Class DataNftMarket

constructor

• new DataNftMarket(env, timeout?): DataNftMarket

• Creates a new instance of the DataNftMarket which can be used to interact with the marketplace smart contract

  Parameters

  • env: string

    'devnet' | 'mainnet' | 'testnet'
  • timeout: number = 10000

    Timeout for the network provider (DEFAULT = 10000ms)

  Returns DataNftMarket

ReadonlychainID

Readonlycontract

Readonlyenv

ReadonlynetworkProvider

acceptOfferWithEGLD

• acceptOfferWithEGLD(senderAddress, offerId, amount, price): Transaction

• Creates a acceptOffer transaction with EGLD

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer to be accepted
  • amount: Value

    the price of the offer for the total amount to be bought (must include the buyer fee)
  • price: Value

    the price of the offer (must include the buyer fee)

  Returns Transaction

acceptOfferWithESDT

• acceptOfferWithESDT(senderAddress, offerId, amount, price, paymentTokenIdentifier?): Transaction

• Creates a acceptOffer transaction with ESDT tokens

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer to be accepted
  • amount: Value

    the amount of tokens to be bought
  • price: Value

    the price of the offer for the total amount to be bought (must include the buyer fee)
  • paymentTokenIdentifier: string = ...

    the identifier of the payment token (default = ITHEUM token identifier based on the EnvironmentsEnum))

  Returns Transaction

acceptOfferWithNFT

• acceptOfferWithNFT(senderAddress, offerId, amount, tokenIdentifier, nonce, paymentAmount): Transaction

• Creates a acceptOffer transaction with NFT/SFT tokens

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer to be accepted
  • amount: Value

    the amount of tokens to be bought
  • tokenIdentifier: string

    the identifier of the token for the payment
  • nonce: number

    the nonce of the token for the payment
  • paymentAmount: Value

    the amount of the token for the payment

  Returns Transaction

acceptOfferWithNoPayment

• acceptOfferWithNoPayment(senderAddress, offerId, amount): Transaction

• Creates a acceptOffer without payment token (Free)

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer to be accepted
  • amount: Value

    the amount of tokens to be bought

  Returns Transaction

addOffer

• addOffer(senderAddress, dataNftIdentifier, dataNftNonce, dataNftAmount, paymentTokenIdentifier, paymentTokenNonce, paymentTokenAmount, minimumPaymentTokenAmount?, maxQuantity): Transaction

• Creates a addOffer transaction

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • dataNftIdentifier: string

    the identifier of the DATA-NFT
  • dataNftNonce: number

    the nonce of the DATA-NFT
  • dataNftAmount: Value

    the amount of the DATA-NFT
  • paymentTokenIdentifier: string

    the identifier of the payment token sender wants to receive
  • paymentTokenNonce: number

    the nonce of the payment token
  • paymentTokenAmount: Value

    the amount of the payment token
  • minimumPaymentTokenAmount: number = 0

    the minimum amount of which the sender is willing to receive (useful in case where an offer was added and the smart contract fee was changed afterwards)
  • maxQuantity: Value

    the maximum quantity a user can buy (default could be 0 - (no enforced max value) or admin defined value)

  Returns Transaction

cancelOffer

• cancelOffer(senderAddress, offerId, quantity, sendFundsBackToOwner?): Transaction

• Creates a cancelOffer transaction

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer to be cancelled
  • quantity: number

    the quantity of the offer to be cancelled
  • sendFundsBackToOwner: boolean = true

    default true, if false the offer will be cancelled, but the funds will be kept in the contract until withdrawal

  Returns Transaction

changeOfferPrice

• changeOfferPrice(senderAddress, offerId, newPrice, newMinimumPaymentTokenAmount?): Transaction

• Creates a changeOfferPrice transaction

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer to be changed
  • newPrice: Value

    the new price of the offer
  • newMinimumPaymentTokenAmount: number = 0

    the new minimum amount of which the sender is willing to receive (useful in case where an offer was added and the smart contract fee was changed afterwards)

  Returns Transaction

getContractAddress

• getContractAddress(): IAddress

• Retrieves the address of the marketplace smart contract based on the environment

  Returns IAddress

viewAddressCancelledOffers

• viewAddressCancelledOffers(address): Promise<Offer[]>

• Retrieves all cancelled Offer objects for a given address which opted to not withdraw the funds

  Parameters

  • address: IAddress

    Address to query

  Returns Promise<Offer[]>

viewAddressListedOffers

• viewAddressListedOffers(address): Promise<Offer[]>

• Retrieves all Offer objects listed on the marketplace for a given address

  Parameters

  • address: IAddress

    Address to query

  Returns Promise<Offer[]>

viewAddressPagedOffers

• viewAddressPagedOffers(from, to, address): Promise<Offer[]>

• Retrieves an array of Offer objects listed on the marketplace for a given address within a specified range.

  Parameters

  • from: number

    The starting index of the desired range of offers.
  • to: number

    The ending index of the desired range of offers.
  • address: IAddress

    The address to query.

  Returns Promise<Offer[]>

viewAddressTotalOffers

• viewAddressTotalOffers(address): Promise<number>

• Returns the total number of offers listed for a given address

  Parameters

  • address: IAddress

    Address to query

  Returns Promise<number>

viewContractPauseState

• viewContractPauseState(): Promise<boolean>

• Retrieves if the smart contract is paused or not

  Returns Promise<boolean>

viewLastValidOfferId

• viewLastValidOfferId(): Promise<number>

• Retrieves the last valid offer id in the storage

  Returns Promise<number>

viewNumberOfOffers

• viewNumberOfOffers(): Promise<number>

• Retrieves the smart contract number of offers

  Returns Promise<number>

viewOffer

• viewOffer(offerId): Promise<Offer>

• Retrieves an Offer object based on the offer id

  Parameters

  • offerId: number

    The id of the offer to be retrieved

  Returns Promise<Offer>

viewOffers

• viewOffers(offerIds): Promise<Offer[]>

• Retrieves an array of Offer objects.

  Parameters

  • offerIds: number[]

  Returns Promise<Offer[]>

viewPagedOffers

• viewPagedOffers(from, to, senderAddress?): Promise<Offer[]>

• Retrieves an array of Offer objects in an arbitrary order.

  Parameters

  • from: number

    first index
  • to: number

    last index
  • OptionalsenderAddress: IAddress

    the address of the sender (optional)

  Returns Promise<Offer[]>

viewRequirements

• viewRequirements(): Promise<MarketplaceRequirements>

• Retrieves the smart contract requirements for the marketplace

  Returns Promise<MarketplaceRequirements>

withdrawCancelledOffer

• withdrawCancelledOffer(senderAddress, offerId): Transaction

• Creates a withdrawCancelledOffer transaction

  Parameters

  • senderAddress: IAddress

    the address of the sender
  • offerId: number

    the id of the offer from which the funds should be withdrawn

    offerId must be firstly cancelled. cancelOffer

  Returns Transaction