rename, added comments

wormhole-foundation · Nov 28, 2024 · d0c7a9f · d0c7a9f
1 parent 88447d4
commit d0c7a9f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/sdk/route/src/automatic.ts b/sdk/route/src/automatic.ts
@@ -122,15 +122,16 @@ export class NttAutomaticRoute<N extends Network>
     );
 
     const parsedAmount = amount.parse(params.amount, request.source.decimals);
-    const transferAmount = NttRoute.getTransferAmount(
+    // The trimmedAmount may differ from the parsedAmount if the parsedAmount includes dust
+    const trimmedAmount = NttRoute.getTrimmedAmount(
       parsedAmount,
       request.destination.decimals
     );
 
     const validatedParams: Vp = {
       amount: params.amount,
       normalizedParams: {
-        amount: transferAmount,
+        amount: trimmedAmount,
         sourceContracts: NttRoute.resolveNttContracts(
           this.staticConfig,
           request.source.id

diff --git a/sdk/route/src/manual.ts b/sdk/route/src/manual.ts
@@ -103,7 +103,8 @@ export class NttManualRoute<N extends Network>
     const options = params.options ?? this.getDefaultOptions();
 
     const parsedAmount = amount.parse(params.amount, request.source.decimals);
-    const transferAmount = NttRoute.getTransferAmount(
+    // The trimmedAmount may differ from the parsedAmount if the parsedAmount includes dust
+    const trimmedAmount = NttRoute.getTrimmedAmount(
       parsedAmount,
       request.destination.decimals
     );
@@ -118,7 +119,7 @@ export class NttManualRoute<N extends Network>
     const validatedParams: Vp = {
       amount: params.amount,
       normalizedParams: {
-        amount: transferAmount,
+        amount: trimmedAmount,
         sourceContracts: NttRoute.resolveNttContracts(
           this.staticConfig,
           request.source.id

diff --git a/sdk/route/src/types.ts b/sdk/route/src/types.ts
@@ -215,7 +215,7 @@ export namespace NttRoute {
     return amount > threshold;
   }
 
-  export function getTransferAmount(
+  export function getTrimmedAmount(
     amt: amount.Amount,
     dstTokenDecimals: number
   ): amount.Amount {