@aptos-labs/cross-chain-core 4.25.0 → 5.0.1

package/src/CrossChainCore.ts

@@ -1,11 +1,13 @@
 import { Account, Network } from "@aptos-labs/ts-sdk";
 
 import {
-  WormholeInitiateTransferRequest,
-  WormholeInitiateTransferResponse,
+  WormholeTransferRequest,
+  WormholeTransferResponse,
   WormholeProvider,
   WormholeQuoteRequest,
   WormholeQuoteResponse,
+  WormholeWithdrawRequest,
+  WormholeWithdrawResponse,
 } from "./providers/wormhole";
 
 import {
@@ -15,8 +17,6 @@ import {
   mainnetChains,
   mainnetTokens,
   TokenConfig,
-  AptosTestnetUSDCToken,
-  AptosMainnetUSDCToken,
 } from "./config";
 import {
   getAptosWalletUSDCBalance,
@@ -48,13 +48,14 @@ export type CCTPProviders = "Wormhole";
 export interface CrossChainProvider<
   TQuoteRequest = any,
   TQuoteResponse = any,
-  TInitiateTransferRequest = any,
-  TInitiateTransferResponse = any,
+  TTransferRequest = any,
+  TTransferResponse = any,
+  TWithdrawRequest = any,
+  TWithdrawResponse = any,
 > {
   getQuote(params: TQuoteRequest): Promise<TQuoteResponse>;
-  initiateCCTPTransfer(
-    params: TInitiateTransferRequest,
-  ): Promise<TInitiateTransferResponse>;
+  transfer(params: TTransferRequest): Promise<TTransferResponse>;
+  withdraw(params: TWithdrawRequest): Promise<TWithdrawResponse>;
 }
 
 export class CrossChainCore {
@@ -65,18 +66,14 @@ export class CrossChainCore {
   readonly CHAINS: ChainsConfig = testnetChains;
   readonly TOKENS: Record<string, TokenConfig> = testnetTokens;
 
-  readonly APTOS_TOKEN: TokenConfig = AptosTestnetUSDCToken;
-
   constructor(args: { dappConfig: CrossChainDappConfig }) {
     this._dappConfig = args.dappConfig;
     if (args.dappConfig?.aptosNetwork === Network.MAINNET) {
       this.CHAINS = mainnetChains;
       this.TOKENS = mainnetTokens;
-      this.APTOS_TOKEN = AptosMainnetUSDCToken;
     } else {
       this.CHAINS = testnetChains;
       this.TOKENS = testnetTokens;
-      this.APTOS_TOKEN = AptosTestnetUSDCToken;
     }
   }
 
@@ -86,8 +83,10 @@ export class CrossChainCore {
         return new WormholeProvider(this) as CrossChainProvider<
           WormholeQuoteRequest,
           WormholeQuoteResponse,
-          WormholeInitiateTransferRequest,
-          WormholeInitiateTransferResponse
+          WormholeTransferRequest,
+          WormholeTransferResponse,
+          WormholeWithdrawRequest,
+          WormholeWithdrawResponse
         >;
       default:
         throw new Error(`Unknown provider: ${providerType}`);
@@ -96,12 +95,12 @@ export class CrossChainCore {
 
   async getWalletUSDCBalance(
     walletAddress: string,
-    sourceChain: Chain,
+    sourceChain: Chain
   ): Promise<string> {
     if (sourceChain === "Aptos") {
       return await getAptosWalletUSDCBalance(
         walletAddress,
-        this._dappConfig.aptosNetwork,
+        this._dappConfig.aptosNetwork
       );
     }
     if (!this.CHAINS[sourceChain]) {
@@ -113,7 +112,7 @@ export class CrossChainCore {
           walletAddress,
           this._dappConfig.aptosNetwork,
           this._dappConfig?.solanaConfig?.rpc ??
-            this.CHAINS[sourceChain].defaultRpc,
+            this.CHAINS[sourceChain].defaultRpc
         );
       case "Ethereum":
       case "Sepolia":
@@ -121,7 +120,7 @@ export class CrossChainCore {
           walletAddress,
           this._dappConfig.aptosNetwork,
           // TODO: maybe let the user config it
-          this.CHAINS[sourceChain].defaultRpc,
+          this.CHAINS[sourceChain].defaultRpc
         );
       default:
         throw new Error(`Unsupported chain: ${sourceChain}`);

package/src/config/mainnet/chains.ts

@@ -31,6 +31,21 @@ export const mainnetChains: ChainsConfig = {
     symbol: "SOL",
     defaultRpc: "https://solana-mainnet.rpc.extrnode.com",
   },
+  Aptos: {
+    key: "Aptos",
+    id: 22,
+    context: Context.APTOS,
+    finalityThreshold: 0,
+    displayName: "Aptos",
+    explorerUrl: "https://explorer.aptoslabs.com/",
+    explorerName: "Aptos Explorer",
+    gasToken: "APT",
+    chainId: 0,
+    icon: "Aptos",
+    maxBlockSearch: 0,
+    symbol: "APT",
+    defaultRpc: "https://fullnode.mainnet.aptos.dev",
+  },
   // Sui: {
   //   key: "Sui",
   //   id: 21,
@@ -47,18 +62,3 @@ export const mainnetChains: ChainsConfig = {
   //   symbol: "SUI",
   // },
 };
-
-export const AptosMainnetChain = {
-  key: "Aptos",
-  id: 22,
-  context: "Aptos",
-  finalityThreshold: 0,
-  displayName: "Aptos",
-  explorerUrl: "https://explorer.aptoslabs.com/",
-  explorerName: "Aptos Explorer",
-  gasToken: "APT",
-  chainId: 0,
-  icon: "Aptos",
-  maxBlockSearch: 0,
-  symbol: "APT",
-};

package/src/config/mainnet/tokens.ts

@@ -19,6 +19,16 @@ export const mainnetTokens: Record<string, TokenConfig> = {
     icon: "USDC",
     decimals: 6,
   },
+  Aptos: {
+    symbol: "USDC",
+    decimals: 6,
+    tokenId: {
+      chain: "Aptos",
+      address:
+        "0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
+    },
+    icon: "USDC",
+  },
   // Sui: {
   //   symbol: "USDC",
   //   decimals: 6,
@@ -30,14 +40,3 @@ export const mainnetTokens: Record<string, TokenConfig> = {
   //   icon: "USDC",
   // },
 };
-
-export const AptosMainnetUSDCToken: TokenConfig = {
-  symbol: "USDC",
-  tokenId: {
-    chain: "Aptos",
-    address:
-      "0xbae207659db88bea0cbead6da0ed00aac12edcdda169e591cd41c94180b46f3b",
-  },
-  icon: "USDC",
-  decimals: 6,
-};

package/src/config/testnet/chains.ts

@@ -35,6 +35,21 @@ export const testnetChains: ChainsConfig = {
     defaultRpc: "https://api.devnet.solana.com",
     wrappedGasToken: "So11111111111111111111111111111111111111112",
   },
+  Aptos: {
+    key: "Aptos",
+    id: 22,
+    context: Context.APTOS,
+    finalityThreshold: 0,
+    displayName: "Aptos",
+    explorerUrl: "https://explorer.aptoslabs.com?network=testnet",
+    explorerName: "Aptos Explorer",
+    gasToken: "APT",
+    chainId: 0,
+    icon: "Aptos",
+    maxBlockSearch: 0,
+    symbol: "APT",
+    defaultRpc: "https://fullnode.testnet.aptos.dev",
+  },
   // Sui: {
   //   key: "Sui",
   //   id: 21,
@@ -51,19 +66,3 @@ export const testnetChains: ChainsConfig = {
   //   sdkName: "Sui",
   // },
 };
-
-export const AptosTestnetChain = {
-  key: "Aptos",
-  id: 22,
-  context: Context.APTOS,
-  finalityThreshold: 0,
-  displayName: "Aptos",
-  explorerUrl: "https://explorer.aptoslabs.com?network=testnet",
-  explorerName: "Aptos Explorer",
-  gasToken: "APT",
-  chainId: 0,
-  icon: "Aptos",
-  maxBlockSearch: 0,
-  symbol: "APT",
-  sdkName: "Aptos",
-};

package/src/config/testnet/tokens.ts

@@ -19,6 +19,16 @@ export const testnetTokens: Record<string, TokenConfig> = {
     icon: "USDC",
     decimals: 6,
   },
+  Aptos: {
+    symbol: "USDC",
+    decimals: 6,
+    tokenId: {
+      chain: "Aptos",
+      address:
+        "0x69091fbab5f7d635ee7ac5098cf0c1efbe31d68fec0f2cd565e8d168daf52832",
+    },
+    icon: "USDC",
+  },
   // Sui: {
   //   symbol: "USDC",
   //   tokenId: {
@@ -30,14 +40,3 @@ export const testnetTokens: Record<string, TokenConfig> = {
   //   decimals: 6,
   // },
 };
-
-export const AptosTestnetUSDCToken: TokenConfig = {
-  symbol: "USDC",
-  decimals: 6,
-  tokenId: {
-    chain: "Aptos",
-    address:
-      "0x69091fbab5f7d635ee7ac5098cf0c1efbe31d68fec0f2cd565e8d168daf52832",
-  },
-  icon: "USDC",
-};

package/src/providers/wormhole/signers/AptosLocalSigner.ts

@@ -33,7 +33,7 @@ export class AptosLocalSigner<N extends Network, C extends Chain>
     chain: C,
     options: any,
     wallet: Account,
-    feePayerAccount: Account | GasStationApiKey | undefined,
+    feePayerAccount: Account | GasStationApiKey | undefined
   ) {
     this._chain = chain;
     this._options = options;
@@ -61,7 +61,7 @@ export class AptosLocalSigner<N extends Network, C extends Chain>
       const txId = await signAndSendTransaction(
         tx as AptosUnsignedTransaction<Network, AptosChains>,
         this._wallet,
-        this._sponsorAccount,
+        this._sponsorAccount
       );
       txHashes.push(txId);
       this._claimedTransactionHashes = txId;
@@ -73,7 +73,7 @@ export class AptosLocalSigner<N extends Network, C extends Chain>
 export async function signAndSendTransaction(
   request: UnsignedTransaction<Network, AptosChains>,
   wallet: Account,
-  sponsorAccount: Account | GasStationApiKey | undefined,
+  sponsorAccount: Account | GasStationApiKey | undefined
 ) {
   if (!wallet) {
     throw new Error("Wallet is undefined");
@@ -101,6 +101,7 @@ export async function signAndSendTransaction(
     sender: wallet.accountAddress.toString(),
     withFeePayer: sponsorAccount ? true : false,
   });
+
   const senderAuthenticator = await aptos.transaction.sign({
     signer: wallet,
     transaction: txnToSign,

package/src/providers/wormhole/signers/AptosSigner.ts

@@ -0,0 +1,139 @@
+import {
+  Account,
+  AccountAddress,
+  AccountAuthenticator,
+  AnyRawTransaction,
+  Aptos,
+  AptosConfig,
+  Network as AptosNetwork,
+  Deserializer,
+  EntryFunctionArgumentTypes,
+  InputGenerateTransactionPayloadData,
+  ScriptFunctionArgumentTypes,
+  Serializer,
+  SimpleEntryFunctionArgumentTypes,
+  U64,
+} from "@aptos-labs/ts-sdk";
+import { AdapterWallet } from "@aptos-labs/wallet-adapter-core";
+import { Network } from "@wormhole-foundation/sdk";
+import {
+  AptosChains,
+  AptosUnsignedTransaction,
+} from "@wormhole-foundation/sdk-aptos";
+import { GasStationApiKey } from "..";
+import { UserResponseStatus } from "@aptos-labs/wallet-standard";
+
+export async function signAndSendTransaction(
+  request: AptosUnsignedTransaction<Network, AptosChains>,
+  wallet: AdapterWallet,
+  sponsorAccount: Account | GasStationApiKey | undefined
+) {
+  if (!wallet) {
+    throw new Error("wallet.sendTransaction is undefined").message;
+  }
+
+  const payload = request.transaction;
+  // The wallets do not handle Uint8Array serialization
+  payload.functionArguments = payload.functionArguments.map((a: any) => {
+    if (a instanceof Uint8Array) {
+      return Array.from(a);
+    } else if (typeof a === "bigint") {
+      return a.toString();
+    } else {
+      return a;
+    }
+  });
+
+  const aptosConfig = new AptosConfig({
+    network: AptosNetwork.TESTNET,
+  });
+  const aptos = new Aptos(aptosConfig);
+
+  // TODO: handle mainnet
+  const contractAddress = AptosNetwork.TESTNET
+    ? "0x5e2d961f06cd27aa07554a39d55f5ce1e58dff35d803c3529b1cd5c4fa3ab584"
+    : "0x1";
+
+  // Wormhole resturns a script function transaction payload, but due to a ts-sdk version mismatch,
+  // linter complains on different types - so need to first convert to unknown and then to ScriptFunctionArgumentTypes.
+  // Also, tranfering the arguments as it brings some errors (which not sure if bug or not), so we first extract them
+  // and then tranform them into the functionArguments.
+  const functionArguments = extractFunctionArguments(
+    payload.functionArguments as unknown as ScriptFunctionArgumentTypes[]
+  );
+
+  const transactionData: InputGenerateTransactionPayloadData = {
+    // a custom function to withdraw tokens from the aptos chain, published here on testnet:
+    // https://explorer.aptoslabs.com/account/0x5e2d961f06cd27aa07554a39d55f5ce1e58dff35d803c3529b1cd5c4fa3ab584/modules/code/withdraw?network=testnet
+    function: `${contractAddress}::withdraw::deposit_for_burn`,
+    functionArguments,
+  };
+
+  const txnToSign = await aptos.transaction.build.simple({
+    data: transactionData,
+    sender: (
+      await wallet.features["aptos:account"]?.account()
+    ).address.toString(),
+    withFeePayer: sponsorAccount ? true : false,
+  });
+
+  const response =
+    await wallet.features["aptos:signTransaction"]?.signTransaction(txnToSign);
+
+  if (response?.status === UserResponseStatus.REJECTED) {
+    throw new Error("User has rejected the request");
+  }
+
+  const txnToSubmit: {
+    transaction: AnyRawTransaction;
+    senderAuthenticator: AccountAuthenticator;
+    feePayerAuthenticator?: AccountAuthenticator;
+  } = {
+    transaction: txnToSign,
+    senderAuthenticator: response.args,
+  };
+
+  if (sponsorAccount) {
+    if (typeof sponsorAccount === "string") {
+      // TODO: handle gas station integration here
+    } else {
+      const feePayerSignerAuthenticator = aptos.transaction.signAsFeePayer({
+        signer: sponsorAccount as Account,
+        transaction: txnToSign,
+      });
+      txnToSubmit.feePayerAuthenticator = feePayerSignerAuthenticator;
+    }
+  }
+
+  const txnSubmitted = await aptos.transaction.submit.simple(txnToSubmit);
+
+  const tx = await aptos.waitForTransaction({
+    transactionHash: txnSubmitted.hash,
+  });
+
+  return tx.hash;
+}
+
+/**
+ * Extracts the function arguments from the function arguments array and tranform them into types the sdk can ready.
+ *
+ * Note: we assume the argument types are always [U64, U32, accountAddress, accountAddress] - even tho we use
+ * Wormhole fix version in the package.json, if wormhole changes this, we need to update this function.
+ * @param functionArguments - The function arguments array.
+ * @returns The function arguments.
+ */
+function extractFunctionArguments(
+  functionArguments: ScriptFunctionArgumentTypes[]
+) {
+  const deserializer1 = new Deserializer(functionArguments[0].bcsToBytes());
+  const amount = deserializer1.deserializeU64();
+
+  const deserializer2 = new Deserializer(functionArguments[1].bcsToBytes());
+  const destination_domain = deserializer2.deserializeU32();
+
+  const mint_recipient = new AccountAddress(functionArguments[2].bcsToBytes());
+
+  const burn_token = new AccountAddress(functionArguments[3].bcsToBytes());
+
+  return [amount, destination_domain, mint_recipient, burn_token];
+}

package/src/providers/wormhole/signers/Signer.ts

@@ -14,6 +14,7 @@ import {
 
 import * as solanaSigner from "./SolanaSigner";
 import * as ethereumSigner from "./EthereumSigner";
+import * as aptosSigner from "./AptosSigner";
 // import {
 //   SuiChains,
 //   SuiUnsignedTransaction,
@@ -22,6 +23,10 @@ import * as ethereumSigner from "./EthereumSigner";
 
 import { ChainConfig } from "../../../config";
 import { CrossChainCore } from "../../../CrossChainCore";
+import { AptosChains } from "@wormhole-foundation/sdk-aptos/dist/cjs/types";
+import { AptosUnsignedTransaction } from "@wormhole-foundation/sdk-aptos/dist/cjs/unsignedTransaction";
+import { GasStationApiKey } from "../types";
+import { Account } from "@aptos-labs/ts-sdk";
 export class Signer<N extends Network, C extends Chain>
   implements SignAndSendSigner<N, C>
 {
@@ -30,6 +35,8 @@ export class Signer<N extends Network, C extends Chain>
   _options: any;
   _wallet: AdapterWallet;
   _crossChainCore?: CrossChainCore;
+  _sponsorAccount: Account | GasStationApiKey | undefined;
+  _claimedTransactionHashes: string;
 
   constructor(
     chain: ChainConfig,
@@ -37,12 +44,15 @@ export class Signer<N extends Network, C extends Chain>
     options: any,
     wallet: AdapterWallet,
     crossChainCore?: CrossChainCore,
+    sponsorAccount?: Account | GasStationApiKey | undefined
   ) {
     this._chain = chain;
     this._address = address;
     this._options = options;
     this._wallet = wallet;
     this._crossChainCore = crossChainCore;
+    this._sponsorAccount = sponsorAccount;
+    this._claimedTransactionHashes = "";
   }
 
   chain(): C {
@@ -52,6 +62,10 @@ export class Signer<N extends Network, C extends Chain>
     return this._address;
   }
 
+  claimedTransactionHashes(): string {
+    return this._claimedTransactionHashes;
+  }
+
   async signAndSend(txs: UnsignedTransaction<N, C>[]): Promise<TxHash[]> {
     const txHashes: TxHash[] = [];
 
@@ -62,8 +76,10 @@ export class Signer<N extends Network, C extends Chain>
         this._wallet,
         this._options,
         this._crossChainCore,
+        this._sponsorAccount
       );
       txHashes.push(txId);
+      this._claimedTransactionHashes = txId;
     }
     return txHashes;
   }
@@ -75,6 +91,7 @@ export const signAndSendTransaction = async (
   wallet: AdapterWallet,
   options: any = {},
   crossChainCore?: CrossChainCore,
+  sponsorAccount?: Account | GasStationApiKey | undefined
 ): Promise<string> => {
   if (!wallet) {
     throw new Error("wallet is undefined");
@@ -85,7 +102,7 @@ export const signAndSendTransaction = async (
       request as SolanaUnsignedTransaction<Network>,
       wallet,
       options,
-      crossChainCore,
+      crossChainCore
     );
     return signature;
   } else if (chain.context === "Ethereum") {
@@ -93,7 +110,14 @@ export const signAndSendTransaction = async (
       request as EvmUnsignedTransaction<Network, EvmChains>,
       wallet,
       chain.displayName,
-      options,
+      options
+    );
+    return tx;
+  } else if (chain.context === "Aptos") {
+    const tx = await aptosSigner.signAndSendTransaction(
+      request as AptosUnsignedTransaction<Network, AptosChains>,
+      wallet,
+      sponsorAccount
     );
     return tx;
   } else {

package/src/providers/wormhole/types.ts

@@ -22,12 +22,13 @@ export type WormholeQuoteResponse = routes.Quote<
 
 export interface WormholeQuoteRequest {
   amount: string;
-  sourceChain: Chain;
+  originChain: Chain;
+  type: "transfer" | "withdraw";
 }
 
 export type GasStationApiKey = string;
 
-export interface WormholeInitiateTransferRequest {
+export interface WormholeTransferRequest {
   sourceChain: Chain;
   wallet: AdapterWallet;
   destinationAddress: AccountAddressInput;
@@ -36,6 +37,13 @@ export interface WormholeInitiateTransferRequest {
   sponsorAccount?: Account | GasStationApiKey;
 }
 
+export interface WormholeWithdrawRequest {
+  sourceChain: Chain;
+  wallet: AdapterWallet;
+  destinationAddress: AccountAddressInput;
+  sponsorAccount?: Account | GasStationApiKey;
+}
+
 export interface WormholeSubmitTransferRequest {
   sourceChain: Chain;
   wallet: AdapterWallet;
@@ -48,7 +56,12 @@ export interface WormholeClaimTransferRequest {
   sponsorAccount?: AptosAccount | GasStationApiKey;
 }
 
-export interface WormholeInitiateTransferResponse {
+export interface WormholeTransferResponse {
+  destinationChainTxnId: string;
+  originChainTxnId: string;
+}
+
+export interface WormholeWithdrawResponse {
   destinationChainTxnId: string;
   originChainTxnId: string;
 }