6 |
7 |
8 | 
9 |
10 | A curated list of awesome EIP2535 Diamonds resources, libraries, tools and more.
13 |Please check the contribution guidelines for information on formatting and writing pull requests.
14 | 15 | 16 | # Official 17 | 18 | * [EIP2535 Diamonds](https://eips.ethereum.org/EIPS/eip-2535) - Standard. 19 | * [EIP2535 Diamonds discussion thread](https://github.com/ethereum/EIPs/issues/2535) - Github issue created to discuss Diamonds. 20 | * [Twitter @eip2535](https://twitter.com/eip2535) - Twitter handle. 21 | * [EIP2535 Blog](https://eip2535diamonds.substack.com/) - Technical articles about diamonds. 22 | * [EIP2535 Discord Server](https://discord.gg/kQewPw2) - Discord server for discussing EIP2535 Diamonds and related things. 23 | * [Diamond reference implementation comparisons](https://github.com/mudgen/diamond) - Compares Diamond reference implementations. 24 | * [diamond-1-hardhat](https://github.com/mudgen/diamond-1-hardhat) - Simple Diamond reference implementation. 25 | * [diamond-2-hardhat](https://github.com/mudgen/diamond-2-hardhat) - Gas-optimized Diamond reference implementation. 26 | * [diamond-3-hardhat](https://github.com/mudgen/diamond-3-hardhat) - Simple loupe (introspecting functions) Diamond reference implementation. 27 | 28 | # Websites 29 | 30 | * [info.diamonds](https://www.info.diamonds/) 31 | 32 | # Articles 33 | 34 | ### Diamonds 35 | 36 | * [Introduction to EIP-2535 Diamonds](https://eip2535diamonds.substack.com/p/introduction-to-the-diamond-standard?s=w) - Explains the problem diamonds were initially developed to solve, how they work, how to organize them, and how to deploy and upgrade them. 37 | * [Compliance with EIP-2535 Diamonds Standard](https://eip2535diamonds.substack.com/p/compliance-with-eip-2535-diamonds) - How implementations can comply with the standard. 38 | * [EIP-2535: A Technical Overview of the Diamond Smart Contract Standard](https://hackmd.io/@Jesserc/HkZXGpC6j) - Overview and tutorial. 39 | * [EIP-2535: A standard for organizing and upgrading a modular smart contract system.](https://soliditydeveloper.com/eip-2535) - Describes what diamonds are, how they work and how to use them. 40 | * [Diamond Loupe Functions](https://dev.to/mudgen/why-loupe-functions-for-diamonds-1kc3) - Explains the need and use of loupe functions (diamond introspecting functions). 41 | * [How to Share Functions Between Facets of a Diamond](https://eip2535diamonds.substack.com/p/how-to-share-functions-between-facets?s=w) - Shows ways to share functionality between facets of a diamond. 42 | * [A Beginner’s Guide to The Diamond Standard Proxy](https://blessingemah.medium.com/a-beginners-guide-to-the-diamond-standard-proxy-b57076365403) - Explains EIP-2535 Diamonds. 43 | * [Idiots Guide to Using an EIP-2535 Diamond Proxy](https://andrewedwards.substack.com/p/coming-soon) 44 | * [EIP 2535: Diamond standard explained — Part 1: Why diamonds?](https://bitsbyblocks.com/eip-2535-diamond-standard-explained-part-1-why-diamonds/) 45 | * [EIP 2535: Diamond standard explained – Part 2: What are diamonds and how they work](https://bitsbyblocks.com/eip-2535-diamond-standard-explained-part-2-what-are-diamonds-and-how-they-work/) 46 | * [EIP 2535: Diamond standard explained – Part 3: Understanding storage patterns in diamonds](https://bitsbyblocks.com/eip-2535-diamond-standard-explained-part-3-understanding-storage-patterns-in-diamonds/) 47 | * [The Diamond Standard (EIP-2535) Explained: Part 1](https://www.quicknode.com/guides/smart-contract-development/the-diamond-standard-eip-2535-explained-part-1) 48 | * [ The Diamond Standard (EIP-2535) Explained: Part 2](https://www.quicknode.com/guides/smart-contract-development/the-diamond-standard-eip-2535-explained-part-2) 49 | * [A better way to initialize upgradeable contracts](https://medium.com/@gweiworld/a-new-better-way-to-initialize-upgradeable-contracts-39080d72f066) - Shows how to execute initialization functions during diamond upgrades. 50 | * [An Introduction to ERC2535 Diamonds Development And Why Solidity Devs Should Adopt It](https://proggr.hashnode.dev/ooo-shiny-an-introduction-to-erc2535-diamonds-development-and-why-solidity-devs-should-adopt-it) 51 | * [Transforming web3 through a Diamond Management System](https://medium.com/@alexeluca.spataru/transforming-web3-through-a-diamond-management-system-d2efa560ea7f) 52 | * [Achieving Universal and Reusable Smart Contracts via ERC2535 Diamond Proxy Standard](https://medium.com/@alexeluca.spataru/achieving-universal-and-reusable-smart-contracts-via-erc2535-diamond-proxy-standard-ba4c9f5ac5bc) 53 | * [A guide to building and deploying upgradeable contracts on CELO with Diamond standard](https://docs.celo.org/blog/tutorials/a-guide-to-building-and-deploying-upgradeable-contracts-on-celo-with-diamond-standard) 54 | * [How to use TypeScript with EIP-2535: Diamonds](https://dev.to/erhant/how-to-use-typescript-with-eip-2535-diamonds-3gl6) 55 | * [Multiple NFT and ERC-20 tokens backed by a single diamond](https://hiddentao.com/archives/2023/08/08/building-multiple-nft-and-erc-20-tokens-backed-by-a-single-upgradeable-smart-contract) 56 | 57 | ### Diamond Storage 58 | 59 | * [How Diamond Storage Works](https://dev.to/mudgen/how-diamond-storage-works-90e) - Explains diamond storage and shows an example. 60 | * [New Storage Layout For Proxy Contracts and Diamonds](https://medium.com/1milliondevs/new-storage-layout-for-proxy-contracts-and-diamonds-98d01d0eadb) - First written article that describes diamond storage. 61 | * [AppStorage Pattern for State Variables in Solidity](https://eip2535diamonds.substack.com/p/appstorage-pattern-for-state-variables?s=w) - Describes and shows AppStorage. 62 | * [Rules for Upgrading Diamond Storage](https://eip2535diamonds.substack.com/p/diamond-upgrades) - Best documentation about upgrading Diamond Storage. 63 | * [Migrating the EIP-2535 Diamond Storage layout](https://medium.com/@0xFluffyBeard/migrating-the-eip-2535-diamond-storage-layout-cb28b9c47e71) - Shows Diamond Storage and how to migrate data to new Diamond Storage in upgrades. 64 | 65 | ### Diamond Deployment and Upgrades 66 | 67 | * [Diamond Upgrades](https://eip2535diamonds.substack.com/p/diamond-upgrades?s=w) - How to perform diamond upgrades. 68 | * [Example of Adding New State Variables in Diamond Upgrade](https://eip2535diamonds.substack.com/p/example-of-a-diamond-upgrade?s=w) - Shows how to add new state variables to a diamond. 69 | * [Initializing an EIP-2535 Diamond for deployment and upgrades](https://eip2535diamonds.substack.com/p/initializing-an-eip-2535-diamond) 70 | * [A better way to initialize upgradeable contracts](https://medium.com/@gweiworld/a-new-better-way-to-initialize-upgradeable-contracts-39080d72f066) - Shows how to execute initialization functions during diamond upgrades. 71 | * [Upgradeable Smart Contracts and Initialization](https://medium.com/@gweiworld/upgradeable-smart-contracts-and-initialization-6374fd3df267) - Compares methods of initializing upgrades. 72 | 73 | ### Diamonds in Projects 74 | * [🌱 Beanstalk 🤝 EIP-2535 💎](https://bean.money/blog/beanstalk-eip-2535) - Lays out benefits of EIP-2535 with examples from their project. 75 | * [Smart Contracts as Apps](https://0xhabitat.substack.com/p/33) - EIP-2535 Diamonds and the feasibility of a DAO Operating System 76 | * [Dark Forest & the Diamond Standard](https://blog.zkga.me/dark-forest-and-the-diamond-standard) - Dark Forest project moves to and dicusses diamonds. 77 | * [The Diamond Standard: A new paradigm for upgradeability](https://medium.com/derivadex/the-diamond-standard-a-new-paradigm-for-upgradeability-569121a08954) - DerivaDEX on diamonds. 78 | * [We like the (EIP-2535) Diamonds](https://blog.premia.finance/we-like-the-eip-2535-diamonds-90184b2e6741) - Premia Finance talks about their use of diamonds. 79 | * [Why Gotchivault is upgrading to the Diamond standard](https://medium.com/@bearded.eth/diamonds-are-a-proxys-best-friends-c302cca82203) - How to upgrade an existing proxy contract to EIP2535 Diamonds. 80 | * [Handling multiple tokens, with a modern solidity architecture via Diamonds & ERC1155](https://dev.to/nohehf/handling-multiple-tokens-with-a-modern-solidity-architecture-via-diamonds-erc1155-1h7e) 81 | * [Smart contract packages — upgradeability for normal people](https://medium.com/@tjvs/smart-contract-packages-upgradeability-for-normal-people-8646e817e196) 82 | 83 | #### Diamond Project Documentation 84 | * [Aavegotchi Smart Contract Documentation](https://docs.aavegotchi.com/) 85 | * [LIFI Overview](https://docs.li.fi/smart-contracts/overview) 86 | * [Geo Web Documentation](https://docs.geoweb.network/developers/core-contracts) 87 | 88 | # Videos 89 | 90 | * [Full course on Diamond Proxy Pattern with code walkthrough](https://youtu.be/e6WCbOyK7FA?si=JuuYOEEfuGIjHjTj) 91 | * [Ethereum Diamonds - EIP-2535 Multi Facet Proxy](https://youtu.be/yKLDBsYPyE8) 92 | * [How to Organize a Diamond with Facets](https://youtu.be/qHMdqHJMXww) 93 | * [Create Diamond Contracts In Your Browser Using Remix And Louper](https://youtu.be/8p4NhC9sLDA) 94 | * [Share Functions And Storage With Diamond Contracts | Louper/Remix](https://youtu.be/6a379dRTcXU) 95 | 96 | 97 | # Libraries 98 | * [Diamond Scaffold](https://github.com/collinsadi/diamonds) - An NPM package to help in scaffolding Diamond Smart Contracts. 99 | * [SolidState Solidity](https://github.com/solidstate-network/solidstate-solidity) - Upgradeable-first Solidity smart contract development library that supports diamonds. 100 | * [ERC20 Facet](https://github.com/danfinlay/erc20-diamond-facet) - A facet that adds ERC-20 token functionality to the host contract. 101 | * [ERC721A-Upgradeable](https://github.com/chiru-labs/ERC721A-Upgradeable) - Gas efficient ERC721 implementation. 102 | * [ERC1155-DiamondStorage](https://github.com/rachit2501/ERC1155-Diamond) - ERC1155 Implementation 103 | * [OpenZeppelin Diamonds](https://github.com/GeniusVentures/openzeppelin-contracts-diamond) - OpenZeppelin contracts transpiled to use Diamonds & Facets 104 | 105 | # Tools 106 | ### User Interfaces 107 | * [Louper - The Ethereum Diamond Inspector](https://louper.dev/) - User interface for diamonds. 108 | * [DiamondScan](https://diamondscan.xyz/) - User inteface for diamonds. 109 | * [Governance Diamonds](https://www.dmath.is/governance-diamonds/) - User interface for exploring diamonds. 110 | * [diamond-etherscan](https://github.com/zdenham/diamond-etherscan) - Make your EIP-2535 Diamond etherscan compatible. 111 | * [Diamantair](https://diamantaire.xyz/) - Deploying new diamonds from a template. 112 | ### Hardhat 113 | * [diamond-2-hardhat-v6](https://github.com/jhubbardsf/diamond-2-hardhat-v6) - diamond-2-hardhat using TypeScript and Hardhat with Ethers v6. 114 | * [diamond-hardhat](https://github.com/proggR/diamond-hardhat) - Extension that adds deeper Hardhat integrations for faster/more maintainable ERC2535 Diamond contract development. 115 | * [hardhat-diamond-abi](https://github.com/projectsophon/hardhat-diamond-abi) - Hardhat plugin to combine multiple ABIs into a Diamond ABI artifact. 116 | * [hardhat-deploy](https://github.com/wighawag/hardhat-deploy#builtin-in-support-for-diamonds-eip2535) - Hardhat plugin that supports deploying, upgrading and managing diamonds. 117 | * [Zem](https://github.com/anders-torbjornsen/zem) - Hardhat deployment management system that supports deploying, upgrading and managing diamonds. 118 | ### Foundry 119 | * [diamond-foundry](https://github.com/Forgenie/diamond-foundry) - A modern framework for creating EIP2535 Diamonds. 120 | * [Foundry-Hardhat-Diamonds](https://github.com/Timidan/Foundry-Hardhat-Diamonds) - Mimimal template for Diamonds. 121 | * [foundry-diamond-deploy](https://github.com/xenoliss/foundry-diamond-deploy) - Minimal example of a Diamond deployment script using foundry. 122 | * [Diamond-Foundry](https://github.com/FydeTreasury/Diamond-Foundry) - Foundry version of Diamond Pattern (EIP-2535) reference implementation. 123 | * [Foundry template for diamond-3](https://github.com/alexbabits/diamond-3-foundry) 124 | ### Diamond Command Line Tools 125 | * [gemforge](https://github.com/gemstation/gemforge) - Command-line tool for building, deploying and upgrading Diamond Standard contracts on EVM chains. 126 | * [louper-cli](https://github.com/mark3labs/louper-cli) - Command-line tool for Louper.dev 127 | ### Package Management & Facet Registries 128 | * [0xpm](https://0xpm.app/) - Diamond-based smart contract package manager. 129 | * [Ethereum Package Manager](https://epm.wtf) - GUI to deploy and upgrade Diamond proxies and facets. Granular facet control with ability to toggle facet functions on/off. 130 | 131 | ### Python 132 | * [Inspector Facet](https://github.com/bugout-dev/inspector-facet) - Inspection utility for EIP2535 Diamond proxies. Written in Python. 133 | 134 | ### Command line tools 135 | * [diamond-diff](https://www.npmjs.com/package/diamond-diff) - Tool that helps retrieve the necessary `diamondCut` by checking against a Diamond model. 136 | 137 | ### Transpilers 138 | * [OpenZeppelin Transpiler for Diamonds](https://github.com/GeniusVentures/openzeppelin-transpiler) - Updated OpenZeppelin Transpiler supporting Diamond patter with significant speed improvements 139 | 140 | # Security Audits 141 | > Note that some changes have been made to the [Diamond reference implementations](https://github.com/mudgen/diamond) since the following audits have been done. 142 | 143 | ### Omniscia 144 | 145 | * [Smart Contract Audit](https://omniscia.io/alliance-block-multitoken-bridge/) - Omniscia published a smart contract audit of the diamond implementing AllianceBlock’s token bridge, which uses the [diamond-3](https://github.com/mudgen/diamond-3-hardhat) implementation. 146 | 147 | * [Smart Contract Audit](https://omniscia.io/seen-haus-nft-auction-sales/) - Omniscia published a smart contract audit of the [Seen.Haus Marketplace Diamond](https://github.com/seen-haus/seen-contracts), which uses the [diamond-3](https://github.com/mudgen/diamond-3-hardhat) implementation, modified for role-based access rather than single-owner. 148 | 149 | ### Certik 150 | 151 | * [Smart Contract Audit](https://www.certik.org/projects/aavegotchi) - Certik published a smart contract audit of Aavegotchi’s core diamond which use the [diamond-3](https://github.com/mudgen/diamond-3-hardhat) implementation. 152 | * [Smart Contract Audit](https://raw.githubusercontent.com/DOTCPro/Audit/main/DOTC-Security-Rep.pdf) - Certik published a smart contract audit of DOTC’s diamond. 153 | 154 | ### Quantstamp 155 | 156 | * [Smart Contract Audit](https://certificate.quantstamp.com/full/aavegotchi-ghst-staking) - Quantstamp published a smart contract audit of Aavegotchi’s staking diamond which used the [diamond-2](https://github.com/mudgen/diamond-2-hardhat) implementation. 157 | 158 | * [Smart Contract Audit](https://raw.githubusercontent.com/BarnBridge/BarnBridge-PM/master/audits/BarnBridge%20DAO%20audit%20by%20Quanstamp.pdf) - Quantstamp published a smart contract audit of BarnBridge’s [Barn diamond](https://github.com/BarnBridge/BarnBridge-Barn), which uses BarnBridge’s own implementation of EIP-2535 Diamonds based on diamond-1. 159 | 160 | * [Smart Contract Audit](https://certificate.quantstamp.com/full/deriva-dex) - Quantstamp published a smart contract audit of DerivaDEX’s [governance diamond](https://gitlab.com/derivadex/dips/-/tree/master/packages/protocol/contracts), which uses the [diamond-3](https://github.com/mudgen/diamond-3-hardhat) implementation. 161 | 162 | ### MixBytes 163 | 164 | * [Smart Contract Audit](https://github.com/pie-dao/audits/blob/main/Mixbytes%20-%20ExperiPie_Smart_Contrac%202020-12-11.pdf) - MixBytes published a smart contract audit of PieDAO’s [ExperiPie diamond](https://github.com/pie-dao/initialisable-diamond), which uses the diamond-2 implementation. 165 | 166 | ### Haechi Audit 167 | 168 | * [Smart Contract Audit](https://github.com/BarnBridge/BarnBridge-Barn) - Haechi Audit published a smart contract audit of BarnBridge’s Barn diamond, which uses BarnBridge’s own implementation of EIP-2535 Diamonds based on diamond-1. 169 | 170 | # Projects using Diamonds 171 | 172 | 1. DerivaDEX 173 | 2. BarnBridge 174 | 3. Aavegotchi 175 | 4. [ERC721A-Upgradeable](https://github.com/chiru-labs/ERC721A-Upgradeable) 176 | 5. PieDAO 177 | 6. Boson Protocol 178 | 7. hardhat-deploy 179 | 8. Nifty Cannon 180 | 9. AllianceBlock 181 | 10. Louper 182 | 11. solidstate-solidity 183 | 12. Nayms 184 | 13. Diamond Setter 185 | 14. Sherlock 186 | 15. Premia Finance 187 | 16. Nocturnal Finance 188 | 17. scaffold-eth 189 | 18. diamond-starter-kit 190 | 19. scaffold-eth-diamond-standard 191 | 20. Sanshu Inu 192 | 21. Gelato Network 193 | 22. Teller Finance 194 | 23. seen.haus 195 | 24. thx.network 196 | 25. Token Gallery 197 | 26. Beanstalk Protocol 198 | 27. kanaloa.network 199 | 28. PoolSharks 200 | 29. Bitpixel 201 | 30. neodymium-contracts 202 | 31. INU Token 203 | 32. Sigmadex 204 | 33. TuffToken 205 | 34. hardhat-diamond-abi 206 | 35. EnterDAO 207 | 36. Gemcutter 208 | 37. [GNUS.AI](https://www.gnus.ai) 209 | 38. Dark Forest 210 | 39. Moonstream DAO 211 | 40. Chain of Empires 212 | 41. LI.FI 213 | 42. cryptopoopz.com 214 | 43. [Copium Wars](https://copiumwars.xyz/) 215 | 44. Typenauts 216 | 46. connext.network 217 | 47. [The Saudis](https://www.thesaudisnft.com/) 218 | 48. [Spring Game](https://spring.game/) 219 | 49. [oncyber](https://oncyber.io/) 220 | 50. [Avathereum](https://avathereum.com/) 221 | 51. [Cartesi](https://cartesi.io/) 222 | 52. [Energy Web](https://www.energyweb.org) 223 | 53. [Shattered Eon](https://shatteredeon.io/) 224 | 54. Zem 225 | 55. [SolarProtocol](https://www.solarprotocol.io/) 226 | 56. [VOID.MONEY](https://void.money/) 227 | 58. [Simple DeFi](https://www.simpledefi.io/) 228 | 59. [CroSwap](https://www.croswap.com/) 229 | 60. [Lightm](https://lightm.xyz) 230 | 61. [PartyFinance](https://party.finance/) 231 | 62. [1o1.art](https://1o1.art/) 232 | 63. [withmantra.com](https://withmantra.com) 233 | 64. [Nobility Token](https://nobilitytoken.com) 234 | 65. [meTokens](https://meTokens.com) 235 | 66. [Fyde Treasury Protocol](https://www.fyde.fi) 236 | 67. [VaporFi](https://vapornodes.finance/) 237 | 68. [MetaMask Grants DAO](https://metamaskgrants.org/) 238 | 69. [zkSync](https://zksync.io/) 239 | 70. [Crypto Unicorns](https://www.cryptounicorns.fun/) 240 | 71. [Forward Protocol](https://forwardprotocol.io/) 241 | 1. [Ubiquity Dollar](https://github.com/ubiquity/ubiquity-dollar) 242 | 1. [Geo Web](https://www.geoweb.network/) 243 | 1. [Nexera ID](https://blog.allianceblock.io/nexera-nexera-id-deep-dive-ea58350686f3) 244 | 1. [CronosNode NFTs](https://cronosnode.com/) 245 | 1. [Tombala Games](https://tombala.games/) 246 | 1. [Perp88](https://medium.com/perp88/perp88-has-adopted-the-diamond-standard-eip-2535-fcc60f49ece1) 247 | 1. [Helix2](https://ethresear.ch/t/helix2-name-link-service/14823) 248 | 1. [Pendle](https://www.pendle.finance/) 249 | 1. [Worker Node Toolkit](https://medium.com/energy-web-insights/proof-of-good-work-energy-web-releases-worker-node-toolkit-to-the-public-e67a9d8a2973) 250 | 1. [NiftyKit](https://niftykit.com/) 251 | 2. [Babylon](https://babylon.game/) 252 | 1. [Autify Network](https://autifynetwork.com/) 253 | 1. [Keepers](https://keepers.com) 254 | 1. [MetaBase](https://metabase.cc) 255 | 2. [props](https://www.props.app/) 256 | 3. [VL Relics](https://relics.vitriol.sh) 257 | 4. [ApeFathers NFT](https://www.apefathersnft.com/) 258 | 5. [ssv.network](https://ssv.network) 259 | 6. [Pinjam](https://pinjamlabs.com/) 260 | 7. [Venus Protocol](https://venus.io/) 261 | 8. [OmniKingdoms](https://www.omnikingdoms.io/) 262 | 9. [ZKasino](https://docs.zkasino.io/) 263 | 10. [FrenPet](https://docs.frenpet.xyz/) 264 | 11. [Citizen Capital](https://citizencapital.fund/) 265 | 12. [basedVC](https://basedvc.fund/) 266 | 13. [Rico Credit System ](https://bank.dev/) 267 | 14. [GEMPAD](https://gempad.app) 268 | 15. [Kresko Protocol](www.kresko.fi) 269 | 16. [untrading](https://untrading.org/) 270 | 17. [Enzo Racing](https://enzo.gg/) 271 | 1. [Trust Wallet](https://trustwallet.com) 272 | 2. [KingPinOnBase](https://kingpinonbase.com/) 273 | 3. [Parallel](https://parallel.fi) 274 | 4. [JungleArt](https://jungleart.ai/) 275 | 5. [Owl Protocol](https://docs-api.owlprotocol.xyz/docs/introduction) 276 | 6. [Vaultus Finance](https://vaultusfinance.io/) 277 | 7. [zkLink](https://docs.zklink.io/) 278 | 8. [OctoDeFi](https://octodefi.com/) 279 | 9. [RAIRprotocol](https://rairprotocol.org/) 280 | 10. [kewl](https://www.kewl.exchange/) 281 | 11. [Mande Network](https://www.mande.network/) 282 | 12. [FeverTokens](https://www.fevertokens.io) 283 | 13. [Pantos](https://pantos.io) 284 | 14. [Amplified](https://amplified.fi/) 285 | 15. [RangoExchange](https://rango.exchange/) 286 | 16. [Flare Networks](https://flare.network) 287 | 17. [BoomBots](https://www.boombots.xyz) 288 | 18. [River Protocol](https://www.river.build/) 289 | 19. [Towns](https://www.towns.com/) 290 | 20. [Splatter Party](https://splatterparty.xyz) 291 | --------------------------------------------------------------------------------