Amount namespace (#306)

Author: barnjamin

connect/src/protocols/tokenTransfer.ts

@@ -4,12 +4,9 @@ import {
   Network,
   Platform,
   PlatformToChains,
-  amountFromBaseUnits,
-  baseUnits,
   encoding,
-  scaleAmount,
+  amount,
   toChain as toChainName,
-  truncateAmount,
 } from "@wormhole-foundation/sdk-base";
 import {
   AttestationId,
@@ -177,8 +174,8 @@ export class TokenTransfer<N extends Network = Network>
     let from = { chain: vaa.emitterChain, address: vaa.emitterAddress };
     let { token, to } = vaa.payload;
 
-    const scaledAmount = scaleAmount(
-      amountFromBaseUnits(token.amount, TOKEN_BRIDGE_MAX_DECIMALS),
+    const scaledAmount = amount.scale(
+      amount.fromBaseUnits(token.amount, TOKEN_BRIDGE_MAX_DECIMALS),
       await wh.getDecimals(token.chain, token.address),
     );
 
@@ -191,7 +188,7 @@ export class TokenTransfer<N extends Network = Network>
 
     const details: TokenTransferDetails = {
       token: token,
-      amount: baseUnits(scaledAmount),
+      amount: amount.units(scaledAmount),
       from,
       to,
       automatic,
@@ -458,15 +455,15 @@ export class TokenTransfer<N extends Network = Network>
     const srcDecimals = await srcChain.getDecimals(srcToken.address);
     const dstDecimals = await dstChain.getDecimals(dstToken.address);
 
-    const srcAmount = amountFromBaseUnits(transfer.amount, srcDecimals);
+    const srcAmount = amount.fromBaseUnits(transfer.amount, srcDecimals);
 
-    const srcAmountTruncated = truncateAmount(srcAmount, TOKEN_BRIDGE_MAX_DECIMALS);
-    const dstAmountReceivable = scaleAmount(srcAmountTruncated, dstDecimals);
+    const srcAmountTruncated = amount.truncate(srcAmount, TOKEN_BRIDGE_MAX_DECIMALS);
+    const dstAmountReceivable = amount.scale(srcAmountTruncated, dstDecimals);
 
     if (!transfer.automatic) {
       return {
-        sourceToken: { token: srcToken, amount: baseUnits(srcAmountTruncated) },
-        destinationToken: { token: dstToken, amount: baseUnits(dstAmountReceivable) },
+        sourceToken: { token: srcToken, amount: amount.units(srcAmountTruncated) },
+        destinationToken: { token: dstToken, amount: amount.units(dstAmountReceivable) },
       };
     }
 
@@ -476,8 +473,8 @@ export class TokenTransfer<N extends Network = Network>
     // quoted on the source chain
     const stb = await srcChain.getAutomaticTokenBridge();
     const fee = await stb.getRelayerFee(transfer.from.address, transfer.to, srcToken.address);
-    const feeAmountDest = scaleAmount(
-      truncateAmount(amountFromBaseUnits(fee, srcDecimals), TOKEN_BRIDGE_MAX_DECIMALS),
+    const feeAmountDest = amount.scale(
+      amount.truncate(amount.fromBaseUnits(fee, srcDecimals), TOKEN_BRIDGE_MAX_DECIMALS),
       dstDecimals,
     );
 
@@ -504,12 +501,12 @@ export class TokenTransfer<N extends Network = Network>
     }
 
     const destAmountLessFee =
-      baseUnits(dstAmountReceivable) - dstNativeGasAmountRequested - baseUnits(feeAmountDest);
+      amount.units(dstAmountReceivable) - dstNativeGasAmountRequested - amount.units(feeAmountDest);
 
     return {
       sourceToken: {
         token: srcToken,
-        amount: baseUnits(srcAmountTruncated),
+        amount: amount.units(srcAmountTruncated),
       },
       destinationToken: { token: dstToken, amount: destAmountLessFee },
       relayFee: { token: srcToken, amount: fee },

connect/src/routes/cctp/automatic.ts

@@ -1,12 +1,4 @@
-import {
-  Amount,
-  Chain,
-  Network,
-  baseUnits,
-  circle,
-  contracts,
-  displayAmount,
-} from "@wormhole-foundation/sdk-base";
+import { Chain, Network, circle, contracts, amount } from "@wormhole-foundation/sdk-base";
 import {
   ChainContext,
   CircleTransferDetails,
@@ -33,9 +25,9 @@ export namespace AutomaticCCTPRoute {
   };
 
   export type NormalizedParams = {
-    amount: Amount;
-    fee: Amount;
-    nativeGasAmount: Amount;
+    amount: amount.Amount;
+    fee: amount.Amount;
+    nativeGasAmount: amount.Amount;
   };
 
   export interface ValidatedParams extends ValidatedTransferParams<Options> {
@@ -140,19 +132,19 @@ export class AutomaticCCTPRoute<N extends Network>
   }
 
   private async normalizeTransferParams(params: Tp): Promise<AutomaticCCTPRoute.NormalizedParams> {
-    const amount = this.request.parseAmount(params.amount);
+    const amt = this.request.parseAmount(params.amount);
 
     const ctb = await this.request.fromChain.getAutomaticCircleBridge();
     const fee = await ctb.getRelayerFee(this.request.to.chain);
 
     const minAmount = (fee * 105n) / 100n;
-    if (baseUnits(amount) < minAmount) {
+    if (amount.units(amt) < minAmount) {
       throw new Error(
-        `Minimum amount is ${displayAmount(this.request.amountFromBaseUnits(minAmount))}`,
+        `Minimum amount is ${amount.display(this.request.amountFromBaseUnits(minAmount))}`,
       );
     }
 
-    const transferableAmount = baseUnits(amount) - fee;
+    const transferableAmount = amount.units(amt) - fee;
 
     const options = params.options ?? this.getDefaultOptions();
 
@@ -170,7 +162,7 @@ export class AutomaticCCTPRoute<N extends Network>
 
     return {
       fee: this.request.amountFromBaseUnits(fee),
-      amount,
+      amount: amt,
       nativeGasAmount: this.request.amountFromBaseUnits(nativeGasAmount),
     };
   }
@@ -179,9 +171,9 @@ export class AutomaticCCTPRoute<N extends Network>
     return {
       from: this.request.from,
       to: this.request.to,
-      amount: baseUnits(params.normalizedParams.amount),
+      amount: amount.units(params.normalizedParams.amount),
       automatic: true,
-      nativeGas: baseUnits(params.normalizedParams.nativeGasAmount),
+      nativeGas: amount.units(params.normalizedParams.nativeGasAmount),
     };
   }
 

connect/src/routes/cctp/manual.ts

@@ -1,11 +1,4 @@
-import {
-  Amount,
-  Chain,
-  Network,
-  baseUnits,
-  circle,
-  contracts,
-} from "@wormhole-foundation/sdk-base";
+import { Chain, Network, circle, contracts, amount } from "@wormhole-foundation/sdk-base";
 import {
   ChainContext,
   CircleBridge,
@@ -27,7 +20,7 @@ export namespace CCTPRoute {
   };
 
   export type NormalizedParams = {
-    amount: Amount;
+    amount: amount.Amount;
   };
 
   export interface ValidatedParams extends ValidatedTransferParams<Options> {
@@ -164,7 +157,7 @@ export class CCTPRoute<N extends Network>
     return {
       from: this.request.from,
       to: this.request.to,
-      amount: baseUnits(params.normalizedParams.amount),
+      amount: amount.units(params.normalizedParams.amount),
       automatic: false,
       ...params.options,
     };

connect/src/routes/mock/automatic.ts

@@ -10,7 +10,7 @@ import {
   WormholeMessageId,
   encoding,
   nativeTokenId,
-  parseAmount,
+  amount,
 } from "../..";
 import { AutomaticRoute, StaticRouteMethods } from "../route";
 import {
@@ -79,15 +79,15 @@ export class AutomaticMockRoute<N extends Network>
     const fakeQuote: Q = {
       sourceToken: {
         token: this.request.source.id,
-        amount: parseAmount(params.amount, this.request.source.decimals),
+        amount: amount.parse(params.amount, this.request.source.decimals),
       },
       destinationToken: {
         token: this.request.destination!.id,
-        amount: parseAmount(params.amount, this.request.destination.decimals),
+        amount: amount.parse(params.amount, this.request.destination.decimals),
       },
       relayFee: {
         token: this.request.source.id,
-        amount: parseAmount("0.01", this.request.source.decimals),
+        amount: amount.parse("0.01", this.request.source.decimals),
       },
     };
     return fakeQuote;

connect/src/routes/mock/manual.ts

@@ -11,7 +11,7 @@ import {
   WormholeMessageId,
   encoding,
   nativeTokenId,
-  parseAmount,
+  amount,
 } from "../..";
 import { ManualRoute, StaticRouteMethods } from "../route";
 import {
@@ -74,15 +74,15 @@ export class ManualMockRoute<N extends Network>
     const fakeQuote: Q = {
       sourceToken: {
         token: this.request.source.id,
-        amount: parseAmount(params.amount, this.request.destination.decimals),
+        amount: amount.parse(params.amount, this.request.destination.decimals),
       },
       destinationToken: {
         token: this.request.destination!.id,
-        amount: parseAmount(params.amount, this.request.destination.decimals),
+        amount: amount.parse(params.amount, this.request.destination.decimals),
       },
       relayFee: {
         token: this.request.source.id,
-        amount: parseAmount("0.01", this.request.source.decimals),
+        amount: amount.parse("0.01", this.request.source.decimals),
       },
     };
     return fakeQuote;

connect/src/routes/portico/automatic.ts

@@ -1,5 +1,4 @@
 import {
-  Amount,
   AttestationReceipt,
   Chain,
   ChainContext,
@@ -12,7 +11,6 @@ import {
   TransactionId,
   TransferState,
   Wormhole,
-  baseUnits,
   canonicalAddress,
   chainToPlatform,
   contracts,
@@ -22,6 +20,7 @@ import {
   resolveWrappedToken,
   signSendWait,
   tokens,
+  amount,
 } from "../..";
 import { AutomaticRoute, StaticRouteMethods } from "../route";
 import {
@@ -43,7 +42,7 @@ export namespace PorticoRoute {
   }
 
   export type NormalizedParams = {
-    amount: Amount;
+    amount: amount.Amount;
 
     canonicalSourceToken: TokenId;
     canonicalDestinationToken: TokenId;
@@ -237,7 +236,7 @@ export class AutomaticPorticoRoute<N extends Network>
       ...(await this.request.displayQuote({
         sourceToken: {
           token: params.normalizedParams.sourceToken,
-          amount: baseUnits(params.normalizedParams.amount),
+          amount: amount.units(params.normalizedParams.amount),
         },
         destinationToken: {
           token: params.normalizedParams.destinationToken,
@@ -260,7 +259,7 @@ export class AutomaticPorticoRoute<N extends Network>
       this.request.from.address,
       this.request.to,
       sourceToken,
-      baseUnits(params.normalizedParams.amount),
+      amount.units(params.normalizedParams.amount),
       destToken!,
       params.quote!.quote,
     );
@@ -300,7 +299,7 @@ export class AutomaticPorticoRoute<N extends Network>
     const startQuote = await fromPorticoBridge.quoteSwap(
       params.normalizedParams.sourceToken.address,
       params.normalizedParams.canonicalSourceToken.address,
-      baseUnits(params.normalizedParams.amount),
+      amount.units(params.normalizedParams.amount),
     );
     const startSlippage = (startQuote * SLIPPAGE_BPS) / BPS_PER_HUNDRED_PERCENT;
 

connect/src/routes/request.ts

@@ -1,4 +1,4 @@
-import { Amount, Network, amountFromBaseUnits, parseAmount } from "@wormhole-foundation/sdk-base";
+import { Network, amount } from "@wormhole-foundation/sdk-base";
 import { ChainAddress, ChainContext, TokenId } from "@wormhole-foundation/sdk-definitions";
 import { TransferQuote } from "../types";
 import { Wormhole } from "../wormhole";
@@ -30,12 +30,12 @@ export class RouteTransferRequest<N extends Network> {
     this.destination = destination;
   }
 
-  parseAmount(amt: string): Amount {
-    return parseAmount(amt, this.source.decimals);
+  parseAmount(amt: string): amount.Amount {
+    return amount.parse(amt, this.source.decimals);
   }
 
-  amountFromBaseUnits(amt: bigint): Amount {
-    return amountFromBaseUnits(amt, this.source.decimals);
+  amountFromBaseUnits(amt: bigint): amount.Amount {
+    return amount.fromBaseUnits(amt, this.source.decimals);
   }
 
   async displayQuote(quote: TransferQuote): Promise<Quote> {
@@ -48,23 +48,23 @@ export class RouteTransferRequest<N extends Network> {
     let dq: Quote = {
       sourceToken: {
         token: quote.sourceToken.token,
-        amount: amountFromBaseUnits(quote.sourceToken.amount, this.source.decimals),
+        amount: amount.fromBaseUnits(quote.sourceToken.amount, this.source.decimals),
       },
       destinationToken: {
         token: quote.destinationToken.token,
-        amount: amountFromBaseUnits(quote.destinationToken.amount, dstDecimals),
+        amount: amount.fromBaseUnits(quote.destinationToken.amount, dstDecimals),
       },
     };
 
     if (quote.relayFee) {
       dq.relayFee = {
         token: quote.relayFee.token,
-        amount: amountFromBaseUnits(quote.relayFee.amount, this.source.decimals),
+        amount: amount.fromBaseUnits(quote.relayFee.amount, this.source.decimals),
       };
     }
 
     if (quote.destinationNativeGas) {
-      dq.destinationNativeGas = amountFromBaseUnits(
+      dq.destinationNativeGas = amount.fromBaseUnits(
         quote.destinationNativeGas,
         this.destination.decimals,
       );