From 26bae10e333b31940f297acc014297222e763d07 Mon Sep 17 00:00:00 2001 From: Vitaly Drogan Date: Mon, 4 Nov 2024 17:23:05 +0100 Subject: [PATCH] Update readme --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f997c2c..c119a94 100644 --- a/README.md +++ b/README.md @@ -42,23 +42,23 @@ COMMANDS: help, h Shows a list of commands or help for one command GLOBAL OPTIONS: - --local-listen-addr value address to listen on for orderflow proxy API for external users and local operator (default: "127.0.0.1:443") - --public-listen-addr value address to listen on for orderflow proxy API for other network participants (default: "127.0.0.1:5544") - --cert-listen-addr value address to listen on for orderflow proxy serving its SSL certificate on /cert (default: "127.0.0.1:14727") - --builder-endpoint value address to send local ordeflow to (default: "http://127.0.0.1:8645") - --rpc-endpoint value address of the node RPC that supports eth_blockNumber (default: "http://127.0.0.1:8545") - --builder-confighub-endpoint value address of the builder config hub enpoint (directly or throught the cvm-proxy) (default: "http://127.0.0.1:14892") - --orderflow-archive-endpoint value address of the ordreflow archive endpoint (block-processor) (default: "http://127.0.0.1:14893") - --flashbots-orderflow-signer-address value ordreflow from Flashbots will be signed with this address (default: "0x5015Fa72E34f75A9eC64f44a4Fcf0837919D1bB7") - --max-request-body-size-bytes value Maximum size of the request body, if 0 default will be used (default: 0) - --cert-duration value generated certificate duration (default: 8760h0m0s) - --cert-hosts value [ --cert-hosts value ] generated certificate hosts (default: "127.0.0.1", "localhost") - --metrics-addr value address to listen on for Prometheus metrics (metrics are served on $metrics-addr/metrics) (default: "127.0.0.1:8090") - --log-json log in JSON format (default: false) - --log-debug log debug messages (default: false) - --log-uid generate a uuid and add to all log messages (default: false) - --log-service value add 'service' tag to logs (default: "tdx-orderflow-proxy-receiver") - --pprof enable pprof debug endpoint (pprof is served on $metrics-addr/debug/pprof/*) (default: false) + --local-listen-addr value address to listen on for orderflow proxy API for external users and local operator (default: "127.0.0.1:443") [$LOCAL_LISTEN_ADDR] + --public-listen-addr value address to listen on for orderflow proxy API for other network participants (default: "127.0.0.1:5544") [$PUBLIC_LISTEN_ADDR] + --cert-listen-addr value address to listen on for orderflow proxy serving its SSL certificate on /cert (default: "127.0.0.1:14727") [$CERT_LISTEN_ADDR] + --builder-endpoint value address to send local ordeflow to (default: "http://127.0.0.1:8645") [$BUILDER_ENDPOINT] + --rpc-endpoint value address of the node RPC that supports eth_blockNumber (default: "http://127.0.0.1:8545") [$RPC_ENDPOINT] + --builder-confighub-endpoint value address of the builder config hub enpoint (directly or throught the cvm-proxy) (default: "http://127.0.0.1:14892") [$BUILDER_CONFIGHUB_ENDPOINT] + --orderflow-archive-endpoint value address of the ordreflow archive endpoint (block-processor) (default: "http://127.0.0.1:14893") [$ORDERFLOW_ARCHIVE_ENDPOINT] + --flashbots-orderflow-signer-address value ordreflow from Flashbots will be signed with this address (default: "0x5015Fa72E34f75A9eC64f44a4Fcf0837919D1bB7") [$FLASHBOTS_ORDERFLOW_SIGNER_ADDRESS] + --max-request-body-size-bytes value Maximum size of the request body, if 0 default will be used (default: 0) [$MAX_REQUEST_BODY_SIZE_BYTES] + --connections-per-peer value Number of parallel connections for each peer (default: 10) [$CONN_PER_PEER] + --cert-duration value generated certificate duration (default: 8760h0m0s) [$CERT_DURATION] + --cert-hosts value [ --cert-hosts value ] generated certificate hosts (default: "127.0.0.1", "localhost") [$CERT_HOSTS] + --metrics-addr value address to listen on for Prometheus metrics (metrics are served on $metrics-addr/metrics) (default: "127.0.0.1:8090") [$METRICS_ADDR] + --log-json log in JSON format (default: false) [$LOG_JSON] + --log-debug log debug messages (default: false) [$LOG_DEBUG] + --log-uid generate a uuid and add to all log messages (default: false) [$LOG_UID] + --log-service value add 'service' tag to logs (default: "tdx-orderflow-proxy-receiver") [$LOG_SERVICE] --pprof enable pprof debug endpoint (pprof is served on $metrics-addr/debug/pprof/*) (default: false) [$PPROF] --help, -h show help ``` @@ -86,6 +86,7 @@ GLOBAL OPTIONS: --builder-confighub-endpoint value address of the builder config hub enpoint (directly or throught the cvm-proxy) (default: "http://127.0.0.1:14892") [$BUILDER_CONFIGHUB_ENDPOINT] --orderflow-signer-key value ordreflow will be signed with this address (default: "0xfb5ad18432422a84514f71d63b45edf51165d33bef9c2bd60957a48d4c4cb68e") [$ORDERFLOW_SIGNER_KEY] --max-request-body-size-bytes value Maximum size of the request body, if 0 default will be used (default: 0) [$MAX_REQUEST_BODY_SIZE_BYTES] + --connections-per-peer value Number of parallel connections for each peer (default: 10) [$CONN_PER_PEER] --metrics-addr value address to listen on for Prometheus metrics (metrics are served on $metrics-addr/metrics) (default: "127.0.0.1:8090") [$METRICS_ADDR] --log-json log in JSON format (default: false) [$LOG_JSON] --log-debug log debug messages (default: false) [$LOG_DEBUG]