@streamflow/common 6.1.0 → 6.1.2

package/dist/solana/types.d.ts

@@ -26,4 +26,5 @@ export interface ConfirmationParams {
     commitment?: Commitment;
 }
 export declare class TransactionFailedError extends Error {
+    constructor(m: string);
 }

package/dist/solana/types.js

@@ -18,8 +18,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransactionFailedError = void 0;
 var TransactionFailedError = /** @class */ (function (_super) {
     __extends(TransactionFailedError, _super);
-    function TransactionFailedError() {
-        return _super !== null && _super.apply(this, arguments) || this;
+    function TransactionFailedError(m) {
+        var _this = _super.call(this, m) || this;
+        Object.setPrototypeOf(_this, TransactionFailedError.prototype);
+        _this.name = "TransactionFailedError";
+        return _this;
     }
     return TransactionFailedError;
 }(Error));

package/dist/solana/utils.d.ts

@@ -64,20 +64,29 @@ export declare function signAndExecuteTransaction(connection: Connection, invoke
  * - otherwise there is a chance of marking a landed tx as failed if it was broadcasted at least once
  * @param connection - Solana client connection
  * @param tx - Transaction instance
+ * @param {ConfirmationParams} confirmationParams - Confirmation Params that will be used for execution
+ * @returns Transaction signature
+ */
+export declare function executeTransaction(connection: Connection, tx: Transaction | VersionedTransaction, confirmationParams: ConfirmationParams): Promise<string>;
+/**
+ * Sends and confirm transaction in a loop, constantly re-broadcsting the tx until Blockheight expires.
+ * - we add additional 30 bocks to account for validators in an PRC pool divergence
+ * @param connection - Solana client connection
+ * @param tx - Transaction instance
  * @param hash - blockhash information, the same hash should be used in the Transaction
  * @param context - context at which blockhash has been retrieve
  * @param commitment - optional commitment that will be used for simulation and confirmation
- * @returns Transaction signature
  */
-export declare function executeTransaction(connection: Connection, tx: Transaction | VersionedTransaction, { hash, context, commitment }: ConfirmationParams): Promise<string>;
+export declare function sendAndConfirmTransaction(connection: Connection, tx: Transaction | VersionedTransaction, { hash, context, commitment }: ConfirmationParams): Promise<string>;
+export declare function simulateTransaction(connection: Connection, tx: Transaction | VersionedTransaction): Promise<void>;
 /**
  * Confirms and validates transaction success once
  * @param connection - Solana client connection
  * @param signature - Transaction signature
- * @param passError - return status even if tx failed
+ * @param ignoreError - return status even if tx failed
  * @returns Transaction Status
  */
-export declare function confirmAndEnsureTransaction(connection: Connection, signature: string, passError?: boolean): Promise<SignatureStatus | null>;
+export declare function confirmAndEnsureTransaction(connection: Connection, signature: string, ignoreError?: boolean): 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

@@ -50,12 +50,13 @@ 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.confirmAndEnsureTransaction = exports.executeTransaction = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isTransactionVersioned = 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.simulateTransaction = exports.sendAndConfirmTransaction = exports.executeTransaction = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isTransactionVersioned = 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 types_1 = require("./types");
 var utils_1 = require("../utils");
+var SIMULATE_TRIES = 3;
 /**
  * Wrapper function for Solana web3 getProgramAccounts with slightly better call interface
  * @param {Connection} connection - Solana web3 connection object.
@@ -128,7 +129,11 @@ function prepareTransaction(connection, ixs, payer, commitment) {
         var _a, hash, context, messageV0, tx, signers;
         return __generator(this, function (_b) {
             switch (_b.label) {
-                case 0: return [4 /*yield*/, connection.getLatestBlockhashAndContext(commitment)];
+                case 0:
+                    if (!payer) {
+                        throw new Error("Payer public key is not provided!");
+                    }
+                    return [4 /*yield*/, connection.getLatestBlockhashAndContext(commitment)];
                 case 1:
                     _a = _b.sent(), hash = _a.value, context = _a.context;
                     messageV0 = new web3_js_1.TransactionMessage({
@@ -204,47 +209,42 @@ exports.signAndExecuteTransaction = signAndExecuteTransaction;
  * - otherwise there is a chance of marking a landed tx as failed if it was broadcasted at least once
  * @param connection - Solana client connection
  * @param tx - Transaction instance
+ * @param {ConfirmationParams} confirmationParams - Confirmation Params that will be used for execution
+ * @returns Transaction signature
+ */
+function executeTransaction(connection, tx, confirmationParams) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (tx.signatures.length === 0) {
+                        throw Error("Error with transaction parameters.");
+                    }
+                    return [4 /*yield*/, simulateTransaction(connection, tx)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/, sendAndConfirmTransaction(connection, tx, confirmationParams)];
+            }
+        });
+    });
+}
+exports.executeTransaction = executeTransaction;
+/**
+ * Sends and confirm transaction in a loop, constantly re-broadcsting the tx until Blockheight expires.
+ * - we add additional 30 bocks to account for validators in an PRC pool divergence
+ * @param connection - Solana client connection
+ * @param tx - Transaction instance
  * @param hash - blockhash information, the same hash should be used in the Transaction
  * @param context - context at which blockhash has been retrieve
  * @param commitment - optional commitment that will be used for simulation and confirmation
- * @returns Transaction signature
  */
-function executeTransaction(connection, tx, _a) {
+function sendAndConfirmTransaction(connection, tx, _a) {
     var hash = _a.hash, context = _a.context, commitment = _a.commitment;
     return __awaiter(this, void 0, void 0, function () {
-        var i, res, errMessage, isVersioned, signature, blockheight, transactionSent, rawTransaction, e_1, value, e_2, _e_1;
+        var isVersioned, signature, blockheight, transactionSent, rawTransaction, e_1, value, e_2, _e_1;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
-                    if (!hash.lastValidBlockHeight || tx.signatures.length === 0 || !hash.blockhash) {
-                        throw Error("Error with transaction parameters.");
-                    }
-                    i = 0;
-                    _b.label = 1;
-                case 1:
-                    if (!(i < 3)) return [3 /*break*/, 7];
-                    res = void 0;
-                    if (!isTransactionVersioned(tx)) return [3 /*break*/, 3];
-                    return [4 /*yield*/, connection.simulateTransaction(tx)];
-                case 2:
-                    res = _b.sent();
-                    return [3 /*break*/, 5];
-                case 3: return [4 /*yield*/, connection.simulateTransaction(tx)];
-                case 4:
-                    res = _b.sent();
-                    _b.label = 5;
-                case 5:
-                    if (res.value.err) {
-                        errMessage = JSON.stringify(res.value.err);
-                        if (!errMessage.includes("BlockhashNotFound") || i === 2) {
-                            throw new web3_js_1.SendTransactionError("failed to simulate transaction: " + errMessage, res.value.logs || undefined);
-                        }
-                    }
-                    return [3 /*break*/, 7];
-                case 6:
-                    i++;
-                    return [3 /*break*/, 1];
-                case 7:
                     isVersioned = isTransactionVersioned(tx);
                     if (isVersioned) {
                         signature = bs58_1.default.encode(tx.signatures[0]);
@@ -253,82 +253,123 @@ function executeTransaction(connection, tx, _a) {
                         signature = bs58_1.default.encode(tx.signature);
                     }
                     return [4 /*yield*/, connection.getBlockHeight(commitment)];
-                case 8:
+                case 1:
                     blockheight = _b.sent();
                     transactionSent = false;
                     rawTransaction = tx.serialize();
-                    _b.label = 9;
-                case 9:
-                    if (!(blockheight < hash.lastValidBlockHeight)) return [3 /*break*/, 24];
-                    _b.label = 10;
-                case 10:
-                    _b.trys.push([10, 12, , 13]);
+                    _b.label = 2;
+                case 2:
+                    if (!(blockheight < hash.lastValidBlockHeight + 15)) return [3 /*break*/, 20];
+                    _b.label = 3;
+                case 3:
+                    _b.trys.push([3, 6, , 9]);
+                    if (!(blockheight < hash.lastValidBlockHeight || !transactionSent)) return [3 /*break*/, 5];
                     return [4 /*yield*/, connection.sendRawTransaction(rawTransaction, {
                             maxRetries: 0,
                             minContextSlot: context.slot,
                             preflightCommitment: commitment,
                             skipPreflight: true,
                         })];
-                case 11:
+                case 4:
                     _b.sent();
                     transactionSent = true;
-                    return [3 /*break*/, 13];
-                case 12:
+                    _b.label = 5;
+                case 5: return [3 /*break*/, 9];
+                case 6:
                     e_1 = _b.sent();
-                    if (transactionSent ||
-                        (e_1 instanceof web3_js_1.SendTransactionError && e_1.message.includes("Minimum context slot has not been reached"))) {
-                        return [3 /*break*/, 9];
-                    }
-                    throw e_1;
-                case 13: return [4 /*yield*/, (0, utils_1.sleep)(500)];
-                case 14:
+                    if (!(transactionSent ||
+                        (e_1 instanceof web3_js_1.SendTransactionError && e_1.message.includes("Minimum context slot has not been reached")))) return [3 /*break*/, 8];
+                    return [4 /*yield*/, (0, utils_1.sleep)(500)];
+                case 7:
                     _b.sent();
-                    _b.label = 15;
-                case 15:
-                    _b.trys.push([15, 17, , 19]);
+                    return [3 /*break*/, 2];
+                case 8: throw e_1;
+                case 9: return [4 /*yield*/, (0, utils_1.sleep)(500)];
+                case 10:
+                    _b.sent();
+                    _b.label = 11;
+                case 11:
+                    _b.trys.push([11, 13, , 15]);
                     return [4 /*yield*/, confirmAndEnsureTransaction(connection, signature)];
-                case 16:
+                case 12:
                     value = _b.sent();
                     if (value) {
                         return [2 /*return*/, signature];
                     }
-                    return [3 /*break*/, 19];
-                case 17:
+                    return [3 /*break*/, 15];
+                case 13:
                     e_2 = _b.sent();
                     if (e_2 instanceof types_1.TransactionFailedError) {
                         throw e_2;
                     }
                     return [4 /*yield*/, (0, utils_1.sleep)(500)];
-                case 18:
+                case 14:
                     _b.sent();
-                    return [3 /*break*/, 19];
-                case 19:
-                    _b.trys.push([19, 21, , 23]);
+                    return [3 /*break*/, 15];
+                case 15:
+                    _b.trys.push([15, 17, , 19]);
                     return [4 /*yield*/, connection.getBlockHeight(commitment)];
-                case 20:
+                case 16:
                     blockheight = _b.sent();
-                    return [3 /*break*/, 23];
-                case 21:
+                    return [3 /*break*/, 19];
+                case 17:
                     _e_1 = _b.sent();
                     return [4 /*yield*/, (0, utils_1.sleep)(500)];
-                case 22:
+                case 18:
                     _b.sent();
-                    return [3 /*break*/, 23];
-                case 23: return [3 /*break*/, 9];
-                case 24: throw new Error("Transaction ".concat(signature, " expired."));
+                    return [3 /*break*/, 19];
+                case 19: return [3 /*break*/, 2];
+                case 20: throw new Error("Transaction ".concat(signature, " expired."));
             }
         });
     });
 }
-exports.executeTransaction = executeTransaction;
+exports.sendAndConfirmTransaction = sendAndConfirmTransaction;
+function simulateTransaction(connection, tx) {
+    return __awaiter(this, void 0, void 0, function () {
+        var i, res, errMessage;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    i = 0;
+                    _a.label = 1;
+                case 1:
+                    if (!(i < SIMULATE_TRIES)) return [3 /*break*/, 7];
+                    res = void 0;
+                    if (!isTransactionVersioned(tx)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, connection.simulateTransaction(tx)];
+                case 2:
+                    res = _a.sent();
+                    return [3 /*break*/, 5];
+                case 3: return [4 /*yield*/, connection.simulateTransaction(tx)];
+                case 4:
+                    res = _a.sent();
+                    _a.label = 5;
+                case 5:
+                    if (res.value.err) {
+                        errMessage = JSON.stringify(res.value.err);
+                        if (!errMessage.includes("BlockhashNotFound") || i === SIMULATE_TRIES - 1) {
+                            throw new web3_js_1.SendTransactionError("failed to simulate transaction: " + errMessage, res.value.logs || undefined);
+                        }
+                    }
+                    return [3 /*break*/, 7];
+                case 6:
+                    i++;
+                    return [3 /*break*/, 1];
+                case 7: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.simulateTransaction = simulateTransaction;
 /**
  * Confirms and validates transaction success once
  * @param connection - Solana client connection
  * @param signature - Transaction signature
- * @param passError - return status even if tx failed
+ * @param ignoreError - return status even if tx failed
  * @returns Transaction Status
  */
-function confirmAndEnsureTransaction(connection, signature, passError) {
+function confirmAndEnsureTransaction(connection, signature, ignoreError) {
     return __awaiter(this, void 0, void 0, function () {
         var response, value;
         return __generator(this, function (_a) {
@@ -343,7 +384,7 @@ function confirmAndEnsureTransaction(connection, signature, passError) {
                     if (!value) {
                         return [2 /*return*/, null];
                     }
-                    if (!passError && value.err) {
+                    if (!ignoreError && value.err) {
                         // That's how solana-web3js does it, `err` here is an object that won't really be handled
                         throw new types_1.TransactionFailedError("Raw transaction ".concat(signature, " failed (").concat(JSON.stringify({ err: value.err }), ")"));
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "6.1.0",
+  "version": "6.1.2",
   "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": "170947ffbd1de885ac95c4b809b0e889d938eaaf",
+  "gitHead": "1104b998070b9c5c70142025ba8aa22895990b10",
   "devDependencies": {
     "@streamflow/eslint-config": "6.0.0",
     "@types/bn.js": "5.1.1",