Refactored some of the JS from the mudgen/diamond-3-hardhat repo to lean into Hardhat features. Primarily tasks, but aiming for a simple/extensible testing structure as well. Aiming for a structure I could conceivably use to start throwing reliable/maintainable Diamonds together with less boilerplate/thinking involved (in part because I need it for a stealth project, so updates/example Facet implementations to follow).
- Clone this repo:
git clone git@github.com:proggR/diamond-hardhat.git- Install NPM packages:
cd diamond-hardhat
npm installcp .env.example .env
. .env
npx hardhat node --network hardhatIncludes mock implementations for ERC20, ERC721, and ERC1155 facets built leveraging diamond storage, including tests and management tasks to varying degrees of coverage.
Additional EIPs being researched for inclusion: ERC137, ERC681, ERC725/ERC735, ERC884, ERC1400/ERC1404
Per-Facet tests are simple to add if you follow the examples in test/facets/Greeter.ts, test/facets/Farewell.ts, and most critically test/facets/index.ts which is all that needs to be changed to construct and test Diamonds from the available facets.
A Facet test conforms if: it exposes a runTest function that takes the diamond address, the owner, and a counter representing which Facet this is (should account for the 3 Base Facets), and then calls describe, passing it the local Facet test callback to execute.
Tests that conform to this pattern need only be required in the test/facets/index.ts file and added to array returned by enabledFacets. Non-conforming tests can be added/required/adapted into the test/Diamond.ts file. The deployFacets/cutFacets/removeFacets functions in facet.ts don't currently support the callback option of diamondCut (passes empty string), but will amend that to support optional callback functions to execute initialization functions as needed.
npx hardhat test// Deploy Facet, but don't cut
npx hardhat facet-deploy --network localhost --name FarewellFacet
// Deploy & cut new Facet to Diamond
npx hardhat facet-deploy --network localhost --diamond 0xblah --name FarewellFacet
// Deploy & cut upgrade of Facet to Diamond
npx hardhat facet-upgrade --network localhost --diamond 0xblah --name FarewellFacet
// Remove & cut Facet from Diamond
npx hardhat facet-remove --network localhost --diamond 0xblah --name FarewellFacet
// Cut Newly deployed Facet to Diamond (called by facet-deploy)
npx hardhat cut-add --network localhost --diamond 0xblah --facet 0xblah --name FarewellFacet
// Cut upgraded Facet to Diamond (called by facet-upgrade)
npx hardhat cut-replace --network localhost --diamond 0xblah --facet 0xblah --name FarewellFacet// Get the facet address for a given function signature
npx hardhat loupe-facet-address --network localhost --diamond 0xblah --func 0xblah
// Get a list of facet addresses for a given diamond
npx hardhat loupe-facet-addresses --network localhost --diamond 0xblah
// Get the selectors for a given facet
npx hardhat loupe-facet-function-selectors --network localhost --diamond 0xblah --facet 0xblah
// Get the facets for a given diamond
npx hardhat loupe-facets --network localhost --diamond 0xblah
// Call hello function from GreeterFacet through Diamond contract
npx hardhat call-hello --network localhost --diamond 0xblah
// Call goodbye function from FarewellFacet through Diamond contract
npx hardhat call-goodbye --network localhost --diamond 0xblah
// Get the msg set in app storage through PersistentFacet1
npx hardhat storage-app-msg --network localhost --diamond 0xblah
// Get the msg set in app storage through PersistentFacet2
npx hardhat storage-app-msg-clone --network localhost --diamond 0xblah
// Get the greeting set in diamond storage through PersistentFacet2
npx hardhat storage-ds-greeting --network localhost --diamond 0xblah
// Set the msg in app storage through PersistentFacet1
npx hardhat storage-app-msg-set --network localhost --diamond 0xblah --msg blah
// Set the greeting in diamond storage through PersistentFacet2
npx hardhat storage-ds-greeting-set --network localhost --diamond 0xblah --greeting blah
// Get the total supply for a given diamond
npx hardhat erc20-symbol --network localhost --diamond 0xblah
// Get the total supply for a given diamond
npx hardhat erc20-name --network localhost --diamond 0xblah
// Get the total supply for a given diamond
npx hardhat erc20-decimals --network localhost --diamond 0xblah
// Get the total supply for a given diamond
npx hardhat erc20-total-supply --network localhost --diamond 0xblah
// Get the signer balance for a given diamond
npx hardhat erc20-balance --network localhost --diamond 0xblah
// Get the total supply for a given diamond
npx hardhat erc20-allowance --network localhost --diamond 0xblah --owner 0xblah --spender 0xblah
// Get the total supply for a given diamond
npx hardhat erc20-approve --network localhost --diamond 0xblah --spender 0xblah --amount 1000
// Get the total supply for a given diamond
npx hardhat erc20-transfer --network localhost --diamond 0xblah --to 0xblah --amount 1000
// Get the total supply for a given diamond
npx hardhat erc20-transfer-from --network localhost --diamond 0xblah --from 0xblah --to 0xblah --amount 1000
// Get the signer balance for a given diamond
npx hardhat erc721-balance --network localhost --diamond 0xblah
// Get the total supply for a given diamond
npx hardhat erc721-total-supply --network localhost --diamond 0xblah
// Approve a spender for a token ID
npx hardhat erc721-approve --network localhost --diamond 0xblah --spender 0xblah --id 1
// Get approvals for a token ID
npx hardhat erc721-get-approved --network localhost --diamond 0xblah --id 1
// Get approval status for an owner=>operator
npx hardhat erc721-is-approved-for-all --network localhost --diamond 0xblah --owner 0xblah --operator 0xblah
// Get the owner of a token ID
npx hardhat erc721-owner --network localhost --diamond 0xblah --id 1
// Call safeTransferFrom
npx hardhat erc721-safe-transfer-from --network localhost --diamond 0xblah --from 0xblah --to 0xblah --id 1
// Set approval status for an owner=>operator
npx hardhat erc721-set-approved-for-all --network localhost --diamond 0xblah --owner 0xblah --operator 0xblah --approved 0
// Call transferFrom
npx hardhat erc721-transfer-from --network localhost --diamond 0xblah --from 0xblah --to 0xblah --id 1
// Get the signer balance for a given diamond and token ID
npx hardhat erc1155-balance --network localhost --diamond 0xblah --id 1
// Get the total supply for a given diamond and token ID
npx hardhat erc1155-total-supply --network localhost --diamond 0xblah --id 1
// Get the signer balance for a given diamond and token ID
npx hardhat erc1155-balance-batch --network localhost --diamond 0xblah --id 1
// Get the signer balance for a given diamond and token ID
npx hardhat erc1155-is-approved-for-all --network localhost --diamond 0xblah --owner 0xblah --operator 0xblah
// Get the signer balance for a given diamond and token ID
npx hardhat erc1155-safe-batch-transfer-from --network localhost --diamond 0xblah --from 0xblah --to 0xblah --id 1 --amount 1
// Get the signer balance for a given diamond and token ID
npx hardhat erc1155-safe-transfer-from --network localhost --diamond 0xblah --from 0xblah --to 0xblah --id 1 --amount 1
// Get the signer balance for a given diamond and token ID
npx hardhat erc1155-set-approved-for-all --network localhost --diamond 0xblah --operator 0xblah --approved 0
This is an implementation for EIP-2535 Diamond Standard. To learn about other implementations go here: https://github.com/mudgen/diamond
The standard loupe functions have been gas-optimized in this implementation and can be called in on-chain transactions. However keep in mind that a diamond can have any number of functions and facets so it is still possible to get out-of-gas errors when calling loupe functions. Except for the facetAddress loupe function which has a fixed gas cost.
Note: The loupe functions in DiamondLoupeFacet.sol MUST be added to a diamond and are required by the EIP-2535 Diamonds standard.
- DiamondCutFacet is deployed.
- The diamond is deployed, passing as arguments to the diamond constructor the owner address of the diamond and the DiamondCutFacet address. DiamondCutFacet has the
diamondCutexternal function which is used to upgrade the diamond to add more functions. - The
DiamondInitcontract is deployed. This contains aninitfunction which is called on the first diamond upgrade to initialize state of some state variables. Information on how thediamondCutfunction works is here: https://eips.ethereum.org/EIPS/eip-2535#diamond-interface - Facets are deployed.
- The diamond is upgraded. The
diamondCutfunction is used to add functions from facets to the diamond. In addition thediamondCutfunction calls theinitfunction from theDiamondInitcontract usingdelegatecallto initialize state variables.
How a diamond is deployed is not part of the EIP-2535 Diamonds standard. This implementation shows a usable example.
Check tasks/diamond/facet-upgrade.js, lib/diamond/facet.ts, test/Diamond.ts, and test/facets/Farewell.ts for examples of upgrades.
Note that upgrade functionality is optional. It is possible to deploy a diamond that can't be upgraded, which is a 'Single Cut Diamond'. It is also possible to deploy an upgradeable diamond and at a later date remove its diamondCut function so it can't be upgraded any more.
Note that any number of functions from any number of facets can be added/replaced/removed on a diamond in a single transaction. In addition an initialization function can be executed in the same transaction as an upgrade to initialize any state variables required for an upgrade. This 'everything done in a single transaction' capability ensures a diamond maintains a correct and consistent state during upgrades.
The contracts/Diamond.sol file shows an example of implementing a diamond.
The contracts/facets/DiamondCutFacet.sol file shows how to implement the diamondCut external function.
The contracts/facets/DiamondLoupeFacet.sol file shows how to implement the four standard loupe functions.
The contracts/libraries/LibDiamond.sol file shows how to implement Diamond Storage and a diamondCut internal function.
The lib/diamond/deploy.ts file shows how to deploy a diamond.
test/Diamond.ts and test/facets/Farewell.ts gives tests for the diamondCut function and the Diamond Loupe functions.
-
Reading and understand EIP-2535 Diamonds. If something is unclear let me know!
-
Use a diamond reference implementation. You are at the right place because this is the README for a diamond reference implementation.
This diamond implementation is boilerplate code that makes a diamond compliant with EIP-2535 Diamonds.
Specifically you can copy and use the DiamondCutFacet.sol and DiamondLoupeFacet.sol contracts. They implement the diamondCut function and the loupe functions.
The Diamond.sol contract could be used as is, or it could be used as a starting point and customized. This contract is the diamond. Its deployment creates a diamond. It's address is a stable diamond address that does not change.
The LibDiamond.sol library could be used as is. It shows how to implement Diamond Storage. This contract includes contract ownership which you might want to change if you want to implement DAO-based ownership or other form of contract ownership. Go for it. Diamonds can work with any kind of contract ownership strategy. This library contains an internal function version of diamondCut that can be used in the constructor of a diamond or other places.
In order to call a function that exists in a diamond you need to use the ABI information of the facet that has the function.
Here is an example that uses web3.js:
let myUsefulFacet = new web3.eth.Contract(MyUsefulFacet.abi, diamondAddress);In the code above we create a contract variable so we can call contract functions with it.
In this example we know we will use a diamond because we pass a diamond's address as the second argument. But we are using an ABI from the MyUsefulFacet facet so we can call functions that are defined in that facet. MyUsefulFacet's functions must have been added to the diamond (using diamondCut) in order for the diamond to use the function information provided by the ABI of course.
Similarly you need to use the ABI of a facet in Solidity code in order to call functions from a diamond. Here's an example of Solidity code that calls a function from a diamond:
string result = MyUsefulFacet(address(diamondContract)).getResult()If you need help or would like to discuss diamonds then send Nick a message on twitter, or email him. Or join the EIP-2535 Diamonds Discord server.
- Introduction to the Diamond Standard, EIP-2535 Diamonds
- EIP-2535 Diamonds
- Understanding Diamonds on Ethereum
- Solidity Storage Layout For Proxy Contracts and Diamonds
- New Storage Layout For Proxy Contracts and Diamonds
- Upgradeable smart contracts using the Diamond Standard
- buidler-deploy supports diamonds
This example implementation was written by Nick Mudge.
Hardhat Tasks and some adjustments to the JS library made by @proggR
Contact Nick:
Contact @proggR:
MIT license. See the license file. Anyone can use or modify this software for their purposes.