Skip to content

Commit 2ec727d

Browse files
zapper-95zapper-95
committed
docs: updated information on features of fork
1 parent 56f9d98 commit 2ec727d

File tree

1 file changed

+92
-49
lines changed

1 file changed

+92
-49
lines changed

‎README.md‎

Lines changed: 92 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,54 @@
1-
# Welcome to Optimism Package
1+
# UpRoll Optimism Package
2+
This is a fork of the optimism package built to allow more chain configurations. Its intended purpose is to give [UpRoll CLI](https://github.com/zapper-95/UpRoll-cli.git) greater control over deployed rollups.
3+
4+
## New Configurations
5+
### Signer Information
6+
In the upstream package, privates keys are determined by the mnemonic `test test test test test test test test test test test junk` and cannot be customised.
7+
8+
We introduce customisation for private keys and signer information (address and endpoint) for each privallaged role.
9+
10+
11+
| Role | Parameter | Path |
12+
|------------|---------------|-----------------------------------------|
13+
| **Batcher** | private_key | `chain.batcher_params.private_key` |
14+
| | signer_endpoint | `chain.batcher_params.signer_endpoint` |
15+
| | signer_address | `chain.batcher_params.signer_address` |
16+
| **Sequencer** | private_key | `chain.sequencer_params.private_key` |
17+
| | signer_endpoint | `chain.sequencer_params.signer_endpoint` |
18+
| | signer_address | `chain.sequencer_params.signer_address` |
19+
| **Proposer** | private_key | `chain.proposer_params.private_key` |
20+
| | signer_endpoint | `chain.proposer_params.signer_endpoint` |
21+
| | signer_address | `chain.proposer_params.signer_address` |
22+
| **Challenger** | private_key | `chain.challenger_params.private_key` |
23+
| | signer_endpoint | `chain.challenger_params.signer_endpoint` |
24+
| | signer_address | `chain.challenger_params.signer_address` |
25+
26+
### Network Parameters
27+
| Parameter | Path |
28+
|---------------------------------|---------------------------------------------------|
29+
| Withdrawal delay | `chain.network_params.withdrawal_delay` |
30+
| Fee withdrawal network | `chain.network_params.fee_withdrawal_network` |
31+
| Dispute game finality delay | `chain.network_params.dispute_game_finality_delay` |
32+
33+
### Gas Parameters
34+
| Parameter | Path |
35+
|-----------------------------|--------------------------------------------|
36+
| Block gas limit | `chain.gas_params.gas_limit` |
37+
| EIP 1559 Elasticity | `chain.gas_params.eip1559Elasticity` |
38+
| EIP 1559 Denominator | `chain.gas_params.denominator` |
39+
| Base Fee Scalar | `chain.gas_params.base_fee_scalar` |
40+
| Blob Base Fee Scalar | `chain.gas_params.blob_base_fee_scalar` |
41+
42+
43+
### Data Availibility
44+
| Parameter | Path |
45+
|-----------------------------------|----------------------------------------------------------------|
46+
| Data availability type | `optimism_package.altda_deploy_config.da_type` |
47+
| Batch submissions frequency | `optimism_package.altda_deploy_config.da_batch_submission_frequency` |
48+
| DA server endpoint | `chain.da_server_params.server_endpoint` |
49+
| DA Challenge Contract Address | `optimism_package.altda_deploy_config.da_challenge_contract_address` |
250

3-
The default package for Optimism. The kurtosis package uses [op-deployer](https://github.com/ethereum-optimism/optimism/tree/develop/op-deployer) to manage
4-
the L2 chains and all associated artifacts such as contract deployments.
551

6-
```yaml
7-
optimism_package:
8-
chains:
9-
- participants:
10-
- el_type: op-geth
11-
cl_type: op-node
12-
- el_type: op-reth
13-
- el_type: op-erigon
14-
- el_type: op-nethermind
15-
ethereum_package:
16-
network_params:
17-
preset: minimal
18-
genesis_delay: 5
19-
additional_preloaded_contracts: '
20-
{
21-
"0x4e59b44847b379578588920cA78FbF26c0B4956C": {
22-
"balance": "0ETH",
23-
"code": "0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf3",
24-
"storage": {},
25-
"nonce": "1"
26-
}
27-
}
28-
'
29-
30-
```
31-
32-
Please note, by default your network will be running a `minimal` preset Ethereum network. Click [here](https://github.com/ethereum/consensus-specs/blob/dev/configs/minimal.yaml) to learn more about minimal preset. You can [customize](https://github.com/ethpandaops/ethereum-package) the L1 Ethereum network by modifying the `ethereum_package` configuration.
33-
34-
You can also completely remove `ethereum_package` from your configuration in which case it will default to a `minimal` preset Ethereum network.
3552

3653
## Quickstart
3754

@@ -138,14 +155,17 @@ optimism_package:
138155
# - For altda chains, set da_server_params to use an image and cmd of your choice (one could use da-server, another eigenda-proxy, another celestia proxy, etc). If unset, op's default da-server image will be used.
139156
altda_deploy_config:
140157
use_altda: false
141-
# TODO: Is this field redundant? Afaiu setting it to GenericCommitment will not deploy the
142-
# DAChallengeContract, and hence is equivalent to setting use_altda to false.
143-
# Furthermore, altda rollups using generic commitments might anyways need to support failing over
144-
# to keccak commitments if the altda layer is down.
158+
da_type: "calldata" # allows auto, blobs, calldata or custom. Sets --data-availability-type in batcher_launcher
159+
160+
da_batch_submission_frequency: 1 #--max-channel-duration=1 in block units but user input in minutes
161+
162+
da_challenge_contract_address: "0x49cce536156dC6E5F05B26eaA8a2607Cb943e041"
163+
164+
145165
da_commitment_type: KeccakCommitment
146166
da_challenge_window: 100
147167
da_resolve_window: 100
148-
da_bond_size: 0
168+
da_bond_size: 1000
149169
da_resolver_refund_percentage: 0
150170

151171
# An array of L2 networks to run
@@ -370,6 +390,15 @@ optimism_package:
370390
# The Docker image that should be used for the batcher; leave blank to use the default op-batcher image
371391
image: ""
372392

393+
394+
# If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
395+
private_key: ""
396+
signer_endpoint: "" # endpoint of the signer
397+
signer_address: "" # wallet address of the signer
398+
399+
signer_endpoint ""
400+
401+
373402
# A list of optional extra params that will be passed to the batcher container for modifying its behaviour
374403
extra_params: []
375404

@@ -381,6 +410,12 @@ optimism_package:
381410
# The Docker image that should be used for the challenger; leave blank to use the default op-challenger image
382411
image: ""
383412

413+
414+
# If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
415+
private_key: ""
416+
signer_endpoint: "" # endpoint of the signer
417+
signer_address: "" # wallet address of the signer
418+
384419
# A list of optional extra params that will be passed to the challenger container for modifying its behaviour
385420
extra_params: []
386421

@@ -395,6 +430,11 @@ optimism_package:
395430
# The Docker image that should be used for the proposer; leave blank to use the default op-proposer image
396431
image: ""
397432

433+
# If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
434+
private_key: ""
435+
signer_endpoint: "" # endpoint of the signer
436+
signer_address: "" # wallet address of the signer
437+
398438
# A list of optional extra params that will be passed to the proposer container for modifying its behaviour
399439
extra_params: []
400440

@@ -404,6 +444,19 @@ optimism_package:
404444
# Interval between submitting L2 output proposals
405445
proposal_internal: 10m
406446

447+
sequencer_params:
448+
# If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
449+
private_key: ""
450+
signer_endpoint: "" # endpoint of the signer
451+
signer_address: "" # wallet address of the signer
452+
453+
gas_params:
454+
gas_limit: "0x17D7840"
455+
eip_1559_elasticity: 6
456+
eip_1559_denominator: 50
457+
base_fee_scalar: 2
458+
blob_base_fee_scalar: 1
459+
407460
# Default MEV configuration
408461
mev_params:
409462
# The Docker image that should be used for rollup boost; leave blank to use the default rollup-boost image
@@ -427,18 +480,8 @@ optimism_package:
427480
# Configuration for da-server - https://specs.optimism.io/experimental/alt-da.html#da-server
428481
# TODO: each op-node and op-batcher should potentially have their own da-server, instead of sharing one like we currently do. For eg batcher needs to write via its da-server, whereas op-nodes don't.
429482
da_server_params:
430-
image: us-docker.pkg.dev/oplabs-tools-artifacts/images/da-server:latest
431-
# Command to pass to the container.
432-
# This is kept maximally generic to allow for any possible configuration, given that different
433-
# da layer da-servers might have completely different flags.
434-
# The below arguments are also the default, so can be omitted, and will work as long as the image
435-
# is the da-server above (which is also the default, so can also be omitted).
436-
cmd:
437-
- "da-server"
438-
- "--file.path=/home"
439-
- "--addr=0.0.0.0"
440-
- "--port=3100"
441-
- "--log.level=debug"
483+
# include your custom da server endpoint
484+
server_endpoint: ""
442485

443486
# L2 contract deployer configuration - used for all L2 networks
444487
# The docker image that should be used for the L2 contract deployer

0 commit comments

Comments
 (0)