Release Notes / Changelog

This page tracks releases, notable changes, and upgrade notes for MetaTx-Contracts.

Latest release

  • Version: v1.0.0-native-token-support

  • Date: 2025-08-25

  • Highlights:

    • MetaTxGateway: batch meta-transactions with native token support, refunds, and pause/relayer controls

    • DI Token: ERC20 with allocation and staking integration

    • GasCreditVault: BSC deployment for gas credits

Changelog (sample)

v1.0.0-native-token-support

  • Added EIP-712 batch signing support (MetaTransactions)

  • Implemented native-token validation and automatic refunds

  • Added relayer authorization and pauseWithReason

  • UUPS upgradeable proxy pattern

Upgrade Notes

  • When upgrading MetaTxGateway via UUPS, ensure _authorizeUpgrade is invoked by owner and follow proxy admin checks.

  • Review domain separator version in EIP-712 if you change the version field.

  • Deadline Enforcement: Stricter deadline validation with configurable limits

  • Access Control: Enhanced permission system for administrative functions

🔧 Improvements

Smart Contract Enhancements

  • UUPS Upgradeable: Full support for transparent upgrades without storage conflicts

  • Gas Optimization: 15-20% reduction in gas costs through optimized code

  • Error Messages: Custom errors for better debugging and lower gas costs

  • Event Logging: Comprehensive event system for better tracking and analytics

Developer Experience

  • TypeScript SDK: Complete TypeScript library for frontend integration

  • React Hooks: Ready-to-use React hooks for common operations

  • CLI Tools: Command-line interface for contract interaction and management

  • Comprehensive Documentation: Complete GitBook documentation with examples

Price Oracle Integration

  • Chainlink v3: Updated to latest Chainlink price feed interfaces

  • Staleness Protection: Enhanced checks for price data freshness

  • Fallback Mechanisms: Multiple price sources for reliability

  • Circuit Breakers: Automatic pause mechanisms for extreme price movements

🛠️ Technical Changes

Contract Architecture

// New MetaTxGateway features
contract MetaTxGateway {
    // Native token support
    function executeMetaTransactions(
        MetaTransaction[] calldata transactions
    ) external payable; // Now payable!
    
    // Enhanced events
    event NativeTokenUsed(address indexed user, uint256 amount);
    event MetaTransactionExecuted(
        address indexed user,
        address indexed to,
        bool success,
        bytes returnData
    );
}

Updated Domain Separator

const domain = {
  name: "MetaTxGateway",
  version: "1",
  chainId: 56,
  verifyingContract: "0x..."
};

📊 Performance Metrics

Gas Optimizations

  • Meta-transaction execution: 21,000 → 18,500 gas (12% reduction)

  • Batch processing: 85,000 → 72,000 gas for 5 transactions (15% reduction)

  • Credit deposits: 65,000 → 58,000 gas (11% reduction)

  • Signature verification: 5,000 → 4,200 gas (16% reduction)

Throughput Improvements

  • Transaction processing: 50% faster execution

  • Batch size: Increased from 5 to 10 transactions per batch

  • Credit calculations: 40% faster price oracle queries

  • Nonce management: 60% reduction in nonce-related failures

🔄 Migration Guide

For Existing Users

  1. Update Contract Addresses

    // Old v1.0.0 address
const oldGateway = "0x..."; 

// New v1.0.0 address
const newGateway = "0x...";

  2. Update Domain Separator

    // Update version in signing domain
const domain = {
  name: "MetaTxGateway",
  version: "2.0.0", // Changed from "1.0.0"
  chainId: 56,
  verifyingContract: newGatewayAddress
};

  3. Handle Native Tokens

    // For transactions with ETH/BNB
await gateway.executeMetaTransactions(transactions, {
  value: totalNativeValue
});

For Developers

  1. SDK Update

    npm install @metatx-contracts/[email protected]

  2. API Changes

    // New SDK usage
import { MetaTxSDK } from '@metatx-contracts/sdk';

const sdk = new MetaTxSDK({
  version: '2.0.0',
  chainId: 56,
  gatewayAddress: newGatewayAddress
});

🐛 Bug Fixes

  • Fixed nonce synchronization issues in high-frequency scenarios

  • Resolved gas estimation errors for complex contract interactions

  • Corrected price feed staleness checks during network congestion

  • Fixed batch transaction ordering in edge cases

  • Resolved signature verification issues with certain wallet implementations

🚨 Breaking Changes

  1. Domain Separator Version: Signatures from v1.0.0 will not work with v1.0.0

  2. Contract Address: New deployment address for enhanced contract

  3. Event Structure: Some events have additional parameters

  4. Gas Requirements: Minimum gas requirements updated for new features

📋 Deployment Information

BSC Mainnet

  • MetaTxGateway Proxy: 0x... (To be updated)

  • MetaTxGateway Implementation: 0x... (To be updated)

  • GasCreditVault Proxy: 0x... (To be updated)

  • GasCreditVault Implementation: 0x... (To be updated)

BSC Testnet

  • MetaTxGateway Proxy: 0x... (To be updated)

  • MetaTxGateway Implementation: 0x... (To be updated)

  • GasCreditVault Proxy: 0x... (To be updated)

  • GasCreditVault Implementation: 0x... (To be updated)

🔐 Security

  • Audit Status: Security audit completed by AuditAgent AuditAgent Security Review Report

  • Bug Bounty: Active bug bounty program with up to $10,000 rewards

  • Formal Verification: Critical functions formally verified

  • Insurance: Smart contract insurance coverage active

Version 1.0.0 - October 2024

🚀 Initial Release

The first stable release of MetaTx-Contracts, providing core meta-transaction functionality with gas credit management.

✨ Core Features

Meta-Transaction Gateway

  • EIP-712 Signatures: Secure transaction signing with domain separation

  • Batch Processing: Execute multiple transactions in a single call

  • Nonce Management: Sequential nonce system preventing replay attacks

  • Deadline Protection: Transaction expiration for enhanced security

Gas Credit System

  • Multi-Token Support: USDT, USDC, and BUSD supported for gas credits

  • Chainlink Integration: Real-time price feeds for accurate credit calculation

  • Credit Transfers: Transfer credits between accounts

  • Balance Management: Query and track credit balances

Smart Contract Architecture

  • UUPS Upgradeable: Future-proof upgrade system

  • Access Control: Role-based permissions for administrative functions

  • Event System: Comprehensive logging for transaction tracking

  • Error Handling: Custom errors for efficient gas usage

🛠️ Technical Specifications

Supported Networks

  • Binance Smart Chain (BSC) Mainnet

  • BSC Testnet

Contract Specifications

  • Solidity Version: 0.8.20

  • OpenZeppelin: v5.3.0

  • Compilation: Via IR optimization enabled

  • Gas Optimization: Extensive optimization for minimal costs

Integration Support

  • JavaScript/TypeScript: Complete SDK with TypeScript support

  • React: Ready-to-use React hooks and components

  • Web3 Libraries: Compatible with ethers.js and web3.js

📊 Performance

Gas Costs

  • Simple meta-transaction: ~25,000 gas

  • ERC-20 transfer: ~45,000 gas

  • Batch of 5 transactions: ~85,000 gas

  • Credit deposit: ~65,000 gas

Throughput

  • Transactions per second: 50+ TPS on BSC

  • Batch processing: Up to 5 transactions per batch

  • Confirmation time: 3-5 seconds average

🔧 Developer Tools

Documentation

  • GitBook: Comprehensive documentation with examples

  • API Reference: Complete contract and SDK documentation

  • Tutorials: Step-by-step integration guides

  • Best Practices: Security and optimization guidelines

Testing Suite

  • Unit Tests: 100% coverage for critical functions

  • Integration Tests: End-to-end testing scenarios

  • Fuzzing Tests: Property-based testing for edge cases

  • Performance Tests: Gas usage and throughput benchmarks

🔐 Security

Security Measures

  • Multi-signature: Admin functions require multi-sig approval

  • Timelock: 24-hour delay for critical parameter changes

  • Emergency Pause: Circuit breaker for emergency situations

  • Access Control: Granular permission system

Audit and Verification

  • Internal Audit: Comprehensive internal security review

  • Code Review: Multiple developer review process

  • Static Analysis: Automated security scanning

  • Testnet Deployment: Extensive testing on BSC testnet

📋 Known Limitations

  1. Single Chain: Initially BSC only (multi-chain support planned)

  2. Token Support: Limited to USDT, USDC, BUSD (expansion planned)

  3. Batch Size: Maximum 5 transactions per batch

  4. Price Feeds: Dependent on Chainlink oracle availability

🔄 Upgrade Path

This initial release provides the foundation for future enhancements:

  • Multi-chain Support: Ethereum, Polygon, Avalanche planned

  • Additional Tokens: More ERC-20 tokens for gas credits

  • Advanced Features: Subscription payments, gasless approvals

  • Mobile SDK: React Native SDK for mobile applications

Upcoming Releases

Version 1.1.0 (Q4 2025) - Advanced Features

New Capabilities

  • Gasless Approvals: EIP-2612 permit integration

  • Subscription Payments: Recurring payment support

  • Conditional Execution: Smart contract triggers

  • Bulk Operations: Advanced batch processing

Developer Enhancements

  • Mobile SDK: React Native and Flutter support

  • GraphQL API: Enhanced querying capabilities

  • Webhook System: Real-time event notifications

  • Analytics Dashboard: Usage metrics and insights

Version 3.0.0 (Q1 2026) - Ecosystem Integration

Platform Features

  • DeFi Integration: Direct DEX and lending protocol support

  • NFT Marketplace: Gasless NFT trading

  • Social Features: Gasless social interactions

Enterprise Features

  • White-label Solutions: Customizable interfaces

  • Enterprise Analytics: Advanced reporting and monitoring

  • SLA Guarantees: Service level agreements

  • 24/7 Support: Dedicated enterprise support

Support and Feedback

Community Channels

Getting Help

  • Documentation: Browse this GitBook for comprehensive guides

  • Stack Overflow: Tag questions with metatx-contracts

  • Email Support: [email protected]

  • Video Tutorials: YouTube channel with integration tutorials

Contributing

We welcome contributions from the community:

  • Bug Reports: Help us identify and fix issues

  • Feature Requests: Suggest new functionality

  • Code Contributions: Submit pull requests

  • Documentation: Improve guides and examples

See our Contributing Guide for detailed information.

Thank you for using MetaTx-Contracts! 🚀

We're committed to making decentralized applications more accessible and user-friendly. Your feedback and contributions help us build better tools for the entire ecosystem.

PreviousAudit Notes & Security ReportsNextFAQ

Last updated