support updating transferable, cancelable flags (#290)

Yolley · web-flow · commit 5039e5cad99a · 2025-05-20T13:40:54.000+02:00
* support updating transferable flags
* expose cancelable by sender
diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "8.0.2",
+  "version": "8.1.0",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "command": {
     "run": {
diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "type": "module",
diff --git a/packages/distributor/package.json b/packages/distributor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/distributor",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "JavaScript SDK to interact with Streamflow Airdrop protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/eslint-config",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "ESLint configuration for Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "engines": {
diff --git a/packages/launchpad/package.json b/packages/launchpad/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/launchpad",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "JavaScript SDK to interact with Streamflow Launchpad protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",
diff --git a/packages/staking/package.json b/packages/staking/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/staking",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "JavaScript SDK to interact with Streamflow Staking protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",
diff --git a/packages/stream/common/contractUtils.ts b/packages/stream/common/contractUtils.ts
@@ -110,7 +110,6 @@ export const isTokenLock = (streamData: {
     !streamData.cancelableBySender &&
     !streamData.cancelableByRecipient &&
     !streamData.transferableBySender &&
-    !streamData.transferableByRecipient &&
     (isCliffCloseToDepositedAmount(streamData) ||
       isDynamicLock(streamData.minPrice, streamData.maxPrice, streamData.minPercentage, streamData.maxPercentage))
   );
diff --git a/packages/stream/common/types.ts b/packages/stream/common/types.ts
@@ -74,6 +74,11 @@ export interface IUpdateData extends IInteractData {
   enableAutomaticWithdrawal?: boolean;
   withdrawFrequency?: BN;
   amountPerPeriod?: BN;
+
+  // supported only on Solana
+  transferableBySender?: boolean;
+  transferableByRecipient?: boolean;
+  cancelableBySender?: boolean;
 }
 
 export type ICancelData = IInteractData;
diff --git a/packages/stream/package.json b/packages/stream/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/stream",
-  "version": "8.0.2",
+  "version": "8.1.0",
   "description": "JavaScript SDK to interact with Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "main": "./dist/cjs/index.cjs",
diff --git a/packages/stream/solana/instructionTypes.ts b/packages/stream/solana/instructionTypes.ts
@@ -94,6 +94,9 @@ export interface IUpdateStreamLayout {
   enable_automatic_withdrawal?: number;
   withdraw_frequency?: Uint8Array;
   amount_per_period?: Uint8Array;
+  transferable_by_sender?: number;
+  transferable_by_recipient?: number;
+  cancelable_by_sender?: number;
 }
 
 export interface ITopupStreamLayout {
diff --git a/packages/stream/solana/instructions.ts b/packages/stream/solana/instructions.ts
@@ -302,6 +302,7 @@ interface UpdateAccounts {
   withdrawor: PublicKey;
   systemProgram: PublicKey;
 }
+
 export const updateStreamInstruction = async (
   params: IUpdateData,
   programId: PublicKey,
@@ -319,6 +320,9 @@ export const updateStreamInstruction = async (
     enable_automatic_withdrawal: Number(params.enableAutomaticWithdrawal),
     withdraw_frequency: params.withdrawFrequency ? params.withdrawFrequency.toArrayLike(Buffer, "le", 8) : undefined,
     amount_per_period: params.amountPerPeriod ? params.amountPerPeriod.toArrayLike(Buffer, "le", 8) : undefined,
+    transferable_by_sender: params.transferableBySender !== undefined ? Number(params.transferableBySender) : undefined,
+    transferable_by_recipient: params.transferableByRecipient !== undefined ? Number(params.transferableByRecipient) : undefined,
+    cancelable_by_sender: params.cancelableBySender !== undefined ? Number(params.cancelableBySender) : undefined,
   };
   const encodeLength = Layout.encodeUpdateStream(decodedData, data);
   data = data.slice(0, encodeLength);
diff --git a/packages/stream/solana/layout.ts b/packages/stream/solana/layout.ts
@@ -153,6 +153,24 @@ export const encodeUpdateStream = (values: IUpdateStreamLayout, data: Buffer): n
   } else {
     structs.push(BufferLayout.u8("amount_per_period_exists"));
   }
+  if (values.transferable_by_sender !== undefined) {
+    structs.push(BufferLayout.u8("transferable_by_sender_exists"));
+    structs.push(BufferLayout.u8("transferable_by_sender"));
+  } else {
+    structs.push(BufferLayout.u8("transferable_by_sender_exists"));
+  }
+  if (values.transferable_by_recipient !== undefined) {
+    structs.push(BufferLayout.u8("transferable_by_recipient_exists"));
+    structs.push(BufferLayout.u8("transferable_by_recipient"));
+  } else {
+    structs.push(BufferLayout.u8("transferable_by_recipient_exists"));
+  }
+  if (values.cancelable_by_sender !== undefined) {
+    structs.push(BufferLayout.u8("cancelable_by_sender_exists"));
+    structs.push(BufferLayout.u8("cancelable_by_sender"));
+  } else {
+    structs.push(BufferLayout.u8("cancelable_by_sender"));
+  }
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return BufferLayout.struct<any>(structs).encode(
     {
@@ -162,6 +180,12 @@ export const encodeUpdateStream = (values: IUpdateStreamLayout, data: Buffer): n
       withdraw_frequency: values.withdraw_frequency ?? 0,
       amount_per_period_exists: values.amount_per_period ? 1 : 0,
       amount_per_period: values.amount_per_period ?? 0,
+      transferable_by_sender_exists: values.transferable_by_sender !== undefined ? 1 : 0,
+      transferable_by_sender: values.transferable_by_sender ?? 0,
+      transferable_by_recipient_exists: values.transferable_by_recipient !== undefined ? 1 : 0,
+      transferable_by_recipient: values.transferable_by_recipient ?? 0,
+      cancelable_by_sender_exists: values.cancelable_by_sender !== undefined ? 1 : 0,
+      cancelable_by_sender: values.cancelable_by_sender ?? 0,
     },
     data,
   );

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/common",`
`3`		`- "version": "8.0.2",`
	`3`	`+ "version": "8.1.0",`
`4`	`4`	`"description": "Common utilities and types used by streamflow packages.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/distributor",`
`3`		`- "version": "8.0.2",`
	`3`	`+ "version": "8.1.0",`
`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/cjs/index.cjs",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/eslint-config",`
`3`		`- "version": "8.0.2",`
	`3`	`+ "version": "8.1.0",`
`4`	`4`	`"description": "ESLint configuration for Streamflow protocol.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"engines": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/launchpad",`
`3`		`- "version": "8.0.2",`
	`3`	`+ "version": "8.1.0",`
`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/cjs/index.cjs",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/staking",`
`3`		`- "version": "8.0.2",`
	`3`	`+ "version": "8.1.0",`
`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/cjs/index.cjs",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@streamflow/stream",`
`3`		`- "version": "8.0.2",`
	`3`	`+ "version": "8.1.0",`
`4`	`4`	`"description": "JavaScript SDK to interact with Streamflow protocol.",`
`5`	`5`	`"homepage": "https://github.com/streamflow-finance/js-sdk/",`
`6`	`6`	`"main": "./dist/cjs/index.cjs",`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,9 @@ export interface IUpdateStreamLayout {`
`94`	`94`	`enable_automatic_withdrawal?: number;`
`95`	`95`	`withdraw_frequency?: Uint8Array;`
`96`	`96`	`amount_per_period?: Uint8Array;`
	`97`	`+ transferable_by_sender?: number;`
	`98`	`+ transferable_by_recipient?: number;`
	`99`	`+ cancelable_by_sender?: number;`
`97`	`100`	`}`
`98`	`101`
`99`	`102`	`export interface ITopupStreamLayout {`