Skip to content

Commit 05c75da

Browse files
committed
update readme
1 parent 9c51918 commit 05c75da

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

README.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,32 @@ This crate contains an example block builder in the Signet ecosystem.
88

99
### Requirements
1010

11-
- Rust 1.81.0
12-
- Cargo [Lambda](https://www.cargo-lambda.info/)
13-
- AWS CLI and credentials
11+
- Rust 1.85
12+
- AWS CLI
13+
- A private key or AWS KMS key for signing transactions
1414

1515
### Environment
1616

1717
The following environment variables are exposed to configure the Builder:
1818

1919
```bash
20-
# Builder Configs
21-
HOST_CHAIN_ID="17000" # Holesky Testnet
22-
RU_CHAIN_ID="17001"
23-
HOST_RPC_URL="http://host.url.here"
24-
# trailing slash is required
25-
TX_BROADCAST_URLS="http://tx.broadcast.url.here/,https://additional.url.here/"
26-
ZENITH_ADDRESS="ZENITH_ADDRESS_HERE"
27-
QUINCEY_URL="http://signer.url.here"
20+
# Builder Configs for Pecorino Test Net
21+
HOST_CHAIN_ID="3151908"
22+
RU_CHAIN_ID="14174"
23+
HOST_RPC_URL="https://host-rpc.pecorino.signet.sh"
24+
TX_BROADCAST_URLS="" # trailing slash is required - set to none for test net configuration
25+
ZENITH_ADDRESS="0xbe45611502116387211D28cE493D6Fb3d192bc4E"
26+
QUINCEY_URL="http://sequencer.pecorino.signet.sh/signBlock"
2827
BUILDER_PORT="8080"
29-
BUILDER_KEY="YOUR_BUILDER_KEY_HERE"
3028
INCOMING_TRANSACTIONS_BUFFER="10"
3129
BLOCK_CONFIRMATION_BUFFER="10"
3230
BUILDER_REWARDS_ADDRESS="BUILDER_REWARDS_ADDRESS_HERE"
3331
ROLLUP_BLOCK_GAS_LIMIT="30000000"
32+
CONCURRENCY_LIMIT=10 # Concurrency parameter for simulation
33+
# Pecorino Slot Timing Configuration
34+
SLOT_OFFSET="4"
35+
SLOT_DURATION="12"
36+
START_TIMESTAMP="1740681556"
3437
# Transaction Pool Configs
3538
TX_POOL_URL="http://pool.url.here/" # trailing slash is required
3639
TX_POOL_POLL_INTERVAL="5" # seconds
@@ -53,3 +56,21 @@ Sign request example payload:
5356
"contents": "0x0707070707070707070707070707070707070707070707070707070707070707"
5457
}
5558
```
59+
60+
## Transaction Sender
61+
62+
The builder includes a `transaction-sender` for sending miniscule transactions for the purpose of testing the rollup block construction process. The `transaction-sender` is located in `bin/submit-transaction.rs`.
63+
64+
It requires a key to sign the transactions and a funded wallet.
65+
66+
### Environment Variables
67+
68+
The `transaction-sender` also has a set of configurable environment variables listed below.
69+
70+
```
71+
RPC_URL="" # The URL of the RPC endpoint of the node you're sending the transaction to.
72+
RECIPIENT_ADDRESS="" # The address the submitter addresses the transaction to.
73+
SLEEP_TIME="" # The time to wait before sending another transaction, in seconds.
74+
SIGNER_CHAIN_ID=""
75+
SIGNER_KEY="" #
76+
```

0 commit comments

Comments
 (0)