1.3.0 • Published 12 months ago

yeet-cli v1.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Description

A CLI for querying blockchain data, interacting with smart contracts, transfer funds, generating accounts and more

Video Demo

Table of contents

Usage

$ yarn global add yeet-cli
$ yeet COMMAND
running command...
$ yeet (--version)
yeet-cli/1.3.0 darwin-x64 node-v16.20.0
$ yeet --help [COMMAND]
USAGE
  $ yeet COMMAND
...

Commands

yeet abi NAME

gets abi from storage

USAGE
  $ yeet abi NAME

ARGUMENTS
  NAME  abi name in storage

DESCRIPTION
  gets abi from storage

EXAMPLES
  $ yeet abi erc20ABI

See code: dist/commands/abi/index.ts

yeet abi-add NAME ABIPATH

stores contract abi

USAGE
  $ yeet abi-add NAME ABIPATH

ARGUMENTS
  NAME     abi name in storage
  ABIPATH  path to abi

DESCRIPTION
  stores contract abi

ALIASES
  $ yeet abi-add

EXAMPLES
  $ yeet abi-add erc20ABI ./erc20ABI.json

yeet abi-events NAME

lists all events of abi

USAGE
  $ yeet abi-events NAME

ARGUMENTS
  NAME  abi name in storage

DESCRIPTION
  lists all events of abi

ALIASES
  $ yeet abi-events

EXAMPLES
  $ yeet abi-events erc20ABI

yeet abi-list

lists all stored abi names

USAGE
  $ yeet abi-list

DESCRIPTION
  lists all stored abi names

ALIASES
  $ yeet abi-list

EXAMPLES
  $ yeet abi-list

yeet abi-methods NAME

lists all methods of abi

USAGE
  $ yeet abi-methods NAME

ARGUMENTS
  NAME  abi name in storage

DESCRIPTION
  lists all methods of abi

ALIASES
  $ yeet abi-methods

EXAMPLES
  $ yeet abi-methods erc20ABI

yeet abi-remove NAME

removes contract abi

USAGE
  $ yeet abi-remove NAME

ARGUMENTS
  NAME  abi name in storage

DESCRIPTION
  removes contract abi

ALIASES
  $ yeet abi-remove

EXAMPLES
  $ yeet abi-remove erc20ABI

yeet abi-total

gets total contract abis stored

USAGE
  $ yeet abi-total

DESCRIPTION
  gets total contract abis stored

ALIASES
  $ yeet abi-total

EXAMPLES
  $ yeet abi-total

yeet abi-update NAME ABIPATH

updates contract abi

USAGE
  $ yeet abi-update NAME ABIPATH

ARGUMENTS
  NAME     abi name to update
  ABIPATH  path to abi

DESCRIPTION
  updates contract abi

ALIASES
  $ yeet abi-update

EXAMPLES
  $ yeet abi-update erc20ABI ./erc20ABI.json

yeet account-balance ADDRESS|ENS

gets address balance of address or ens. default network: localhost

USAGE
  $ yeet account-balance ADDRESSORENS [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum |
    --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai] [--wei | --kwei | --mwei | --gwei |
    --szabo | --finney | --ether]

ARGUMENTS
  ADDRESSORENS  account address or ens name

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --ether            eth denomination
  --finney           eth denomination
  --goerli           provider network
  --gwei             eth denomination
  --kwei             eth denomination
  --mainnet          provider network
  --mwei             eth denomination
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network
  --szabo            eth denomination
  --wei              eth denomination

DESCRIPTION
  gets address balance of address or ens. default network: localhost

ALIASES
  $ yeet account-balance

EXAMPLES
  $ yeet account-balance 0xF51CD0d607c82db2B70B678554c52C266a9D49B6 --mainnet

  $ yeet account-balance valentineorga.eth --rpc_url=[PROVIDER_URL]

  $ yeet account-balance 0xF51CD0d607c82db2B70B678554c52C266a9D49B6 --mainnet --wei

yeet address-ens ACCOUNT

gets ens of address

USAGE
  $ yeet address-ens ACCOUNT [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum |
    --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai]

ARGUMENTS
  ACCOUNT  account address

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

DESCRIPTION
  gets ens of address

ALIASES
  $ yeet address-ens

EXAMPLES
  $ yeet address-ens 0xF51CD0d607c82db2B70B678554c52C266a9D49B6 --mainnet

  $ yeet address-ens 0xF51CD0d607c82db2B70B678554c52C266a9D49B6 --rpc_url=[PROVIDER_URL]

yeet ens-address ENS

gets address of ens

USAGE
  $ yeet ens-address ENS [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum | --arbitrumGoerli
    | --optimism | --optimismGoerli | --polygon | --polygonMumbai]

ARGUMENTS
  ENS  ENS name

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

DESCRIPTION
  gets address of ens

ALIASES
  $ yeet ens-address

EXAMPLES
  $ yeet ens-address valentineorga.eth --mainnet

  $ yeet ens-address valentineorga.eth --rpc_url=[PROVIDER_URL]

yeet block [BLOCK_NUMBER]

gets block object from block number or hash. default network: Localhost

USAGE
  $ yeet block [BLOCK_NUMBER] [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum |
    --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai] [--json]

ARGUMENTS
  BLOCK_NUMBER  block number

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  gets block object from block number or hash. default network: Localhost

EXAMPLES
  $ yeet block 20 --mainnet

  $ yeet block 0x720c47720a39b4b2f04ca82420b8272910a7c397710fcb8ed8337f5a007e39ec --rpc_url=[PROVIDER_URL]

See code: dist/commands/block/index.ts

yeet block-number

gets latest block number. default network: localhost

USAGE
  $ yeet block-number [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum | --arbitrumGoerli |
    --optimism | --optimismGoerli | --polygon | --polygonMumbai]

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

DESCRIPTION
  gets latest block number. default network: localhost

ALIASES
  $ yeet block-number

EXAMPLES
  $ yeet block-number --mainnet
  $ yeet block-number --rpc_url=[PROVIDER_URL]

yeet contract ADDRESS ABI

exposes a contract instance in a REPL environment for making contract calls

USAGE
  $ yeet contract ADDRESS ABI [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum |
    --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai] [--private_key <value>]

ARGUMENTS
  ADDRESS  contract address
  ABI      abi name saved using `yeet abi-add`

FLAGS
  --arbitrum             provider network
  --arbitrumGoerli       provider network
  --goerli               provider network
  --mainnet              provider network
  --optimism             provider network
  --optimismGoerli       provider network
  --polygon              provider network
  --polygonMumbai        provider network
  --private_key=<value>  private key of transaction signer
  --rpc_url=<value>      provider network rpc url
  --sepolia              provider network

DESCRIPTION
  exposes a `contract` instance in a REPL environment for making contract calls

EXAMPLES
  $ yeet contract 0xF51CD0d607c82db2B7EB670554C82C276A9549B4 erc20ABI --mainnet

  > await contract.name()

  > await contract.getterFunction()

  $ yeet contract 0xF51CD0d607c82db2B7EB670554C82C276A9549B4 erc20ABI --private_key=0xdf57089febbacf7ba0bc227dafbffa9fc08a93fdc68e1e42411a14efcf23656e --mainnet

  > await contract.mint()

  > await contract.setterFunction({value: '10000000000000'})

yeet convert UNIT

convert from eth to wei or vice versa

USAGE
  $ yeet convert UNIT [--wei]

ARGUMENTS
  UNIT  number to convert

FLAGS
  --wei  eth denomination

DESCRIPTION
  convert from eth to wei or vice versa

EXAMPLES
  $ yeet convert 1000000000000000000

  $ yeet convert 1 --wei

yeet events ACCOUNT

get past event logs of given address

USAGE
  $ yeet events ACCOUNT [-f <value>] [-t <value>] [-p <value>] [-o <value>] [-e] [--mainnet | --goerli |
    --sepolia]

ARGUMENTS
  ACCOUNT  account address

FLAGS
  -e, --export          exports events to 'events.json' file in current directory
  -f, --from=<value>    [default: 0] start block
  -o, --offset=<value>  [default: 1000] number of logs per page. Limit: 1000
  -p, --page=<value>    [default: 1] page number
  -t, --to=<value>      end block
  --goerli              etherscan supported network
  --mainnet             etherscan supported network
  --sepolia             etherscan supported network

DESCRIPTION
  get past event logs of given address

EXAMPLES
  $ yeet events yourens.eth --mainnet

  $ yeet events 0xF51CD0d607c82db2B7EB670554C82C276A9549B4 --sepolia --export,-e

  $ yeet events 0xF51CD0d607c82db2B7EB670554C82C276A9549B4 --goerli --from,-f=[block-number] --to,-t=[block-number] --page,-p=[page] --offset,-o=[offset]

yeet events-watch ADDRESS ABI EVENT

emits new events from contract

USAGE
  $ yeet events-watch ADDRESS ABI EVENT [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum |
    --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai]

ARGUMENTS
  ADDRESS  contract address
  ABI      abi name saved using `yeet abi-add`
  EVENT    event to watch

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

DESCRIPTION
  emits new events from contract

ALIASES
  $ yeet events-watch

EXAMPLES
  $ yeet events-watch 0xF51CD0d607c82db2B7EB670554C82C276A9549B4 erc20ABI Transfer --mainnet

See code: dist/commands/events/index.ts

yeet generateAccount

generates a new random account

USAGE
  $ yeet generateAccount [--no-export]

FLAGS
  --no-export  disables export for mnemonic and private key to 'new-wallet.json' file in current directory

DESCRIPTION
  generates a new random account

EXAMPLES
  $ yeet generateAccount

  $ yeet generateAccount --no-export

See code: dist/commands/generateAccount.ts

yeet help [COMMANDS]

Display help for yeet.

USAGE
  $ yeet help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for yeet.

See code: @oclif/plugin-help

yeet plugins

List installed plugins.

USAGE
  $ yeet plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ yeet plugins

See code: @oclif/plugin-plugins

yeet plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ yeet plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ yeet plugins add

EXAMPLES
  $ yeet plugins:install myplugin

  $ yeet plugins:install https://github.com/someuser/someplugin

  $ yeet plugins:install someuser/someplugin

yeet plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ yeet plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ yeet plugins:inspect myplugin

yeet plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ yeet plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ yeet plugins add

EXAMPLES
  $ yeet plugins:install myplugin

  $ yeet plugins:install https://github.com/someuser/someplugin

  $ yeet plugins:install someuser/someplugin

yeet plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ yeet plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ yeet plugins:link myplugin

yeet plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ yeet plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ yeet plugins unlink
  $ yeet plugins remove

yeet plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ yeet plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ yeet plugins unlink
  $ yeet plugins remove

yeet plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ yeet plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ yeet plugins unlink
  $ yeet plugins remove

yeet plugins update

Update installed plugins.

USAGE
  $ yeet plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

yeet transfer TO AMOUNT PRIVATE_KEY

transfer funds

USAGE
  $ yeet transfer TO AMOUNT PRIVATE_KEY [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum
    | --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai]

ARGUMENTS
  TO           address of receiver
  AMOUNT       amount in eth
  PRIVATE_KEY  private key of transaction signer

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

DESCRIPTION
  transfer funds

EXAMPLES
  $ yeet transfer valentineorga.eth 0.5 0x182466b65247ebac8c2a0483aaede25af0d5a328a718674c6b6830f8b21d6f6e --mainnet

See code: dist/commands/transfer.ts

yeet tx TXHASH

gets transaction object from transaction hash

USAGE
  $ yeet tx TXHASH [--mainnet | --rpc_url <value> |  | --sepolia | --goerli | --arbitrum |
    --arbitrumGoerli | --optimism | --optimismGoerli | --polygon | --polygonMumbai]

ARGUMENTS
  TXHASH  transaction hash

FLAGS
  --arbitrum         provider network
  --arbitrumGoerli   provider network
  --goerli           provider network
  --mainnet          provider network
  --optimism         provider network
  --optimismGoerli   provider network
  --polygon          provider network
  --polygonMumbai    provider network
  --rpc_url=<value>  provider network rpc url
  --sepolia          provider network

DESCRIPTION
  gets transaction object from transaction hash

ALIASES
  $ yeet tx

EXAMPLES
  $ yeet tx 0x1936d8ee3676e640a44b1289cd8245e40288922510fb88266857a3140420f689 --mainnet

  $ yeet tx 0x1936d8ee3676e640a44b1289cd8245e40288922510fb88266857a3140420f689 --rpc_url=[PROVIDER_URL]

yeet txs ACCOUNT

lists all past transactions of account

USAGE
  $ yeet txs ACCOUNT [--mainnet | --goerli | --sepolia] [-e]

ARGUMENTS
  ACCOUNT  account address

FLAGS
  -e, --export  exports transactions to 'transactions.json' file in current directory
  --goerli      etherscan supported network
  --mainnet     etherscan supported network
  --sepolia     etherscan supported network

DESCRIPTION
  lists all past transactions of account

ALIASES
  $ yeet txs

EXAMPLES
  $ yeet txs yourens.eth --mainnet

  $ yeet txs 0xF51CD0d607c82db2B7EB670554C82C276A9549B4 --rpc_url=[PROVIDER_URL]

  $ yeet txs myens.eth --sepolia --export,-e
oclif
@oclif/core@oclif/plugin-help@oclif/plugin-pluginsaxioschalkconfethersuuid
@everything-registry/sub-chunk-3201
1.3.0

12 months ago

1.2.1

12 months ago

1.2.0

12 months ago

1.1.0

12 months ago

1.0.0

12 months ago

0.0.0

12 months ago