Rest
...args: [metadata: AirdropContractDeployMetadata, options?: DeployOptions]Rest
...args: [metadata: AirdropContractDeployMetadata, options?: DeployOptions]Rest
...args: [metadata: AirdropContractDeployMetadata, options?: DeployOptions]Rest
...args: [metadata: AirdropContractDeployMetadata, options?: DeployOptions]Rest
...args: [metadata: AirdropContractDeployMetadata, options?: DeployOptions]Rest
...args: [metadata: AirdropContractDeployMetadata, options?: DeployOptions]Deploys a new Edition contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys an Edition contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployEdition({
name: "My Edition",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploys a new EditionDrop contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys an Edition Drop contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployEditionDrop({
name: "My Edition Drop",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploys a new LoyaltyCard contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a LoyaltyCard contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployLoyaltyCard({
name: "My Loyalty Program",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploys a new Marketplace contract
Rest
...args: [metadata: MarketplaceContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Marketplace contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployMarketplace({
name: "My Marketplace",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: MarketplaceContractDeployMetadata, options?: DeployOptions]Deploys a new Marketplace-V3 contract
Rest
...args: [metadata: MarketplaceV3ContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Marketplace-V3 contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployMarketplaceV3({
name: "My Marketplace",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: MarketplaceV3ContractDeployMetadata, options?: DeployOptions]Beta
Deploys a new Multiwrap contract
Rest
...args: [metadata: MultiwrapContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Multiwrap contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployMultiwrap({
name: "My Multiwrap",
});
Rest
...args: [metadata: MultiwrapContractDeployMetadata, options?: DeployOptions]Deploys an NFT Collection contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys an NFT Collection contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployNFTCollection({
name: "My Collection",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploys a new NFTDrop contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys an NFT Drop contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployNFTDrop({
name: "My Drop",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploys a new OpenEditionERC721 contract
Rest
...args: [metadata: OpenEditionContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a OpenEdition contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployOpenEdition({
name: "My Open Edition",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: OpenEditionContractDeployMetadata, options?: DeployOptions]Deploys a new Pack contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Pack contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployPack({
name: "My Pack",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploy a proxy contract of a given implementation directly
Rest
...args: [implementationAddress: string, implementationAbi: ContractInterface, initializerFunction: string, initializerArgs: any[]]Rest
...args: [implementationAddress: string, implementationAbi: ContractInterface, initializerFunction: string, initializerArgs: any[]]Deploy any published contract by its name
Rest
...args: [publisherAddress: string, contractName: string, constructorParams: any[], version: any, options?: DeployOptions]Rest
...args: [publisherAddress: string, contractName: string, constructorParams: any[], version: any, options?: DeployOptions]Deploy any published contract by its name
Rest
...args: [publisherAddress: string, contractName: string, constructorParams: any[], version: any, options?: DeployOptions]use deployPublishedContract instead
Rest
...args: [publisherAddress: string, contractName: string, constructorParams: any[], version: any, options?: DeployOptions]Deploys a new SignatureDrop contract
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a SignatureDrop contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deploySignatureDrop({
name: "My Signature Drop",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: NFTContractDeployMetadata, options?: DeployOptions]Deploys a new Split contract
Rest
...args: [metadata: SplitContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Split contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deploySplit({
name: "My Split",
primary_sale_recipient: "your-address",
recipients: [
{
address: "your-address",
sharesBps: 80 * 100, // 80%
},
{
address: "another-address",
sharesBps: 20 * 100, // 20%
},
],
});
Rest
...args: [metadata: SplitContractDeployMetadata, options?: DeployOptions]Deploys a new Token contract
Rest
...args: [metadata: TokenContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Token contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployToken({
name: "My Token",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: TokenContractDeployMetadata, options?: DeployOptions]Deploys a new Token Drop contract
Rest
...args: [metadata: TokenContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys a Token Drop contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployTokenDrop({
name: "My Token Drop",
primary_sale_recipient: "your-address",
});
Rest
...args: [metadata: TokenContractDeployMetadata, options?: DeployOptions]Deploy a proxy contract of a given implementation via thirdweb's Clone factory
Rest
...args: [publishMetadataUri: string, deployMetadata: DeployMetadata, signer: Signer, initializerFunction: string, paramValues: any[], options?: DeployOptions]Rest
...args: [publishMetadataUri: string, deployMetadata: DeployMetadata, signer: Signer, initializerFunction: string, paramValues: any[], options?: DeployOptions]Deploy a proxy contract of a given implementation via a custom factory
Rest
...args: [constructorParamValues: any[], deployMetadata: DeployMetadata, signer: Signer, chainId: number]Rest
...args: [constructorParamValues: any[], deployMetadata: DeployMetadata, signer: Signer, chainId: number]Deploy a proxy contract of a given implementation via the given factory
Rest
...args: [factoryAddress: string, implementationAddress: string, implementationAbi: ContractInterface, initializerFunction: string, initializerArgs: any[], saltForProxyDeploy?: string]Rest
...args: [factoryAddress: string, implementationAddress: string, implementationAbi: ContractInterface, initializerFunction: string, initializerArgs: any[], saltForProxyDeploy?: string]Deploys a new Vote contract
Rest
...args: [metadata: VoteContractDeployMetadata, options?: DeployOptions]the address of the deployed contract
Deploys an Vote contract and returns the address of the deployed contract
const contractAddress = await sdk.deployer.deployVote({
name: "My Vote",
primary_sale_recipient: "your-address",
voting_token_address: "your-token-contract-address",
});
Rest
...args: [metadata: VoteContractDeployMetadata, options?: DeployOptions]Private
eventsReadonly
optionsOptional
clientOptional
gasless?: ({ openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; }; experimentalChainlessSupport: boolean; }) | ({ biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; }; })Optional
gatewayOptional
readonlyOptional
secretPrivate
storageListen to all deploy transactions from this deployer
the listener to add
Deploy any published contract by its name
the name of the contract to deploy
the constructor params to pass to the contract
the address of the publisher
Optional
saltForCreate2: stringOptional: salt for create2 deployment, will determine deployment address
Private
fetchPrivate
getOptional
options: DeployOptionsPrivate
hasPredict Create2 address of a contract
the name of the contract
the constructor params to pass to the contract
the address of the publisher
Optional
saltForCreate2: stringOptional: salt for create2 deployment, will determine deployment address
Remove a deploy listener
the listener to remove
Private
transactionPrivate
updateGenerated using TypeDoc
Handles deploying new contracts