feat: support fee partner, cancel request

Author: Yolley

packages/stream/__tests__/solana/streamClient.spec.ts

@@ -404,6 +404,8 @@ describe("SolanaStreamClient Transaction Builders", async () => {
       oldMetadata: PublicKey.default,
       payer: PublicKey.default,
       bump: 0,
+      feePartner: PublicKey.default,
+      cancelRequestTime: new BN(0),
     });
 
     const setupTransferHookMint = () => {

packages/stream/solana/StreamClient.ts

@@ -73,13 +73,15 @@ import {
   type IMultiTransactionResult,
   type IPrepareCreateStreamExt,
   type IPrepareStreamExt, type IPrepareTopUpstreamExt,
+  type IRequestCancelData,
   type ISearchStreams,
   type ITopUpData,
   type ITopUpStreamExt,
   type ITransactionExtWithInstructions,
   type ITransactionResult,
   type ITransferData,
   type IUpdateData,
+  type IWithdrawCancelRequestData,
   type IWithdrawData,
   type MetadataRecipientHashMap,
   type OracleType,
@@ -122,9 +124,11 @@ import {
   createStreamV2Instruction,
   createUncheckedStreamInstruction,
   createUncheckedStreamV2Instruction,
+  requestCancelStreamInstruction,
   topupStreamInstruction,
   transferStreamInstruction,
   updateStreamInstruction,
+  withdrawCancelRequestInstruction,
   withdrawStreamInstruction,
 } from "./instructions.js";
 import type { IPartnerLayout } from "./instructionTypes.js";
@@ -1468,6 +1472,114 @@ export class SolanaStreamClient {
     return ixs;
   }
 
+  /**
+   * Requests cancellation of a stream by the fee partner authority.
+   * @param {IRequestCancelData} data - Request cancel parameters including stream ID
+   * @param {IInteractStreamExt} extParams - Transaction configuration including invoker wallet and compute settings
+   * @returns Transaction result
+   */
+  public async requestCancel(
+    data: IRequestCancelData,
+    extParams: IInteractStreamExt,
+  ): Promise<ITransactionResult> {
+    const ixs = await this.prepareRequestCancelInstructions(data, extParams);
+    const { tx, hash, context } = await prepareTransaction(this.connection, ixs, extParams.invoker.publicKey);
+    const signature = await signAndExecuteTransaction(
+      this.connection,
+      extParams.invoker,
+      tx,
+      {
+        hash,
+        context,
+        commitment: this.getCommitment(),
+      },
+      this.schedulingParams,
+    );
+
+    return { ixs, txId: signature };
+  }
+
+  /**
+   * Creates Transaction Instructions for request_cancel
+   * @param {IRequestCancelData} data - Request cancel parameters including stream ID
+   * @param {IPrepareStreamExt} extParams - Transaction configuration including invoker wallet and compute settings
+   * @returns Transaction instructions
+   */
+  public async prepareRequestCancelInstructions(
+    { id }: IRequestCancelData,
+    { invoker, computePrice, computeLimit }: IPrepareStreamExt,
+  ): Promise<TransactionInstruction[]> {
+    assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
+
+    const ixs: TransactionInstruction[] = prepareBaseInstructions(this.connection, {
+      computePrice,
+      computeLimit,
+    });
+
+    ixs.push(
+      await requestCancelStreamInstruction(this.programId, {
+        authority: invoker.publicKey,
+        metadata: new PublicKey(id),
+      }),
+    );
+
+    return ixs;
+  }
+
+  /**
+   * Withdraws a previously submitted cancel request.
+   * @param {IWithdrawCancelRequestData} data - Withdraw cancel request parameters including stream ID
+   * @param {IInteractStreamExt} extParams - Transaction configuration including invoker wallet and compute settings
+   * @returns Transaction result
+   */
+  public async withdrawCancelRequest(
+    data: IWithdrawCancelRequestData,
+    extParams: IInteractStreamExt,
+  ): Promise<ITransactionResult> {
+    const ixs = await this.prepareWithdrawCancelRequestInstructions(data, extParams);
+    const { tx, hash, context } = await prepareTransaction(this.connection, ixs, extParams.invoker.publicKey);
+    const signature = await signAndExecuteTransaction(
+      this.connection,
+      extParams.invoker,
+      tx,
+      {
+        hash,
+        context,
+        commitment: this.getCommitment(),
+      },
+      this.schedulingParams,
+    );
+
+    return { ixs, txId: signature };
+  }
+
+  /**
+   * Creates Transaction Instructions for withdraw_cancel_request
+   * @param {IWithdrawCancelRequestData} data - Withdraw cancel request parameters including stream ID
+   * @param {IPrepareStreamExt} extParams - Transaction configuration including invoker wallet and compute settings
+   * @returns Transaction instructions
+   */
+  public async prepareWithdrawCancelRequestInstructions(
+    { id }: IWithdrawCancelRequestData,
+    { invoker, computePrice, computeLimit }: IPrepareStreamExt,
+  ): Promise<TransactionInstruction[]> {
+    assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
+
+    const ixs: TransactionInstruction[] = prepareBaseInstructions(this.connection, {
+      computePrice,
+      computeLimit,
+    });
+
+    ixs.push(
+      await withdrawCancelRequestInstruction(this.programId, {
+        authority: invoker.publicKey,
+        metadata: new PublicKey(id),
+      }),
+    );
+
+    return ixs;
+  }
+
   /**
    * Attempts changing the stream/vesting contract's recipient (effectively transferring the stream/vesting contract).
    * Potential associated token account rent fee (to make it rent-exempt) is paid by the transaction initiator.

packages/stream/solana/api-public/transform.ts

@@ -87,6 +87,8 @@ async function toDecodedStream(schema: ContractSchema): Promise<DecodedStream> {
     oldMetadata: PublicKey.default,
     payer,
     bump: schema.bump ? schema.bump : 0,
+    feePartner: partner,
+    cancelRequestTime: toBN(isoToUnix(schema.cancelRequestDt)),
   };
 }
 

packages/stream/solana/api-public/types.ts

@@ -74,6 +74,8 @@ export interface ContractSchema {
   nonce: number | null;
   payer: string | null;
   bump: number | null;
+  feePartner: string | null,
+  cancelRequestDt: string | null;
   dynamicContract: DynamicContractSchema | null;
 }
 

packages/stream/solana/descriptor/idl/streamflow.json

@@ -2,7 +2,7 @@
   "address": "strmRqUCoQUgGUan5YhzUZa6KqdzwX5L6FpUxfmKg5m",
   "metadata": {
     "name": "streamflow",
-    "version": "0.4.0",
+    "version": "0.6.0",
     "spec": "0.1.0",
     "description": "Created with Anchor"
   },
@@ -94,6 +94,10 @@
         {
           "name": "metadata",
           "writable": true
+        },
+        {
+          "name": "partner",
+          "writable": true
         }
       ],
       "args": []
@@ -1122,6 +1126,30 @@
       ],
       "args": []
     },
+    {
+      "name": "request_cancel",
+      "discriminator": [
+        244,
+        78,
+        42,
+        227,
+        165,
+        174,
+        94,
+        167
+      ],
+      "accounts": [
+        {
+          "name": "authority",
+          "signer": true
+        },
+        {
+          "name": "metadata",
+          "writable": true
+        }
+      ],
+      "args": []
+    },
     {
       "name": "topup",
       "discriminator": [
@@ -1435,6 +1463,30 @@
           "type": "u64"
         }
       ]
+    },
+    {
+      "name": "withdraw_cancel_request",
+      "discriminator": [
+        91,
+        137,
+        171,
+        103,
+        142,
+        205,
+        96,
+        75
+      ],
+      "accounts": [
+        {
+          "name": "authority",
+          "signer": true
+        },
+        {
+          "name": "metadata",
+          "writable": true
+        }
+      ],
+      "args": []
     }
   ]
 }