oasis-debug

oasis-debug.js

oasis-debug.js is a simple cli utility to view web3c logs. Although meant to be used in conjunction with contracts using the owasm-debug crate, it can be used more generally to view logs for any web3c contracts with or without confidentiality.

Oasis Debug

Authors:
  Oasis Labs Inc. <[e-mail]>

Usage:
  oasis-debug [arguments...]

Options:
  --help, -h       Show help                                           [boolean]
  --version, -v    Show version number                                 [boolean]
  --address, -a    Address to stream logs from         [string] [default: "all"]
  --topics, -t     Array of log topics to stream or "all" for any topic)
                                                      [array] [default: "debug"]
  --raw, -r        Option to emit the raw log data    [boolean] [default: false]
  --receipt, --re  Option to emit the entire transaction receipt for a given log
                                                      [boolean] [default: false]
  --network, -n    Gateway websocket url to connect to a network
                               [string] [default: "wss://web3.oasiscloud.io/ws"]
  --sender, -s     Address to filter output such that only transactions from
                   this address are given              [string] [default: "all"]
  --web3c          Path to the .web3c key manager database to use
                                                    [string] [default: ".web3c"]

By default, runing oasis-debug.js will try to deserialize all logs from hex strings to human readable utf-8. When provided with the raw flag, the raw log data, i.e., what is stored on chain, will be printed out.

Also by default, when viewing logs from confidential contracts, oasis-debug will only have access to the encryption keys of the .web3c database in the directory within which it is run. To specify a key manager database, use the --web3c flag. When receiving an encrypted log for which it doesn't have keys to decrypt, oasis-debug will print out the encrypted data.