github.com/TrueBlocks/trueblocks-core/src/apps/chifra@v0.0.0-20241022031540-b362680128f7/internal/transactions/README.md (about)

     1  ## chifra transactions
     2  
     3  The `chifra transactions` tool retrieves transactions directly from the Ethereum node or from the TrueBlocks cache (if present). You may specify multiple transaction identifiers
     4  per invocation. Unlike the Ethereum RPC, the reported transactions include the transaction's receipt
     5  and generated logs.
     6  
     7  The `--articulate` option fetches the ABI from each encountered smart contract (including those
     8  encountered in a trace--if the `--trace` option is enabled) to better describe the reported data.
     9  
    10  The `--trace` option attaches an array transaction traces to the output (if the node you're querying
    11  has --tracing enabled), while the `--uniq` option displays a list of uniq address appearances
    12  instead of the underlying data (including uniq addresses in traces if enabled).
    13  
    14  ```[plaintext]
    15  Purpose:
    16    Retrieve one or more transactions from the chain or local cache.
    17  
    18  Usage:
    19    chifra transactions [flags] <tx_id> [tx_id...]
    20  
    21  Arguments:
    22    transactions - a space-separated list of one or more transaction identifiers (required)
    23  
    24  Flags:
    25    -a, --articulate        articulate the retrieved data if ABIs can be found
    26    -t, --traces            include the transaction's traces in the results
    27    -u, --uniq              display a list of uniq addresses found in the transaction
    28    -f, --flow string       for the uniq option only, export only from or to (including trace from or to)
    29                            One of [ from | to ]
    30    -l, --logs              display only the logs found in the transaction(s)
    31    -m, --emitter strings   for the --logs option only, filter logs to show only those logs emitted by the given address(es)
    32    -B, --topic strings     for the --logs option only, filter logs to show only those with this topic(s)
    33    -R, --cache_traces      force the transaction's traces into the cache
    34    -H, --ether             specify value in ether
    35    -o, --cache             force the results of the query into the cache
    36    -D, --decache           removes related items from the cache
    37    -x, --fmt string        export format, one of [none|json*|txt|csv]
    38    -v, --verbose           enable verbose output
    39    -h, --help              display this help screen
    40  
    41  Notes:
    42    - The transactions list may be one or more transaction hashes, blockNumber.transactionID pairs, or a blockHash.transactionID pairs.
    43    - This tool checks for valid input syntax, but does not check that the transaction requested actually exists.
    44    - If the queried node does not store historical state, the results for most older transactions are undefined.
    45    - The --decache option removes the all transaction(s) and all traces in those transactions from the cache.
    46    - The --traces option requires your RPC to provide trace data. See the README for more information.
    47  ```
    48  
    49  Data models produced by this tool:
    50  
    51  - [appearance](/data-model/accounts/#appearance)
    52  - [function](/data-model/other/#function)
    53  - [log](/data-model/chaindata/#log)
    54  - [message](/data-model/other/#message)
    55  - [parameter](/data-model/other/#parameter)
    56  - [transaction](/data-model/chaindata/#transaction)
    57  
    58  ### further information
    59  
    60  The `--traces` option requires your node to enable the `trace_block` (and related) RPC endpoints. Please see the README file for the `chifra traces` command for more information.
    61  
    62  ### Other Options
    63  
    64  All tools accept the following additional flags, although in some cases, they have no meaning.
    65  
    66  ```[plaintext]
    67    -v, --version         display the current version of the tool
    68        --output string   write the results to file 'fn' and return the filename
    69        --append          for --output command only append to instead of replace contents of file
    70        --file string     specify multiple sets of command line options in a file
    71  ```
    72  
    73  **Note:** For the `--file string` option, you may place a series of valid command lines in a file using any
    74  valid flags. In some cases, this may significantly improve performance. A semi-colon at the start
    75  of any line makes it a comment.
    76  
    77  **Note:** If you use `--output --append` option and at the same time the `--file` option, you may not switch
    78  export formats in the command file. For example, a command file with two different commands, one with `--fmt csv`
    79  and the other with `--fmt json` will produce both invalid CSV and invalid JSON.
    80  
    81  *Copyright (c) 2024, TrueBlocks, LLC. All rights reserved. Generated with goMaker.*