Type alias UpdateAuctionHouseBuilderParams

UpdateAuctionHouseBuilderParams: {
    auctionHouse: AuctionHouse;
    sellerFeeBasisPoints?: undefined | null | number;
    requiresSignOff?: undefined | null | boolean;
    canChangeSalePrice?: undefined | null | boolean;
    authority?: undefined | Signer;
    auctioneerAuthority?: undefined | PublicKey;
    auctioneerScopes?: undefined | AuthorityScope[];
    feeWithdrawalDestination?: undefined | PublicKey;
    treasuryWithdrawalDestinationOwner?: undefined | PublicKey;
    newAuthority?: undefined | PublicKey;
    instructionKey?: undefined | string;
    delegateAuctioneerInstructionKey?: undefined | string;
    updateAuctioneerInstructionKey?: undefined | string;
}

Type declaration

  • auctionHouse: AuctionHouse

    The Auction House model. We need the full model in order to compare the current data with the provided data to update. For instance, if you only want to update the feeWithdrawalDestination, we need to send an instruction that updates the data whilst keeping all other properties the same.

  • Optional sellerFeeBasisPoints?: undefined | null | number

    The share of the sale the auction house takes on all NFTs as a fee.

    Default Value

    auctionHouse.requiresSignOff

  • Optional requiresSignOff?: undefined | null | boolean

    This allows the centralised authority to gate which NFT can be listed, bought and sold.

    Default Value

    auctionHouse.requiresSignOff

  • Optional canChangeSalePrice?: undefined | null | boolean

    Is intended to be used with the Auction House that requires sign off. If the seller intentionally lists their NFT for a price of 0, a new FreeSellerTradeState is made. The Auction House can then change the price to match a matching Bid that is greater than 0.

    Default Value

    auctionHouse.canChangeSalePrice

  • Optional authority?: undefined | Signer

    The Auction House authority.

    Default Value

    auctionHouse.authority

  • Optional auctioneerAuthority?: undefined | PublicKey

    The Auctioneer authority key. It is required when Auction House is going to have Auctioneer enabled.

    Provide it if you want to delegate Auctioneer on the Auction House that doesn't have Auctioneer enabled.

    Default Value

    auctionHouse.auctioneerAuthority

  • Optional auctioneerScopes?: undefined | AuthorityScope[]

    The list of scopes available to the user in the Auction House. For example Bid, List, Execute Sale.

    Only takes place when Auction House has Auctioneer enabled.

    Default Value

    auctionHouse.scopes

  • Optional feeWithdrawalDestination?: undefined | PublicKey

    The account that is marked as a destination of withdrawal from the fee account.

    Default Value

    auctionHouse.feeWithdrawalDestination

  • Optional treasuryWithdrawalDestinationOwner?: undefined | PublicKey

    The account that is marked as the owner of treasury withdrawal destination.

    Default Value

    auctionHouse.treasuryWithdrawalDestinationAddress

  • Optional newAuthority?: undefined | PublicKey

    The new Auction House authority if you want to change it.

    Default Value

    auctionHouse.authority

  • Optional instructionKey?: undefined | string
  • Optional delegateAuctioneerInstructionKey?: undefined | string
  • Optional updateAuctioneerInstructionKey?: undefined | string

Settings

Member Visibility

Theme

Generated using TypeDoc