Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 7.55 KB

README.md

File metadata and controls

136 lines (100 loc) · 7.55 KB
Raw

🐍 snekmate

Test smart contracts License: AGPL v3 npm package PyPI package

State-of-the-art, highly opinionated, hyper-optimised, and secure 🐍Vyper smart contract building blocks.

This is experimental software and is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any losses incurred through any use of this code base.

📜 Contracts

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"

🎛 Installation

We offer three convenient ways to install the 🐍 snekmate contracts:

1️⃣ Foundry

You can install 🐍 snekmate via submodules using Foundry with:

forge install pcaversaccio/snekmate

If you want to leverage 🐍 snekmate's VyperDeployer contract for your own testing, ensure that you compile the Vyper contracts with the same EVM version as configured in your foundry.toml file. The VyperDeployer contract offers two overloaded deployContract functions that allow the configuration of the target EVM version. Please note that since Vyper version 0.3.8 the default EVM version is set to shanghai.

2️⃣ PyPI

You can install 🐍 snekmate from PyPI with:

pip install snekmate

You can use pip install snekmate -t . to install the contracts directly into the current working directory!

3️⃣ npm

You can install 🐍 snekmate from npm with:

npm install --save-dev snekmate

Or if you are using Yarn:

yarn add --dev snekmate

In case you are using pnpm, invoke:

pnpm add --save-dev snekmate

👩🏼‍⚖️ Tests

This repository contains Foundry-based unit tests, property-based tests (i.e. fuzzing), and invariant tests for all contracts, if applicable. All tests are run as part of the CI pipeline test-contracts.

Note: An invariant is a property of a program that should always hold true. Fuzzing is a way of checking whether the invariant is falsifiable.

Contract Unit Tests Property-Based Tests Invariant Tests
Ownable ✅ ✅ ✅
Ownable2Step ✅ ✅ ✅
AccessControl ✅ ✅ ✅
ERC2981 ✅ ✅ ✅
ERC4626 ✅ ✅ ✅
ERC20 ✅ ✅ ✅
ERC721 ✅ ✅ ✅
ERC1155 ✅ ✅ ✅
Base64 ✅ ❌ ❌
BatchDistributor ✅ ✅ ✅
CreateAddress ✅ ✅ ❌
Create2Address ✅ ✅ ❌
ECDSA ✅ ✅ ❌
SignatureChecker ✅ ✅ ❌
EIP712DomainSeparator ✅ ✅ ❌
Math ✅ ✅ ❌
MerkleProofVerification ✅ ✅ ❌
Multicall ✅ ❌ ❌

✅ Test Type Implemented   ❌ Test Type Not Implemented

🙏🏼 Acknowledgements

This repository is inspired by or directly modified from many sources, primarily:

🫡 Contributing

🐍 snekmate only exists thanks to its contributors. There are many ways to get involved and contribute to our high-quality and secure smart contracts. Check out our Contribution Guidelines!

💸 Donation

I am a strong advocate of the open-source and free software paradigm. However, if you feel my work deserves a donation, you can send it to this address: 0x07bF3CDA34aA78d92949bbDce31520714AB5b228. I can pledge that I will use this money to help fix more existing challenges in the Ethereum ecosystem 🤝.

💢 Disclaimer