Skip to content

Commit 0bca674

Browse files
ltitanbltitanb
committed
fix rabby doc
1 parent f13b78d commit 0bca674

File tree

2 files changed

+42
-35
lines changed

2 files changed

+42
-35
lines changed

‎README.md‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,30 @@
33
## Local Development/Quick start
44

55
### With existing OP chain
6-
The following steps have been tested on Sepolia, with a previously deployed L2 chain
6+
7+
The following steps have been tested on Sepolia, with a previously deployed L2 chain
8+
79
1. locate your `rollup.json`, `genesis.json` and `state.json` files
810
2. run `make config-main-node OP_NODE_DATA_DIR=<path/to/op-node/data> OP_GETH_DATA_DIR=<path/to/op-geth/data> ROLLUP_JSON=<path/to/rollup.json> GENESIS_JSON=<path/to/genesis.json> STATE_JSON=<path/to/state.json>`
911
3. there should be some files set up in `.local_main_node`
1012
4. start sequencing the main chain with `make start-main-node OP_BATCHER_KEY=<op-batcher-private-key> OP_PROPOSER_KEY=<op-proposer-private-key> MAIN_KEY=<vault-key/main-sequencing key>`
1113
5. Normally you should see some logs starting
12-
6. `blockscout` should be up and running at `http://0.0.0.0:4000`
13-
7a. `make stop-main-node` to stop all the sequencing services
14-
7b. `make stop-monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
15-
7c. `make logs-main-node` to output logs of all the main services
14+
6. `blockscout` should be up and running at `http://0.0.0.0:4000`
15+
7a. `make stop-main-node` to stop all the sequencing services
16+
7b. `make stop-monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
17+
7c. `make logs-main-node` to output logs of all the main services
1618

1719
### Deploy a new l2 chain on Sepolia
20+
1821
1. To deploy a new chain on l2, make sure to have an address on Sepolia with some funds. This will be used as the `MAIN`/`vault` address.
1922
2. create 2 more accounts, deposit ~0.2 eth in them. One will be used for the `op-batcher` one for the `op-proposer.
2023
3. run `make deploy-chain OP_BATCHER_KEY=<op-batcher private key> OP_PROPOSER_KEY=<op-proposer private key> MAIN_KEY=<vault key>`
2124
4. start sequencing the main chain with `make start-main-node OP_BATCHER_KEY=<op-batcher-private-key> OP_PROPOSER_KEY=<op-proposer-private-key> MAIN_KEY=<vault-key/main-sequencing key> L1_RPC_URL=<sepolia rpc url> L1_BEACON_RPC_URL=<sepolia beacon rpc url>`
2225
5. Normally you should see some logs starting
23-
6. `blockscout` should be up and running at `http://0.0.0.0:4000`
24-
7a. `make stop-main-node` to stop all the sequencing services
25-
7b. `make stop-monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
26-
7c. `make logs-main-node` to output logs of all the main services
26+
6. `blockscout` should be up and running at `http://0.0.0.0:4000`
27+
7a. `make stop-main-node` to stop all the sequencing services
28+
7b. `make stop-monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
29+
7c. `make logs-main-node` to output logs of all the main services
2730

2831
### Run a Based Gateway
2932

@@ -46,36 +49,36 @@ The configuration that was generated can be found in `based-op/.local_gateway_an
4649
When you [spam some transactions with `based-bmf`](https://based-bmf.gattaca.com), you should see them appear in the `Transaction Pool` of your `Gateway`.
4750

4851
A couple of commands tend to come in handy (from the top `based-op` directory):
52+
4953
- `make stop-gateway`
5054
- `make start-gateway`
5155
- `make start-overseer`
5256
- `make logs-gateway`
5357
- `make logs-based-op-node`
5458
- `make logs-based-op-geth`
5559

56-
5760
### Add/Update based-gateways to Registry
61+
5862
When a based-gateway is started with `make start-gateway`, it will register itself to the Registry behind the `PORTAL`. For now, the Registry is kept in a simple json file in `.local_main_node/config/registry.json`. You can add/update/remove gateways there, the Registry and Portal will pick up on the changes every minute.
5963

6064
If you have started both the main sequencing node and the gateway on the same machine, you might need to change the ip to `0.0.0.0`, by default `curl ifconfig.me` is used to populate
6165
your url.
6266

6367
### Send your first tx
68+
6469
You can now test sending a transaction with `make test-tx`.
6570
The transaction will be sent to the Portal, and forwarded to the gateway, which will sequence the transaction in a new Frag, and broacast it via p2p to follower nodes.
6671

67-
6872
> [!IMPORTANT]
6973
>
7074
> **The following is experimental**
71-
>
7275
7376
## Wallets
7477

7578
Wallets commonly use a high polling interval for the transaction receipt. To be able to see the preconfirmation speed, we modify Rabby to speed up that interval. You can test it compiling it:
7679

7780
```sh
78-
make build-rabby
81+
make build-rabby-chrom
7982
```
8083

8184
And importing it to your browser locally (see [Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/) or [Chrome](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world?hl=es-419#load-unpacked) references). The compiled extension directory is `rabby/dist` for Google Chrome, and `rabby/dist-mv2` for Mozilla Firefox.

‎docs/docs/getting_started/try-out.md‎

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ You can try out a Based OP testnet following the steps below.
44

55
### Network Details
66

7-
| Parameter | Value |
8-
|-----------|-------|
9-
| Chain ID | 29866 |
10-
| Network Name | Based-OP |
11-
| Currency Symbol | opETH |
12-
| RPC URL | https://based-rpc.gattaca.com |
13-
| Block Explorer | https://based-explorer.gattaca.com/ |
14-
| Break My Frags | https://based-bmf.gattaca.com/ |
7+
| Parameter | Value |
8+
| --------------- | ----------------------------------- |
9+
| Chain ID | 29866 |
10+
| Network Name | Based-OP |
11+
| Currency Symbol | opETH |
12+
| RPC URL | https://based-rpc.gattaca.com |
13+
| Block Explorer | https://based-explorer.gattaca.com/ |
14+
| Break My Frags | https://based-bmf.gattaca.com/ |
1515

1616
## Break My Frags
1717

@@ -22,12 +22,13 @@ generated with a small amount of Eth deposited to it. Transactions can then be g
2222

2323
Our current testnet setup is mainly focused on robustness and thorough testing of different scenarios.
2424
As such it is structrured as follows:
25+
2526
- A vanilla `op-node` and `op-geth`, with a `Portal` in between, are driving the chain forward on a box in Europe.
2627
- Multiple sequencing `Gateways` are setup to take turns sequencing a number of future blocks
27-
- On the same box
28-
- In the same region
29-
- In the US east region
30-
- A varying number in the UK on WiFi
28+
- On the same box
29+
- In the same region
30+
- In the US east region
31+
- A varying number in the UK on WiFi
3132
- `Gateways` gossip `Frags`, i.e. ~`200ms` partial blocks that have been committed to
3233
- The `Gateway` on the same box as the main `op-node` and `op-geth` serves as the main RPC
3334
- Txs are gossiped around, `Frags` arrive back, and the `Gateway` serves `Receipts` based on those
@@ -37,17 +38,20 @@ This setup means that the total latency to receive `Receipts` will vary dependin
3738
- 80-150 ms on the same box
3839
- 200-350 ms for same region
3940
- 500-700 ms when in different regions
40-
- 200-700 ms for the last category of `Gateways`, depending on the WiFi
41+
- 200-700 ms for the last category of `Gateways`, depending on the WiFi
4142

4243
## Run a local Gateway
4344

4445
### Prerequisites
46+
4547
You will need a box with globally open ports:
46-
- 9997 (tcp)
47-
- 9103 (tcp/udp)
48+
49+
- 9997 (tcp)
50+
- 9103 (tcp/udp)
4851
- 31303 (tcp/udp)
4952

5053
### Gateway Setup
54+
5155
In the following, all defaults are set up to target the [`Based OP` testnet](https://based-explorer.gattaca.com), deployed on top of mainnet Sepolia.
5256
With that default config, a new `private-key` and `wallet` combo will be generated which your `Gateway` will use to sign `Frags`.
5357
The `wallet` is communicated back to the `Portal` to be gossiped around to the rest of the network for signature verification.
@@ -65,6 +69,7 @@ The configuration that was generated can be found in `based-op/.local_gateway_an
6569
When you [spam some transactions with `based-bmf`](https://based-bmf.gattaca.com), you should see them appear in the `Transaction Pool` of your `Gateway`.
6670

6771
A couple of commands tend to come in handy (from the top `based-op` directory):
72+
6873
- `make stop-gateway`
6974
- `make start-gateway`
7075
- `make start-overseer`
@@ -84,7 +89,7 @@ Wallets commonly use a high polling interval for the transaction receipt. To be
8489
You can test it by compiling it:
8590

8691
```sh
87-
make build-rabby
92+
make build-rabby-chrom
8893
```
8994

9095
And importing it to your browser locally (see [Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/) or [Chrome](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked) references). The compiled extension directory is `rabby/dist` for Google Chrome, and `rabby/dist-mv2` for Mozilla Firefox.
@@ -108,11 +113,11 @@ To manually add the network, follow these steps:
108113
![3](../../static/img/wallet_tutorial/step_3.png)
109114

110115
4. Fill in the form with the following values:
111-
- Chain ID: `29866`
112-
- Network Name: `Based-OP`
113-
- RPC URL: `https://based-rpc.gattaca.com`
114-
- Currency Symbol: `opETH`
115-
- Block Explorer URL: `https://based-explorer.gattaca.com/`
116+
- Chain ID: `29866`
117+
- Network Name: `Based-OP`
118+
- RPC URL: `https://based-rpc.gattaca.com`
119+
- Currency Symbol: `opETH`
120+
- Block Explorer URL: `https://based-explorer.gattaca.com/`
116121

117122
![4](../../static/img/wallet_tutorial/step_4.png)
118123

@@ -125,4 +130,3 @@ To manually add the network, follow these steps:
125130
![6](../../static/img/wallet_tutorial/step_6.png)
126131

127132
You can now use the wallet to interact with the Based-OP devnet.
128-

0 commit comments

Comments
 (0)