@firmachain/firma-js 0.3.5 → 0.3.6

package/dist/sdk/firmachain/common/SigningStargateClient.js

@@ -0,0 +1,322 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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 };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SigningStargateClient = exports.defaultRegistryTypes = void 0;
+var encoding_1 = require("@cosmjs/encoding");
+var proto_signing_1 = require("@cosmjs/proto-signing");
+var tendermint_rpc_1 = require("@cosmjs/tendermint-rpc");
+var coin_1 = require("cosmjs-types/cosmos/base/v1beta1/coin");
+var tx_1 = require("cosmjs-types/cosmos/tx/v1beta1/tx");
+var keys_1 = require("cosmjs-types/cosmos/crypto/secp256k1/keys");
+var axios_1 = __importDefault(require("axios"));
+var accounts_1 = require("./accounts");
+var StargateClient_1 = require("./StargateClient");
+var any_1 = require("cosmjs-types/google/protobuf/any");
+var modules_1 = require("@cosmjs/stargate/build/modules");
+var signing_1 = require("./signing");
+exports.defaultRegistryTypes = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([
+    ["/cosmos.base.v1beta1.Coin", coin_1.Coin]
+], __read(modules_1.authzTypes), false), __read(modules_1.bankTypes), false), __read(modules_1.distributionTypes), false), __read(modules_1.feegrantTypes), false), __read(modules_1.govTypes), false), __read(modules_1.groupTypes), false), __read(modules_1.stakingTypes), false), __read(modules_1.ibcTypes), false), __read(modules_1.vestingTypes), false);
+var SigningStargateClient = /** @class */ (function (_super) {
+    __extends(SigningStargateClient, _super);
+    function SigningStargateClient(cometClient, signer, options) {
+        var _this = _super.call(this, cometClient, options) || this;
+        var _a = options.registry, registry = _a === void 0 ? new proto_signing_1.Registry(exports.defaultRegistryTypes) : _a;
+        _this.registry = registry;
+        _this.signer = signer;
+        return _this;
+    }
+    SigningStargateClient.connectWithSigner = function (endpoint, signer, options) {
+        if (options === void 0) { options = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var cometClient;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, tendermint_rpc_1.connectComet)(endpoint)];
+                    case 1:
+                        cometClient = _a.sent();
+                        return [2 /*return*/, SigningStargateClient.createWithSigner(cometClient, signer, options)];
+                }
+            });
+        });
+    };
+    SigningStargateClient.createWithSigner = function (cometClient, signer, options) {
+        if (options === void 0) { options = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, new SigningStargateClient(cometClient, signer, options)];
+            });
+        });
+    };
+    SigningStargateClient.prototype.signAndBroadcast = function (signerAddress, messages, fee, memo) {
+        if (memo === void 0) { memo = ""; }
+        return __awaiter(this, void 0, void 0, function () {
+            var txRaw, txBytes;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(signerAddress, messages, fee, memo)];
+                    case 1:
+                        txRaw = _a.sent();
+                        txBytes = tx_1.TxRaw.encode(txRaw).finish();
+                        return [2 /*return*/, this.broadcastTx(txBytes)];
+                }
+            });
+        });
+    };
+    SigningStargateClient.makeSignDocForSend = function (signerAddress, pubkeyStr, messages, fee, memo, serverUrl, chainId, registry) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, accountNumber, sequence, account, pubkeyBytes, pubkey, pubkeyAny, anyMsgs, txBody, bodyBytes, authInfoBytes;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        SigningStargateClient._endpoint = serverUrl;
+                        return [4 /*yield*/, SigningStargateClient.getSequence(signerAddress)];
+                    case 1:
+                        _a = _b.sent(), accountNumber = _a.accountNumber, sequence = _a.sequence;
+                        return [4 /*yield*/, SigningStargateClient.getAccount(signerAddress)];
+                    case 2:
+                        account = _b.sent();
+                        if (account == null)
+                            throw new Error("Failed to retrieve account from signer");
+                        pubkeyBytes = (0, encoding_1.fromBase64)(pubkeyStr);
+                        pubkey = keys_1.PubKey.fromPartial({
+                            key: pubkeyBytes,
+                        });
+                        pubkeyAny = {
+                            typeUrl: "/cosmos.crypto.secp256k1.PubKey",
+                            value: keys_1.PubKey.encode(pubkey).finish(),
+                        };
+                        anyMsgs = messages.map(function (msg) { return registry.encodeAsAny(msg); });
+                        txBody = tx_1.TxBody.fromPartial({
+                            messages: anyMsgs,
+                            memo: memo,
+                        });
+                        bodyBytes = tx_1.TxBody.encode(txBody).finish();
+                        authInfoBytes = (0, signing_1.makeAuthInfoBytesProtobuf)([{ pubkey: pubkeyAny, sequence: sequence }], fee.amount, fee.gasLimit, fee.granter, fee.payer);
+                        return [2 /*return*/, (0, signing_1.makeSignDocProtobuf)(bodyBytes, authInfoBytes, chainId, accountNumber)];
+                }
+            });
+        });
+    };
+    SigningStargateClient.prototype.sign = function (signerAddress, messages, fee, memo, explicitSignerData) {
+        return __awaiter(this, void 0, void 0, function () {
+            var signerData, _a, accountNumber, sequence, chainId;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!explicitSignerData) return [3 /*break*/, 1];
+                        signerData = explicitSignerData;
+                        return [3 /*break*/, 4];
+                    case 1: return [4 /*yield*/, this.getSequence(signerAddress)];
+                    case 2:
+                        _a = _b.sent(), accountNumber = _a.accountNumber, sequence = _a.sequence;
+                        return [4 /*yield*/, this.getChainId()];
+                    case 3:
+                        chainId = _b.sent();
+                        signerData = {
+                            accountNumber: accountNumber,
+                            sequence: sequence,
+                            chainId: chainId,
+                        };
+                        _b.label = 4;
+                    case 4: return [2 /*return*/, this.signDirect(signerAddress, messages, fee, memo, signerData)];
+                }
+            });
+        });
+    };
+    SigningStargateClient.prototype.signDirect = function (signerAddress, messages, fee, memo, _a) {
+        var accountNumber = _a.accountNumber, sequence = _a.sequence, chainId = _a.chainId;
+        return __awaiter(this, void 0, void 0, function () {
+            var accountFromSigner, pubkey, pubkeyAny, anyMsgs, txBody, bodyBytes, authInfoBytes, signDoc, _b, signature, signed;
+            var _this = this;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, this.signer.getAccounts()];
+                    case 1:
+                        accountFromSigner = (_c.sent()).find(function (account) { return account.address === signerAddress; });
+                        if (!accountFromSigner) {
+                            throw new Error("Failed to retrieve account from signer");
+                        }
+                        pubkey = keys_1.PubKey.fromPartial({
+                            key: accountFromSigner.pubkey,
+                        });
+                        pubkeyAny = {
+                            typeUrl: "/cosmos.crypto.secp256k1.PubKey",
+                            value: keys_1.PubKey.encode(pubkey).finish(),
+                        };
+                        anyMsgs = messages.map(function (msg) { return _this.registry.encodeAsAny(msg); });
+                        txBody = tx_1.TxBody.fromPartial({
+                            messages: anyMsgs,
+                            memo: memo,
+                        });
+                        bodyBytes = tx_1.TxBody.encode(txBody).finish();
+                        authInfoBytes = (0, signing_1.makeAuthInfoBytesProtobuf)([{ pubkey: pubkeyAny, sequence: sequence }], fee.amount, fee.gasLimit, fee.granter, fee.payer);
+                        signDoc = (0, signing_1.makeSignDocProtobuf)(bodyBytes, authInfoBytes, chainId, accountNumber);
+                        return [4 /*yield*/, this.signer.signDirect(signerAddress, signDoc)];
+                    case 2:
+                        _b = _c.sent(), signature = _b.signature, signed = _b.signed;
+                        return [2 /*return*/, tx_1.TxRaw.fromPartial({
+                                bodyBytes: signed.bodyBytes,
+                                authInfoBytes: signed.authInfoBytes,
+                                signatures: [(0, encoding_1.fromBase64)(signature.signature)],
+                            })];
+                }
+            });
+        });
+    };
+    SigningStargateClient.prototype.signDirectForSignDoc = function (signerAddress, signDoc) {
+        return __awaiter(this, void 0, void 0, function () {
+            var accountFromSigner, _a, signature, signed, txRaw;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.signer.getAccounts()];
+                    case 1:
+                        accountFromSigner = (_b.sent()).find(function (account) { return account.address === signerAddress; });
+                        if (!accountFromSigner) {
+                            throw new Error("Failed to retrieve account from signer");
+                        }
+                        return [4 /*yield*/, this.signer.signDirect(signerAddress, signDoc)];
+                    case 2:
+                        _a = _b.sent(), signature = _a.signature, signed = _a.signed;
+                        txRaw = tx_1.TxRaw.fromPartial({
+                            bodyBytes: signed.bodyBytes,
+                            authInfoBytes: signed.authInfoBytes,
+                            signatures: [(0, encoding_1.fromBase64)(signature.signature)],
+                        });
+                        return [2 /*return*/, { txRaw: txRaw, signature: signature.signature }];
+                }
+            });
+        });
+    };
+    SigningStargateClient.getSequence = function (address) {
+        return __awaiter(this, void 0, void 0, function () {
+            var account;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAccount(address)];
+                    case 1:
+                        account = _a.sent();
+                        if (!account) {
+                            throw new Error("Account does not exist on chain. Send some tokens there before trying to query sequence.");
+                        }
+                        return [2 /*return*/, {
+                                accountNumber: account.accountNumber,
+                                sequence: account.sequence,
+                            }];
+                }
+            });
+        });
+    };
+    SigningStargateClient.getAccount = function (address) {
+        return __awaiter(this, void 0, void 0, function () {
+            var accAddress, hexAccAddress, axiosInstance, path, result, finalData, account, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        accAddress = (0, encoding_1.fromBech32)(address).data;
+                        hexAccAddress = "0x01".concat(Buffer.from(accAddress).toString("hex"));
+                        axiosInstance = axios_1.default.create({
+                            baseURL: SigningStargateClient._endpoint,
+                            headers: {
+                                Accept: "application/json",
+                            },
+                            timeout: 15000
+                        });
+                        path = "/abci_query?path=\"/store/acc/key\"";
+                        return [4 /*yield*/, axiosInstance.get(path, { params: { data: hexAccAddress } })];
+                    case 1:
+                        result = _a.sent();
+                        finalData = result.data.result.response.value;
+                        account = any_1.Any.decode(Buffer.from(finalData, "base64"));
+                        return [2 /*return*/, (0, accounts_1.accountFromAny)(account)];
+                    case 2:
+                        error_1 = _a.sent();
+                        return [2 /*return*/, null];
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    SigningStargateClient._endpoint = "";
+    return SigningStargateClient;
+}(StargateClient_1.StargateClient));
+exports.SigningStargateClient = SigningStargateClient;

package/dist/sdk/firmachain/common/StargateClient.d.ts

@@ -0,0 +1,161 @@
+import { CometClient, HttpEndpoint } from "@cosmjs/tendermint-rpc";
+import { AuthExtension, BankExtension, QueryClient, StakingExtension, TxExtension } from "@cosmjs/stargate";
+import { Account, AccountParser } from "./accounts";
+import { Event } from "./events";
+export declare class TimeoutError extends Error {
+    readonly txId: string;
+    constructor(message: string, txId: string);
+}
+export interface BlockHeader {
+    readonly version: {
+        readonly block: string;
+        readonly app: string;
+    };
+    readonly height: number;
+    readonly chainId: string;
+    /** An RFC 3339 time string like e.g. '2020-02-15T10:39:10.4696305Z' */
+    readonly time: string;
+}
+export interface Block {
+    /** The ID is a hash of the block header (uppercase hex) */
+    readonly id: string;
+    readonly header: BlockHeader;
+    /** Array of raw transactions */
+    readonly txs: readonly Uint8Array[];
+}
+/** A transaction that is indexed as part of the transaction history */
+export interface IndexedTx {
+    readonly height: number;
+    /** The position of the transaction within the block. This is a 0-based index. */
+    readonly txIndex: number;
+    /** Transaction hash (might be used as transaction ID). Guaranteed to be non-empty upper-case hex */
+    readonly hash: string;
+    /** Transaction execution error code. 0 on success. */
+    readonly code: number;
+    readonly events: readonly Event[];
+    /**
+     * Raw transaction bytes stored in Tendermint.
+     *
+     * If you hash this, you get the transaction hash (= transaction ID):
+     *
+     * ```js
+     * import { sha256 } from "@cosmjs/crypto";
+     * import { toHex } from "@cosmjs/encoding";
+     *
+     * const transactionId = toHex(sha256(indexTx.tx)).toUpperCase();
+     * ```
+     *
+     * Use `decodeTxRaw` from @cosmjs/proto-signing to decode this.
+     */
+    readonly tx: Uint8Array;
+    /**
+     * The message responses extracted from events.
+     * This field contains structured message response data parsed from transaction events.
+     */
+    readonly msgResponses: Array<{
+        readonly typeUrl: string;
+        readonly value: Uint8Array;
+    }>;
+    readonly gasUsed: bigint;
+    readonly gasWanted: bigint;
+}
+export interface SequenceResponse {
+    readonly accountNumber: number;
+    readonly sequence: number;
+}
+/**
+ * The response after successfully broadcasting a transaction.
+ * Success or failure refer to the execution result.
+ */
+export interface DeliverTxResponse {
+    readonly height: number;
+    /** The position of the transaction within the block. This is a 0-based index. */
+    readonly txIndex: number;
+    /** Error code. The transaction suceeded if and only if code is 0. */
+    readonly code: number;
+    readonly transactionHash: string;
+    readonly events: readonly Event[];
+    /**
+     * The message responses extracted from events.
+     * This field contains structured message response data parsed from transaction events.
+     */
+    readonly msgResponses: Array<{
+        readonly typeUrl: string;
+        readonly value: Uint8Array;
+    }>;
+    readonly gasUsed: bigint;
+    readonly gasWanted: bigint;
+}
+export type BroadcastTxResponse = DeliverTxResponse;
+export declare function isDeliverTxFailure(result: DeliverTxResponse): boolean;
+export declare function isDeliverTxSuccess(result: DeliverTxResponse): boolean;
+export declare function isBroadcastTxFailure(result: BroadcastTxResponse): boolean;
+export declare function isBroadcastTxSuccess(result: BroadcastTxResponse): boolean;
+/**
+ * Ensures the given result is a success. Throws a detailed error message otherwise.
+ */
+export declare function assertIsDeliverTxSuccess(result: DeliverTxResponse): void;
+/**
+ * Ensures the given result is a failure. Throws a detailed error message otherwise.
+ */
+export declare function assertIsDeliverTxFailure(result: DeliverTxResponse): void;
+/**
+ * An error when broadcasting the transaction. This contains the CheckTx errors
+ * from the blockchain. Once a transaction is included in a block no BroadcastTxError
+ * is thrown, even if the execution fails (DeliverTx errors).
+ */
+export declare class BroadcastTxError extends Error {
+    readonly code: number;
+    readonly codespace: string;
+    readonly log: string | undefined;
+    constructor(code: number, codespace: string, log: string | undefined);
+}
+/** Use for testing only */
+export interface PrivateStargateClient {
+    readonly cometClient: CometClient | undefined;
+}
+export interface StargateClientOptions {
+    readonly accountParser?: AccountParser;
+}
+export declare class StargateClient {
+    private readonly cometClient;
+    private readonly queryClient;
+    private chainId;
+    private readonly accountParser;
+    /**
+     * Creates an instance by connecting to the given CometBFT RPC endpoint.
+     *
+     * This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client.
+     * To set the Comet client explicitly, use `create`.
+     */
+    static connect(endpoint: string | HttpEndpoint, options?: StargateClientOptions): Promise<StargateClient>;
+    /**
+     * Creates an instance from a manually created Comet client.
+     * Use this to use `Comet38Client` or `Tendermint37Client` instead of `Tendermint34Client`.
+     */
+    static create(cometClient: CometClient, options?: StargateClientOptions): Promise<StargateClient>;
+    protected constructor(cometClient: CometClient | undefined, options?: StargateClientOptions);
+    protected getCometClient(): CometClient | undefined;
+    protected forceGetCometClient(): CometClient;
+    protected getQueryClient(): (QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension) | undefined;
+    protected forceGetQueryClient(): QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension;
+    getChainId(): Promise<string>;
+    getHeight(): Promise<number>;
+    getAccount(searchAddress: string): Promise<Account | null>;
+    getSequence(address: string): Promise<SequenceResponse>;
+    getTx(id: string): Promise<IndexedTx | null>;
+    disconnect(): void;
+    /**
+     * Broadcasts a signed transaction to the network and monitors its inclusion in a block.
+     *
+     * If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure),
+     * an error is thrown.
+     *
+     * If the transaction is not included in a block before the provided timeout, this errors with a `TimeoutError`.
+     *
+     * If the transaction is included in a block, a `DeliverTxResponse` is returned. The caller then
+     * usually needs to check for execution success or failure.
+     */
+    broadcastTx(tx: Uint8Array, timeoutMs?: number, pollIntervalMs?: number): Promise<DeliverTxResponse>;
+    private txsQuery;
+}