https://github.com/0xpolygon/polygon-cli
A Swiss Army knife of blockchain tools
https://github.com/0xpolygon/polygon-cli
Last synced: 4 months ago
JSON representation
A Swiss Army knife of blockchain tools
- Host: GitHub
- URL: https://github.com/0xpolygon/polygon-cli
- Owner: 0xPolygon
- License: agpl-3.0
- Created: 2022-07-08T14:42:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T13:41:33.000Z (about 1 year ago)
- Last Synced: 2025-03-28T05:11:34.641Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 5.34 MB
- Stars: 74
- Watchers: 10
- Forks: 44
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Polycli
We run a lot of different blockchain technologies. Different tools often have inconsistent tooling and this makes automation and operations painful. The goal of this codebase is to standardize some of our commonly needed tools and provide interfaces and formats.
## Summary
- [Install](#install)
- [Features](#features)
- [Testing](#testing)
- [References](#references)
## Install
Requirements:
- [Go](https://go.dev/)
- make
- jq
- bc
- protoc (Only required for `make generate`)
To install, clone this repo and run:
```bash
make install
```
By default, the commands will be in `$HOME/go/bin/`, so for ease, we recommend adding that path to your shell's startup file by adding the following line:
```bash
export PATH="$HOME/go/bin:$PATH"
```
## Features
Note: Do not modify this section! It is auto-generated by `cobra` using `make gen-doc`.
- [polycli abi](doc/polycli_abi.md) - Provides encoding and decoding functionalities with contract signatures and ABI.
- [polycli cdk](doc/polycli_cdk.md) - Utilities for interacting with CDK networks.
- [polycli contract](doc/polycli_contract.md) - Interact with smart contracts and fetch contract information from the blockchain.
- [polycli dbbench](doc/polycli_dbbench.md) - Perform a level/pebble db benchmark.
- [polycli dockerlogger](doc/polycli_dockerlogger.md) - Monitor and filter Docker container logs.
- [polycli dumpblocks](doc/polycli_dumpblocks.md) - Export a range of blocks from a JSON-RPC endpoint.
- [polycli ecrecover](doc/polycli_ecrecover.md) - Recovers and returns the public key of the signature.
- [polycli enr](doc/polycli_enr.md) - Convert between ENR and Enode format.
- [polycli fix-nonce-gap](doc/polycli_fix-nonce-gap.md) - Send txs to fix the nonce gap for a specific account.
- [polycli fold-trace](doc/polycli_fold-trace.md) - Trace an execution trace and fold it for visualization.
- [polycli fork](doc/polycli_fork.md) - Take a forked block and walk up the chain to do analysis.
- [polycli fund](doc/polycli_fund.md) - Bulk fund crypto wallets automatically.
- [polycli hash](doc/polycli_hash.md) - Provide common crypto hashing functions.
- [polycli loadtest](doc/polycli_loadtest.md) - Run a generic load test against an Eth/EVM style JSON-RPC endpoint.
- [polycli metrics-to-dash](doc/polycli_metrics-to-dash.md) - Create a dashboard from an Openmetrics / Prometheus response.
- [polycli mnemonic](doc/polycli_mnemonic.md) - Generate a BIP39 mnemonic seed.
- [polycli monitor](doc/polycli_monitor.md) - Monitor blocks using a JSON-RPC endpoint.
- [polycli monitorv2](doc/polycli_monitorv2.md) - Monitor v2 command stub.
- [polycli nodekey](doc/polycli_nodekey.md) - Generate node keys for different blockchain clients and protocols.
- [polycli p2p](doc/polycli_p2p.md) - Set of commands related to devp2p.
- [polycli parse-batch-l2-data](doc/polycli_parse-batch-l2-data.md) - Convert batch l2 data into an ndjson stream.
- [polycli parseethwallet](doc/polycli_parseethwallet.md) - Extract the private key from an eth wallet.
- [polycli plot](doc/polycli_plot.md) - Plot a chart of transaction gas prices and limits.
- [polycli publish](doc/polycli_publish.md) - Publish transactions to the network with high-throughput.
- [polycli report](doc/polycli_report.md) - Generate a report analyzing a range of blocks from an Ethereum-compatible blockchain.
- [polycli retest](doc/polycli_retest.md) - Convert the standard ETH test fillers into something to be replayed against an RPC.
- [polycli rpcfuzz](doc/polycli_rpcfuzz.md) - Continually run a variety of RPC calls and fuzzers.
- [polycli signer](doc/polycli_signer.md) - Utilities for security signing transactions.
- [polycli ulxly](doc/polycli_ulxly.md) - Utilities for interacting with the uLxLy bridge.
- [polycli version](doc/polycli_version.md) - Get the current version of this application.
- [polycli wallet](doc/polycli_wallet.md) - Create or inspect BIP39(ish) wallets.
- [polycli wrap-contract](doc/polycli_wrap-contract.md) - Wrap deployed bytecode into create bytecode.
## Testing
To test the features of `polycli`, we'll run geth in `dev` mode but you can run any node you want.
```bash
make geth
```
You can then fund the default load testing account and run some tests.
```bash
make geth-loadtest
```
You can view the state of the chain using `polycli`.
```bash
polycli monitor --rpc-url http://127.0.0.1:8545
```
Note that if you want to debug the monitor, you can use the following command.
```bash
polycli monitor --rpc-url http://34.117.145.249:80 -v 700 &> log.txt
```
You can also interact manually with your node, you can attach a Javascript console to your node using IPC.
First, wait for the IPC endpoint to open.
```bash
INFO [07-10|10:44:29.250] Starting peer-to-peer node instance=Geth/v1.12.0-stable/darwin-amd64/go1.20.4
WARN [07-10|10:44:29.250] P2P server will be useless, neither dialing nor listening
INFO [07-10|10:44:29.255] Stored checkpoint snapshot to disk number=0 hash=039839..dcb5c1
DEBUG[07-10|10:44:29.255] IPCs registered namespaces=admin,debug,web3,eth,txpool,clique,miner,net,engine
INFO [07-10|10:44:29.256] IPC endpoint opened url=/var/folders/7m/3_x4ns7557x52hb6vncqkx8h0000gn/T/geth.ipc
INFO [07-10|10:44:29.256] Generated ephemeral JWT secret secret=0x7511b4e6312a1a63348d8fc8c6a586ed4ea69ed31c27b3c0cc5e41cb6d2d5822
```
Then, attach a console to your node.
```bash
geth attach /var/folders/7m/3_x4ns7557x52hb6vncqkx8h0000gn/T/geth.ipc
```
From there, you can do anything such as funding the default load testing account with some currency.
```bash
> eth.coinbase==eth.accounts[0]
true
> eth.sendTransaction({from: eth.coinbase, to: "0x85da99c8a7c2c95964c8efd687e95e632fc533d6", value: web3.toWei(5000, "ether")})
"0xd8223589989d198741e0543ab01d9d3ce2b81e38927cb213a56589e111dfd388"
```
You can then generate some load to make sure that blocks with transactions are being created. Note that the chain id of local geth is `1337`.
```bash
polycli loadtest --verbosity 700 --chain-id 1337 --concurrency 1 --requests 1000 --rate-limit 5 --mode c --rpc-url http://127.0.0.1:8545
```
## Contact
For more discussions, please head to the [R&D Discord](https://discord.gg/0xPolygonRnD)
## References
Sending some value to the default load testing account.
Listening for re-orgs.
```bash
socat - UNIX-CONNECT:/var/folders/zs/k8swqskj1t79cgnjh6yt0fqm0000gn/T/geth.ipc
{"id": 1, "method": "eth_subscribe", "params": ["newHeads"]}
```
Useful RPCs when testing.
```bash
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "net_version", "params": []}' https://polygon-rpc.com
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "eth_blockNumber", "params": []}' https://polygon-rpc.com
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "eth_getBlockByNumber", "params": ["0x1DE8531", true]}' https://polygon-rpc.com
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "clique_getSigner", "params": ["0x1DE8531", true]}' https://polygon-rpc.com
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "eth_getBalance", "params": ["0x85da99c8a7c2c95964c8efd687e95e632fc533d6", "latest"]}' https://polygon-rpc.com
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "eth_getCode", "params": ["0x79954f948079ee9ef1d15eff3e07ceaef7cdf3b4", "latest"]}' https://polygon-rpc.com
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "txpool_inspect", "params": []}' http://localhost:8545
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "txpool_status", "params": []}' http://localhost:8545
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "eth_gasPrice", "params": []}' http://localhost:8545
curl -v -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0", "id": 1, "method": "admin_peers", "params": []}' http://localhost:8545
```
```bash
websocat ws://34.208.176.205:9944
{"jsonrpc":"2.0", "id": 1, "method": "chain_subscribeNewHead", "params": []}
```
If you add a new loadtest mode, don't forget to update the loadtest mode string by running `make gen-load-test-modes`.