Skip to content

Commit

Permalink
Docs: Fix incorrect toml paths in run.md. (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
ceyhunsen authored Mar 29, 2024
1 parent 855bc31 commit 5f6d1d2
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,23 @@ Run on a local da layer, sharable between nodes that run on your computer.

Run sequencer on Mock DA:
```sh
./target/debug/citrea --da-layer mock --rollup-config-path citrea/rollup/configs/mock/sequencer_rollup_config.toml --sequencer-config-path citrea/rollup/configs/mock/sequencer_config.toml --genesis-paths citrea/test-data/genesis/demo-tests/mock
./target/debug/citrea --da-layer mock --rollup-config-path bin/citrea/configs/mock/sequencer_rollup_config.toml --sequencer-config-path bin/citrea/configs/mock/sequencer_config.toml --genesis-paths bin/test-data/genesis/demo-tests/mock
```

Sequencer RPC is accessible at `127.0.0.1:12345`

_Optional_: Run full node on Mock DA:
```sh
./target/debug/citrea --rollup-config-path citrea/rollup/configs/mock/rollup_config.toml --genesis-paths citrea/test-data/genesis/demo-tests/mock
./target/debug/citrea --rollup-config-path bin/citrea/configs/mock/sequencer_rollup_config.toml --genesis-paths bin/test-data/genesis/demo-tests/mock
```

Full node RPC is accessible at `127.0.0.1:12346`

To publish blocks on Mock DA, run these on two seperate terminals:
To publish blocks on Mock DA, run these two on seperate terminals:
```sh
./citrea/rollup/publish_block.sh
./bin/citrea/publish_block.sh

./citrea/rollup/publish_da_block.sh
./bin/citrea/publish_da_block.sh
```

### Run on Bitcoin Regtest
Expand All @@ -56,7 +56,7 @@ Mine blocks so that the wallet has BTC:
bitcoin-cli -regtest -generate 201
```

Edit `bin/citrea/configs/bitcoin-regtest/sequencer_rollup_config.toml` and `bin/citrea/configs/bitcoin-regtest/sequencer_rollup_config.toml` files and put in your rpc url, username and password:
Edit `bin/citrea/configs/bitcoin-regtest/sequencer_rollup_config.toml` and `bin/citrea/configs/bitcoin-regtest/sequencer_config.toml` files and put in your rpc url, username and password:

```toml
[da]
Expand All @@ -70,7 +70,7 @@ node_password = ""

Run sequencer:
```sh
./target/debug/citrea --da-layer bitcoin --rollup-config-path citrea/rollup/configs/bitcoin-regtest/sequencer_rollup_config.toml --sequencer-config-path citrea/rollup/configs/bitcoin-regtest/sequencer_config.toml --genesis-paths citrea/test-data/genesis/demo-tests/bitcoin-regtest
./target/debug/citrea --da-layer bitcoin --rollup-config-path bin/citrea/configs/bitcoin-regtest/sequencer_rollup_config.toml --sequencer-config-path bin/citrea/configs/bitcoin-regtest/sequencer_config.toml --genesis-paths bin/test-data/genesis/demo-tests/bitcoin-regtest
```

Sequencer RPC is accessible at `127.0.0.1:12345`
Expand All @@ -79,14 +79,14 @@ _Optional_: Run full node

Run full node:
```sh
./target/debug/citrea --da-layer bitcoin --rollup-config-path citrea/rollup/configs/bitcoin-regtest/rollup_config.toml --genesis-paths citrea/test-data/genesis/demo-tests/bitcoin-regtest
./target/debug/citrea --da-layer bitcoin --rollup-config-path bin/citrea/configs/bitcoin-regtest/rollup_config.toml --genesis-paths bin/test-data/genesis/demo-tests/bitcoin-regtest
```

Full node RPC is accessible at `127.0.0.1:12346`

To publish blocks on Bitcoin Regtest, run this and keep the terminal open:
```sh
./citrea/rollup/publish_block.sh
./bin/citrea/publish_block.sh
```

To delete sequencer or full nodes databases run:
Expand All @@ -100,4 +100,4 @@ To run tests:
```sh
SKIP_GUEST_BUILD=1 make test
```
This will run [`cargo nextest`](https://nexte.st).
This will run [`cargo nextest`](https://nexte.st).

0 comments on commit 5f6d1d2

Please sign in to comment.