Merge pull request #91 from tinymanorg/feat/extra-app-call-note

Include extra app call note data if added to the params
tinymanorg · Aug 30, 2024 · b22e80e · b22e80e
2 parents 9d83dd5 + 5e1fd04
commit b22e80e
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 8 deletions.
diff --git a/dist/config.d.ts b/dist/config.d.ts
@@ -8,7 +8,7 @@ declare class TinymanJSSDKConfig {
     /**
      * @returns {Uint8Array} - encoded note includings version with client name
      */
-    getAppCallTxnNoteWithClientName(contractVersion: ContractVersionValue): Uint8Array;
+    getAppCallTxnNoteWithClientName(contractVersion: ContractVersionValue, extraData?: Record<string, string>): Uint8Array;
 }
 export declare const tinymanJSSDKConfig: TinymanJSSDKConfig;
 export {};
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/swap/types.d.ts b/dist/swap/types.d.ts
@@ -104,6 +104,7 @@ export interface GenerateSwapTxnsParams {
     swapType: SwapType;
     slippage: number;
     initiatorAddr: string;
+    appCallNoteExtraData?: Record<string, string>;
 }
 export type GenerateV1_1SwapTxnsParams = Omit<GenerateSwapTxnsParams, "quote" | "network"> & {
     quoteAndPool: DirectSwapQuoteAndPool;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tinymanorg/tinyman-js-sdk",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "description": "Tinyman JS SDK",
   "author": "Tinyman Core Team",
   "license": "MIT",

diff --git a/src/config.ts b/src/config.ts
@@ -21,11 +21,15 @@ class TinymanJSSDKConfig {
   /**
    * @returns {Uint8Array} - encoded note includings version with client name
    */
-  getAppCallTxnNoteWithClientName(contractVersion: ContractVersionValue): Uint8Array {
+  getAppCallTxnNoteWithClientName(
+    contractVersion: ContractVersionValue,
+    extraData?: Record<string, string>
+  ): Uint8Array {
     const versionMarker =
       contractVersion === CONTRACT_VERSION.V1_1 ? "v1" : contractVersion;
+    const data = JSON.stringify({origin: this.clientName, ...extraData});
 
-    return encodeString(`tinyman/${versionMarker}:j{"origin":"${this.clientName}"}`);
+    return encodeString(`tinyman/${versionMarker}:j${data}`);
   }
 }
 

diff --git a/src/swap/types.ts b/src/swap/types.ts
@@ -117,6 +117,7 @@ export interface GenerateSwapTxnsParams {
   swapType: SwapType;
   slippage: number;
   initiatorAddr: string;
+  appCallNoteExtraData?: Record<string, string>;
 }
 
 export type GenerateV1_1SwapTxnsParams = Omit<

diff --git a/src/swap/v2/index.ts b/src/swap/v2/index.ts
@@ -107,7 +107,10 @@ async function generateTxns(
       V2_SWAP_APP_CALL_SWAP_TYPE_ARGS_ENCODED[swapType],
       algosdk.encodeUint64(assetOutAmount)
     ],
-    note: tinymanJSSDKConfig.getAppCallTxnNoteWithClientName(CONTRACT_VERSION.V2),
+    note: tinymanJSSDKConfig.getAppCallTxnNoteWithClientName(
+      CONTRACT_VERSION.V2,
+      params.appCallNoteExtraData
+    ),
     accounts: [poolAddress],
     foreignAssets: [pool.asset1ID, pool.asset2ID],
     suggestedParams