Merge pull request #266 from streamflow-finance/feat/add-custom-instructions-on-top-of-stream-generation

7.4.8: Add support for custom transaction instructions in Solana stream client

Author: RolginRoman

lerna.json

@@ -2,6 +2,6 @@
   "packages": [
     "packages/*"
   ],
-  "version": "7.4.7",
+  "version": "7.4.8",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json"
 }

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "7.4.7",
+  "version": "7.4.8",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/esm/index.js",

packages/distributor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/distributor",
-  "version": "7.4.7",
+  "version": "7.4.8",
   "description": "JavaScript SDK to interact with Streamflow Airdrop protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",

packages/eslint-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/eslint-config",
-  "version": "7.4.7",
+  "version": "7.4.8",
   "license": "ISC",
   "main": "index.js",
   "files": [

packages/launchpad/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/launchpad",
-  "version": "7.4.7",
+  "version": "7.4.8",
   "description": "JavaScript SDK to interact with Streamflow Launchpad protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",

packages/staking/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/staking",
-  "version": "7.4.7",
+  "version": "7.4.8",
   "description": "JavaScript SDK to interact with Streamflow Staking protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "dist/esm/index.js",

packages/stream/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/stream",
-  "version": "7.4.7",
+  "version": "7.4.8",
   "description": "JavaScript SDK to interact with Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/esm/index.js",

packages/stream/solana/StreamClient.ts

@@ -46,6 +46,7 @@ import {
   ICreateStreamSolanaExt,
   IInteractStreamSolanaExt,
   ITopUpStreamSolanaExt,
+  ITransactionSolanaExtWithInstructions,
   ISearchStreams,
   ICreateStreamInstructions,
   AlignedContract,
@@ -111,7 +112,7 @@ import { BaseStreamClient } from "../common/BaseStreamClient.js";
 import { IPartnerLayout } from "./instructionTypes.js";
 import { calculateTotalAmountToDeposit } from "../common/utils.js";
 import { WITHDRAW_AVAILABLE_AMOUNT } from "../common/constants.js";
-import { StreamflowAlignedUnlocks as AlignedUnlocksProgramType } from "./descriptor/streamflow_aligned_unlocks";
+import { StreamflowAlignedUnlocks as AlignedUnlocksProgramType } from "./descriptor/streamflow_aligned_unlocks.js";
 import StreamflowAlignedUnlocksIDL from "./descriptor/idl/streamflow_aligned_unlocks.json";
 import { deriveContractPDA, deriveEscrowPDA, deriveTestOraclePDA } from "./lib/derive-accounts.js";
 import { isCreateAlignedStreamData } from "../common/contractUtils.js";
@@ -220,7 +221,7 @@ export class SolanaStreamClient extends BaseStreamClient {
    */
   public async create(data: ICreateStreamData, extParams: ICreateStreamSolanaExt): Promise<ICreateResult> {
     const { partner, amount, tokenProgramId } = data;
-    const { isNative, sender } = extParams;
+    const { isNative, sender, customInstructions } = extParams;
 
     const partnerPublicKey = partner ? new PublicKey(partner) : WITHDRAWOR_PUBLIC_KEY;
     const mintPublicKey = new PublicKey(data.tokenId);
@@ -229,7 +230,7 @@ export class SolanaStreamClient extends BaseStreamClient {
       throw new Error("Sender's PublicKey is not available, check passed wallet adapter!");
     }
 
-    const ixs = await this.getCreateATAInstructions(
+    const ixs: TransactionInstruction[] = await this.getCreateATAInstructions(
       [STREAMFLOW_TREASURY_PUBLIC_KEY, partnerPublicKey],
       mintPublicKey,
       sender,
@@ -249,13 +250,9 @@ export class SolanaStreamClient extends BaseStreamClient {
       ixs.push(...(await prepareWrappedAccount(this.connection, sender.publicKey, totalAmount)));
     }
 
-    const { tx, hash, context } = await prepareTransaction(
-      this.connection,
-      ixs,
-      extParams.sender.publicKey,
-      undefined,
-      metadata,
-    );
+    await this.applyCustomAfterInstructions(ixs, customInstructions, metadataPubKey);
+
+    const { tx, hash, context } = await prepareTransaction(this.connection, ixs, sender.publicKey, undefined, metadata);
     const signature = await signAndExecuteTransaction(
       this.connection,
       extParams.sender,
@@ -653,7 +650,14 @@ export class SolanaStreamClient extends BaseStreamClient {
   ): Promise<IMultiTransactionResult> {
     const { recipients, ...streamParams } = data;
 
-    const { sender, metadataPubKeys: metadataPubKeysExt, isNative, computePrice, computeLimit } = extParams;
+    const {
+      sender,
+      metadataPubKeys: metadataPubKeysExt,
+      isNative,
+      computePrice,
+      computeLimit,
+      customInstructions,
+    } = extParams;
 
     const metadatas: string[] = [];
     const metadataToRecipient: MetadataRecipientHashMap = {};
@@ -686,13 +690,15 @@ export class SolanaStreamClient extends BaseStreamClient {
         metadataPubKeys: metadataPubKeys[i] ? [metadataPubKeys[i]] : undefined,
         computePrice,
         computeLimit,
+        customInstructions,
       };
 
       const { ixs, metadata, metadataPubKey } = await this.prepareCreateInstructions(
         createStreamData,
         createStreamExtParams,
       );
 
+      await this.applyCustomAfterInstructions(ixs, customInstructions, metadataPubKey);
       metadataToRecipient[metadataPubKey.toBase58()] = recipientData;
 
       metadatas.push(metadataPubKey.toBase58());
@@ -803,7 +809,14 @@ export class SolanaStreamClient extends BaseStreamClient {
   ): Promise<IMultiTransactionResult> {
     const { recipients, ...streamParams } = data;
 
-    const { sender, metadataPubKeys: metadataPubKeysExt, isNative, computePrice, computeLimit } = extParams;
+    const {
+      sender,
+      metadataPubKeys: metadataPubKeysExt,
+      isNative,
+      computePrice,
+      computeLimit,
+      customInstructions,
+    } = extParams;
 
     const metadatas: string[] = [];
     const metadataToRecipient: MetadataRecipientHashMap = {};
@@ -836,13 +849,15 @@ export class SolanaStreamClient extends BaseStreamClient {
         metadataPubKeys: metadataPubKeys[i] ? [metadataPubKeys[i]] : undefined,
         computePrice,
         computeLimit,
+        customInstructions,
       };
 
       const { ixs, metadata, metadataPubKey } = await this.prepareCreateInstructions(
         createStreamData,
         createStreamExtParams,
       );
 
+      await this.applyCustomAfterInstructions(ixs, customInstructions, metadataPubKey);
       metadataToRecipient[metadataPubKey.toBase58()] = recipientData;
 
       metadatas.push(metadataPubKey.toBase58());
@@ -934,8 +949,18 @@ export class SolanaStreamClient extends BaseStreamClient {
     { id, amount = WITHDRAW_AVAILABLE_AMOUNT }: IWithdrawData,
     extParams: IInteractStreamSolanaExt,
   ): Promise<ITransactionResult> {
+    const { invoker, customInstructions } = extParams;
+
+    if (!invoker.publicKey) {
+      throw new Error("Invoker's PublicKey is not available, check passed wallet adapter!");
+    }
+
     const ixs: TransactionInstruction[] = await this.prepareWithdrawInstructions({ id, amount }, extParams);
-    const { tx, hash, context } = await prepareTransaction(this.connection, ixs, extParams.invoker.publicKey);
+
+    const metadata = new PublicKey(id);
+    await this.applyCustomAfterInstructions(ixs, customInstructions, metadata);
+
+    const { tx, hash, context } = await prepareTransaction(this.connection, ixs, invoker.publicKey);
     const signature = await signAndExecuteTransaction(
       this.connection,
       extParams.invoker,
@@ -1574,4 +1599,21 @@ export class SolanaStreamClient extends BaseStreamClient {
     );
     return checkOrCreateAtaBatch(this.connection, uniqueOwners, mint, invoker, programId);
   }
+
+  private async applyCustomAfterInstructions(
+    ixs: TransactionInstruction[],
+    customInstructions: ITransactionSolanaExtWithInstructions["customInstructions"],
+    metadata?: PublicKey,
+  ): Promise<void> {
+    if (customInstructions?.after) {
+      const afterInstructions =
+        typeof customInstructions.after === "function"
+          ? await customInstructions.after({
+              instructions: ixs,
+              metadata,
+            })
+          : customInstructions.after;
+      ixs.push(...afterInstructions);
+    }
+  }
 }

packages/stream/solana/lib/derive-accounts.ts

@@ -1,6 +1,6 @@
 import { PublicKey } from "@solana/web3.js";
 
-import { CONTRACT_SEED, ESCROW_SEED, TEST_ORACLE_SEED } from "../constants";
+import { CONTRACT_SEED, ESCROW_SEED, TEST_ORACLE_SEED } from "../constants.js";
 
 export const deriveContractPDA = (programId: PublicKey, streamMetadata: PublicKey): PublicKey => {
   return PublicKey.findProgramAddressSync([CONTRACT_SEED, streamMetadata.toBuffer()], programId)[0];

packages/stream/solana/types.ts

@@ -41,13 +41,19 @@ export interface ICreateSolanaExt {
   isNative?: boolean;
 }
 
-export interface ICreateStreamSolanaExt extends ICreateSolanaExt, ITransactionSolanaExt {
+export interface ITransactionSolanaExtWithInstructions extends ITransactionSolanaExt {
+  customInstructions?: {
+    after?: InstructionGenerator;
+  };
+}
+
+export interface ICreateStreamSolanaExt extends ICreateSolanaExt, ITransactionSolanaExtWithInstructions {
   // allow custom Metadata Account to be passed, ephemeral signer is most cases, accepts array to be compatible in createMultiple
   metadataPubKeys?: PublicKey[];
   partner?: string | null;
 }
 
-export interface IInteractStreamSolanaExt extends ITransactionSolanaExt {
+export interface IInteractStreamSolanaExt extends ITransactionSolanaExtWithInstructions {
   invoker: SignerWalletAdapter | Keypair;
   checkTokenAccounts?: boolean;
 }
@@ -307,3 +313,10 @@ export interface BatchItemError extends BatchItem {
 }
 
 export type BatchItemResult = BatchItemSuccess | BatchItemError;
+
+export type InstructionGenerator =
+  | TransactionInstruction[]
+  | ((params: {
+      instructions: TransactionInstruction[];
+      metadata?: PublicKey;
+    }) => TransactionInstruction[] | Promise<TransactionInstruction[]>);