Skip to main content

Meta Contract

Meta Contract is a Foundry-based smart contract framework designed to create flexible, upgradeable, and scalable blockchain applications. It implements the UCS (Upgradeable Clone for Scalable Contracts) architecture, providing developers with powerful tools to build and maintain complex decentralized systems.

caution

Please note that as it is still in the development version, there may be potentially breaking changes made without notice. Use it with caution.

Quick Start​

Just run this:

forge init <project-name> -t metacontract/template

After the installation, run the following command to test the Counter sample project and see how it works:

cd <project-name>
forge test

If you want to learn more about meta contract installation, please refer to installation guide.

Features​

  • Upgradeability 🔄: Meta Contracts can be upgraded without changing their address, allowing for seamless improvements and bug fixes.
  • Modularity 🗂️: The framework separates contract logic into distinct, manageable components, enhancing code organization and reusability.
  • Scalability 📈: Meta Contracts are designed to handle growth efficiently, making them suitable for large-scale applications.
  • Flexibility ⚙️: Developers can easily extend and customize Meta Contracts to suit specific project needs.
  • Testability ✅: The modular structure of Meta Contracts facilitates comprehensive testing, including unit tests for individual functions and integration tests for the entire system.

Documentation Overview​

This documentation is structured to guide you through the Meta Contract framework:

  1. Concepts: Understand the fundamental concepts and architecture of Meta Contract.
  2. Guides: Learn about best practices for development, deployment, and operations.
  3. API Reference: Explore the API details and usage of the Meta Contract DevKit.
  4. Examples: Review examples of various use cases.

Each section provides detailed information to help you effectively use and understand the Meta Contract framework. For more information, follow the links to each section.