github.com/TrueBlocks/trueblocks-core/src/apps/chifra@v0.0.0-20241022031540-b362680128f7/internal/tokens/doc.go (about)

     1  // Copyright 2016, 2024 The TrueBlocks Authors. All rights reserved.
     2  // Use of this source code is governed by a license that can
     3  // be found in the LICENSE file.
     4  /*
     5   * Parts of this file were auto generated. Edit only those parts of
     6   * the code inside of 'EXISTING_CODE' tags.
     7   */
     8  
     9  // tokensPkg implements the chifra tokens command.
    10  //
    11  // Given the address of an ERC20 token contract, the chifra tokens tool reports token balances for one or
    12  // more additional addresses. Alternatively, the tool can report the token balances for multiple ERC20
    13  // tokens for a single addresses.
    14  //
    15  // In normal operation the **first item** in the address_list is assumed to be an ERC20 token
    16  // contract whose balances are being queried, whereas the remainder of the list is assumed to be
    17  // addresses on which to report.
    18  //
    19  // In --byAcct mode, **all addresses** in the address_list are assumed to be ERC20 token contracts,
    20  // except the final one which is the account whose token balances are reported.
    21  //
    22  // You may optionally specify one or more blocks at which to report. If no block is specified, the
    23  // latest block is assumed. You may also optionally specify which parts of the token data to extract.
    24  package tokensPkg