add docs for update method and expose update on solana properly (#185)

* add docs for update method and expose update on solana properly

lerna.json

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

packages/common/package.json

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

packages/distributor/package.json

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

packages/eslint-config/package.json

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

packages/stream/README.md

@@ -150,6 +150,7 @@ const createStreamParams: Types.ICreateStreamData = {
   amountPerPeriod: getBN(5, 9), // Release rate: how many tokens are unlocked per each period.
   name: "Transfer to Jane Doe.", // The stream name or subject.
   canTopup: false, // setting to FALSE will effectively create a vesting contract.
+  canUpdateRate: false, // settings to TRUE allows sender to update amountPerPeriod
   cancelableBySender: true, // Whether or not sender can cancel the stream.
   cancelableByRecipient: false, // Whether or not recipient can cancel the stream.
   transferableBySender: true, // Whether or not sender can transfer the stream.
@@ -161,7 +162,7 @@ const createStreamParams: Types.ICreateStreamData = {
 
 const solanaParams = {
     sender: wallet, // SignerWalletAdapter or Keypair of Sender account
-    isNative: // [optional] [WILL CREATE A wSOL STREAM] Wether Stream or Vesting should be paid with Solana native token or not
+    isNative: false // [optional] [WILL CREATE A wSOL STREAM] Wether Stream or Vesting should be paid with Solana native token or not
 };
 
 const aptosParams = {
@@ -371,6 +372,37 @@ try {
 }
 ```
 
+## Update a stream
+
+```javascript
+const updateStreamParams: Types.IUpdateData = {
+  id: "AAAAyotqTZZMAAAAmsD1JAgksT8NVAAAASfrGB5RAAAA", // Identifier of a stream to update.
+  enableAutomaticWithdrawal: true,  // [optional], allows to enable AW if it wasn't, disable is not possible
+  withdrawFrequency: 60,  // [optional], allows to update withdrawal frequency, may result in additional AW fees
+  amountPerPeriod: getBN(10, 9),  // [optional], allows to update release amount effective on next unlock
+}
+
+const solanaParams = {
+  invoker: wallet, // SignerWalletAdapter or Keypair signing the transaction
+};
+
+const aptosParams = {
+  senderWallet: wallet, // AptosWalletAdapter Wallet of wallet signing the transaction
+};
+
+const suiParams = {
+  senderWallet: wallet, // WalletContextState | Keypair
+};
+
+const ethereumParams = undefined;
+
+try {
+  const { ixs, tx } = await client.update(updateStreamParams, solanaParams);
+} catch (exception) {
+  // handle exception
+}
+```
+
 ## Get one stream by its ID
 
 ```javascript

packages/stream/package.json

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

packages/stream/solana/StreamClient.ts

@@ -181,6 +181,8 @@ export default class SolanaStreamClient extends BaseStreamClient {
       cliffAmount,
       amountPerPeriod,
       name,
+      canPause,
+      canUpdateRate,
       canTopup,
       cancelableBySender,
       cancelableByRecipient,
@@ -245,6 +247,8 @@ export default class SolanaStreamClient extends BaseStreamClient {
           transferableBySender,
           transferableByRecipient,
           canTopup,
+          canUpdateRate: !!canUpdateRate,
+          canPause: !!canPause,
           name,
           withdrawFrequency: new BN(automaticWithdrawal ? withdrawalFrequency : period),
         },
@@ -324,6 +328,8 @@ export default class SolanaStreamClient extends BaseStreamClient {
       amountPerPeriod,
       name,
       canTopup,
+      canUpdateRate,
+      canPause,
       cancelableBySender,
       cancelableByRecipient,
       transferableBySender,
@@ -389,6 +395,8 @@ export default class SolanaStreamClient extends BaseStreamClient {
         transferableBySender,
         transferableByRecipient,
         canTopup,
+        canUpdateRate: !!canUpdateRate,
+        canPause: !!canPause,
         name,
         withdrawFrequency: new BN(automaticWithdrawal ? withdrawalFrequency : period),
         recipient: recipientPublicKey,
@@ -986,6 +994,8 @@ export default class SolanaStreamClient extends BaseStreamClient {
       period,
       cliff,
       canTopup,
+      canUpdateRate,
+      canPause,
       cancelableBySender,
       cancelableByRecipient,
       transferableBySender,
@@ -1035,6 +1045,8 @@ export default class SolanaStreamClient extends BaseStreamClient {
           transferableBySender,
           transferableByRecipient,
           canTopup,
+          canUpdateRate: !!canUpdateRate,
+          canPause: !!canPause,
           name: recipient.name,
           withdrawFrequency: new BN(automaticWithdrawal ? withdrawalFrequency : period),
         },

packages/stream/solana/instructions.ts

@@ -19,6 +19,8 @@ interface CreateStreamData {
   transferableBySender: boolean;
   transferableByRecipient: boolean;
   canTopup: boolean;
+  canUpdateRate: boolean;
+  canPause: boolean;
   name: string;
   withdrawFrequency: BN;
 }
@@ -100,6 +102,10 @@ export const createStreamInstruction = (
     transferable_by_sender: Number(data.transferableBySender),
     transferable_by_recipient: Number(data.transferableByRecipient),
     can_topup: Number(data.canTopup),
+    _pausable_discriminator: 1,
+    can_update_rate: Number(data.canUpdateRate),
+    _can_update_rate_discriminator: 1,
+    pausable: Number(data.canPause),
     stream_name: streamNameBuffer,
     withdraw_frequency: data.withdrawFrequency.toArrayLike(Buffer, "le", 8),
   };
@@ -127,6 +133,8 @@ interface CreateUncheckedStreamData {
   transferableBySender: boolean;
   transferableByRecipient: boolean;
   canTopup: boolean;
+  canUpdateRate: boolean;
+  canPause: boolean;
   name: string;
   withdrawFrequency: BN;
   recipient: PublicKey;
@@ -197,8 +205,8 @@ export const createUncheckedStreamInstruction = (
     withdraw_frequency: data.withdrawFrequency.toArrayLike(Buffer, "le", 8),
     recipient: data.recipient.toBuffer(),
     partner: data.partner.toBuffer(),
-    pausable: 1,
-    can_update_rate: 1,
+    pausable: Number(data.canPause),
+    can_update_rate: Number(data.canUpdateRate),
   };
   const encodeLength = Layout.createUncheckedStreamLayout.encode(decodedData, bufferData);
   bufferData = bufferData.slice(0, encodeLength);

packages/stream/solana/layout.ts

@@ -91,6 +91,12 @@ export const createStreamLayout: BufferLayout.Structure<ICreateStreamLayout> = B
   BufferLayout.u8("can_topup"),
   BufferLayout.blob(64, "stream_name"),
   BufferLayout.blob(8, "withdraw_frequency"),
+  // discriminator for optional field
+  BufferLayout.u8("_pausable_discriminator"),
+  BufferLayout.u8("pausable"),
+  // discriminator for optional field
+  BufferLayout.u8("_can_update_rate_discriminator"),
+  BufferLayout.u8("can_update_rate"),
 ]);
 
 /**