docs: make gen-doc

Author: minhd-vu

doc/polycli_dumpblocks.md

@@ -74,7 +74,7 @@ To solve this, add the unknown fields to the `.proto` files and recompile them (
 ## Flags
 
 ```bash
-  -b, --batch-size uint    the batch size. Realistically, this probably shouldn't be bigger than 999. Most providers seem to cap at 1000 (default 150)
+  -b, --batch-size uint    batch size for requests (most providers cap at 1000) (default 150)
   -c, --concurrency uint   how many go routines to leverage (default 1)
   -B, --dump-blocks        dump blocks to output (default true)
       --dump-receipts      dump receipts to output (default true)

doc/polycli_loadtest.md

@@ -79,45 +79,45 @@ The codebase has a contract that used for load testing. It's written in Solidity
 ## Flags
 
 ```bash
-      --account-funding-amount big.Int         the amount in wei to fund the sending accounts with. Set to 0 to disable account funding (useful for eth-call-only mode or pre-funded accounts)
+      --account-funding-amount big.Int         amount in wei to fund sending accounts (set to 0 to disable)
       --adaptive-backoff-factor float          multiplicative decrease factor for adaptive rate limiting (default 2)
       --adaptive-cycle-duration-seconds uint   interval in seconds to check queue size and adjust rates for adaptive rate limiting (default 10)
       --adaptive-rate-limit                    enable AIMD-style congestion control to automatically adjust request rate
       --adaptive-rate-limit-increment uint     size of additive increases for adaptive rate limiting (default 50)
       --adaptive-target-size uint              target queue size for adaptive rate limiting (speed up if smaller, back off if larger) (default 1000)
-      --batch-size uint                        number of batches to perform at a time for receipt fetching. Default is 999 requests at a time (default 999)
+      --batch-size uint                        batch size for receipt fetching (default: 999) (default 999)
       --blob-fee-cap uint                      blob fee cap, or maximum blob fee per chunk, in Gwei (default 100000)
-      --calldata string                        hex encoded calldata passed in. Format is function signature + arguments encoded together. This must be paired up with --mode contract-call and --contract-address
+      --calldata string                        hex encoded calldata: function signature + encoded arguments (requires --mode contract-call and --contract-address)
       --chain-id uint                          chain ID for the transactions
-  -c, --concurrency int                        number of requests to perform concurrently. Default is one request at a time (default 1)
-      --contract-address string                address of contract that will be used in --mode contract-call. This must be paired up with --mode contract-call and --calldata
+  -c, --concurrency int                        number of requests to perform concurrently (default: one at a time) (default 1)
+      --contract-address string                contract address for --mode contract-call (requires --calldata)
       --contract-call-payable                  mark function as payable using value from --eth-amount-in-wei (requires --mode contract-call and --contract-address)
       --erc20-address string                   address of pre-deployed ERC20 contract
       --erc721-address string                  address of pre-deployed ERC721 contract
       --eth-amount-in-wei uint                 amount of ether in wei to send per transaction
       --eth-call-only                          call contracts without sending transactions (incompatible with adaptive rate limiting and summarization)
       --eth-call-only-latest                   execute on latest block instead of original block in call-only mode with recall
       --fire-and-forget                        send transactions and load without waiting for it to be mined
-      --gas-limit uint                         in environments where the gas limit can't be computed on the fly, we can specify it manually. This can also be used to avoid eth_estimateGas
-      --gas-price uint                         in environments where the gas price can't be determined automatically, we can specify it manually
+      --gas-limit uint                         manually specify gas limit (useful to avoid eth_estimateGas or when auto-computation fails)
+      --gas-price uint                         manually specify gas price (useful when auto-detection fails)
       --gas-price-multiplier float             a multiplier to increase or decrease the gas price (default 1)
   -h, --help                                   help for loadtest
       --legacy                                 send a legacy transaction instead of an EIP1559 transaction
       --loadtest-contract-address string       address of pre-deployed load test contract
       --max-base-fee-wei uint                  maximum base fee in wei (pause sending new transactions when exceeded, useful during network congestion)
-  -m, --mode strings                           the testing mode to use. It can be multiple like: "d,t"
-                                               2, erc20 - Send ERC20 tokens
-                                               7, erc721 - Mint ERC721 tokens
-                                               b, blob - Send blob transactions
-                                               cc, contract-call - Make contract calls
-                                               d, deploy - Deploy contracts
-                                               inc, increment - Increment a counter
-                                               r, random - Random modes (does not include the following modes: blob, call, inscription, recall, rpc, uniswapv3)
-                                               R, recall - Replay or simulate transactions
-                                               rpc - Call random rpc methods
-                                               s, store - Store bytes in a dynamic byte array
-                                               t, transaction - Send transactions
-                                               v3, uniswapv3 - Perform UniswapV3 swaps (default [t])
+  -m, --mode strings                           testing mode (can specify multiple like "d,t"):
+                                               2, erc20 - send ERC20 tokens
+                                               7, erc721 - mint ERC721 tokens
+                                               b, blob - send blob transactions
+                                               cc, contract-call - make contract calls
+                                               d, deploy - deploy contracts
+                                               inc, increment - increment a counter
+                                               r, random - random modes (excludes: blob, call, inscription, recall, rpc, uniswapv3)
+                                               R, recall - replay or simulate transactions
+                                               rpc - call random rpc methods
+                                               s, store - store bytes in a dynamic byte array
+                                               t, transaction - send transactions
+                                               v3, uniswapv3 - perform UniswapV3 swaps (default [t])
       --nonce uint                             use this flag to manually set the starting nonce
       --output-mode string                     format mode for summary output (json | text) (default "text")
       --output-raw-tx-only                     output raw signed transaction hex without sending (works with most modes except RPC and UniswapV3)
@@ -126,20 +126,20 @@ The codebase has a contract that used for load testing. It's written in Solidity
       --private-key string                     hex encoded private key to use for sending transactions (default "42b6e34dc21598a807dc19d7784c71b2a7a01f6480dc6f58258f78e539f1a1fa")
       --proxy string                           use the proxy specified
       --random-recipients                      send to random addresses instead of fixed address in transfer tests
-      --rate-limit float                       an overall limit to the number of requests per second. Give a number less than zero to remove this limit all together (default 4)
+      --rate-limit float                       requests per second limit (use negative value to remove limit) (default 4)
       --recall-blocks uint                     number of blocks that we'll attempt to fetch for recall (default 50)
-      --receipt-retry-initial-delay-ms uint    initial delay in milliseconds for receipt polling retry. Uses exponential backoff with jitter (default 100)
+      --receipt-retry-initial-delay-ms uint    initial delay in milliseconds for receipt polling (uses exponential backoff with jitter) (default 100)
       --receipt-retry-max uint                 maximum polling attempts for transaction receipt with --wait-for-receipt (default 30)
       --refund-remaining-funds                 refund remaining balance to funding account after completion
-  -n, --requests int                           number of requests to perform for the benchmarking session. The default is to just perform a single request which usually leads to non-representative benchmarking results (default 1)
+  -n, --requests int                           number of requests to perform for the benchmarking session (default of 1 leads to non-representative results) (default 1)
   -r, --rpc-url string                         the RPC endpoint URL (default "http://localhost:8545")
       --seed int                               a seed for generating random values and addresses (default 123456)
       --send-only                              alias for --fire-and-forget
-      --sending-accounts-count uint            number of sending accounts to use. This is useful for avoiding pool account queue
-      --sending-accounts-file string           file containing sending accounts private keys, one per line. This is useful for avoiding pool account queue but also to keep same sending accounts for different execution cycles
+      --sending-accounts-count uint            number of sending accounts to use (avoids pool account queue)
+      --sending-accounts-file string           file with sending account private keys, one per line (avoids pool queue and preserves accounts across runs)
       --store-data-size uint                   number of bytes to store in contract for store mode (default 1024)
       --summarize                              produce execution summary after load test (can take a long time for large tests)
-  -t, --time-limit int                         maximum number of seconds to spend for benchmarking. Use this to benchmark within a fixed total amount of time. Per default there is no time limit (default -1)
+  -t, --time-limit int                         maximum seconds to spend benchmarking (default: no limit) (default -1)
       --to-address string                      recipient address for transactions (default "0xDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEF")
       --wait-for-receipt                       wait for transaction receipt to be mined instead of just sending
 ```

doc/polycli_loadtest_uniswapv3.md

@@ -54,7 +54,7 @@ Contracts are cloned from the different Uniswap repositories, compiled with a sp
 
 ```bash
   -h, --help                                                   help for uniswapv3
-  -f, --pool-fees float                                        trading fees charged on each swap or trade made within a UniswapV3 liquidity pool (e.g. 0.3 means 0.3%) (default 0.3)
+  -f, --pool-fees float                                        trading fees for UniswapV3 liquidity pool swaps (e.g. 0.3 means 0.3%) (default 0.3)
   -a, --swap-amount uint                                       amount of inbound token given as swap input (default 1000)
       --uniswap-factory-v3-address string                      address of pre-deployed UniswapFactoryV3 contract
       --uniswap-migrator-address string                        address of pre-deployed Migrator contract
@@ -81,16 +81,16 @@ The command also inherits flags from parent commands.
       --adaptive-rate-limit                    enable AIMD-style congestion control to automatically adjust request rate
       --adaptive-rate-limit-increment uint     size of additive increases for adaptive rate limiting (default 50)
       --adaptive-target-size uint              target queue size for adaptive rate limiting (speed up if smaller, back off if larger) (default 1000)
-      --batch-size uint                        number of batches to perform at a time for receipt fetching. Default is 999 requests at a time (default 999)
+      --batch-size uint                        batch size for receipt fetching (default: 999) (default 999)
       --chain-id uint                          chain ID for the transactions
-  -c, --concurrency int                        number of requests to perform concurrently. Default is one request at a time (default 1)
+  -c, --concurrency int                        number of requests to perform concurrently (default: one at a time) (default 1)
       --config string                          config file (default is $HOME/.polygon-cli.yaml)
       --eth-amount-in-wei uint                 amount of ether in wei to send per transaction
       --eth-call-only                          call contracts without sending transactions (incompatible with adaptive rate limiting and summarization)
       --eth-call-only-latest                   execute on latest block instead of original block in call-only mode with recall
       --fire-and-forget                        send transactions and load without waiting for it to be mined
-      --gas-limit uint                         in environments where the gas limit can't be computed on the fly, we can specify it manually. This can also be used to avoid eth_estimateGas
-      --gas-price uint                         in environments where the gas price can't be determined automatically, we can specify it manually
+      --gas-limit uint                         manually specify gas limit (useful to avoid eth_estimateGas or when auto-computation fails)
+      --gas-price uint                         manually specify gas price (useful when auto-detection fails)
       --gas-price-multiplier float             a multiplier to increase or decrease the gas price (default 1)
       --legacy                                 send a legacy transaction instead of an EIP1559 transaction
       --nonce uint                             use this flag to manually set the starting nonce
@@ -100,13 +100,13 @@ The command also inherits flags from parent commands.
       --priority-gas-price uint                gas tip price for EIP-1559 transactions
       --private-key string                     hex encoded private key to use for sending transactions (default "42b6e34dc21598a807dc19d7784c71b2a7a01f6480dc6f58258f78e539f1a1fa")
       --random-recipients                      send to random addresses instead of fixed address in transfer tests
-      --rate-limit float                       an overall limit to the number of requests per second. Give a number less than zero to remove this limit all together (default 4)
-  -n, --requests int                           number of requests to perform for the benchmarking session. The default is to just perform a single request which usually leads to non-representative benchmarking results (default 1)
+      --rate-limit float                       requests per second limit (use negative value to remove limit) (default 4)
+  -n, --requests int                           number of requests to perform for the benchmarking session (default of 1 leads to non-representative results) (default 1)
   -r, --rpc-url string                         the RPC endpoint URL (default "http://localhost:8545")
       --seed int                               a seed for generating random values and addresses (default 123456)
       --send-only                              alias for --fire-and-forget
       --summarize                              produce execution summary after load test (can take a long time for large tests)
-  -t, --time-limit int                         maximum number of seconds to spend for benchmarking. Use this to benchmark within a fixed total amount of time. Per default there is no time limit (default -1)
+  -t, --time-limit int                         maximum seconds to spend benchmarking (default: no limit) (default -1)
       --to-address string                      recipient address for transactions (default "0xDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEF")
   -v, --verbosity int                          0 - silent
                                                100 panic

doc/polycli_publish.md

@@ -50,11 +50,11 @@ polycli publish --rpc-url https://sepolia.drpc.org
 ## Flags
 
 ```bash
-  -c, --concurrency uint      number of txs to send concurrently. Default is one request at a time (default 1)
+  -c, --concurrency uint      number of txs to send concurrently (default: one at a time) (default 1)
       --file string           provide a filename with transactions to publish
   -h, --help                  help for publish
       --job-queue-size uint   number of jobs we can put in the job queue for workers to process (default 100)
-      --rate-limit uint       rate limit in txs per second. Default is no rate limit
+      --rate-limit uint       rate limit in txs per second (default: no limit)
       --rpc-url string        RPC URL of network (default "http://localhost:8545")
 ```
 

doc/polycli_ulxly_claim-everything.md

@@ -21,7 +21,7 @@ polycli ulxly  claim-everything [flags]
 ```bash
       --bridge-limit int             limit the number or responses returned by the bridge service when claiming (default 25)
       --bridge-offset int            offset to specify for pagination of underlying bridge service deposits
-      --bridge-service-map strings   mappings between network IDs and bridge service URLs. E.g. '1=http://network-1-bridgeurl,7=http://network-2-bridgeurl'
+      --bridge-service-map strings   network ID to bridge service URL mappings (e.g. '1=http://network-1-bridgeurl,7=http://network-2-bridgeurl')
       --concurrency uint             worker pool size for claims (default 1)
   -h, --help                         help for claim-everything
 ```

doc/polycli_ulxly_claim.md

@@ -21,7 +21,7 @@ Commands for claiming deposits on a particular chain
       --deposit-network uint        rollup ID of the network where the deposit was made
       --global-index string         an override of the global index value
   -h, --help                        help for claim
-      --wait duration               this flag is available for claim asset and claim message. if specified, the command will retry in a loop for the deposit to be ready to claim up to duration. Once the deposit is ready to claim, the claim will actually be sent.
+      --wait duration               retry claiming until deposit is ready, up to specified duration (available for claim asset and claim message)
 ```
 
 The command also inherits flags from parent commands.

doc/polycli_ulxly_claim_asset.md

@@ -132,7 +132,7 @@ The command also inherits flags from parent commands.
                                            500 info
                                            600 debug
                                            700 trace (default 500)
-      --wait duration                      this flag is available for claim asset and claim message. if specified, the command will retry in a loop for the deposit to be ready to claim up to duration. Once the deposit is ready to claim, the claim will actually be sent.
+      --wait duration                      retry claiming until deposit is ready, up to specified duration (available for claim asset and claim message)
 ```
 
 ## See also