This project contains the smart contract and local testing tool for DCTRL Membership.
Userflow state diagrams: https://miro.com/app/board/uXjVN9-cSjo=/?share_link_id=748410878407
Sepolia:
- Registry: https://sepolia.etherscan.io/address/0x3ae4caee6fbc2a5eefbf27eccef7747b22fb9490#code
- Multicall3: https://sepolia.etherscan.io/address/0x86e305ae97b79c15a8ebe9f331ce4db0ec3ee8a2#code
- AccountGuardian: https://sepolia.etherscan.io/address/0x0e5e22506e7c5b9d8de73a99724ddfc99daefa51#code
- AccountV3 (unverified): https://sepolia.etherscan.io/address/0xe14051b8e736caa02068bc2d9bad61f72f9c9d8d
- membership: https://sepolia.etherscan.io/address/0x807ec011bd4c5b122178d73fbd0b49d46fb4a0b9#code
- FobNFT: 0x880505222ccAd5E03221005839F12d32B7F4B2EF
- Minter: 0xB2895d2a0205F05c70C0342259492C97423FaCC4
Linea testnet:
I recommend getting Linea Testnet from the covalent faucet: https://docs.linea.build/use-mainnet/fund
- Create a copy of
.env.exampleand rename it to.env - Add your private key to
.envif you intend to deploy - Install with
npm install - Deploy onchain with
npx hardhat run .\scripts\deploy\deploy.js
You can create a long-running local hardhat node with npx hardhat node and then point the DCTRL tool to it with npx hardhat run .\scripts\start.js --network hardhat and pointing your dApp to localhost:8545 with chainId 31337
This project contains the following smart contracts:
- MembershipNFT.sol
- FobNFT.sol
- Minter.sol
- /TokenBound/* (ERC6551)
The DCTRL membership is built ontop of ERC6551: Non-fungible Token Bound Accounts
- https://eips.ethereum.org/EIPS/eip-6551
- https://tokenbound.org/
- https://github.com/erc6551/reference
- https://github.com/tokenbound
The idea is that each human being that joins DCTRL gets a "soulbound" MembershipNFT. The MembershipNFT can hold a FobNFT that corresponds to a real physical fob that gives access to the physical space.
All contracts are managed via AccessControl roles.
The multisig is expected to always have superadmin rights.
MembershipNFT.sol is an ERC721 that contains two fields:
- creationDate
- name
- role
The NFT is intended to be a 1:1 lifetime onchain representation with each physical human being. The NFT is "soulbound" in the sense that it cannot be traded by default.
The MembershipNFT is expected to be upgraded to a TokenBoundAccount using AccountV3. This way, the MembershipNFT can hold additional NFTs and scale to additional onchain activities.
FobNFT.sol is an ERC721 that represents a physical fob that gives access to the DCTRL space. It is intended that either EOA or a TokenBoundAccount can hold a fob.
The Expiration of the Fob is UNIX time in seconds and can be queried via tokenURI() or idToExpiration().
Minter.sol is the orcestrator contract that users interact with. It is expected to have the roles to issue and manage membershipNFTs and fobNFTs. Minter is also expected to handle payment.
These are copies of the ERC6551 Registry (https://github.com/erc6551/reference) and AccountV3 (https://github.com/tokenbound/contracts) contracts. This is used for local testing only. It is expected that we use the existing onchain Registry in production per the ERC6551 spec.
Test suite is in Foundry, install docs here (https://book.getfoundry.sh/getting-started/installation)
Environment variables below the Required for running tests heading must be valid in your .env to run the tests. Tests require forking from latest block on the target chain.
To run tests with 1st level of verbosity:
forge install foundry-rs/forge-std // todo, is this necessary?
forge test -v