From 95a4484de07a95fe25f55da5b0aadc320f3581f8 Mon Sep 17 00:00:00 2001 From: Slava <20563034+veaceslavdoina@users.noreply.github.com> Date: Mon, 29 Jan 2024 21:31:29 +0200 Subject: [PATCH] fix: update codex help output (#687) --- README.md | 17 +++++++++-------- codex/conf.nim | 10 +++++----- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a0691e83..bfd13116 100644 --- a/README.md +++ b/README.md @@ -76,30 +76,31 @@ The following options are available: --metrics Enable the metrics server [=false]. --metrics-address Listening address of the metrics server [=127.0.0.1]. --metrics-port Listening HTTP port of the metrics server [=8008]. - -d, --data-dir The directory where codex will store configuration and data.. + -d, --data-dir The directory where codex will store configuration and data. -i, --listen-addrs Multi Addresses to listen on [=/ip4/0.0.0.0/tcp/0]. -a, --nat IP Addresses to announce behind a NAT [=127.0.0.1]. -e, --disc-ip Discovery listen address [=0.0.0.0]. -u, --disc-port Discovery (UDP) port [=8090]. --net-privkey Source of network (secp256k1) private key file path or name [=key]. - -b, --bootstrap-node Specifies one or more bootstrap nodes to use when connecting to the network.. + -b, --bootstrap-node Specifies one or more bootstrap nodes to use when connecting to the network. --max-peers The maximum number of peers to connect to [=160]. --agent-string Node agent string which is used as identifier in network [=Codex]. --api-bindaddr The REST API bind address [=127.0.0.1]. -p, --api-port The REST Api port [=8080]. - --repo-kind backend for main repo store (fs, sqlite) [=fs]. + --repo-kind Backend for main repo store (fs, sqlite) [=fs]. -q, --storage-quota The size of the total storage quota dedicated to the node [=8589934592]. -t, --block-ttl Default block timeout in seconds - 0 disables the ttl [=$DefaultBlockTtl]. --block-mi Time interval in seconds - determines frequency of block maintenance cycle: how - often blocks are checked for expiration and cleanup. + often blocks are checked for expiration and cleanup [=$DefaultBlockMaintenanceInterval]. - --block-mn Number of blocks to check every maintenance cycle. [=1000]. - -c, --cache-size The size in MiB of the block cache, 0 disables the cache - might help on slow - hardrives [=0]. + --block-mn Number of blocks to check every maintenance cycle [=1000]. + -c, --cache-size The size of the block cache, 0 disables the cache - might help on slow hardrives + [=0]. --persistence Enables persistence mechanism, requires an Ethereum node [=false]. --eth-provider The URL of the JSON-RPC API of the Ethereum node [=ws://localhost:8545]. --eth-account The Ethereum account that is used for storage contracts [=EthAddress.none]. - --eth-deployment The json file describing the contract deployment [=string.none]. + --eth-private-key File containing Ethereum private key for storage contracts [=string.none]. + --marketplace-address Address of deployed Marketplace contract [=EthAddress.none]. --validator Enables validator, requires an Ethereum node [=false]. --validator-max-slots Maximum number of slots that the validator monitors [=1000]. diff --git a/codex/conf.nim b/codex/conf.nim index 09f17f83..197df56c 100644 --- a/codex/conf.nim +++ b/codex/conf.nim @@ -105,7 +105,7 @@ type name: "metrics-port" }: Port dataDir* {. - desc: "The directory where codex will store configuration and data." + desc: "The directory where codex will store configuration and data" defaultValue: defaultDataDir() defaultValueDesc: "" abbr: "d" @@ -154,7 +154,7 @@ type name: "net-privkey" }: string bootstrapNodes* {. - desc: "Specifies one or more bootstrap nodes to use when connecting to the network." + desc: "Specifies one or more bootstrap nodes to use when connecting to the network" abbr: "b" name: "bootstrap-node" }: seq[SignedPeerRecord] @@ -182,7 +182,7 @@ type abbr: "p" }: Port repoKind* {. - desc: "backend for main repo store (fs, sqlite)" + desc: "Backend for main repo store (fs, sqlite)" defaultValueDesc: "fs" defaultValue: repoFS name: "repo-kind" }: RepoKind @@ -202,13 +202,13 @@ type abbr: "t" }: Duration blockMaintenanceInterval* {. - desc: "Time interval in seconds - determines frequency of block maintenance cycle: how often blocks are checked for expiration and cleanup." + desc: "Time interval in seconds - determines frequency of block maintenance cycle: how often blocks are checked for expiration and cleanup" defaultValue: DefaultBlockMaintenanceInterval defaultValueDesc: $DefaultBlockMaintenanceInterval name: "block-mi" }: Duration blockMaintenanceNumberOfBlocks* {. - desc: "Number of blocks to check every maintenance cycle." + desc: "Number of blocks to check every maintenance cycle" defaultValue: DefaultNumberOfBlocksToMaintainPerInterval defaultValueDesc: $DefaultNumberOfBlocksToMaintainPerInterval name: "block-mn" }: int