Skip to content

v0.3.0

Choose a tag to compare

View all tags
@rya-sge rya-sge released this 30 Jun 14:38
· 50 commits to main since this release
v0.3.0
18a8e66
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Added

  • CMTAT Light factories CMTAT_LIGHT_TP_FACTORY and CMTAT_LIGHT_BEACON_FACTORY (contracts/light/) deploying the lighter CMTATUpgradeableLight implementation through the smaller CMTAT_LIGHT_ARGUMENT initializer struct.
  • ERC-8303 factory version support: version() exposed through IERC8303 / ContractVersion, with matching ERC-165 supportsInterface.
  • Rich deployment event CMTATDeployed(address indexed proxy, address indexed deployer, uint256 indexed id, bytes32 salt), emitted on every deployment.
  • Deployment-salt helpers for address prediction: nextDeploymentSalt() and computedNextProxyAddress(...) on every factory.
  • npm run check:oz script (also run in CI) that fails the build if the installed OpenZeppelin version diverges from the version required by the pinned CMTAT submodule.

Changed

  • Reorganised factory contracts into contracts/standard/ and contracts/light/ folders.
  • Shared transparent and beacon deployment logic into new base contracts CMTATTransparentFactoryBase and CMTATBeaconFactoryBase.
  • Removed redundant beacon access-control inheritance and made factory-error imports explicit.
  • Removed the redundant cmtats mapping — CMTATProxyAddress(id) now reads cmtatsList (with a bounds guard returning the zero address for unknown ids), saving one storage write per deployment.
  • Assigned useCustomSalt unconditionally in the constructor and removed a no-op bytes32(...) cast in nextDeploymentSalt().
  • Set the package.json version field to 0.3.0.

Removed

  • Removed the legacy CMTAT(address indexed, uint256) event, superseded by CMTATDeployed (which carries the same proxy address and id plus the deployer and salt).

Fixed

  • Validate the transparent proxy admin owner is non-zero (CMTAT_Factory_AddressZeroNotAllowedForProxyAdminOwner).
  • Fix proxy creation bytecode assembly for the Light factories.

Dependencies

  • Update Solidity (Hardhat compiler) to v0.8.34.
  • Update CMTAT to v3.3.0-rc1.
  • Update OpenZeppelin (Contracts & Contracts-Upgradeable) to v5.6.1 — required by CMTAT v3.3.0-rc1 and resolves a duplicate Initializable declaration that broke compilation under v5.4.0.

Documentation

  • Major README overhaul: document all five factories including the Light variants, the ERC-8303 version(), deployment events, and the salt / address-prediction API; correct the Engine ABI encoding, the Transparent deployCMTAT return type, and contract paths; complete the library-contracts section and regenerate the Surya diagrams.
  • Added README sections: a generated table of contents, CREATE vs CREATE2 deterministic deployment, a Transparent/UUPS/Beacon proxy comparison table, and a CMTAT Standard vs Light overview.
  • Added @return NatSpec to computedProxyAddress (Transparent/UUPS), fixed the beaconImplementation casing, and linked ERC-8303 to its draft PR (not yet published as an EIP page).
  • Added versioned Slither and Aderyn static-analysis reports for v0.3.0 with per-finding triage feedback, and a consolidated doc/audits/AUDIT_OVERVIEW.md (both tools: nothing to fix).

Testing

  • Added tests for the proxy registry (the emitted CMTATDeployed address, cmtatsList(id), and CMTATProxyAddress(id) all agree, in both counter-salt and custom-salt modes; unknown ids return the zero address), the useCustomSalt getter (true/false), a uniform version() across all five factories, and supportsInterface for the inherited ERC-165 and AccessControl interface ids (exercising the super chain in ContractVersion).
Assets 2
Loading