Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.91 KB

README.md

File metadata and controls

65 lines (43 loc) · 3.91 KB
Raw

cdk-contracts-tooling

Tools to interact with CDK smart contracts and Go bindings

Requirements

Not all the commands have the same requirements, but here is the complete list of requirements (to be able to run all the commands):

  • Go
  • NVM installed under $NVM_DIR
  • abigen

Usage

From the root of this repo run go run ./cmd. This will print a help message explaining how to use all the commands

Wallets

Some commands require using private keys. There are multiple ways to import private keys, but all of them require to:

  1. Copy paste wallets.example.toml into wallets.toml
  2. Edit the new file to include your wallets (the file has comments to make the needed changes comprehensible)

RPCs

Some commands require using RPC endpoints. There are multiple ways to import these endpoints, but all of them require to:

  1. Copy paste rpcs.example.toml into rpcs.toml
  2. Edit the new file to include your RPC configurations (the file has comments to make the needed changes comprehensible)

Genesis

Unfortunately the base genesis file cannot be retrieved from L1. Therefore they must be imported manually.

Full execution proofs rollups

For the full execution proofs rollups, the location that should contain the genesis allocations is ./genesis/fep/<root>.json

Pessimistic proofs rollups

For the pessimistic proofs rollups (since they are initialized with an empty genesis root), the location that should contain the genesis allocations is constructed following the pattern ./genesis/pp/<l1_network_alias>/<rollup_manager_alias>/<rollup_alias>/allocs.json.

Example

Let's assume that we have a pessimistic proofs rollup named cdk-pp-1 running on the cardona, that is pointing to sepolia l1 network.

The genesis file should be named as allocs.json and placed in the ./genesis/pp/sepolia/cardona/cdk-pp-1/, so the full path is ./genesis/pp/sepolia/cardona/cdk-pp-1/allocs.json.

Examples

Generate genesis file for a node (cdk-validium-node or zkevm-node) and the config for a Bridge service (zkevm-bridge-service)

  1. Import the rollup manager: go run ./cmd import-rm -l1 sepolia -addr 0x32d33d5137a7cffb54c5bf8371172bcec5f310ff -alias cardona. In this example:
    • -l1 sepolia is the L1 network, make sure that your rpcs.toml file contains a valid RPC for the L1 network this CDK belongs to
    • -addr 0x32d33d5137a7cffb54c5bf8371172bcec5f310ff is the L1 address where the rollup manager is deployed
    • -alias cardona is an arbitrary name. You can really name this however you want, but this is going to be used later to reference this rollup manager deployment
  2. (OPTIONAL) After first step, all the attached rollups are imported using their name as alias, and defaulting to chainID for name if the name has the default value networkName. It's possible to manually import a rollup using a custom alias: go run ./cmd import-r -l1 sepolia -rm cardona -r API3 -chainid 879490799. In this example:
    • -rm cardona rollup manager referenced by the alias used in the previous step
    • -chainid 879490799 is the chain ID of the rollup (L2 Chain ID)
    • -alias API3 is an arbitrary name. You can really name this however you want, but this is going to be used later to reference this rollup deployment
  3. Generate the genesis file for the node: go run ./cmd genesis -l1 sepolia -rm cardona -r API3 -output API3.json. In this example:
    • -l1 sepolia is the L1 network
    • -rm cardona rollup manager referenced by the alias used in the step 1 (import rollup manager)
    • -r API3 rollup referenced by the alias used in the previous step
    • -output API3.json file where the genesis will be stored
  4. Generate the network config section of the bridge service: go run ./cmd bridge -l1 sepolia -rm cardona -r API3 -output API3Bridge.toml

Note that step 1 only needs to be done once, if there are multiple CDKs attached to the same rollup manager, with a single run it will be enough.