Package Documentation
Storm Package: synapse-blockcypher
The following Commands are available from this package. This documentation is generated for version 2.0.0 of the package.
Storm Commands
This package implements the following Storm Commands.
blockcypher.config.add
Add a Synapse-BlockCypher configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add a global configuration
blockcypher.config.add default myapikey1234
// Add a configuration for the current user
blockcypher.config.add --scope self myconfig myapikey5678
Usage: blockcypher.config.add [options] <name> <apikey>
Options:
--help : Display the command usage.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
<apikey> : The BlockCypher API key string.
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
blockcypher.config.del
Delete a Synapse-BlockCypher configuration.
Examples:
// Delete the "myconfig" configuration
blockcypher.config.del myconfig
Usage: blockcypher.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
blockcypher.config.list
Display the list of Synapse-BlockCypher configurations you have access to.
Usage: blockcypher.config.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
blockcypher.config.migrate
Migrate options for all Synapse-BlockCypher configurations.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Disable SSL verification for all configurations
blockcypher.config.migrate --ssl-verify (false)
Usage: blockcypher.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.admin
blockcypher.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
blockcypher.config.show
// Show a configuration by name
blockcypher.config.show myconfig
Usage: blockcypher.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
blockcypher.config.update
Update the configuration of a defined Synapse-BlockCypher configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the permission level for user "myuser" to "admin" on the "myconfig"
// configuration
blockcypher.config.update myconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "myconfig" configuration
blockcypher.config.update myconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "myconfig"
blockcypher.config.update myconfig --ssl-verify (false)
// Change the name of the "myconfig" configuration to "otherconfig"
blockcypher.config.update myconfig --name otherconfig
Usage: blockcypher.config.update [options] <config>
Options:
--help : Display the command usage.
--apikey <apikey> : The BlockCypher API key string. (default: None)
--perm <perm> : Set the permission level for a user or role on this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level name, or (null) to remove the
permission, which falls back to the config default.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--name <name> : Rename the configuration. (default: None)
Arguments:
<config> : The name of the configuration to modify.
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
blockcypher.transaction.get
Load additional transaction information from the Blockcypher API.
This command takes crypto:currency:transaction nodes or transaction
hash strings as input and populates the crypto:currency:transaction
node with data from Blockcypher.
Note: When using a crypto:currency:transaction node as input, both
the :hash and :block:coin properties must be set to perform enrichment.
Examples:
// Get additional information for a crypto:currency:transaction
crypto:currency:transaction#mytx | blockcypher.transaction.get
// Get additional information for transactions by hash
blockcypher.transaction.get $hash1 $hash2
Usage: blockcypher.transaction.get [options] <hashes>
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--yield : Yield the newly created nodes.
--config <config> : Override the default config with the provided name.
Arguments:
[<hashes> ...] : Specify hashes to query Blockcypher for.
Inputs:
crypto:currency:transaction : crypto:currency:transaction nodes
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
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.
--config <config> : Override the default config with the provided name.
Inputs:
crypto:currency:address : The address to lookup transactions for.
The command is accessible to users with one or more of the following permissions:
power-ups.blockcypher.adminpower-ups.blockcypher.user
Storm Modules
This package does not export any Storm APIs.