@wormhole-foundation/sdk-connect 0.5.0-beta.0

package/dist/cjs/wormhole.d.ts

@@ -0,0 +1,198 @@
+import { Chain, Network, Platform } from "@wormhole-foundation/sdk-base";
+import { ChainAddress, ChainContext, Contracts, NativeAddress, PayloadDiscriminator, PayloadLiteral, PlatformContext, PlatformUtils, TokenAddress, TokenId, TxHash, WormholeMessageId, deserialize } from "@wormhole-foundation/sdk-definitions";
+import { ConfigOverrides, WormholeConfig } from "./config";
+import { CircleTransfer } from "./protocols/cctpTransfer";
+import { TokenTransfer } from "./protocols/tokenTransfer";
+import { RouteConstructor } from "./routes";
+import { RouteResolver } from "./routes/resolver";
+import { TransactionStatus } from "./whscan-api";
+type PlatformMap<N extends Network, P extends Platform = Platform> = Map<P, PlatformContext<N, P>>;
+type ChainMap<N extends Network, C extends Chain = Chain> = Map<C, ChainContext<N, C>>;
+export declare class Wormhole<N extends Network> {
+    protected readonly _network: N;
+    protected _platforms: PlatformMap<N>;
+    protected _chains: ChainMap<N>;
+    readonly config: WormholeConfig;
+    constructor(network: N, platforms: PlatformUtils<any>[], config?: ConfigOverrides);
+    get network(): N;
+    /**
+     * Creates a CircleTransfer object to move Native USDC from one chain to another
+     * @param amount the amount to transfer
+     * @param from the address to transfer from
+     * @param to the address to transfer to
+     * @param automatic whether to use automatic delivery
+     * @param payload the payload to send with the transfer
+     * @param nativeGas the amount of native gas to send with the transfer
+     * @returns the CircleTransfer object
+     * @throws Errors if the chain or protocol is not supported
+     */
+    circleTransfer(amount: bigint, from: ChainAddress, to: ChainAddress, automatic: boolean, payload?: Uint8Array, nativeGas?: bigint): Promise<CircleTransfer<N>>;
+    /**
+     * Creates a TokenTransfer object to move a token from one chain to another
+     * @param token the token to transfer
+     * @param amount the amount to transfer
+     * @param from the address to transfer from
+     * @param to the address to transfer to
+     * @param automatic whether to use automatic delivery
+     * @param payload the payload to send with the transfer
+     * @param nativeGas the amount of native gas to send with the transfer
+     * @returns the TokenTransfer object
+     * @throws Errors if the chain or protocol is not supported
+     */
+    tokenTransfer(token: TokenId, amount: bigint, from: ChainAddress, to: ChainAddress, automatic: boolean, payload?: Uint8Array, nativeGas?: bigint): Promise<TokenTransfer<N>>;
+    /**
+     * Gets a RouteResolver configured with the routes passed
+     * @param routes the list RouteConstructors to use
+     * @returns the RouteResolver
+     */
+    resolver(routes: RouteConstructor[]): RouteResolver<N>;
+    /**
+     * Gets the contract addresses for a given chain
+     * @param chain the chain name
+     * @returns the contract addresses
+     */
+    getContracts(chain: Chain): Contracts | undefined;
+    /**
+     * Returns the platform object, i.e. the class with platform-specific logic and methods
+     * @param chain the platform name
+     * @returns the platform context class
+     * @throws Errors if platform is not found
+     */
+    getPlatform<P extends Platform>(platformName: P): PlatformContext<N, P>;
+    /**
+     * Returns the chain "context", i.e. the class with chain-specific logic and methods
+     * @param chain the chain name
+     * @returns the chain context class
+     * @throws Errors if context is not found
+     */
+    getChain<C extends Chain>(chain: C): ChainContext<N, C>;
+    /**
+     * Gets the TokenId for a token representation on any chain
+     *  These are the Wormhole wrapped token addresses, not necessarily
+     *  the cannonical version of that token
+     *
+     * @param chain The chain name to get the wrapped token address
+     * @param tokenId The Token ID (chain/address) of the original token
+     * @returns The TokenId on the given chain, null if it does not exist
+     * @throws Errors if the chain is not supported or the token does not exist
+     */
+    getWrappedAsset<C extends Chain>(chain: C, token: TokenId<Chain>): Promise<TokenId<C>>;
+    /**
+     *  Taking the original TokenId for some wrapped token chain
+     *  These are the Wormhole wrapped token addresses, not necessarily
+     *  the cannonical version of that token
+     *
+     * @param tokenId The Token ID of the token we're looking up the original asset for
+     * @returns The Original TokenId corresponding to the token id passed,
+     * @throws Errors if the chain is not supported or the token does not exist
+     */
+    getOriginalAsset<C extends Chain>(token: TokenId<C>): Promise<TokenId<Chain>>;
+    /**
+     * Gets the number of decimals for a token on a given chain
+     *
+     * @param chain The chain name or id of the token/representation
+     * @param token The token address
+     * @returns The number of decimals
+     */
+    getDecimals<C extends Chain>(chain: C, token: TokenAddress<C>): Promise<number>;
+    /**
+     * Fetches the balance of a given token for a wallet
+     *
+     * @param walletAddress The wallet address
+     * @param tokenId The token ID (its home chain and address on the home chain)
+     * @param chain The chain name or id
+     * @returns The token balance of the wormhole asset as a BigNumber
+     */
+    getBalance<C extends Chain>(chain: C, token: TokenAddress<C>, walletAddress: string): Promise<bigint | null>;
+    /**
+     * Gets the associated token account for chains that require it (only Solana currently).
+     *
+     * @param token the TokenId of the token to get the token account for
+     * @param recipient the address of the primary account that may require a separate token account
+     * @returns
+     */
+    getTokenAccount<C extends Chain>(recipient: ChainAddress<C>, token: TokenId<C>): Promise<ChainAddress<C>>;
+    /**
+     * Gets the Raw VAA Bytes from the API or Guardian RPC, finality must be met before the VAA will be available.
+     *
+     * @param wormholeMessageId The WormholeMessageId corresponding to the VAA to be fetched
+     * @param timeout The total amount of time to wait for the VAA to be available
+     * @returns The VAA bytes if available
+     * @throws Errors if the VAA is not available after the retries
+     */
+    getVaaBytes(wormholeMessageId: WormholeMessageId, timeout?: number): Promise<Uint8Array | null>;
+    /**
+     * Gets a VAA from the API or Guardian RPC, finality must be met before the VAA will be available.
+     *
+     * @param id The WormholeMessageId or Transaction hash corresponding to the VAA to be fetched
+     * @param decodeAs The VAA type to decode the bytes as
+     * @param timeout The total amount of time to wait for the VAA to be available
+     * @returns The VAA if available
+     * @throws Errors if the VAA is not available after the retries
+     */
+    getVaa<T extends PayloadLiteral | PayloadDiscriminator>(id: WormholeMessageId | TxHash, decodeAs: T, timeout?: number): Promise<ReturnType<typeof deserialize<T>> | null>;
+    /**
+     * Gets the CircleAttestation corresponding to the message hash logged in the transfer transaction.
+     * @param msgHash  The keccak256 hash of the message emitted by the circle contract
+     * @param timeout The total amount of time to wait for the VAA to be available
+     * @returns The CircleAttestation as a string, if available
+     * @throws Errors if the CircleAttestation is not available after the retries
+     */
+    getCircleAttestation(msgHash: string, timeout?: number): Promise<string | null>;
+    /**
+     * Get the status of a transaction, identified by the chain, emitter address, and sequence number
+     *
+     * @param id the message id for the Wormhole Message to get transaction status for or originating Transaction hash
+     * @returns the TransactionStatus
+     */
+    getTransactionStatus(id: WormholeMessageId | TxHash, timeout?: number): Promise<TransactionStatus | null>;
+    /**
+     * Get recent transactions for an address
+     *
+     * @param address the string formatted address to get transactions for
+     * @returns the TransactionStatus
+     */
+    getTransactionsForAddress(address: string, pageSize?: number, page?: number): Promise<TransactionStatus[] | null>;
+    /**
+     * Parse an address from its canonincal string format to a NativeAddress
+     *
+     * @param chain The chain the address is for
+     * @param address The address in canonical string format
+     * @returns The address in the NativeAddress format
+     */
+    static parseAddress<C extends Chain>(chain: C, address: string): NativeAddress<C>;
+    /**
+     * Return a string in the canonical chain format representing the address
+     * of a token or account
+     *
+     * @param chainAddress The ChainAddress or TokenId to get a string address
+     * @returns The string address in canonical format for the chain
+     */
+    static canonicalAddress(chainAddress: ChainAddress | TokenId): string;
+    /**
+     * Parse an address from its canonincal string format to a NativeAddress
+     *
+     * @param chain The chain the address is for
+     * @param address The native address in canonical string format
+     * @returns The ChainAddress
+     */
+    static chainAddress<C extends Chain>(chain: C, address: string): ChainAddress<C>;
+    /**
+     * Parse an address from its canonincal string format to a NativeAddress
+     *
+     * @param chain The chain the address is for
+     * @param address The native address in canonical string format or the string "native"
+     * @returns The ChainAddress
+     */
+    static tokenId<C extends Chain>(chain: C, address: string): TokenId<C>;
+    /**
+     * Parses all relevant information from a transaction given the sending tx hash and sending chain
+     *
+     * @param chain The sending chain name or context
+     * @param tx The sending transaction hash
+     * @returns The parsed WormholeMessageId
+     */
+    static parseMessageFromTx<N extends Network, C extends Chain>(chain: ChainContext<N, C>, txid: TxHash, timeout?: number): Promise<WormholeMessageId[]>;
+}
+export {};
+//# sourceMappingURL=wormhole.d.ts.map

package/dist/cjs/wormhole.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wormhole.d.ts","sourceRoot":"","sources":["../../src/wormhole.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAA2B,MAAM,+BAA+B,CAAC;AAClG,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,SAAS,EACT,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,aAAa,EACb,YAAY,EACZ,OAAO,EACP,MAAM,EACN,iBAAiB,EAEjB,WAAW,EAIZ,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAwB,cAAc,EAAkB,MAAM,UAAU,CAAC;AACjG,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EACL,iBAAiB,EAMlB,MAAM,cAAc,CAAC;AAEtB,KAAK,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,QAAQ,GAAG,QAAQ,IAAI,GAAG,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACnG,KAAK,QAAQ,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,KAAK,GAAG,KAAK,IAAI,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEvF,qBAAa,QAAQ,CAAC,CAAC,SAAS,OAAO;IACrC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/B,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACrC,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAE/B,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;gBAEpB,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,eAAe;IAWjF,IAAI,OAAO,IAAI,CAAC,CAEf;IAED;;;;;;;;;;OAUG;IACG,cAAc,CAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,YAAY,EAClB,EAAE,EAAE,YAAY,EAChB,SAAS,EAAE,OAAO,EAClB,OAAO,CAAC,EAAE,UAAU,EACpB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IA8B7B;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,YAAY,EAClB,EAAE,EAAE,YAAY,EAChB,SAAS,EAAE,OAAO,EAClB,OAAO,CAAC,EAAE,UAAU,EACpB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAY5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE;IAInC;;;;OAIG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,SAAS;IAIjD;;;;;OAKG;IACH,WAAW,CAAC,CAAC,SAAS,QAAQ,EAAE,YAAY,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC;IAMvE;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;IAOvD;;;;;;;;;OASG;IACG,eAAe,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAM5F;;;;;;;;OAQG;IACG,gBAAgB,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAMnF;;;;;;OAMG;IACG,WAAW,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrF;;;;;;;OAOG;IACG,UAAU,CAAC,CAAC,SAAS,KAAK,EAC9B,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAKzB;;;;;;OAMG;IACG,eAAe,CAAC,CAAC,SAAS,KAAK,EACnC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,EAC1B,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,GAChB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI3B;;;;;;;OAOG;IACG,WAAW,CACf,iBAAiB,EAAE,iBAAiB,EACpC,OAAO,GAAE,MAA6B,GACrC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAI7B;;;;;;;;OAQG;IACG,MAAM,CAAC,CAAC,SAAS,cAAc,GAAG,oBAAoB,EAC1D,EAAE,EAAE,iBAAiB,GAAG,MAAM,EAC9B,QAAQ,EAAE,CAAC,EACX,OAAO,GAAE,MAA6B,GACrC,OAAO,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAOpD;;;;;;OAMG;IACG,oBAAoB,CACxB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAA6B,GACrC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAIzB;;;;;OAKG;IACG,oBAAoB,CACxB,EAAE,EAAE,iBAAiB,GAAG,MAAM,EAC9B,OAAO,SAAuB,GAC7B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAcpC;;;;;OAKG;IACG,yBAAyB,CAC7B,OAAO,EAAE,MAAM,EACf,QAAQ,GAAE,MAAW,EACrB,IAAI,GAAE,MAAU,GACf,OAAO,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC;IAItC;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC;IAIjF;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,GAAG,MAAM;IAIrE;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC;IAIhF;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAItE;;;;;;OAMG;WACU,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,KAAK,EAChE,KAAK,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,MAA6B,GACrC,OAAO,CAAC,iBAAiB,EAAE,CAAC;CAwBhC"}

package/dist/cjs/wormhole.js

@@ -0,0 +1,324 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Wormhole = void 0;
+const sdk_base_1 = require("@wormhole-foundation/sdk-base");
+const sdk_definitions_1 = require("@wormhole-foundation/sdk-definitions");
+const circle_api_1 = require("./circle-api");
+const config_1 = require("./config");
+const cctpTransfer_1 = require("./protocols/cctpTransfer");
+const tokenTransfer_1 = require("./protocols/tokenTransfer");
+const resolver_1 = require("./routes/resolver");
+const tasks_1 = require("./tasks");
+const whscan_api_1 = require("./whscan-api");
+class Wormhole {
+    _network;
+    _platforms;
+    _chains;
+    config;
+    constructor(network, platforms, config) {
+        this._network = network;
+        this.config = (0, config_1.applyOverrides)(network, config);
+        this._chains = new Map();
+        this._platforms = new Map();
+        for (const p of platforms) {
+            this._platforms.set(p._platform, new p(network));
+        }
+    }
+    get network() {
+        return this._network;
+    }
+    /**
+     * Creates a CircleTransfer object to move Native USDC from one chain to another
+     * @param amount the amount to transfer
+     * @param from the address to transfer from
+     * @param to the address to transfer to
+     * @param automatic whether to use automatic delivery
+     * @param payload the payload to send with the transfer
+     * @param nativeGas the amount of native gas to send with the transfer
+     * @returns the CircleTransfer object
+     * @throws Errors if the chain or protocol is not supported
+     */
+    async circleTransfer(amount, from, to, automatic, payload, nativeGas) {
+        if (automatic && payload)
+            throw new Error("Payload with automatic delivery is not supported");
+        if (!sdk_base_1.circle.isCircleChain(this.network, from.chain) ||
+            !sdk_base_1.circle.isCircleChain(this.network, to.chain) ||
+            !sdk_base_1.circle.isCircleSupported(this.network, from.chain) ||
+            !sdk_base_1.circle.isCircleSupported(this.network, to.chain))
+            throw new Error(`Network and chain not supported: ${this.network} ${from.chain} `);
+        // ensure the amount is > fee + native gas
+        if (automatic) {
+            const acb = await this.getChain(from.chain).getAutomaticCircleBridge();
+            const relayerFee = await acb.getRelayerFee(to.chain);
+            const minAmount = relayerFee + (nativeGas ? nativeGas : 0n);
+            if (amount < minAmount)
+                throw new Error(`Amount must be > ${minAmount} (relayerFee + nativeGas)`);
+        }
+        return await cctpTransfer_1.CircleTransfer.from(this, {
+            amount,
+            from,
+            to,
+            automatic,
+            payload,
+            nativeGas,
+        });
+    }
+    /**
+     * Creates a TokenTransfer object to move a token from one chain to another
+     * @param token the token to transfer
+     * @param amount the amount to transfer
+     * @param from the address to transfer from
+     * @param to the address to transfer to
+     * @param automatic whether to use automatic delivery
+     * @param payload the payload to send with the transfer
+     * @param nativeGas the amount of native gas to send with the transfer
+     * @returns the TokenTransfer object
+     * @throws Errors if the chain or protocol is not supported
+     */
+    async tokenTransfer(token, amount, from, to, automatic, payload, nativeGas) {
+        return await tokenTransfer_1.TokenTransfer.from(this, {
+            token,
+            amount,
+            from,
+            to,
+            automatic,
+            payload,
+            nativeGas,
+        });
+    }
+    /**
+     * Gets a RouteResolver configured with the routes passed
+     * @param routes the list RouteConstructors to use
+     * @returns the RouteResolver
+     */
+    resolver(routes) {
+        return new resolver_1.RouteResolver(this, routes);
+    }
+    /**
+     * Gets the contract addresses for a given chain
+     * @param chain the chain name
+     * @returns the contract addresses
+     */
+    getContracts(chain) {
+        return this.config.chains[chain]?.contracts;
+    }
+    /**
+     * Returns the platform object, i.e. the class with platform-specific logic and methods
+     * @param chain the platform name
+     * @returns the platform context class
+     * @throws Errors if platform is not found
+     */
+    getPlatform(platformName) {
+        const platform = this._platforms.get(platformName);
+        if (!platform)
+            throw new Error(`Not able to retrieve platform ${platform}`);
+        return platform;
+    }
+    /**
+     * Returns the chain "context", i.e. the class with chain-specific logic and methods
+     * @param chain the chain name
+     * @returns the chain context class
+     * @throws Errors if context is not found
+     */
+    getChain(chain) {
+        const platform = (0, sdk_base_1.chainToPlatform)(chain);
+        if (!this._chains.has(chain))
+            this._chains.set(chain, this.getPlatform(platform).getChain(chain));
+        return this._chains.get(chain);
+    }
+    /**
+     * Gets the TokenId for a token representation on any chain
+     *  These are the Wormhole wrapped token addresses, not necessarily
+     *  the cannonical version of that token
+     *
+     * @param chain The chain name to get the wrapped token address
+     * @param tokenId The Token ID (chain/address) of the original token
+     * @returns The TokenId on the given chain, null if it does not exist
+     * @throws Errors if the chain is not supported or the token does not exist
+     */
+    async getWrappedAsset(chain, token) {
+        const ctx = this.getChain(chain);
+        const tb = await ctx.getTokenBridge();
+        return { chain, address: await tb.getWrappedAsset(token) };
+    }
+    /**
+     *  Taking the original TokenId for some wrapped token chain
+     *  These are the Wormhole wrapped token addresses, not necessarily
+     *  the cannonical version of that token
+     *
+     * @param tokenId The Token ID of the token we're looking up the original asset for
+     * @returns The Original TokenId corresponding to the token id passed,
+     * @throws Errors if the chain is not supported or the token does not exist
+     */
+    async getOriginalAsset(token) {
+        const ctx = this.getChain(token.chain);
+        const tb = await ctx.getTokenBridge();
+        return await tb.getOriginalAsset(token.address);
+    }
+    /**
+     * Gets the number of decimals for a token on a given chain
+     *
+     * @param chain The chain name or id of the token/representation
+     * @param token The token address
+     * @returns The number of decimals
+     */
+    async getDecimals(chain, token) {
+        const ctx = this.getChain(chain);
+        return await ctx.getDecimals(token);
+    }
+    /**
+     * Fetches the balance of a given token for a wallet
+     *
+     * @param walletAddress The wallet address
+     * @param tokenId The token ID (its home chain and address on the home chain)
+     * @param chain The chain name or id
+     * @returns The token balance of the wormhole asset as a BigNumber
+     */
+    async getBalance(chain, token, walletAddress) {
+        const ctx = this.getChain(chain);
+        return ctx.getBalance(walletAddress, token);
+    }
+    /**
+     * Gets the associated token account for chains that require it (only Solana currently).
+     *
+     * @param token the TokenId of the token to get the token account for
+     * @param recipient the address of the primary account that may require a separate token account
+     * @returns
+     */
+    async getTokenAccount(recipient, token) {
+        return this.getChain(recipient.chain).getTokenAccount(recipient.address, token.address);
+    }
+    /**
+     * Gets the Raw VAA Bytes from the API or Guardian RPC, finality must be met before the VAA will be available.
+     *
+     * @param wormholeMessageId The WormholeMessageId corresponding to the VAA to be fetched
+     * @param timeout The total amount of time to wait for the VAA to be available
+     * @returns The VAA bytes if available
+     * @throws Errors if the VAA is not available after the retries
+     */
+    async getVaaBytes(wormholeMessageId, timeout = config_1.DEFAULT_TASK_TIMEOUT) {
+        return await (0, whscan_api_1.getVaaBytesWithRetry)(this.config.api, wormholeMessageId, timeout);
+    }
+    /**
+     * Gets a VAA from the API or Guardian RPC, finality must be met before the VAA will be available.
+     *
+     * @param id The WormholeMessageId or Transaction hash corresponding to the VAA to be fetched
+     * @param decodeAs The VAA type to decode the bytes as
+     * @param timeout The total amount of time to wait for the VAA to be available
+     * @returns The VAA if available
+     * @throws Errors if the VAA is not available after the retries
+     */
+    async getVaa(id, decodeAs, timeout = config_1.DEFAULT_TASK_TIMEOUT) {
+        if (typeof id === "string")
+            return await (0, whscan_api_1.getVaaByTxHashWithRetry)(this.config.api, id, decodeAs, timeout);
+        return await (0, whscan_api_1.getVaaWithRetry)(this.config.api, id, decodeAs, timeout);
+    }
+    /**
+     * Gets the CircleAttestation corresponding to the message hash logged in the transfer transaction.
+     * @param msgHash  The keccak256 hash of the message emitted by the circle contract
+     * @param timeout The total amount of time to wait for the VAA to be available
+     * @returns The CircleAttestation as a string, if available
+     * @throws Errors if the CircleAttestation is not available after the retries
+     */
+    async getCircleAttestation(msgHash, timeout = config_1.DEFAULT_TASK_TIMEOUT) {
+        return (0, circle_api_1.getCircleAttestationWithRetry)(this.config.circleAPI, msgHash, timeout);
+    }
+    /**
+     * Get the status of a transaction, identified by the chain, emitter address, and sequence number
+     *
+     * @param id the message id for the Wormhole Message to get transaction status for or originating Transaction hash
+     * @returns the TransactionStatus
+     */
+    async getTransactionStatus(id, timeout = config_1.DEFAULT_TASK_TIMEOUT) {
+        let msgid;
+        // No txid endpoint exists to get the status by txhash yet
+        if (typeof id === "string") {
+            const vaa = await (0, whscan_api_1.getVaaByTxHashWithRetry)(this.config.api, id, "Uint8Array", timeout);
+            if (!vaa)
+                return null;
+            msgid = { emitter: vaa.emitterAddress, chain: vaa.emitterChain, sequence: vaa.sequence };
+        }
+        else {
+            msgid = id;
+        }
+        return await (0, whscan_api_1.getTransactionStatusWithRetry)(this.config.api, msgid, timeout);
+    }
+    /**
+     * Get recent transactions for an address
+     *
+     * @param address the string formatted address to get transactions for
+     * @returns the TransactionStatus
+     */
+    async getTransactionsForAddress(address, pageSize = 50, page = 0) {
+        return (0, whscan_api_1.getTxsByAddress)(this.config.api, address, pageSize, page);
+    }
+    /**
+     * Parse an address from its canonincal string format to a NativeAddress
+     *
+     * @param chain The chain the address is for
+     * @param address The address in canonical string format
+     * @returns The address in the NativeAddress format
+     */
+    static parseAddress(chain, address) {
+        return (0, sdk_definitions_1.toNative)(chain, address);
+    }
+    /**
+     * Return a string in the canonical chain format representing the address
+     * of a token or account
+     *
+     * @param chainAddress The ChainAddress or TokenId to get a string address
+     * @returns The string address in canonical format for the chain
+     */
+    static canonicalAddress(chainAddress) {
+        return (0, sdk_definitions_1.canonicalAddress)(chainAddress);
+    }
+    /**
+     * Parse an address from its canonincal string format to a NativeAddress
+     *
+     * @param chain The chain the address is for
+     * @param address The native address in canonical string format
+     * @returns The ChainAddress
+     */
+    static chainAddress(chain, address) {
+        return { chain, address: Wormhole.parseAddress(chain, address) };
+    }
+    /**
+     * Parse an address from its canonincal string format to a NativeAddress
+     *
+     * @param chain The chain the address is for
+     * @param address The native address in canonical string format or the string "native"
+     * @returns The ChainAddress
+     */
+    static tokenId(chain, address) {
+        return (0, sdk_definitions_1.isNative)(address) ? (0, sdk_definitions_1.nativeTokenId)(chain) : this.chainAddress(chain, address);
+    }
+    /**
+     * Parses all relevant information from a transaction given the sending tx hash and sending chain
+     *
+     * @param chain The sending chain name or context
+     * @param tx The sending transaction hash
+     * @returns The parsed WormholeMessageId
+     */
+    static async parseMessageFromTx(chain, txid, timeout = config_1.DEFAULT_TASK_TIMEOUT) {
+        const task = async () => {
+            try {
+                const msgs = await chain.parseTransaction(txid);
+                // possible the node we hit does not have this data yet
+                // return null to signal retry
+                if (msgs.length === 0)
+                    return null;
+                return msgs;
+            }
+            catch (e) {
+                console.error(e);
+                return null;
+            }
+        };
+        const parsed = await (0, tasks_1.retry)(task, chain.config.blockTime, timeout, "WormholeCore:ParseMessageFromTransaction");
+        if (!parsed)
+            throw new Error(`No WormholeMessageId found for ${txid}`);
+        return parsed;
+    }
+}
+exports.Wormhole = Wormhole;
+//# sourceMappingURL=wormhole.js.map

package/dist/cjs/wormhole.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wormhole.js","sourceRoot":"","sources":["../../src/wormhole.ts"],"names":[],"mappings":";;;AAAA,4DAAkG;AAClG,0EAkB8C;AAC9C,6CAA6D;AAC7D,qCAAiG;AACjG,2DAA0D;AAC1D,6DAA0D;AAE1D,gDAAkD;AAClD,mCAAgC;AAChC,6CAOsB;AAKtB,MAAa,QAAQ;IACA,QAAQ,CAAI;IACrB,UAAU,CAAiB;IAC3B,OAAO,CAAc;IAEtB,MAAM,CAAiB;IAEhC,YAAY,OAAU,EAAE,SAA+B,EAAE,MAAwB;QAC/E,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAA,uBAAc,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAE9C,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE;YACzB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;SAClD;IACH,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAClB,MAAc,EACd,IAAkB,EAClB,EAAgB,EAChB,SAAkB,EAClB,OAAoB,EACpB,SAAkB;QAElB,IAAI,SAAS,IAAI,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAE9F,IACE,CAAC,iBAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC;YAC/C,CAAC,iBAAM,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC;YAC7C,CAAC,iBAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC;YACnD,CAAC,iBAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC;YAEjD,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAErF,0CAA0C;QAC1C,IAAI,SAAS,EAAE;YACb,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,wBAAwB,EAAE,CAAC;YACvE,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;YACrD,MAAM,SAAS,GAAG,UAAU,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC5D,IAAI,MAAM,GAAG,SAAS;gBACpB,MAAM,IAAI,KAAK,CAAC,oBAAoB,SAAS,2BAA2B,CAAC,CAAC;SAC7E;QAED,OAAO,MAAM,6BAAc,CAAC,IAAI,CAAC,IAAI,EAAE;YACrC,MAAM;YACN,IAAI;YACJ,EAAE;YACF,SAAS;YACT,OAAO;YACP,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,KAAc,EACd,MAAc,EACd,IAAkB,EAClB,EAAgB,EAChB,SAAkB,EAClB,OAAoB,EACpB,SAAkB;QAElB,OAAO,MAAM,6BAAa,CAAC,IAAI,CAAC,IAAI,EAAE;YACpC,KAAK;YACL,MAAM;YACN,IAAI;YACJ,EAAE;YACF,SAAS;YACT,OAAO;YACP,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAA0B;QACjC,OAAO,IAAI,wBAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,KAAY;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAqB,YAAe;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,QAAQ,EAAE,CAAC,CAAC;QAC5E,OAAO,QAAiC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAkB,KAAQ;QAChC,MAAM,QAAQ,GAAG,IAAA,0BAAe,EAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;YAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAwB,CAAC;IACxD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CAAkB,KAAQ,EAAE,KAAqB;QACpE,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,cAAc,EAAE,CAAC;QACtC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CAAkB,KAAiB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,cAAc,EAAE,CAAC;QACtC,OAAO,MAAM,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAkB,KAAQ,EAAE,KAAsB;QACjE,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,MAAM,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAU,CACd,KAAQ,EACR,KAAsB,EACtB,aAAqB;QAErB,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC,UAAU,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CACnB,SAA0B,EAC1B,KAAiB;QAEjB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CACf,iBAAoC,EACpC,UAAkB,6BAAoB;QAEtC,OAAO,MAAM,IAAA,iCAAoB,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,EAA8B,EAC9B,QAAW,EACX,UAAkB,6BAAoB;QAEtC,IAAI,OAAO,EAAE,KAAK,QAAQ;YACxB,OAAO,MAAM,IAAA,oCAAuB,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAE/E,OAAO,MAAM,IAAA,4BAAe,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,UAAkB,6BAAoB;QAEtC,OAAO,IAAA,0CAA6B,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,EAA8B,EAC9B,OAAO,GAAG,6BAAoB;QAE9B,IAAI,KAAwB,CAAC;QAC7B,0DAA0D;QAC1D,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;YAC1B,MAAM,GAAG,GAAG,MAAM,IAAA,oCAAuB,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;YACtF,IAAI,CAAC,GAAG;gBAAE,OAAO,IAAI,CAAC;YACtB,KAAK,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;SAC1F;aAAM;YACL,KAAK,GAAG,EAAE,CAAC;SACZ;QAED,OAAO,MAAM,IAAA,0CAA6B,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAe,EACf,WAAmB,EAAE,EACrB,OAAe,CAAC;QAEhB,OAAO,IAAA,4BAAe,EAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAkB,KAAQ,EAAE,OAAe;QAC5D,OAAO,IAAA,0BAAQ,EAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CAAC,YAAoC;QAC1D,OAAO,IAAA,kCAAgB,EAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAkB,KAAQ,EAAE,OAAe;QAC5D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;IACnE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAkB,KAAQ,EAAE,OAAe;QACvD,OAAO,IAAA,0BAAQ,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAA,+BAAa,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,KAAyB,EACzB,IAAY,EACZ,UAAkB,6BAAoB;QAEtC,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;YACtB,IAAI;gBACF,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAChD,uDAAuD;gBACvD,8BAA8B;gBAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO,IAAI,CAAC;gBACnC,OAAO,IAAI,CAAC;aACb;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACjB,OAAO,IAAI,CAAC;aACb;QACH,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAA,aAAK,EACxB,IAAI,EACJ,KAAK,CAAC,MAAM,CAAC,SAAS,EACtB,OAAO,EACP,0CAA0C,CAC3C,CAAC;QAEF,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAhYD,4BAgYC"}

package/dist/cjs/wormholeTransfer.d.ts

@@ -0,0 +1,78 @@
+import { Chain, Network, Platform, PlatformToChains, ProtocolName } from "@wormhole-foundation/sdk-base";
+import { AttestationId, AttestationReceipt, ChainContext, CircleTransferDetails, GatewayTransferDetails, Signer, TokenId, TokenTransferDetails, TransactionId, TxHash } from "@wormhole-foundation/sdk-definitions";
+import { Wormhole } from "./wormhole";
+export type TransferRequest<PN extends ProtocolName = ProtocolName> = PN extends "TokenBridge" | "AutomaticTokenBridge" ? TokenTransferDetails : PN extends "CircleBridge" | "AutomaticCircleBridge" ? CircleTransferDetails : PN extends "IbcBridge" ? GatewayTransferDetails : never;
+export declare enum TransferState {
+    Failed = -1,
+    Created = 0,
+    SourceInitiated = 1,
+    SourceFinalized = 2,
+    Attested = 3,
+    DestinationInitiated = 4,
+    DestinationFinalized = 5
+}
+interface BaseTransferReceipt<PN extends ProtocolName, SC extends Chain, DC extends Chain> {
+    protocol: PN;
+    from: SC;
+    to: DC;
+    request: TransferRequest<PN>;
+    state: TransferState;
+}
+export interface CreatedTransferReceipt<PN extends ProtocolName, SC extends Chain = Chain, DC extends Chain = Chain> extends BaseTransferReceipt<PN, SC, DC> {
+    state: TransferState.Created;
+}
+export interface SourceInitiatedTransferReceipt<PN extends ProtocolName, SC extends Chain = Chain, DC extends Chain = Chain> extends BaseTransferReceipt<PN, SC, DC> {
+    state: TransferState.SourceInitiated;
+    originTxs: TransactionId<SC>[];
+}
+export interface SourceFinalizedTransferReceipt<PN extends ProtocolName, SC extends Chain = Chain, DC extends Chain = Chain> extends BaseTransferReceipt<PN, SC, DC> {
+    state: TransferState.SourceFinalized;
+    originTxs: TransactionId<SC>[];
+    attestation: AttestationReceipt<PN>;
+}
+export interface AttestedTransferReceipt<PN extends ProtocolName, SC extends Chain = Chain, DC extends Chain = Chain> extends BaseTransferReceipt<PN, SC, DC> {
+    state: TransferState.Attested;
+    originTxs: TransactionId<SC>[];
+    attestation: Required<AttestationReceipt<PN>>;
+}
+export interface CompletedTransferReceipt<PN extends ProtocolName, SC extends Chain = Chain, DC extends Chain = Chain> extends BaseTransferReceipt<PN, SC, DC> {
+    state: TransferState.DestinationInitiated | TransferState.DestinationFinalized;
+    originTxs: TransactionId<SC>[];
+    attestation: AttestationReceipt<PN>;
+    destinationTxs?: TransactionId<DC>[];
+}
+export declare function isAttested<PN extends ProtocolName>(receipt: TransferReceipt<PN, Chain, Chain>): receipt is AttestedTransferReceipt<PN, Chain, Chain>;
+export declare function isSourceInitiated<PN extends ProtocolName>(receipt: TransferReceipt<PN, Chain, Chain>): receipt is SourceInitiatedTransferReceipt<PN, Chain, Chain>;
+export declare function isSourceFinalized<PN extends ProtocolName>(receipt: TransferReceipt<PN, Chain, Chain>): receipt is SourceFinalizedTransferReceipt<PN, Chain, Chain>;
+export type TransferReceipt<PN extends ProtocolName, SC extends Chain = Chain, DC extends Chain = Chain> = CreatedTransferReceipt<PN, SC, DC> | SourceInitiatedTransferReceipt<PN, SC, DC> | SourceFinalizedTransferReceipt<PN, SC, DC> | AttestedTransferReceipt<PN, SC, DC> | CompletedTransferReceipt<PN, SC, DC>;
+export type TransferQuote = {
+    sourceToken: {
+        token: TokenId;
+        amount: bigint;
+    };
+    destinationToken: {
+        token: TokenId;
+        amount: bigint;
+    };
+    relayFee?: {
+        token: TokenId;
+        amount: bigint;
+    };
+    destinationNativeGas?: bigint;
+};
+export interface TransferProtocol<PN extends ProtocolName> {
+    isTransferComplete<N extends Network, P extends Platform, C extends PlatformToChains<P>>(toChain: ChainContext<N, P, C>, attestation: AttestationId<PN>): Promise<boolean>;
+    validateTransferDetails<N extends Network>(wh: Wormhole<N>, transfer: TransferRequest<PN>): Promise<void>;
+    quoteTransfer(xfer: WormholeTransfer<PN>): Promise<TransferQuote>;
+    getReceipt(xfer: WormholeTransfer<PN>): TransferReceipt<PN>;
+    track<N extends Network>(wh: Wormhole<N>, xfer: WormholeTransfer<PN>, timeout: number): AsyncGenerator<TransferReceipt<PN>, unknown, unknown>;
+}
+export interface WormholeTransfer<PN extends ProtocolName> {
+    transfer: TransferRequest<PN>;
+    getTransferState(): TransferState;
+    initiateTransfer(signer: Signer): Promise<TxHash[]>;
+    fetchAttestation(timeout?: number): Promise<AttestationId[]>;
+    completeTransfer(signer: Signer): Promise<TxHash[]>;
+}
+export {};
+//# sourceMappingURL=wormholeTransfer.d.ts.map

package/dist/cjs/wormholeTransfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wormholeTransfer.d.ts","sourceRoot":"","sources":["../../src/wormholeTransfer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,OAAO,EACP,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACb,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,sBAAsB,EACtB,MAAM,EACN,OAAO,EACP,oBAAoB,EACpB,aAAa,EACb,MAAM,EACP,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,MAAM,eAAe,CAAC,EAAE,SAAS,YAAY,GAAG,YAAY,IAAI,EAAE,SACpE,aAAa,GACb,sBAAsB,GACtB,oBAAoB,GACpB,EAAE,SAAS,cAAc,GAAG,uBAAuB,GACnD,qBAAqB,GACrB,EAAE,SAAS,WAAW,GACtB,sBAAsB,GACtB,KAAK,CAAC;AAGV,oBAAY,aAAa;IACvB,MAAM,KAAK;IACX,OAAO,IAAI;IACX,eAAe,IAAA;IACf,eAAe,IAAA;IACf,QAAQ,IAAA;IACR,oBAAoB,IAAA;IACpB,oBAAoB,IAAA;CACrB;AAGD,UAAU,mBAAmB,CAAC,EAAE,SAAS,YAAY,EAAE,EAAE,SAAS,KAAK,EAAE,EAAE,SAAS,KAAK;IACvF,QAAQ,EAAE,EAAE,CAAC;IACb,IAAI,EAAE,EAAE,CAAC;IACT,EAAE,EAAE,EAAE,CAAC;IACP,OAAO,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC;IAC7B,KAAK,EAAE,aAAa,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB,CACrC,EAAE,SAAS,YAAY,EACvB,EAAE,SAAS,KAAK,GAAG,KAAK,EACxB,EAAE,SAAS,KAAK,GAAG,KAAK,CACxB,SAAQ,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IACvC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,8BAA8B,CAC7C,EAAE,SAAS,YAAY,EACvB,EAAE,SAAS,KAAK,GAAG,KAAK,EACxB,EAAE,SAAS,KAAK,GAAG,KAAK,CACxB,SAAQ,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IACvC,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC;IACrC,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC;CAChC;AACD,MAAM,WAAW,8BAA8B,CAC7C,EAAE,SAAS,YAAY,EACvB,EAAE,SAAS,KAAK,GAAG,KAAK,EACxB,EAAE,SAAS,KAAK,GAAG,KAAK,CACxB,SAAQ,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IACvC,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC;IACrC,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/B,WAAW,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;CACrC;AACD,MAAM,WAAW,uBAAuB,CACtC,EAAE,SAAS,YAAY,EACvB,EAAE,SAAS,KAAK,GAAG,KAAK,EACxB,EAAE,SAAS,KAAK,GAAG,KAAK,CACxB,SAAQ,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IACvC,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC;IAC9B,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/B,WAAW,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;CAC/C;AACD,MAAM,WAAW,wBAAwB,CACvC,EAAE,SAAS,YAAY,EACvB,EAAE,SAAS,KAAK,GAAG,KAAK,EACxB,EAAE,SAAS,KAAK,GAAG,KAAK,CACxB,SAAQ,mBAAmB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IACvC,KAAK,EAAE,aAAa,CAAC,oBAAoB,GAAG,aAAa,CAAC,oBAAoB,CAAC;IAC/E,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/B,WAAW,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC;IACpC,cAAc,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC;CACtC;AAED,wBAAgB,UAAU,CAAC,EAAE,SAAS,YAAY,EAChD,OAAO,EAAE,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,GACzC,OAAO,IAAI,uBAAuB,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAEtD;AAED,wBAAgB,iBAAiB,CAAC,EAAE,SAAS,YAAY,EACvD,OAAO,EAAE,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,GACzC,OAAO,IAAI,8BAA8B,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAE7D;AAED,wBAAgB,iBAAiB,CAAC,EAAE,SAAS,YAAY,EACvD,OAAO,EAAE,eAAe,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,GACzC,OAAO,IAAI,8BAA8B,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAE7D;AAED,MAAM,MAAM,eAAe,CACzB,EAAE,SAAS,YAAY,EACvB,EAAE,SAAS,KAAK,GAAG,KAAK,EACxB,EAAE,SAAS,KAAK,GAAG,KAAK,IAEtB,sBAAsB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAClC,8BAA8B,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAC1C,8BAA8B,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAC1C,uBAAuB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GACnC,wBAAwB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;AAIzC,MAAM,MAAM,aAAa,GAAG;IAI1B,WAAW,EAAE;QACX,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAGF,gBAAgB,EAAE;QAChB,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAGF,QAAQ,CAAC,EAAE;QACT,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAIF,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAIF,MAAM,WAAW,gBAAgB,CAAC,EAAE,SAAS,YAAY;IACvD,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,gBAAgB,CAAC,CAAC,CAAC,EACrF,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC9B,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC,GAC7B,OAAO,CAAC,OAAO,CAAC,CAAC;IACpB,uBAAuB,CAAC,CAAC,SAAS,OAAO,EACvC,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,EACf,QAAQ,EAAE,eAAe,CAAC,EAAE,CAAC,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,aAAa,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAClE,UAAU,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;IAC5D,KAAK,CAAC,CAAC,SAAS,OAAO,EACrB,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,EACf,IAAI,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAC1B,OAAO,EAAE,MAAM,GACd,cAAc,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;CAC1D;AAID,MAAM,WAAW,gBAAgB,CAAC,EAAE,SAAS,YAAY;IACvD,QAAQ,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC;IAI9B,gBAAgB,IAAI,aAAa,CAAC;IAIlC,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAIpD,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAI7D,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CAMrD"}

package/dist/cjs/wormholeTransfer.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSourceFinalized = exports.isSourceInitiated = exports.isAttested = exports.TransferState = void 0;
+// Transfer state machine states
+var TransferState;
+(function (TransferState) {
+    TransferState[TransferState["Failed"] = -1] = "Failed";
+    TransferState[TransferState["Created"] = 0] = "Created";
+    TransferState[TransferState["SourceInitiated"] = 1] = "SourceInitiated";
+    TransferState[TransferState["SourceFinalized"] = 2] = "SourceFinalized";
+    TransferState[TransferState["Attested"] = 3] = "Attested";
+    TransferState[TransferState["DestinationInitiated"] = 4] = "DestinationInitiated";
+    TransferState[TransferState["DestinationFinalized"] = 5] = "DestinationFinalized";
+})(TransferState || (exports.TransferState = TransferState = {}));
+function isAttested(receipt) {
+    return receipt.state === TransferState.Attested;
+}
+exports.isAttested = isAttested;
+function isSourceInitiated(receipt) {
+    return receipt.state === TransferState.SourceInitiated;
+}
+exports.isSourceInitiated = isSourceInitiated;
+function isSourceFinalized(receipt) {
+    return receipt.state === TransferState.SourceFinalized;
+}
+exports.isSourceFinalized = isSourceFinalized;
+//# sourceMappingURL=wormholeTransfer.js.map