Skip to main content

Contract Deployer

Deploy smart contracts from the connected wallet.

deployBuiltInContract​

Deploy one of thirdweb’s prebuilt contracts.

const txResult = await sdk.deployer.deployBuiltInContract("{{contract-type}}", {
  name: "My Contract",
  primary_sale_recipient: "{{wallet_address}}",
  voting_token_address: "{{wallet_address}}", // Only used for Vote
});
Configuration

contractType​

The name of the contract to deploy.

Must be one of the following string values:

"nft-drop" |
  "edition-drop" |
  "edition" |
  "marketplace" |
  "marketplace-v3" |
  "multiwrap" |
  "nft-collection" |
  "pack" |
  "signature-drop" |
  "split" |
  "token-drop" |
  "token" |
  "vote";

contractMetadata​

An object containing the metadata for the contract to deploy.

{
  // Required parameters
  name: "My Contract", // Name of the contract
  primary_sale_recipient: "{{wallet_address}}", // Wallet address to receive funds from sales
  voting_token_address: "{{wallet_address}}", // Only used for Vote

  // Optional metadata
  app_uri: "https://example.com", // Website of your contract dApp
  description: "This is a great contract", // Description of your contract
  external_link: "https://example.com", // External link to view contract info on your website
  symbol: "MYCON", // Symbol of the contract tokens
  image: "https://some-image-here.png", // Image to use for the contract

  // Optional Platform fee information
  platform_fee_basis_points: 100,
  platform_fee_recipient: "{{wallet_address}}",

  // Optional Royalty fee information
  fee_recipient: "{{wallet_address}}",
  seller_fee_basis_points: 100,

  // Optional Vote specific parameters
  proposal_token_threshold: 100,
  voting_delay_in_blocks: 100,
  voting_period_in_blocks: 100,
  voting_quorum_fraction: 0.5,

  // Optional split specific parameters
  recipients: [
    {
      address: "{{wallet_address}}",
      sharesBps: 100,
    },
  ],

  // Optional Gasless specific parameters
  trusted_forwarders: ["{{wallet_address}}"],
};

deployPublishedContract​

Deploys any published contract

const txResult = await sdk.deployer.deployPublishedContract(
  "{{publisher_address_or_ens}}",
  "{{contract_name}}",
  [param1, param2],
);
Details

publisher address​

address or ENS of the publisher address. ex: deployer.thirdweb.eth

contract name​

the name of the published contract to deploy. ex: TokenERC721

constructor arguments​

array of constructor arguments for the contract.

version​

version of the published contract. defaults to 'latest'.

deployProxy​

Deploy a proxy contract of a given implementation directly

const txResult = await sdk.deployer.deployProxy(
  "{{implementation_contract_address}}",
  implementationAbi,
  "initialize",
  [1, 2, 3],
);
Configuration

implementationAddress​

The address of the implementation contract to deploy.

Must be a string.

implementationAbi​

The ABI of the implementation contract to deploy.

Must be a ContractInterface.

initializeFunction​

The name of the function to call on the implementation contract after deployment.

Must be a string.

initializeArgs​

The arguments to pass to the initializeFunction function.

Must be an Array<any>.

deployViaFactory​

Deploy a proxy contract of a given implementation via the given factory.

const txResult = await sdk.deployer.deployViaFactory(
  "{{factory_contract_address}}",
  "{{implementation_contract_address}}",
  implementationAbi,
  "initialize",
  [1, 2, 3],
);
Configuration

factoryAddress​

The address of the factory contract to deploy via.

Must be a string.

implementationAddress​

The address of the implementation contract to deploy.

Must be a string.

implementationAbi​

The ABI of the implementation contract to deploy.

Must be a ContractInterface.

initializeFunction​

The name of the function to call on the implementation contract after deployment.

Must be a string.

initializeArgs​

The arguments to pass to the initializeFunction function.

Must be an array of any values.