logsPkg

README

chifra logs

chifra logs returns the given transaction's logs. You may specify multiple transaction identifiers per invocation.

The --articulate option fetches the ABI from each encountered smart contract to better describe the reported data. The --topic and --source options allow you to filter your results.

Purpose:
  Retrieve logs for the given transaction(s).

Usage:
  chifra logs [flags] <tx_id> [tx_id...]

Arguments:
  transactions - a space-separated list of one or more transaction identifiers (required)

Flags:
  -m, --emitter strings   filter logs to show only those logs emitted by the given address(es)
  -B, --topic strings     filter logs to show only those with this topic(s)
  -a, --articulate        articulate the retrieved data if ABIs can be found
  -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:
  - The transactions list may be one or more transaction hashes, blockNumber.transactionID pairs, or a blockHash.transactionID pairs.
  - This tool checks for valid input syntax, but does not check that the transaction requested actually exists.
  - If the queried node does not store historical state, the results for most older transactions are undefined.
  - If you specify a 32-byte hash, it will be assumed to be a transaction hash, if it is not, the hash will be used as a topic.

Data models produced by this tool:

• function
• log
• message
• parameter

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

logsPkg implements the chifra logs command.

chifra logs returns the given transaction's logs. You may specify multiple transaction identifiers per invocation.

The --articulate option fetches the ABI from each encountered smart contract to better describe the reported data. The --topic and --source options allow you to filter your results.

Index

• func ResetOptions(testMode bool)
• func RunLogs(cmd *cobra.Command, args []string) error
• func ServeLogs(w http.ResponseWriter, r *http.Request) error
• type LogsOptions
  • func GetLogsOptions(args []string, g *globals.GlobalOptions) *LogsOptions
  • func GetOptions() *LogsOptions
  • func LogsFinishParseInternal(w io.Writer, values url.Values) *LogsOptions
  • func (opts *LogsOptions) HandleDecache(rCtx *output.RenderCtx) error
  • func (opts *LogsOptions) HandleShow(rCtx *output.RenderCtx) error
  • func (opts *LogsOptions) LogsInternal(rCtx *output.RenderCtx) error
  • func (opts *LogsOptions) String() string

Functions

func ResetOptions

func ResetOptions(testMode bool)

func RunLogs

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

RunLogs handles the logs command for the command line. Returns error only as per cobra.

func ServeLogs

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

ServeLogs handles the logs command for the API. Returns an error.

Types

type LogsOptions

type LogsOptions struct {
	Transactions   []string                 `json:"transactions,omitempty"`   // A space-separated list of one or more transaction identifiers
	TransactionIds []identifiers.Identifier `json:"transactionIds,omitempty"` // Transaction identifiers
	Emitter        []string                 `json:"emitter,omitempty"`        // Filter logs to show only those logs emitted by the given address(es)
	Topic          []string                 `json:"topic,omitempty"`          // Filter logs to show only those with this topic(s)
	Articulate     bool                     `json:"articulate,omitempty"`     // Articulate the retrieved data if ABIs can be found
	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

}

LogsOptions provides all command options for the chifra logs command.

func GetLogsOptions

func GetLogsOptions(args []string, g *globals.GlobalOptions) *LogsOptions

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

func GetOptions

func GetOptions() *LogsOptions

func LogsFinishParseInternal

func LogsFinishParseInternal(w io.Writer, values url.Values) *LogsOptions

func (*LogsOptions) HandleDecache

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

func (*LogsOptions) HandleShow

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

func (*LogsOptions) LogsInternal

func (opts *LogsOptions) LogsInternal(rCtx *output.RenderCtx) error

LogsInternal handles the internal workings of the logs command. Returns an error.

func (*LogsOptions) String

func (opts *LogsOptions) String() string

String implements the Stringer interface