Package Documentation
Storm Package: synapse-etherscan
The following Commands are available from this package. This documentation is generated for version 3.0.0 of the package.
Storm Commands
This package implements the following Storm Commands.
etherscan.chains.list
List information about the configured chains for the Etherscan API.
Usage: etherscan.chains.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.etherscan.adminpower-ups.etherscan.user
etherscan.config.add
Add a Synapse-Etherscan 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
etherscan.config.add default myapikey1234
// Add a configuration for the current user
etherscan.config.add --scope self myconfig myapikey5678
Usage: etherscan.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 Etherscan API key string.
The command is accessible to users with one or more of the following permissions:
power-ups.etherscan.adminpower-ups.etherscan.user
etherscan.config.del
Delete a Synapse-Etherscan configuration.
Examples:
// Delete the "myconfig" configuration
etherscan.config.del myconfig
Usage: etherscan.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.etherscan.adminpower-ups.etherscan.user
etherscan.config.list
Display the list of Synapse-Etherscan configurations you have access to.
Usage: etherscan.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.etherscan.adminpower-ups.etherscan.user
etherscan.config.migrate
Migrate options for all Synapse-Etherscan 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
etherscan.config.migrate --ssl-verify (false)
Usage: etherscan.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.etherscan.admin
etherscan.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
etherscan.config.show
// Show a configuration by name
etherscan.config.show myconfig
Usage: etherscan.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.etherscan.adminpower-ups.etherscan.user
etherscan.config.update
Update the configuration of a defined Synapse-Etherscan 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
etherscan.config.update myconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "myconfig" configuration
etherscan.config.update myconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "myconfig"
etherscan.config.update myconfig --ssl-verify (false)
// Change the name of the "myconfig" configuration to "otherconfig"
etherscan.config.update myconfig --name otherconfig
Usage: etherscan.config.update [options] <config>
Options:
--help : Display the command usage.
--apikey <apikey> : The Etherscan 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.etherscan.adminpower-ups.etherscan.user
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.
--config <config> : Override the default config with the provided name.
Inputs:
crypto:currency:address : crypto:currency:address nodes
crypto:currency:transaction : crypto:currency:transaction nodes
crypto:smart:contract : crypto:smart:contract nodes
The command is accessible to users with one or more of the following permissions:
power-ups.etherscan.adminpower-ups.etherscan.user
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 pol
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.
--config <config> : Override the default config with the provided name.
Arguments:
<hashes> [<hashes> ...] : Specify hashes to query Etherscan for.
The command is accessible to users with one or more of the following permissions:
power-ups.etherscan.adminpower-ups.etherscan.user
Storm Modules
This package does not export any Storm APIs.