Check that the token expected from bridging is acceptable (#613)

Author: barnjamin

connect/src/routes/tokenBridge/automatic.ts

@@ -6,10 +6,16 @@ import type {
   TokenId,
   TokenTransferDetails,
 } from "@wormhole-foundation/sdk-definitions";
-import { isNative, isTokenId, nativeTokenId } from "@wormhole-foundation/sdk-definitions";
+import {
+  ChainAddress,
+  isNative,
+  isTokenId,
+  nativeTokenId,
+} from "@wormhole-foundation/sdk-definitions";
 import { TokenTransfer } from "../../protocols/tokenBridge/tokenTransfer.js";
 import type { AttestationReceipt, SourceInitiatedTransferReceipt } from "../../types.js";
 import { TransferState } from "../../types.js";
+import { Wormhole } from "../../wormhole.js";
 import type { StaticRouteMethods } from "../route.js";
 import { AutomaticRoute } from "../route.js";
 import type {
@@ -20,8 +26,6 @@ import type {
   ValidatedTransferParams,
   ValidationResult,
 } from "../types.js";
-import { ChainAddress } from "@wormhole-foundation/sdk-definitions";
-import { Wormhole } from "../../wormhole.js";
 
 export namespace AutomaticTokenBridgeRoute {
   export type Options = {
@@ -90,7 +94,19 @@ export class AutomaticTokenBridgeRoute<N extends Network>
     toChain: ChainContext<N>,
   ): Promise<TokenId[]> {
     try {
-      return [await TokenTransfer.lookupDestinationToken(fromChain, toChain, sourceToken)];
+      const expectedDestinationToken = await TokenTransfer.lookupDestinationToken(
+        fromChain,
+        toChain,
+        sourceToken,
+      );
+
+      const atb = await toChain.getAutomaticTokenBridge();
+      const acceptable = await atb.isRegisteredToken(expectedDestinationToken.address);
+      if (!acceptable) {
+        throw new Error("Destination token is not accepted by the AutomaticTokenBridge");
+      }
+
+      return [expectedDestinationToken];
     } catch (e) {
       console.error(`Failed to get destination token: ${e}`);
       return [];

core/definitions/src/protocols/tokenBridge/tokenBridge.ts

@@ -1,11 +1,6 @@
 import type { Chain, Network } from "@wormhole-foundation/sdk-base";
 import { lazyInstantiate } from "@wormhole-foundation/sdk-base";
-import type {
-  AccountAddress,
-  ChainAddress,
-  NativeAddress,
-  UniversalOrNative,
-} from "../../address.js";
+import type { AccountAddress, ChainAddress } from "../../address.js";
 import type { TokenAddress, TokenId } from "../../types.js";
 import type { UnsignedTransaction } from "../../unsignedTransaction.js";
 import type { ProtocolPayload, ProtocolVAA } from "./../../vaa/index.js";
@@ -144,7 +139,7 @@ export interface TokenBridge<N extends Network = Network, C extends Chain = Chai
    * @returns The address of the native gas token that has been wrapped
    * for use where the gas token is not possible to use (e.g. bridging)
    */
-  getWrappedNative(): Promise<NativeAddress<C>>;
+  getWrappedNative(): Promise<TokenAddress<C>>;
   /**
    * Check to see if a foreign token has a wrapped version
    *
@@ -158,7 +153,7 @@ export interface TokenBridge<N extends Network = Network, C extends Chain = Chai
    * @param foreignToken The token to check
    * @returns The address of the native version of this asset
    */
-  getWrappedAsset(foreignToken: TokenId<Chain>): Promise<NativeAddress<C>>;
+  getWrappedAsset(foreignToken: TokenId<Chain>): Promise<TokenAddress<C>>;
   /**
    * Checks if a transfer VAA has been redeemed
    *
@@ -177,7 +172,7 @@ export interface TokenBridge<N extends Network = Network, C extends Chain = Chai
    */
   createAttestation(
     token: TokenAddress<C>,
-    payer?: UniversalOrNative<C>,
+    payer?: AccountAddress<C>,
   ): AsyncGenerator<UnsignedTransaction<N, C>>;
 
   /**
@@ -189,7 +184,7 @@ export interface TokenBridge<N extends Network = Network, C extends Chain = Chai
    */
   submitAttestation(
     vaa: TokenBridge.AttestVAA,
-    payer?: UniversalOrNative<C>,
+    payer?: AccountAddress<C>,
   ): AsyncGenerator<UnsignedTransaction<N, C>>;
 
   /**
@@ -251,7 +246,7 @@ export interface AutomaticTokenBridge<N extends Network = Network, C extends Cha
   /** Check if a given token is in the registered token list */
   isRegisteredToken(token: TokenAddress<C>): Promise<boolean>;
   /**  Get the list of tokens that are registered and acceptable to send */
-  getRegisteredTokens(): Promise<NativeAddress<C>[]>;
+  getRegisteredTokens(): Promise<TokenAddress<C>[]>;
   /** Amount of native tokens a user would receive by swapping x amount of sending tokens */
   nativeTokenAmount(token: TokenAddress<C>, amount: bigint): Promise<bigint>;
   /** Maximum amount of sending tokens that can be swapped for native tokens */