Merge pull request #8 from zapper-95/fix-signer

fix: Fix signer

Author: zapper-95

.github/tests/external-l1/optimism.yaml

@@ -1,7 +1,18 @@
+optimism_package:
+  chains:
+    - batcher_params:
+        private_key: "e7848b12992369c383cfbff59633aeb305dbbd7a2c2ca19e60cc514dd953aefa"
+      challenger_params:
+        private_key: "e7848b12992369c383cfbff59633aeb305dbbd7a2c2ca19e60cc514dd953aefb"
+        enabled: true
+      sequencer_params:
+        private_key: "e7848b12992369c383cfbff59633aeb305dbbd7a2c2ca19e60cc514dd953aefc"     
+      proposer_params:
+        private_key: "e7848b12992369c383cfbff59633aeb305dbbd7a2c2ca19e60cc514dd953aefd"
 external_l1_network_params:
   network_id: "3151908"
   rpc_kind: standard
   el_rpc_url: http://el-1-geth-teku:8545 
   el_ws_url: ws://el-1-geth-teku:8546 
   cl_rpc_url: http://cl-1-teku-geth:4000 
-  priv_key: "0xbcdf20249abf0ed6d944c0288fad489e33f66b3960d9e6229c1cd214ed3bbe31"
+  priv_key: "0xbcdf20249abf0ed6d944c0288fad489e33f66b3960d9e6229c1cd214ed3bbe31"

README.md

@@ -1,37 +1,54 @@
-# Welcome to Optimism Package
+# UpRoll Optimism Package
+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.
+
+## New Configurations
+### Signer Information
+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.
+
+We introduce customisation for private keys and signer information (address and endpoint) for each privallaged role.
+
+
+| Role       | Parameter       | Path                                    |
+|------------|---------------|-----------------------------------------|
+| **Batcher**    | private_key    | `chain.batcher_params.private_key`    |
+|            | signer_endpoint | `chain.batcher_params.signer_endpoint` |
+|            | signer_address  | `chain.batcher_params.signer_address`  |
+| **Sequencer**  | private_key    | `chain.sequencer_params.private_key`  |
+|            | signer_endpoint | `chain.sequencer_params.signer_endpoint` |
+|            | signer_address  | `chain.sequencer_params.signer_address`  |
+| **Proposer**   | private_key    | `chain.proposer_params.private_key`   |
+|            | signer_endpoint | `chain.proposer_params.signer_endpoint` |
+|            | signer_address  | `chain.proposer_params.signer_address`  |
+| **Challenger** | private_key    | `chain.challenger_params.private_key` |
+|            | signer_endpoint | `chain.challenger_params.signer_endpoint` |
+|            | signer_address  | `chain.challenger_params.signer_address` |
+
+### Network Parameters
+| Parameter                         | Path                                              |
+|---------------------------------|---------------------------------------------------|
+| Withdrawal delay              | `chain.network_params.withdrawal_delay`          |
+| Fee withdrawal network          | `chain.network_params.fee_withdrawal_network`    |
+| Dispute game finality delay     | `chain.network_params.dispute_game_finality_delay` |
+
+### Gas Parameters
+| Parameter                   | Path                                       |
+|-----------------------------|--------------------------------------------|
+| Block gas limit             | `chain.gas_params.gas_limit`               |
+| EIP 1559 Elasticity         | `chain.gas_params.eip1559Elasticity`       |
+| EIP 1559 Denominator        | `chain.gas_params.denominator`            |
+| Base Fee Scalar            | `chain.gas_params.base_fee_scalar`         |
+| Blob Base Fee Scalar       | `chain.gas_params.blob_base_fee_scalar`    |
+
+
+### Data Availibility
+| Parameter                         | Path                                                           |
+|-----------------------------------|----------------------------------------------------------------|
+| Data availability type           | `optimism_package.altda_deploy_config.da_type`                 |
+| Batch submissions frequency      | `optimism_package.altda_deploy_config.da_batch_submission_frequency` |
+| DA server endpoint               | `chain.da_server_params.server_endpoint`                      |
+| DA Challenge Contract Address    | `optimism_package.altda_deploy_config.da_challenge_contract_address` |
 
-The default package for Optimism. The kurtosis package uses [op-deployer](https://github.com/ethereum-optimism/optimism/tree/develop/op-deployer) to manage
-the L2 chains and all associated artifacts such as contract deployments.
 
-```yaml
-optimism_package:
-  chains:
-    - participants:
-        - el_type: op-geth
-          cl_type: op-node
-        - el_type: op-reth
-        - el_type: op-erigon
-        - el_type: op-nethermind
-ethereum_package:
-  network_params:
-    preset: minimal
-    genesis_delay: 5
-    additional_preloaded_contracts: '
-      {
-        "0x4e59b44847b379578588920cA78FbF26c0B4956C": {
-          "balance": "0ETH",
-          "code": "0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf3",
-          "storage": {},
-          "nonce": "1"
-        }
-      }
-    '
-
-```
-
-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.
-
-You can also completely remove `ethereum_package` from your configuration in which case it will default to a `minimal` preset Ethereum network.
 
 ## Quickstart
 
@@ -138,14 +155,17 @@ optimism_package:
   #    - 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.
   altda_deploy_config:
     use_altda: false
-    # TODO: Is this field redundant? Afaiu setting it to GenericCommitment will not deploy the
-    # DAChallengeContract, and hence is equivalent to setting use_altda to false.
-    # Furthermore, altda rollups using generic commitments might anyways need to support failing over
-    # to keccak commitments if the altda layer is down.
+    da_type: "calldata" # allows auto, blobs, calldata or custom. Sets --data-availability-type in batcher_launcher
+
+    da_batch_submission_frequency: 1 #--max-channel-duration=1 in block units but user input in minutes
+
+    da_challenge_contract_address: "0x49cce536156dC6E5F05B26eaA8a2607Cb943e041"
+
+
     da_commitment_type: KeccakCommitment
     da_challenge_window: 100
     da_resolve_window: 100
-    da_bond_size: 0
+    da_bond_size: 1000
     da_resolver_refund_percentage: 0
 
   # An array of L2 networks to run
@@ -370,6 +390,15 @@ optimism_package:
         # The Docker image that should be used for the batcher; leave blank to use the default op-batcher image
         image: ""
 
+
+        # If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
+        private_key: ""  
+        signer_endpoint: "" # endpoint of the signer
+        signer_address: "" # wallet address of the signer
+
+        signer_endpoint ""
+
+
         # A list of optional extra params that will be passed to the batcher container for modifying its behaviour
         extra_params: []
 
@@ -381,6 +410,12 @@ optimism_package:
         # The Docker image that should be used for the challenger; leave blank to use the default op-challenger image
         image: ""
 
+
+        # If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
+        private_key: ""  
+        signer_endpoint: "" # endpoint of the signer
+        signer_address: "" # wallet address of the signer
+
         # A list of optional extra params that will be passed to the challenger container for modifying its behaviour
         extra_params: []
 
@@ -395,6 +430,11 @@ optimism_package:
         # The Docker image that should be used for the proposer; leave blank to use the default op-proposer image
         image: ""
 
+        # If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
+        private_key: ""  
+        signer_endpoint: "" # endpoint of the signer
+        signer_address: "" # wallet address of the signer
+
         # A list of optional extra params that will be passed to the proposer container for modifying its behaviour
         extra_params: []
 
@@ -404,6 +444,19 @@ optimism_package:
         # Interval between submitting L2 output proposals
         proposal_internal: 10m
 
+      sequencer_params:
+        # If using a testnet, use either a private key or signer information (signer_endpoint and signer_address), but not both
+        private_key: ""  
+        signer_endpoint: "" # endpoint of the signer
+        signer_address: "" # wallet address of the signer
+      
+      gas_params:
+        gas_limit: "0x17D7840"
+        eip_1559_elasticity: 6
+        eip_1559_denominator: 50
+        base_fee_scalar: 2
+        blob_base_fee_scalar: 1
+  
       # Default MEV configuration
       mev_params:
         # 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:
       # Configuration for da-server - https://specs.optimism.io/experimental/alt-da.html#da-server
       # 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.
       da_server_params:
-        image: us-docker.pkg.dev/oplabs-tools-artifacts/images/da-server:latest
-        # Command to pass to the container.
-        # This is kept maximally generic to allow for any possible configuration, given that different
-        # da layer da-servers might have completely different flags.
-        # The below arguments are also the default, so can be omitted, and will work as long as the image
-        # is the da-server above (which is also the default, so can also be omitted).
-        cmd:
-          - "da-server"
-          - "--file.path=/home"
-          - "--addr=0.0.0.0"
-          - "--port=3100"
-          - "--log.level=debug"
+        # include your custom da server endpoint
+        server_endpoint: ""
 
   # L2 contract deployer configuration - used for all L2 networks
   # The docker image that should be used for the L2 contract deployer

src/batcher/op-batcher/op_batcher_launcher.star

@@ -120,15 +120,12 @@ def get_batcher_config(
     plan.print("Batcher params: " + str(batcher_params))
     plan.print(batcher_params.signer_endpoint)
     plan.print(batcher_params.signer_address)
-
-    cmd.append("--private-key=" + gs_batcher_private_key)
-
-    # if batcher_params.private_key:
-    #     cmd.append("--private-key=" + gs_batcher_private_key)
-    # else:
-    #     cmd.append("--signer.endpoint=" + str(batcher_params.signer_endpoint))
-    #     cmd.append("--signer.address=" + str(batcher_params.signer_address))
-    #     cmd.append("--signer.tls.enabled=false")
+    if not batcher_params.signer_address:
+        cmd.append("--private-key=" + gs_batcher_private_key)
+    else:
+        cmd.append("--signer.endpoint=" + str(batcher_params.signer_endpoint))
+        cmd.append("--signer.address=" + str(batcher_params.signer_address))
+        cmd.append("--signer.tls.enabled=false")
 
     if observability_helper.enabled:
         observability.configure_op_service_metrics(cmd, ports)

src/challenger/op-challenger/op_challenger_launcher.star

@@ -109,11 +109,18 @@ def get_challenger_config(
         "--l1-beacon=" + l1_config_env_vars["CL_RPC_URL"],
         "--l1-eth-rpc=" + l1_config_env_vars["L1_RPC_URL"],
         "--l2-eth-rpc=" + el_context.rpc_http_url,
-        "--private-key=" + challenger_key,
         "--rollup-rpc=" + cl_context.beacon_http_url,
         "--trace-type=" + ",".join(challenger_params.cannon_trace_types),
     ]
 
+    if not challenger_params.signer_address:
+        cmd.append("--private-key=" + challenger_key)
+    else:
+        cmd.append("--signer.endpoint=" + str(challenger_params.signer_endpoint))
+        cmd.append("--signer.address=" + str(challenger_params.signer_address))
+        cmd.append("--signer.tls.enabled=false")
+
+    plan.print(cmd)
     # configure files
 
     files = {

src/cl/hildr/hildr_launcher.star

@@ -79,6 +79,7 @@ def launch(
     observability_helper,
     interop_params,
     da_server_context,
+    sequencer_params,
 ):
     # beacon_node_identity_recipe = PostHttpRequestRecipe(
     #     endpoint="/",
@@ -111,6 +112,7 @@ def launch(
         sequencer_enabled,
         observability_helper,
         da_server_context,
+        sequencer_params,
     )
 
     beacon_service = plan.add_service(service_name, config)
@@ -158,6 +160,7 @@ def get_beacon_config(
     sequencer_enabled,
     observability_helper,
     da_server_context,
+    sequencer_params,
 ):
     EXECUTION_ENGINE_ENDPOINT = "http://{0}:{1}".format(
         el_context.ip_addr,
@@ -223,6 +226,7 @@ def get_beacon_config(
         observability.expose_metrics_port(ports)
 
     if sequencer_enabled:
+        # this value is never used so why is it set?????
         sequencer_private_key = util.read_network_config_value(
             plan,
             launcher.deployment_output,
@@ -279,9 +283,10 @@ def get_beacon_config(
     return ServiceConfig(**config_args)
 
 
-def new_hildr_launcher(deployment_output, jwt_file, network_params):
+def new_hildr_launcher(deployment_output, jwt_file, network_params, sequencer_params):
     return struct(
         deployment_output=deployment_output,
         jwt_file=jwt_file,
         network_params=network_params,
+        sequencer_params=sequencer_params,
     )

src/cl/op-node/op_node_builder_launcher.star

@@ -78,6 +78,7 @@ def launch(
     observability_helper,
     interop_params,
     da_server_context,
+    sequencer_params,
 ):
     beacon_node_identity_recipe = PostHttpRequestRecipe(
         endpoint="/",
@@ -112,6 +113,7 @@ def launch(
         observability_helper,
         interop_params,
         da_server_context,
+        sequencer_params,
     )
 
     beacon_service = plan.add_service(service_name, config)
@@ -161,6 +163,7 @@ def get_beacon_config(
     observability_helper,
     interop_params,
     da_server_context,
+    sequencer_params,
 ):
     ports = dict(get_used_ports(BEACON_DISCOVERY_PORT_NUM))
 
@@ -254,8 +257,18 @@ def get_beacon_config(
             ".privateKey",
         )
 
+        if sequencer_params.signer_address:
+            env_vars.update(
+                {
+                    "OP_NODE_SIGNER_ADDRESS": str(sequencer_params.signer_address),
+                    "OP_NODE_SIGNER_ENDPOINT": str(sequencer_params.signer_endpoint),
+                    "OP_NODE_SIGNER_TLS_ENABLED": "false",
+                }
+            )
+        else:
+            cmd += ["--p2p.sequencer.key=" + sequencer_private_key]
+
         cmd += [
-            "--p2p.sequencer.key=" + sequencer_private_key,
             "--sequencer.enabled",
             "--sequencer.l1-confs=2",
         ]
@@ -314,9 +327,12 @@ def get_beacon_config(
     return ServiceConfig(**config_args)
 
 
-def new_op_node_builder_launcher(deployment_output, jwt_file, network_params):
+def new_op_node_builder_launcher(
+    deployment_output, jwt_file, network_params, sequencer_params
+):
     return struct(
         deployment_output=deployment_output,
         jwt_file=jwt_file,
         network_params=network_params,
+        sequencer_params=sequencer_params,
     )