'devnet' | 'mainnet' | 'testnet'
Timeout for the network provider (DEFAULT = 10000ms)
-Readonly chainIDReadonly contractReadonly envReadonly networkReadonly chainIDReadonly contractReadonly envReadonly networkBuilds a bond transaction with EGLD transfer
the address of the sender
the address of the original caller
the token identifier of the NFT/SFT
the token identifier nonce
the lock period for the bond
the payment for the bond (tokenIdentifier, nonce and amount)
-Builds a bond transaction with ESDT transfer
the address of the sender
the address of the original caller
the token identifier of the NFT/SFT
the token identifier nonce
the lock period for the bond
the payment for the bond (tokenIdentifier and amount)
-Builds a bond transaction with NFT/SFT transfer
the address of the sender
the address of the original caller
the token identifier of the NFT/SFT
the token identifier nonce
the lock period for the bond
the payment for the bond (tokenIdentifier, nonce and amount)
-Builds a bond transaction with no payment
the address of the sender
the address of the original caller
the token identifier of the NFT/SFT
the token identifier nonce
the lock period for the bond
-Builds a initiateBond transaction to "whitelist" an address for being able to bond for a specific Data NFT
Builds a initiateBond transaction to "whitelist" an address for being able to bond for a specific Data NFT
the address of the sender
the address to be whitelisted
the token identifier
the token identifier nonce
-Builds a refund transaction
Builds a refund transaction
the address of the sender
the identifier of the NFT/SFT
the token identifier nonce
the end timestamp for the proof period for a refund
-Builds a modifyBond transaction
address of the sender (must be the owner of the contract or the administrator)
token identifier to modify the bond for
nonce to modify the bond for
-Builds a removeAcceptedCallers transaction to remove the accepted callers
Builds a removeBlacklist transaction to remove addresses from the blacklist
Builds a removeBlacklist transaction to remove addresses from the blacklist
the address of the sender
the compensation id to remove the blacklist from
an array of addresses to be removed from the blacklist
-Builds a removePeriodsBonds transaction to remove the bonds for each of the specified periods
Builds a removePeriodsBonds transaction to remove the bonds for each of the specified periods
the address of the sender
an array of periods for which the bonds should be removed
-Builds a sanction transaction
Builds a sanction transaction
address of the sender (must be the owner of the contract or the administrator)
token identifier to sanction
nonce to sanction
penalty type
Optional customPenalty: numbercustom penalty amount (required if penalty is Custom)
Builds a setAcceptedCallers transaction to add accepted callers for the bond endpoint
Builds a setAcceptedCallers transaction to add accepted callers for the bond endpoint
the address of the sender
an array of addresses to be added as accepted callers for bond endpoint
Builds a setAdministrator transaction
Builds a setBlacklist transaction to blacklist addresses
Builds a setBondToken transaction to set the bond token
Builds a setBondToken transaction to set the bond token
the address of the sender
the token identifier. If not provided, the default token identifier based on the EnvironmentsEnum
-Builds a setContractState transaction
address of the sender (must be the owner of the contract or the administrator)
state to set the contract to
-Builds a setMaximumPenalty transaction to set the maximum penalty
Builds a setMinimumPenalty transaction to set the minimum penalty
+
Builds a setWithdrawPenalty transaction to set the withdraw penalty
Returns a Bond object array for the given address
Returns an Optional Compensation and Refund object for the given address and compensation id
Returns an Optional Compensation and Refund object for the given address and compensation id
address to query
compensation id to query
-Returns a Bond object for the given bondId
Returns a Bond object array for the given bondIds
Returns a Bond object array for the given bondIds
Bond ids to query
-Returns a Bond object array for the given full tokenIdentifier
Returns a Bond object array for the given tokenIdentifiers and nonces
Returns a Compensation object for the given compensation id
Returns a Bond object array for the given full tokenIdentifier
Returns a Bond object array for the given tokenIdentifiers and nonces
Returns a Compensation object for the given compensation id
compensation id to query
-Returns a list of addresses that are blacklisted from claiming compensations
+Returns a Compensation object array for the given tokens
Returns a Compensation object array for the given tokens
tokens to query
-Returns the bond contract configuration
Returns a Compensation object array for the given indexes
Returns the bond contract configuration
Returns a Compensation object array for the given indexes
Generated using TypeDoc
Generated using TypeDoc
Abstract Abstract Protected constructorReadonly chainIDReadonly contractReadonly envReadonly networkGenerated using TypeDoc
Protected constructorReadonly chainIDReadonly contractReadonly envReadonly networkGenerated using TypeDoc
Readonly balanceReadonly collectionReadonly creationReadonly creatorReadonly dataReadonly dataReadonly dataReadonly descriptionReadonly extraReadonly isReadonly mediaReadonly nftReadonly nonceReadonly overrideReadonly overrideReadonly ownerReadonly royaltiesReadonly supplyReadonly titleReadonly tokenReadonly tokenStatic apiStatic envStatic networkUpdate any attributes for DataNft
-Method to get the data via the Data Marshal.
-Optional asOptional fwdOptional fwdOptional fwdOptional nestedOptional stream?: booleanMethod to get the data from the data marshal by authenticating and authorizing via MultiversX Native Auth. This has a better UX as it does not need a manually signed signableMessage
-Optional asOptional fwdOptional fwdOptional nestedOptional stream?: booleanStatic createCreates a DataNft calling the API and also decoding the attributes.
+Readonly balanceReadonly collectionReadonly creationReadonly creatorReadonly dataReadonly dataReadonly dataReadonly descriptionReadonly extraReadonly isReadonly mediaReadonly nftReadonly nonceReadonly overrideReadonly overrideReadonly ownerReadonly royaltiesReadonly supplyReadonly titleReadonly tokenReadonly tokenStatic apiStatic envStatic networkUpdate any attributes for DataNft
+Method to get the data via the Data Marshal.
+Optional asOptional fwdOptional fwdOptional fwdOptional nestedOptional stream?: booleanMethod to get the data from the data marshal by authenticating and authorizing via MultiversX Native Auth. This has a better UX as it does not need a manually signed signableMessage
+Optional asOptional fwdOptional fwdOptional nestedOptional stream?: booleanStatic createCreates a DataNft calling the API and also decoding the attributes.
Not useful for creating an array of DataNft, because it calls the API every single time.
Object should have a nonce property representing the token nonce. An optional tokenIdentifier property can be provided to specify the token identifier.
If not provided, the default token identifier based on the EnvironmentsEnum
Optional tokenStatic createCreates a DataNft or an array of DataNft from either a single NFT details API response or an array of NFT details API response.
+Optional tokenStatic createStatic createCreates an array of DataNfts by calling the API and decoding the attributes.
+Static createCreates an array of DataNfts by calling the API and decoding the attributes.
An array of objects containing token nonces and optional token identifiers.
Each object should have a nonce property representing the token nonce.
An optional tokenIdentifier property can be provided to specify the token identifier.
If not provided, the default token identifier based on the EnvironmentsEnum
An array of DataNft objects
-Static decodeStatic method to decode the attributes of a DataNft
+Static decodeStatic Private ensureStatic ownedReturns an array of DataNft objects owned by the address
Static Private ensureStatic ownedReturns an array of DataNft objects owned by the address
the address to query
Optional collections: string[]the collection identifiers to query. If not provided, the default collection identifier based on the EnvironmentsEnum
-Static setStatic setGenerated using TypeDoc
Generated using TypeDoc
Creates a new instance of the DataNftMarket which can be used to interact with the marketplace smart contract
'devnet' | 'mainnet' | 'testnet'
Timeout for the network provider (DEFAULT = 10000ms)
-Readonly chainIDReadonly contractReadonly envReadonly networkReadonly chainIDReadonly contractReadonly envReadonly networkCreates a acceptOffer transaction with EGLD
the address of the sender
the id of the offer to be accepted
the price of the offer for the total amount to be bought (must include the buyer fee)
the price of the offer (must include the buyer fee)
-Creates a acceptOffer transaction with ESDT tokens
the address of the sender
the id of the offer to be accepted
the amount of tokens to be bought
the price of the offer for the total amount to be bought (must include the buyer fee)
the identifier of the payment token (default = ITHEUM token identifier based on the EnvironmentsEnum))
Creates a acceptOffer transaction with NFT/SFT tokens
the address of the sender
the id of the offer to be accepted
the amount of tokens to be bought
the identifier of the token for the payment
the nonce of the token for the payment
the amount of the token for the payment
-Creates a addOffer transaction
the address of the sender
the identifier of the DATA-NFT
the nonce of the DATA-NFT
@@ -57,40 +57,40 @@the nonce of the payment token
the amount of the payment token
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)
Creates a cancelOffer transaction
the address of the sender
the id of the offer to be cancelled
the quantity of the offer to be cancelled
default true, if false the offer will be cancelled, but the funds will be kept in the contract until withdrawal
Creates a changeOfferPrice transaction
Creates a changeOfferPrice transaction
the address of the sender
the id of the offer to be changed
the new price of the offer
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)
Retrieves all cancelled Offer objects for a given address which opted to not withdraw the funds
Retrieves all Offer objects listed on the marketplace for a given address
Retrieves an array of Offer objects listed on the marketplace for a given address within a specified range.
Retrieves an array of Offer objects listed on the marketplace for a given address within a specified range.
The starting index of the desired range of offers.
The ending index of the desired range of offers.
The address to query.
-Returns the total number of offers listed for a given address
+Retrieves an Offer object based on the offer id
Retrieves an array of Offer objects in an arbitrary order.
Retrieves the smart contract requirements for the marketplace
-Creates a withdrawCancelledOffer transaction
Retrieves the smart contract requirements for the marketplace
+Creates a withdrawCancelledOffer transaction
the address of the sender
the id of the offer from which the funds should be withdrawn
offerId must be firstly cancelled. cancelOffer
Generated using TypeDoc
Generated using TypeDoc
Abstract Abstract Protected constructorReadonly chainIDReadonly contractReadonly envReadonly imageReadonly networkProtected constructorReadonly chainIDReadonly contractReadonly envReadonly imageReadonly networkCreates a burn transaction
the address of the user
the nonce of the DataNFT-FT
the quantity to burn
the DataNFT-FT token identifier (default = DATA-NFT-FT token identifier based on the EnvironmentsEnum)
Creates a remove whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to remove from the whitelist
The extra gas to add to the transaction
-Creates a set mint time limit transaction for the contract
+The address of the sender, must be the admin of the contract
The minimum royalties to set for minting
The maximum royalties to set for minting
Remarks: The royalties are set in percentage (e.g. 100% = 10000)
-Creates a set mint tax transaction for the contract
+Creates a set mint tax transaction for the contract
The address of the sender, must be the admin of the contract
A boolean value to set if whitelist is enabled or not
-The address of the sender, must be the admin or owner of the contract
The nonce of the token to unfreeze for unfreezeAddress
The address to unfreeze
-Unpause collection transaction
+Creates a whitelist transaction for the contract
+Creates a whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to whitelist
The extra gas to add to the transaction
-The address of the sender, must be the admin or owner of the contract
The nonce of the token to wipe for wipeAddress
The address to wipe from Important: This will wipe all NFTs from the address Note: The nonce must be freezed before wiping
-Generated using TypeDoc
Generated using TypeDoc
'devnet' | 'mainnet' | 'testnet'
The address of the factory generated smart contract
Timeout for the network provider (DEFAULT = 10000ms)
-Readonly chainIDReadonly contractReadonly envReadonly imageReadonly networkReadonly chainIDReadonly contractReadonly envReadonly imageReadonly networkCreates a burn transaction
the address of the user
the nonce of the DataNFT-FT
the quantity to burn
the DataNFT-FT token identifier (default = DATA-NFT-FT token identifier based on the EnvironmentsEnum)
Creates a claim royalties transaction for the contract
The address of the sender, must be the admin of the contract
The token identifier of the token to claim royalties
The nonce of the token to claim royalties (default: 0 for ESDT)
-Creates an initialize contract transaction for the contract
The address of the sender, must be the admin of the contract
The name of the NFT collection
The ticker of the NFT collection
A boolean value to set if the mint tax is required or not
Optional options: { If requireMintTax is true, the options object must contain the taxTokenIdentifier and taxTokenAmount
Creates a mint transaction
NOTE: The dataStreamUrl is being encrypted and the media and metadata urls are build and uploaded to IPFS
NOTE: The options.nftStorageToken is required when not using custom image and traits, when using custom image and traits the traits should be compliant with the Traits structure
For more information, see the README documentation.
@@ -82,72 +82,72 @@ - antiSpamTokenIdentifier: the anti spam token identifier to be used for the minting - antiSpamTax: the anti spam tax to be set for the Data NFT-FT with decimals. Needs to be greater than 0 and should be obtained in real time via viewMinterRequirements prior to calling mint. - extraAssets [optional] extra URIs to attached to the NFT. Can be media files, documents, etc. These URIs are public -Optional antiOptional antiOptional extraOptional imageOptional nftOptional traitsCreates a remove whitelist transaction for the contract
+Creates a remove whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to remove from the whitelist
The extra gas to add to the transaction
-Sets a new administrator for the contract
+Sets the claim address for the contract
+Creates a set mint tax transaction for the contract
+Creates a set mint tax transaction for the contract
The address of the sender, must be the admin of the contract
A boolean value to set if the mint tax is required or not
-Creates a set mint time limit transaction for the contract
+The address of the sender, must be the admin of the contract
The minimum royalties to set for minting
The maximum royalties to set for minting
Remarks: The royalties are set in percentage (e.g. 100% = 10000)
-Creates a setTransferRoles transaction for the contract
+Creates a set mint tax transaction for the contract
+Creates a set mint tax transaction for the contract
The address of the sender, must be the admin of the contract
A boolean value to set if whitelist is enabled or not
-The address of the sender, must be the admin or owner of the contract
The nonce of the token to unfreeze for unfreezeAddress
The address to unfreeze
-Unpause collection transaction
+Creates an unsetTransferRoles transaction for the contract
+Creates a updateAttributes transaction for the contract
+Creates a updateAttributes transaction for the contract
The address of the sender, must be the admin of the contract
The token identifier of the data nft to update attributes
The nonce of the token to update attributes
The new attributes to update
The quantity of the token to update attributes (default: 1)
-Retrieves the smart contract configuration
-Retrieves the minter smart contract requirements for the given user
+Retrieves the smart contract configuration
+Retrieves the minter smart contract requirements for the given user
the address of the user
the tax token to be used for the minting (default = ITHEUM token identifier based on the EnvironmentsEnum)
Creates a whitelist transaction for the contract
+Creates a whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to whitelist
The extra gas to add to the transaction
-The address of the sender, must be the admin or owner of the contract
The nonce of the token to wipe for wipeAddress
The address to wipe from Important: This will wipe all NFTs from the address Note: The nonce must be freezed before wiping
-Generated using TypeDoc
Generated using TypeDoc
Creates a new instance of the SftMinter class, which can be used to interact with the Data NFT-FT minter smart contract
'devnet' | 'mainnet' | 'testnet'
Timeout for the network provider (DEFAULT = 10000ms)
-Readonly chainIDReadonly contractReadonly envReadonly imageReadonly networkReadonly chainIDReadonly contractReadonly envReadonly imageReadonly networkCreates a burn transaction
the address of the user
the nonce of the DataNFT-FT
the quantity to burn
the DataNFT-FT token identifier (default = DATA-NFT-FT token identifier based on the EnvironmentsEnum)
Creates an initialize contract transaction for the contract
The address of the sender, must be the admin of the contract
The name of the NFT collection
The ticker of the NFT collection
The token identifier of the anti spam token
The amount of anti spam token to be used for minting as tax
The address of the treasury to collect the anti spam tax
-Creates a mint transaction
NOTE: The dataStreamUrl is being encrypted and the media and metadata urls are build and uploaded to IPFS
NOTE: The options.nftStorageToken is required when not using custom image and traits, when using custom image and traits the traits should be compliant with the traits structure
For more information, see the README documentation.
@@ -72,58 +72,58 @@ - traitsUrl: the URL of the traits for the Data NFT - nftStorageToken: the nft storage token to be used to upload the image and metadata to IPFS - extraAssets: [optional] extra URIs to attached to the NFT. Can be media files, documents, etc. These URIs are public -Optional extraOptional imageOptional nftOptional traitsCreates a remove whitelist transaction for the contract
+Creates a remove whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to remove from the whitelist
The extra gas to add to the transaction
-Sets a new administrator for the contract
+Creates a set mint time limit transaction for the contract
+The address of the sender, must be the admin of the contract
The minimum royalties to set for minting
The maximum royalties to set for minting
Remarks: The royalties are set in percentage (e.g. 100% = 10000)
-Creates a setTreasuryAddress transaction
Creates a setTreasuryAddress transaction
The address of the sender, must be the admin of the contract
The address of the treasury to collect the anti spam tax
-Creates a set mint tax transaction for the contract
+Creates a set mint tax transaction for the contract
The address of the sender, must be the admin of the contract
A boolean value to set if whitelist is enabled or not
-The address of the sender, must be the admin or owner of the contract
The nonce of the token to unfreeze for unfreezeAddress
The address to unfreeze
-Unpause collection transaction
+Retrieves a list of nonces that are frozen for address
+Retrieves the minter smart contract requirements for the given user
+Retrieves the minter smart contract requirements for the given user
the address of the user
the tax token to be used for the minting (default = ITHEUM token identifier based on the EnvironmentsEnum)
Creates a whitelist transaction for the contract
+Creates a whitelist transaction for the contract
The address of the sender, must be the admin of the contract
The addresses to whitelist
The extra gas to add to the transaction
-The address of the sender, must be the admin or owner of the contract
The nonce of the token to wipe for wipeAddress
The address to wipe from Important: This will wipe all NFTs from the address Note: The nonce must be freezed before wiping
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The collection of the token
the nonce of the token
The token identifier in the format of ticker-randomString-nonce
-Generated using TypeDoc
Creates a new instance of the DataNftMarket which can be used to interact with the marketplace smart contract