github.com/TrueBlocks/trueblocks-core/src/apps/chifra@v0.0.0-20241022031540-b362680128f7/internal/abis/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  // abisPkg implements the chifra abis command.
    10  //
    11  // The chifra abis tool retrieves one or more ABI files for the given address(es). It searches
    12  // for ABIs, sequentially, in the following locations:
    13  //
    14  // - the current working folder,
    15  // - the TrueBlocks local cache,
    16  // - Etherscan,
    17  // - (in the future) ENS and Sourcify.
    18  //
    19  // While this tool may be used from the command line, its primary purpose is in support of
    20  // the --articulate option for tools such as chifra export and chifra logs.
    21  //
    22  // If possible, the tool will follow proxied addresses searching for the ABI, but that does not
    23  // always work. In that case, you may use the --proxy_for option.
    24  //
    25  // The --known option prints a list of semi-standard function signatures such as the ERC20 standard,
    26  // ERC 721 standard, various functions from OpenZeppelin, various Uniswap functions, etc. As an
    27  // optimization, the known signatures are searched first during articulation.
    28  //
    29  // The --encode option generates a 32-byte encoding for a given cannonical function or event signature. For
    30  // functions, you may manually extract the first four bytes of the hash.
    31  //
    32  // The --find option is experimental. Please see the notes below for more information.
    33  package abisPkg