Getting Started

Create a project using this example:

npx thirdweb create --contract --template hardhat-javascript-starter

You can start editing the page by modifying contracts/Contract.sol.

To add functionality to your contracts, you can use the @thirdweb-dev/contracts package which provides base contracts and extensions to inherit. The package is already installed with this project. Head to our Contracts Extensions Docs to learn more.

Building the project

After any changes to the contract, run:

npm run build
# or
yarn build

to compile your contracts. This will also detect the Contracts Extensions Docs detected on your contract.

Deploying Contracts

When you're ready to deploy your contracts, just run one of the following command to deploy you're contracts:

npm run deploy
# or
yarn deploy

Important

This requires a secret key to make it work. Get your secret key here. Pass your secret key as a value after -k flag.

npm run deploy -- -k <your-secret-key>
# or
yarn deploy -k <your-secret-key>

Releasing Contracts

If you want to release a version of your contracts publicly, you can use one of the followings command:

npm run release
# or
yarn release

Join our Discord!

For any questions, suggestions, join our discord at https://discord.gg/thirdweb.