Skip to content

Commit

Permalink
Unify CLI README and helpstring, update .env.example, update readme w…
Browse files Browse the repository at this point in the history
…ith nice table showing required params
  • Loading branch information
teddyknox committed Jun 26, 2024
1 parent 5bfb245 commit f96169d
Show file tree
Hide file tree
Showing 7 changed files with 273 additions and 131 deletions.
51 changes: 0 additions & 51 deletions .env.example

This file was deleted.

73 changes: 73 additions & 0 deletions .env.example.holesky
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# An example holesky testnet configuration

# Hex-encoded signer private key. This key should not be associated with an Ethereum address holding any funds.
EIGENDA_PROXY_SIGNER_PRIVATE_KEY_HEX=

# JSON RPC node endpoint for the Ethereum network used for finalizing DA blobs. See available list here: https://docs.eigenlayer.xyz/eigenda/networks/
EIGENDA_PROXY_ETH_RPC=https://ethereum-holesky-rpc.publicnode.com

# RPC host of the EigenDA disperser service (e.g., on Holesky this is `disperser-holesky.eigenda.xyz:443`). Full network list available in the documentation.
EIGENDA_PROXY_EIGENDA_DISPERSER_RPC=disperser-holesky.eigenda.xyz:443

# The deployed EigenDA service manager address. The list can be found here: https://github.com/Layr-Labs/eigenlayer-middleware/?tab=readme-ov-file#current-mainnet-deployment
EIGENDA_PROXY_SERVICE_MANAGER_ADDR=0xD4A7E1Bd8015057293f0D0A557088c286942e84b

# Custom quorum IDs for writing blobs. Should not include default quorums 0 or 1.
# EIGENDA_PROXY_CUSTOM_QUORUM_IDS=

# Directory path to SRS tables
# EIGENDA_PROXY_TARGET_CACHE_PATH=resources/SRSTables

# Directory path to g1.point file
# EIGENDA_PROXY_TARGET_KZG_G1_PATH=resources/g1.point

# Directory path to g2.point.powerOf2 file
# EIGENDA_PROXY_TARGET_G2_TAU_PATH=resources/g2.point.powerOf2

# Disable point verification mode. This mode performs IFFT on data before writing and FFT on data after reading. Disabling requires supplying the entire blob for verification against the KZG commitment.
# EIGENDA_PROXY_DISABLE_POINT_VERIFICATION_MODE=false

# Disable TLS for gRPC communication with the EigenDA disperser
# EIGENDA_PROXY_GRPC_DISABLE_TLS=false

# Maximum blob length to be written or read from EigenDA. Determines the number of SRS points loaded into memory for KZG commitments. Example units: '30MiB', '4Kb', '30MB'. Maximum size slightly exceeds 1GB.
# EIGENDA_PROXY_MAX_BLOB_LENGTH=2MiB

# Blob encoding version to use when writing blobs from the high-level interface
# EIGENDA_PROXY_PUT_BLOB_ENCODING_VERSION=0

# Total time to wait for a response from the EigenDA disperser
# EIGENDA_PROXY_RESPONSE_TIMEOUT=10s

# Interval between retries when awaiting network blob finalization
# EIGENDA_PROXY_STATUS_QUERY_INTERVAL=5s

# Duration to wait for a blob to finalize after being sent for dispersal
# EIGENDA_PROXY_STATUS_QUERY_TIMEOUT=45m0s

# Color the log output if in terminal mode
# EIGENDA_PROXY_LOG_COLOR=false

# Format the log output. Supported formats: 'text', 'terminal', 'logfmt', 'json', 'json-pretty'
# EIGENDA_PROXY_LOG_FORMAT=text

# The lowest log level that will be output
# EIGENDA_PROXY_LOG_LEVEL=INFO

# Show pid in the log
# EIGENDA_PROXY_LOG_PID=false

# Whether to use mem-store for DA logic
# MEMSTORE_ENABLED=false

# Duration that a blob/commitment pair are allowed to live
# MEMSTORE_EXPIRATION=25m0s

# Metrics listening address
# EIGENDA_PROXY_METRICS_ADDR=0.0.0.0

# Enable the metrics server
# EIGENDA_PROXY_METRICS_ENABLED=false

# Metrics listening port
# EIGENDA_PROXY_METRICS_PORT=7300
73 changes: 73 additions & 0 deletions .env.example.mainnet
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# An example mainnet configuration

# Hex-encoded signer private key. This key should not be associated with an Ethereum address holding any funds.
EIGENDA_PROXY_SIGNER_PRIVATE_KEY_HEX=

# JSON RPC node endpoint for the Ethereum network used for finalizing DA blobs. See available list here: https://docs.eigenlayer.xyz/eigenda/networks/
EIGENDA_PROXY_ETH_RPC=

# RPC host of the EigenDA disperser service (e.g., on Holesky this is `disperser-holesky.eigenda.xyz:443`). Full network list available in the documentation.
EIGENDA_PROXY_EIGENDA_DISPERSER_RPC=disperser.eigenda.xyz:443

# The deployed EigenDA service manager address. The list can be found here: https://github.com/Layr-Labs/eigenlayer-middleware/?tab=readme-ov-file#current-mainnet-deployment
EIGENDA_PROXY_SERVICE_MANAGER_ADDR=0x870679E138bCdf293b7Ff14dD44b70FC97e12fc0

# Custom quorum IDs for writing blobs. Should not include default quorums 0 or 1.
# EIGENDA_PROXY_CUSTOM_QUORUM_IDS=

# Directory path to SRS tables
# EIGENDA_PROXY_TARGET_CACHE_PATH=resources/SRSTables

# Directory path to g1.point file
# EIGENDA_PROXY_TARGET_KZG_G1_PATH=resources/g1.point

# Directory path to g2.point.powerOf2 file
# EIGENDA_PROXY_TARGET_G2_TAU_PATH=resources/g2.point.powerOf2

# Disable point verification mode. This mode performs IFFT on data before writing and FFT on data after reading. Disabling requires supplying the entire blob for verification against the KZG commitment.
# EIGENDA_PROXY_DISABLE_POINT_VERIFICATION_MODE=false

# Disable TLS for gRPC communication with the EigenDA disperser
# EIGENDA_PROXY_GRPC_DISABLE_TLS=false

# Maximum blob length to be written or read from EigenDA. Determines the number of SRS points loaded into memory for KZG commitments. Example units: '30MiB', '4Kb', '30MB'. Maximum size slightly exceeds 1GB.
# EIGENDA_PROXY_MAX_BLOB_LENGTH=2MiB

# Blob encoding version to use when writing blobs from the high-level interface
# EIGENDA_PROXY_PUT_BLOB_ENCODING_VERSION=0

# Total time to wait for a response from the EigenDA disperser
# EIGENDA_PROXY_RESPONSE_TIMEOUT=10s

# Interval between retries when awaiting network blob finalization
# EIGENDA_PROXY_STATUS_QUERY_INTERVAL=5s

# Duration to wait for a blob to finalize after being sent for dispersal
# EIGENDA_PROXY_STATUS_QUERY_TIMEOUT=30m0s

# Color the log output if in terminal mode
# EIGENDA_PROXY_LOG_COLOR=false

# Format the log output. Supported formats: 'text', 'terminal', 'logfmt', 'json', 'json-pretty'
# EIGENDA_PROXY_LOG_FORMAT=text

# The lowest log level that will be output
# EIGENDA_PROXY_LOG_LEVEL=INFO

# Show pid in the log
# EIGENDA_PROXY_LOG_PID=false

# Whether to use mem-store for DA logic
# MEMSTORE_ENABLED=false

# Duration that a blob/commitment pair are allowed to live
# MEMSTORE_EXPIRATION=25m0s

# Metrics listening address
# EIGENDA_PROXY_METRICS_ADDR=0.0.0.0

# Enable the metrics server
# EIGENDA_PROXY_METRICS_ENABLED=false

# Metrics listening port
# EIGENDA_PROXY_METRICS_PORT=7300
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ resources/SRSTables/
/.vscode

## Idea
.idea
.idea
Loading

0 comments on commit f96169d

Please sign in to comment.