feat: support price based update (#315)

Author: Yolley

lerna.json

@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "9.0.4",
+  "version": "9.1.0",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "command": {
     "run": {

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/common",
-  "version": "9.0.4",
+  "version": "9.1.0",
   "description": "Common utilities and types used by streamflow packages.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "type": "module",

packages/distributor/package.json

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

packages/eslint-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamflow/eslint-config",
-  "version": "9.0.4",
+  "version": "9.1.0",
   "description": "ESLint configuration for Streamflow protocol.",
   "homepage": "https://github.com/streamflow-finance/js-sdk/",
   "engines": {

packages/launchpad/package.json

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

packages/staking/package.json

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

packages/stream/package.json

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

packages/stream/solana/StreamClient.ts

@@ -408,7 +408,10 @@ export class SolanaStreamClient extends BaseStreamClient {
     } = streamParams;
     const { isNative, sender, computeLimit, computePrice, metadataPubKeys } = extParams;
 
-    invariant(priceOracle || !oracleType || oracleType === "none", "Price oracle is required for the specified oracle type" );
+    invariant(
+      priceOracle || !oracleType || oracleType === "none",
+      "Price oracle is required for the specified oracle type",
+    );
     assertHasPublicKey(sender, "Sender's PublicKey is not available, check passed wallet adapter!");
 
     const recipientPublicKey = new PublicKey(recipient);
@@ -441,10 +444,10 @@ export class SolanaStreamClient extends BaseStreamClient {
     // We already have getCreateATAInstructions for WSOL and sender address
     // This check avoids sending double create ATA instructions which would cause transaction to fail
     if (recipientPublicKey.toString() !== sender.toString() || !isNative) {
-    ixs.push(
-      ...(await this.getCreateATAInstructions([recipientPublicKey], mintPublicKey, sender, true, tokenProgramId)),
-    );
-  }
+      ixs.push(
+        ...(await this.getCreateATAInstructions([recipientPublicKey], mintPublicKey, sender, true, tokenProgramId)),
+      );
+    }
 
     const encodedUIntArray = new TextEncoder().encode(streamName);
     const streamNameArray = Array.from(encodedUIntArray);
@@ -533,7 +536,6 @@ export class SolanaStreamClient extends BaseStreamClient {
     }: ICreateStreamData,
     { sender, metadataPubKeys, isNative = false, computePrice, computeLimit }: IPrepareCreateStreamSolanaExt,
   ): Promise<ICreateStreamInstructions> {
-
     assertHasPublicKey(sender, "Sender's PublicKey is not available, check passed wallet adapter!");
 
     const ixs: TransactionInstruction[] = prepareBaseInstructions(this.connection, {
@@ -622,10 +624,7 @@ export class SolanaStreamClient extends BaseStreamClient {
    * @returns Create result
    */
   public async createUnchecked(data: ICreateStreamData, extParams: ICreateStreamSolanaExt): Promise<ICreateResult> {
-
-    const { ixs, metadata, metadataPubKey } = await this.prepareCreateUncheckedInstructions(data, 
-      extParams,
-    );
+    const { ixs, metadata, metadataPubKey } = await this.prepareCreateUncheckedInstructions(data, extParams);
     const { tx, hash, context } = await prepareTransaction(
       this.connection,
       ixs,
@@ -820,20 +819,11 @@ export class SolanaStreamClient extends BaseStreamClient {
       });
     }
 
-    const prepareInstructions = await this.getCreateATAInstructions(
-      [partnerPublicKey],
-      mintPublicKey,
-      sender,
-      true,
-    );
+    const prepareInstructions = await this.getCreateATAInstructions([partnerPublicKey], mintPublicKey, sender, true);
 
     if (isNative) {
       const totalDepositedAmount = recipients.reduce((acc, recipient) => recipient.amount.add(acc), new BN(0));
-      const nativeInstructions = await prepareWrappedAccount(
-        this.connection,
-        sender.publicKey,
-        totalDepositedAmount,
-      );
+      const nativeInstructions = await prepareWrappedAccount(this.connection, sender.publicKey, totalDepositedAmount);
       prepareInstructions.push(...nativeInstructions);
     }
 
@@ -1094,8 +1084,7 @@ export class SolanaStreamClient extends BaseStreamClient {
 
     assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
 
-    const ixs: TransactionInstruction[] = await this.prepareWithdrawInstructions({ id, amount }, 
-extParams);
+    const ixs: TransactionInstruction[] = await this.prepareWithdrawInstructions({ id, amount }, extParams);
 
     const metadata = new PublicKey(id);
     await this.applyCustomAfterInstructions(ixs, customInstructions, metadata);
@@ -1126,7 +1115,6 @@ extParams);
     { id, amount = WITHDRAW_AVAILABLE_AMOUNT }: IWithdrawData,
     { invoker, checkTokenAccounts, computePrice, computeLimit }: IPrepareStreamSolanaExt,
   ): Promise<TransactionInstruction[]> {
-
     assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
 
     const ixs: TransactionInstruction[] = prepareBaseInstructions(this.connection, {
@@ -1179,7 +1167,6 @@ extParams);
    * @returns Transaction result
    */
   public async cancel(cancelData: ICancelData, extParams: IInteractStreamSolanaExt): Promise<ITransactionResult> {
-
     const ixs = await this.prepareCancelInstructions(cancelData, extParams);
     const { tx, hash, context } = await prepareTransaction(this.connection, ixs, extParams.invoker.publicKey);
     const signature = await signAndExecuteTransaction(
@@ -1232,7 +1219,6 @@ extParams);
     { id }: ICancelData,
     { invoker, checkTokenAccounts, computePrice, computeLimit }: IPrepareStreamSolanaExt,
   ): Promise<TransactionInstruction[]> {
-
     assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
 
     const streamPublicKey = new PublicKey(id);
@@ -1285,7 +1271,6 @@ extParams);
     { id }: ICancelData,
     { invoker, checkTokenAccounts, computePrice, computeLimit }: IPrepareStreamSolanaExt,
   ): Promise<TransactionInstruction[]> {
-
     assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
 
     const streamPublicKey = new PublicKey(id);
@@ -1373,7 +1358,6 @@ extParams);
     { id, newRecipient }: ITransferData,
     { invoker, computePrice, computeLimit = 100001 }: IPrepareStreamSolanaExt,
   ): Promise<TransactionInstruction[]> {
-
     assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
 
     const ixs: TransactionInstruction[] = prepareBaseInstructions(this.connection, {
@@ -1655,7 +1639,7 @@ extParams);
           const alignedProxy = await this.alignedProxyProgram.account.contract.fetch(
             deriveContractPDA(this.alignedProxyProgram.programId, pubkey),
           );
-invariant(alignedProxy, "Couldn't get aligned proxy account info");
+          invariant(alignedProxy, "Couldn't get aligned proxy account info");
           return { publicKey: pubkey, account: new AlignedContract(stream, alignedProxy) };
         }
         return { publicKey: pubkey, account: new Contract(stream) };
@@ -1704,25 +1688,41 @@ invariant(alignedProxy, "Couldn't get aligned proxy account info");
     data: IUpdateData,
     { invoker, computePrice, computeLimit }: IPrepareStreamSolanaExt,
   ): Promise<TransactionInstruction[]> {
-
     assertHasPublicKey(invoker, "Invoker's PublicKey is not available, check passed wallet adapter!");
 
     const streamPublicKey = new PublicKey(data.id);
     const escrow = await this.connection.getAccountInfo(streamPublicKey);
 
     invariant(escrow, "Couldn't get account info");
 
+    const { sender: senderPublicKey } = decodeStream(escrow.data);
+    const isAlignedUnlock = this.isAlignedUnlock(streamPublicKey, senderPublicKey);
+
+    if (isAlignedUnlock && (data.enableAutomaticWithdrawal !== undefined || data.amountPerPeriod !== undefined)) {
+      throw new Error("Automatic withdrawal and rate update are not possible in price-based vesting!");
+    }
+
     const ixs: TransactionInstruction[] = prepareBaseInstructions(this.connection, {
       computePrice,
       computeLimit,
     });
     ixs.push(
-      await updateStreamInstruction(data, this.programId, {
-        authority: invoker.publicKey,
-        metadata: streamPublicKey,
-        withdrawor: WITHDRAWOR_PUBLIC_KEY,
-        systemProgram: SystemProgram.programId,
-      }),
+      await (isAlignedUnlock
+        ? this.alignedProxyProgram.methods
+            .updateContract({
+              transferableBySender: data.transferableBySender ?? null,
+              transferableByRecipient: data.transferableByRecipient ?? null,
+              cancelableBySender: data.cancelableBySender ?? null,
+            })
+            .accounts({ sender: invoker.publicKey, streamMetadata: streamPublicKey, withdrawor: WITHDRAWOR_PUBLIC_KEY })
+            .accountsPartial({ streamflowProgram: this.programId })
+            .instruction()
+        : updateStreamInstruction(data, this.programId, {
+            authority: invoker.publicKey,
+            metadata: streamPublicKey,
+            withdrawor: WITHDRAWOR_PUBLIC_KEY,
+            systemProgram: SystemProgram.programId,
+          })),
     );
 
     return ixs;
@@ -1771,13 +1771,13 @@ invariant(alignedProxy, "Couldn't get aligned proxy account info");
     return extractSolanaErrorCode(err.toString() ?? "Unknown error!", logs);
   }
 
-    /**
+  /**
    * Utility function that checks whether the associated stream address is an aligned unlock contract, indicated by whether the sender/creator is a PDA
    */
-    public isAlignedUnlock(streamPublicKey: PublicKey, senderPublicKey: PublicKey) {
-      const pda = deriveContractPDA(this.alignedProxyProgram.programId, streamPublicKey);
-      return senderPublicKey.equals(pda);
-    }
+  public isAlignedUnlock(streamPublicKey: PublicKey, senderPublicKey: PublicKey) {
+    const pda = deriveContractPDA(this.alignedProxyProgram.programId, streamPublicKey);
+    return senderPublicKey.equals(pda);
+  }
 
   /**
    * Utility function to generate metadata for a Contract or return existing Pubkey
@@ -1833,4 +1833,3 @@ invariant(alignedProxy, "Couldn't get aligned proxy account info");
     }
   }
 }
-

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

@@ -2,7 +2,7 @@
   "address": "aSTRM2NKoKxNnkmLWk9sz3k74gKBk9t7bpPrTGxMszH",
   "metadata": {
     "name": "streamflow_aligned_unlocks",
-    "version": "1.3.0",
+    "version": "1.4.0",
     "spec": "0.1.0",
     "description": "Proxy to update unlock amount within Streamflow vesting protocol according to Token performance and other metrics"
   },
@@ -876,6 +876,80 @@
       ],
       "args": []
     },
+    {
+      "name": "update_contract",
+      "discriminator": [
+        78,
+        184,
+        162,
+        174,
+        233,
+        5,
+        40,
+        82
+      ],
+      "accounts": [
+        {
+          "name": "sender",
+          "writable": true,
+          "signer": true
+        },
+        {
+          "name": "proxy_metadata",
+          "docs": [
+            "Proxy Contract"
+          ],
+          "writable": true,
+          "pda": {
+            "seeds": [
+              {
+                "kind": "const",
+                "value": [
+                  99,
+                  111,
+                  110,
+                  116,
+                  114,
+                  97,
+                  99,
+                  116
+                ]
+              },
+              {
+                "kind": "account",
+                "path": "stream_metadata"
+              }
+            ]
+          }
+        },
+        {
+          "name": "stream_metadata",
+          "writable": true
+        },
+        {
+          "name": "withdrawor",
+          "writable": true
+        },
+        {
+          "name": "streamflow_program",
+          "address": "strmRqUCoQUgGUan5YhzUZa6KqdzwX5L6FpUxfmKg5m"
+        },
+        {
+          "name": "system_program",
+          "address": "11111111111111111111111111111111"
+        }
+      ],
+      "args": [
+        {
+          "name": "params",
+          "type": {
+            "defined": {
+              "name": "UpdateContractParams"
+            }
+          }
+        }
+      ]
+    },
     {
       "name": "update_test_oracle",
       "discriminator": [
@@ -1471,6 +1545,32 @@
         ]
       }
     },
+    {
+      "name": "UpdateContractParams",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "transferable_by_sender",
+            "type": {
+              "option": "bool"
+            }
+          },
+          {
+            "name": "transferable_by_recipient",
+            "type": {
+              "option": "bool"
+            }
+          },
+          {
+            "name": "cancelable_by_sender",
+            "type": {
+              "option": "bool"
+            }
+          }
+        ]
+      }
+    },
     {
       "name": "UpdateTestOracleParams",
       "type": {