This repository contains the binaries, scripts, and configuration files necessary to run a local development network for a development environment for Arcology Network. This network is intended to be used for testing and development purposes only. The network is configured to use a single node, and is not intended to be used for testing validator functionality.
For more information about Arcology Network, please visit Arcology Network.
There is a docker image option aviailable please check this document for more information
This is an all-in-one package for running a local development network. Once installed, the network will be running on your local machine. The package contains the following major components:
- An Ethereum L1
- An Optimism bridge
- An Arcology parallel execution node
The installation package contains the following files and directories:
| Name | Description |
|---|---|
| L1 | This directory contains the files for the Ethereum L1 node. |
| L2 | L2: This directory contains the files for the Optimism bridge and Arcology parallel execution node. |
| README.md | Documentation file for the project. |
| bin | Directory for binary/executable files. |
| cmd | Directory for command-related files. |
| env | Directory for environment-related files. |
| foundry.toml | Configuration file for Foundry. |
| install.sh | Shell script for installing dependencies. |
| lib | Directory for library files. |
| scripts | Directory for various scripts. |
| sdk | Software development kit. |
| src | Source code directory. |
| start.sh | Shell script for starting the project. |
| stop.sh | Shell script for stopping the project. |
| test | Directory for testing-related files. |
You will also need to have two machines, either physical or virtual, to run the development network. One machine will be used to run the L1 and the other will be used to run the Arcology parallel execution node and Optimism bridge,. The two machines must be able to communicate with each other over the network.
- Machine 1: Ethereum L1
- Machine 2: Optimism bridge and Arcology parallel execution node
- 16GB RAM
- 4 CPU cores
- 100GB disk space
- Ubuntu 20.04 or later
Download the package first then follow the steps below to install and run the development network.
> git clone https://github.com/arcology-network/devnet.gitThe Ethereum L1 needs to be set up first. The package comes with a script with the necessary commands to install the L1. The installation script does the following things:
- Install Environment for the L1
- Start the the Ethereum L1 node
- Deploy a proxy contract for the Optimism bridge
Please execute the following command to call the script. The following steps are performed on the machine where the L1 is installed.
```shell
L1>./start.shNow the L1 is ready to be used and produces empty blocks.
Now move on to the second machine to install the L2 related files. The L2 includes:
- A standard Optimism bridge
- An Arcology parallel execution node
The following steps are performed on the machine where the L1 is located.
devnet>install.sh -p X.X.X.X # Your local IPPlease make sure to close the current terminal window once the installation is completed.
The environment file .envrc is located in the root directory of the package. It contains the environment configuration for the L1 and L2. Please modify the following parameters in the configuration file:
- L1_RPC_URL should be set to the IP address of the L1 machine
The environment variables are loaded using direnv. If you don't have direnv installed, please install it first.
> cd devnet
devnet> direnv allowYou should see output that looks something like the following (the exact output will vary depending on the variables you've set, don't worry if it doesn't look exactly like this):
direnv: loading ~/optimism/.envrc
direnv: export +DEPLOYMENT_CONTEXT +ETHERSCAN_API_KEY +GS_ADMIN_ADDRESS +GS_ADMIN_PRIVATE_KEY +GS_BATCHER_ADDRESS +GS_BATCHER_PRIVATE_KEY +GS_PROPOSER_ADDRESS +GS_PROPOSER_PRIVATE_KEY +GS_SEQUENCER_ADDRESS +GS_SEQUENCER_PRIVATE_KEY +IMPL_SALT +L1_RPC_KIND +L1_RPC_URL +PRIVATE_KEY +TENDERLY_PROJECT +TENDERLY_USERNAMEGenerate a default OP configuration file containing the default values for the OP components. The script will generate a file named getting-started.json.
devnet> ./cmd/config.shThe default configuration file only contains the default values. The following command updates the chain ID fields in the file:
devnet> ./cmd/chainID.shIt is time to deploy the OP bridge contract to the Ethereum L1. The following command will deploy the L1 contracts to the L1 machine from the L2 machine.
devnet> ./cmd/l1contracts.shThe following command will generate the configuration files base on the deployment context.
devnet> ./cmd/50-generateConfig.shThe following files will be generated:
rollup.jsoncontains the configuration for the OP componentsgenesis.jsoncontains the genesis block for the Arcology parallel execution nodejwt.txtcontains the private key for the Arcology to authenticate the transactions received from the OP Node.
You are now ready to start the L2 network. Start a new terminal, and load the system variables by executing the following instructions on the machine for L2.
The final step is to start the Arcology node. The following steps are performed on the machine where the Arcology is installed.
devnet> ./start.sh devnet> ./cmd/02-startNode.sh devnet> ./cmd/03-startBatcher.sh devnet> ./cmd/04-startProposer.sh