Package Documentation

Storm Package: synapse-blockcypher

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

Storm Commands

This package implements the following Storm Commands.

blockcypher.setup.apikey

Manage the BlockCypher API key.

Examples

    // Set a global BlockCypher API key
    blockcypher.setup.apikey abcd1234

    // Set a BlockCypher API key for the current user
    blockcypher.setup.apikey --self abcd1234

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

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

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

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


Usage: blockcypher.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.

blockcypher.transactions

Load transactions for ``crypto:currency:address`` nodes.

This command will also create an ``econ:account:balance`` node with the current
balance and amount of BTC sent/received at this address.

Examples:

  // Load transactions and yield the newly constructed crypto:currency:transaction nodes
  crypto:currency:address=btc/3HMgskrRPa5ZVwtU7C9Qt7WYYym1yQzdww | blockcypher.transactions --debug --yield


Usage: blockcypher.transactions [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.