@streamflow/common 6.0.2 → 6.0.3

package/dist/solana/utils.d.ts

@@ -1,6 +1,6 @@
 import { Mint } from "@solana/spl-token";
 import { SignerWalletAdapter } from "@solana/wallet-adapter-base";
-import { BlockhashWithExpiryBlockHeight, Commitment, Connection, Keypair, PublicKey, Transaction, TransactionInstruction } from "@solana/web3.js";
+import { BlockhashWithExpiryBlockHeight, Commitment, Connection, Keypair, PublicKey, Transaction, TransactionInstruction, SignatureStatus } from "@solana/web3.js";
 import { Account, AtaParams, ITransactionSolanaExt } from "./types";
 /**
  * Wrapper function for Solana web3 getProgramAccounts with slightly better call interface
@@ -39,17 +39,33 @@ export declare function prepareTransaction(connection: Connection, ixs: Transact
 export declare function signTransaction(invoker: Keypair | SignerWalletAdapter, tx: Transaction): Promise<Transaction>;
 /**
  * Signs, sends and confirms Transaction
+ * @param connection - Solana client connection
+ * @param invoker - Keypair used as signer
+ * @param tx - Transaction instance
+ * @param hash - blockhash information, the same hash should be used in the Transaction
+ * @returns Transaction signature
+ */
+export declare function signAndExecuteTransaction(connection: Connection, invoker: Keypair | SignerWalletAdapter, tx: Transaction, hash: BlockhashWithExpiryBlockHeight): Promise<string>;
+/**
+ * Sends and confirms Transaction
  * Confirmation strategy is not 100% reliable here as in times of congestion there can be a case that tx is executed,
  * but is not in `commitment` state and so it's not considered executed by the `sendAndConfirmRawTransaction` method,
  * and it raises an expiry error even though transaction may be executed soon.
- * So we add additional 50 blocks for checks to account for such issues.
+ * - so we add additional 50 blocks for checks to account for such issues;
+ * - also, we check for SignatureStatus one last time as it could be that websocket was slow to respond.
  * @param connection - Solana client connection
- * @param invoker - Keypair used as signer
  * @param tx - Transaction instance
  * @param hash - blockhash information, the same hash should be used in the Transaction
  * @returns Transaction signature
  */
-export declare function signAndExecuteTransaction(connection: Connection, invoker: Keypair | SignerWalletAdapter, tx: Transaction, hash: BlockhashWithExpiryBlockHeight): Promise<string>;
+export declare function executeTransaction(connection: Connection, tx: Transaction, hash: BlockhashWithExpiryBlockHeight): Promise<string>;
+/**
+ * Confirms and validates transaction success once
+ * @param connection - Solana client connection
+ * @param signature - Transaction signature
+ * @returns Transaction Status
+ */
+export declare function confirmAndEnsureTransaction(connection: Connection, signature: string): Promise<SignatureStatus | null>;
 /**
  * Shorthand call signature for getAssociatedTokenAddress, with allowance for address to be offCurve
  * @param {PublicKey} mint - SPL token Mint address.

package/dist/solana/utils.js

@@ -75,10 +75,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMintAndProgram = exports.prepareBaseInstructions = exports.checkOrCreateAtaBatch = exports.createAtaBatch = exports.generateCreateAtaBatchTx = exports.enrichAtaParams = exports.ataBatchExist = exports.ata = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isSignerKeypair = exports.isSignerWallet = exports.getProgramAccounts = void 0;
+exports.getMintAndProgram = exports.prepareBaseInstructions = exports.checkOrCreateAtaBatch = exports.createAtaBatch = exports.generateCreateAtaBatchTx = exports.enrichAtaParams = exports.ataBatchExist = exports.ata = exports.confirmAndEnsureTransaction = exports.executeTransaction = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isSignerKeypair = exports.isSignerWallet = exports.getProgramAccounts = void 0;
 var spl_token_1 = require("@solana/spl-token");
 var web3_js_1 = require("@solana/web3.js");
 var bs58_1 = __importDefault(require("bs58"));
+var utils_1 = require("../utils");
 /**
  * Wrapper function for Solana web3 getProgramAccounts with slightly better call interface
  * @param {Connection} connection - Solana web3 connection object.
@@ -195,10 +196,6 @@ function signTransaction(invoker, tx) {
 exports.signTransaction = signTransaction;
 /**
  * Signs, sends and confirms Transaction
- * Confirmation strategy is not 100% reliable here as in times of congestion there can be a case that tx is executed,
- * but is not in `commitment` state and so it's not considered executed by the `sendAndConfirmRawTransaction` method,
- * and it raises an expiry error even though transaction may be executed soon.
- * So we add additional 50 blocks for checks to account for such issues.
  * @param connection - Solana client connection
  * @param invoker - Keypair used as signer
  * @param tx - Transaction instance
@@ -207,26 +204,122 @@ exports.signTransaction = signTransaction;
  */
 function signAndExecuteTransaction(connection, invoker, tx, hash) {
     return __awaiter(this, void 0, void 0, function () {
-        var signedTx, rawTx, confirmationStrategy;
+        var signedTx;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, signTransaction(invoker, tx)];
                 case 1:
                     signedTx = _a.sent();
-                    rawTx = signedTx.serialize();
-                    if (!hash.lastValidBlockHeight || !signedTx.signature || !hash.blockhash)
+                    return [2 /*return*/, executeTransaction(connection, signedTx, hash)];
+            }
+        });
+    });
+}
+exports.signAndExecuteTransaction = signAndExecuteTransaction;
+/**
+ * Sends and confirms Transaction
+ * Confirmation strategy is not 100% reliable here as in times of congestion there can be a case that tx is executed,
+ * but is not in `commitment` state and so it's not considered executed by the `sendAndConfirmRawTransaction` method,
+ * and it raises an expiry error even though transaction may be executed soon.
+ * - so we add additional 50 blocks for checks to account for such issues;
+ * - also, we check for SignatureStatus one last time as it could be that websocket was slow to respond.
+ * @param connection - Solana client connection
+ * @param tx - Transaction instance
+ * @param hash - blockhash information, the same hash should be used in the Transaction
+ * @returns Transaction signature
+ */
+function executeTransaction(connection, tx, hash) {
+    return __awaiter(this, void 0, void 0, function () {
+        var rawTx, signature, confirmationStrategy, e_2, value;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    rawTx = tx.serialize();
+                    if (!hash.lastValidBlockHeight || !tx.signature || !hash.blockhash)
                         throw Error("Error with transaction parameters.");
+                    signature = bs58_1.default.encode(tx.signature);
                     confirmationStrategy = {
                         lastValidBlockHeight: hash.lastValidBlockHeight + 50,
-                        signature: bs58_1.default.encode(signedTx.signature),
+                        signature: signature,
                         blockhash: hash.blockhash,
                     };
-                    return [2 /*return*/, (0, web3_js_1.sendAndConfirmRawTransaction)(connection, rawTx, confirmationStrategy)];
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 7]);
+                    return [4 /*yield*/, (0, web3_js_1.sendAndConfirmRawTransaction)(connection, rawTx, confirmationStrategy)];
+                case 2: return [2 /*return*/, _a.sent()];
+                case 3:
+                    e_2 = _a.sent();
+                    if (!(e_2 instanceof web3_js_1.TransactionExpiredBlockheightExceededError)) return [3 /*break*/, 6];
+                    return [4 /*yield*/, (0, utils_1.sleep)(1000)];
+                case 4:
+                    _a.sent();
+                    return [4 /*yield*/, confirmAndEnsureTransaction(connection, signature)];
+                case 5:
+                    value = _a.sent();
+                    if (!value) {
+                        throw e_2;
+                    }
+                    return [2 /*return*/, signature];
+                case 6: throw e_2;
+                case 7: return [2 /*return*/];
             }
         });
     });
 }
-exports.signAndExecuteTransaction = signAndExecuteTransaction;
+exports.executeTransaction = executeTransaction;
+/**
+ * Confirms and validates transaction success once
+ * @param connection - Solana client connection
+ * @param signature - Transaction signature
+ * @returns Transaction Status
+ */
+function confirmAndEnsureTransaction(connection, signature) {
+    return __awaiter(this, void 0, void 0, function () {
+        var response, value;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, connection.getSignatureStatus(signature)];
+                case 1:
+                    response = _a.sent();
+                    if (!response) {
+                        return [2 /*return*/, null];
+                    }
+                    value = response.value;
+                    if (!value) {
+                        return [2 /*return*/, null];
+                    }
+                    if (value.err) {
+                        // That's how solana-web3js does it, `err` here is an object that won't really be handled
+                        throw new Error("Raw transaction ".concat(signature, " failed (").concat(JSON.stringify({ err: value.err }), ")"));
+                    }
+                    switch (connection.commitment) {
+                        case "confirmed":
+                        case "single":
+                        case "singleGossip": {
+                            if (value.confirmationStatus === "processed") {
+                                return [2 /*return*/, null];
+                            }
+                            break;
+                        }
+                        case "finalized":
+                        case "max":
+                        case "root": {
+                            if (value.confirmationStatus === "processed" || value.confirmationStatus === "confirmed") {
+                                return [2 /*return*/, null];
+                            }
+                            break;
+                        }
+                        // exhaust enums to ensure full coverage
+                        case "processed":
+                        case "recent":
+                    }
+                    return [2 /*return*/, value];
+            }
+        });
+    });
+}
+exports.confirmAndEnsureTransaction = confirmAndEnsureTransaction;
 /**
  * Shorthand call signature for getAssociatedTokenAddress, with allowance for address to be offCurve
  * @param {PublicKey} mint - SPL token Mint address.
@@ -385,8 +478,8 @@ exports.createAtaBatch = createAtaBatch;
  */
 function checkOrCreateAtaBatch(connection, owners, mint, invoker, programId) {
     return __awaiter(this, void 0, void 0, function () {
-        var ixs, atas, owners_1, owners_1_1, owner, _a, _b, e_2_1, response, i;
-        var e_2, _c;
+        var ixs, atas, owners_1, owners_1_1, owner, _a, _b, e_3_1, response, i;
+        var e_3, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
@@ -410,14 +503,14 @@ function checkOrCreateAtaBatch(connection, owners, mint, invoker, programId) {
                     return [3 /*break*/, 2];
                 case 5: return [3 /*break*/, 8];
                 case 6:
-                    e_2_1 = _d.sent();
-                    e_2 = { error: e_2_1 };
+                    e_3_1 = _d.sent();
+                    e_3 = { error: e_3_1 };
                     return [3 /*break*/, 8];
                 case 7:
                     try {
                         if (owners_1_1 && !owners_1_1.done && (_c = owners_1.return)) _c.call(owners_1);
                     }
-                    finally { if (e_2) throw e_2.error; }
+                    finally { if (e_3) throw e_3.error; }
                     return [7 /*endfinally*/];
                 case 8: return [4 /*yield*/, connection.getMultipleAccountsInfo(atas)];
                 case 9:

package/dist/utils.d.ts

@@ -20,3 +20,8 @@ export declare const getNumberFromBN: (value: BN, decimals: number) => number;
  * @returns {T}
  */
 export declare function handleContractError<T>(func: () => Promise<T>, callback?: (err: Error) => string | null): Promise<T>;
+/**
+ * Pause async function execution for given amount of milliseconds
+ * @param ms millisecond to sleep for
+ */
+export declare function sleep(ms: number): Promise<void>;

package/dist/utils.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleContractError = exports.getNumberFromBN = exports.getBN = void 0;
+exports.sleep = exports.handleContractError = exports.getNumberFromBN = exports.getBN = void 0;
 var bn_js_1 = __importDefault(require("bn.js"));
 var types_1 = require("./types");
 /**
@@ -97,3 +97,11 @@ function handleContractError(func, callback) {
     });
 }
 exports.handleContractError = handleContractError;
+/**
+ * Pause async function execution for given amount of milliseconds
+ * @param ms millisecond to sleep for
+ */
+function sleep(ms) {
+    return new Promise(function (resolve) { return setTimeout(resolve, ms); });
+}
+exports.sleep = sleep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "6.0.2",
+  "version": "6.0.3",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/index.js",
@@ -23,7 +23,7 @@
     "lint-config": "eslint --print-config",
     "prepublishOnly": "npm run lint && npm run build"
   },
-  "gitHead": "53a78cbfcb7053bf2b9b267ad8f678cade3e6fe1",
+  "gitHead": "d8f882dcb32394efb4ca997fff05e8c30128f14f",
   "devDependencies": {
     "@streamflow/eslint-config": "6.0.0",
     "@types/bn.js": "5.1.1",