@gnolang/tm2-js-client 1.0.5 → 1.1.0

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

@@ -1,6 +1,5 @@
 import { Provider } from '../provider';
-import { BlockInfo, BlockResult, ConsensusParams, NetworkInfo, Status } from '../types';
-import { TransactionEndpoint } from '../endpoints';
+import { BlockInfo, BlockResult, BroadcastTransactionMap, ConsensusParams, NetworkInfo, Status } from '../types';
 import { Tx } from '../../proto';
 /**
  * Provider based on JSON-RPC HTTP requests
@@ -23,7 +22,7 @@ export declare class JSONRPCProvider implements Provider {
     getAccountSequence(address: string, height?: number): Promise<number>;
     getAccountNumber(address: string, height?: number): Promise<number>;
     getStatus(): Promise<Status>;
-    sendTransaction(tx: string, endpoint?: TransactionEndpoint.BROADCAST_TX_SYNC | TransactionEndpoint.BROADCAST_TX_COMMIT): Promise<string>;
+    sendTransaction<K extends keyof BroadcastTransactionMap>(tx: string, endpoint: K): Promise<BroadcastTransactionMap[K]['result']>;
     private broadcastTxSync;
     private broadcastTxCommit;
     waitForTransaction(hash: string, fromHeight?: number, timeout?: number): Promise<Tx>;

package/bin/provider/jsonrpc/jsonrpc.js

@@ -195,18 +195,19 @@ var JSONRPCProvider = /** @class */ (function () {
     };
     JSONRPCProvider.prototype.sendTransaction = function (tx, endpoint) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryEndpoint, request;
+            var request;
             return __generator(this, function (_a) {
-                queryEndpoint = endpoint
-                    ? endpoint
-                    : endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC;
-                request = (0, utility_1.newRequest)(queryEndpoint, [tx]);
-                if (queryEndpoint == endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC) {
-                    return [2 /*return*/, this.broadcastTxSync(request)];
+                request = (0, utility_1.newRequest)(endpoint, [tx]);
+                switch (endpoint) {
+                    case endpoints_1.TransactionEndpoint.BROADCAST_TX_COMMIT:
+                        // The endpoint is a commit broadcast
+                        // (it waits for the transaction to be committed) to the chain before returning
+                        return [2 /*return*/, this.broadcastTxCommit(request)];
+                    case endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC:
+                    default:
+                        return [2 /*return*/, this.broadcastTxSync(request)];
                 }
-                // The endpoint is a commit broadcast
-                // (it waits for the transaction to be committed) to the chain before returning
-                return [2 /*return*/, this.broadcastTxCommit(request)];
+                return [2 /*return*/];
             });
         });
     };
@@ -227,7 +228,7 @@ var JSONRPCProvider = /** @class */ (function () {
                             log = response.Log;
                             throw (0, errors_utility_1.constructRequestError)(errType, log);
                         }
-                        return [2 /*return*/, response.hash];
+                        return [2 /*return*/, response];
                 }
             });
         });
@@ -255,7 +256,7 @@ var JSONRPCProvider = /** @class */ (function () {
                             log = deliver_tx.ResponseBase.Log;
                             throw (0, errors_utility_1.constructRequestError)(errType, log);
                         }
-                        return [2 /*return*/, response.hash];
+                        return [2 /*return*/, response];
                 }
             });
         });

package/bin/provider/jsonrpc/jsonrpc.test.js

@@ -130,7 +130,7 @@ describe('JSON-RPC Provider', function () {
             [validResult, validResult.hash, '', ''],
             [invalidResult, invalidResult.hash, messages_1.UnauthorizedErrorMessage, mockLog], // error out
         ])('case %#', function (response, expectedHash, expectedErr, expectedLog) { return __awaiter(void 0, void 0, void 0, function () {
-            var provider, hash, e_1;
+            var provider, tx, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -141,11 +141,11 @@ describe('JSON-RPC Provider', function () {
                     case 1:
                         _a.trys.push([1, 3, , 4]);
                         provider = new jsonrpc_1.JSONRPCProvider(mockURL);
-                        return [4 /*yield*/, provider.sendTransaction('encoded tx')];
+                        return [4 /*yield*/, provider.sendTransaction('encoded tx', endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC)];
                     case 2:
-                        hash = _a.sent();
+                        tx = _a.sent();
                         expect(axios_1.default.post).toHaveBeenCalled();
-                        expect(hash).toEqual(expectedHash);
+                        expect(tx.hash).toEqual(expectedHash);
                         if (expectedErr != '') {
                             fail('expected error');
                         }

package/bin/provider/provider.d.ts

@@ -1,6 +1,5 @@
-import { BlockInfo, BlockResult, ConsensusParams, NetworkInfo, Status } from './types';
+import { BlockInfo, BlockResult, BroadcastAsGeneric, BroadcastTransactionMap, ConsensusParams, NetworkInfo, Status } from './types';
 import { Tx } from '../proto';
-import { TransactionEndpoint } from './endpoints';
 /**
  * Read-only abstraction for accessing blockchain data
  */
@@ -65,14 +64,14 @@ export interface Provider {
      */
     estimateGas(tx: Tx): Promise<number>;
     /**
-     * Sends the transaction to the node for committing.
+     * Sends the transaction to the node. If the type of endpoint
+     * is a broadcast commit, waits for the transaction to be committed to the chain.
      * The transaction needs to be signed beforehand.
-     * Returns the transaction hash
+     * Returns the transaction broadcast result.
      * @param {string} tx the base64-encoded signed transaction
-     * @param {TransactionEndpoint} endpoint the transaction broadcast type (sync / commit).
-     * Defaults to broadcast_sync
+     * @param {BroadcastType} endpoint the transaction broadcast type (sync / commit)
      */
-    sendTransaction(tx: string, endpoint?: TransactionEndpoint.BROADCAST_TX_SYNC | TransactionEndpoint.BROADCAST_TX_COMMIT): Promise<string>;
+    sendTransaction<K extends keyof BroadcastTransactionMap>(tx: string, endpoint: K): Promise<BroadcastAsGeneric<K>['result']>;
     /**
      * Waits for the transaction to be committed on the chain.
      * NOTE: This method will not take in the fromHeight parameter once

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

@@ -1,4 +1,5 @@
 import { ABCIResponseBase } from './abci';
+import { TransactionEndpoint } from '../endpoints';
 export interface NetworkInfo {
     listening: boolean;
     listeners: string[];
@@ -157,4 +158,20 @@ export interface BroadcastTxCommitResult {
     hash: string;
     height: string;
 }
+export type BroadcastType = TransactionEndpoint.BROADCAST_TX_SYNC | TransactionEndpoint.BROADCAST_TX_COMMIT;
+export type BroadcastTransactionSync = {
+    endpoint: TransactionEndpoint.BROADCAST_TX_SYNC;
+    result: BroadcastTxSyncResult;
+};
+export type BroadcastTransactionCommit = {
+    endpoint: TransactionEndpoint.BROADCAST_TX_COMMIT;
+    result: BroadcastTxCommitResult;
+};
+export type BroadcastTransactionMap = {
+    [TransactionEndpoint.BROADCAST_TX_COMMIT]: BroadcastTransactionCommit;
+    [TransactionEndpoint.BROADCAST_TX_SYNC]: BroadcastTransactionSync;
+};
+export type BroadcastAsGeneric<K extends keyof BroadcastTransactionMap = keyof BroadcastTransactionMap> = {
+    [P in K]: BroadcastTransactionMap[P];
+}[K];
 export {};

package/bin/provider/types/common.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var endpoints_1 = require("../endpoints");

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

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { Provider } from '../provider';
-import { BlockInfo, BlockResult, ConsensusParams, NetworkInfo, RPCRequest, RPCResponse, Status } from '../types';
-import { TransactionEndpoint } from '../endpoints';
+import { BlockInfo, BlockResult, BroadcastTransactionMap, ConsensusParams, NetworkInfo, RPCRequest, RPCResponse, Status } from '../types';
 import { Tx } from '../../proto';
 /**
  * Provider based on WS JSON-RPC HTTP requests
@@ -51,7 +50,7 @@ export declare class WSProvider implements Provider {
     getAccountSequence(address: string, height?: number): Promise<number>;
     getAccountNumber(address: string, height?: number): Promise<number>;
     getStatus(): Promise<Status>;
-    sendTransaction(tx: string, endpoint?: TransactionEndpoint.BROADCAST_TX_SYNC | TransactionEndpoint.BROADCAST_TX_COMMIT): Promise<string>;
+    sendTransaction<K extends keyof BroadcastTransactionMap>(tx: string, endpoint: K): Promise<BroadcastTransactionMap[K]['result']>;
     private broadcastTxSync;
     private broadcastTxCommit;
     waitForTransaction(hash: string, fromHeight?: number, timeout?: number): Promise<Tx>;

package/bin/provider/websocket/ws.js

@@ -285,18 +285,19 @@ var WSProvider = /** @class */ (function () {
     };
     WSProvider.prototype.sendTransaction = function (tx, endpoint) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryEndpoint, request;
+            var request;
             return __generator(this, function (_a) {
-                queryEndpoint = endpoint
-                    ? endpoint
-                    : endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC;
-                request = (0, utility_1.newRequest)(queryEndpoint, [tx]);
-                if (queryEndpoint == endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC) {
-                    return [2 /*return*/, this.broadcastTxSync(request)];
+                request = (0, utility_1.newRequest)(endpoint, [tx]);
+                switch (endpoint) {
+                    case endpoints_1.TransactionEndpoint.BROADCAST_TX_COMMIT:
+                        // The endpoint is a commit broadcast
+                        // (it waits for the transaction to be committed) to the chain before returning
+                        return [2 /*return*/, this.broadcastTxCommit(request)];
+                    case endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC:
+                    default:
+                        return [2 /*return*/, this.broadcastTxSync(request)];
                 }
-                // The endpoint is a commit broadcast
-                // (it waits for the transaction to be committed) to the chain before returning
-                return [2 /*return*/, this.broadcastTxCommit(request)];
+                return [2 /*return*/];
             });
         });
     };
@@ -316,7 +317,7 @@ var WSProvider = /** @class */ (function () {
                             log = broadcastResponse.Log;
                             throw (0, errors_utility_1.constructRequestError)(errType, log);
                         }
-                        return [2 /*return*/, broadcastResponse.hash];
+                        return [2 /*return*/, broadcastResponse];
                 }
             });
         });
@@ -343,7 +344,7 @@ var WSProvider = /** @class */ (function () {
                             log = deliver_tx.ResponseBase.Log;
                             throw (0, errors_utility_1.constructRequestError)(errType, log);
                         }
-                        return [2 /*return*/, broadcastResponse.hash];
+                        return [2 /*return*/, broadcastResponse];
                 }
             });
         });

package/bin/provider/websocket/ws.test.js

@@ -358,7 +358,7 @@ describe('WS Provider', function () {
             [validResult, validResult.hash, '', ''],
             [invalidResult, invalidResult.hash, messages_1.UnauthorizedErrorMessage, mockLog], // error out
         ])('case %#', function (response, expectedHash, expectedErr, expectedLog) { return __awaiter(void 0, void 0, void 0, function () {
-            var hash, e_2;
+            var tx, e_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, setHandler(response)];
@@ -367,10 +367,10 @@ describe('WS Provider', function () {
                         _a.label = 2;
                     case 2:
                         _a.trys.push([2, 4, , 5]);
-                        return [4 /*yield*/, wsProvider.sendTransaction('encoded tx')];
+                        return [4 /*yield*/, wsProvider.sendTransaction('encoded tx', endpoints_1.TransactionEndpoint.BROADCAST_TX_SYNC)];
                     case 3:
-                        hash = _a.sent();
-                        expect(hash).toEqual(expectedHash);
+                        tx = _a.sent();
+                        expect(tx.hash).toEqual(expectedHash);
                         if (expectedErr != '') {
                             fail('expected error');
                         }

package/bin/wallet/wallet.d.ts

@@ -1,4 +1,4 @@
-import { Provider } from '../provider';
+import { BroadcastTransactionMap, Provider } from '../provider';
 import { Signer } from './signer';
 import { LedgerConnector } from '@cosmjs/ledger-amino';
 import { Any, Tx } from '../proto';
@@ -81,12 +81,14 @@ export declare class Wallet {
      */
     signTransaction: (tx: Tx, decodeTxMessages: (messages: Any[]) => any[]) => Promise<Tx>;
     /**
-     * Encodes and sends the transaction.
+     * Encodes and sends the transaction. If the type of endpoint
+     * is a broadcast commit, waits for the transaction to be committed to the chain.
      * The transaction needs to be signed beforehand.
      * Returns the transaction hash (base-64)
      * @param {Tx} tx the signed transaction
+     * @param {BroadcastType} endpoint the transaction broadcast type (sync / commit)
      */
-    sendTransaction: (tx: Tx) => Promise<string>;
+    sendTransaction<K extends keyof BroadcastTransactionMap>(tx: Tx, endpoint: K): Promise<BroadcastTransactionMap[K]['result']>;
     /**
      * Returns the associated signer
      */

package/bin/wallet/wallet.js

@@ -244,12 +244,22 @@ var Wallet = /** @class */ (function () {
             });
         }); };
         /**
-         * Encodes and sends the transaction.
-         * The transaction needs to be signed beforehand.
-         * Returns the transaction hash (base-64)
-         * @param {Tx} tx the signed transaction
+         * Returns the associated signer
          */
-        this.sendTransaction = function (tx) { return __awaiter(_this, void 0, void 0, function () {
+        this.getSigner = function () {
+            return _this.signer;
+        };
+    }
+    /**
+     * Encodes and sends the transaction. If the type of endpoint
+     * is a broadcast commit, waits for the transaction to be committed to the chain.
+     * The transaction needs to be signed beforehand.
+     * Returns the transaction hash (base-64)
+     * @param {Tx} tx the signed transaction
+     * @param {BroadcastType} endpoint the transaction broadcast type (sync / commit)
+     */
+    Wallet.prototype.sendTransaction = function (tx, endpoint) {
+        return __awaiter(this, void 0, void 0, function () {
             var encodedTx;
             return __generator(this, function (_b) {
                 if (!this.provider) {
@@ -257,16 +267,10 @@ var Wallet = /** @class */ (function () {
                 }
                 encodedTx = (0, provider_1.uint8ArrayToBase64)(proto_1.Tx.encode(tx).finish());
                 // Send the encoded transaction
-                return [2 /*return*/, this.provider.sendTransaction(encodedTx)];
+                return [2 /*return*/, this.provider.sendTransaction(encodedTx, endpoint)];
             });
-        }); };
-        /**
-         * Returns the associated signer
-         */
-        this.getSigner = function () {
-            return _this.signer;
-        };
-    }
+        });
+    };
     var _a;
     _a = Wallet;
     // Wallet initialization //

package/bin/wallet/wallet.test.js

@@ -39,6 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+var provider_1 = require("../provider");
 var jest_mock_extended_1 = require("jest-mock-extended");
 var wallet_1 = require("./wallet");
 var crypto_1 = require("@cosmjs/crypto");
@@ -298,7 +299,7 @@ describe('Wallet', function () {
         });
     }); });
     test('sendTransaction', function () { return __awaiter(void 0, void 0, void 0, function () {
-        var mockTx, mockTxHash, mockStatus, mockProvider, wallet, txHash;
+        var mockTx, mockTxHash, mockStatus, mockTransaction, mockProvider, wallet, tx;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -325,19 +326,25 @@ describe('Wallet', function () {
                         },
                         network: 'testchain',
                     };
+                    mockTransaction = {
+                        error: null,
+                        data: null,
+                        Log: '',
+                        hash: mockTxHash,
+                    };
                     mockProvider = (0, jest_mock_extended_1.mock)();
                     mockProvider.getStatus.mockResolvedValue(mockStatus);
                     mockProvider.getAccountNumber.mockResolvedValue(10);
                     mockProvider.getAccountSequence.mockResolvedValue(10);
-                    mockProvider.sendTransaction.mockResolvedValue(mockTxHash);
+                    mockProvider.sendTransaction.mockResolvedValue(mockTransaction);
                     return [4 /*yield*/, wallet_1.Wallet.createRandom()];
                 case 1:
                     wallet = _a.sent();
                     wallet.connect(mockProvider);
-                    return [4 /*yield*/, wallet.sendTransaction(mockTx)];
+                    return [4 /*yield*/, wallet.sendTransaction(mockTx, provider_1.TransactionEndpoint.BROADCAST_TX_SYNC)];
                 case 2:
-                    txHash = _a.sent();
-                    expect(txHash).toBe(mockTxHash);
+                    tx = _a.sent();
+                    expect(tx.hash).toBe(mockTxHash);
                     return [2 /*return*/];
             }
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnolang/tm2-js-client",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Tendermint2 JS / TS Client",
   "main": "./bin/index.js",
   "repository": {