Skip to main content

Publish

Use the CLI to publish your contracts directly to Any EVM compatible chain using the dashboard:

npx thirdweb publish

This command will:

  • Compile your smart contract.
  • Upload the contract source code (ABI) to IPFS.
  • Open the publish flow in the dashboard.

Options​

 -p--path <string>
  Path to project

 -f--file <string>
  Filter for contract files that contain this file name

 -cn--contract-name <string>
  Filter for contracts that contain this contract name

 -c--clean
  Clear the cache before building

 --dry-run
  Dry run (skip actually publishing)

 -d--debug
  Show debug logs

 --ci
  Continuous Integration mode

 -k--key <string>
  Optional parameter to use passed in secret key, most useful for continuous integration use cases

How to Publish Your Contract​

In your browser, follow the steps below to publish your contract:

Configure Contract Metadata​

From the dashboard, provide the metadata for your smart contract including:

  • Name
  • Image
  • Description
  • README - Markdown is supported. What your contract does, common use cases & examples are great things to include here.

Enter Contract Metadata

Add A Version & Audit Report (Optional)​

Use semantic versioning to incrementally publish new versions of your smart contract; ideal for when you want to make changes to your smart contract but don't want to break existing integrations.

Each version of your smart contract is stored on-chain and can be deployed by anyone. You can optionally include release notes, to describe the changes you've made between versions.

You can also link each version to an audit report. You can paste a link to it, or drag and drop a PDF. We will generate an IPFS link for you.

Versioned Releases

Choose how users will deploy your published contract​

Select the contract type for your published contract

  • Direct Deploy: Choose this option if your contract does not follow the upgradeable contract pattern.
    • This option can be used for any contract
    • there are no requirements for using this option to publish your contract.
    • Users will deploy the full contract: storage and implementation logic.
  • Deploy via Factory: Choose this option if you would like users to deploy proxies of your contract using the thirdweb default factory contract or using your own pre-deployed custom factory.
    • Default Factory - Use this option to use the thirdweb default factory if your contract follows the upgradeable contract pattern.
    • Custom Factory - Use this option to use your own pre-deployed custom factory to create proxies for your users.

Choose Contract Type

Once selected, click "Next" to move on to the flow corresponding to the contract type selected.

Choose which network(s) to publish your contract to​

Select the network(s) you would like to publish your contract. You can select multiple networks or any EVM.

Choose Network

If you chose to publish via direct deploy, you will be asked to select the network(s) you would like users to be able to deploy your contract to and then click the "Next" button. If you chose to publish via factory, you will be asked to select the network(s) you would like users to be able to deploy your contract to when setting your "Factory deploy settings".

Customize Contract Parameters​

Help users trying to deploy your smart contract by changing what your contract parameters look like. These are fields that users need to enter before deploying your contract with each field corresponding to the associated variable in the constructor of your contract.

  • Display name: Use this to have a more readable version of the parameter name. Otherwise, the parameter name from the contract will be shown as is.
  • Default value: This will be pre-filled in the deploy form. Use this to guide users on what value to enter. If the parameter is of the address datatype, you can pre-fill the users connected wallet address by setting the default value as {{connected_wallet}}
  • Description: Use this to clear up any confusion and explain what value this parameter is expecting
  • Advanced: Tick this option if you want to hide this parameter from the deploy form. This is useful for parameters that are not required to be changed by the user. This option is only available for parameters that have a default value.

Describe Constructor Parameters

Publish Contract​

Finally, click the "Publish Contract" button to publish your smart contract to the on-chain registry.

For best practices and getting your contract on Explore, refer to this page.