Admin Guide

Synapse-BlockCypher Admin Guide

Configuration

Synapse-BlockCypher requires a BlockCypher API key. For information on how to sign up, please visit the BlockCypher API documentation.

Setting API key for global use

To set-up a global API key:

> blockcypher.config.add default myapikey
Synapse-BlockCypher config "default" added

Creating a configuration for role-based use

Add an unscoped configuration:

> blockcypher.config.add myunscoped myapikey --scope unscoped
Synapse-BlockCypher config "myunscoped" added

Grant another user admin permissions to the new configuration:

> blockcypher.config.update myunscoped --perm user visi admin
Updated Synapse-BlockCypher config "myunscoped"

Grant a role read permissions to the new configuration:

> blockcypher.config.update myunscoped --perm role ninjas read
Updated Synapse-BlockCypher config "myunscoped"

Users may select a configuration other than their default by passing --config <name> to the Synapse-BlockCypher commands.

Overriding the proxy configuration

In order to override the default proxy configuration in the Cortex the user must have the power-ups.blockcypher.admin or storm.lib.inet.http.proxy permission.

When the proxy configuration is set to (false) or a URL the permission will be checked when a configuration is created/updated, and when it is used to make an HTTP request.

Permissions

Package (synapse-blockcypher) defines the following permissions:
power-ups.blockcypher.user       : Controls user access to Synapse-BlockCypher. ( default: false )
power-ups.blockcypher.admin      : Controls access to Synapse-BlockCypher admin options. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.blockcypher.user
Added rule power-ups.blockcypher.user to user visi.

or:

> auth.role.addrule ninjas power-ups.blockcypher.user
Added rule power-ups.blockcypher.user to role ninjas.

Exported APIs

Synapse-BlockCypher does not currently export any APIs.

Workflows

Synapse-BlockCypher provides the following workflows in Optic:

Title: Configuration

The Configuration workflow may be used to manage Synapse-BlockCypher configurations from Optic.

Node Actions

Synapse-BlockCypher provides the following node actions in Optic:

Name : transactions
Desc : Load transactions for the given crypto currency address.
Forms: crypto:currency:address

Name : enrich transaction
Desc : Enrich a transaction with data from Blockcypher
Forms: crypto:currency:transaction