Bug Fixes: misc (#302)

Author: barnjamin

.gitignore

@@ -6,3 +6,4 @@ node_modules/
 tsconfig-build.tsbuildinfo
 tsconfig.tsbuildinfo
 __tests__/staging
+wormhole-foundation-*.tgz

VERSION

@@ -1 +1 @@
-0.4.0-beta.5
+0.4.0-beta.8

connect/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wormhole-foundation/connect-sdk",
-  "version": "0.4.0-beta.5",
+  "version": "0.4.0-beta.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wormhole-foundation/connect-sdk.git"
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "axios": "^1.4.0",
-    "@wormhole-foundation/sdk-base": "^0.4.0-beta.5",
-    "@wormhole-foundation/sdk-definitions": "^0.4.0-beta.5"
+    "@wormhole-foundation/sdk-base": "^0.4.0-beta.8",
+    "@wormhole-foundation/sdk-definitions": "^0.4.0-beta.8"
   }
 }

connect/src/protocols/tokenTransfer.ts

@@ -461,53 +461,57 @@ export class TokenTransfer<N extends Network = Network>
     const srcAmount = amountFromBaseUnits(transfer.amount, srcDecimals);
 
     const srcAmountTruncated = truncateAmount(srcAmount, TOKEN_BRIDGE_MAX_DECIMALS);
-    const dstAmountTruncated = scaleAmount(srcAmountTruncated, dstDecimals);
+    const dstAmountReceivable = scaleAmount(srcAmountTruncated, dstDecimals);
 
     if (!transfer.automatic) {
       return {
         sourceToken: { token: srcToken, amount: baseUnits(srcAmountTruncated) },
-        destinationToken: { token: dstToken, amount: baseUnits(dstAmountTruncated) },
+        destinationToken: { token: dstToken, amount: baseUnits(dstAmountReceivable) },
       };
     }
 
     // Otherwise automatic
 
-    // If a native gas dropoff is requested, remove that from the amount they'll get
-    const dstNativeGasAmount = scaleAmount(
-      truncateAmount(
-        amountFromBaseUnits(transfer.nativeGas ?? 0n, srcDecimals),
-        TOKEN_BRIDGE_MAX_DECIMALS,
-      ),
-      dstDecimals,
-    );
-    const dstNativeGasBaseUnits = baseUnits(dstNativeGasAmount);
-
-    let dstAmountBaseUnits = baseUnits(dstAmountTruncated) - dstNativeGasBaseUnits;
-
-    // The fee is also removed from the amount transferred
+    // The fee is removed from the amount transferred
     // 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),
       dstDecimals,
     );
-    dstAmountBaseUnits -= baseUnits(feeAmountDest);
+
+    let dstNativeGasAmountRequested = transfer.nativeGas ?? 0n;
 
     // The expected destination gas can be pulled from the destination token bridge
     let destinationNativeGas = 0n;
     if (transfer.nativeGas) {
       const dtb = await dstChain.getAutomaticTokenBridge();
-      destinationNativeGas = await dtb.nativeTokenAmount(dstToken.address, dstNativeGasBaseUnits);
+
+      // There is a limit applied to the amount of the source
+      // token that may be swapped for native gas on the destination
+      const maxNativeAmountIn = await dtb.maxSwapAmount(dstToken.address);
+      dstNativeGasAmountRequested =
+        dstNativeGasAmountRequested > maxNativeAmountIn
+          ? maxNativeAmountIn
+          : dstNativeGasAmountRequested;
+
+      // Get the actual amount we should receive
+      destinationNativeGas = await dtb.nativeTokenAmount(
+        dstToken.address,
+        dstNativeGasAmountRequested,
+      );
     }
 
+    const destAmountLessFee =
+      baseUnits(dstAmountReceivable) - dstNativeGasAmountRequested - baseUnits(feeAmountDest);
+
     return {
       sourceToken: {
         token: srcToken,
         amount: baseUnits(srcAmountTruncated),
       },
-      destinationToken: { token: dstToken, amount: dstAmountBaseUnits },
+      destinationToken: { token: dstToken, amount: destAmountLessFee },
       relayFee: { token: srcToken, amount: fee },
       destinationNativeGas,
     };

connect/src/routes/mock/automatic.ts

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

connect/src/routes/mock/manual.ts

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

connect/src/routes/portico/automatic.ts

@@ -234,7 +234,7 @@ export class AutomaticPorticoRoute<N extends Network>
 
     return {
       quote,
-      ...this.request.displayQuote({
+      ...(await this.request.displayQuote({
         sourceToken: {
           token: params.normalizedParams.sourceToken,
           amount: baseUnits(params.normalizedParams.amount),
@@ -247,7 +247,7 @@ export class AutomaticPorticoRoute<N extends Network>
           token: params.normalizedParams.destinationToken,
           amount: fee,
         },
-      }),
+      })),
     };
   }
 

connect/src/routes/request.ts

@@ -1,11 +1,5 @@
-import { Network, amountFromBaseUnits, displayAmount } from "@wormhole-foundation/sdk-base";
-import {
-  ChainAddress,
-  ChainContext,
-  TokenId,
-  isSameToken,
-} from "@wormhole-foundation/sdk-definitions";
-import { Amount, parseAmount } from "@wormhole-foundation/sdk-base";
+import { Amount, Network, amountFromBaseUnits, parseAmount } from "@wormhole-foundation/sdk-base";
+import { ChainAddress, ChainContext, TokenId } from "@wormhole-foundation/sdk-definitions";
 import { TransferQuote } from "../types";
 import { Wormhole } from "../wormhole";
 import { TokenDetails, getTokenDetails } from "./token";
@@ -44,36 +38,35 @@ export class RouteTransferRequest<N extends Network> {
     return amountFromBaseUnits(amt, this.source.decimals);
   }
 
-  displayQuote(quote: TransferQuote): Quote {
+  async displayQuote(quote: TransferQuote): Promise<Quote> {
+    // If we have a destination native gas
+    // since the dest token is `native` on the dest chain
+    const dstDecimals = quote.destinationNativeGas
+      ? await this.toChain.getDecimals(quote.destinationToken.token.address)
+      : this.destination.decimals;
+
     let dq: Quote = {
       sourceToken: {
         token: quote.sourceToken.token,
-        amount: displayAmount(amountFromBaseUnits(quote.sourceToken.amount, this.source.decimals)),
+        amount: amountFromBaseUnits(quote.sourceToken.amount, this.source.decimals),
       },
       destinationToken: {
         token: quote.destinationToken.token,
-        amount: displayAmount(
-          amountFromBaseUnits(quote.destinationToken.amount, this.destination.decimals),
-        ),
+        amount: amountFromBaseUnits(quote.destinationToken.amount, dstDecimals),
       },
     };
 
     if (quote.relayFee) {
-      let amount = isSameToken(quote.relayFee.token, quote.sourceToken.token)
-        ? displayAmount(amountFromBaseUnits(quote.sourceToken.amount, this.source.decimals))
-        : displayAmount(
-            amountFromBaseUnits(quote.destinationToken.amount, this.destination.decimals),
-          );
-
       dq.relayFee = {
         token: quote.relayFee.token,
-        amount,
+        amount: amountFromBaseUnits(quote.relayFee.amount, this.source.decimals),
       };
     }
 
     if (quote.destinationNativeGas) {
-      dq.destinationNativeGas = displayAmount(
-        amountFromBaseUnits(quote.destinationNativeGas, this.source.decimals),
+      dq.destinationNativeGas = amountFromBaseUnits(
+        quote.destinationNativeGas,
+        this.destination.decimals,
       );
     }
 

connect/src/routes/tokenBridge/automatic.ts

@@ -1,10 +1,10 @@
 import {
+  Amount,
   Chain,
   Network,
-  contracts,
-  Amount,
-  baseUnits,
   amountFromBaseUnits,
+  baseUnits,
+  contracts,
   displayAmount,
 } from "@wormhole-foundation/sdk-base";
 import {
@@ -86,7 +86,7 @@ export class AutomaticTokenBridgeRoute<N extends Network>
     ];
   }
 
-  // get the liist of destination tokens that may be recieved on the destination chain
+  // get the list of destination tokens that may be recieved on the destination chain
   static async supportedDestinationTokens<N extends Network>(
     sourceToken: TokenId,
     fromChain: ChainContext<N>,
@@ -120,20 +120,17 @@ export class AutomaticTokenBridgeRoute<N extends Network>
     try {
       const options = params.options ?? this.getDefaultOptions();
 
-      const { destination } = this.request;
-      let nativeGasPerc = options.nativeGas ?? 0.0;
-
-      if (nativeGasPerc > 1.0 || nativeGasPerc < 0.0)
+      if (options.nativeGas && (options.nativeGas > 1.0 || options.nativeGas < 0.0))
         throw new Error("Native gas must be between 0.0 and 1.0 (0% and 100%)");
 
       // If destination is native, max out the nativeGas requested
-      if (destination && isNative(destination.id.address) && nativeGasPerc === 0.0)
-        nativeGasPerc = 1.0;
+      const { destination } = this.request;
+      if (isNative(destination.id.address) && options.nativeGas === 0.0) options.nativeGas = 1.0;
 
+      const updatedParams = { ...params, options };
       const validatedParams: Vp = {
-        amount: params.amount,
-        options: { ...params.options, nativeGas: nativeGasPerc },
-        normalizedParams: await this.normalizeTransferParams(params),
+        ...updatedParams,
+        normalizedParams: await this.normalizeTransferParams(updatedParams),
       };
 
       return { valid: true, params: validatedParams };
@@ -142,7 +139,9 @@ export class AutomaticTokenBridgeRoute<N extends Network>
     }
   }
 
-  async normalizeTransferParams(params: Tp): Promise<AutomaticTokenBridgeRoute.NormalizedParams> {
+  private async normalizeTransferParams(
+    params: Tp,
+  ): Promise<AutomaticTokenBridgeRoute.NormalizedParams> {
     const amount = this.request.parseAmount(params.amount);
 
     const inputToken = isNative(this.request.source.id.address)
@@ -159,29 +158,22 @@ export class AutomaticTokenBridgeRoute<N extends Network>
     // Min amount is fee + 5%
     const minAmount = (fee * 105n) / 100n;
     if (baseUnits(amount) < minAmount) {
-      throw new Error(`Minimum amount is ${displayAmount(amount)}`);
+      throw new Error(
+        `Minimum amount is ${displayAmount({
+          amount: minAmount.toString(),
+          decimals: amount.decimals,
+        })}`,
+      );
     }
 
-    const transferableAmount = baseUnits(amount) - fee;
-
-    const { destination } = this.request;
-    const options = params.options ?? this.getDefaultOptions();
-
-    let nativeGasPerc = options.nativeGas ?? 0.0;
-    // If destination is native, max out the nativeGas requested
-    if (destination && isNative(destination.id.address) && nativeGasPerc === 0.0)
-      nativeGasPerc = 1.0;
-    if (nativeGasPerc > 1.0 || nativeGasPerc < 0.0) {
-      throw new Error("Native gas must be between 0.0 and 1.0 (0% and 100%)");
-    }
+    const redeemableAmount = baseUnits(amount) - fee;
 
     // Determine nativeGas
     let nativeGasAmount = 0n;
-    if (nativeGasPerc > 0) {
-      // TODO: currently supporting 2 decimals of the percentage requested
+    if (params.options && params.options.nativeGas > 0) {
       const scale = 10000;
-      const scaledGas = BigInt(options.nativeGas * scale);
-      nativeGasAmount = (transferableAmount * scaledGas) / BigInt(scale);
+      const scaledGas = BigInt(params.options.nativeGas * scale);
+      nativeGasAmount = (redeemableAmount * scaledGas) / BigInt(scale);
     }
 
     return {

connect/src/routes/types.ts

@@ -1,5 +1,6 @@
 import { TokenId } from "@wormhole-foundation/sdk-definitions";
 import { AttestationReceipt, TransferReceipt } from "../types";
+import { Amount } from "@wormhole-foundation/sdk-base";
 
 // Extend Options to provide custom options
 // to use for the transfer
@@ -19,23 +20,22 @@ export type Receipt<AT extends AttestationReceipt = AttestationReceipt> = Transf
 export interface Quote {
   sourceToken: {
     token: TokenId;
-    amount: string;
+    amount: Amount;
   };
-
   destinationToken: {
     token: TokenId;
-    amount: string;
+    amount: Amount;
   };
   // If the transfer being quoted is automatic
   // a relayer fee may apply
   relayFee?: {
     token: TokenId;
-    amount: string;
+    amount: Amount;
   };
   // If the transfer being quoted asked for native gas dropoff
   // this will contain the amount of native gas that is to be minted
   // on the destination chain given the current swap rates
-  destinationNativeGas?: string;
+  destinationNativeGas?: Amount;
 }
 
 // Transfer params after being validated.

core/base/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wormhole-foundation/sdk-base",
-  "version": "0.4.0-beta.5",
+  "version": "0.4.0-beta.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wormhole-foundation/connect-sdk.git"