dshackle cli tool

dshackle-cli/README.md

@@ -0,0 +1,21 @@
+# DSHACKLE CLI
+
+A CLI tool to verify the [dshacle](https://github.com/emeraldpay/dshackle) installation.
+
+## Usage
+```
+npx dchackle-cli-tool [-p|--print] <dshackle instance url>
+```
+
+### Options
+-p | --print - will print the describe response as is
+
+## Example
+
+```
+> dchackle-cli-tool localhost:2449
+Connecting to: localhost:2449...
+Connected to  localhost:2449
+CHAIN_ETHEREUM -> AVAIL_OK
+CHAIN_KOVAN -> AVAIL_OK
+```

dshackle-cli/bin/dshackle-cli-tool

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+require = require('esm')(module /*, options*/);
+require('../src/cli').cli(process.argv);

dshackle-cli/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "dshackle-cli-tool",
+  "version": "1.0.3",
+  "description": "",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "@mfomenkov/dshackle-cli-tool": "bin/dshackle-cli-tool",
+    "dshackle-cli-tool": "bin/dshackle-cli-tool"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@grpc/grpc-js": "^1.6.12",
+    "@grpc/proto-loader": "^0.7.2",
+    "arg": "^5.0.2",
+    "cli-color": "^2.0.3",
+    "esm": "^3.2.25",
+    "inquirer": "^9.1.1"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "proto/"
+  ]
+}

dshackle-cli/proto/blockchain.proto

@@ -0,0 +1,284 @@
+syntax = "proto3";
+package emerald;
+option java_package = "io.emeraldpay.api.proto";
+import "common.proto";
+
+service Blockchain {
+    rpc SubscribeHead (Chain) returns (stream ChainHead) {}
+    rpc SubscribeBalance (BalanceRequest) returns (stream AddressBalance) {}
+    rpc SubscribeTxStatus (TxStatusRequest) returns (stream TxStatus) {}
+
+    rpc GetBalance (BalanceRequest) returns (stream AddressBalance) {}
+
+    /**
+     * Fee Estimation service. The server tries to estimate a fair fee based on the last N blocks.
+     */
+    rpc EstimateFee (EstimateFeeRequest) returns (EstimateFeeResponse) {}
+
+    rpc NativeCall (NativeCallRequest) returns (stream NativeCallReplyItem) {}
+    rpc NativeSubscribe (NativeSubscribeRequest) returns (stream NativeSubscribeReplyItem) {}
+
+    rpc Describe (DescribeRequest) returns (DescribeResponse) {}
+    rpc SubscribeStatus (StatusRequest) returns (stream ChainStatus) {}
+}
+
+message NativeCallRequest {
+    ChainRef chain = 1;
+    repeated NativeCallItem items = 2;
+    Selector selector = 3;
+    int32 quorum = 4;
+    AvailabilityEnum min_availability = 5;
+}
+
+message NativeCallItem {
+    uint32 id = 1;
+    string method = 3;
+    bytes payload = 4;
+    uint64 nonce = 5;
+}
+
+/**
+ * Signature for a response
+ */
+message NativeCallReplySignature {
+    /**
+     * Original nonce value used for the call
+     */
+    uint64 nonce = 1;
+    /**
+     * Signature value
+     */
+    bytes signature = 2;
+    /**
+     * Key Id used for the signing
+     */
+    uint64 key_id = 3;
+    /**
+     * Id of the upstream produced the response
+     */
+    string upstream_id = 4;
+}
+
+message NativeCallReplyItem {
+    uint32 id = 1;
+    bool succeed = 2;
+    bytes payload = 3;
+    string errorMessage = 4;
+    /**
+     * Optional signature for the response.
+     * Available only when it's configured at the edge dshackle and nonce is provided wit the request.
+     */
+    NativeCallReplySignature signature = 5;
+}
+
+message NativeSubscribeRequest {
+    ChainRef chain = 1;
+    string method = 2;
+    bytes payload = 3;
+}
+
+message NativeSubscribeReplyItem {
+    bytes payload = 1;
+}
+
+message ChainHead {
+    ChainRef chain = 1;
+    uint64 height = 2;
+    string block_id = 3;
+    uint64 timestamp = 4;
+    bytes weight = 5;
+    uint64 reorg = 6;
+}
+
+message TxStatusRequest {
+    ChainRef chain = 1;
+    string tx_id = 2;
+    uint32 confirmation_limit = 3;
+}
+
+message TxStatus {
+    string tx_id = 1;
+    bool broadcasted = 2;
+    bool mined = 3;
+    BlockInfo block = 4;
+    uint32 confirmations = 5;
+}
+
+message BalanceRequest {
+    Asset asset = 1;
+    AnyAddress address = 2;
+    bool include_utxo = 3;
+}
+
+message AddressBalance {
+    Asset asset = 1;
+    SingleAddress address = 2;
+    string balance = 3;
+    bool confirmed = 4;
+    repeated Utxo utxo = 5;
+}
+
+message Utxo {
+    string tx_id = 1;
+    uint64 index = 2;
+    string balance = 3;
+    bool spent = 4;
+}
+
+message DescribeRequest {
+}
+
+message DescribeResponse {
+    repeated DescribeChain chains = 1;
+}
+
+message DescribeChain {
+    ChainRef chain = 1;
+    ChainStatus status = 2;
+    repeated NodeDetails nodes = 3;
+    repeated string supportedMethods = 4;
+    repeated string excludedMethods = 5;
+    repeated Capabilities capabilities = 6;
+}
+
+message StatusRequest {
+    repeated ChainRef chains = 1;
+}
+
+message ChainStatus {
+    ChainRef chain = 1;
+    AvailabilityEnum availability = 2;
+    uint32 quorum = 3;
+}
+
+enum AvailabilityEnum {
+    AVAIL_UNKNOWN = 0;
+    AVAIL_OK = 1;
+    AVAIL_LAGGING = 2;
+    AVAIL_IMMATURE = 3;
+    AVAIL_SYNCING = 4;
+    AVAIL_UNAVAILABLE = 5;
+}
+
+message NodeDetails {
+    uint32 quorum = 1;
+    repeated Label labels = 2;
+}
+
+enum Capabilities {
+    CAP_NONE = 0;
+    CAP_CALLS = 1;
+    CAP_BALANCE = 2;
+}
+
+message Label {
+    string name = 1;
+    string value = 2;
+}
+
+message Selector {
+    oneof selector_type {
+        LabelSelector labelSelector = 1;
+        OrSelector orSelector = 2;
+        AndSelector andSelector = 3;
+        NotSelector notSelector = 4;
+        ExistsSelector existsSelector = 5;
+    }
+}
+
+message LabelSelector {
+    string name = 1;
+    repeated string value = 2;
+}
+
+message OrSelector {
+    repeated Selector selectors = 1;
+}
+
+message AndSelector {
+    repeated Selector selectors = 1;
+}
+
+message NotSelector {
+    Selector selector = 1;
+}
+
+message ExistsSelector {
+    string name = 1;
+}
+
+/**
+ * Request for Fee Estimation Service
+ */
+message EstimateFeeRequest {
+    // Target chain
+    ChainRef chain = 1;
+    // The way how the fee should be estimated
+    FeeEstimationMode mode = 2;
+    // How many blocks the server is supposed to use to estimate current fee. Note that the server may use value, depending on configuration
+    uint32 blocks = 3;
+}
+
+/**
+ * Responset for Fee Estimation Service
+ */
+message EstimateFeeResponse {
+    // May return different struct, depending on the blockchain
+    oneof fee_type {
+        // Standard Ethereum Fee, supported by majority of forks and by Ethereum Mainnet before EIP-1559
+        EthereumStdFees ethereumStd = 1;
+        // Ethereum Fee for EIP-1559 compatible forks
+        EthereumExtFees ethereumExtended = 2;
+        // Standard Bitcoin Fee
+        BitcoinStdFees bitcoinStd = 3;
+    }
+}
+
+/**
+ * The mode of how the fee must be estimated
+ */
+enum FeeEstimationMode {
+    INVALID = 0;
+    // Average over last transaction in each block
+    AVG_LAST = 1;
+    // Average over transaction 5th from the end in each block
+    AVG_T5 = 2;
+    // Average over transaction 20th from the end in each block
+    AVG_T20 = 3;
+    // Average over transaction 50th from the end in each block
+    AVG_T50 = 4;
+    // Minimal fee that would be accepted by every last block
+    MIN_ALWAYS = 5;
+    // Average over transaction in the middle of each block
+    AVG_MIDDLE = 6;
+    // Average over transaction in head of each block. Note that for Bitcoin it doesn't count COINBASE tx as top tx.
+    AVG_TOP = 7;
+}
+
+/**
+ * Standard Ethereum Fee, supported by majority of forks and by Ethereum Mainnet before EIP-1559
+ */
+message EthereumStdFees {
+    // Big Number encoded as string. Fee value in Wei
+    string fee = 1;
+}
+
+/**
+ * Ethereum Fee for EIP-1559 compatible forks
+ */
+message EthereumExtFees {
+    // Big Number encoded as string. Estimated fee that expected to be actually paid. I.e. it's the Base Fee + Priority Fee
+    string expect = 1;
+    // Big Number encoded as string. Priority Fee in Wei
+    string priority = 2;
+    // Big Number encoded as string. Max Fee value in Wei. Note that it only indicates the current preference, and the actual Max may be significantly lower, depending on the usage scenario.
+    string max = 3;
+}
+
+/**
+ * Standard Bitcoin Fee
+ */
+message BitcoinStdFees {
+    // Fee in Satoshi per Kilobyte. Note that the actual fee calculation MUST divide it by 1024 at the last step to get a fair fee.
+    uint64 satPerKb = 1;
+}

dshackle-cli/proto/common.proto

@@ -0,0 +1,74 @@
+syntax = "proto3";
+package emerald;
+option java_package = "io.emeraldpay.api.proto";
+
+message Chain {
+    ChainRef type = 1;
+}
+
+enum ChainRef {
+    CHAIN_UNSPECIFIED = 0;
+
+    CHAIN_BITCOIN = 1;
+    // CHAIN_GRIN = 2;
+
+    CHAIN_ETHEREUM = 100;
+    CHAIN_ETHEREUM_CLASSIC = 101;
+    CHAIN_FANTOM = 102; // Fantom, https://fantom.foundation/
+
+    // Sidechains and state channels start with 1_000
+    // CHAIN_LIGHTNING = 1001;
+    CHAIN_MATIC = 1002; // Matic PoS Ethereum sidechain based on Polygon
+    CHAIN_RSK = 1003; // RSK sidechain, https://www.rsk.co/
+
+    // Testnets start with 10_000
+    CHAIN_MORDEN = 10001;
+    CHAIN_KOVAN = 10002;
+    CHAIN_TESTNET_BITCOIN = 10003;
+    // CHAIN_FLOONET = 10004;
+    CHAIN_GOERLI = 10005;
+    CHAIN_ROPSTEN = 10006;
+    CHAIN_RINKEBY = 10007;
+
+    // Non-standard starts from 20_000
+}
+
+message SingleAddress {
+    string address = 1;
+}
+
+message XpubAddress {
+    bytes xpub = 1;
+    string path = 2;
+    uint64 start = 3;
+    uint64 limit = 4;
+}
+
+message MultiAddress {
+    repeated SingleAddress addresses = 1;
+}
+
+message ReferenceAddress {
+    uint64 refid = 1;
+}
+
+message AnyAddress {
+    oneof addr_type {
+        SingleAddress address_single = 1;
+        MultiAddress address_multi = 2;
+        XpubAddress address_xpub = 3;
+        ReferenceAddress address_ref = 4;
+    }
+}
+
+message Asset {
+    ChainRef chain = 1;
+    string code = 2;
+}
+
+message BlockInfo {
+    uint64 height = 1;
+    string block_id = 2;
+    uint64 timestamp = 3;
+    bytes weight = 4;
+}

dshackle-cli/src/cli.js

@@ -0,0 +1,57 @@
+import {describe} from "./grpc-clent";
+import arg from 'arg';
+import clc from "cli-color";
+import util from "util";
+
+export function cli(args) {
+    let opts = parseArgumentsIntoOptions(args);
+    if (!opts.url) {
+        console.log("Err: URL not specified!")
+        return
+    }
+    describe(opts.url, (error, response) => {
+        if (error) {
+            console.error(clc.red('Connection to ' + opts.url + ' failed! [' + error.message + ']'));
+        } else {
+            console.error(clc.green('Connected to ', opts.url));
+            if (opts.print) {
+                console.log(util.inspect(response, false, null, true /* enable colors */));
+            } else {
+                response.chains.forEach(function (item) {
+                    var state = item.status.availability;
+
+                    switch (state) {
+                        case 'AVAIL_OK':
+                            state = clc.green(state);
+                            break
+                        case 'AVAIL_UNKNOWN':
+                        case 'AVAIL_UNAVAILABLE':
+                            state = clc.red(state);
+                            break
+                        default:
+                            state = clc.yellow(state);
+                    }
+                    console.log(item.status.chain + ' -> ' + clc.bold(state))
+                })
+            }
+        }
+    })
+}
+
+function parseArgumentsIntoOptions(rawArgs) {
+    const args = arg(
+        {
+            '--print': Boolean,
+            '-p': '--print'
+        },
+        {
+            argv: rawArgs.slice(2),
+        }
+    );
+    return {
+        print: args['--print'] || false,
+        url: args._[0]
+    };
+}
+
+

dshackle-cli/src/grpc-clent.js

@@ -0,0 +1,25 @@
+const grpc = require("@grpc/grpc-js");
+const path = require('path')
+const protoLoader = require("@grpc/proto-loader");
+
+const PROTO_PATH = path.join(__dirname, "../proto/blockchain.proto");
+
+const options = {
+    keepCase: true,
+    longs: String,
+    enums: String,
+    defaults: true,
+    oneofs: true,
+};
+
+const packageDefinition = protoLoader.loadSync(PROTO_PATH, options);
+const emerald = grpc.loadPackageDefinition(packageDefinition).emerald
+
+export function describe(url, handler) {
+    const client = new emerald.Blockchain(
+        url,
+        grpc.credentials.createInsecure()
+    );
+    console.log('Connecting to: ' + url + '...')
+    client.Describe({}, handler);
+}