From 5f13de7cf084d89af9055635322ef5c2b22c4810 Mon Sep 17 00:00:00 2001 From: Pascal Marco Caversaccio Date: Thu, 12 Oct 2023 15:31:50 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Add=20Interfaces=20to=20`Contrac?= =?UTF-8?q?ts`=20Section=20in=20`README`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Pascal Marco Caversaccio --- README.md | 60 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 38 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7997227c..1d734c07 100644 --- a/README.md +++ b/README.md @@ -15,28 +15,44 @@ ```ml src -├─ auth -│ ├─ Ownable — "Owner-Based Access Control Functions" -│ ├─ Ownable2Step — "2-Step Ownership Transfer Functions" -│ ├─ AccessControl — "Multi-Role-Based Access Control Functions" -├─ extensions -│ ├─ ERC2981 — "ERC-721 and ERC-1155 Compatible ERC-2981 Reference Implementation" -│ ├─ ERC4626 — "Modern and Gas-Efficient ERC-4626 Tokenised Vault Implementation" -├─ tokens -│ ├─ ERC20 — "Modern and Gas-Efficient ERC-20 + EIP-2612 Implementation" -│ ├─ ERC721 — "Modern and Gas-Efficient ERC-721 + EIP-4494 Implementation" -│ ├─ ERC1155 — "Modern and Gas-Efficient ERC-1155 Implementation" -├─ utils - ├─ Base64 — "Base64 Encoding and Decoding Functions" - ├─ BatchDistributor — "Batch Sending Both Native and ERC-20 Tokens" - ├─ CreateAddress — "`CREATE` EVM Opcode Utility Function for Address Calculation" - ├─ Create2Address — "`CREATE2` EVM Opcode Utility Functions for Address Calculations" - ├─ ECDSA — "Elliptic Curve Digital Signature Algorithm (ECDSA) Functions" - ├─ SignatureChecker — "ECDSA and EIP-1271 Signature Verification Functions" - ├─ EIP712DomainSeparator — "EIP-712 Domain Separator" - ├─ Math — "Standard Mathematical Utility Functions" - ├─ MerkleProofVerification — "Merkle Tree Proof Verification Functions" - ├─ Multicall — "Multicall Functions" +├── auth +│ ├── Ownable — "Owner-Based Access Control Functions" +│ ├── Ownable2Step — "2-Step Ownership Transfer Functions" +│ ├── AccessControl — "Multi-Role-Based Access Control Functions" +│ └── interfaces +│ └── IAccessControl — "AccessControl Interface Definition" +├── extensions +│ ├── ERC2981 — "ERC-721 and ERC-1155 Compatible ERC-2981 Reference Implementation" +│ ├── ERC4626 — "Modern and Gas-Efficient ERC-4626 Tokenised Vault Implementation" +│ └── interfaces +│ └── IERC2981 — "EIP-2981 Interface Definition" +├── tokens +│ ├── ERC20 — "Modern and Gas-Efficient ERC-20 + EIP-2612 Implementation" +│ ├── ERC721 — "Modern and Gas-Efficient ERC-721 + EIP-4494 Implementation" +│ ├── ERC1155 — "Modern and Gas-Efficient ERC-1155 Implementation" +│ └── interfaces +│ ├── IERC20Permit — "EIP-2612 Interface Definition" +│ ├── IERC721Enumerable — "EIP-721 Optional Enumeration Interface Definition" +│ ├── IERC721Metadata — "EIP-721 Optional Metadata Interface Definition" +│ ├── IERC721Permit — "EIP-4494 Interface Definition" +│ ├── IERC721Receiver — "EIP-721 Token Receiver Interface Definition" +│ ├── IERC1155 — "EIP-1155 Interface Definition" +│ ├── IERC1155MetadataURI — "EIP-1155 Optional Metadata Interface Definition" +│ ├── IERC1155Receiver — "EIP-1155 Token Receiver Interface Definition" +│ └── IERC4906 — "EIP-4906 Interface Definition" +└── utils + ├── Base64 — "Base64 Encoding and Decoding Functions" + ├── BatchDistributor — "Batch Sending Both Native and ERC-20 Tokens" + ├── CreateAddress — "`CREATE` EVM Opcode Utility Function for Address Calculation" + ├── Create2Address — "`CREATE2` EVM Opcode Utility Functions for Address Calculations" + ├── ECDSA — "Elliptic Curve Digital Signature Algorithm (ECDSA) Functions" + ├── SignatureChecker — "ECDSA and EIP-1271 Signature Verification Functions" + ├── EIP712DomainSeparator — "EIP-712 Domain Separator" + ├── Math — "Standard Mathematical Utility Functions" + ├── MerkleProofVerification — "Merkle Tree Proof Verification Functions" + ├── Multicall — "Multicall Functions" + └── interfaces + └── IERC5267 — "EIP-5267 Interface Definition" ``` ## 🎛 Installation