@streamflow/common 6.3.1 → 6.3.3

package/dist/solana/types.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { AccountInfo, BlockhashWithExpiryBlockHeight, Commitment, Context, PublicKey } from "@solana/web3.js";
+import PQueue from "p-queue";
 export interface ITransactionSolanaExt {
     computePrice?: number;
     computeLimit?: number;
@@ -25,6 +26,10 @@ export interface ConfirmationParams {
     context: Context;
     commitment?: Commitment;
 }
+export interface ThrottleParams {
+    sendRate?: number;
+    sendThrottler?: PQueue;
+}
 export declare class TransactionFailedError extends Error {
     constructor(m: string);
 }

package/dist/solana/utils.d.ts

@@ -1,7 +1,9 @@
 import { Mint } from "@solana/spl-token";
 import { SignerWalletAdapter } from "@solana/wallet-adapter-base";
 import { BlockhashWithExpiryBlockHeight, Commitment, Connection, Keypair, PublicKey, Transaction, TransactionInstruction, SignatureStatus, VersionedTransaction, Context, RpcResponseAndContext, SimulatedTransactionResponse } from "@solana/web3.js";
-import { Account, AtaParams, ConfirmationParams, ITransactionSolanaExt } from "./types";
+import PQueue from "p-queue";
+import { Account, AtaParams, ConfirmationParams, ITransactionSolanaExt, ThrottleParams } from "./types";
+export declare const buildSendThrottler: (sendRate: number) => PQueue;
 /**
  * Wrapper function for Solana web3 getProgramAccounts with slightly better call interface
  * @param {Connection} connection - Solana web3 connection object.
@@ -49,10 +51,11 @@ export declare function signTransaction<T extends Transaction | VersionedTransac
  * @param connection - Solana client connection
  * @param invoker - Keypair used as signer
  * @param tx - Transaction instance
- * @param {ConfirmationParams} confirmationParams - Confirmation Params that will be used for execution
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
  * @returns Transaction signature
  */
-export declare function signAndExecuteTransaction(connection: Connection, invoker: Keypair | SignerWalletAdapter, tx: Transaction | VersionedTransaction, confirmationParams: ConfirmationParams): Promise<string>;
+export declare function signAndExecuteTransaction(connection: Connection, invoker: Keypair | SignerWalletAdapter, tx: Transaction | VersionedTransaction, confirmationParams: ConfirmationParams, throttleParams: ThrottleParams): Promise<string>;
 /**
  * Sends and confirms Transaction
  * Uses custom confirmation logic that:
@@ -64,20 +67,36 @@ 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
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
  * @returns Transaction signature
  */
-export declare function executeTransaction(connection: Connection, tx: Transaction | VersionedTransaction, confirmationParams: ConfirmationParams): Promise<string>;
+export declare function executeTransaction(connection: Connection, tx: Transaction | VersionedTransaction, confirmationParams: ConfirmationParams, throttleParams: ThrottleParams): Promise<string>;
+/**
+ * Launches a PromisePool with all transaction being executed at the same time, allows to throttle all TXs through one Queue
+ * @param connection - Solana client connection
+ * @param txs - Transactions
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
+ * @param throttleParams.sendRate - rate
+ * @param throttleParams.sendThrottler -  throttler instance
+ * @returns Raw Promise Results - should be handled by the consumer and unwrapped accordingly
+ */
+export declare function executeMultipleTransactions(connection: Connection, txs: (Transaction | VersionedTransaction)[], confirmationParams: ConfirmationParams, { sendRate, sendThrottler }: ThrottleParams): Promise<PromiseSettledResult<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
- */
-export declare function sendAndConfirmTransaction(connection: Connection, tx: Transaction | VersionedTransaction, { hash, context, commitment }: ConfirmationParams): Promise<string>;
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param confirmationParams.hash - blockhash information, the same hash should be used in the Transaction
+ * @param confirmationParams.context - context at which blockhash has been retrieve
+ * @param confirmationParams.commitment - optional commitment that will be used for simulation and confirmation
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
+ * @param throttleParams.sendRate - rate
+ * @param throttleParams.sendThrottler -  throttler instance
+ */
+export declare function sendAndConfirmTransaction(connection: Connection, tx: Transaction | VersionedTransaction, { hash, context, commitment }: ConfirmationParams, { sendRate, sendThrottler }: ThrottleParams): Promise<string>;
 export declare function simulateTransaction(connection: Connection, tx: Transaction | VersionedTransaction): Promise<RpcResponseAndContext<SimulatedTransactionResponse>>;
 /**
  * Confirms and validates transaction success once
@@ -122,9 +141,10 @@ export declare function generateCreateAtaBatchTx(connection: Connection, payer:
  * @param invoker - Transaction invoker and payer
  * @param paramsBatch - Array of Params for an each ATA account: {mint, owner}
  * @param commitment - optional commitment that will be used to fetch Blockhash
+ * @param rate - throttle rate for tx sending
  * @returns Transaction signature
  */
-export declare function createAtaBatch(connection: Connection, invoker: Keypair | SignerWalletAdapter, paramsBatch: AtaParams[], commitment?: Commitment): Promise<string>;
+export declare function createAtaBatch(connection: Connection, invoker: Keypair | SignerWalletAdapter, paramsBatch: AtaParams[], commitment?: Commitment, rate?: number): Promise<string>;
 /**
  * Utility function that checks whether associated token accounts exist and return instructions to populate them if not
  * @param connection - Solana client connection

package/dist/solana/utils.js

@@ -50,13 +50,18 @@ 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.simulateTransaction = exports.sendAndConfirmTransaction = 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.executeMultipleTransactions = exports.executeTransaction = exports.signAndExecuteTransaction = exports.signTransaction = exports.prepareTransaction = exports.isTransactionVersioned = exports.isSignerKeypair = exports.isSignerWallet = exports.getProgramAccounts = exports.buildSendThrottler = 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 p_queue_1 = __importDefault(require("p-queue"));
 var types_1 = require("./types");
 var utils_1 = require("../utils");
 var SIMULATE_TRIES = 3;
+var buildSendThrottler = function (sendRate) {
+    return new p_queue_1.default({ concurrency: sendRate, intervalCap: 1, interval: 1000 });
+};
+exports.buildSendThrottler = buildSendThrottler;
 /**
  * Wrapper function for Solana web3 getProgramAccounts with slightly better call interface
  * @param {Connection} connection - Solana web3 connection object.
@@ -181,10 +186,11 @@ exports.signTransaction = signTransaction;
  * @param connection - Solana client connection
  * @param invoker - Keypair used as signer
  * @param tx - Transaction instance
- * @param {ConfirmationParams} confirmationParams - Confirmation Params that will be used for execution
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
  * @returns Transaction signature
  */
-function signAndExecuteTransaction(connection, invoker, tx, confirmationParams) {
+function signAndExecuteTransaction(connection, invoker, tx, confirmationParams, throttleParams) {
     return __awaiter(this, void 0, void 0, function () {
         var signedTx;
         return __generator(this, function (_a) {
@@ -192,7 +198,7 @@ function signAndExecuteTransaction(connection, invoker, tx, confirmationParams)
                 case 0: return [4 /*yield*/, signTransaction(invoker, tx)];
                 case 1:
                     signedTx = _a.sent();
-                    return [2 /*return*/, executeTransaction(connection, signedTx, confirmationParams)];
+                    return [2 /*return*/, executeTransaction(connection, signedTx, confirmationParams, throttleParams)];
             }
         });
     });
@@ -209,10 +215,11 @@ 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
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
  * @returns Transaction signature
  */
-function executeTransaction(connection, tx, confirmationParams) {
+function executeTransaction(connection, tx, confirmationParams, throttleParams) {
     return __awaiter(this, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
@@ -223,27 +230,57 @@ function executeTransaction(connection, tx, confirmationParams) {
                     return [4 /*yield*/, simulateTransaction(connection, tx)];
                 case 1:
                     _a.sent();
-                    return [2 /*return*/, sendAndConfirmTransaction(connection, tx, confirmationParams)];
+                    return [2 /*return*/, sendAndConfirmTransaction(connection, tx, confirmationParams, throttleParams)];
             }
         });
     });
 }
 exports.executeTransaction = executeTransaction;
+/**
+ * Launches a PromisePool with all transaction being executed at the same time, allows to throttle all TXs through one Queue
+ * @param connection - Solana client connection
+ * @param txs - Transactions
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
+ * @param throttleParams.sendRate - rate
+ * @param throttleParams.sendThrottler -  throttler instance
+ * @returns Raw Promise Results - should be handled by the consumer and unwrapped accordingly
+ */
+function executeMultipleTransactions(connection, txs, confirmationParams, _a) {
+    var _b = _a.sendRate, sendRate = _b === void 0 ? 1 : _b, sendThrottler = _a.sendThrottler;
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_c) {
+            if (!sendThrottler) {
+                sendThrottler = (0, exports.buildSendThrottler)(sendRate);
+            }
+            return [2 /*return*/, Promise.allSettled(txs.map(function (tx) {
+                    return executeTransaction(connection, tx, confirmationParams, { sendRate: sendRate, sendThrottler: sendThrottler });
+                }))];
+        });
+    });
+}
+exports.executeMultipleTransactions = executeMultipleTransactions;
 /**
  * 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
+ * @param confirmationParams - Confirmation Params that will be used for execution
+ * @param confirmationParams.hash - blockhash information, the same hash should be used in the Transaction
+ * @param confirmationParams.context - context at which blockhash has been retrieve
+ * @param confirmationParams.commitment - optional commitment that will be used for simulation and confirmation
+ * @param throttleParams - rate or throttler instance to throttle TX sending - to not spam the blockchain too much
+ * @param throttleParams.sendRate - rate
+ * @param throttleParams.sendThrottler -  throttler instance
  */
-function sendAndConfirmTransaction(connection, tx, _a) {
+function sendAndConfirmTransaction(connection, tx, _a, _b) {
     var hash = _a.hash, context = _a.context, commitment = _a.commitment;
+    var _c = _b.sendRate, sendRate = _c === void 0 ? 1 : _c, sendThrottler = _b.sendThrottler;
     return __awaiter(this, void 0, void 0, function () {
         var isVersioned, signature, blockheight, transactionSent, rawTransaction, e_1, value, e_2, _e_1;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var _this = this;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
                     isVersioned = isTransactionVersioned(tx);
                     if (isVersioned) {
@@ -252,71 +289,78 @@ function sendAndConfirmTransaction(connection, tx, _a) {
                     else {
                         signature = bs58_1.default.encode(tx.signature);
                     }
+                    if (!sendThrottler) {
+                        sendThrottler = (0, exports.buildSendThrottler)(sendRate);
+                    }
                     return [4 /*yield*/, connection.getBlockHeight(commitment)];
                 case 1:
-                    blockheight = _b.sent();
+                    blockheight = _d.sent();
                     transactionSent = false;
                     rawTransaction = tx.serialize();
-                    _b.label = 2;
+                    _d.label = 2;
                 case 2:
                     if (!(blockheight < hash.lastValidBlockHeight + 15)) return [3 /*break*/, 20];
-                    _b.label = 3;
+                    _d.label = 3;
                 case 3:
-                    _b.trys.push([3, 6, , 9]);
+                    _d.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,
-                        })];
+                    return [4 /*yield*/, sendThrottler.add(function () { return __awaiter(_this, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, connection.sendRawTransaction(rawTransaction, {
+                                        maxRetries: 0,
+                                        minContextSlot: context.slot,
+                                        preflightCommitment: commitment,
+                                        skipPreflight: true,
+                                    })];
+                            });
+                        }); })];
                 case 4:
-                    _b.sent();
+                    _d.sent();
                     transactionSent = true;
-                    _b.label = 5;
+                    _d.label = 5;
                 case 5: return [3 /*break*/, 9];
                 case 6:
-                    e_1 = _b.sent();
+                    e_1 = _d.sent();
                     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();
+                    _d.sent();
                     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;
+                    _d.sent();
+                    _d.label = 11;
                 case 11:
-                    _b.trys.push([11, 13, , 15]);
+                    _d.trys.push([11, 13, , 15]);
                     return [4 /*yield*/, confirmAndEnsureTransaction(connection, signature)];
                 case 12:
-                    value = _b.sent();
+                    value = _d.sent();
                     if (value) {
                         return [2 /*return*/, signature];
                     }
                     return [3 /*break*/, 15];
                 case 13:
-                    e_2 = _b.sent();
+                    e_2 = _d.sent();
                     if (e_2 instanceof types_1.TransactionFailedError) {
                         throw e_2;
                     }
                     return [4 /*yield*/, (0, utils_1.sleep)(500)];
                 case 14:
-                    _b.sent();
+                    _d.sent();
                     return [3 /*break*/, 15];
                 case 15:
-                    _b.trys.push([15, 17, , 19]);
+                    _d.trys.push([15, 17, , 19]);
                     return [4 /*yield*/, connection.getBlockHeight(commitment)];
                 case 16:
-                    blockheight = _b.sent();
+                    blockheight = _d.sent();
                     return [3 /*break*/, 19];
                 case 17:
-                    _e_1 = _b.sent();
+                    _e_1 = _d.sent();
                     return [4 /*yield*/, (0, utils_1.sleep)(500)];
                 case 18:
-                    _b.sent();
+                    _d.sent();
                     return [3 /*break*/, 19];
                 case 19: return [3 /*break*/, 2];
                 case 20: throw new Error("Transaction ".concat(signature, " expired."));
@@ -543,9 +587,10 @@ exports.generateCreateAtaBatchTx = generateCreateAtaBatchTx;
  * @param invoker - Transaction invoker and payer
  * @param paramsBatch - Array of Params for an each ATA account: {mint, owner}
  * @param commitment - optional commitment that will be used to fetch Blockhash
+ * @param rate - throttle rate for tx sending
  * @returns Transaction signature
  */
-function createAtaBatch(connection, invoker, paramsBatch, commitment) {
+function createAtaBatch(connection, invoker, paramsBatch, commitment, rate) {
     return __awaiter(this, void 0, void 0, function () {
         var _a, tx, hash, context, _b, _c;
         return __generator(this, function (_d) {
@@ -558,7 +603,7 @@ function createAtaBatch(connection, invoker, paramsBatch, commitment) {
                 case 1: return [4 /*yield*/, _b.apply(void 0, _c.concat([_d.sent(), commitment]))];
                 case 2:
                     _a = _d.sent(), tx = _a.tx, hash = _a.hash, context = _a.context;
-                    return [2 /*return*/, signAndExecuteTransaction(connection, invoker, tx, { hash: hash, context: context, commitment: commitment })];
+                    return [2 /*return*/, signAndExecuteTransaction(connection, invoker, tx, { hash: hash, context: context, commitment: commitment }, { sendRate: rate })];
             }
         });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "6.3.1",
+  "version": "6.3.3",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/index.js",
@@ -23,9 +23,9 @@
     "lint-config": "eslint --print-config",
     "prepublishOnly": "npm run lint && npm run build"
   },
-  "gitHead": "dd901627ee3ece821b9be3668b489ab4267a58df",
+  "gitHead": "01ceb912ed61adfb1055d9d1ea64e61f98a183eb",
   "devDependencies": {
-    "@streamflow/eslint-config": "6.3.1",
+    "@streamflow/eslint-config": "6.3.3",
     "@types/bn.js": "5.1.1",
     "@types/jest": "29.2.4",
     "date-fns": "2.28.0",
@@ -42,6 +42,7 @@
     "aptos": "1.4.0",
     "bn.js": "5.2.1",
     "borsh": "^2.0.0",
-    "bs58": "5.0.0"
+    "bs58": "5.0.0",
+    "p-queue": "^6.6.2"
   }
 }