web3cli 0.4.0

Interact with blockchains and smart contracts using the command line

Interact with blockchains and smart contracts using the command line.

Built on web3client, the Swiss-army knife of the blockchain.

Install

pip3 install -U web3cli

Examples

• Get the ETH balance of the Ethereum foundation:

  web3 balance 0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae
  

• Get the BNB balance of the Binance hot wallet on BNB chain:

  web3 -n binance balance 0x8894e0a0c962cb723c1976a4421c95949be2d4e3
  

• List all supported networks (blockchains):

  web3 network list
  

Address book

web3 can store tags just like you would do on etherscan.io or bscscan.com:

web3 address add "Ethereum foundation" 0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae
web3 address add "Binance hot wallet" 0x8894e0a0c962cb723c1976a4421c95949be2d4e3

You can use these tags instead of the actual addresses:

web3 balance "Ethereum foundation"
web3 -n binance balance "Binance hot wallet"

To see the list of saved addresses, run:

web3 address list

which will produce the following output:

| LABEL               | ADDRESS                                    |
|---------------------+--------------------------------------------|
| Binance hot wallet  | 0x8894e0a0c962cb723c1976a4421c95949be2d4e3 |
| Ethereum foundation | 0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae |

To see all the actions that can be done with addresses, run web3 address.

Signers

You can use web3 to send transactions to the blockchain or to sign messages. To do so, you first need to define a signer:

web3 add my_signer

You will be prompted to insert a private key, which will be encrypted and stored in the database. Feel free to do so with this test private key: d94e4166f0b3c85ffebed3e0eaa7f7680ae296cf8a7229d637472b7452c8602c.

You can add multiple signers and switch between them using the web3 --signer my_signer flag, or choose a default signer with the command web3 config set default_signer my_signer.

Once you have added a signer, you can use any of the commands that need a private key, as shown in the following examples.

Sign a message

web3 sign "Hello world!"

Output:

{'messageHash': HexBytes('0x8144a6fa26be252b86456491fbcd43c1de7e022241845ffea1c3df066f7cfede'),
 'r': 29064792366355323740950985371105895961858398238980883773193501881276705228481,
 's': 35017827091540952858431223849020104301448914783999277111090808754042212439431,
 'signature': HexBytes('0x404216ea232b5289610a7483de746fed3c94b6e6c2b8bf62ce5286850ff346c14d6b63445107a9d9e342720e88e82a3ff794dd6bd255931b552dedf2e243d5871c'),
 'v': 28}

Send ETH, BNB, AVAX, etc

This is to be implemented yet, but the idea is to send funds with the following command:

web3 send <address> 0.001 ETH

where address is either an address from the address book, or a 0x.. hex string.

Settings

Settings are read from the configuration file ~/.web3cli/config/web3cli.yaml, or from environment variables. (The symbol ~ refers to the home folder of your user.) See the example configuration file for a list of available settings.

Environment variables

All settings can be overridden via environment variables. For example, the settings web3cli.default_network can be overridden by setting the env variable WEB3CLI_DEFAULT_NETWORK:

WEB3CLI_DEFAULT_NETWORK=avalanche web3 network get

output> avalanche

Folder-specific settings

To have settings that apply only to the current folder, create a web3cli.yaml file in that folder and execute web3 from that folder. Settings specified in web3cli.yaml will override those in your home folder. Environment variables will still get the precedence.

Edit configuration via the CLI

You can edit the configuration files using web3 config. For example:

• Show the value of a single setting:

  pdm web3 config get default_network
  

• Show all settings:

  pdm web3 config get
  

• Edit a setting value at the local leval (web3cli.yml):

  pdm web3 config set default_network avalanche
  

• Edit a setting value at the global level (~/.web3cli/database/web3cli.sqlite):

  pdm web3 config set default_network avalanche --global
  

Contribute ❤️

Pull requests are welcome!

1. Install and configure PDM:

   curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
   

2. Install dependencies:

   pdm install
   

3. To run the CLI against your changes:

   pdm web3 ...
   

4. To run tests:

   pdm test
   

TODO

• Command: Send ETH
• Signer: Make app_key non-overridable (https://docs.builtoncement.com/core-foundation/configuration-settings#configuration-settings-vs.-meta-options)
• Windows: test on a Windows machine
• Do not mess with DB unless needed by the command
• Do not mess with signers unless needed by the command
• Autocomplete commands
• Autocomplete addresses and signers
• Config: non-string support in config set
• Allow to add custom networks (they should be a db model too)
• Use chains and tokens from other sources (e.g. ethereum-lists)