Skip to content

Commit bfa4469

Browse files
tclemostclemos
committed
make gen-doc
1 parent e1143f6 commit bfa4469

File tree

2 files changed

+41
-45
lines changed

2 files changed

+41
-45
lines changed

‎doc/polycli_loadtest.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,6 @@ The codebase has a contract that used for load testing. It's written in Solidity
111111
--gas-price uint manually specify gas price (useful when auto-detection fails)
112112
--gas-price-multiplier float a multiplier to increase or decrease the gas price (default 1)
113113
-h, --help help for loadtest
114-
--infinite run the load test indefinitely until manually stopped. It will follow the rate limit and concurrency settings, but at the end, it will repeat all over again
115-
--infinite-interval-duration-seconds uint duration to wait between iterations when running in infinite mode
116114
--legacy send a legacy transaction instead of an EIP1559 transaction
117115
--loadtest-contract-address string address of pre-deployed load test contract
118116
--max-base-fee-wei uint maximum base fee in wei (pause sending new transactions when exceeded, useful during network congestion)

‎doc/polycli_loadtest_uniswapv3.md‎

Lines changed: 41 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -76,49 +76,47 @@ Contracts are cloned from the different Uniswap repositories, compiled with a sp
7676
The command also inherits flags from parent commands.
7777

7878
```bash
79-
--adaptive-backoff-factor float multiplicative decrease factor for adaptive rate limiting (default 2)
80-
--adaptive-cycle-duration-seconds uint interval in seconds to check queue size and adjust rates for adaptive rate limiting (default 10)
81-
--adaptive-rate-limit enable AIMD-style congestion control to automatically adjust request rate
82-
--adaptive-rate-limit-increment uint size of additive increases for adaptive rate limiting (default 50)
83-
--adaptive-target-size uint target queue size for adaptive rate limiting (speed up if smaller, back off if larger) (default 1000)
84-
--batch-size uint batch size for receipt fetching (default: 999) (default 999)
85-
--chain-id uint chain ID for the transactions
86-
-c, --concurrency int number of requests to perform concurrently (default: one at a time) (default 1)
87-
--config string config file (default is $HOME/.polygon-cli.yaml)
88-
--eth-amount-in-wei uint amount of ether in wei to send per transaction
89-
--eth-call-only call contracts without sending transactions (incompatible with adaptive rate limiting and summarization)
90-
--eth-call-only-latest execute on latest block instead of original block in call-only mode with recall
91-
--fire-and-forget send transactions and load without waiting for it to be mined
92-
--gas-limit uint manually specify gas limit (useful to avoid eth_estimateGas or when auto-computation fails)
93-
--gas-price uint manually specify gas price (useful when auto-detection fails)
94-
--gas-price-multiplier float a multiplier to increase or decrease the gas price (default 1)
95-
--infinite run the load test indefinitely until manually stopped. It will follow the rate limit and concurrency settings, but at the end, it will repeat all over again
96-
--infinite-interval-duration-seconds uint duration to wait between iterations when running in infinite mode
97-
--legacy send a legacy transaction instead of an EIP1559 transaction
98-
--nonce uint use this flag to manually set the starting nonce
99-
--output-mode string format mode for summary output (json | text) (default "text")
100-
--output-raw-tx-only output raw signed transaction hex without sending (works with most modes except RPC and UniswapV3)
101-
--pretty-logs output logs in pretty format instead of JSON (default true)
102-
--priority-gas-price uint gas tip price for EIP-1559 transactions
103-
--private-key string hex encoded private key to use for sending transactions (default "42b6e34dc21598a807dc19d7784c71b2a7a01f6480dc6f58258f78e539f1a1fa")
104-
--random-recipients send to random addresses instead of fixed address in transfer tests
105-
--rate-limit float requests per second limit (use negative value to remove limit) (default 4)
106-
-n, --requests int number of requests to perform for the benchmarking session (default of 1 leads to non-representative results) (default 1)
107-
-r, --rpc-url string the RPC endpoint URL (default "http://localhost:8545")
108-
--seed int a seed for generating random values and addresses (default 123456)
109-
--send-only alias for --fire-and-forget
110-
--summarize produce execution summary after load test (can take a long time for large tests)
111-
-t, --time-limit int maximum seconds to spend benchmarking (default: no limit) (default -1)
112-
--to-address string recipient address for transactions (default "0xDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEF")
113-
-v, --verbosity string log level (string or int):
114-
0 - silent
115-
100 - panic
116-
200 - fatal
117-
300 - error
118-
400 - warn
119-
500 - info (default)
120-
600 - debug
121-
700 - trace (default "info")
79+
--adaptive-backoff-factor float multiplicative decrease factor for adaptive rate limiting (default 2)
80+
--adaptive-cycle-duration-seconds uint interval in seconds to check queue size and adjust rates for adaptive rate limiting (default 10)
81+
--adaptive-rate-limit enable AIMD-style congestion control to automatically adjust request rate
82+
--adaptive-rate-limit-increment uint size of additive increases for adaptive rate limiting (default 50)
83+
--adaptive-target-size uint target queue size for adaptive rate limiting (speed up if smaller, back off if larger) (default 1000)
84+
--batch-size uint batch size for receipt fetching (default: 999) (default 999)
85+
--chain-id uint chain ID for the transactions
86+
-c, --concurrency int number of requests to perform concurrently (default: one at a time) (default 1)
87+
--config string config file (default is $HOME/.polygon-cli.yaml)
88+
--eth-amount-in-wei uint amount of ether in wei to send per transaction
89+
--eth-call-only call contracts without sending transactions (incompatible with adaptive rate limiting and summarization)
90+
--eth-call-only-latest execute on latest block instead of original block in call-only mode with recall
91+
--fire-and-forget send transactions and load without waiting for it to be mined
92+
--gas-limit uint manually specify gas limit (useful to avoid eth_estimateGas or when auto-computation fails)
93+
--gas-price uint manually specify gas price (useful when auto-detection fails)
94+
--gas-price-multiplier float a multiplier to increase or decrease the gas price (default 1)
95+
--legacy send a legacy transaction instead of an EIP1559 transaction
96+
--nonce uint use this flag to manually set the starting nonce
97+
--output-mode string format mode for summary output (json | text) (default "text")
98+
--output-raw-tx-only output raw signed transaction hex without sending (works with most modes except RPC and UniswapV3)
99+
--pretty-logs output logs in pretty format instead of JSON (default true)
100+
--priority-gas-price uint gas tip price for EIP-1559 transactions
101+
--private-key string hex encoded private key to use for sending transactions (default "42b6e34dc21598a807dc19d7784c71b2a7a01f6480dc6f58258f78e539f1a1fa")
102+
--random-recipients send to random addresses instead of fixed address in transfer tests
103+
--rate-limit float requests per second limit (use negative value to remove limit) (default 4)
104+
-n, --requests int number of requests to perform for the benchmarking session (default of 1 leads to non-representative results) (default 1)
105+
-r, --rpc-url string the RPC endpoint URL (default "http://localhost:8545")
106+
--seed int a seed for generating random values and addresses (default 123456)
107+
--send-only alias for --fire-and-forget
108+
--summarize produce execution summary after load test (can take a long time for large tests)
109+
-t, --time-limit int maximum seconds to spend benchmarking (default: no limit) (default -1)
110+
--to-address string recipient address for transactions (default "0xDEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEF")
111+
-v, --verbosity string log level (string or int):
112+
0 - silent
113+
100 - panic
114+
200 - fatal
115+
300 - error
116+
400 - warn
117+
500 - info (default)
118+
600 - debug
119+
700 - trace (default "info")
122120
```
123121
124122
## See also

0 commit comments

Comments
 (0)