1616## Installation
1717
1818``` shell
19+ # Forge projects
20+ forge install https://github.com/thirdweb-dev/contracts
21+
22+ # Hardhat / npm based projects
1923npm i @thirdweb-dev/contracts
2024```
2125
26+ ``` bash
27+ contracts
28+ |
29+ | -- extension: " extensions that can be inherited by NON-upgradeable contracts"
30+ | | -- interface: " interfaces of all extension contracts"
31+ | | -- upgradeable: " extensions that can be inherited by upgradeable contracts"
32+ | | -- [$prebuilt -category]: " legacy extensions written specifically for a prebuilt contract"
33+ |
34+ | -- base: " NON-upgradeable base contracts to build on top of"
35+ | | -- interface: " interfaces for all base contracts"
36+ | | -- upgradeable: " upgradeable base contracts to build on top of"
37+ |
38+ | -- prebuilt: " audited, ready-to-deploy thirdweb smart contracts"
39+ | | -- interface: " interfaces for all prebuilt contracts"
40+ | | --[$prebuilt -category]: " feature-based group of prebuilt contracts"
41+ | | -- unaudited: " yet-to-audit thirdweb smart contracts"
42+ | | -- [$prebuilt -category]: " feature-based group of prebuilt contracts"
43+ |
44+ | -- infra: " onchain infrastructure contracts"
45+ | | -- interface: " interfaces for all infrastructure contracts"
46+ |
47+ | -- eip: " implementations of relevant EIP standards"
48+ | | -- interface " all interfaces of relevant EIP standards"
49+ |
50+ | -- lib: " Solidity libraries"
51+ |
52+ | -- external-deps: " modified / copied over external dependencies"
53+ | | -- openzeppelin: " modified / copied over openzeppelin dependencies"
54+ | | -- chainlink: " modified / copied over chainlink dependencies"
55+ |
56+ | -- legacy-contracts: " maintained legacy thirdweb contracts"
57+ ```
58+
2259## Running Tests
2360
24611 . ` yarn ` : install contracts dependencies
@@ -51,8 +88,6 @@ forge test
5188
5289Pre-built contracts are written by the thirdweb team, and cover the most common use cases for smart contracts.
5390
54- Release pages for pre-built contracts:
55-
5691- [ DropERC20] ( https://thirdweb.com/deployer.thirdweb.eth/DropERC20 )
5792- [ DropERC721] ( https://thirdweb.com/deployer.thirdweb.eth/DropERC721 )
5893- [ DropERC1155] ( https://thirdweb.com/deployer.thirdweb.eth/DropERC1155 )
@@ -77,27 +112,6 @@ Other (smaller) blocks are Features, which provide a way for you to pick and cho
77112
78113[ Learn more about extensions] ( https://portal.thirdweb.com/extensions )
79114
80- ## Deployments
81-
82- The thirdweb registry (` TWRegistry ` ) and factory (` TWFactory ` ) have been deployed on the following chains:
83-
84- - [ Ethereum mainnet] ( https://etherscan.io/ )
85- - [ Rinkeby] ( https://rinkeby.etherscan.io/ )
86- - [ Goerli] ( https://goerli.etherscan.io/ )
87- - [ Polygon mainnet] ( https://polygonscan.com/ )
88- - [ Polygon Mumbai testnet] ( https://mumbai.polygonscan.com/ )
89- - [ Avalanche mainnet] ( https://snowtrace.io/ )
90- - [ Avalanche Fuji testnet] ( https://testnet.snowtrace.io/ )
91- - [ Fantom mainnet] ( https://ftmscan.com/ )
92- - [ Fantom testnet] ( https://testnet.ftmscan.com/ )
93-
94- ` 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.
95-
96- - ` TWRegistry ` : [ 0x7c487845f98938Bb955B1D5AD069d9a30e4131fd] ( https://blockscan.com/address/0x7c487845f98938Bb955B1D5AD069d9a30e4131fd )
97-
98- - ` TWFactory ` : [ 0x5DBC7B840baa9daBcBe9D2492E45D7244B54A2A0] ( https://blockscan.com/address/0x5DBC7B840baa9daBcBe9D2492E45D7244B54A2A0 )
99- - ` TWFactory ` (Fantom mainnet): [ 0x97EA0Fcc552D5A8Fb5e9101316AAd0D62Ea0876B] ( https://blockscan.com/address/0x97EA0Fcc552D5A8Fb5e9101316AAd0D62Ea0876B )
100-
101115## Contract Audits
102116
103117- [ Audit 1] ( audit-reports/audit-1.pdf )
0 commit comments