Ether-cli NPM | npm.io

DOCUMENTATION

Description

ether-cli is a tool for querying blockchain data and sending transactions right from your command line

Get Started

To get started with ether-cli, follow these steps:

Install ether-cli globally using npm:

 npm install -g ether-cli

Run a command using the eth command:

eth COMMAND

Use the eth -help command to view the available commands and their usage:

 eth -help

Commands

`eth abis`

Retrieves all ABI names in storage.

USAGE
  $ eth abis

ARGUMENTS
  none

DESCRIPTION
 Retrieves all ABI names in storage.

EXAMPLES
  $ eth abis

`eth addabi <NAME> <PATH>`

Adds an ABI JSON file to storage.

USAGE
  $ eth addabi NAME PATH

ARGUMENTS
  NAME - Name of the ABI contract
  PATH - Location of the ABI file

DESCRIPTION
  Adds an ABI JSON file to storage.

EXAMPLES
  $ eth addabi erc20abi ./abis/erc20abi.json

`eth balance <ADDRESS || ENS> --network=<NETWORK>`

Gets the eth balance of an address

USAGE
  $ eth balance <ADDRESS || ENS> --network=<NETWORK>

ARGUMENTS
  ADDRESS - Wallet address
  ENS - ENS of the wallet address
  NETWORK - Network name

DESCRIPTION
  Gets the eth balance of an address

EXAMPLES
  $ eth balance michael001.eth
  $ eth balance myande.eth --network=sepolia

`eth contract <ADDRESS> --abi=<abiName> --privatekey=<PRIVATEKEY> --network=<NETWORK>`

Generates a contract instance and opens an environment to interact with the contract.

USAGE
  $ eth contract <ADDRESS> --abi=<abiName> --privatekey=<PRIVATEKEY> --network=<NETWORK>

ARGUMENTS
  ADDRESS - Contract address
  PRIVATEKEY - Private key of the wallet to sign transactions
  NETWORK - Network name

DESCRIPTION
  Generates a contract instance and opens an environment to interact with the contract.

EXAMPLES
  $ eth contract 0x0000000000000000000000000000000000001111 --abi=erc20abi --privatekey=0x00000000000000000000000000000000000000000000001111 --network=sepolia
  > await contract.name()
  > await contract.totalSupply()

`eth ens <ADDRESS>`

Gets the ens name of a wallet address.

USAGE
  $ eth ens <ADDRESS>

ARGUMENTS
  ADDRESS - wallet address
  
DESCRIPTION
  Gets the ens name of a wallet address.

EXAMPLES
  $ eth ens 0x0000000000000000000000000000000000001111

`eth events <ADDRESS>`

Gets the log of past events of a contract address.

USAGE
  $ eth events <ADDRESS>

ARGUMENTS
  ADDRESS - contract address
  
DESCRIPTION
  Gets the log of past events of a contract address.

EXAMPLES
  $ eth events 0x0000000000000000000000000000000000001111
  $ eth events 0xsafe.eth

`eth generate`

Generates a random wallet address with its privatekey and mnemonic phrase.

USAGE
  $ eth generate
  $ eth generate --export

ARGUMENTS
  none
  
DESCRIPTION
  Generates a random wallet address with its privatekey and mnemonic phrase.

EXAMPLES
  $ eth generate --export

`eth getabi <NAME>`

Gets an ABI from storage.

USAGE
  $ eth getabi NAME

ARGUMENTS
  NAME - name of the abi in storage
  
DESCRIPTION
  Gets an ABI from storage.

EXAMPLES
  $ eth getabi erc20abi

`eth removeabi <NAME>`

Removes an ABI from storage.

USAGE
  $ eth removeabi NAME 

ARGUMENTS
  NAME - abi name
  
DESCRIPTION
  Removes an ABI from storage.

EXAMPLES
  $ eth removeabi erc20abi

`eth resolvename <NAME>`

Resolves an ENS name and gives the address.

USAGE
  $ eth resolvename NAME

ARGUMENTS
  NAME - ens name
  
DESCRIPTION
  Resolves an ENS name and gives the address.

EXAMPLES
  $ eth resolvename michael001.eth

`eth transaction <HASH> --network=<NETWORK>`

Gets the transaction log of a transaction hash.

USAGE
  $ eth transaction HASH --network=<NETWORK>
  $ eth transaction HASH 

ARGUMENTS
  HASH - transaction hash
  NETWORK - network name
  
DESCRIPTION
  Gets the transaction log of a transaction hash.

EXAMPLES
  $ eth transaction 0xc4fd8a76acef6abf75f3272fc3a08a480504d3770797b0c9458abc1f1717d46a
  $ eth transaction 0xc4fd8a76acef6abf75f3272fc3a08a480504d3770797b0c9458abc1f1717d46a --network=optimism

`eth transactions <ADDRESS> --network=<NETWORK>`

Gets all transaction logs of a wallet address.

USAGE
  $ eth transaction ADDRESS --network=<NETWORK>
  $ eth transaction ADDRESS 

ARGUMENTS
  ADDRESS - wallet address
  NETWORK - network name
  
DESCRIPTION
  Gets all transaction logs of a wallet address.

EXAMPLES
  $ eth transaction michael001.eth
  $ eth transaction myande.eth --network=polygon

`eth transfer <ADDRESS> <AMOUNT> --privatekey=<PRIVATEKEY> --network=<NETWORK>`

Transfers an amount of eth to a wallet address.

USAGE
  $ eth transfer <ADDRESS> <AMOUNT> --privatekey=<PRIVATEKEY> --network=<NETWORK>
  $ eth transfer <ADDRESS> <AMOUNT> --privatekey=<PRIVATEKEY>

ARGUMENTS
  ADDRESS - receiver wallet address
  AMOUNT - Amount of eth to send
  PRIVATEKEY - private key of sender wallet address
  NETWORK - network name
  
DESCRIPTION
  Transfers an amount of eth to a wallet address.

EXAMPLES
  $ eth transfer michael001.eth 1 --privatekey=0xc4fd8a76acef6abf75f3272fc3a08a480504d3770797b0c9458abc0000000000
  $ eth transfer myande.eth 1 --privatekey=0xc4fd8a76acef6abf75f3272fc3a08a480504d3770797b0c9458abc0000000000 --network=sepolia

`eth updateabi <NAME> <PATH>`

Update an ABI already in storage.

USAGE
  $ eth updateabi NAME PATH

ARGUMENTS
  NAME - name of the abi contract
  PATH - location of the abi file

DESCRIPTION
  Update an ABI already in storage.

EXAMPLES
  $ eth update erc20abi ./abis/erc20abi.json

`eth watchtransactions <ADDRESS>`

Watch all pending transactions on eth mainnet or transactions specific to an address.

USAGE
  $ eth watchtransactions <ADDRESS>
  $ eth watchtransactions 

ARGUMENTS
  ADDRESS - wallet address 

DESCRIPTION
  Watch all pending transactions on eth mainnet or transactions specific to an address.

EXAMPLES
  $ eth watchtransactions