Skip to content

MetaRegistry: Overview

The MetaRegistry functions as a Curve Finance Pool Registry Aggregator and offers an on-chain API for various properties of Curve pools by consolidating different registries into a single contract.

This is achieved by integrating multiple ChildRegistries1, each paired with a RegistryHandler. This handler serves as a wrapper around its respective ChildRegistry, ensuring compatibility with the MetaRegistry's ABI standards.

Curve Factory contracts, which allow the permissionless deployment of pools and gauges, are such a ChildRegistry. When deploying pools or gauges, the respective information is picked up by the registry and then plugged into the MetaRegistry via a Handler2.

Contract Source & Deployment

The MetaRegistry is deployed across multiple networks. A full list of deployments can be found here.

The source code is available on GitHub.

flowchart BT
    mr[(MetaRegistry)]
    cr1(ChildRegistry1) -.- rh1(RegistryHandler1)
    cr2(ChildRegistry2) -.- rh2(RegistryHandler2)
    cr3(ChildRegistry3) -.- rh3(RegistryHandler3)
    rh1 -.-> mr
    rh2 -.-> mr
    rh3 -.-> mr

Registries with Already Compliant ABI Standards

If a ChildRegistry already meets these standards, it does not require a handler. Nonetheless, wrappers can be useful for hotfixing bugs in production, especially when direct modifications to the ChildRegistry would lead to significant breaking changes.

Who should use the MetaRegistry?

Integrators often find it challenging to incorporate a protocol into their dapp when multiple on-chain registries are stored in separate contracts. They lack intrinsic, protocol-level knowledge to handle edge cases and onboard various registries. A single source that aggregates all registries can simplify integrations significantly.

If you're an integrator looking to integrate Curve, the MetaRegistry is an invaluable resource.

Setup

Set up the python environment using the following steps: Please visit Github for more details.

> python -m venv venv
> source ./venv/bin/active
> pip install --upgrade pip
> pip install -r ./requirements.txt

This project uses eth-ape >= 0.5.2 developed at Apeworx. The various plugins used are:

  • ape-vyper
  • ape-hardhat
  • ape-alchemy
  • ape-ledger
  • ape-etherscan

To install these, please follow the instructions in their respective Github repositories.

Note

If you choose to run tests using Alchemy as the upstream provider, please set up an Alchemy API key into an environment variable labeled WEB3_ALCHEMY_PROJECT_ID or WEB3_ALCHEMY_API_KEY. If you use a local node (geth or erigon), please change the hardhat upstream provider for mainnet-fork to geth in ape-config.yaml:

hardhat:
    port: auto
    fork:
        ethereum:
            mainnet:
                upstream_provider: geth
                # upstream_provider: alchemy

Testing

To run tests in interactive mode, please do the following: 

> ape test -I -s

Deployment

First, set up your account in Ape. If you're using an EOA that is a cold wallet, do:

> ape accounts import <alias>

This will prompt you for a private key. If your account is a ledger account, then follow:

> ape ledger add <alias>

To deploy, please use the following command (example deployment in mainnet-fork):

> ape run scripts/deploy.py main --network ethereum:mainnet-fork --account <your_account>

  1. Also referred to as BaseRegistry. ↩

  2. The Handler needs to be added to the MetaRegistry using the add_registry_handler function. ↩