Skip to content

v3.0.0

Choose a tag to compare

View all tags
@jistro jistro released this 17 Feb 23:57
· 154 commits to main since this release
3.0.0
ea9ba94

Codename: "Ichiban"

Named after Ichiban Kasuga from Yakuza: Like a Dragon, this release embodies the spirit of rebuilding from the ground up. Just as Ichiban rebuilt his life and united scattered allies into a cohesive team, this release fundamentally restructures EVVM by centralizing previously fragmented functionalities into a unified Core. The name reflects both its literal meaning ("number one") and the protagonist's journey of transforming chaos into order, mirroring how this version consolidates from disparate services into a single, robust foundation for the entire EVVM ecosystem.

Added

  • Changelog: Added codenames to releases for a more engaging and memorable version history
  • Signature standardization: Implemented a standardized signature payload construction method in AdvancedStrings.sol to ensure consistent signature generation and verification across all EVVM services, improving security and interoperability
    • This standard consists of concatenating the following parameters in order:
      "<evvmID>,<serviceAddress>,<hashInput>,<executor>,<nonce>,<isAsyncExec>" where hashInput is a service-specific hash of the relevant transaction data using keccak256(abi.encode("functionName", param1, param2, ...)) and executor represents the address executing the transaction (origin executor service transactions and sender for payment transactions on Core.sol). This standardization allows for a single signature verification method in Core.sol that can be used across all services, eliminating inconsistencies and potential security vulnerabilities from service-specific signature implementations.
  • Core.sol:
    • A new core contract to:
      • Manage treasury deposits and withdrawals
      • Handle payments
      • Handle signature verification for all EVVM transactions
      • A centralized nonce for async and sync nonce validation across EVVM services preventing replay attacks in multi-service transactions
  • ICore: Interface for cross-contract interaction with Core.sol
  • Core tests: Added comprehensive tests for Core.sol covering payment handling, signature verification, and nonce management
  • AdvancedStrings.sol: buildSignaturePayload function for standardized signature generation and verification
  • Hashing utilities: Added service-specific hashing functions in /library/utils/signature/ for consistent payload construction across services
  • Deployment script: Updated to deploy Core.sol and set its address in the services during deployment
  • IUserValidator: Interface for user validation logic in Core.sol, allowing for flexible access control in evvm transactions
  • CA Verification Library: Added CAUtils.sol for verifying if a certain address is a CA, which can be used in user validation logic in Core.sol
  • CoreExecution Library: Added CoreExecution.sol for handling core execution logic on services.
  • Github templates:
    • Added CONTRIBUTING.md with contribution guidelines for the community
    • Added PULL_REQUEST_TEMPLATE.md to standardize pull request submissions and ensure necessary information is provided for reviews
    • Added SECURITY.md with security best practices and reporting guidelines for responsible disclosure of vulnerabilities

Changed

  • Payment service handling inputs: Change <variableName>Evvm or <variableName>_EVVM naming convention for all payment handling related variables across services to <variableName>Pay to clearly indicate their purpose in payment handling logic
  • Cli:
    • Changed CLI deployment script to deploy Core.sol
    • Updated CLI test script to reflect changes in CLI deployment and interaction with Core.sol
    • Updated CLI contract interface generation to include Core.sol state variables and functions
    • Updated CLI evvm verification to use Core.sol
  • Error handling: Standardized error naming (e.g., CoreError, NameServiceError) and established a consistent import aliasing pattern across all services for improved maintainability
  • Payment functions: Renamed payMultiple to batchPay and BatchData (formerly PayData) in Core.sol (formerly Evvm.sol) for clarity
  • Import paths: Moved all struct libraries from contracts/<service>/lib/ to library/structs/ for better organization
  • Parameter naming:
    • priorityFlag to isAsyncExec for clearer async execution identification
  • Contract naming: Renamed AdminControlled to Admin in library/utils/governance/Admin.sol
  • Core (before called Evvm.sol)
    • Changed _setupNameServiceAndTreasuryAddress to initializeSystemContracts to generalize the function for setting up system contracts (NameService, Treasury) in one call during deployment
    • Updated CoreStructs (formerly EvvmStructs) to interact as a library instead of an abstract contract for better modularity and reuse across services
    • Implemented centralized nonce management and signature verification, replacing Evvm's previous nonce management and signature utilities
  • NameService:
    • Updated variable name clowNumber to lockNumber and expireDate to expirationDate for better clarity
    • Updated NameServiceStructs to be a library instead of an abstract contract for better modularity and reuse across services
    • Implemented Core.sol for nonce validation and signature verification replacing previous service-specific nonce management and signature utilities
    • Now both nonce and noncePay are async nonces managed by Core.sol to prevent replay attacks in multi-service transactions, replacing the previous service-specific nonce management
  • P2PSwap:
    • Implemented Core.sol for nonce validation and signature verification replacing previous service-specific nonce management and signature utilities
    • Now both nonce and noncePay are async nonces managed by Core.sol to prevent replay attacks in multi-service transactions, replacing the previous service-specific nonce management
  • Staking:
    • Implemented Core.sol for nonce validation and signature verification replacing previous service-specific nonce management
    • Updated StakingStructs to be a library instead of an abstract contract for better modularity and reuse across services
    • Changed _setupEstimatorAndEvvm to initializeSystemContracts to generalize the function for setting up all critical system contracts (Evvm, Estimator, Core) in one call during deployment
    • Implemented nonce and noncePay as async nonces for public and presale staking via Core.sol to prevent multi-service replay attacks
  • Cross Chain Treasury:
    • Implemented Core.sol for nonce validation and signature verification replacing previous service-specific nonce management and signature utilities
    • Updated ExternalChainStationStructs and HostChainStationStructs to be a library instead of an abstract contract for better modularity and reuse across services
  • NatSpec documentation: Updated and added NatSpec documentation across all contracts for improved clarity and maintainability
  • Testing: Refactored and added tests to cover new Core.sol functionality and its integration with services, including payment handling, signature verification, and nonce management scenarios
  • Github templates: Updated bug_report.md and feature_request.md templates to include Core.sol as an option

Removed

  • Evvm.sol: Renamed to Core.sol and refactored to centralize core EVVM functionalities such as payment handling, signature verification, and nonce management
  • Service-specific nonce management: All nonce management is now centralized in Core.sol for improved security and consistency across services
  • Service SignatureUtils: Removed service-specific signature utilities because signature generation and verification is now centralized in Core.sol using AdvancedStrings.sol for payload construction
  • Redundant Structs: Removed all governance-related structs from individual service struct libraries, as they are now centralized in ProposalStructs.sol for better organization and reuse
  • Service nonce libraries: Removed all service-specific nonce libraries, as nonce management is now handled by Core.sol
  • Github templates: Removed references to Evvm.sol in bug_report.md and feature_request.md templates

Fixed

  • CLI:
    • Default values for Hyperlane, LayerZero, and Axelar data when user opts not to add on cli deployment script are now properly set to empty values instead of undefined
    • Updated CLI prompts to support async input handling and cursor navigation
Assets 2
Loading