Marketplace | ternoa-js

Type aliases

AccountListType

AccountListType: MarketplaceConfigAction.Noop | MarketplaceConfigAction.Remove | { set: string[] }

CommissionFeeType

CommissionFeeType: MarketplaceConfigAction.Noop | MarketplaceConfigAction.Remove | Marketplace.SetFeeType

ListingFeeType

ListingFeeType: MarketplaceConfigAction.Noop | MarketplaceConfigAction.Remove | Marketplace.SetFeeType

MarketplaceDataType

MarketplaceDataType: { accountList: string[] | undefined; commissionFee: Marketplace.IFeeType | undefined; kind: string; listingFee: Marketplace.IFeeType | undefined; offchainData: string | undefined; owner: string }

Type declaration

accountList: string[] | undefined
commissionFee: Marketplace.IFeeType | undefined
kind: string
listingFee: Marketplace.IFeeType | undefined
offchainData: string | undefined
owner: string

OffchainDataType

OffchainDataType: MarketplaceConfigAction.Noop | MarketplaceConfigAction.Remove | { set: string }

SetFeeType

SetFeeType: { set: RequireOnlyOne<Marketplace.IFeeType> }

Type declaration

set: RequireOnlyOne<Marketplace.IFeeType>

Functions

buyNft

buyNft(nft_id: number, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.NFTSoldEvent>

- Defined in src/marketplace/extrinsics.ts:266
name
buyNft

summary
Buys an NFT on a marketplace.

Parameters
- nft_id: number
  
  NFT Id of the NFT for sale.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.NFTSoldEvent>
NFTSoldEvent Blockchain event.

buyNftTx

buyNftTx(nft_id: number): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:254
name
buyNftTx

summary
Creates an unsigned unsubmitted Buy-NFT Transaction Hash.

Parameters
- nft_id: number
  
  NFT Id of the NFT for sale.
Returns Promise<`0x${string}`>
Unsigned unsubmitted Buy-NFT Transaction Hash. The Hash is only valid for 5 minutes.

createMarketplace

createMarketplace(kind: MarketplaceKind, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.MarketplaceCreatedEvent>

- Defined in src/marketplace/extrinsics.ts:39
name
createMarketplace

summary
Creates a Marketplace on the chain.

Parameters
- kind: MarketplaceKind
  
  Kind of marketplace : It must be public or private.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.MarketplaceCreatedEvent>
MarketplaceCreatedEvent Blockchain event.

createMarketplaceTx

createMarketplaceTx(kind: MarketplaceKind): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:27
name
createMarketplaceTx

summary
Creates an unsigned unsubmitted Create-Marketplace Transaction Hash.

Parameters
- kind: MarketplaceKind
  
  Kind of marketplace : It must be public or private.
Returns Promise<`0x${string}`>
Unsigned unsubmitted Create-Marketplace Transaction Hash. The Hash is only valid for 5 minutes.

getMarketplaceAccountSizeLimit

getMarketplaceAccountSizeLimit(): Promise<number>

- Defined in src/marketplace/constants.ts:20
name
getMarketplaceAccountSizeLimit

summary
The maximum number of accounts that can be stored inside the account list.

Returns Promise<number>
Number.

getMarketplaceData

getMarketplaceData(marketplaceId: number): Promise<null | Marketplace.MarketplaceDataType>

- Defined in src/marketplace/storage.ts:35
name
getMarketplaceData

summary
Provides the data related to a marketplace.

Parameters
- marketplaceId: number
  
  The Markeplace id.
Returns Promise<null | Marketplace.MarketplaceDataType>
A JSON object with the marketplace data. ex:{owner, kind, accountList, (...)}

getMarketplaceMintFee

getMarketplaceMintFee(): Promise<BN>

- Defined in src/marketplace/storage.ts:14
name
getMarketplaceMintFee

summary
Fee to mint a Marketplace. (extra fee on top of the tx fees).

Returns Promise<BN>
Marketplace mint fee.

getMarketplaceOffchainDataLimit

getMarketplaceOffchainDataLimit(): Promise<number>

- Defined in src/marketplace/constants.ts:10
name
getMarketplaceOffchainDataLimit

summary
Provides the maximum offchain data length.

Returns Promise<number>
Number.

getNextMarketplaceId

getNextMarketplaceId(): Promise<number>

- Defined in src/marketplace/storage.ts:24
name
getNextMarketplaceId

summary
Get the next Marketplace Id available.

Returns Promise<number>
Number.

getNftForSale

getNftForSale(nftId: number): Promise<null | Marketplace.IListedNft>

- Defined in src/marketplace/storage.ts:57
name
getNftForSale

summary
Provides the data related to an NFT listed for sale.

Parameters
- nftId: number
  
  The NFT id.
Returns Promise<null | Marketplace.IListedNft>
A JSON object with the NFT listing data.

listNft

listNft(nft_id: number, marketplace_id: number, price: number | BN, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.NFTListedEvent>

- Defined in src/marketplace/extrinsics.ts:208
name
listNft

summary
Lists an NFT on a marketplace.

Parameters
- nft_id: number
  
  NFT Id of the NFT to be listed for sale.
- marketplace_id: number
  
  Marketplace Id of the marketplace to list the NFT on.
- price: number | BN
  
  Price of the NFT.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.NFTListedEvent>
NFTListedEvent Blockchain event.

listNftTx

listNftTx(nft_id: number, marketplace_id: number, price: number | BN): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:189
name
listNftTx

summary
Creates an unsigned unsubmitted List-NFT Transaction Hash.

Parameters
- nft_id: number
  
  NFT Id of the NFT to be listed for sale.
- marketplace_id: number
  
  Marketplace Id of the marketplace to list the NFT on.
- price: number | BN
  
  Price of the NFT.
Returns Promise<`0x${string}`>
Unsigned unsubmitted List-NFT Transaction Hash. The Hash is only valid for 5 minutes.

setMarketplaceConfiguration

setMarketplaceConfiguration(id: number, commissionFee?: Marketplace.CommissionFeeType, listingFee?: Marketplace.ListingFeeType, accountList?: Marketplace.AccountListType, offchainData?: Marketplace.OffchainDataType, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.MarketplaceConfigSetEvent>

- Defined in src/marketplace/extrinsics.ts:107
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 datas 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}

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.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.MarketplaceConfigSetEvent>
MarketplaceConfigSetEvent Blockchain event.

setMarketplaceConfigurationTx

setMarketplaceConfigurationTx(id: number, commissionFee?: Marketplace.CommissionFeeType, listingFee?: Marketplace.ListingFeeType, accountList?: Marketplace.AccountListType, offchainData?: Marketplace.OffchainDataType): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:68
name
setMarketplaceConfigurationTx

summary
Creates an unsigned unsubmitted Set-Marketplace-Configuration Transaction Hash.

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 datas 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}

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.
Returns Promise<`0x${string}`>
MarketplaceConfigSetEvent Blockchain event.

setMarketplaceKind

setMarketplaceKind(id: number, kind: MarketplaceKind, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.MarketplaceKindSetEvent>

- Defined in src/marketplace/extrinsics.ts:170
name
setMarketplaceKind

summary
Set the new marketplace kind on the chain.

Parameters
- id: number
- kind: MarketplaceKind
  
  Kind of marketplace : It must be public or private.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.MarketplaceKindSetEvent>
MarketplaceKindSetEvent Blockchain event.

setMarketplaceKindTx

setMarketplaceKindTx(id: number, kind: MarketplaceKind): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:158
name
setMarketplaceKindTx

summary
Creates an unsigned unsubmitted Set-Marketplace-Kind Transaction Hash.

Parameters
- id: number
- kind: MarketplaceKind
  
  Kind of marketplace : It must be public or private.
Returns Promise<`0x${string}`>
Unsigned unsubmitted Set-Marketplace-Kind Transaction Hash. The Hash is only valid for 5 minutes.

setMarketplaceMintFee

setMarketplaceMintFee(fee: number | BN, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.MarketplaceMintFeeSetEvent>

- Defined in src/marketplace/extrinsics.ts:291
name
setMarketplaceMintFee

summary
Set the new marketplace minting fee on the chain.

Parameters
- fee: number | BN
  
  Fee to mint a marketplace.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.MarketplaceMintFeeSetEvent>
NFTSoldEvent Blockchain event.

setMarketplaceMintFeeTx

setMarketplaceMintFeeTx(fee: number | BN): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:278
name
setMarketplaceMintFeeTx

summary
Creates an unsigned unsubmitted Set-Marketplace-Mint-Fee Transaction Hash.

Parameters
- fee: number | BN
  
  Fee to mint a marketplace.
Returns Promise<`0x${string}`>
Unsigned unsubmitted Set-Marketplace-Mint-Fee Transaction Hash. The Hash is only valid for 5 minutes.

setMarketplaceOwner

setMarketplaceOwner(id: number, recipient: string, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.MarketplaceOwnerSetEvent>

- Defined in src/marketplace/extrinsics.ts:141
name
setMarketplaceOwner

summary
Set the new marketplace owner on the chain.

Parameters
- id: number
  
  Marketplace Id of the marketplace to be transferred.
- recipient: string
  
  Adress of the new marketplace owner.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.MarketplaceOwnerSetEvent>
MarketplaceOwnerSetEvent Blockchain event.

setMarketplaceOwnerTx

setMarketplaceOwnerTx(id: number, recipient: string): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:128
name
setMarketplaceOwnerTx

summary
Creates an unsigned unsubmitted Set-Marketplace-Owner Transaction Hash.

Parameters
- id: number
  
  Marketplace Id of the marketplace to be transferred.
- recipient: string
  
  Adress of the new marketplace owner.
Returns Promise<`0x${string}`>
Unsigned unsubmitted Set-Marketplace-Owner Transaction Hash. The Hash is only valid for 5 minutes.

unlistNft

unlistNft(nft_id: number, keyring: IKeyringPair, waitUntil: WaitUntil): Promise<Events.NFTUnlistedEvent>

- Defined in src/marketplace/extrinsics.ts:238
name
unlistNft

summary
Unlists an NFT from a marketplace.

Parameters
- nft_id: number
  
  NFT Id of the NFT to be unlisted from sale.
- keyring: IKeyringPair
  
  Account that will sign the transaction.
- waitUntil: WaitUntil
  
  Execution trigger that can be set either to BlockInclusion or BlockFinalization.
Returns Promise<Events.NFTUnlistedEvent>
NFTUnlistedEvent Blockchain event.

unlistNftTx

unlistNftTx(nft_id: number): Promise<`0x${string}`>

- Defined in src/marketplace/extrinsics.ts:226
name
unlistNftTx

summary
Creates an unsigned unsubmitted Unlist-NFT Transaction Hash.

Parameters
- nft_id: number
  
  NFT Id of the NFT to be unlisted from sale.
Returns Promise<`0x${string}`>
Unsigned unsubmitted Unlist-NFT Transaction Hash. The Hash is only valid for 5 minutes.

Index

Interfaces

Type aliases

Functions

Type aliases

AccountListType

CommissionFeeType

ListingFeeType

MarketplaceDataType

Type declaration

accountList: string[] | undefined

commissionFee: Marketplace.IFeeType | undefined

kind: string

listingFee: Marketplace.IFeeType | undefined

offchainData: string | undefined

owner: string

OffchainDataType

SetFeeType

Type declaration

set: RequireOnlyOne<Marketplace.IFeeType>

Functions

buyNft

Parameters

nft_id: number

keyring: IKeyringPair

waitUntil: WaitUntil

Returns Promise<Events.NFTSoldEvent>

buyNftTx

Parameters

nft_id: number

Returns Promise<`0x${string}`>

createMarketplace

Parameters

kind: MarketplaceKind

keyring: IKeyringPair

waitUntil: WaitUntil

Returns Promise<Events.MarketplaceCreatedEvent>

createMarketplaceTx

Parameters

kind: MarketplaceKind

Returns Promise<`0x${string}`>

getMarketplaceAccountSizeLimit

Returns Promise<number>

getMarketplaceData

Parameters

marketplaceId: number

Returns Promise<null | Marketplace.MarketplaceDataType>

getMarketplaceMintFee

Returns Promise<BN>

getMarketplaceOffchainDataLimit

Returns Promise<number>

getNextMarketplaceId

Returns Promise<number>

getNftForSale

Parameters

nftId: number

Returns Promise<null | Marketplace.IListedNft>

listNft

Parameters

nft_id: number

marketplace_id: number

price: number | BN

keyring: IKeyringPair

waitUntil: WaitUntil

Returns Promise<Events.NFTListedEvent>

listNftTx

Parameters

nft_id: number

marketplace_id: number

price: number | BN

Returns Promise<`0x${string}`>

setMarketplaceConfiguration

Parameters

id: number

commissionFee: Marketplace.CommissionFeeType = MarketplaceConfigAction.Noop

listingFee: Marketplace.ListingFeeType = MarketplaceConfigAction.Noop

accountList: Marketplace.AccountListType = MarketplaceConfigAction.Noop

offchainData: Marketplace.OffchainDataType = MarketplaceConfigAction.Noop

keyring: IKeyringPair

waitUntil: WaitUntil