User Guide

Synapse-Etherscan User Guide

Synapse-Etherscan adds new Storm commands to allow you to query the Etherscan API using your existing API key.

Getting Started

Check with your Admin to enable permissions and find out if you need a personal API key.

Examples

Setting your personal API key

To set-up a personal use API key:

> etherscan.setup.apikey eth --self myapikey
Setting Etherscan (eth) API key for the current user.

Use Etherscan to enrich nodes

Enrich a crypto:currency:address node with etherscan.enrich and yield the results:

> [ crypto:currency:address=(eth, 0x32F1Af729bAa768fb9d30F5Dbc295B7737a3E210) ] | etherscan.enrich --yield --size 3
crypto:currency:transaction=3d60f43557d72b66f873d140f3541d6e
        .created = 2023/01/31 20:21:14.989
        :block = eth/12971814
        :block:coin = eth
        :block:offset = 12971814
        :eth:gaslimit = 207128
        :eth:gasprice = 0.000000062
        :eth:gasused = 21000
        :from = eth/0xDFd5293D8e347dFe59E90eFd55b2956a1343963d
        :hash = f45b8ff1335fad160e00cba42df67462101b1353eee96e21e2c5168a84a7a3a9
        :success = True
        :time = 2021/08/06 14:00:24.000
        :to = eth/0x32F1Af729bAa768fb9d30F5Dbc295B7737a3E210
        :value = 4.0965
crypto:currency:transaction=a416dc317462a38cc114f0574e0c9e16
        .created = 2023/01/31 20:21:15.015
        :block = eth/12971837
        :block:coin = eth
        :block:offset = 12971837
        :contract:input = sha256:27c28a1d7429e3db79ec1aebe196de7be355143c9bc9ad29d2712797099f79ee
        :eth:gaslimit = 215887
        :eth:gasprice = 0.000000052320218757
        :eth:gasused = 163754
        :from = eth/0x32F1Af729bAa768fb9d30F5Dbc295B7737a3E210
        :hash = 6ca2643fd1dbb23daa43b306fdc20f72db616be5e775cdf1c96e6352d139c59d
        :success = True
        :time = 2021/08/06 14:06:41.000
        :to = eth/0x1A2a1c938CE3eC39b6D47113c7955bAa9DD454F2
        :value = 2.4
crypto:currency:transaction=f192d0d056494c68aa07147a2f909903
        .created = 2023/01/31 20:21:15.048
        :block = eth/12971864
        :block:coin = eth
        :block:offset = 12971864
        :eth:gaslimit = 21000
        :eth:gasprice = 0.000000051
        :eth:gasused = 21000
        :from = eth/0x32F1Af729bAa768fb9d30F5Dbc295B7737a3E210
        :hash = 7e3df29a81e8ec78d7fb53194c3e9692e1fa88301a6ad900d7bbc52f40ca99eb
        :success = True
        :time = 2021/08/06 14:13:29.000
        :to = eth/0xc073D4d22C851c662A963E398022Bf138555303c
        :value = 1.55

Query multiple chains using a hash argument and yield the results:

> etherscan.enrich.hash 0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0 --coin eth polygon --size 2 --yield
crypto:currency:transaction=5eb88169dbefb82ab32493f07a189e70
        .created = 2023/01/31 20:21:15.609
        :block = eth/13055340
        :block:coin = eth
        :block:offset = 13055340
        :eth:gaslimit = 21000
        :eth:gasprice = 0.000000029124495648
        :eth:gasused = 21000
        :from = eth/0xDDB833b9e0e3f2F521480e7Bcb3e676E0737047d
        :hash = 1f3fadee389f8393991e71974145a5fa2de049ed0a6264a9da879f1c97df3d51
        :success = True
        :time = 2021/08/19 11:08:52.000
        :to = eth/0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0
        :value = 4.319765525314957809
crypto:currency:transaction=df23226f953c4cac2acacbb2664a47a4
        .created = 2023/01/31 20:21:15.633
        :block = eth/13056982
        :block:coin = eth
        :block:offset = 13056982
        :contract:input = sha256:e8c05ca256a4cece99a2da695899ecdf753b7995cd124a0189f1e57886c8e415
        :eth:gaslimit = 2156471
        :eth:gasprice = 0.000000073534170823
        :eth:gasused = 2078783
        :from = eth/0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0
        :hash = be9d1e2c39412f3a5d31e6083b1c8ac84d56c4ee6e3ba29dd94f6f449f6618db
        :success = True
        :time = 2021/08/19 17:10:55.000
        :to = eth/0x86E4Dc95c7FBdBf52e33D563BbDB00823894C287
        :value = 0
crypto:currency:transaction=0b41ee119d6f4e8d6577b55d8b61434c
        .created = 2023/01/31 20:21:15.720
        :block = polygon/18654325
        :block:coin = polygon
        :block:offset = 18654325
        :eth:gaslimit = 21000
        :eth:gasprice = 0.00000003
        :eth:gasused = 21000
        :from = polygon/0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0
        :hash = edf831328291b404b69b0b41360fdafbb7e8f98beb87b916d5415a90df316306
        :success = True
        :time = 2021/09/02 07:41:44.000
        :to = polygon/0x2b563420722cBcFC84857129Bef775e0dC5F1401
        :value = 44211.438807197944577722
crypto:currency:transaction=485ecfba1adb90cc4791ff35549218af
        .created = 2023/01/31 20:21:15.744
        :block = polygon/18711859
        :block:coin = polygon
        :block:offset = 18711859
        :eth:gaslimit = 21000
        :eth:gasprice = 0.000000001000000001
        :eth:gasused = 21000
        :from = polygon/0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0
        :hash = 9d3b0b478fcc62d62328ab92038809e0b0417ecaa24d381d4d6b8749fcebaaff
        :success = True
        :time = 2021/09/03 19:31:25.000
        :to = polygon/0x2b563420722cBcFC84857129Bef775e0dC5F1401
        :value = 4407.901439470710765904

Use of meta:source nodes

Synapse-Etherscan uses a meta:source node and -(seen)> light weight edges to track nodes observed from the Etherscan API.

> meta:source=2dddff51304a19ce0bc77a1c9cfd22bb
meta:source=2dddff51304a19ce0bc77a1c9cfd22bb
        .created = 2023/01/31 20:21:14.927
        :name = etherscan api

Storm can be used to filter nodes to include/exclude nodes which have been observed by Synapse-Etherscan. The following example shows how to filter the results of a query to include only results observed by Synapse-Etherscan:

> crypto:currency:coin=polygon -> crypto:currency:transaction +{ <(seen)- meta:source=2dddff51304a19ce0bc77a1c9cfd22bb }
crypto:currency:transaction=485ecfba1adb90cc4791ff35549218af
        .created = 2023/01/31 20:21:15.744
        :block = polygon/18711859
        :block:coin = polygon
        :block:offset = 18711859
        :eth:gaslimit = 21000
        :eth:gasprice = 0.000000001000000001
        :eth:gasused = 21000
        :from = polygon/0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0
        :hash = 9d3b0b478fcc62d62328ab92038809e0b0417ecaa24d381d4d6b8749fcebaaff
        :success = True
        :time = 2021/09/03 19:31:25.000
        :to = polygon/0x2b563420722cBcFC84857129Bef775e0dC5F1401
        :value = 4407.901439470710765904
crypto:currency:transaction=0b41ee119d6f4e8d6577b55d8b61434c
        .created = 2023/01/31 20:21:15.720
        :block = polygon/18654325
        :block:coin = polygon
        :block:offset = 18654325
        :eth:gaslimit = 21000
        :eth:gasprice = 0.00000003
        :eth:gasused = 21000
        :from = polygon/0xF0245F6251Bef9447A08766b9DA2B07b28aD80B0
        :hash = edf831328291b404b69b0b41360fdafbb7e8f98beb87b916d5415a90df316306
        :success = True
        :time = 2021/09/02 07:41:44.000
        :to = polygon/0x2b563420722cBcFC84857129Bef775e0dC5F1401
        :value = 44211.438807197944577722