This project was built using Foundry. Refer to installation instructions here.
git clone [email protected]:molecule-protocol/molecule-core.git
cd molecule-core
forge install
yarn buildMolecule Protocol standardizes implemantion of onchain access control rules.
It consists of a MoleculeController contract, where rules can be added or removed. The owner can also preset which combination of rules to activate, or set different statuses to always allow or always block, for instance.
The access control rules are defined by MoleculeLogic contracts. The template is minimalistic by design, so it can be implemented in any ways for any purposes. It has only 1 required function check() that returns the logic (true or false.) The other requirements are a human readable name and a boolean that states if it is an allow-list or a block-list.
Two fully functionaly sample MoleculeLogic contracts are provided for implementing allow-list or block-list using NFTs or custom lists.
It can be implemented with 1-line using a require statement.
require(IMoleculeAddress(_moleculeContract).check(accountAddress), "error: account not allowed to access this function");
You can also use the more gas-optimized code snippet below.
error RecipientNotAllowedToReceive(address sender);
...
if (!IMoleculeController(_moleculeTransfer).check(recipient)) {
revert RecipientNotAllowedToReceive(recipient);
}
_moleculeTransfer is the MoleculeController contract address that checks if the recipient is allowed or not. Using the Solidity error keyword more meaningful error messages can be logged with variables.
Three simple steps:
-
Launch and configure configure your
MoleculeControllercontract and customize the logic. -
Import the
MoleculeControllerinterface in your smart contract. -
Cast the
MoleculeControllerwith contract address and call thecheck()function with the address to validate
Fully functional token contracts with Molecule Protocol integrated are available here:
You can launch the contracts and add rules later.
Various use cases for Molecule Protcol are hosted over on our examples repo, alongwith relevant test cases.
Can you think of more use cases that Molecule Protocol can support? Please describe your idea, or demo your idea, or submit a PR (pull request) to us so we can share it with the entire community!
Send us questions on Twitter: @moleculepro
Or join our Discord: https://discord.gg/J8dqFK8ufA
-
Molecule Controller AML Deployment: 0x6F612658b209Ed53720a31D6d2CbE7bCF1664595
-
US Sanction List (ID:840): 0x710dAaD75641f8D57CE54291A00Ac76cc2beD248
-
UK Sanction List (ID:826): 0xc934E5372D8c3841DD08b9FBeeF52473CfD9ABf5
-
EU Sanction List (ID:001): 0x1734E7BEa6CBf4602b3dfE1eA2CB32be8291553B
-
Molecule Controller AML Deployment: 0x6Af29020B8C1B343d0eC3FFD81aA507b5AB05b43
-
US Sanction List (ID:840): 0x769A94FF9548Eee399ef3F7A4d3f33b2f81c8487
-
UK Sanction List (ID:826): 0x55178561E4332Fe6397422EEB958C57867aC4751
| Task | Chain | Transaction Gas Amount (Gas usage) | Gas price | Cost |
|---|---|---|---|---|
| Batch updation | Tenderly mainnet fork | 1,287,779 | 50 Gwei | 0.064 ETH |
| Batch updation | polygon mumbai | 1,496,526 | 50 Gwei | 0.0748263 MATIC ($0.08) |
| Batch updation | Base EVM | 999,026 | 50 Gwei | 0.05485969674721 |
| Batch updation | scroll EVM | 979,116 | 50 Gwei | 0.0489558 ETH |
| Batch updation | Goerli | 999,026 | 195.268257805 Gwei | 0.200000 ETH |
| Task | chain | Transaction Gas Amount (Gas usage) | Gas price | Cost |
|---|---|---|---|---|
| Deploy ERC20m | sepolia | 2,450,487 | 2.50 Gwei | 0.006126217517153409 ETH |
| Mint ERC20m (without gating) | sepolia | 71,152 | 2.50 Gwei | 0.000177880000569216 ETH |
| Transfer ERC20 (without gating) | sepolia | 49,587 (91.17%) | 2.50 Gwei | 0.000123967500396696 ETH |
| Mint ERC20m (with gating) | sepolia | 78,679 | 2.50 Gwei | 0.000196697500708111 ETH |
| Transfer ERC20m (with gating) | sepolia | 64,741 (93.1%) | 2.50 Gwei | 0.000161852500517928 ETH |
| Deploy ERC20 OZ | sepolia | 1,819,416 | 2.50 Gwei | 0.004548540014555328 ETH |
| Mint ERC20 OZ | sepolia | 71,527 | 2.50 Gwei | 0.000178817500572216 ETH |
| Transfer ERC20 OZ | sepolia | 49,631 | 2.50 Gwei | 0.000124077500397048 ETH |
| Deploy ERC721m | sepolia | 3,262,692 | 2.50 Gwei | 0.008156730026101536 ETH |
| Mint ERC721m (without gating) | sepolia | 74,524 | 2.50 Gwei | 0.00018631000074524 ETH |
| Transfer ERC721m (without gating) | sepolia | 58,471 (92.41%) | 2.50 Gwei | 0.000146177500643181 ETH |
| Mint ERC721m (with gating) | sepolia | 99,151 | 2.50 Gwei | 0.000247877500892359 ETH |
| Transfer ERC721m (with gating) | sepolia | 73,631 (93.88%) | 2.50 Gwei | 0.000184077500662679 ETH |
| Deploy ERC721 OZ | sepolia | 2,634,838 | 2.50 Gwei | 0.006587095021078704 ETH |
| Mint ERC721 OZ | sepolia | 96,921 (100%) | 2.50 Gwei | 0.000242302500872289 ETH |
| Transfer ERC721 OZ | sepolia | 58,508 (92.42%) | 2.50 Gwei | 0.000146270000526572 ETH |
| Deploy ERC1155m | sepolia | 3,484,645 | 2.50 Gwei | 0.008711612531361805 ETH |
| Mint ERC1155m (without gating) | sepolia | 56,803 | 2.50 Gwei | 0.00014200750056803 ETH |
| Transfer ERC1155m (without gating) | sepolia | 55,929 (92.1%) | 2.50 Gwei | 0.000139822500503361 ETH |
| Mint ERC1155m (with gating) | sepolia | 94,684 | 2.50 Gwei | 0.000236710001041524 ETH |
| Transfer ERC1155m (with gating) | sepolia | 71,083 (93.67%) | 2.50 Gwei | 0.00017770750071083 ETH |
| Deploy ERC1155 OZ | sepolia | 3,359,382 | 2.50 Gwei | 0.00839845503359382 ETH |
| Mint ERC1155 OZ | sepolia | 54,693 | 2.50 Gwei | 0.00013673250054693 ETH |
| Transfer ERC1155 OZ | sepolia | 53,704 (91.8%) | 2.50 Gwei | 0.000134260000483336 ETH |