Function setMarketplaceConfiguration

  • Name

    setMarketplaceConfiguration

    Summary

    Set or Remove (Noop for No Operation) the marketplace parameters configuration : Commission fee, listing fee, the account list or any offchain datas.

    Each of the parameters of the marketplace, need one of the following type: Noop is set by default for each of the parameters. Noop : No Operation, nothing change. Removed : Current data will be deleted. Set : Un object that update parameter value: Commission Fee and Listing Fee require a data type (flat or percentage) under format : { [MarketplaceConfigAction.Set]: { setFeeType: number || BN}} AccountList require an array of string: { [MarketplaceConfigAction.Set]: string[]} OffChainData require a string: { [MarketplaceConfigAction.Set]: string} CollectionList require an array of number: { [MarketplaceConfigAction.Set]: number[]}

    Returns

    MarketplaceConfigSetEvent Blockchain event.

    Parameters

    • id: number

      Marketplace Id of the marketplace to update.

    • commissionFee: Marketplace.CommissionFeeType = MarketplaceConfigAction.Noop

      Commission when an NFT is sold on the marketplace : it can be set as flat (number) or as percentage. ex: { [MarketplaceConfigAction.Set]: { percentage: 10 } }

    • listingFee: Marketplace.ListingFeeType = MarketplaceConfigAction.Noop

      Fee when an NFT is added for sale to marketplace : it can be set as flat (number) or as percentage. ex: { [MarketplaceConfigAction.Set]: { flat: 5 } }

    • accountList: Marketplace.AccountListType = MarketplaceConfigAction.Noop

      A list of accounts : if the marketplace kind is private, it allows these accounts to sell NFT. If the marketplace kind is public, it bans these accounts from selling NFT.

    • offchainData: Marketplace.OffchainDataType = MarketplaceConfigAction.Noop

      Off-chain related marketplace metadata. Can be an IPFS Hash, an URL or plain text.

    • collectionList: Marketplace.CollectionListType = MarketplaceConfigAction.Noop

      A list of Collection Id: same as accountList, if the marketplace kind is private, the list is a whitelist and if the marketplace is public, the list bans the collection to be listed. ex: { [MarketplaceConfigAction.Set]: [0, 1, 2] }

    • keyring: IKeyringPair

      Account that will sign the transaction.

    • waitUntil: TernoaConstants.WaitUntil

      Execution trigger that can be set either to BlockInclusion or BlockFinalization.

    Returns Promise<TernoaEvents.MarketplaceConfigSetEvent>

Generated using TypeDoc