https://github.com/dymensionxyz/rollapp-evm
EVM DRS - EVM Dymension Rollapp Standard
https://github.com/dymensionxyz/rollapp-evm
Last synced: 26 days ago
JSON representation
EVM DRS - EVM Dymension Rollapp Standard
- Host: GitHub
- URL: https://github.com/dymensionxyz/rollapp-evm
- Owner: dymensionxyz
- License: apache-2.0
- Created: 2023-07-10T12:20:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T09:32:49.000Z (8 months ago)
- Last Synced: 2024-09-09T11:09:15.625Z (8 months ago)
- Language: Go
- Homepage:
- Size: 37.4 MB
- Stars: 38
- Watchers: 9
- Forks: 25
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - dymensionxyz/rollapp-evm - EVM DRS - EVM Dymension Rollapp Standard (Go)
README
# Dymension EVM Rollapp
## Rollapp-evm - A template EVM RollApp chain
This repository hosts `rollapp-evm`, a template implementation of a dymension rollapp with `EVM` execution layer.
`rollapp-evm` is an example of a working RollApp using `dymension-RDK` and `dymint`.
It uses Cosmos-SDK's [simapp](https://github.com/cosmos/cosmos-sdk/tree/main/simapp) as a reference, but with the following changes:
- minimal app setup
- wired with EVM and ERC20 modules by [Evmos](https://github.com/evmos/evmos)
- wired IBC for [ICS 20 Fungible Token Transfers](https://github.com/cosmos/ibc/tree/main/spec/app/ics-020-fungible-token-transfer)
- Uses `dymint` for block sequencing and replacing `tendermint`
- Uses modules from `dymension-RDK` to sync with `dymint` and provide RollApp custom logic
## Overview
**Note**: Requires [Go 1.22.1](https://go.dev/dl/). Requires [Dasel](https://formulae.brew.sh/formula/dasel) and [JQ](https://formulae.brew.sh/formula/jq).
## Installing / Getting started
Build and install the ```rollapp-evm``` binary:
```shell
export BECH32_PREFIX=ethm
make install BECH32_PREFIX=$BECH32_PREFIX
export EXECUTABLE="rollapp-evm"
```
### Initial configuration
export the following variables:
```shell
export DA_CLIENT="mock" # choose DA client: mock(local db), celestia, loadnetwork, sui, aptos, walrus
# For Sui DA, one more env variable is needed: Sui wallet mnemonic.
# export SUI_MNEMONIC="$MNEMONIC"
# For Aptos DA, one more env variable is needed: hex-encoded Aptos wallet private key.
# export APT_PRIVATE_KEY="$PRIVATE_KEY"
# For Celestia DA, one more env variable is needed:
#export CELESTIA_NETWORK="mocha" # for a testnet RollApp use "mocha", for mainnet - "celestia"
#export CELESTIA_HOME_DIR="${HOME}/.da" # Celestia light client home directory
export ROLLAPP_CHAIN_ID="rollappevm_1234-1"
export KEY_NAME_ROLLAPP="rol-user"
export BASE_DENOM="arax"
export DENOM=$(echo "$BASE_DENOM" | sed 's/^.//')
export MONIKER="$ROLLAPP_CHAIN_ID-sequencer"
export ROLLAPP_HOME_DIR="$HOME/.rollapp_evm"
export ROLLAPP_SETTLEMENT_INIT_DIR_PATH="${ROLLAPP_HOME_DIR}/init"
export SKIP_EVM_BASE_FEE=true # optional, disables rollapp fees
$EXECUTABLE config keyring-backend test
# (if running hub too)
export SETTLEMENT_LAYER="mock" # when running a local hub or a public network use "dymension"
export HUB_KEY_WITH_FUNDS="hub-user"
export HUB_RPC_ENDPOINT="localhost"
export HUB_RPC_PORT="36657" # default: 36657
export HUB_RPC_URL="http://${HUB_RPC_ENDPOINT}:${HUB_RPC_PORT}"
export HUB_REST_URL="http://localhost:1318" # required for relayer
export HUB_CHAIN_ID="dymension_100-1"
dymd config chain-id "${HUB_CHAIN_ID}"
dymd config node "${HUB_RPC_URL}"
dymd config keyring-backend test
```
And initialize the rollapp:
```shell
sh scripts/init.sh
```
### Run rollapp
```shell
$EXECUTABLE start
```
You should have a running local rollapp!
## Run a settlement node too
### Run local dymension hub node
Follow the instructions on [Dymension Hub docs](https://docs.dymension.xyz/develop/get-started/run-base-layers) to run local dymension hub node
all scripts are adjusted to use local hub node that's hosted on the default port `localhost:36657`.
configuration with a remote hub node is also supported. Configure env vars above appropriately (RPC_URL)
### Create sequencer keys
create sequencer key using `dymd`
```shell
dymd keys add sequencer --keyring-dir ~/.rollapp_evm/sequencer_keys --keyring-backend test
SEQUENCER_ADDR=`dymd keys show sequencer --address --keyring-backend test --keyring-dir ~/.rollapp_evm/sequencer_keys`
```
fund the sequencer account (if you're using a remote hub node, you must fund the sequencer account or you must have an account with enough funds in your keyring)
```shell
# retrieve the minimal bond amount from hub sequencer params
# you have to account for gas fees so it should the final value should be increased
BOND_AMOUNT="$(dymd q rollapp params -o json | jq -r '.params.min_sequencer_bond_global.amount')$(dymd q rollapp params -o json | jq -r '.params.min_sequencer_bond_global.denom')"
# Extract the numeric part
NUMERIC_PART=$(echo $BOND_AMOUNT | sed 's/adym//')
# Add 100000000000000000000 for fees
NEW_NUMERIC_PART=$(echo "$NUMERIC_PART + 100000000000000000000" | bc)
# Append 'adym' back
TRANSFER_AMOUNT="${NEW_NUMERIC_PART}adym"
dymd tx bank send $HUB_KEY_WITH_FUNDS $SEQUENCER_ADDR ${TRANSFER_AMOUNT} --keyring-backend test --broadcast-mode sync --fees 1dym -y --node ${HUB_RPC_URL}
```
### Register rollapp on settlement
```shell
export HUB_PERMISSIONED_KEY="hub-user"
sh scripts/settlement/register_rollapp_to_hub.sh
```
### Register sequencer for rollapp on settlement
```shell
sh scripts/settlement/register_sequencer_to_hub.sh
```
### Configure the rollapp
Modify `dymint.toml` in the chain directory (`~/.rollapp_evm/config`)
```shell
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "settlement_layer" -v "dymension"
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "node_address" -v "$HUB_RPC_URL"
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "rollapp_id" -v "$ROLLAPP_CHAIN_ID"
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "max_idle_time" -v "2s" # may want to change to something longer after setup (see below)
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "max_proof_time" -v "1s"
dasel put -f "${ROLLAPP_HOME_DIR}"/config/app.toml "minimum-gas-prices" -v "1arax"
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "batch_submit_time" -v "30s"
```
```shell
$EXECUTABLE validate-genesis
```
```shell
# this script automatically adds 2 vesting accounts, adjust the timestamps to your liking or skip this step
sh scripts/add_vesting_accounts_to_genesis_file.sh
```
### Run rollapp locally
```shell
$EXECUTABLE start --log_level=debug
```
## Set Sequencer reward address (optional)
```shell
# Add a new key for the reward address
$EXECUTABLE keys add reward
REWARD=$($EXECUTABLE keys show reward -a)
# This assumes mock default sequencer consensus key location. for different location, update the path.
KEY="${ROLLAPP_HOME_DIR}/config/priv_validator_key.json"
# set the kerying backend to test
$EXECUTABLE config keyring-backend test
# Import the consensus key into the rollapp keyring
$EXECUTABLE tx sequencer unsafe-import-cons-key sequencerConsensusKey $KEY
# Update the sequencer reward address
$EXECUTABLE tx sequencer create-sequencer sequencerConsensusKey --from $KEY_NAME_ROLLAPP --fees 20000000000000$BASE_DENOM --reward-addr $REWARD --keyring-backend test -y
```
## Setup IBC between rollapp and local dymension hub node
### Install dymension relayer
```shell
git clone https://github.com/dymensionxyz/go-relayer.git --branch v0.3.4-v2.5.2-relayer-canon-6
cd go-relayer && make install
```
### Establish IBC channel
Verify you have all the environment variables defined earlier set.
while the rollapp and the local dymension hub node running, run:
```shell
sh scripts/ibc/setup_ibc.sh
```
After successful run, the new established channels will be shown
### Configure empty block time to 1hr
Stop the rollapp:
```shell
kill $(pgrep $EXECUTABLE)
```
Linux:
```shell
dasel put -f "${ROLLAPP_HOME_DIR}"/config/dymint.toml "max_idle_time" -v "1h"
```
Start the rollapp:
```shell
$EXECUTABLE start
```
### run the relayer
```shell
rly start hub-rollapp
```
## Developers guide
For support, join our [Discord](http://discord.gg/dymension) community and find us in the Developer section.
### Setup push hooks
To setup push hooks, run the following command:
```sh
./scripts/setup_push_hooks.sh
```