Package Documentation

Storm Package: synapse-blockchair

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

Storm Commands

This package implements the following Storm Commands.

blockchair.enrich

Load additional EVM information from the Blockchair API.

For crypto:currency:transaction nodes, this command will populate
transaction data and create smart:contract:effect:* nodes for various
ERC-20 and ERC-721 events which occurred as part of the transaction.

Note: Both the :hash and :block:coin properties must be set on the
inbound crypto:currency:transaction nodes to perform enrichment.

Examples:

  // Get additional information for a crypto:currency:transaction
  crypto:currency:transaction#mytx | blockchair.enrich

  // Query with caching disabled
  crypto:currency:transaction#mytx | blockchair.enrich --asof now


Usage: blockchair.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.
  --asof <asof>               : Specify the maximum age for a cached result. To disable caching, use --asof now. (default: -30days)

blockchair.enrich.hash

Load additional EVM information from the Blockchair 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 transaction hash and yield the results
  blockchair.enrich.hash --yield 0x32f1af729baa768fb9d30f5dbc295b7737a3e210


Usage: blockchair.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 details for.
  --asof <asof>               : Specify the maximum age for a cached result. To disable caching, use --asof now. (default: -30days)

Arguments:

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

blockchair.info

Get information about the Blockchair API key in use.

This command queries the /premium/stats endpoint to get information
about the current quota status for the Blockchair API key in use.

Usage: blockchair.info [options]

Options:

  --help                      : Display the command usage.

blockchair.setup.apikey

Manage the Blockchair API key.

Examples

    // Set a global Blockchair API key
    blockchair.setup.apikey abcd1234

    // Set a Blockchair API key for the current user
    blockchair.setup.apikey --self abcd1234

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

    // Display the current API key.
    blockchair.setup.apikey --show-apikey

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

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


Usage: blockchair.setup.apikey [options] <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:

  [apikey]                    : The API key string.

Storm Modules

This package does not export any Storm APIs.