Collection of smart contracts deployable via the thirdweb SDK, dashboard and CLI
\n \n\n## Installation\n\n```shell\nnpm i @thirdweb-dev/contracts\n```\n\n## Running Tests\n\n1. `yarn`: install contracts dependencies\n2. `forge install`: install tests dependencies\n3. `forge test`: run the tests\n\nThis repository is a hybrid [hardhat](https://hardhat.org/) and [forge](https://github.com/foundry-rs/foundry/tree/master/forge) project.\n\nFirst install the relevant dependencies of the project:\n\n```bash\nyarn\n\nforge install\n```\n\nTo compile contracts, run:\n\n```bash\nforge build\n```\n\nOr, if you prefer hardhat, you can run:\n\n```bash\nnpx hardhat compile\n```\n\nTo run tests:\n\n```bash\nforge test\n```\n\nTo export the ABIs of the contracts in the `/contracts` directory, run:\n\n```\nnpx hardhat export-abi\n```\n\nTo run any scripts in the `/scripts` directory, run:\n\n```\nnpx hardhat run scripts/{path to the script}\n```\n\n## Pre-built Contracts\n\nPre-built contracts are written by the thirdweb team, and cover the most common use cases for smart contracts.\n\nRelease pages for pre-built contracts:\n\n- [DropERC20](https://thirdweb.com/deployer.thirdweb.eth/DropERC20)\n- [DropERC721](https://thirdweb.com/deployer.thirdweb.eth/DropERC721)\n- [DropERC1155](https://thirdweb.com/deployer.thirdweb.eth/DropERC1155)\n- [SignatureDrop](https://thirdweb.com/deployer.thirdweb.eth/SignatureDrop)\n- [Marketplace](https://thirdweb.com/deployer.thirdweb.eth/Marketplace)\n- [Multiwrap](https://thirdweb.com/deployer.thirdweb.eth/Multiwrap)\n- [TokenERC20](https://thirdweb.com/deployer.thirdweb.eth/TokenERC20)\n- [TokenERC721](https://thirdweb.com/deployer.thirdweb.eth/TokenERC721)\n- [TokenERC1155](https://thirdweb.com/deployer.thirdweb.eth/TokenERC1155)\n- [VoteERC20](https://thirdweb.com/deployer.thirdweb.eth/VoteERC20)\n- [Split](https://thirdweb.com/deployer.thirdweb.eth/Split)\n\n[Learn more about pre-built contracts](https://portal.thirdweb.com/pre-built-contracts)\n\n## Extensions\n\nExtensions are building blocks that help enrich smart contracts with features.\n\nSome blocks come packaged together as Base Contracts, which come with a full set of features out of the box that you can modify and extend. These contracts are available at `contracts/base/`.\n\nOther (smaller) blocks are Features, which provide a way for you to pick and choose which individual pieces you want to put into your contract; with full customization of how those features work. These are available at `contracts/extension/`.\n\n[Learn more about extensions](https://portal.thirdweb.com/extensions)\n\n## Deployments\n\nThe thirdweb registry (`TWRegistry`) and factory (`TWFactory`) have been deployed on the following chains:\n\n- [Ethereum mainnet](https://etherscan.io/)\n- [Rinkeby](https://rinkeby.etherscan.io/)\n- [Goerli](https://goerli.etherscan.io/)\n- [Polygon mainnet](https://polygonscan.com/)\n- [Polygon Mumbai testnet](https://mumbai.polygonscan.com/)\n- [Avalanche mainnet](https://snowtrace.io/)\n- [Avalanche Fuji testnet](https://testnet.snowtrace.io/)\n- [Fantom mainnet](https://ftmscan.com/)\n- [Fantom testnet](https://testnet.ftmscan.com/)\n\n`TWRegistry` is deployed to a common address on all mentioned networks. `TWFactory` is deployed to a common address on all mentioned networks except Fantom mainnet.\n\n- `TWRegistry`: [0x7c487845f98938Bb955B1D5AD069d9a30e4131fd](https://blockscan.com/address/0x7c487845f98938Bb955B1D5AD069d9a30e4131fd)\n\n- `TWFactory`: [0x5DBC7B840baa9daBcBe9D2492E45D7244B54A2A0](https://blockscan.com/address/0x5DBC7B840baa9daBcBe9D2492E45D7244B54A2A0)\n- `TWFactory` (Fantom mainnet): [0x97EA0Fcc552D5A8Fb5e9101316AAd0D62Ea0876B](https://blockscan.com/address/0x97EA0Fcc552D5A8Fb5e9101316AAd0D62Ea0876B)\n\n\n## Bug reports\n\nFound a security issue with our smart contracts? Send bug reports to security@thirdweb.com and we'll continue communicating with you from there. We're actively developing a bug bounty program; bug report payouts happen on a case by case basis, for now.\n\n## Feedback\n\nIf you have any feedback, please reach out to us at support@thirdweb.com.\n\n## Authors\n\n- [thirdweb](https://thirdweb.com)\n\n## License\n\n[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)\n","readmeFilename":"README.md"}
![\"\"/](\"https://github.com/thirdweb-dev/typescript-sdk/blob/main/logo.svg?raw=true\"){kind=logo}
![\"npm](\"https://img.shields.io/npm/v/@thirdweb-dev/contracts?color=red&logo=npm\")
![\"Build](\"https://github.com/thirdweb-dev/contracts/actions/workflows/tests.yml/badge.svg\"/){kind=icon}
\n![\"Join](\"https://img.shields.io/discord/834227967404146718.svg?color=7289da&label=discord&logo=discord&style=flat\"/)
\n\n