📄️ thirdweb TypeScript SDK
thirdweb TypeScript SDK
📄️ Migration Guide
If you are looking to upgrade from an earlier version of the SDK, below are the breaking changes that you should be aware of between each version.
📄️ Abi type
Signature:
📄️ AbiEvent type
Signature:
📄️ AbiFunction type
Signature:
📄️ AbstractClaimConditionContractStruct type
Signature:
📄️ AddContractInput type
Signature:
📄️ AddressSchema variable
Signature:
📄️ AirdropInput type
Input model to pass a list of addresses + amount to transfer to each one
📄️ ALL\_ROLES variable
Signature:
📄️ Amount type
Represents a currency amount already formatted. ie. "1" for 1 ether.
📄️ APPROVED\_IMPLEMENTATIONS variable
Signature:
📄️ AuctionListing.asset property
The asset being listed.
📄️ AuctionListing.assetContractAddress property
The address of the asset being listed.
📄️ AuctionListing.buyoutCurrencyValuePerToken property
The CurrencyValue of the buyout price listing. Useful for displaying the price information.
📄️ AuctionListing.buyoutPrice property
The buyout price of the listing.
📄️ AuctionListing.currencyContractAddress property
The address of the currency to accept for the listing.
📄️ AuctionListing.endTimeInEpochSeconds property
Number of seconds until the auction expires.
📄️ AuctionListing.id property
The id of the listing
📄️ AuctionListing interface
Represents a new marketplace auction listing.
📄️ AuctionListing.quantity property
The quantity of tokens to include in the listing.
📄️ AuctionListing.reservePrice property
The reserve price is the minimum price that a bid must be in order to be accepted.
📄️ AuctionListing.reservePriceCurrencyValuePerToken property
The CurrencyValue of the reserve price. Useful for displaying the price information.
📄️ AuctionListing.sellerAddress property
The address of the seller.
📄️ AuctionListing.startTimeInEpochSeconds property
The start time of the listing.
📄️ AuctionListing.tokenId property
The ID of the token to list.
📄️ AuctionListing.type property
Signature:
📄️ BatchToReveal.batchId property
Signature:
📄️ BatchToReveal.batchUri property
Signature:
📄️ BatchToReveal interface
Signature:
📄️ BatchToReveal.placeholderMetadata property
Signature:
📄️ Bid.auctionId property
The id of the auction.
📄️ Bid.bidAmount property
The amount of coins offered per token.
📄️ Bid.bidAmountCurrencyValue property
The CurrencyValue of the listing. Useful for displaying the price information.
📄️ Bid.bidderAddress property
The address of the buyer who made the offer.
📄️ Bid.currencyContractAddress property
The currency contract address of the offer token.
📄️ Bid interface
Signature:
📄️ BigNumberishSchema variable
Signature:
📄️ BigNumberSchema variable
Signature:
📄️ BigNumberTransformSchema variable
Signature:
📄️ buildDefaultMap() function
Signature:
📄️ CallOverrideSchema variable
Signature:
📄️ CHAIN\_ID\_TO\_NAME variable
Signature:
📄️ ChainId enum
Signature:
📄️ ChainIdOrName type
Signature:
📄️ ChainInfo type
Signature:
📄️ ChainInfoInputSchema variable
Signature:
📄️ ChainNames type
Signature:
📄️ ChainOrRpc type
Signature:
📄️ ClaimCondition type
Represents a claim condition fetched from the SDK
📄️ ClaimConditionFetchOptions type
Signature:
📄️ ClaimConditionInput type
Input model to create a claim condition with optional snapshot of wallets
📄️ ClaimConditionsForToken type
Signature:
📄️ ClaimEligibility enum
Signature:
📄️ ClaimOptions type
Signature:
📄️ ClaimVerification type
Signature:
📄️ CommonContractSchemaInput type
Signature:
📄️ ContractDeployer.(constructor)
Constructs a new instance of the ContractDeployer class
📄️ ContractDeployer.addDeployListener() method
Listen to all deploy transactions from this deployer
📄️ ContractDeployer.deployEdition() method
Deploys a new Edition contract
📄️ ContractDeployer.deployEditionDrop() method
Deploys a new EditionDrop contract
📄️ ContractDeployer.deployMarketplace() method
Deploys a new Marketplace contract
📄️ ContractDeployer.deployMarketplaceV3() method
Deploys a new Marketplace-V3 contract
📄️ ContractDeployer.deployMultiwrap() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ ContractDeployer.deployNFTCollection() method
Deploys an NFT Collection contract
📄️ ContractDeployer.deployNFTDrop() method
Deploys a new NFTDrop contract
📄️ ContractDeployer.deployPack() method
Deploys a new Pack contract
📄️ ContractDeployer.deployProxy() method
Deploy a proxy contract of a given implementation directly
📄️ ContractDeployer.deployReleasedContract() method
Deploy any released contract by its name
📄️ ContractDeployer.deploySignatureDrop() method
Deploys a new SignatureDrop contract
📄️ ContractDeployer.deploySplit() method
Deploys a new Split contract
📄️ ContractDeployer.deployToken() method
Deploys a new Token contract
📄️ ContractDeployer.deployTokenDrop() method
Deploys a new Token Drop contract
📄️ ContractDeployer.deployViaFactory() method
Deploy a proxy contract of a given implementation via the given factory
📄️ ContractDeployer.deployVote() method
Deploys a new Vote contract
📄️ ContractDeployer class
Handles deploying new contracts
📄️ ContractDeployer.removeAllDeployListeners() method
Remove all deploy listeners
📄️ ContractDeployer.removeDeployListener() method
Remove a deploy listener
📄️ ContractDeployer.updateSignerOrProvider() method
Signature:
📄️ ContractEncoder.(constructor)
Constructs a new instance of the ContractEncoder class
📄️ ContractEncoder.decode() method
Decode encoded call data for a given function
📄️ ContractEncoder.encode() method
Encodes the given contract function with argument
📄️ ContractEncoder class
Encodes and decodes Contract functions
📄️ ContractEvent type
Standardized return type for contract events that returns event arguments
📄️ ContractEvents.(constructor)
Constructs a new instance of the ContractEvents class
📄️ ContractEvents.addEventListener() method
Subscribe to contract events
📄️ ContractEvents.addTransactionListener() method
Subscribe to transactions in this contract.
📄️ ContractEvents.contractWrapper property
Signature:
📄️ ContractEvents.getAllEvents() method
Get All Events
📄️ ContractEvents.getEvents() method
Get Events
📄️ ContractEvents.listenToAllEvents() method
Listen to all events emitted from this contract
📄️ ContractEvents class
Listen to Contract events in real time
📄️ ContractEvents.removeAllListeners() method
Remove all listeners on this contract
📄️ ContractEvents.removeEventListener() method
Remove an event listener from this contract
📄️ ContractEvents.removeTransactionListener() method
Remove a transaction listener
📄️ ContractForPrebuiltContractType type
Signature:
📄️ ContractInput type
Signature:
📄️ ContractInterceptor.(constructor)
Constructs a new instance of the ContractInterceptor class
📄️ ContractInterceptor class
Allows overriding transaction behavior for this contract
📄️ ContractInterceptor.overrideNextTransaction() method
The next transaction executed will add/replace any overrides passed via the passed in hook.
📄️ ContractMetadata.(constructor)
Constructs a new instance of the ContractMetadata class
📄️ ContractMetadata.featureName property
Signature:
📄️ ContractMetadata.get() method
Get the metadata of a contract
📄️ ContractMetadata class
Handles metadata for a Contract
📄️ ContractMetadata.set() method
Set the metadata of a contract
📄️ ContractMetadata.update() method
Update the metadata of a contract
📄️ ContractOwner.(constructor)
Constructs a new instance of the ContractOwner class
📄️ ContractOwner.featureName property
Signature:
📄️ ContractOwner.get() method
Return the current owner of the contract
📄️ ContractOwner class
Encodes and decodes Contract functions
📄️ ContractOwner.set() method
Set the new owner of the contract
📄️ ContractParam type
Signature:
📄️ ContractPlatformFee.(constructor)
Constructs a new instance of the ContractPlatformFee class
📄️ ContractPlatformFee.featureName property
Signature:
📄️ ContractPlatformFee.get() method
Get the platform fee recipient and basis points \*
📄️ ContractPlatformFee class
Handle platform fees and recipients
📄️ ContractPlatformFee.set() method
Set the platform fee recipient and basis points
📄️ ContractPrimarySale.(constructor)
Constructs a new instance of the ContractPrimarySale class
📄️ ContractPrimarySale.featureName property
Signature:
📄️ ContractPrimarySale.getRecipient() method
Get the primary sale recipient.
📄️ ContractPrimarySale class
Handle primary sales recipients
📄️ ContractPrimarySale.setRecipient() method
Set the primary sale recipient
📄️ ContractRoles.(constructor)
Constructs a new instance of the ContractRoles class
📄️ ContractRoles.featureName property
Signature:
📄️ ContractRoles.get() method
Call this to get a list of addresses that are members of a specific role.
📄️ ContractRoles.getAll() method
Call this to get get a list of addresses for all supported roles on the contract.
📄️ ContractRoles.grant() method
Call this to grant a role to a specific address.
📄️ ContractRoles class
Handle contract permissions
📄️ ContractRoles.revoke() method
Call this to revoke a role from a specific address.
📄️ ContractRoles.setAll() method
Call this to OVERWRITE the list of addresses that are members of specific roles.
📄️ ContractRoyalty.(constructor)
Constructs a new instance of the ContractRoyalty class
📄️ ContractRoyalty.featureName property
Signature:
📄️ ContractRoyalty.getDefaultRoyaltyInfo() method
Gets the royalty recipient and BPS (basis points) of the contract
📄️ ContractRoyalty.getTokenRoyaltyInfo() method
Gets the royalty recipient and BPS (basis points) of a particular token
📄️ ContractRoyalty class
Handle contract royalties
📄️ ContractRoyalty.setDefaultRoyaltyInfo() method
Set the royalty recipient and fee for a contract
📄️ ContractRoyalty.setTokenRoyaltyInfo() method
Set the royalty recipient and fee for a particular token
📄️ CONTRACTS\_MAP variable
Signature:
📄️ ContractsMap type
Signature:
📄️ ContractSource type
Signature:
📄️ ContractType type
Signature:
📄️ ContractWithMetadata type
Signature:
📄️ Currency type
Signature:
📄️ CurrencyValue type
Currency value and display value
📄️ DelayedReveal.(constructor)
Constructs a new instance of the DelayedReveal class
📄️ DelayedReveal.createDelayedRevealBatch() method
Create a batch of encrypted NFTs that can be revealed at a later time.
📄️ DelayedReveal.featureName property
Signature:
📄️ DelayedReveal.getBatchesToReveal() method
Gets the list of unrevealed NFT batches.
📄️ DelayedReveal class
Handles delayed reveal logic
📄️ DelayedReveal.reveal() method
Reveal a batch of hidden NFTs
📄️ DeployedContract type
Signature:
📄️ DeployEvent.contractAddress property
Signature:
📄️ DeployEvent interface
Signature:
📄️ DeployEvent.status property
Signature:
📄️ DeployEvent.transactionHash property
Signature:
📄️ DeployEvents.contractDeployed property
Signature:
📄️ DeployEvents interface
Signature:
📄️ DeployMetadata type
Signature:
📄️ DeployOptions type
Signature:
📄️ DeploySchemaForPrebuiltContractType type
Signature:
📄️ DirectListing.asset property
The asset being listed.
📄️ DirectListing.assetContractAddress property
The address of the asset being listed.
📄️ DirectListing.buyoutCurrencyValuePerToken property
The CurrencyValue of the listing. Useful for displaying the price information.
📄️ DirectListing.buyoutPrice property
The buyout price of the listing.
📄️ DirectListing.currencyContractAddress property
The address of the currency to accept for the listing.
📄️ DirectListing.id property
The id of the listing.
📄️ DirectListing interface
Represents a marketplace direct listing.
📄️ DirectListing.quantity property
The quantity of tokens to include in the listing.
📄️ DirectListing.secondsUntilEnd property
Number of seconds until the listing expires.
📄️ DirectListing.sellerAddress property
The address of the seller.
📄️ DirectListing.startTimeInSeconds property
The start time of the listing.
📄️ DirectListing.tokenId property
The ID of the token to list.
📄️ DirectListing.type property
Signature:
📄️ DirectListingV3.asset property
The asset being listed.
📄️ DirectListingV3.assetContractAddress property
The address of the asset being listed.
📄️ DirectListingV3.creatorAddress property
The address of the creator of listing.
📄️ DirectListingV3.currencyContractAddress property
The address of the currency to accept for the listing.
📄️ DirectListingV3.currencyValuePerToken property
The CurrencyValue of the listing. Useful for displaying the price information.
📄️ DirectListingV3.endTimeInSeconds property
The end time of the listing.
📄️ DirectListingV3.id property
The id of the listing.
📄️ DirectListingV3.isReservedListing property
Whether the listing is reserved to be bought from a specific set of buyers.
📄️ DirectListingV3 interface
Represents a marketplace direct listing.
📄️ DirectListingV3.pricePerToken property
The price to pay per unit of NFTs listed.
📄️ DirectListingV3.quantity property
The quantity of tokens to include in the listing.
📄️ DirectListingV3.startTimeInSeconds property
The start time of the listing.
📄️ DirectListingV3.status property
Whether the listing is CREATED, COMPLETED, or CANCELLED.
📄️ DirectListingV3.tokenId property
The ID of the token to list.
📄️ DropClaimConditions.(constructor)
Constructs a new instance of the DropClaimConditions class
📄️ DropClaimConditions.canClaim() method
Can Claim
📄️ DropClaimConditions.getActive() method
Get the currently active claim condition
📄️ DropClaimConditions.getAll() method
Get all the claim conditions
📄️ DropClaimConditions.getClaimArguments() method
Signature:
📄️ DropClaimConditions.getClaimerProofs() method
Returns allow list information and merkle proofs for the given address.
📄️ DropClaimConditions.getClaimIneligibilityReasons() method
For any claim conditions that a particular wallet is violating, this function returns human readable information about the breaks in the condition that can be used to inform the user.
📄️ DropClaimConditions.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ DropClaimConditions.isLegacyMultiPhaseDrop() method
Signature:
📄️ DropClaimConditions.isLegacySinglePhaseDrop() method
Signature:
📄️ DropClaimConditions.isNewMultiphaseDrop() method
Signature:
📄️ DropClaimConditions.isNewSinglePhaseDrop() method
Signature:
📄️ DropClaimConditions class
Manages claim conditions for NFT Drop contracts
📄️ DropClaimConditions.set() method
Set public mint conditions
📄️ DropClaimConditions.update() method
Update a single claim condition with new data.
📄️ DropErc1155ClaimConditions.(constructor)
Constructs a new instance of the DropErc1155ClaimConditions class
📄️ DropErc1155ClaimConditions.canClaim() method
Can Claim
📄️ DropErc1155ClaimConditions.getActive() method
Get the currently active claim condition
📄️ DropErc1155ClaimConditions.getAll() method
Get all the claim conditions
📄️ DropErc1155ClaimConditions.getClaimArguments() method
Signature:
📄️ DropErc1155ClaimConditions.getClaimerProofs() method
Returns allow list information and merkle proofs for the given address.
📄️ DropErc1155ClaimConditions.getClaimIneligibilityReasons() method
For any claim conditions that a particular wallet is violating, this function returns human-readable information about the breaks in the condition that can be used to inform the user.
📄️ DropErc1155ClaimConditions.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ DropErc1155ClaimConditions.isLegacyMultiPhaseDrop() method
Signature:
📄️ DropErc1155ClaimConditions.isLegacySinglePhaseDrop() method
Signature:
📄️ DropErc1155ClaimConditions.isNewMultiphaseDrop() method
Signature:
📄️ DropErc1155ClaimConditions.isNewSinglePhaseDrop() method
Signature:
📄️ DropErc1155ClaimConditions class
Manages claim conditions for Edition Drop contracts
📄️ DropErc1155ClaimConditions.prepareClaim() method
Returns proofs and the overrides required for the transaction.
📄️ DropErc1155ClaimConditions.set() method
Set claim conditions on a single NFT
📄️ DropErc1155ClaimConditions.setBatch() method
Set claim conditions on multiple NFTs at once
📄️ DropErc1155ClaimConditions.update() method
Update a single claim condition with new data.
📄️ DropErc1155History.(constructor)
Constructs a new instance of the DropErc1155History class
📄️ DropErc1155History.getAllClaimerAddresses() method
Get all claimer addresses
📄️ DropErc1155History class
Manages history for Edition Drop contracts
📄️ Edition.(constructor)
Constructs a new instance of the Edition class
📄️ Edition.abi property
Signature:
📄️ Edition.burn() method
Burn a specified amount of a NFT
📄️ Edition.contractRoles property
Signature:
📄️ Edition.encoder property
Signature:
📄️ Edition.erc1155 property
Signature:
📄️ Edition.estimator property
Signature:
📄️ Edition.events property
Signature:
📄️ Edition.getAddress() method
Signature:
📄️ Edition.getAll() method
Get All Minted NFTs
📄️ Edition.getMintTransaction() method
Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Edition.getOwned() method
Get Owned NFTs
📄️ Edition.getTotalCount() method
Get the number of NFTs minted
📄️ Edition.interceptor property
Signature:
📄️ Edition.isTransferRestricted() method
Get whether users can transfer NFTs from this contract
📄️ Edition class
Create a collection of NFTs that lets you mint multiple copies of each NFT.
📄️ Edition.metadata property
Signature:
📄️ Edition.mint() method
Mint NFT for the connected wallet
📄️ Edition.mintAdditionalSupply() method
Increase the supply of an existing NFT and mint it to the connected wallet
📄️ Edition.mintAdditionalSupplyTo() method
Increase the supply of an existing NFT and mint it to a given wallet address
📄️ Edition.mintBatch() method
Mint Many NFTs for the connected wallet
📄️ Edition.mintBatchTo() method
Mint Many NFTs with limited supplies
📄️ Edition.mintTo() method
Mint an NFT with a limited supply
📄️ Edition.owner property
Signature:
📄️ Edition.platformFees property
Signature:
📄️ Edition.roles property
Signature:
📄️ Edition.royalties property
Configure royalties
📄️ Edition.sales property
Signature:
📄️ Edition.signature property
Signature Minting
📄️ EditionDrop.(constructor)
Constructs a new instance of the EditionDrop class
📄️ EditionDrop.abi property
Signature:
📄️ EditionDrop.burnTokens() method
Burn a specified amount of a NFT
📄️ EditionDrop.checkout property
Checkout
📄️ EditionDrop.claim() method
Claim a token to the connected wallet
📄️ EditionDrop.claimConditions property
Configure claim conditions for each NFT
📄️ EditionDrop.claimTo() method
Claim NFTs to a specific Wallet
📄️ EditionDrop.createBatch() method
Create a batch of NFTs to be claimed in the future
📄️ EditionDrop.encoder property
Signature:
📄️ EditionDrop.erc1155 property
Signature:
📄️ EditionDrop.estimator property
Signature:
📄️ EditionDrop.events property
Signature:
📄️ EditionDrop.getAddress() method
Signature:
📄️ EditionDrop.getAll() method
Get All Minted NFTs
📄️ EditionDrop.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ EditionDrop.getOwned() method
Get Owned NFTs
📄️ EditionDrop.getTotalCount() method
Get the number of NFTs minted
📄️ EditionDrop.history property
Signature:
📄️ EditionDrop.interceptor property
Signature:
📄️ EditionDrop.isTransferRestricted() method
Get whether users can transfer NFTs from this contract
📄️ EditionDrop class
Setup a collection of NFTs with a customizable number of each NFT that are minted as users claim them.
📄️ EditionDrop.metadata property
Signature:
📄️ EditionDrop.owner property
Signature:
📄️ EditionDrop.platformFees property
Signature:
📄️ EditionDrop.roles property
Signature:
📄️ EditionDrop.royalties property
Configure royalties
📄️ EditionDrop.sales property
Signature:
📄️ EditionDropInitializer variable
Signature:
📄️ EditionInitializer variable
Signature:
📄️ EditionMetadataInput type
Signature:
📄️ EditionMetadataOrUri type
Signature:
📄️ EndDateSchema variable
Default to 10 years from now
📄️ EnglishAuction.asset property
The asset being auctioned.
📄️ EnglishAuction.assetContractAddress property
The address of the asset being auctioned.
📄️ EnglishAuction.bidBufferBps property
This is a buffer in basis points e.g. x%.
📄️ EnglishAuction.buyoutBidAmount property
The buyout price of the auction.
📄️ EnglishAuction.buyoutCurrencyValue property
The CurrencyValue of the buyout price. Useful for displaying the price information.
📄️ EnglishAuction.creatorAddress property
The address of the creator of auction.
📄️ EnglishAuction.currencyContractAddress property
The address of the currency to accept for the auction.
📄️ EnglishAuction.endTimeInSeconds property
The end time of the auction.
📄️ EnglishAuction.id property
The id of the auction
📄️ EnglishAuction interface
Represents a new marketplace english-auction.
📄️ EnglishAuction.minimumBidAmount property
The minimum price that a bid must be in order to be accepted.
📄️ EnglishAuction.minimumBidCurrencyValue property
The CurrencyValue of the minimum bid amount. Useful for displaying the price information.
📄️ EnglishAuction.quantity property
The quantity of tokens to include in the auction.
📄️ EnglishAuction.startTimeInSeconds property
The start time of the auction.
📄️ EnglishAuction.status property
Whether the listing is CREATED, COMPLETED, or CANCELLED.
📄️ EnglishAuction.timeBufferInSeconds property
This is a buffer e.g. x seconds.
📄️ EnglishAuction.tokenId property
The ID of the token to auction.
📄️ Erc1155.(constructor)
Constructs a new instance of the Erc1155 class
📄️ Erc1155.airdrop() method
Airdrop multiple NFTs
📄️ Erc1155.balance() method
Get NFT Balance for the currently connected wallet
📄️ Erc1155.balanceOf() method
Get NFT Balance
📄️ Erc1155.burn() method
Burn a specified amount of a NFTs
📄️ Erc1155.burnBatch() method
Burn a batch of NFTs
📄️ Erc1155.burnBatchFrom() method
Burn a batch of NFTs
📄️ Erc1155.burnFrom() method
Burn a specified amount of a NFTs
📄️ Erc1155.chainId property
Signature:
📄️ Erc1155.claim() method
Claim NFTs
📄️ Erc1155.claimConditions property
Configure claim conditions
📄️ Erc1155.claimTo() method
Claim NFTs to a specific Wallet
📄️ Erc1155.contractWrapper property
Signature:
📄️ Erc1155.featureName property
Signature:
📄️ Erc1155.get() method
Get a single NFT Metadata
📄️ Erc1155.getAddress() method
Signature:
📄️ Erc1155.getAll() method
Get All NFTs
📄️ Erc1155.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Erc1155.getMintTransaction() method
Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Erc1155.getOwned() method
Get Owned NFTs
📄️ Erc1155.isApproved() method
Get whether this wallet has approved transfers from the given operator
📄️ Erc1155.lazyMint() method
Create a batch of NFTs to be claimed in the future
📄️ Erc1155 class
Standard ERC1155 NFT functions
📄️ Erc1155.mint() method
Mint an NFT with a limited supply
📄️ Erc1155.mintAdditionalSupply() method
Increase the supply of an existing NFT
📄️ Erc1155.mintAdditionalSupplyTo() method
Increase the supply of an existing NFT and mint it to a given wallet address
📄️ Erc1155.mintBatch() method
Mint Many NFTs with limited supplies
📄️ Erc1155.mintBatchTo() method
Mint Many NFTs with limited supplies
📄️ Erc1155.mintTo() method
Mint an NFT with a limited supply
📄️ Erc1155.revealer property
Delayed reveal
📄️ Erc1155.signature property
Signature Minting
📄️ Erc1155.storage property
Signature:
📄️ Erc1155.totalCirculatingSupply() method
Get the supply of token for a given tokenId.
📄️ Erc1155.totalCount() method
Get the number of NFTs minted
📄️ Erc1155.totalSupply() method
Returns the total supply of a specific token
📄️ Erc1155.transfer() method
Transfer a single NFT
📄️ Erc1155BatchMintable.(constructor)
Constructs a new instance of the Erc1155BatchMintable class
📄️ Erc1155BatchMintable.featureName property
Signature:
📄️ Erc1155BatchMintable class
Mint Many ERC1155 NFTs at once
📄️ Erc1155BatchMintable.to() method
Mint Many NFTs with limited supplies
📄️ Erc1155Burnable.(constructor)
Constructs a new instance of the Erc1155Burnable class
📄️ Erc1155Burnable.batch() method
Burn a batch of NFTs
📄️ Erc1155Burnable.batchFrom() method
Burn a batch of NFTs
📄️ Erc1155Burnable.featureName property
Signature:
📄️ Erc1155Burnable.from() method
Burn a specified amount of a NFTs
📄️ Erc1155Burnable class
Signature:
📄️ Erc1155Burnable.tokens() method
Burn a specified amount of a NFTs
📄️ Erc1155Enumerable.(constructor)
Constructs a new instance of the Erc1155Enumerable class
📄️ Erc1155Enumerable.all() method
Get All NFTs
📄️ Erc1155Enumerable.featureName property
Signature:
📄️ Erc1155Enumerable class
List ERC1155 NFTs
📄️ Erc1155Enumerable.owned() method
Get Owned NFTs
📄️ Erc1155Enumerable.totalCirculatingSupply() method
Get the supply of token for a given tokenId.
📄️ Erc1155Enumerable.totalCount() method
Get the number of NFTs minted
📄️ Erc1155LazyMintable.(constructor)
Constructs a new instance of the Erc1155LazyMintable class
📄️ Erc1155LazyMintable.claim property
Signature:
📄️ Erc1155LazyMintable.claimWithConditions property
Claim tokens and configure claim conditions
📄️ Erc1155LazyMintable.featureName property
Signature:
📄️ Erc1155LazyMintable.lazyMint() method
Create a batch of NFTs to be claimed in the future
📄️ Erc1155LazyMintable class
Signature:
📄️ Erc1155LazyMintable.revealer property
Delayed reveal
📄️ Erc1155Mintable.(constructor)
Constructs a new instance of the Erc1155Mintable class
📄️ Erc1155Mintable.additionalSupplyTo() method
Increase the supply of an existing NFT and mint it to a given wallet address
📄️ Erc1155Mintable.batch property
Batch mint Tokens to many addresses
📄️ Erc1155Mintable.featureName property
Signature:
📄️ Erc1155Mintable.getMintTransaction() method
Signature:
📄️ Erc1155Mintable class
Mint ERC1155 NFTs
📄️ Erc1155Mintable.to() method
Mint an NFT with a limited supply
📄️ Erc1155SignatureMintable.(constructor)
Constructs a new instance of the Erc1155SignatureMintable class
📄️ Erc1155SignatureMintable.featureName property
Signature:
📄️ Erc1155SignatureMintable.generate() method
Generate a signature that can be used to mint an NFT dynamically.
📄️ Erc1155SignatureMintable.generateBatch() method
Generate a batch of signatures that can be used to mint many new NFTs dynamically.
📄️ Erc1155SignatureMintable.generateBatchFromTokenIds() method
Genrate a batch of signatures that can be used to mint new NFTs or additionaly supply to existing NFTs dynamically.
📄️ Erc1155SignatureMintable.generateFromTokenId() method
Generate a signature that can be used to mint additionaly supply to an existing NFT.
📄️ Erc1155SignatureMintable class
Enables generating dynamic ERC1155 NFTs with rules and an associated signature, which can then be minted by anyone securely
📄️ Erc1155SignatureMintable.mint() method
Mint a dynamically generated NFT
📄️ Erc1155SignatureMintable.mintBatch() method
Mint any number of dynamically generated NFT at once
📄️ Erc1155SignatureMintable.verify() method
Verify that a payload is correctly signed
📄️ ERC1155Wrappable type
Represents a certain amount of ERC1155 NFTs that can be wrapped
📄️ Erc20.(constructor)
Constructs a new instance of the Erc20 class
📄️ Erc20.allowance() method
Get Token Allowance
📄️ Erc20.allowanceOf() method
Get Token Allowance
📄️ Erc20.balance() method
Get Token Balance for the currently connected wallet
📄️ Erc20.balanceOf() method
Get Token Balance
📄️ Erc20.burn() method
Burn Tokens
📄️ Erc20.burnFrom() method
Burn Tokens
📄️ Erc20.chainId property
Signature:
📄️ Erc20.claim() method
Claim a certain amount of tokens to the connected Wallet
📄️ Erc20.claimConditions property
Configure claim conditions
📄️ Erc20.claimTo() method
Claim a certain amount of tokens to a specific Wallet
📄️ Erc20.contractWrapper property
Signature:
📄️ Erc20.featureName property
Signature:
📄️ Erc20.get() method
Get the token Metadata (name, symbol, etc...)
📄️ Erc20.getMintTransaction() method
Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Erc20 class
Standard ERC20 Token functions
📄️ Erc20.mint() method
Mint Tokens
📄️ Erc20.mintBatchTo() method
Mint Tokens To Many Wallets
📄️ Erc20.mintTo() method
Mint Tokens
📄️ Erc20.setAllowance() method
Allows the specified spender wallet to transfer the given amount of tokens to another wallet
📄️ Erc20.signature property
Signature Minting
📄️ Erc20.storage property
Signature:
📄️ Erc20.totalSupply() method
The total supply for this Token
📄️ Erc20.transfer() method
Transfer Tokens
📄️ Erc20.transferBatch() method
Transfer Tokens To Many Wallets
📄️ Erc20.transferFrom() method
Transfer Tokens From Address
📄️ Erc20BatchMintable.(constructor)
Constructs a new instance of the Erc20BatchMintable class
📄️ Erc20BatchMintable.featureName property
Signature:
📄️ Erc20BatchMintable class
Mint Many ERC20 Tokens at once
📄️ Erc20BatchMintable.to() method
Mint Tokens To Many Wallets
📄️ Erc20Burnable.(constructor)
Constructs a new instance of the Erc20Burnable class
📄️ Erc20Burnable.featureName property
Signature:
📄️ Erc20Burnable.from() method
Burn Tokens
📄️ Erc20Burnable class
Signature:
📄️ Erc20Burnable.tokens() method
Burn Tokens
📄️ Erc20Mintable.(constructor)
Constructs a new instance of the Erc20Mintable class
📄️ Erc20Mintable.batch property
Batch mint Tokens to many addresses
📄️ Erc20Mintable.featureName property
Signature:
📄️ Erc20Mintable.getMintTransaction() method
Signature:
📄️ Erc20Mintable class
Mint ERC20 Tokens
📄️ Erc20Mintable.to() method
Mint Tokens
📄️ Erc20SignatureMintable.(constructor)
Constructs a new instance of the Erc20SignatureMintable class
📄️ Erc20SignatureMintable.featureName property
Signature:
📄️ Erc20SignatureMintable.generate() method
Generate a signature that can be used to mint a certain amount of tokens
📄️ Erc20SignatureMintable.generateBatch() method
Generate a batch of signatures that can be used to mint many token signatures.
📄️ Erc20SignatureMintable class
Enables generating ERC20 Tokens with rules and an associated signature, which can then be minted by anyone securely
📄️ Erc20SignatureMintable.mint() method
Mint tokens from a signature
📄️ Erc20SignatureMintable.mintBatch() method
Mint any number of generated tokens signatures at once
📄️ Erc20SignatureMintable.verify() method
Verify that a payload is correctly signed
📄️ ERC20Wrappable type
Represents a certain amount of ERC20 tokens that can be wrapped
📄️ Erc721.(constructor)
Constructs a new instance of the Erc721 class
📄️ Erc721.balance() method
Get NFT Balance for the currently connected wallet
📄️ Erc721.balanceOf() method
Get NFT Balance
📄️ Erc721.burn() method
Burn a single NFT
📄️ Erc721.chainId property
Signature:
📄️ Erc721.claim() method
Claim unique NFTs to the connected wallet
📄️ Erc721.claimConditions property
Configure claim conditions
📄️ Erc721.claimTo() method
Claim unique NFTs to a specific Wallet
📄️ Erc721.contractWrapper property
Signature:
📄️ Erc721.featureName property
Signature:
📄️ Erc721.get() method
Get a single NFT Metadata
📄️ Erc721.getAddress() method
Signature:
📄️ Erc721.getAll() method
Get All Minted NFTs
📄️ Erc721.getAllOwners() method
Get All owners of minted NFTs on this contract
📄️ Erc721.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Erc721.getMintTransaction() method
Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Erc721.getOwned() method
Get Owned NFTs
📄️ Erc721.getOwnedTokenIds() method
Get all token ids of NFTs owned by a specific wallet.
📄️ Erc721.isApproved() method
Get whether this wallet has approved transfers from the given operator
📄️ Erc721.lazyMint() method
Create a batch of unique NFTs to be claimed in the future
📄️ Erc721 class
Standard ERC721 NFT functions
📄️ Erc721.mint() method
Mint a unique NFT
📄️ Erc721.mintBatch() method
Mint Many unique NFTs
📄️ Erc721.mintBatchTo() method
Mint Many unique NFTs
📄️ Erc721.mintTo() method
Mint a unique NFT
📄️ Erc721.ownerOf() method
Get the current owner of a given NFT within this Contract
📄️ Erc721.revealer property
Delayed reveal
📄️ Erc721.signature property
Signature Minting
📄️ Erc721.storage property
Signature:
📄️ Erc721.tieredDrop property
Tiered Drop
📄️ Erc721.totalCirculatingSupply() method
Get the total count NFTs minted in this contract
📄️ Erc721.totalClaimedSupply() method
Signature:
📄️ Erc721.totalCount() method
Get the number of NFTs minted
📄️ Erc721.totalUnclaimedSupply() method
Get the unclaimed supply
📄️ Erc721.transfer() method
Transfer a single NFT
📄️ Erc721BatchMintable.(constructor)
Constructs a new instance of the Erc721BatchMintable class
📄️ Erc721BatchMintable.featureName property
Signature:
📄️ Erc721BatchMintable class
Mint Many ERC721 NFTs at once
📄️ Erc721BatchMintable.to() method
Mint Many unique NFTs
📄️ Erc721Burnable.(constructor)
Constructs a new instance of the Erc721Burnable class
📄️ Erc721Burnable.featureName property
Signature:
📄️ Erc721Burnable class
Signature:
📄️ Erc721Burnable.token() method
Burn NFTs
📄️ Erc721ClaimableWithConditions.(constructor)
Constructs a new instance of the Erc721ClaimableWithConditions class
📄️ Erc721ClaimableWithConditions.conditions property
Configure claim conditions
📄️ Erc721ClaimableWithConditions.featureName property
Signature:
📄️ Erc721ClaimableWithConditions class
Configure and claim ERC721 NFTs
📄️ Erc721ClaimableWithConditions.to() method
Claim unique NFTs to a specific Wallet
📄️ Erc721Enumerable.(constructor)
Constructs a new instance of the Erc721Enumerable class
📄️ Erc721Enumerable.all() method
Get Owned NFTs
📄️ Erc721Enumerable.featureName property
Signature:
📄️ Erc721Enumerable class
List owned ERC721 NFTs
📄️ Erc721Enumerable.tokenIds() method
Get all token ids of NFTs owned by a specific wallet.
📄️ Erc721LazyMintable.(constructor)
Constructs a new instance of the Erc721LazyMintable class
📄️ Erc721LazyMintable.claim property
Signature:
📄️ Erc721LazyMintable.claimWithConditions property
Claim tokens and configure claim conditions
📄️ Erc721LazyMintable.featureName property
Signature:
📄️ Erc721LazyMintable.lazyMint() method
Create a batch of unique NFTs to be claimed in the future
📄️ Erc721LazyMintable class
Lazily mint and claim ERC721 NFTs
📄️ Erc721LazyMintable.revealer property
Delayed reveal
📄️ Erc721Mintable.(constructor)
Constructs a new instance of the Erc721Mintable class
📄️ Erc721Mintable.batch property
Signature:
📄️ Erc721Mintable.featureName property
Signature:
📄️ Erc721Mintable.getMintTransaction() method
Signature:
📄️ Erc721Mintable class
Mint ERC721 NFTs
📄️ Erc721Mintable.to() method
Mint a unique NFT
📄️ Erc721Supply.(constructor)
Constructs a new instance of the Erc721Supply class
📄️ Erc721Supply.all() method
Get All Minted NFTs
📄️ Erc721Supply.allOwners() method
Return all the owners of each token id in this contract
📄️ Erc721Supply.featureName property
Signature:
📄️ Erc721Supply class
List ERC721 NFTs
📄️ Erc721Supply.owned property
Signature:
📄️ Erc721Supply.totalCirculatingSupply() method
Get the number of NFTs of this contract currently owned by end users
📄️ Erc721Supply.totalCount() method
Get the number of NFTs minted
📄️ Erc721WithQuantitySignatureMintable.(constructor)
Constructs a new instance of the Erc721WithQuantitySignatureMintable class
📄️ Erc721WithQuantitySignatureMintable.featureName property
Signature:
📄️ Erc721WithQuantitySignatureMintable.generate() method
Generate a signature that can be used to mint a dynamic NFT
📄️ Erc721WithQuantitySignatureMintable.generateBatch() method
Genrate a batch of signatures that can be used to mint many dynamic NFTs.
📄️ Erc721WithQuantitySignatureMintable class
Enables generating dynamic ERC721 NFTs with rules and an associated signature, which can then be minted by anyone securely
📄️ Erc721WithQuantitySignatureMintable.mint() method
Mint a dynamically generated NFT
📄️ Erc721WithQuantitySignatureMintable.mintBatch() method
Mint any number of dynamically generated NFT at once
📄️ Erc721WithQuantitySignatureMintable.verify() method
Verify that a payload is correctly signed
📄️ ERC721Wrappable type
Represents a ERC721 NFT that can be wrapped
📄️ EventQueryOptions.filters property
Signature:
📄️ EventQueryOptions.fromBlock property
Signature:
📄️ EventQueryOptions interface
Filters for querying past events
📄️ EventQueryOptions.order property
Signature:
📄️ EventQueryOptions.toBlock property
Signature:
📄️ EventType enum
Signature:
📄️ ExtraPublishMetadata type
Signature:
📄️ fetchSnapshotEntryForAddress() function
Signature:
📄️ FilledConditionInput type
Signature:
📄️ FilledSignature721WithQuantity type
Signature:
📄️ FilledSignaturePayload1155 type
Signature:
📄️ FilledSignaturePayload1155WithTokenId type
Signature:
📄️ FilledSignaturePayload20 type
Signature:
📄️ FilledSignaturePayload721 type
Signature:
📄️ ForwardRequestMessage type
Forward Request Message that's used for gasless transaction
📄️ FullPublishMetadata type
Signature:
📄️ GasCostEstimator.(constructor)
Constructs a new instance of the GasCostEstimator class
📄️ GasCostEstimator.currentGasPriceInGwei() method
Returns the current gas price in gwei
📄️ GasCostEstimator.gasCostOf() method
Estimates the cost of gas in native token of the current chain Pass in the same parameters as the contract's function.
📄️ GasCostEstimator.gasLimitOf() method
Estimates the gas limit of a transaction Pass in the same parameters as the contract's function.
📄️ GasCostEstimator class
Estimates the gas cost of Contract calls
📄️ GaslessTransaction.callOverrides property
Signature:
📄️ GaslessTransaction.chainId property
Signature:
📄️ GaslessTransaction.data property
Signature:
📄️ GaslessTransaction.from property
Signature:
📄️ GaslessTransaction.functionArgs property
Signature:
📄️ GaslessTransaction.functionName property
Signature:
📄️ GaslessTransaction.gasLimit property
Signature:
📄️ GaslessTransaction interface
transaction message contains information that's needed to execute a gasless transaction
📄️ GaslessTransaction.to property
Signature:
📄️ GenericRequest variable
Signature:
📄️ getAllDetectedFeatureNames() function
Return all the detected features names in the abi
📄️ getAllDetectedFeatures() function
Return all the detected features in the abi
📄️ getChainProvider() function
Signature:
📄️ getContractName() function
Signature:
📄️ getNativeTokenByChainId() function
Returns the native token for a given chain
📄️ getReadOnlyProvider() function
Signature:
📄️ getRpcUrl() function
Signature:
📄️ isDowngradeVersion() function
Signature:
📄️ LINK\_TOKEN\_ADDRESS variable
Signature:
📄️ ListingType enum
Signature:
📄️ LOCAL\_NODE\_PKEY variable
publicly available wallet for local nodes
📄️ Marketplace.(constructor)
Constructs a new instance of the Marketplace class
📄️ Marketplace.abi property
Signature:
📄️ Marketplace.allowListingFromAnyAsset() method
Allow listings from any NFT contract
📄️ Marketplace.allowListingFromSpecificAssetOnly() method
Restrict listing NFTs only from the specified NFT contract address. It is possible to allow listing from multiple contract addresses.
📄️ Marketplace.auction property
Auctions
📄️ Marketplace.buyoutListing() method
Purchase NFTs
📄️ Marketplace.chainId property
Signature:
📄️ Marketplace.contractRoles property
Signature:
📄️ Marketplace.direct property
Direct listings
📄️ Marketplace.encoder property
Signature:
📄️ Marketplace.estimator property
Signature:
📄️ Marketplace.events property
Signature:
📄️ Marketplace.getActiveListings() method
Get all active listings
📄️ Marketplace.getAddress() method
Signature:
📄️ Marketplace.getAllListings() method
Get all the listings
📄️ Marketplace.getBidBufferBps() method
Get the buffer in basis points between offers
📄️ Marketplace.getListing() method
Convenience function to get either a direct or auction listing
📄️ Marketplace.getOffers() method
Get all the offers for a listing
📄️ Marketplace.getTimeBufferInSeconds() method
get the buffer time in seconds between offers
📄️ Marketplace.getTotalCount() method
Get the total number of Listings
📄️ Marketplace.isRestrictedToListerRoleOnly() method
Get whether listing is restricted only to addresses with the Lister role
📄️ Marketplace.makeOffer() method
Make an offer for a Direct or Auction Listing
📄️ Marketplace class
Create your own whitelabel marketplace that enables users to buy and sell any digital assets.
📄️ Marketplace.metadata property
Signature:
📄️ Marketplace.onNetworkUpdated() method
Signature:
📄️ Marketplace.platformFees property
Signature:
📄️ Marketplace.roles property
Signature:
📄️ Marketplace.setBidBufferBps() method
Set the Auction bid buffer
📄️ Marketplace.setTimeBufferInSeconds() method
Set the Auction Time buffer:
📄️ MarketplaceAuction.(constructor)
Constructs a new instance of the MarketplaceAuction class
📄️ MarketplaceAuction.buyoutListing() method
Buyout Auction
📄️ MarketplaceAuction.cancelListing() method
Cancel Auction Listing
📄️ MarketplaceAuction.closeListing() method
Close the Auction for the buyer or the seller
📄️ MarketplaceAuction.createListing() method
Create Auction
📄️ MarketplaceAuction.encoder property
Signature:
📄️ MarketplaceAuction.executeSale() method
Execute the Auction Sale
📄️ MarketplaceAuction.getAddress() method
Signature:
📄️ MarketplaceAuction.getBidBufferBps() method
Get the buffer in basis points between offers
📄️ MarketplaceAuction.getListing() method
Get an Auction listing by id
📄️ MarketplaceAuction.getMinimumNextBid() method
returns the minimum bid a user can place to outbid the previous highest bid
📄️ MarketplaceAuction.getWinner() method
Get Auction Winner
📄️ MarketplaceAuction.getWinningBid() method
Get Highest Bid
📄️ MarketplaceAuction.makeBid() method
Bid On Auction
📄️ MarketplaceAuction class
Handles auction listings
📄️ MarketplaceAuction.updateListing() method
Update an Auction listing with new metadata
📄️ MarketplaceContractDeployMetadata.description property
Optional description of the contract
📄️ MarketplaceContractDeployMetadata.external\_link property
Optional url for the contract
📄️ MarketplaceContractDeployMetadata.image property
Optional image for the contract
📄️ MarketplaceContractDeployMetadata interface
Options for deploying a Marketplace contract
📄️ MarketplaceContractDeployMetadata.name property
name of the contract
📄️ MarketplaceContractDeployMetadata.platform\_fee\_basis\_points property
The percentage (in basis points) of platform fees
📄️ MarketplaceContractDeployMetadata.platform\_fee\_recipient property
The address that will receive the proceeds from platform fees
📄️ MarketplaceContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ MarketplaceDirect.(constructor)
Constructs a new instance of the MarketplaceDirect class
📄️ MarketplaceDirect.acceptOffer() method
Accept an offer on a direct listing
📄️ MarketplaceDirect.buyoutListing() method
Buy a Listing
📄️ MarketplaceDirect.cancelListing() method
Cancel Direct Listing
📄️ MarketplaceDirect.createListing() method
Create Direct Listing
📄️ MarketplaceDirect.getActiveOffer() method
Get the active offer on a listing
📄️ MarketplaceDirect.getAddress() method
Signature:
📄️ MarketplaceDirect.getListing() method
Get a direct listing by id
📄️ MarketplaceDirect.makeOffer() method
Make an offer for a Direct Listing
📄️ MarketplaceDirect class
Handles direct listings
📄️ MarketplaceDirect.updateListing() method
Update a Direct listing with new metadata.
📄️ MarketplaceFilter interface
Signature:
📄️ MarketplaceFilter.offeror property
Signature:
📄️ MarketplaceFilter.seller property
Signature:
📄️ MarketplaceFilter.tokenContract property
Signature:
📄️ MarketplaceFilter.tokenId property
Signature:
📄️ MarketplaceInitializer variable
Signature:
📄️ MarketplaceV3.(constructor)
Constructs a new instance of the MarketplaceV3 class
📄️ MarketplaceV3.abi property
Signature:
📄️ MarketplaceV3.chainId property
Signature:
📄️ MarketplaceV3.contractRoles property
Signature:
📄️ MarketplaceV3.directListings property
Direct listings
📄️ MarketplaceV3.encoder property
Signature:
📄️ MarketplaceV3.englishAuctions property
Auctions
📄️ MarketplaceV3.estimator property
Signature:
📄️ MarketplaceV3.events property
Signature:
📄️ MarketplaceV3.getAddress() method
Signature:
📄️ MarketplaceV3 class
Create your own whitelabel marketplace that enables users to buy and sell any digital assets.
📄️ MarketplaceV3.metadata property
Signature:
📄️ MarketplaceV3.offers property
Offers
📄️ MarketplaceV3.onNetworkUpdated() method
Signature:
📄️ MarketplaceV3.platformFees property
Signature:
📄️ MarketplaceV3.roles property
Signature:
📄️ MarketplaceV3ContractDeployMetadata.description property
Optional description of the contract
📄️ MarketplaceV3ContractDeployMetadata.external\_link property
Optional url for the contract
📄️ MarketplaceV3ContractDeployMetadata.image property
Optional image for the contract
📄️ MarketplaceV3ContractDeployMetadata interface
Options for deploying a Marketplace-V3 contract
📄️ MarketplaceV3ContractDeployMetadata.name property
name of the contract
📄️ MarketplaceV3ContractDeployMetadata.platform\_fee\_basis\_points property
The percentage (in basis points) of platform fees
📄️ MarketplaceV3ContractDeployMetadata.platform\_fee\_recipient property
The address that will receive the proceeds from platform fees
📄️ MarketplaceV3ContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ MarketplaceV3Initializer variable
Signature:
📄️ sdk package
Classes
📄️ MintRequest1155 variable
Signature:
📄️ MintRequest20 variable
Signature:
📄️ MintRequest721 variable
Signature:
📄️ MintRequest721withQuantity variable
Signature:
📄️ Multiwrap.(constructor)
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.abi property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.contractRoles property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.encoder property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.estimator property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.events property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.getWrappedContents() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap class
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.metadata property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.owner property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.roles property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.royalties property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.unwrap() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Multiwrap.wrap() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ MultiwrapContractDeployMetadata.description property
Optional description of the contract
📄️ MultiwrapContractDeployMetadata.external\_link property
Optional url for the contract
📄️ MultiwrapContractDeployMetadata.fee\_recipient property
The address that will receive the proceeds from secondary sales (royalties)
📄️ MultiwrapContractDeployMetadata.image property
Optional image for the contract
📄️ MultiwrapContractDeployMetadata interface
Options for deploying an Multiwrap contract
📄️ MultiwrapContractDeployMetadata.name property
name of the contract
📄️ MultiwrapContractDeployMetadata.seller\_fee\_basis\_points property
The percentage (in basis points) of royalties for secondary sales
📄️ MultiwrapContractDeployMetadata.symbol property
Symbol for the NFTs
📄️ MultiwrapContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ MultiwrapInitializer variable
Signature:
📄️ NATIVE\_TOKEN\_ADDRESS variable
Signature:
📄️ NATIVE\_TOKENS variable
Signature:
📄️ NativeToken.decimals property
Signature:
📄️ NativeToken interface
Signature:
📄️ NativeToken.wrapped property
Signature:
📄️ NetworkInput type
Signature:
📄️ NewAuctionListing.assetContractAddress property
The address of the asset being listed.
📄️ NewAuctionListing.buyoutPricePerToken property
The buyout price of the listing.
📄️ NewAuctionListing.currencyContractAddress property
The address of the currency to accept for the listing.
📄️ NewAuctionListing.listingDurationInSeconds property
The duration of the listing in seconds.
📄️ NewAuctionListing interface
Represents a new marketplace auction listing.
📄️ NewAuctionListing.quantity property
The quantity of tokens to include in the listing.
📄️ NewAuctionListing.reservePricePerToken property
The reserve price is the minimum price that a bid must be in order to be accepted, per token.
📄️ NewAuctionListing.startTimestamp property
The start time of the listing.
📄️ NewAuctionListing.tokenId property
The ID of the token to list.
📄️ NewAuctionListing.type property
Signature:
📄️ NewDirectListing.assetContractAddress property
The address of the asset being listed.
📄️ NewDirectListing.buyoutPricePerToken property
The buyout price of the listing.
📄️ NewDirectListing.currencyContractAddress property
The address of the currency to accept for the listing.
📄️ NewDirectListing.listingDurationInSeconds property
The duration of the listing in seconds.
📄️ NewDirectListing interface
Represents a new marketplace direct listing.
📄️ NewDirectListing.quantity property
The quantity of tokens to include in the listing.
📄️ NewDirectListing.startTimestamp property
The start time of the listing.
📄️ NewDirectListing.tokenId property
The ID of the token to list.
📄️ NewDirectListing.type property
Signature:
📄️ NFT type
Signature:
📄️ NFTCollection.(constructor)
Constructs a new instance of the NFTCollection class
📄️ NFTCollection.abi property
Signature:
📄️ NFTCollection.burn() method
Burn a single NFT
📄️ NFTCollection.contractRoles property
Signature:
📄️ NFTCollection.encoder property
Signature:
📄️ NFTCollection.erc721 property
Signature:
📄️ NFTCollection.estimator property
Signature:
📄️ NFTCollection.events property
Signature:
📄️ NFTCollection.getAddress() method
Signature:
📄️ NFTCollection.getMintTransaction() method
Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ NFTCollection.isTransferRestricted() method
Get whether users can transfer NFTs from this contract
📄️ NFTCollection class
Create a collection of one-of-one NFTs.
📄️ NFTCollection.metadata property
Signature:
📄️ NFTCollection.mint() method
Mint a unique NFT
📄️ NFTCollection.mintBatch() method
Mint Many unique NFTs
📄️ NFTCollection.mintBatchTo() method
Mint Many unique NFTs
📄️ NFTCollection.mintTo() method
Mint a unique NFT
📄️ NFTCollection.owner property
Signature:
📄️ NFTCollection.platformFees property
Signature:
📄️ NFTCollection.roles property
Signature:
📄️ NFTCollection.royalties property
Configure royalties
📄️ NFTCollection.sales property
Signature:
📄️ NFTCollection.signature property
Signature Minting
📄️ NFTCollectionInitializer variable
Signature:
📄️ NFTContractDeployMetadata.description property
Optional description of the contract
📄️ NFTContractDeployMetadata.external\_link property
Optional url for the contract
📄️ NFTContractDeployMetadata.fee\_recipient property
The address that will receive the proceeds from secondary sales (royalties)
📄️ NFTContractDeployMetadata.image property
Optional image for the contract
📄️ NFTContractDeployMetadata interface
Options for deploying an NFT contract
📄️ NFTContractDeployMetadata.name property
name of the contract
📄️ NFTContractDeployMetadata.platform\_fee\_basis\_points property
The percentage (in basis points) of platform fees
📄️ NFTContractDeployMetadata.platform\_fee\_recipient property
The address that will receive the proceeds from platform fees
📄️ NFTContractDeployMetadata.primary\_sale\_recipient property
The address that will receive the proceeds from primary sales
📄️ NFTContractDeployMetadata.seller\_fee\_basis\_points property
The percentage (in basis points) of royalties for secondary sales
📄️ NFTContractDeployMetadata.symbol property
Symbol for the NFTs
📄️ NFTContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ NFTDrop.(constructor)
Constructs a new instance of the NFTDrop class
📄️ NFTDrop.abi property
Signature:
📄️ NFTDrop.balance() method
Get NFT Balance for the currently connected wallet
📄️ NFTDrop.balanceOf() method
Get NFT Balance
📄️ NFTDrop.burn() method
Burn a single NFT
📄️ NFTDrop.checkout property
Checkout
📄️ NFTDrop.claim() method
Claim NFTs to the connected wallet.
📄️ NFTDrop.claimConditions property
Configure claim conditions
📄️ NFTDrop.claimTo() method
Claim unique NFTs to a specific Wallet
📄️ NFTDrop.contractRoles property
Signature:
📄️ NFTDrop.createBatch() method
Create a batch of unique NFTs to be claimed in the future
📄️ NFTDrop.encoder property
Signature:
📄️ NFTDrop.erc721 property
Signature:
📄️ NFTDrop.estimator property
Signature:
📄️ NFTDrop.events property
Signature:
📄️ NFTDrop.get() method
Get a single NFT Metadata
📄️ NFTDrop.getAddress() method
Signature:
📄️ NFTDrop.getAllClaimed() method
Get All Claimed NFTs
📄️ NFTDrop.getAllUnclaimed() method
Get All Unclaimed NFTs
📄️ NFTDrop.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ NFTDrop.isApproved() method
Get whether this wallet has approved transfers from the given operator
📄️ NFTDrop.isTransferRestricted() method
Get whether users can transfer NFTs from this contract
📄️ NFTDrop class
Setup a collection of one-of-one NFTs that are minted as users claim them.
📄️ NFTDrop.metadata property
Signature:
📄️ NFTDrop.owner property
Signature:
📄️ NFTDrop.ownerOf() method
Get the current owner of a given NFT within this Contract
📄️ NFTDrop.platformFees property
Signature:
📄️ NFTDrop.revealer property
Delayed reveal
📄️ NFTDrop.roles property
Signature:
📄️ NFTDrop.royalties property
Configure royalties
📄️ NFTDrop.sales property
Signature:
📄️ NFTDrop.totalClaimedSupply() method
Get the claimed supply
📄️ NFTDrop.totalSupply() method
Get the total count NFTs in this drop contract, both claimed and unclaimed
📄️ NFTDrop.totalUnclaimedSupply() method
Get the unclaimed supply
📄️ NFTDrop.transfer() method
Transfer a single NFT
📄️ NFTDropInitializer variable
Signature:
📄️ NFTMetadata type
Signature:
📄️ NFTMetadataInput type
Signature:
📄️ NFTMetadataOrUri type
Signature:
📄️ Offer.buyerAddress property
The address of the buyer who made the offer.
📄️ Offer.currencyContractAddress property
The currency contract address of the offer token.
📄️ Offer.currencyValue property
The CurrencyValue of the listing. Useful for displaying the price information.
📄️ Offer.listingId property
The id of the listing.
📄️ Offer interface
Signature:
📄️ Offer.pricePerToken property
The amount of coins offered per token.
📄️ Offer.quantityDesired property
The quantity of tokens to be bought.
📄️ OfferV3.asset property
The asset to buy.
📄️ OfferV3.assetContractAddress property
The address of the asset being sought.
📄️ OfferV3.currencyContractAddress property
The address of the currency offered for the NFTs.
📄️ OfferV3.currencyValue property
The CurrencyValue of the listing. Useful for displaying the price information.
📄️ OfferV3.endTimeInSeconds property
The end time of the offer.
📄️ OfferV3.id property
The id of the offer.
📄️ OfferV3 interface
Represents a marketplace offer.
📄️ OfferV3.offerorAddress property
The address of the creator of offer.
📄️ OfferV3.quantity property
The quantity of tokens to buy.
📄️ OfferV3.status property
Whether the listing is CREATED, COMPLETED, or CANCELLED.
📄️ OfferV3.tokenId property
The ID of the token.
📄️ OfferV3.totalPrice property
The total offer amount for the NFTs.
📄️ Pack.(constructor)
Constructs a new instance of the Pack class
📄️ Pack.abi property
Signature:
📄️ Pack.addPackContents() method
Add Pack Contents
📄️ Pack.contractRoles property
Signature:
📄️ Pack.create() method
Create Pack
📄️ Pack.createTo() method
Create Pack To Wallet
📄️ Pack.encoder property
Signature:
📄️ Pack.erc1155 property
Signature:
📄️ Pack.estimator property
Signature:
📄️ Pack.events property
Signature:
📄️ Pack.get() method
Get a single Pack
📄️ Pack.getAddress() method
Signature:
📄️ Pack.getAll() method
Get All Packs
📄️ Pack.getOwned() method
Get Owned Packs
📄️ Pack.getPackContents() method
Get Pack Contents
📄️ Pack.getTotalCount() method
Get the number of packs created
📄️ Pack.isTransferRestricted() method
Get whether users can transfer packs from this contract
📄️ Pack class
Create lootboxes of NFTs with rarity based open mechanics.
📄️ Pack.metadata property
Signature:
📄️ Pack.open() method
Open Pack
📄️ Pack.owner property
Signature:
📄️ Pack.roles property
Signature:
📄️ Pack.royalties property
Configure royalties
📄️ Pack.vrf property
If enabled in the contract, use the Chainlink VRF functionality to open packs
📄️ PackInitializer variable
Signature:
📄️ PaperCreateCheckoutLinkShardParams type
The parameters for creating a paper.xyz checkout link.
📄️ PayloadToSign1155 type
Signature:
📄️ PayloadToSign1155WithTokenId type
Signature:
📄️ PayloadToSign20 type
Signature:
📄️ PayloadToSign721 type
Signature:
📄️ PayloadToSign721withQuantity type
Signature:
📄️ PayloadWithUri1155 type
Signature:
📄️ PayloadWithUri20 type
Signature:
📄️ PayloadWithUri721 type
Signature:
📄️ PayloadWithUri721withQuantity type
Signature:
📄️ PermitRequestMessage type
EIP-2612 token permit message for gasless transaction
📄️ PrebuiltContractsInstances type
Signature:
📄️ PrebuiltContractsMap type
Signature:
📄️ PrebuiltContractType type
Signature:
📄️ PreDeployMetadataFetched type
Signature:
📄️ Price type
Represents a currency price already formatted. ie. "1" for 1 ether.
📄️ ProfileMetadata type
Signature:
📄️ ProfileMetadataInput type
Signature:
📄️ ProfileSchemaOutput variable
Signature:
📄️ Proposal.description property
The description of the proposal.
📄️ Proposal.endBlock property
Signature:
📄️ Proposal.executions property
All executions that have been proposed for the proposal.
📄️ Proposal interface
Signature:
📄️ Proposal.proposalId property
The unique identifier of the proposal.
📄️ Proposal.proposer property
The address of the wallet that created the proposal.
📄️ Proposal.startBlock property
Signature:
📄️ Proposal.state property
The current state of the proposal.
📄️ Proposal.votes property
All votes that have been casted on the proposal.
📄️ ProposalExecutable interface
Signature:
📄️ ProposalExecutable.nativeTokenValue property
The amount of a native token that may be sent if a proposal is executing a token transfer.
📄️ ProposalExecutable.toAddress property
The address of the contract that the proposal will execute a transaction on. If the proposal is sending a token to a wallet, this address should be the address of the wallet that will be receiving the tokens.
📄️ ProposalExecutable.transactionData property
The transaction payload that will be executed if the proposal is approved.
📄️ ProposalState enum
Signature:
📄️ ProposalVote.count property
Signature:
📄️ ProposalVote.label property
Signature:
📄️ ProposalVote interface
Signature:
📄️ ProposalVote.type property
Signature:
📄️ PublishedContract type
Signature:
📄️ PublishedContractFetched type
Signature:
📄️ PublishedMetadata type
Signature:
📄️ QueryAllParams type
Pagination Parameters
📄️ RawDateSchema variable
Signature:
📄️ Role type
Signature:
📄️ SchemaForPrebuiltContractType type
Signature:
📄️ SDKOptions type
All these configuration options are optional with sane defaults:
📄️ SDKOptionsSchema variable
Signature:
📄️ ShardData type
Signature:
📄️ ShardedMerkleTreeInfo type
Signature:
📄️ ShardedSnapshot type
Signature:
📄️ SignatureDrop.(constructor)
Constructs a new instance of the SignatureDrop class
📄️ SignatureDrop.abi property
Signature:
📄️ SignatureDrop.burn() method
Burn a single NFT
📄️ SignatureDrop.checkout property
Checkout
📄️ SignatureDrop.claim() method
Claim NFTs to the connected wallet.
📄️ SignatureDrop.claimConditions property
Configure claim conditions
📄️ SignatureDrop.claimTo() method
Claim unique NFTs to a specific Wallet
📄️ SignatureDrop.contractRoles property
Signature:
📄️ SignatureDrop.createBatch() method
Create a batch of unique NFTs to be claimed in the future
📄️ SignatureDrop.encoder property
Signature:
📄️ SignatureDrop.erc721 property
Signature:
📄️ SignatureDrop.estimator property
Signature:
📄️ SignatureDrop.events property
Signature:
📄️ SignatureDrop.getAddress() method
Signature:
📄️ SignatureDrop.getAllClaimed() method
Get All Claimed NFTs
📄️ SignatureDrop.getAllUnclaimed() method
Get All Unclaimed NFTs
📄️ SignatureDrop.getClaimTransaction() method
Construct a claim transaction without executing it. This is useful for estimating the gas cost of a claim transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ SignatureDrop.isTransferRestricted() method
Get whether users can transfer NFTs from this contract
📄️ SignatureDrop class
Setup a collection of NFTs where when it comes to minting, you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party..
📄️ SignatureDrop.metadata property
Signature:
📄️ SignatureDrop.owner property
Signature:
📄️ SignatureDrop.platformFees property
Signature:
📄️ SignatureDrop.revealer property
Delayed reveal
📄️ SignatureDrop.roles property
Signature:
📄️ SignatureDrop.royalties property
Configure royalties
📄️ SignatureDrop.sales property
Signature:
📄️ SignatureDrop.signature property
Signature Minting
📄️ SignatureDrop.totalClaimedSupply() method
Get the claimed supply
📄️ SignatureDrop.totalSupply() method
Get the total count NFTs in this drop contract, both claimed and unclaimed
📄️ SignatureDrop.totalUnclaimedSupply() method
Get the unclaimed supply
📄️ SignatureDropInitializer variable
Signature:
📄️ SignedPayload1155 type
Signature:
📄️ SignedPayload20 type
Signature:
📄️ SignedPayload721 type
Signature:
📄️ SignedPayload721WithQuantitySignature type
Signature:
📄️ SignerOrProvider type
Signature:
📄️ SmartContract.(constructor)
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.abi property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.appURI property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.call() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.chainId property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.encoder property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.erc1155 property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.erc20 property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.erc721 property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.estimator property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.events property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.getAddress() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.interceptor property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract class
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.metadata property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.onNetworkUpdated() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.owner property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.platformFees property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.publishedMetadata property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.roles property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.royalties property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ SmartContract.sales property
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ Snapshot type
Signature:
📄️ SnapshotEntry type
Signature:
📄️ SnapshotEntryInput variable
Signature:
📄️ SnapshotEntryWithProofSchema variable
Signature:
📄️ SnapshotInfo type
Signature:
📄️ SnapshotInput type
Input model to pass a snapshot of addresses + amount claimable for a claim condition
📄️ Split.(constructor)
Constructs a new instance of the Split class
📄️ Split.abi property
Signature:
📄️ Split.balanceOf() method
Get Funds owed to a particular wallet
📄️ Split.balanceOfAllRecipients() method
Returns all the recipients and their balances in the native currency.
📄️ Split.balanceOfToken() method
Get non-native Token Funds owed to a particular wallet
📄️ Split.balanceOfTokenAllRecipients() method
Returns all the recipients and their balances in a non-native currency.
📄️ Split.chainId property
Signature:
📄️ Split.contractRoles property
Signature:
📄️ Split.distribute() method
Distribute Funds
📄️ Split.distributeToken() method
Distribute Funds
📄️ Split.encoder property
Signature:
📄️ Split.estimator property
Signature:
📄️ Split.events property
Signature:
📄️ Split.getAddress() method
Signature:
📄️ Split.getAllRecipients() method
Get Recipients of this splits contract
📄️ Split.getRecipientSplitPercentage() method
Get the % of funds owed to a given address
📄️ Split class
Create custom royalty splits to distribute funds.
📄️ Split.metadata property
Signature:
📄️ Split.onNetworkUpdated() method
Signature:
📄️ Split.roles property
Signature:
📄️ Split.withdraw() method
Withdraw Funds
📄️ Split.withdrawToken() method
Triggers a transfer to account of the amount of a given currency they are owed.
📄️ SplitContractDeployMetadata.description property
Optional description of the contract
📄️ SplitContractDeployMetadata.external\_link property
Optional url for the contract
📄️ SplitContractDeployMetadata.image property
Optional image for the contract
📄️ SplitContractDeployMetadata interface
Options for deploying Split contract
📄️ SplitContractDeployMetadata.name property
name of the contract
📄️ SplitContractDeployMetadata.recipients property
The list of recipients and their share of the split
📄️ SplitContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ SplitInitializer variable
Signature:
📄️ SplitRecipient.address property
The address of the recipient
📄️ SplitRecipient interface
The SplitRecipient type represents a recipient of some royalty, indicated by their split percentage.
📄️ SplitRecipient.splitPercentage property
The split of the recipient as a percentage of the total amount
📄️ SplitRecipientInput.address property
The recipient address
📄️ SplitRecipientInput interface
Signature:
📄️ SplitRecipientInput.sharesBps property
the shares in basis point (5% = 500) that address is owed from the total funds
📄️ StandardErc1155.(constructor)
Constructs a new instance of the StandardErc1155 class
📄️ StandardErc1155.airdrop() method
Airdrop multiple NFTs
📄️ StandardErc1155.balance() method
Get NFT Balance for the currently connected wallet
📄️ StandardErc1155.balanceOf() method
Get NFT Balance
📄️ StandardErc1155.chainId property
Signature:
📄️ StandardErc1155.contractWrapper property
Signature:
📄️ StandardErc1155.erc1155 property
Signature:
📄️ StandardErc1155.get() method
Get a single NFT Metadata
📄️ StandardErc1155.getAddress() method
Signature:
📄️ StandardErc1155.isApproved() method
Get whether this wallet has approved transfers from the given operator
📄️ StandardErc1155 class
Standard ERC1155 NFT functions
📄️ StandardErc1155.storage property
Signature:
📄️ StandardErc1155.totalSupply() method
Returns the total supply of a specific token
📄️ StandardErc1155.transfer() method
Transfer a single NFT
📄️ StandardErc20.(constructor)
Constructs a new instance of the StandardErc20 class
📄️ StandardErc20.allowance() method
Get Token Allowance
📄️ StandardErc20.allowanceOf() method
Get Token Allowance
📄️ StandardErc20.balance() method
Get Token Balance for the currently connected wallet
📄️ StandardErc20.balanceOf() method
Get Token Balance
📄️ StandardErc20.chainId property
Signature:
📄️ StandardErc20.contractWrapper property
Signature:
📄️ StandardErc20.erc20 property
Signature:
📄️ StandardErc20.get() method
Get the token Metadata (name, symbol, etc...)
📄️ StandardErc20 class
Standard ERC20 Token functions
📄️ StandardErc20.setAllowance() method
Allows the specified spender wallet to transfer the given amount of tokens to another wallet
📄️ StandardErc20.storage property
Signature:
📄️ StandardErc20.totalSupply() method
The total supply for this Token
📄️ StandardErc20.transfer() method
Transfer Tokens
📄️ StandardErc20.transferBatch() method
Transfer Tokens To Many Wallets
📄️ StandardErc20.transferFrom() method
Transfer Tokens From Address
📄️ StandardErc721.(constructor)
Constructs a new instance of the StandardErc721 class
📄️ StandardErc721.balance() method
Get NFT Balance for the currently connected wallet
📄️ StandardErc721.balanceOf() method
Get NFT Balance
📄️ StandardErc721.chainId property
Signature:
📄️ StandardErc721.contractWrapper property
Signature:
📄️ StandardErc721.erc721 property
Signature:
📄️ StandardErc721.get() method
Get a single NFT Metadata
📄️ StandardErc721.getAddress() method
Signature:
📄️ StandardErc721.getAll() method
Get All Minted NFTs
📄️ StandardErc721.getOwned() method
Get Owned NFTs
📄️ StandardErc721.getOwnedTokenIds() method
Get Owned Token Ids
📄️ StandardErc721.isApproved() method
Get whether this wallet has approved transfers from the given operator
📄️ StandardErc721 class
Standard ERC721 NFT functions
📄️ StandardErc721.ownerOf() method
Get the current owner of a given NFT within this Contract
📄️ StandardErc721.storage property
Signature:
📄️ StandardErc721.totalSupply() method
Get the total count NFTs minted in this contract
📄️ StandardErc721.transfer() method
Transfer a single NFT
📄️ StartDateSchema variable
Default to now
📄️ Status enum
Signature:
📄️ SUPPORTED\_CHAIN\_ID type
Signature:
📄️ SUPPORTED\_CHAIN\_IDS variable
Signature:
📄️ ThirdwebSDK.(constructor)
Constructs a new instance of the ThirdwebSDK class
📄️ ThirdwebSDK.auth property
Signature:
📄️ ThirdwebSDK.deployer property
New contract deployer
📄️ ThirdwebSDK.fromPrivateKey() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ ThirdwebSDK.fromSigner() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ ThirdwebSDK.fromWallet() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ ThirdwebSDK.getBalance() method
Get the native balance of a given address (wallet or contract)
📄️ ThirdwebSDK.getContract() method
Get an instance of a Custom ThirdwebContract
📄️ ThirdwebSDK.getContract() method
Get an instance of a Custom ThirdwebContract
📄️ ThirdwebSDK.getContract() method
Get an instance of a Custom ThirdwebContract
📄️ ThirdwebSDK.getContractFromAbi() method
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
📄️ ThirdwebSDK.getContractList() method
Return all the contracts deployed by the specified address
📄️ ThirdwebSDK.getEdition() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getEditionDrop() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getMarketplace() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getMarketplaceV3() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getMultichainContractList() method
Signature:
📄️ ThirdwebSDK.getMultiwrap() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getNFTCollection() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getNFTDrop() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getPack() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getSignatureDrop() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getSplit() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getToken() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getTokenDrop() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK.getVote() method
Warning: This API is now obsolete.
📄️ ThirdwebSDK class
The main entry point for the thirdweb SDK
📄️ ThirdwebSDK.multiChainRegistry property
The registry of deployed contracts
📄️ ThirdwebSDK.resolveContractType() method
Signature:
📄️ ThirdwebSDK.storage property
Upload and download files from IPFS or from your own storage service
📄️ ThirdwebSDK.updateSignerOrProvider() method
Update the active signer or provider for all contracts
📄️ ThirdwebSDK.wallet property
Interact with the connected wallet
📄️ toChainId() function
Signature:
📄️ Token.(constructor)
Constructs a new instance of the Token class
📄️ Token.abi property
Signature:
📄️ Token.burn() method
Burn Tokens
📄️ Token.burnFrom() method
Burn Tokens
📄️ Token.contractRoles property
Signature:
📄️ Token.encoder property
Signature:
📄️ Token.estimator property
Signature:
📄️ Token.events property
Signature:
📄️ Token.getDelegation() method
Get your voting delegatee address
📄️ Token.getDelegationOf() method
Get a specific address voting delegatee address
📄️ Token.getMintTransaction() method
Construct a mint transaction without executing it. This is useful for estimating the gas cost of a mint transaction, overriding transaction options and having fine grained control over the transaction execution.
📄️ Token.getVoteBalance() method
Get your wallet voting power for the current checkpoints
📄️ Token.getVoteBalanceOf() method
Signature:
📄️ Token.history property
Signature:
📄️ Token.isTransferRestricted() method
Get whether users can transfer tokens from this contract
📄️ Token class
Create a standard crypto token or cryptocurrency.
📄️ Token.metadata property
Signature:
📄️ Token.mint() method
Mint Tokens for the connected wallet
📄️ Token.mintBatchTo() method
Mint Tokens To Many Wallets
📄️ Token.mintTo() method
Mint Tokens
📄️ Token.platformFees property
Signature:
📄️ Token.roles property
Signature:
📄️ Token.sales property
Signature:
📄️ Token.signature property
Signature Minting
📄️ TokenContractDeployMetadata.description property
Optional description of the contract
📄️ TokenContractDeployMetadata.external\_link property
Optional url for the contract
📄️ TokenContractDeployMetadata.image property
Optional image for the contract
📄️ TokenContractDeployMetadata interface
Options for deploying a Token contract
📄️ TokenContractDeployMetadata.name property
name of the contract
📄️ TokenContractDeployMetadata.platform\_fee\_basis\_points property
The percentage (in basis points) of platform fees
📄️ TokenContractDeployMetadata.platform\_fee\_recipient property
The address that will receive the proceeds from platform fees
📄️ TokenContractDeployMetadata.primary\_sale\_recipient property
The address that will receive the proceeds from primary sales
📄️ TokenContractDeployMetadata.symbol property
Symbol for the NFTs
📄️ TokenContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ TokenDrop.(constructor)
Constructs a new instance of the TokenDrop class
📄️ TokenDrop.abi property
Signature:
📄️ TokenDrop.burnFrom() method
Burn Tokens
📄️ TokenDrop.burnTokens() method
Burn Tokens
📄️ TokenDrop.claim() method
Claim a certain amount of tokens
📄️ TokenDrop.claimConditions property
Configure claim conditions
📄️ TokenDrop.claimTo() method
Claim a certain amount of tokens to a specific Wallet
📄️ TokenDrop.contractRoles property
Signature:
📄️ TokenDrop.encoder property
Signature:
📄️ TokenDrop.estimator property
Signature:
📄️ TokenDrop.events property
Signature:
📄️ TokenDrop.getDelegation() method
Get your voting delegatee address
📄️ TokenDrop.getDelegationOf() method
Get a specific address voting delegatee address
📄️ TokenDrop.getVoteBalance() method
Get your wallet voting power for the current checkpoints
📄️ TokenDrop.getVoteBalanceOf() method
Signature:
📄️ TokenDrop.isTransferRestricted() method
Get whether users can transfer tokens from this contract
📄️ TokenDrop class
Create a Drop contract for a standard crypto token or cryptocurrency.
📄️ TokenDrop.metadata property
Signature:
📄️ TokenDrop.platformFees property
Signature:
📄️ TokenDrop.roles property
Signature:
📄️ TokenDrop.sales property
Signature:
📄️ TokenDropInitializer variable
Signature:
📄️ TokenERC20History.(constructor)
Constructs a new instance of the TokenERC20History class
📄️ TokenERC20History.getAllHolderBalances() method
Get all holder balances
📄️ TokenERC20History class
Manages history for Token contracts
📄️ TokenHolderBalance type
A token holder address and its current balance
📄️ TokenInitializer variable
Signature:
📄️ TokenMetadata type
Metadata for a token
📄️ TokenMintInput type
Signature:
📄️ TokensToWrap type
Input for wrapping any number of tokens
📄️ TransactionError.(constructor)
Constructs a new instance of the TransactionError class
📄️ TransactionError.info property
Signature:
📄️ TransactionError class
Signature:
📄️ TransactionError.reason property
Signature:
📄️ TransactionErrorInfo type
Signature:
📄️ TransactionResult type
Signature:
📄️ TransactionResultWithAddress type
Signature:
📄️ TransactionResultWithId type
Signature:
📄️ UnmappedOffer.currency property
The currency contract address of the offer token.
📄️ UnmappedOffer.expirationTimestamp property
The time where the offer expires
📄️ UnmappedOffer.listingId property
The listing that the offer was made on
📄️ UnmappedOffer interface
Signature:
📄️ UnmappedOffer.offeror property
The user who is making the offer.
📄️ UnmappedOffer.pricePerToken property
The amount of coins offered per token.
📄️ UnmappedOffer.quantityDesired property
The quantity of tokens to be bought.
📄️ UnmappedOffer.quantityWanted property
The amount of tokens desired.
📄️ UploadProgressEvent interface
Signature:
📄️ UploadProgressEvent.progress property
The number of bytes uploaded.
📄️ UploadProgressEvent.total property
The total number of bytes to be uploaded.
📄️ UserWallet.(constructor)
Constructs a new instance of the UserWallet class
📄️ UserWallet.balance() method
Fetch the native or ERC20 token balance of this wallet
📄️ UserWallet.connect() method
Signature:
📄️ UserWallet.events property
Signature:
📄️ UserWallet.getAddress() method
Get the currently connected address
📄️ UserWallet class
Connect and Interact with a user wallet
📄️ UserWallet.recoverAddress() method
Recover the signing address from a signed message
📄️ UserWallet.requestFunds() method
Request funds from a running local node to the currently connected wallet
📄️ UserWallet.sendRawTransaction() method
Send a raw transaction to the blockchain from the connected wallet
📄️ UserWallet.sign() method
Sign any message with the connected wallet private key
📄️ UserWallet.signTypedData() method
Sign a typed data structure (EIP712) with the connected wallet private key
📄️ UserWallet.transfer() method
Transfer native or ERC20 tokens from this wallet to another wallet
📄️ UserWalletEvents interface
UserWallet events that you can subscribe to using sdk.wallet.events.
📄️ UserWalletEvents.signerChanged property
Emitted when sdk.wallet.connect() is called.
📄️ ValidContractInstance type
Signature:
📄️ ValueOf type
Signature:
📄️ Vote.(constructor)
Constructs a new instance of the Vote class
📄️ Vote.abi property
Signature:
📄️ Vote.balance() method
Check the balance of the project wallet in the native token of the chain
📄️ Vote.balanceOfToken() method
Check the balance of the project wallet in a particular ERC20 token contract
📄️ Vote.canExecute() method
Can Execute
📄️ Vote.chainId property
Signature:
📄️ Vote.encoder property
Signature:
📄️ Vote.estimator property
Signature:
📄️ Vote.events property
Signature:
📄️ Vote.execute() method
Execute Proposal
📄️ Vote.get() method
Get a proposal by id.
📄️ Vote.getAddress() method
Signature:
📄️ Vote.getAll() method
Get All Proposals
📄️ Vote.getProposalVotes() method
Get the votes for a specific proposal
📄️ Vote.hasVoted() method
Check If Wallet Voted
📄️ Vote class
Create a decentralized organization for token holders to vote on proposals.
📄️ Vote.metadata property
Signature:
📄️ Vote.onNetworkUpdated() method
Signature:
📄️ Vote.propose() method
Create Proposal
📄️ Vote.settings() method
Get the Vote contract configuration
📄️ Vote.vote() method
Vote
📄️ VoteContractDeployMetadata.description property
Optional description of the contract
📄️ VoteContractDeployMetadata.external\_link property
Optional url for the contract
📄️ VoteContractDeployMetadata.image property
Optional image for the contract
📄️ VoteContractDeployMetadata interface
Options for deploying a Vote contract
📄️ VoteContractDeployMetadata.name property
name of the contract
📄️ VoteContractDeployMetadata.proposal\_token\_threshold property
The minimum amount in governance token owned to be able to create a proposal
📄️ VoteContractDeployMetadata.trusted\_forwarders property
Custom gasless trusted forwarder addresses
📄️ VoteContractDeployMetadata.voting\_delay\_in\_blocks property
The delay in blocks before voting can begin on proposals Specified in number of blocks. Assuming block time of around 13.14 seconds, 1 day = 6570 blocks, 1 week = 45992 blocks.
📄️ VoteContractDeployMetadata.voting\_period\_in\_blocks property
The duration in blocks of the open voting window Specified in number of blocks. Assuming block time of around 13.14 seconds, 1 day = 6570 blocks, 1 week = 45992 blocks.
📄️ VoteContractDeployMetadata.voting\_quorum\_fraction property
The minimum fraction to be met to pass a proposal
📄️ VoteContractDeployMetadata.voting\_token\_address property
The address of the governance token contract representing votes
📄️ VoteInitializer variable
Signature:
📄️ VoteSettings interface
Signature:
📄️ VoteSettings.proposalTokenThreshold property
Signature:
📄️ VoteSettings.votingDelay property
Signature:
📄️ VoteSettings.votingPeriod property
Signature:
📄️ VoteSettings.votingQuorumFraction property
Signature:
📄️ VoteSettings.votingTokenAddress property
Signature:
📄️ VoteSettings.votingTokenMetadata property
Signature:
📄️ VoteType enum
Signature:
📄️ WrappedTokens type
Output for the contents of a bundle wrapped token