CHANGELOG.md

🕓 Changelog

0.0.3 (Unreleased)

💥 New Features

• Extensions
  • ERC2981: An ERC-721 and ERC-1155 compatible ERC-2981 reference implementation. (#138)

♻️ Refactoring

• Extensions
  • ERC4626: Remove the non-standard increase_allowance and decrease_allowance functions. (#160)
• Tokens
  • ERC20:
    • Optimise the set_minter function to save one SLOAD. (#154)
    • Remove the non-standard increase_allowance and decrease_allowance functions. (#160)
  • ERC721: Optimise the set_minter function to save one SLOAD. (#154)
  • ERC1155: Optimise the set_minter function to save one SLOAD. (#154)
• Utility Functions
  • Math: Optimise the method used to factor powers of two out of the denominator in mul_div. (#153)

🥢 Test Coverage

• Utility Functions
  • MerkleProofVerificationTest: Add an additional test for a possible multi_proof_verify invariant violation. (#137)

👀 Full Changelog

• v0.0.2...v0.0.3

0.0.2 (07-06-2023)

💥 New Features

• General
  • All 🐍 snekmate contracts now contain an Ethereum Natural Language Specification Format (NatSpec) custom field @custom:contract-name. The underlying rationale is that the block explorers plan to use @custom:contract-name as contract name and @title as fallback. (#124)
• Extensions
  • ERC4626: Implement additionally the interface IERC5267. (#129)
• Tokens
  • ERC20: Implement additionally the interface IERC5267. (#129)
  • ERC721: Implement additionally the interface IERC5267. (#129)
• Utility Functions
  • EIP712DomainSeparator: Implement additionally the interface IERC5267. (#129)
  • Math: Add wad_ln and wad_exp to the standard mathematical utility functions. (#91)

♻️ Refactoring

• General
  • All 🐍 snekmate contracts are now guaranteed to compile with the Vyper CLI flags userdoc and devdoc, and, if using the Ape framework, with ape compile. (#126)
• Extensions
  • ERC4626:
    • Add implements interface ERC20Detailed and ERC4626. (#125)
    • Use of the ternary operator introduced in Vyper 0.3.8 in the constructor for the immutable variable assignment of _UNDERLYING_DECIMALS instead of an if-else statement. (#128)
• Tokens
  • ERC20: Add implements interface ERC20Detailed. (#125)
  • ERC721: Add implements interface IERC721Metadata. (#125)
• Utility Functions
  • Base64: Use the shift operators >> and << introduced in Vyper 0.3.8 instead of the shift instruction. (#127)
  • ECDSA: Use the shift operators >> and << introduced in Vyper 0.3.8 instead of the shift instruction. (#127)
  • SignatureChecker: Use the shift operators >> and << introduced in Vyper 0.3.8 instead of the shift instruction. (#127)
  • Math:
    • Use directly 🐍 snekmate's log_2 function in the internal calculation of wad_cbrt. (#91)
    • Use the shift operators >> and << introduced in Vyper 0.3.8 instead of the shift instruction. (#127)
    • Use of the ternary operator introduced in Vyper 0.3.8 in the function ceil_div instead of an if-else statement. (#128)

❗️ Breaking Change

• All 🐍 snekmate contracts now target the Vyper version 0.3.9. It is strongly recommended to upgrade accordingly your local Vyper version prior to using the 🐍 snekmate contracts. Important: The default EVM version since Vyper version 0.3.8 is set to shanghai (i.e. the EVM includes the PUSH0 instruction). If you intend to deploy on an EVM chain with no PUSH0 support, you must compile the 🐍 snekmate contracts with the --evm-version paris option; e.g. vyper --evm-version paris utils/Math.vy. (#122)

👀 Full Changelog

• v0.0.1...v0.0.2

0.0.1 (06-03-2023)

💥 New Features

• Authentication
  • Ownable: Owner-based access control functions.
  • Ownable2Step: 2-step ownership transfer functions.
  • AccessControl: Multi-role-based access control functions.
• Extensions
  • ERC4626: Modern and gas-efficient ERC-4626 tokenised vault implementation. (#74)
• Tokens
  • ERC20: Modern and gas-efficient ERC-20 + EIP-2612 implementation. (#17)
  • ERC721: Modern and gas-efficient ERC-721 + EIP-4494 implementation. (#20)
  • ERC1155: Modern and gas-efficient ERC-1155 implementation. (#31)
• Utility Functions
  • Base64: Base64 encoding and decoding functions. (#47)
  • 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. (#74, #77, #86)
  • MerkleProofVerification: Merkle tree proof verification functions. (#30)
  • Multicall: Multicall functions.