tokensPkg

README

chifra tokens

Given the address of an ERC20 token contract, the chifra tokens tool reports token balances for one or more additional addresses. Alternatively, the tool can report the token balances for multiple ERC20 tokens for a single addresses.

In normal operation the first item in the address_list is assumed to be an ERC20 token contract whose balances are being queried, whereas the remainder of the list is assumed to be addresses on which to report.

In --byAcct mode, all addresses in the address_list are assumed to be ERC20 token contracts, except the final one which is the account whose token balances are reported.

You may optionally specify one or more blocks at which to report. If no block is specified, the latest block is assumed. You may also optionally specify which parts of the token data to extract.

Purpose:
  Retrieve token balance(s) for one or more addresses at given block(s).

Usage:
  chifra tokens [flags] <address> <address> [address...] [block...]

Arguments:
  addrs - two or more addresses (0x...), the first is an ERC20 token, balances for the rest are reported (required)
  blocks - an optional list of one or more blocks at which to report balances, defaults to 'latest'

Flags:
  -p, --parts strings   which parts of the token information to retrieve
                        One or more of [ name | symbol | decimals | totalSupply | version | some | all ]
  -b, --by_acct         consider each address an ERC20 token except the last, whose balance is reported for each token
  -c, --changes         only report a balance when it changes from one block to the next
  -z, --no_zero         suppress the display of zero balance accounts
  -o, --cache           force the results of the query into the cache
  -D, --decache         removes related items from the cache
  -x, --fmt string      export format, one of [none|json*|txt|csv]
  -v, --verbose         enable verbose output
  -h, --help            display this help screen

Notes:
  - An address must be either an ENS name or start with '0x' and be forty-two characters long.
  - Blocks is a space-separated list of values, a start-end range, a special, or any combination.
  - If the token contract(s) from which you request balances are not ERC20 compliant, the results are undefined.
  - If the queried node does not store historical state, the results are undefined.
  - Special blocks are detailed under chifra when --list.
  - If the --parts option is not empty, all addresses are considered tokens and each token's attributes are presented.

Data models produced by this tool:

• token

Other Options

All tools accept the following additional flags, although in some cases, they have no meaning.

  -v, --version         display the current version of the tool
      --output string   write the results to file 'fn' and return the filename
      --append          for --output command only append to instead of replace contents of file
      --file string     specify multiple sets of command line options in a file

Note: For the --file string option, you may place a series of valid command lines in a file using any valid flags. In some cases, this may significantly improve performance. A semi-colon at the start of any line makes it a comment.

Note: If you use --output --append option and at the same time the --file option, you may not switch export formats in the command file. For example, a command file with two different commands, one with --fmt csv and the other with --fmt json will produce both invalid CSV and invalid JSON.

Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.

Documentation

Overview

tokensPkg implements the chifra tokens command.

Given the address of an ERC20 token contract, the chifra tokens tool reports token balances for one or more additional addresses. Alternatively, the tool can report the token balances for multiple ERC20 tokens for a single addresses.

In normal operation the **first item** in the address_list is assumed to be an ERC20 token contract whose balances are being queried, whereas the remainder of the list is assumed to be addresses on which to report.

In --byAcct mode, **all addresses** in the address_list are assumed to be ERC20 token contracts, except the final one which is the account whose token balances are reported.

You may optionally specify one or more blocks at which to report. If no block is specified, the latest block is assumed. You may also optionally specify which parts of the token data to extract.

Index

• func ResetOptions(testMode bool)
• func RunTokens(cmd *cobra.Command, args []string) error
• func ServeTokens(w http.ResponseWriter, r *http.Request) error
• type TokensOptions
  • func GetOptions() *TokensOptions
  • func GetTokensOptions(args []string, g *globals.GlobalOptions) *TokensOptions
  • func TokensFinishParseInternal(w io.Writer, values url.Values) *TokensOptions
  • func (opts *TokensOptions) HandleDecache(rCtx *output.RenderCtx) error
  • func (opts *TokensOptions) HandleParts(rCtx *output.RenderCtx) error
  • func (opts *TokensOptions) HandleShow(rCtx *output.RenderCtx) error
  • func (opts *TokensOptions) String() string
  • func (opts *TokensOptions) TokensInternal(rCtx *output.RenderCtx) error

Functions

func ResetOptions

func ResetOptions(testMode bool)

func RunTokens

func RunTokens(cmd *cobra.Command, args []string) error

RunTokens handles the tokens command for the command line. Returns error only as per cobra.

func ServeTokens

func ServeTokens(w http.ResponseWriter, r *http.Request) error

ServeTokens handles the tokens command for the API. Returns an error.

Types

type TokensOptions

type TokensOptions struct {
	Addrs    []string                 `json:"addrs,omitempty"`    // Two or more addresses (0x...), the first is an ERC20 token, balances for the rest are reported
	Blocks   []string                 `json:"blocks,omitempty"`   // An optional list of one or more blocks at which to report balances, defaults to 'latest'
	BlockIds []identifiers.Identifier `json:"blockIds,omitempty"` // Block identifiers
	Parts    []string                 `json:"parts,omitempty"`    // Which parts of the token information to retrieve
	ByAcct   bool                     `json:"byAcct,omitempty"`   // Consider each address an ERC20 token except the last, whose balance is reported for each token
	Changes  bool                     `json:"changes,omitempty"`  // Only report a balance when it changes from one block to the next
	NoZero   bool                     `json:"noZero,omitempty"`   // Suppress the display of zero balance accounts
	Globals  globals.GlobalOptions    `json:"globals,omitempty"`  // The global options
	Conn     *rpc.Connection          `json:"conn,omitempty"`     // The connection to the RPC server
	BadFlag  error                    `json:"badFlag,omitempty"`  // An error flag if needed

}

TokensOptions provides all command options for the chifra tokens command.

func GetOptions

func GetOptions() *TokensOptions

func GetTokensOptions

func GetTokensOptions(args []string, g *globals.GlobalOptions) *TokensOptions

GetTokensOptions returns the options for this tool so other tools may use it.

func TokensFinishParseInternal

func TokensFinishParseInternal(w io.Writer, values url.Values) *TokensOptions

func (*TokensOptions) HandleDecache

func (opts *TokensOptions) HandleDecache(rCtx *output.RenderCtx) error

func (*TokensOptions) HandleParts

func (opts *TokensOptions) HandleParts(rCtx *output.RenderCtx) error

func (*TokensOptions) HandleShow

func (opts *TokensOptions) HandleShow(rCtx *output.RenderCtx) error

func (*TokensOptions) String

func (opts *TokensOptions) String() string

String implements the Stringer interface

func (*TokensOptions) TokensInternal

func (opts *TokensOptions) TokensInternal(rCtx *output.RenderCtx) error

TokensInternal handles the internal workings of the tokens command. Returns an error.