@gnolang/tm2-js-client 1.0.0

package/bin/provider/provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/bin/provider/types/abci.d.ts

@@ -0,0 +1,39 @@
+export interface ABCIResponse {
+    response: {
+        ResponseBase: ABCIResponseBase;
+        Key: string | null;
+        Value: string | null;
+        Proof: MerkleProof | null;
+        Height: string;
+    };
+}
+export interface ABCIResponseBase {
+    Error: {
+        [key: string]: string;
+    } | null;
+    Data: string | null;
+    Events: string | null;
+    Log: string;
+    Info: string;
+}
+interface MerkleProof {
+    ops: {
+        type: string;
+        key: string | null;
+        data: string | null;
+    }[];
+}
+export interface ABCIAccount {
+    BaseAccount: {
+        address: string;
+        coins: string;
+        public_key: {
+            type: string;
+            value: string;
+        } | null;
+        account_number: string;
+        sequence: string;
+    };
+}
+export declare const ABCIErrorKey = "@type";
+export {};

package/bin/provider/types/abci.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ABCIErrorKey = void 0;
+exports.ABCIErrorKey = '@type';

package/bin/provider/types/common.d.ts

@@ -0,0 +1,154 @@
+import { ABCIResponseBase } from './abci';
+export interface NetworkInfo {
+    listening: boolean;
+    listeners: string[];
+    n_peers: string;
+    peers: string[];
+}
+export interface Status {
+    node_info: NodeInfo;
+    sync_info: SyncInfo;
+    validator_info: ValidatorInfo;
+}
+interface NodeInfo {
+    version_set: VersionInfo[];
+    net_address: string;
+    network: string;
+    software: string;
+    version: string;
+    channels: string;
+    monkier: string;
+    other: {
+        tx_index: string;
+        rpc_address: string;
+    };
+}
+interface VersionInfo {
+    Name: string;
+    Version: string;
+    Optional: boolean;
+}
+interface SyncInfo {
+    latest_block_hash: string;
+    latest_app_hash: string;
+    latest_block_height: string;
+    latest_block_time: string;
+    catching_up: boolean;
+}
+interface ValidatorInfo {
+    address: string;
+    pub_key: PublicKey;
+    voting_power: string;
+}
+interface PublicKey {
+    type: string;
+    value: string;
+}
+export interface ConsensusParams {
+    block_height: string;
+    consensus_params: {
+        Block: {
+            MaxTxBytes: string;
+            MaxDataBytes: string;
+            MaxBlockBytes: string;
+            MaxGas: string;
+            TimeIotaMS: string;
+        };
+        Validator: {
+            PubKeyTypeURLs: string[];
+        };
+    };
+}
+export interface ConsensusState {
+    round_state: {
+        [key: string]: string | null | object;
+        start_time: string;
+        proposal_block_hash: string | null;
+        locked_block_hash: string | null;
+        valid_block_hash: string | null;
+        height_vote_set: object;
+    };
+}
+export interface BlockInfo {
+    block_meta: BlockMeta;
+    block: Block;
+}
+export interface BlockMeta {
+    block_id: BlockID;
+    header: BlockHeader;
+}
+export interface Block {
+    header: BlockHeader;
+    data: {
+        txs: string[] | null;
+    };
+    last_commit: {
+        block_id: BlockID;
+        precommits: PrecommitInfo[] | null;
+    };
+}
+export interface BlockHeader {
+    version: string;
+    chain_id: string;
+    height: string;
+    time: string;
+    num_txs: string;
+    total_txs: string;
+    app_version: string;
+    last_block_id: BlockID;
+    last_commit_hash: string | null;
+    data_hash: string | null;
+    validators_hash: string;
+    consensus_hash: string;
+    app_hash: string;
+    last_results_hash: string | null;
+    proposer_address: string;
+}
+export interface BlockID {
+    hash: string | null;
+    parts: {
+        total: string;
+        hash: string | null;
+    };
+}
+export interface PrecommitInfo {
+    type: number;
+    height: string;
+    round: string;
+    block_id: BlockID;
+    timestamp: string;
+    validator_address: string;
+    validator_index: string;
+    signature: string;
+}
+export interface BlockResult {
+    height: string;
+    results: {
+        deliver_tx: DeliverTx[] | null;
+        end_block: EndBlock;
+        begin_block: BeginBlock;
+    };
+}
+export interface DeliverTx {
+    ResponseBase: ABCIResponseBase;
+    GasWanted: string;
+    GasUsed: string;
+}
+export interface EndBlock {
+    ResponseBase: ABCIResponseBase;
+    ValidatorUpdates: string | null;
+    ConsensusParams: string | null;
+    Events: string | null;
+}
+export interface BeginBlock {
+    ResponseBase: ABCIResponseBase;
+}
+export interface BroadcastTxResult {
+    error: {
+        [key: string]: string;
+    } | null;
+    data: string | null;
+    Log: string;
+    hash: string;
+}
+export {};

package/bin/provider/types/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/bin/provider/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './abci';
+export * from './common';
+export * from './jsonrpc';

package/bin/provider/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./abci"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./jsonrpc"), exports);

package/bin/provider/types/jsonrpc.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The base JSON-RPC 2.0 request
+ */
+export interface RPCRequest {
+    jsonrpc: string;
+    id: string | number;
+    method: string;
+    params?: any[];
+}
+/**
+ * The base JSON-RPC 2.0 response
+ */
+export interface RPCResponse<Result> {
+    jsonrpc: string;
+    id: string | number;
+    result?: Result;
+    error?: RPCError;
+}
+/**
+ * The base JSON-RPC 2.0 typed response error
+ */
+export interface RPCError {
+    code: number;
+    message: string;
+    data?: any;
+}

package/bin/provider/types/jsonrpc.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/bin/provider/utility/index.d.ts

@@ -0,0 +1,2 @@
+export * from './provider.utility';
+export * from './requests.utility';

package/bin/provider/utility/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./provider.utility"), exports);
+__exportStar(require("./requests.utility"), exports);

package/bin/provider/utility/provider.utility.d.ts

@@ -0,0 +1,28 @@
+import { Provider } from '../provider';
+import { Tx } from '../../proto';
+/**
+ * Extracts the specific balance denomination from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ * @param {string} denomination the required denomination
+ */
+export declare const extractBalanceFromResponse: (abciData: string | null, denomination: string) => number;
+/**
+ * Extracts the account sequence from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+export declare const extractSequenceFromResponse: (abciData: string | null) => number;
+/**
+ * Extracts the account number from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+export declare const extractAccountNumberFromResponse: (abciData: string | null) => number;
+/**
+ * Waits for the transaction to be committed to a block in the chain
+ * of the specified provider. This helper does a search for incoming blocks
+ * and checks if a transaction
+ * @param {Provider} provider the provider instance
+ * @param {string} hash the base64-encoded hash of the transaction
+ * @param {number} [fromHeight=latest] the starting height for the search. If omitted, it is the latest block in the chain
+ * @param {number} [timeout=15000] the timeout in MS for the search
+ */
+export declare const waitForTransaction: (provider: Provider, hash: string, fromHeight?: number, timeout?: number) => Promise<Tx>;

package/bin/provider/utility/provider.utility.js

@@ -0,0 +1,194 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForTransaction = exports.extractAccountNumberFromResponse = exports.extractSequenceFromResponse = exports.extractBalanceFromResponse = void 0;
+var requests_utility_1 = require("./requests.utility");
+var proto_1 = require("../../proto");
+var crypto_1 = require("@cosmjs/crypto");
+/**
+ * Extracts the specific balance denomination from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ * @param {string} denomination the required denomination
+ */
+var extractBalanceFromResponse = function (abciData, denomination) {
+    // Make sure the response is initialized
+    if (!abciData) {
+        return 0;
+    }
+    // Extract the balances
+    var balancesRaw = Buffer.from(abciData, 'base64')
+        .toString()
+        .replace(/"/gi, '');
+    // Find the correct balance denomination
+    var balances = balancesRaw.split(',');
+    if (balances.length < 1) {
+        return 0;
+    }
+    // Find the correct denomination
+    var pattern = new RegExp("^(\\d+)".concat(denomination, "$"));
+    for (var _i = 0, balances_1 = balances; _i < balances_1.length; _i++) {
+        var balance = balances_1[_i];
+        var match = balance.match(pattern);
+        if (match) {
+            return parseInt(match[1], 10);
+        }
+    }
+    return 0;
+};
+exports.extractBalanceFromResponse = extractBalanceFromResponse;
+/**
+ * Extracts the account sequence from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+var extractSequenceFromResponse = function (abciData) {
+    // Make sure the response is initialized
+    if (!abciData) {
+        return 0;
+    }
+    try {
+        // Parse the account
+        var account = (0, requests_utility_1.parseABCI)(abciData);
+        return parseInt(account.BaseAccount.sequence, 10);
+    }
+    catch (e) { }
+    // Account not initialized,
+    // return default value (0)
+    return 0;
+};
+exports.extractSequenceFromResponse = extractSequenceFromResponse;
+/**
+ * Extracts the account number from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+var extractAccountNumberFromResponse = function (abciData) {
+    // Make sure the response is initialized
+    if (!abciData) {
+        throw new Error('account is not initialized');
+    }
+    try {
+        // Parse the account
+        var account = (0, requests_utility_1.parseABCI)(abciData);
+        return parseInt(account.BaseAccount.account_number, 10);
+    }
+    catch (e) {
+        throw new Error('account is not initialized');
+    }
+};
+exports.extractAccountNumberFromResponse = extractAccountNumberFromResponse;
+/**
+ * Waits for the transaction to be committed to a block in the chain
+ * of the specified provider. This helper does a search for incoming blocks
+ * and checks if a transaction
+ * @param {Provider} provider the provider instance
+ * @param {string} hash the base64-encoded hash of the transaction
+ * @param {number} [fromHeight=latest] the starting height for the search. If omitted, it is the latest block in the chain
+ * @param {number} [timeout=15000] the timeout in MS for the search
+ */
+var waitForTransaction = function (provider, hash, fromHeight, timeout) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
+                var currentHeight, _a, exitTimeout, fetchInterval;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            if (!fromHeight) return [3 /*break*/, 1];
+                            _a = fromHeight;
+                            return [3 /*break*/, 3];
+                        case 1: return [4 /*yield*/, provider.getBlockNumber()];
+                        case 2:
+                            _a = _b.sent();
+                            _b.label = 3;
+                        case 3:
+                            currentHeight = _a;
+                            exitTimeout = timeout ? timeout : 15000;
+                            fetchInterval = setInterval(function () { return __awaiter(void 0, void 0, void 0, function () {
+                                var latestHeight, blockNum, block, _i, _a, tx, txRaw, txHash;
+                                return __generator(this, function (_b) {
+                                    switch (_b.label) {
+                                        case 0: return [4 /*yield*/, provider.getBlockNumber()];
+                                        case 1:
+                                            latestHeight = _b.sent();
+                                            if (latestHeight < currentHeight) {
+                                                // No need to parse older blocks
+                                                return [2 /*return*/];
+                                            }
+                                            blockNum = currentHeight;
+                                            _b.label = 2;
+                                        case 2:
+                                            if (!(blockNum <= latestHeight)) return [3 /*break*/, 5];
+                                            return [4 /*yield*/, provider.getBlock(blockNum)];
+                                        case 3:
+                                            block = _b.sent();
+                                            // Check if there are any transactions at all in the block
+                                            if (!block.block.data.txs || block.block.data.txs.length == 0) {
+                                                return [3 /*break*/, 4];
+                                            }
+                                            // Find the transaction among the block transactions
+                                            for (_i = 0, _a = block.block.data.txs; _i < _a.length; _i++) {
+                                                tx = _a[_i];
+                                                txRaw = (0, requests_utility_1.base64ToUint8Array)(tx);
+                                                txHash = (0, crypto_1.sha256)(txRaw);
+                                                if ((0, requests_utility_1.uint8ArrayToBase64)(txHash) == hash) {
+                                                    // Clear the interval
+                                                    clearInterval(fetchInterval);
+                                                    // Decode the transaction from amino
+                                                    resolve(proto_1.Tx.decode(txRaw));
+                                                }
+                                            }
+                                            _b.label = 4;
+                                        case 4:
+                                            blockNum++;
+                                            return [3 /*break*/, 2];
+                                        case 5:
+                                            currentHeight = latestHeight + 1;
+                                            return [2 /*return*/];
+                                    }
+                                });
+                            }); }, 1000);
+                            setTimeout(function () {
+                                // Clear the fetch interval
+                                clearInterval(fetchInterval);
+                                reject('transaction fetch timeout');
+                            }, exitTimeout);
+                            return [2 /*return*/];
+                    }
+                });
+            }); })];
+    });
+}); };
+exports.waitForTransaction = waitForTransaction;

package/bin/provider/utility/requests.utility.d.ts

@@ -0,0 +1,33 @@
+import { RPCError, RPCRequest, RPCResponse } from '../types';
+/**
+ * Creates a new JSON-RPC 2.0 request
+ * @param {string} method the requested method
+ * @param {string[]} [params] the requested params, if any
+ */
+export declare const newRequest: (method: string, params?: any[]) => RPCRequest;
+/**
+ * Creates a new JSON-RPC 2.0 response
+ * @param {Result} result the response result, if any
+ * @param {RPCError} error the response error, if any
+ */
+export declare const newResponse: <Result>(result?: Result | undefined, error?: RPCError) => RPCResponse<Result>;
+/**
+ * Parses the base64 encoded ABCI JSON into a concrete type
+ * @param {string} data the base64-encoded JSON
+ */
+export declare const parseABCI: <Result>(data: string) => Result;
+/**
+ * Converts a string into base64 representation
+ * @param {string} str the raw string
+ */
+export declare const stringToBase64: (str: string) => string;
+/**
+ * Converts a base64 string into a Uint8Array representation
+ * @param {string} str the base64-encoded string
+ */
+export declare const base64ToUint8Array: (str: string) => Uint8Array;
+/**
+ * Converts a Uint8Array into base64 representation
+ * @param {Uint8Array} data the Uint8Array to be encoded
+ */
+export declare const uint8ArrayToBase64: (data: Uint8Array) => string;

package/bin/provider/utility/requests.utility.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uint8ArrayToBase64 = exports.base64ToUint8Array = exports.stringToBase64 = exports.parseABCI = exports.newResponse = exports.newRequest = void 0;
+// The version of the supported JSON-RPC protocol
+var standardVersion = '2.0';
+/**
+ * Creates a new JSON-RPC 2.0 request
+ * @param {string} method the requested method
+ * @param {string[]} [params] the requested params, if any
+ */
+var newRequest = function (method, params) {
+    return {
+        // the ID of the request is not that relevant for this helper method;
+        // for finer ID control, instantiate the request object directly
+        id: Date.now(),
+        jsonrpc: standardVersion,
+        method: method,
+        params: params,
+    };
+};
+exports.newRequest = newRequest;
+/**
+ * Creates a new JSON-RPC 2.0 response
+ * @param {Result} result the response result, if any
+ * @param {RPCError} error the response error, if any
+ */
+var newResponse = function (result, error) {
+    return {
+        id: Date.now(),
+        jsonrpc: standardVersion,
+        result: result,
+        error: error,
+    };
+};
+exports.newResponse = newResponse;
+/**
+ * Parses the base64 encoded ABCI JSON into a concrete type
+ * @param {string} data the base64-encoded JSON
+ */
+var parseABCI = function (data) {
+    var jsonData = Buffer.from(data, 'base64').toString();
+    var parsedData = JSON.parse(jsonData);
+    if (!parsedData) {
+        throw new Error('unable to parse JSON response');
+    }
+    return parsedData;
+};
+exports.parseABCI = parseABCI;
+/**
+ * Converts a string into base64 representation
+ * @param {string} str the raw string
+ */
+var stringToBase64 = function (str) {
+    var buffer = Buffer.from(str, 'utf-8');
+    return buffer.toString('base64');
+};
+exports.stringToBase64 = stringToBase64;
+/**
+ * Converts a base64 string into a Uint8Array representation
+ * @param {string} str the base64-encoded string
+ */
+var base64ToUint8Array = function (str) {
+    var buffer = Buffer.from(str, 'base64');
+    return new Uint8Array(buffer);
+};
+exports.base64ToUint8Array = base64ToUint8Array;
+/**
+ * Converts a Uint8Array into base64 representation
+ * @param {Uint8Array} data the Uint8Array to be encoded
+ */
+var uint8ArrayToBase64 = function (data) {
+    return Buffer.from(data).toString('base64');
+};
+exports.uint8ArrayToBase64 = uint8ArrayToBase64;

package/bin/provider/websocket/index.d.ts

@@ -0,0 +1 @@
+export * from './ws';

package/bin/provider/websocket/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ws"), exports);