Referenced from https://github.com/mudgen/diamond-1-hardhat. Please look at https://github.com/mudgen/diamond for other implementations and tradeoffs.

0. Install dependencies

npm install

1. Create .env file and add private key for rinkeby and etherscan key. Refer to .env.example for var names

2. Compile contracts.

npx hardhat compile

3. Deploy the guardian/diamond contract and add the Sentinel facets. Refer to ./deploy/000-deploy.ts for the tasks being run.

npx hardhat deploy --network rinkeby

This is a reference implementation for EIP-2535 Diamonds. To learn about other implementations go here: https://github.com/mudgen/diamond

Note: In this implementation the loupe functions are NOT gas optimized. The facets, facetFunctionSelectors, facetAddresses loupe functions are not meant to be called on-chain and may use too much gas or run out of gas when called in on-chain transactions. In this implementation these functions should be called by off-chain software like websites and Javascript libraries etc., where gas costs do not matter.

MIT license. See the license file. Anyone can use or modify this software for their purposes.