Skip to main content

sdk package

Classes

ClassDescription
ContractDeployerHandles deploying new contracts
ContractEncoderEncodes and decodes Contract functions
ContractEventsListen to Contract events in real time
ContractInterceptorAllows overriding transaction behavior for this contract
ContractMetadataHandles metadata for a Contract
ContractOwnerEncodes and decodes Contract functions
ContractPlatformFeeHandle platform fees and recipients
ContractPrimarySaleHandle primary sales recipients
ContractRolesHandle contract permissions
ContractRoyaltyHandle contract royalties
DelayedRevealHandles delayed reveal logic
DropClaimConditionsManages claim conditions for NFT Drop contracts
DropErc1155ClaimConditionsManages claim conditions for Edition Drop contracts
DropErc1155HistoryManages history for Edition Drop contracts
EditionCreate a collection of NFTs that lets you mint multiple copies of each NFT.
EditionDropSetup a collection of NFTs with a customizable number of each NFT that are minted as users claim them.
Erc1155Standard ERC1155 NFT functions
Erc1155BatchMintableMint Many ERC1155 NFTs at once
Erc1155Burnable
Erc1155EnumerableList ERC1155 NFTs
Erc1155LazyMintable
Erc1155MintableMint ERC1155 NFTs
Erc1155SignatureMintableEnables generating dynamic ERC1155 NFTs with rules and an associated signature, which can then be minted by anyone securely
Erc20Standard ERC20 Token functions
Erc20BatchMintableMint Many ERC20 Tokens at once
Erc20Burnable
Erc20MintableMint ERC20 Tokens
Erc20SignatureMintableEnables generating ERC20 Tokens with rules and an associated signature, which can then be minted by anyone securely
Erc721Standard ERC721 NFT functions
Erc721BatchMintableMint Many ERC721 NFTs at once
Erc721Burnable
Erc721ClaimableWithConditionsConfigure and claim ERC721 NFTs
Erc721EnumerableList owned ERC721 NFTs
Erc721LazyMintableLazily mint and claim ERC721 NFTs
Erc721MintableMint ERC721 NFTs
Erc721SupplyList ERC721 NFTs
Erc721WithQuantitySignatureMintableEnables generating dynamic ERC721 NFTs with rules and an associated signature, which can then be minted by anyone securely
GasCostEstimatorEstimates the gas cost of Contract calls
MarketplaceCreate your own whitelabel marketplace that enables users to buy and sell any digital assets.
MarketplaceAuctionHandles auction listings
MarketplaceDirectHandles direct listings
Multiwrap(BETA) Multiwrap lets you wrap any number of ERC20, ERC721 and ERC1155 tokens you own into a single wrapped token bundle.
NFTCollectionCreate a collection of one-of-one NFTs.
NFTDropSetup a collection of one-of-one NFTs that are minted as users claim them.
PackCreate lootboxes of NFTs with rarity based open mechanics.
SignatureDropSetup 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..
SplitCreate custom royalty splits to distribute funds.
StandardErc1155Standard ERC1155 NFT functions
StandardErc20Standard ERC20 Token functions
StandardErc721Standard ERC721 NFT functions
ThirdwebSDKThe main entry point for the thirdweb SDK
TokenCreate a standard crypto token or cryptocurrency.
TokenDropCreate a Drop contract for a standard crypto token or cryptocurrency.
TokenERC20HistoryManages history for Token contracts
TransactionError
UserWalletConnect and Interact with a user wallet
VoteCreate a decentralized organization for token holders to vote on proposals.
WalletAuthenticator(BETA) Wallet Authenticator

Enumerations

EnumerationDescription
ChainId
ClaimEligibility
EventType
ListingType
ProposalState
VoteType

Functions

FunctionDescription
getNativeTokenByChainId(chainId)Returns the native token for a given chain
getReadOnlyProvider(network, chainId)
isDowngradeVersion(current, next)

Interfaces

InterfaceDescription
AuctionListingRepresents a new marketplace auction listing.
BatchToReveal
DirectListingRepresents a marketplace direct listing.
EventQueryFilterFilters for querying past events
GaslessTransactiontransaction message contains information that's needed to execute a gasless transaction
MarketplaceContractDeployMetadataOptions for deploying a Marketplace contract
MarketplaceFilter
MultiwrapContractDeployMetadataOptions for deploying an Multiwrap contract
NativeToken
NewAuctionListingRepresents a new marketplace auction listing.
NewDirectListingRepresents a new marketplace direct listing.
NFTContractDeployMetadataOptions for deploying an NFT contract
Offer
Proposal
ProposalExecutable
ProposalVote
QueryAllParamsPagination Parameters
SplitContractDeployMetadataOptions for deploying Split contract
SplitRecipientThe SplitRecipient type represents a recipient of some royalty, indicated by their split percentage.
SplitRecipientInput
TokenContractDeployMetadataOptions for deploying a Token contract
UnmappedOffer
UploadProgressEvent
UserWalletEventsUserWallet events that you can subscribe to using sdk.wallet.events.
VoteContractDeployMetadataOptions for deploying a Vote contract
VoteSettings

Variables

VariableDescription
ALL_ROLES
CONTRACTS_MAP
EditionDropInitializer
EditionInitializer
MarketplaceInitializer
MintRequest1155
MintRequest20
MintRequest721
MintRequest721withQuantity
MultiwrapInitializer
NATIVE_TOKEN_ADDRESS
NATIVE_TOKENS
NFTCollectionInitializer
NFTDropInitializer
PackInitializer
ProfileSchemaOutput
SDKOptionsSchema
SignatureDropInitializer
SplitInitializer
SUPPORTED_CHAIN_IDS
TokenDropInitializer
TokenInitializer
VoteInitializer

Type Aliases

Type AliasDescription
AbiEvent
AbiFunction
AirdropInputInput model to pass a list of addresses + amount to transfer to each one
AmountRepresents a currency amount already formatted. ie. "1" for 1 ether.
AuthenticationOptions
AuthenticationPayload
AuthenticationPayloadData
ClaimConditionRepresents a claim condition fetched from the SDK
ClaimConditionInputInput model to create a claim condition with optional snapshot of wallets
ClaimConditionsForToken
ClaimOptions
ClaimVerification
CommonContractSchemaInput
ContractEventStandardized return type for contract events that returns event arguments
ContractForPrebuiltContractType
ContractParam
ContractsMap
ContractSource
ContractType
Currency
CurrencyValueCurrency value and display value
DeploySchemaForPrebuiltContractType
EditionMetadataInput
EditionMetadataOrUri
ERC1155WrappableRepresents a certain amount of ERC1155 NFTs that can be wrapped
ERC20WrappableRepresents a certain amount of ERC20 tokens that can be wrapped
ERC721WrappableRepresents a ERC721 NFT that can be wrapped
ExtraPublishMetadata
FilledConditionInput
FilledSignature721WithQuantity
FilledSignaturePayload1155
FilledSignaturePayload1155WithTokenId
FilledSignaturePayload20
FilledSignaturePayload721
ForwardRequestMessageForward Request Message that's used for gasless transaction
FullPublishMetadata
LoginOptions
LoginPayload
LoginPayloadData
NetworkOrSignerOrProvider
NFT
NFTMetadata
NFTMetadataInput
NFTMetadataOrUri
PaperCreateCheckoutLinkShardParamsThe parameters for creating a paper.xyz checkout link.
PayloadToSign1155
PayloadToSign1155WithTokenId
PayloadToSign20
PayloadToSign721
PayloadToSign721withQuantity
PayloadWithUri1155
PayloadWithUri20
PayloadWithUri721
PayloadWithUri721withQuantity
PermitRequestMessageEIP-2612 token permit message for gasless transaction
PrebuiltContractsMap
PrebuiltContractType
PreDeployMetadataFetched
PriceRepresents a currency price already formatted. ie. "1" for 1 ether.
ProfileMetadata
ProfileMetadataInput
PublishedContract
PublishedContractFetched
PublishedMetadata
Role
SchemaForPrebuiltContractType
SDKOptionsAll these configuration options are optional with sane defaults:
SignedPayload1155
SignedPayload20
SignedPayload721
SignedPayload721WithQuantitySignature
SignerOrProvider
Snapshot
SnapshotInfo
SnapshotInputInput model to pass a snapshot of addresses + amount claimable for a claim condition
SUPPORTED_CHAIN_ID
TokenHolderBalanceA token holder address and its current balance
TokenMetadataMetadata for a token
TokenMintInput
TokensToWrapInput for wrapping any number of tokens
TransactionResult
TransactionResultWithAddress
TransactionResultWithId
ValidContractInstance
ValueOf
VerifyOptions
WrappedTokensOutput for the contents of a bundle wrapped token