Package Documentation

Storm Package: synapse-etherscan

The following Commands are available from this package. This documentation is generated for version 0.3.1 of the package.

Storm Commands

This package implements the following Storm Commands.

etherscan.enrich

Pull additional EVM information from an Etherscan API.

This command takes a crypto:currency:address, crypto:currency:transaction, or
crypto:smart:contract as input to query an Etherscan API for additional information.

Note: For crypto:currency:transaction nodes, both the :hash and
:block:coin properties must be set to perform enrichment.

Examples:

  // Get additional information for a crypto:currency:address
  crypto:currency:address#myaddr | etherscan.enrich

  // Get additional information for a crypto:currency:transaction limited to 10
  // results and yielding the results.
  crypto:currency:transaction#sometx | etherscan.enrich --yield --size 10


Usage: etherscan.enrich [options]

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size (per-node).
  --yield                     : Yield the newly created nodes.

etherscan.enrich.hash

Pull additional EVM information from an Etherscan API.

This command takes hash strings as input and queries the chains specified by
the --coin parameter. If no --coin parameter is provided, Ethereum
will be queried.

Examples:

  // Enrich a hash and yield the results
  etherscan.enrich.hash --yield 0x32f1af729baa768fb9d30f5dbc295b7737a3e210

  // Query multiple coins with --coin
  etherscan.enrich.hash 0x32f1af729baa768fb9d30f5dbc295b7737a3e210 --coin eth polygon


Usage: etherscan.enrich.hash [options] <hashes>

Options:

  --help                      : Display the command usage.
  --debug                     : Show verbose debug output.
  --size <size>               : Limit the number of results ingested to the given size (per-coin).
  --yield                     : Yield the newly created nodes.
  --coin <coin> [<coin> ...]  : The coin or coins to query address details for.

Arguments:

  <hashes> [<hashes> ...]     : Specify hashes to query Etherscan for.

etherscan.setup.apikey

Manage Etherscan API keys.

Examples

    // Set a global Etherscan API key
    etherscan.setup.apikey eth abcd1234

    // Set a Etherscan API key for the current user
    etherscan.setup.apikey eth --self abcd1234

    // Display the API key scope of the current key
    etherscan.setup.apikey eth --show-scope

    // Display the current API key.
    etherscan.setup.apikey eth --show-apikey

    // Remove the current global API key.
    etherscan.setup.apikey eth --remove

    // Remove the per-user API key for the current user.
    etherscan.setup.apikey eth --self --remove


Usage: etherscan.setup.apikey [options] <api> <apikey>

Options:

  --help                      : Display the command usage.
  --self                      : Set or remove the key as a user variable. If not used, the key is set globally.
  --show-scope                : Display the API key scope in use (global vs self).
  --show-apikey               : Display the API key value (requires admin perms or a "self" scope key).
  --remove                    : Remove the configured API key. May be used with --self.

Arguments:

  <api>                       : The Etherscan API to set the key for.
  [apikey]                    : The API key string.