Merge pull request #246 from streamflow-finance/feat/expose-more-scheduling-options

RolginRoman · web-flow · commit 56f65828955f · 2025-01-15T19:14:26.000+01:00
Feat/expose more scheduling options
diff --git a/lerna.json b/lerna.json
@@ -2,6 +2,6 @@
   "packages": [
     "packages/*"
   ],
-  "version": "7.2.0",
+  "version": "7.2.1",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json"
 }
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/esm/index.js",
diff --git a/packages/common/solana/types.ts b/packages/common/solana/types.ts
@@ -34,6 +34,7 @@ export interface ConfirmationParams {
 export interface ThrottleParams {
   sendRate?: number;
   sendThrottler?: PQueue;
+  waitBeforeConfirming?: number | undefined;
 }
 
 export interface IProgramAccount<T> {
diff --git a/packages/common/solana/utils.ts b/packages/common/solana/utils.ts
@@ -221,14 +221,18 @@ export async function executeMultipleTransactions(
   connection: Connection,
   txs: (Transaction | VersionedTransaction)[],
   confirmationParams: ConfirmationParams,
-  { sendRate = 1, sendThrottler }: ThrottleParams,
+  { sendRate = 1, sendThrottler, ...throttlingParams }: ThrottleParams,
 ): Promise<PromiseSettledResult<string>[]> {
   if (!sendThrottler) {
     sendThrottler = buildSendThrottler(sendRate);
   }
   return Promise.allSettled(
     txs.map((tx) =>
-      executeTransaction(connection, tx, confirmationParams, { sendRate: sendRate, sendThrottler: sendThrottler }),
+      executeTransaction(connection, tx, confirmationParams, {
+        ...throttlingParams,
+        sendRate: sendRate,
+        sendThrottler: sendThrottler,
+      }),
     ),
   );
 }
@@ -250,7 +254,7 @@ export async function sendAndConfirmTransaction(
   connection: Connection,
   tx: Transaction | VersionedTransaction,
   { hash, context, commitment }: ConfirmationParams,
-  { sendRate = 1, sendThrottler }: ThrottleParams,
+  { sendRate = 1, sendThrottler, waitBeforeConfirming }: ThrottleParams,
 ): Promise<string> {
   const isVersioned = isTransactionVersioned(tx);
 
@@ -291,7 +295,8 @@ export async function sendAndConfirmTransaction(
       }
       throw e;
     }
-    await sleep(500);
+    // Wait at least 5 slots (~400ms before confirming)
+    await sleep(waitBeforeConfirming ?? 2000);
     try {
       const value = await confirmAndEnsureTransaction(connection, signature);
       if (value) {
diff --git a/packages/distributor/package.json b/packages/distributor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/distributor",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "description": "JavaScript SDK to interact with Streamflow Airdrop protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/eslint-config",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "license": "ISC",
   "main": "index.js",
   "files": [
diff --git a/packages/launchpad/package.json b/packages/launchpad/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/launchpad",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "description": "JavaScript SDK to interact with Streamflow Launchpad protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",
diff --git a/packages/staking/package.json b/packages/staking/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/staking",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "description": "JavaScript SDK to interact with Streamflow Staking protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",
diff --git a/packages/stream/common/types.ts b/packages/stream/common/types.ts
@@ -340,6 +340,24 @@ export enum SolanaAlignedProxyErrorCode {
   AllFundsUnlocked = "AllFundsUnlocked",
 }
 
+/**
+ * @interface
+ */
+export interface SolanaTransactionSchedulingOptions {
+  /**
+   * concurrency rate for scheduling
+   */
+  sendRate: number;
+  /**
+   * time interval between consecutive sends
+   */
+  sendInterval?: number;
+  /**
+   * time interval before confirming the transaction
+   */
+  waitBeforeConfirming?: number;
+}
+
 /**
  * @interface
  */
@@ -351,18 +369,7 @@ export interface SolanaStreamClientOptions {
   commitment?: Commitment | ConnectionConfig;
   sendRate?: number;
   sendThrottler?: PQueue;
-  sendScheduler?:
-    | PQueue
-    | {
-        /**
-         * concurrency rate for scheduling
-         */
-        sendRate: number;
-        /**
-         * time interval between consecutive sends
-         */
-        sendInterval?: number;
-      };
+  sendScheduler?: PQueue | SolanaTransactionSchedulingOptions;
 }
 
 /**
diff --git a/packages/stream/package.json b/packages/stream/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/stream",
-  "version": "7.2.0",
+  "version": "7.2.1",
   "description": "JavaScript SDK to interact with Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/esm/index.js",
diff --git a/packages/stream/solana/StreamClient.ts b/packages/stream/solana/StreamClient.ts
@@ -32,6 +32,7 @@ import {
   executeMultipleTransactions,
   buildSendThrottler,
   IProgramAccount,
+  ThrottleParams,
 } from "@streamflow/common/solana";
 import * as borsh from "borsh";
 import { Program } from "@coral-xyz/anchor";
@@ -132,10 +133,10 @@ export class SolanaStreamClient extends BaseStreamClient {
 
   private commitment: Commitment | ConnectionConfig;
 
-  private sendThrottler: PQueue;
-
   private alignedProxyProgram: Program<AlignedUnlocksProgramType>;
 
+  private schedulingParams: ThrottleParams;
+
   /**
    * Create Stream instance with flat arguments
    */
@@ -169,7 +170,9 @@ export class SolanaStreamClient extends BaseStreamClient {
       this.commitment = commitment;
       this.connection = new Connection(optionsOrClusterUrl, this.commitment);
       this.programId = programId !== "" ? new PublicKey(programId) : new PublicKey(PROGRAM_ID[cluster]);
-      this.sendThrottler = sendThrottler ?? buildSendThrottler(sendRate);
+      this.schedulingParams = {
+        sendThrottler: sendThrottler ?? buildSendThrottler(sendRate),
+      };
     } else {
       const {
         clusterUrl,
@@ -181,11 +184,16 @@ export class SolanaStreamClient extends BaseStreamClient {
       this.commitment = commitment;
       this.connection = new Connection(clusterUrl, this.commitment);
       this.programId = programId !== "" ? new PublicKey(programId) : new PublicKey(PROGRAM_ID[cluster]);
-      this.sendThrottler = !sendScheduler
+      const schedulingOptions = sendScheduler && "sendRate" in sendScheduler ? sendScheduler : undefined;
+      const sendThrottler = !sendScheduler
         ? buildSendThrottler(1)
         : "sendRate" in sendScheduler
           ? buildSendThrottler(sendScheduler.sendRate ?? 1, sendScheduler.sendInterval)
           : sendScheduler;
+      this.schedulingParams = {
+        ...schedulingOptions,
+        sendThrottler,
+      };
     }
     const alignedUnlocksProgram = {
       ...StreamflowAlignedUnlocksIDL,
@@ -257,7 +265,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return { ixs, txId: signature, metadataId: metadataPubKey.toBase58() };
@@ -520,7 +528,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return { ixs, txId: signature, metadataId: metadataPubKey.toBase58() };
@@ -741,12 +749,7 @@ export class SolanaStreamClient extends BaseStreamClient {
 
     if (prepareInstructions.length > 0) {
       const prepareTx = signedBatch.pop();
-      await sendAndConfirmStreamRawTransaction(
-        this.connection,
-        prepareTx!,
-        { hash, context },
-        { sendThrottler: this.sendThrottler },
-      );
+      await sendAndConfirmStreamRawTransaction(this.connection, prepareTx!, { hash, context }, this.schedulingParams);
     }
 
     const responses: PromiseSettledResult<string>[] = [];
@@ -756,7 +759,7 @@ export class SolanaStreamClient extends BaseStreamClient {
       for (const batchTx of signedBatch) {
         responses.push(
           ...(await Promise.allSettled([
-            executeTransaction(this.connection, batchTx.tx, { hash, context }, { sendThrottler: this.sendThrottler }),
+            executeTransaction(this.connection, batchTx.tx, { hash, context }, this.schedulingParams),
           ])),
         );
       }
@@ -769,7 +772,7 @@ export class SolanaStreamClient extends BaseStreamClient {
           this.connection,
           signedBatch.map((item) => item.tx),
           { hash, context },
-          { sendThrottler: this.sendThrottler },
+          this.schedulingParams,
         )),
       );
     }
@@ -896,20 +899,15 @@ export class SolanaStreamClient extends BaseStreamClient {
 
     if (prepareInstructions.length > 0) {
       const prepareTx = signedBatch.shift();
-      await sendAndConfirmStreamRawTransaction(
-        this.connection,
-        prepareTx!,
-        { hash, context },
-        { sendThrottler: this.sendThrottler },
-      );
+      await sendAndConfirmStreamRawTransaction(this.connection, prepareTx!, { hash, context }, this.schedulingParams);
     }
 
     const responses: PromiseSettledResult<string>[] = [];
 
     for (const batchTx of signedBatch) {
       responses.push(
         ...(await Promise.allSettled([
-          executeTransaction(this.connection, batchTx.tx, { hash, context }, { sendThrottler: this.sendThrottler }),
+          executeTransaction(this.connection, batchTx.tx, { hash, context }, this.schedulingParams),
         ])),
       );
     }
@@ -947,7 +945,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return { ixs, txId: signature };
@@ -1023,7 +1021,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return { ixs, txId: signature };
@@ -1173,7 +1171,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return { ixs, txId: signature };
@@ -1238,7 +1236,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return { ixs, txId: signature };
@@ -1461,7 +1459,7 @@ export class SolanaStreamClient extends BaseStreamClient {
         context,
         commitment: this.getCommitment(),
       },
-      { sendThrottler: this.sendThrottler },
+      this.schedulingParams,
     );
 
     return {

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@`
`2`	`2`	`"packages": [`
`3`	`3`	`"packages/*"`
`4`	`4`	`],`
`5`		`- "version": "7.2.0",`
	`5`	`+ "version": "7.2.1",`
`6`	`6`	`"$schema": "node_modules/lerna/schemas/lerna-schema.json"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/common",`
`3`		`- "version": "7.2.0",`
	`3`	`+ "version": "7.2.1",`
`4`	`4`	`"description": "Common utilities and types used by streamflow packages.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"main": "./dist/esm/index.js",`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ export interface ConfirmationParams {`
`34`	`34`	`export interface ThrottleParams {`
`35`	`35`	`sendRate?: number;`
`36`	`36`	`sendThrottler?: PQueue;`
	`37`	`+ waitBeforeConfirming?: number \| undefined;`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`export interface IProgramAccount<T> {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/distributor",`
`3`		`- "version": "7.2.0",`
	`3`	`+ "version": "7.2.1",`
`4`	`4`	`"description": "JavaScript SDK to interact with Streamflow Airdrop protocol.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"main": "dist/esm/index.js",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/eslint-config",`
`3`		`- "version": "7.2.0",`
	`3`	`+ "version": "7.2.1",`
`4`	`4`	`"license": "ISC",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"files": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/launchpad",`
`3`		`- "version": "7.2.0",`
	`3`	`+ "version": "7.2.1",`
`4`	`4`	`"description": "JavaScript SDK to interact with Streamflow Launchpad protocol.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"main": "dist/esm/index.js",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/staking",`
`3`		`- "version": "7.2.0",`
	`3`	`+ "version": "7.2.1",`
`4`	`4`	`"description": "JavaScript SDK to interact with Streamflow Staking protocol.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"main": "dist/esm/index.js",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/stream",`
`3`		`- "version": "7.2.0",`
	`3`	`+ "version": "7.2.1",`
`4`	`4`	`"description": "JavaScript SDK to interact with Streamflow protocol.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"main": "./dist/esm/index.js",`