@hyperlane-xyz/sdk 3.7.0 → 3.8.0

package/dist/token/Token.js

@@ -0,0 +1,277 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Token = void 0;
+const utils_1 = require("@hyperlane-xyz/utils");
+const TokenAmount_1 = require("./TokenAmount");
+const TokenConnection_1 = require("./TokenConnection");
+const TokenStandard_1 = require("./TokenStandard");
+const CosmWasmTokenAdapter_1 = require("./adapters/CosmWasmTokenAdapter");
+const CosmosTokenAdapter_1 = require("./adapters/CosmosTokenAdapter");
+const EvmTokenAdapter_1 = require("./adapters/EvmTokenAdapter");
+const SealevelTokenAdapter_1 = require("./adapters/SealevelTokenAdapter");
+class Token {
+    constructor(args) {
+        Object.assign(this, args);
+        this.protocol = TokenStandard_1.TOKEN_STANDARD_TO_PROTOCOL[this.standard];
+    }
+    static FromChainMetadataNativeToken(chainMetadata) {
+        const { protocol, name: chainName, nativeToken, logoURI } = chainMetadata;
+        (0, utils_1.assert)(nativeToken, `ChainMetadata for ${chainMetadata.name} missing nativeToken`);
+        return new Token({
+            chainName,
+            standard: TokenStandard_1.PROTOCOL_TO_NATIVE_STANDARD[protocol],
+            addressOrDenom: nativeToken.denom ?? '',
+            decimals: nativeToken.decimals,
+            symbol: nativeToken.symbol,
+            name: nativeToken.name,
+            logoURI,
+        });
+    }
+    /**
+     * Returns a TokenAdapter for the token and multiProvider
+     * @throws If multiProvider does not contain this token's chain.
+     * @throws If token is an NFT (TODO NFT Adapter support)
+     */
+    getAdapter(multiProvider) {
+        const { standard, chainName, addressOrDenom } = this;
+        (0, utils_1.assert)(!this.isNft(), 'NFT adapters not yet supported');
+        (0, utils_1.assert)(multiProvider.tryGetChainMetadata(chainName), `Token chain ${chainName} not found in multiProvider`);
+        if (standard === TokenStandard_1.TokenStandard.ERC20) {
+            return new EvmTokenAdapter_1.EvmTokenAdapter(chainName, multiProvider, {
+                token: addressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.EvmNative) {
+            return new EvmTokenAdapter_1.EvmNativeTokenAdapter(chainName, multiProvider, {});
+        }
+        else if (standard === TokenStandard_1.TokenStandard.SealevelSpl) {
+            return new SealevelTokenAdapter_1.SealevelTokenAdapter(chainName, multiProvider, { token: addressOrDenom }, false);
+        }
+        else if (standard === TokenStandard_1.TokenStandard.SealevelSpl2022) {
+            return new SealevelTokenAdapter_1.SealevelTokenAdapter(chainName, multiProvider, { token: addressOrDenom }, true);
+        }
+        else if (standard === TokenStandard_1.TokenStandard.SealevelNative) {
+            return new SealevelTokenAdapter_1.SealevelNativeTokenAdapter(chainName, multiProvider, {});
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CosmosIcs20) {
+            throw new Error('Cosmos ICS20 token adapter not yet supported');
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CosmosNative) {
+            return new CosmosTokenAdapter_1.CosmNativeTokenAdapter(chainName, multiProvider, {}, { ibcDenom: addressOrDenom });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CW20) {
+            return new CosmWasmTokenAdapter_1.CwTokenAdapter(chainName, multiProvider, {
+                token: addressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CWNative) {
+            return new CosmWasmTokenAdapter_1.CwNativeTokenAdapter(chainName, multiProvider, {}, addressOrDenom);
+        }
+        else if (this.isHypToken()) {
+            return this.getHypAdapter(multiProvider);
+        }
+        else if (this.isIbcToken()) {
+            // Passing in a stub connection here because it's not required
+            // for an IBC adapter to fulfill the ITokenAdapter interface
+            return this.getIbcAdapter(multiProvider, {
+                token: this,
+                sourcePort: 'transfer',
+                sourceChannel: 'channel-0',
+                type: TokenConnection_1.TokenConnectionType.Ibc,
+            });
+        }
+        else {
+            throw new Error(`No adapter found for token standard: ${standard}`);
+        }
+    }
+    /**
+     * Returns a HypTokenAdapter for the token and multiProvider
+     * @throws If not applicable to this token's standard.
+     * @throws If multiProvider does not contain this token's chain.
+     * @throws If token is an NFT (TODO NFT Adapter support)
+     */
+    getHypAdapter(multiProvider, destination) {
+        const { protocol, standard, chainName, addressOrDenom, collateralAddressOrDenom, } = this;
+        const chainMetadata = multiProvider.tryGetChainMetadata(chainName);
+        const mailbox = chainMetadata?.mailbox;
+        (0, utils_1.assert)(this.isMultiChainToken(), `Token standard ${standard} not applicable to hyp adapter`);
+        (0, utils_1.assert)(!this.isNft(), 'NFT adapters not yet supported');
+        (0, utils_1.assert)(chainMetadata, `Token chain ${chainName} not found in multiProvider`);
+        let sealevelAddresses;
+        if (protocol === utils_1.ProtocolType.Sealevel) {
+            (0, utils_1.assert)(mailbox, `Mailbox required for Sealevel hyp tokens`);
+            (0, utils_1.assert)(collateralAddressOrDenom, `collateralAddressOrDenom required for Sealevel hyp tokens`);
+            sealevelAddresses = {
+                warpRouter: addressOrDenom,
+                token: collateralAddressOrDenom,
+                mailbox,
+            };
+        }
+        if (standard === TokenStandard_1.TokenStandard.EvmHypNative) {
+            return new EvmTokenAdapter_1.EvmHypNativeAdapter(chainName, multiProvider, {
+                token: addressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.EvmHypCollateral) {
+            return new EvmTokenAdapter_1.EvmHypCollateralAdapter(chainName, multiProvider, {
+                token: addressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.EvmHypSynthetic) {
+            return new EvmTokenAdapter_1.EvmHypSyntheticAdapter(chainName, multiProvider, {
+                token: addressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.SealevelHypNative) {
+            return new SealevelTokenAdapter_1.SealevelHypNativeAdapter(chainName, multiProvider, sealevelAddresses, false);
+        }
+        else if (standard === TokenStandard_1.TokenStandard.SealevelHypCollateral) {
+            return new SealevelTokenAdapter_1.SealevelHypCollateralAdapter(chainName, multiProvider, sealevelAddresses, false);
+        }
+        else if (standard === TokenStandard_1.TokenStandard.SealevelHypSynthetic) {
+            return new SealevelTokenAdapter_1.SealevelHypSyntheticAdapter(chainName, multiProvider, sealevelAddresses, false);
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CwHypNative) {
+            return new CosmWasmTokenAdapter_1.CwHypNativeAdapter(chainName, multiProvider, {
+                warpRouter: addressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CwHypCollateral) {
+            (0, utils_1.assert)(collateralAddressOrDenom, 'collateralAddressOrDenom required for CwHypCollateral');
+            return new CosmWasmTokenAdapter_1.CwHypCollateralAdapter(chainName, multiProvider, {
+                warpRouter: addressOrDenom,
+                token: collateralAddressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CwHypSynthetic) {
+            (0, utils_1.assert)(collateralAddressOrDenom, 'collateralAddressOrDenom required for CwHypSyntheticAdapter');
+            return new CosmWasmTokenAdapter_1.CwHypSyntheticAdapter(chainName, multiProvider, {
+                warpRouter: addressOrDenom,
+                token: collateralAddressOrDenom,
+            });
+        }
+        else if (standard === TokenStandard_1.TokenStandard.CosmosIbc) {
+            (0, utils_1.assert)(destination, 'destination required for IBC token adapters');
+            const connection = this.getConnectionForChain(destination);
+            (0, utils_1.assert)(connection, `No connection found for chain ${destination}`);
+            return this.getIbcAdapter(multiProvider, connection);
+        }
+        else {
+            throw new Error(`No hyp adapter found for token standard: ${standard}`);
+        }
+    }
+    getIbcAdapter(multiProvider, connection) {
+        if (connection.type === TokenConnection_1.TokenConnectionType.Ibc) {
+            const { sourcePort, sourceChannel } = connection;
+            return new CosmosTokenAdapter_1.CosmIbcTokenAdapter(this.chainName, multiProvider, {}, { ibcDenom: this.addressOrDenom, sourcePort, sourceChannel });
+        }
+        else if (connection.type === TokenConnection_1.TokenConnectionType.IbcHyperlane) {
+            const { sourcePort, sourceChannel, intermediateChainName, intermediateIbcDenom, intermediateRouterAddress, } = connection;
+            const destinationRouterAddress = connection.token.addressOrDenom;
+            return new CosmosTokenAdapter_1.CosmIbcToWarpTokenAdapter(this.chainName, multiProvider, {
+                intermediateRouterAddress,
+                destinationRouterAddress,
+            }, {
+                ibcDenom: this.addressOrDenom,
+                sourcePort,
+                sourceChannel,
+                intermediateIbcDenom,
+                intermediateChainName,
+            });
+        }
+        else {
+            throw new Error(`Unsupported IBC connection type: ${connection.type}`);
+        }
+    }
+    /**
+     * Convenience method to create an adapter and return an account balance
+     */
+    async getBalance(multiProvider, address) {
+        const adapter = this.getAdapter(multiProvider);
+        const balance = await adapter.getBalance(address);
+        return new TokenAmount_1.TokenAmount(balance, this);
+    }
+    amount(amount) {
+        return new TokenAmount_1.TokenAmount(amount, this);
+    }
+    isNft() {
+        return TokenStandard_1.TOKEN_NFT_STANDARDS.includes(this.standard);
+    }
+    isNative() {
+        return Object.values(TokenStandard_1.PROTOCOL_TO_NATIVE_STANDARD).includes(this.standard);
+    }
+    isHypToken() {
+        return TokenStandard_1.TOKEN_HYP_STANDARDS.includes(this.standard);
+    }
+    isIbcToken() {
+        return this.standard === TokenStandard_1.TokenStandard.CosmosIbc;
+    }
+    isMultiChainToken() {
+        return TokenStandard_1.TOKEN_MULTI_CHAIN_STANDARDS.includes(this.standard);
+    }
+    getConnections() {
+        return this.connections || [];
+    }
+    getConnectionForChain(chain) {
+        // A token cannot have > 1 connected token for the same chain
+        return this.getConnections().filter((t) => t.token.chainName === chain)[0];
+    }
+    addConnection(connection) {
+        this.connections = [...(this.connections || []), connection];
+        return this;
+    }
+    removeConnection(token) {
+        const index = this.connections?.findIndex((t) => t.token.equals(token));
+        if (index && index >= 0)
+            this.connections?.splice(index, 1);
+        return this;
+    }
+    /**
+     * Returns true if tokens refer to the same asset
+     */
+    equals(token) {
+        if (!token)
+            return false;
+        return (this.protocol === token.protocol &&
+            this.chainName === token.chainName &&
+            this.standard === token.standard &&
+            this.decimals === token.decimals &&
+            this.addressOrDenom.toLowerCase() ===
+                token.addressOrDenom.toLowerCase() &&
+            this.collateralAddressOrDenom?.toLowerCase() ===
+                token.collateralAddressOrDenom?.toLowerCase());
+    }
+    /**
+     * Two tokens may not be equal but may still represent the same underlying asset
+     * The cases for this include:
+     *   1) A HypCollateral contract token and its wrapped token (eg. EvmHypCollateral and ERC20)
+     *   2) A HypNative contract and its native currency (eg. EvmHypNative and Ether)
+     *   3) An IBC token and its native equivalent
+     * This is useful during fee estimation to determine if a TokenAmount for the transfer and the fee
+     * are actually fungible (represent the same asset).
+     * @returns true if the tokens represent the same underlying asset
+     */
+    isFungibleWith(token) {
+        if (!token || token.chainName !== this.chainName)
+            return false;
+        if (this.equals(token))
+            return true;
+        if (TokenStandard_1.TOKEN_COLLATERALIZED_STANDARDS.includes(this.standard)) {
+            if (this.collateralAddressOrDenom &&
+                (0, utils_1.eqAddress)(this.collateralAddressOrDenom, token.addressOrDenom)) {
+                return true;
+            }
+            if (!this.collateralAddressOrDenom && token.isNative()) {
+                return true;
+            }
+        }
+        if (this.standard === TokenStandard_1.TokenStandard.CosmosIbc &&
+            token.standard === TokenStandard_1.TokenStandard.CosmosNative &&
+            this.addressOrDenom.toLowerCase() === token.addressOrDenom.toLowerCase()) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.Token = Token;
+//# sourceMappingURL=Token.js.map

package/dist/token/Token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.js","sourceRoot":"","sources":["../../src/token/Token.ts"],"names":[],"mappings":";;;AAGA,gDAM8B;AAO9B,+CAA4C;AAC5C,uDAAyE;AACzE,mDAQyB;AACzB,0EAMyC;AACzC,sEAIuC;AACvC,gEAMoC;AAEpC,0EAMyC;AAMzC,MAAa,KAAK;IAGhB,YAAY,IAAe;QACzB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,0CAA0B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,4BAA4B,CAAC,aAA4B;QAC9D,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC;QAC1E,IAAA,cAAM,EACJ,WAAW,EACX,qBAAqB,aAAa,CAAC,IAAI,sBAAsB,CAC9D,CAAC;QAEF,OAAO,IAAI,KAAK,CAAC;YACf,SAAS;YACT,QAAQ,EAAE,2CAA2B,CAAC,QAAQ,CAAC;YAC/C,cAAc,EAAE,WAAW,CAAC,KAAK,IAAI,EAAE;YACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ;YAC9B,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,IAAI,EAAE,WAAW,CAAC,IAAI;YACtB,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,aAAoC;QAC7C,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAErD,IAAA,cAAM,EAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,gCAAgC,CAAC,CAAC;QACxD,IAAA,cAAM,EACJ,aAAa,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAC5C,eAAe,SAAS,6BAA6B,CACtD,CAAC;QAEF,IAAI,QAAQ,KAAK,6BAAa,CAAC,KAAK,EAAE;YACpC,OAAO,IAAI,iCAAe,CAAC,SAAS,EAAE,aAAa,EAAE;gBACnD,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,SAAS,EAAE;YAC/C,OAAO,IAAI,uCAAqB,CAAC,SAAS,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;SAChE;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,WAAW,EAAE;YACjD,OAAO,IAAI,2CAAoB,CAC7B,SAAS,EACT,aAAa,EACb,EAAE,KAAK,EAAE,cAAc,EAAE,EACzB,KAAK,CACN,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,eAAe,EAAE;YACrD,OAAO,IAAI,2CAAoB,CAC7B,SAAS,EACT,aAAa,EACb,EAAE,KAAK,EAAE,cAAc,EAAE,EACzB,IAAI,CACL,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,cAAc,EAAE;YACpD,OAAO,IAAI,iDAA0B,CAAC,SAAS,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;SACrE;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,WAAW,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;SACjE;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,YAAY,EAAE;YAClD,OAAO,IAAI,2CAAsB,CAC/B,SAAS,EACT,aAAa,EACb,EAAE,EACF,EAAE,QAAQ,EAAE,cAAc,EAAE,CAC7B,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,IAAI,EAAE;YAC1C,OAAO,IAAI,qCAAc,CAAC,SAAS,EAAE,aAAa,EAAE;gBAClD,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,QAAQ,EAAE;YAC9C,OAAO,IAAI,2CAAoB,CAC7B,SAAS,EACT,aAAa,EACb,EAAE,EACF,cAAc,CACf,CAAC;SACH;aAAM,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YAC5B,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;SAC1C;aAAM,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YAC5B,8DAA8D;YAC9D,4DAA4D;YAC5D,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;gBACvC,KAAK,EAAE,IAAI;gBACX,UAAU,EAAE,UAAU;gBACtB,aAAa,EAAE,WAAW;gBAC1B,IAAI,EAAE,qCAAmB,CAAC,GAAG;aAC9B,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,wCAAwC,QAAQ,EAAE,CAAC,CAAC;SACrE;IACH,CAAC;IAED;;;;;OAKG;IACH,aAAa,CACX,aAA2D,EAC3D,WAAuB;QAEvB,MAAM,EACJ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,cAAc,EACd,wBAAwB,GACzB,GAAG,IAAI,CAAC;QACT,MAAM,aAAa,GAAG,aAAa,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,aAAa,EAAE,OAAO,CAAC;QAEvC,IAAA,cAAM,EACJ,IAAI,CAAC,iBAAiB,EAAE,EACxB,kBAAkB,QAAQ,gCAAgC,CAC3D,CAAC;QACF,IAAA,cAAM,EAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,gCAAgC,CAAC,CAAC;QACxD,IAAA,cAAM,EACJ,aAAa,EACb,eAAe,SAAS,6BAA6B,CACtD,CAAC;QAEF,IAAI,iBAAiB,CAAC;QACtB,IAAI,QAAQ,KAAK,oBAAY,CAAC,QAAQ,EAAE;YACtC,IAAA,cAAM,EAAC,OAAO,EAAE,0CAA0C,CAAC,CAAC;YAC5D,IAAA,cAAM,EACJ,wBAAwB,EACxB,2DAA2D,CAC5D,CAAC;YACF,iBAAiB,GAAG;gBAClB,UAAU,EAAE,cAAc;gBAC1B,KAAK,EAAE,wBAAwB;gBAC/B,OAAO;aACR,CAAC;SACH;QACD,IAAI,QAAQ,KAAK,6BAAa,CAAC,YAAY,EAAE;YAC3C,OAAO,IAAI,qCAAmB,CAAC,SAAS,EAAE,aAAa,EAAE;gBACvD,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,gBAAgB,EAAE;YACtD,OAAO,IAAI,yCAAuB,CAAC,SAAS,EAAE,aAAa,EAAE;gBAC3D,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,eAAe,EAAE;YACrD,OAAO,IAAI,wCAAsB,CAAC,SAAS,EAAE,aAAa,EAAE;gBAC1D,KAAK,EAAE,cAAc;aACtB,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,iBAAiB,EAAE;YACvD,OAAO,IAAI,+CAAwB,CACjC,SAAS,EACT,aAAa,EACb,iBAAkB,EAClB,KAAK,CACN,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,qBAAqB,EAAE;YAC3D,OAAO,IAAI,mDAA4B,CACrC,SAAS,EACT,aAAa,EACb,iBAAkB,EAClB,KAAK,CACN,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,oBAAoB,EAAE;YAC1D,OAAO,IAAI,kDAA2B,CACpC,SAAS,EACT,aAAa,EACb,iBAAkB,EAClB,KAAK,CACN,CAAC;SACH;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,WAAW,EAAE;YACjD,OAAO,IAAI,yCAAkB,CAAC,SAAS,EAAE,aAAa,EAAE;gBACtD,UAAU,EAAE,cAAc;aAC3B,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,eAAe,EAAE;YACrD,IAAA,cAAM,EACJ,wBAAwB,EACxB,uDAAuD,CACxD,CAAC;YACF,OAAO,IAAI,6CAAsB,CAAC,SAAS,EAAE,aAAa,EAAE;gBAC1D,UAAU,EAAE,cAAc;gBAC1B,KAAK,EAAE,wBAAwB;aAChC,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,cAAc,EAAE;YACpD,IAAA,cAAM,EACJ,wBAAwB,EACxB,6DAA6D,CAC9D,CAAC;YACF,OAAO,IAAI,4CAAqB,CAAC,SAAS,EAAE,aAAa,EAAE;gBACzD,UAAU,EAAE,cAAc;gBAC1B,KAAK,EAAE,wBAAwB;aAChC,CAAC,CAAC;SACJ;aAAM,IAAI,QAAQ,KAAK,6BAAa,CAAC,SAAS,EAAE;YAC/C,IAAA,cAAM,EAAC,WAAW,EAAE,6CAA6C,CAAC,CAAC;YACnE,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;YAC3D,IAAA,cAAM,EAAC,UAAU,EAAE,iCAAiC,WAAW,EAAE,CAAC,CAAC;YACnE,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;SACtD;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,4CAA4C,QAAQ,EAAE,CAAC,CAAC;SACzE;IACH,CAAC;IAES,aAAa,CACrB,aAAoC,EACpC,UAA2B;QAE3B,IAAI,UAAU,CAAC,IAAI,KAAK,qCAAmB,CAAC,GAAG,EAAE;YAC/C,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,UAAU,CAAC;YACjD,OAAO,IAAI,wCAAmB,CAC5B,IAAI,CAAC,SAAS,EACd,aAAa,EACb,EAAE,EACF,EAAE,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,aAAa,EAAE,CAC7D,CAAC;SACH;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,qCAAmB,CAAC,YAAY,EAAE;YAC/D,MAAM,EACJ,UAAU,EACV,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,GAC1B,GAAG,UAAU,CAAC;YACf,MAAM,wBAAwB,GAAG,UAAU,CAAC,KAAK,CAAC,cAAc,CAAC;YACjE,OAAO,IAAI,8CAAyB,CAClC,IAAI,CAAC,SAAS,EACd,aAAa,EACb;gBACE,yBAAyB;gBACzB,wBAAwB;aACzB,EACD;gBACE,QAAQ,EAAE,IAAI,CAAC,cAAc;gBAC7B,UAAU;gBACV,aAAa;gBACb,oBAAoB;gBACpB,qBAAqB;aACtB,CACF,CAAC;SACH;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;SACxE;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAoC,EACpC,OAAgB;QAEhB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,IAAI,yBAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,CAAC,MAAiB;QACtB,OAAO,IAAI,yBAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED,KAAK;QACH,OAAO,mCAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,QAAQ;QACN,OAAO,MAAM,CAAC,MAAM,CAAC,2CAA2B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAED,UAAU;QACR,OAAO,mCAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,KAAK,6BAAa,CAAC,SAAS,CAAC;IACnD,CAAC;IAED,iBAAiB;QACf,OAAO,2CAA2B,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;IAChC,CAAC;IAED,qBAAqB,CAAC,KAAgB;QACpC,6DAA6D;QAC7D,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,aAAa,CAAC,UAA2B;QACvC,IAAI,CAAC,WAAW,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB,CAAC,KAAa;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACxE,IAAI,KAAK,IAAI,KAAK,IAAI,CAAC;YAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAc;QACnB,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAC;QACzB,OAAO,CACL,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE;gBAC/B,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE;YACpC,IAAI,CAAC,wBAAwB,EAAE,WAAW,EAAE;gBAC1C,KAAK,CAAC,wBAAwB,EAAE,WAAW,EAAE,CAChD,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAc;QAC3B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QAE/D,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAEpC,IAAI,8CAA8B,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC1D,IACE,IAAI,CAAC,wBAAwB;gBAC7B,IAAA,iBAAS,EAAC,IAAI,CAAC,wBAAwB,EAAE,KAAK,CAAC,cAAc,CAAC,EAC9D;gBACA,OAAO,IAAI,CAAC;aACb;YAED,IAAI,CAAC,IAAI,CAAC,wBAAwB,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE;gBACtD,OAAO,IAAI,CAAC;aACb;SACF;QAED,IACE,IAAI,CAAC,QAAQ,KAAK,6BAAa,CAAC,SAAS;YACzC,KAAK,CAAC,QAAQ,KAAK,6BAAa,CAAC,YAAY;YAC7C,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,EACxE;YACA,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAtWD,sBAsWC"}

package/dist/token/Token.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Token.test.d.ts.map

package/dist/token/Token.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.test.d.ts","sourceRoot":"","sources":["../../src/token/Token.test.ts"],"names":[],"mappings":""}

package/dist/token/Token.test.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const chai_1 = require("chai");
+const ethers_1 = require("ethers");
+const utils_1 = require("@hyperlane-xyz/utils");
+const chainMetadata_1 = require("../consts/chainMetadata");
+const chains_1 = require("../consts/chains");
+const MultiProtocolProvider_1 = require("../providers/MultiProtocolProvider");
+const Token_1 = require("./Token");
+const TokenStandard_1 = require("./TokenStandard");
+// null values represent TODOs here, ideally all standards should be tested
+const STANDARD_TO_TOKEN = {
+    // EVM
+    [TokenStandard_1.TokenStandard.ERC20]: {
+        chainName: chains_1.Chains.ethereum,
+        standard: TokenStandard_1.TokenStandard.ERC20,
+        addressOrDenom: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+        decimals: 6,
+        symbol: 'USDC',
+        name: 'USDC',
+    },
+    [TokenStandard_1.TokenStandard.ERC721]: null,
+    [TokenStandard_1.TokenStandard.EvmNative]: Token_1.Token.FromChainMetadataNativeToken(chainMetadata_1.chainMetadata.optimism),
+    [TokenStandard_1.TokenStandard.EvmHypNative]: {
+        chainName: chains_1.Chains.inevm,
+        standard: TokenStandard_1.TokenStandard.EvmHypNative,
+        addressOrDenom: '0x26f32245fCF5Ad53159E875d5Cae62aEcf19c2d4',
+        decimals: 18,
+        symbol: 'INJ',
+        name: 'Injective Coin',
+    },
+    [TokenStandard_1.TokenStandard.EvmHypCollateral]: {
+        chainName: chains_1.Chains.bsctestnet,
+        standard: TokenStandard_1.TokenStandard.EvmHypCollateral,
+        addressOrDenom: '0x31b5234A896FbC4b3e2F7237592D054716762131',
+        collateralAddressOrDenom: '0x64544969ed7ebf5f083679233325356ebe738930',
+        decimals: 18,
+        symbol: 'USDC',
+        name: 'USDC',
+    },
+    [TokenStandard_1.TokenStandard.EvmHypSynthetic]: {
+        chainName: chains_1.Chains.inevm,
+        standard: TokenStandard_1.TokenStandard.EvmHypSynthetic,
+        addressOrDenom: '0x8358D8291e3bEDb04804975eEa0fe9fe0fAfB147',
+        decimals: 6,
+        symbol: 'USDC',
+        name: 'USDC',
+    },
+    // Sealevel
+    [TokenStandard_1.TokenStandard.SealevelSpl]: {
+        chainName: chains_1.Chains.solana,
+        standard: TokenStandard_1.TokenStandard.SealevelSpl,
+        addressOrDenom: 'So11111111111111111111111111111111111111112',
+        decimals: 9,
+        symbol: 'Wrapped SOL',
+        name: 'SOL',
+    },
+    [TokenStandard_1.TokenStandard.SealevelSpl2022]: {
+        chainName: chains_1.Chains.solana,
+        standard: TokenStandard_1.TokenStandard.SealevelSpl2022,
+        addressOrDenom: '21zHSATJqhNkcpoNkhFzPJW9LARSmoinLEeDtdygGuWh',
+        decimals: 6,
+        symbol: 'SOLMAX',
+        name: 'Solana Maxi',
+    },
+    [TokenStandard_1.TokenStandard.SealevelNative]: Token_1.Token.FromChainMetadataNativeToken(chainMetadata_1.chainMetadata.solana),
+    [TokenStandard_1.TokenStandard.SealevelHypNative]: null,
+    [TokenStandard_1.TokenStandard.SealevelHypCollateral]: null,
+    [TokenStandard_1.TokenStandard.SealevelHypSynthetic]: null,
+    // Cosmos
+    [TokenStandard_1.TokenStandard.CosmosIcs20]: null,
+    [TokenStandard_1.TokenStandard.CosmosIcs721]: null,
+    [TokenStandard_1.TokenStandard.CosmosNative]: Token_1.Token.FromChainMetadataNativeToken(chainMetadata_1.chainMetadata.neutron),
+    [TokenStandard_1.TokenStandard.CosmosIbc]: {
+        chainName: chains_1.Chains.neutron,
+        standard: TokenStandard_1.TokenStandard.CosmosIbc,
+        addressOrDenom: 'ibc/773B4D0A3CD667B2275D5A4A7A2F0909C0BA0F4059C0B9181E680DDF4965DCC7',
+        decimals: 6,
+        symbol: 'TIA',
+        name: 'TIA',
+    },
+    [TokenStandard_1.TokenStandard.CW20]: null,
+    [TokenStandard_1.TokenStandard.CWNative]: {
+        chainName: chains_1.Chains.neutron,
+        standard: TokenStandard_1.TokenStandard.CWNative,
+        addressOrDenom: 'ibc/5751B8BCDA688FD0A8EC0B292EEF1CDEAB4B766B63EC632778B196D317C40C3A',
+        decimals: 6,
+        symbol: 'ASTRO',
+        name: 'ASTRO',
+    },
+    [TokenStandard_1.TokenStandard.CW721]: null,
+    [TokenStandard_1.TokenStandard.CwHypNative]: {
+        chainName: chains_1.Chains.injective,
+        standard: TokenStandard_1.TokenStandard.CwHypNative,
+        addressOrDenom: 'inj1mv9tjvkaw7x8w8y9vds8pkfq46g2vcfkjehc6k',
+        igpTokenAddressOrDenom: 'inj',
+        decimals: 18,
+        symbol: 'INJ',
+        name: 'Injective Coin',
+    },
+    [TokenStandard_1.TokenStandard.CwHypCollateral]: {
+        chainName: chains_1.Chains.neutron,
+        standard: TokenStandard_1.TokenStandard.CwHypCollateral,
+        addressOrDenom: 'neutron1jyyjd3x0jhgswgm6nnctxvzla8ypx50tew3ayxxwkrjfxhvje6kqzvzudq',
+        collateralAddressOrDenom: 'ibc/773B4D0A3CD667B2275D5A4A7A2F0909C0BA0F4059C0B9181E680DDF4965DCC7',
+        decimals: 6,
+        symbol: 'TIA.n',
+        name: 'TIA.n',
+    },
+    [TokenStandard_1.TokenStandard.CwHypSynthetic]: null,
+    // Fuel
+    [TokenStandard_1.TokenStandard.FuelNative]: null,
+};
+const PROTOCOL_TO_ADDRESS = {
+    [utils_1.ProtocolType.Ethereum]: ethers_1.ethers.constants.AddressZero,
+    [utils_1.ProtocolType.Cosmos]: 'neutron13we0myxwzlpx8l5ark8elw5gj5d59dl6cjkzmt80c5q5cv5rt54qvzkv2a',
+    [utils_1.ProtocolType.Fuel]: '',
+};
+const STANDARD_TO_ADDRESS = {
+    [TokenStandard_1.TokenStandard.SealevelSpl]: 'HVSZJ2juJnMxd6yCNarTL56YmgUqzfUiwM7y7LtTXKHR',
+    [TokenStandard_1.TokenStandard.SealevelSpl2022]: 'EK6cs8jNnu2d9pmKTGf1Bvre9oW2xNhcCKNdLKx6t74w',
+    [TokenStandard_1.TokenStandard.SealevelNative]: 'EK6cs8jNnu2d9pmKTGf1Bvre9oW2xNhcCKNdLKx6t74w',
+    [TokenStandard_1.TokenStandard.CwHypNative]: 'inj1fl48vsnmsdzcv85q5d2q4z5ajdha8yu3lj7tt0',
+};
+describe('Token', () => {
+    it('Handles all standards', async () => {
+        const multiProvider = new MultiProtocolProvider_1.MultiProtocolProvider();
+        for (const tokenArgs of Object.values(STANDARD_TO_TOKEN)) {
+            if (!tokenArgs)
+                continue;
+            console.debug('Testing token standard', tokenArgs.standard);
+            const token = new Token_1.Token(tokenArgs);
+            (0, chai_1.expect)(token.standard).to.eql(tokenArgs.standard);
+            const adapter = token.getAdapter(multiProvider);
+            const adddress = STANDARD_TO_ADDRESS[token.standard] ??
+                PROTOCOL_TO_ADDRESS[token.protocol];
+            if (!adddress)
+                throw new Error(`No address for standard ${tokenArgs.standard}`);
+            const balance = await adapter.getBalance(adddress);
+            (0, chai_1.expect)(typeof balance).to.eql('bigint');
+        }
+    })
+        .timeout(120000)
+        .retries(3);
+    it('Constructs from ChainMetadata', () => {
+        for (const metadata of Object.values(chainMetadata_1.chainMetadata)) {
+            if (!metadata.nativeToken)
+                continue;
+            const token = Token_1.Token.FromChainMetadataNativeToken(metadata);
+            (0, chai_1.expect)(token.symbol).to.eql(metadata.nativeToken.symbol);
+        }
+    });
+});
+//# sourceMappingURL=Token.test.js.map

package/dist/token/Token.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.test.js","sourceRoot":"","sources":["../../src/token/Token.test.ts"],"names":[],"mappings":";;AAAA,+BAA+B;AAC/B,+BAA8B;AAC9B,mCAAgC;AAEhC,gDAA6D;AAE7D,2DAAwD;AACxD,6CAA0C;AAC1C,8EAA2E;AAG3E,mCAAgC;AAChC,mDAAgD;AAEhD,2EAA2E;AAC3E,MAAM,iBAAiB,GAA4C;IACjE,MAAM;IACN,CAAC,6BAAa,CAAC,KAAK,CAAC,EAAE;QACrB,SAAS,EAAE,eAAM,CAAC,QAAQ;QAC1B,QAAQ,EAAE,6BAAa,CAAC,KAAK;QAC7B,cAAc,EAAE,4CAA4C;QAC5D,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,MAAM;KACb;IACD,CAAC,6BAAa,CAAC,MAAM,CAAC,EAAE,IAAI;IAC5B,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAE,aAAK,CAAC,4BAA4B,CAC3D,6BAAa,CAAC,QAAQ,CACvB;IACD,CAAC,6BAAa,CAAC,YAAY,CAAC,EAAE;QAC5B,SAAS,EAAE,eAAM,CAAC,KAAK;QACvB,QAAQ,EAAE,6BAAa,CAAC,YAAY;QACpC,cAAc,EAAE,4CAA4C;QAC5D,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,gBAAgB;KACvB;IACD,CAAC,6BAAa,CAAC,gBAAgB,CAAC,EAAE;QAChC,SAAS,EAAE,eAAM,CAAC,UAAU;QAC5B,QAAQ,EAAE,6BAAa,CAAC,gBAAgB;QACxC,cAAc,EAAE,4CAA4C;QAC5D,wBAAwB,EAAE,4CAA4C;QACtE,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,MAAM;KACb;IACD,CAAC,6BAAa,CAAC,eAAe,CAAC,EAAE;QAC/B,SAAS,EAAE,eAAM,CAAC,KAAK;QACvB,QAAQ,EAAE,6BAAa,CAAC,eAAe;QACvC,cAAc,EAAE,4CAA4C;QAC5D,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,MAAM;KACb;IAED,WAAW;IACX,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAE;QAC3B,SAAS,EAAE,eAAM,CAAC,MAAM;QACxB,QAAQ,EAAE,6BAAa,CAAC,WAAW;QACnC,cAAc,EAAE,6CAA6C;QAC7D,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,KAAK;KACZ;IACD,CAAC,6BAAa,CAAC,eAAe,CAAC,EAAE;QAC/B,SAAS,EAAE,eAAM,CAAC,MAAM;QACxB,QAAQ,EAAE,6BAAa,CAAC,eAAe;QACvC,cAAc,EAAE,8CAA8C;QAC9D,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,aAAa;KACpB;IACD,CAAC,6BAAa,CAAC,cAAc,CAAC,EAAE,aAAK,CAAC,4BAA4B,CAChE,6BAAa,CAAC,MAAM,CACrB;IACD,CAAC,6BAAa,CAAC,iBAAiB,CAAC,EAAE,IAAI;IACvC,CAAC,6BAAa,CAAC,qBAAqB,CAAC,EAAE,IAAI;IAC3C,CAAC,6BAAa,CAAC,oBAAoB,CAAC,EAAE,IAAI;IAE1C,SAAS;IACT,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAE,IAAI;IACjC,CAAC,6BAAa,CAAC,YAAY,CAAC,EAAE,IAAI;IAClC,CAAC,6BAAa,CAAC,YAAY,CAAC,EAAE,aAAK,CAAC,4BAA4B,CAC9D,6BAAa,CAAC,OAAO,CACtB;IACD,CAAC,6BAAa,CAAC,SAAS,CAAC,EAAE;QACzB,SAAS,EAAE,eAAM,CAAC,OAAO;QACzB,QAAQ,EAAE,6BAAa,CAAC,SAAS;QACjC,cAAc,EACZ,sEAAsE;QACxE,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,KAAK;KACZ;IACD,CAAC,6BAAa,CAAC,IAAI,CAAC,EAAE,IAAI;IAC1B,CAAC,6BAAa,CAAC,QAAQ,CAAC,EAAE;QACxB,SAAS,EAAE,eAAM,CAAC,OAAO;QACzB,QAAQ,EAAE,6BAAa,CAAC,QAAQ;QAChC,cAAc,EACZ,sEAAsE;QACxE,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,OAAO;KACd;IACD,CAAC,6BAAa,CAAC,KAAK,CAAC,EAAE,IAAI;IAC3B,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAE;QAC3B,SAAS,EAAE,eAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,6BAAa,CAAC,WAAW;QACnC,cAAc,EAAE,4CAA4C;QAC5D,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,EAAE;QACZ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,gBAAgB;KACvB;IACD,CAAC,6BAAa,CAAC,eAAe,CAAC,EAAE;QAC/B,SAAS,EAAE,eAAM,CAAC,OAAO;QACzB,QAAQ,EAAE,6BAAa,CAAC,eAAe;QACvC,cAAc,EACZ,oEAAoE;QACtE,wBAAwB,EACtB,sEAAsE;QACxE,QAAQ,EAAE,CAAC;QACX,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,OAAO;KACd;IACD,CAAC,6BAAa,CAAC,cAAc,CAAC,EAAE,IAAI;IAEpC,OAAO;IACP,CAAC,6BAAa,CAAC,UAAU,CAAC,EAAE,IAAI;CACjC,CAAC;AAEF,MAAM,mBAAmB,GAA2C;IAClE,CAAC,oBAAY,CAAC,QAAQ,CAAC,EAAE,eAAM,CAAC,SAAS,CAAC,WAAW;IACrD,CAAC,oBAAY,CAAC,MAAM,CAAC,EACnB,oEAAoE;IACtE,CAAC,oBAAY,CAAC,IAAI,CAAC,EAAE,EAAE;CACxB,CAAC;AAEF,MAAM,mBAAmB,GAA4C;IACnE,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAE,8CAA8C;IAC3E,CAAC,6BAAa,CAAC,eAAe,CAAC,EAC7B,8CAA8C;IAChD,CAAC,6BAAa,CAAC,cAAc,CAAC,EAC5B,8CAA8C;IAChD,CAAC,6BAAa,CAAC,WAAW,CAAC,EAAE,4CAA4C;CAC1E,CAAC;AAEF,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACrC,MAAM,aAAa,GAAG,IAAI,6CAAqB,EAAE,CAAC;QAClD,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE;YACxD,IAAI,CAAC,SAAS;gBAAE,SAAS;YACzB,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC5D,MAAM,KAAK,GAAG,IAAI,aAAK,CAAC,SAAS,CAAC,CAAC;YACnC,IAAA,aAAM,EAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAChD,MAAM,QAAQ,GACZ,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC;gBACnC,mBAAmB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACtC,IAAI,CAAC,QAAQ;gBACX,MAAM,IAAI,KAAK,CAAC,2BAA2B,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;YACnE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACnD,IAAA,aAAM,EAAC,OAAO,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SACzC;IACH,CAAC,CAAC;SACC,OAAO,CAAC,MAAO,CAAC;SAChB,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,EAAE;YACnD,IAAI,CAAC,QAAQ,CAAC,WAAW;gBAAE,SAAS;YACpC,MAAM,KAAK,GAAG,aAAK,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YAC3D,IAAA,aAAM,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;SAC1D;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/token/TokenAmount.d.ts

@@ -0,0 +1,12 @@
+import { Numberish } from '@hyperlane-xyz/utils';
+import type { IToken } from './IToken';
+export declare class TokenAmount {
+    readonly token: IToken;
+    readonly amount: bigint;
+    constructor(_amount: Numberish, token: IToken);
+    getDecimalFormattedAmount(): number;
+    plus(amount: Numberish): TokenAmount;
+    minus(amount: Numberish): TokenAmount;
+    equals(tokenAmount: TokenAmount): boolean;
+}
+//# sourceMappingURL=TokenAmount.d.ts.map

package/dist/token/TokenAmount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenAmount.d.ts","sourceRoot":"","sources":["../../src/token/TokenAmount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAW,MAAM,sBAAsB,CAAC;AAE1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,qBAAa,WAAW;aAG0B,KAAK,EAAE,MAAM;IAF7D,SAAgB,MAAM,EAAE,MAAM,CAAC;gBAEnB,OAAO,EAAE,SAAS,EAAkB,KAAK,EAAE,MAAM;IAI7D,yBAAyB,IAAI,MAAM;IAInC,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW;IAIpC,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW;IAIrC,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO;CAK1C"}

package/dist/token/TokenAmount.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenAmount = void 0;
+const utils_1 = require("@hyperlane-xyz/utils");
+class TokenAmount {
+    constructor(_amount, token) {
+        this.token = token;
+        this.amount = BigInt(_amount);
+    }
+    getDecimalFormattedAmount() {
+        return Number((0, utils_1.fromWei)(this.amount.toString(), this.token.decimals));
+    }
+    plus(amount) {
+        return new TokenAmount(this.amount + BigInt(amount), this.token);
+    }
+    minus(amount) {
+        return new TokenAmount(this.amount - BigInt(amount), this.token);
+    }
+    equals(tokenAmount) {
+        return (this.amount === tokenAmount.amount && this.token.equals(tokenAmount.token));
+    }
+}
+exports.TokenAmount = TokenAmount;
+//# sourceMappingURL=TokenAmount.js.map

package/dist/token/TokenAmount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenAmount.js","sourceRoot":"","sources":["../../src/token/TokenAmount.ts"],"names":[],"mappings":";;;AAAA,gDAA0D;AAI1D,MAAa,WAAW;IAGtB,YAAY,OAAkB,EAAkB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;QAC3D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,yBAAyB;QACvB,OAAO,MAAM,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,CAAC,MAAiB;QACpB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,MAAiB;QACrB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,CAAC,WAAwB;QAC7B,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAC3E,CAAC;IACJ,CAAC;CACF;AAxBD,kCAwBC"}

package/dist/token/TokenAmount.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TokenAmount.test.d.ts.map

package/dist/token/TokenAmount.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenAmount.test.d.ts","sourceRoot":"","sources":["../../src/token/TokenAmount.test.ts"],"names":[],"mappings":""}

package/dist/token/TokenAmount.test.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const ethers_1 = require("ethers");
+const chainMetadata_1 = require("../consts/chainMetadata");
+const chains_1 = require("../consts/chains");
+const Token_1 = require("./Token");
+const TokenAmount_1 = require("./TokenAmount");
+const TokenStandard_1 = require("./TokenStandard");
+const token1 = new Token_1.Token({
+    chainName: chains_1.Chains.ethereum,
+    standard: TokenStandard_1.TokenStandard.ERC20,
+    addressOrDenom: ethers_1.ethers.constants.AddressZero,
+    decimals: 4,
+    symbol: 'FAKE',
+    name: 'Fake Token',
+});
+const token2 = Token_1.Token.FromChainMetadataNativeToken(chainMetadata_1.chainMetadata[chains_1.Chains.neutron]);
+describe('TokenAmount', () => {
+    let tokenAmount1;
+    let tokenAmount2;
+    it('Constructs', () => {
+        tokenAmount1 = new TokenAmount_1.TokenAmount(123456789, token1);
+        tokenAmount2 = new TokenAmount_1.TokenAmount('1', token2);
+        (0, chai_1.expect)(!!tokenAmount1).to.eq(true);
+        (0, chai_1.expect)(!!tokenAmount2).to.eq(true);
+    });
+    it('Formats human readable string', () => {
+        (0, chai_1.expect)(tokenAmount1.getDecimalFormattedAmount()).to.eq(12345.6789);
+        (0, chai_1.expect)(tokenAmount2.getDecimalFormattedAmount()).to.eq(0.000001);
+    });
+    it('Does arithmetic', () => {
+        (0, chai_1.expect)(tokenAmount1.plus(1).amount).to.eq(123456790n);
+        (0, chai_1.expect)(tokenAmount2.minus(1).amount).to.eq(0n);
+    });
+    it('Checks equality', () => {
+        (0, chai_1.expect)(tokenAmount1.equals(tokenAmount2)).to.be.false;
+        (0, chai_1.expect)(tokenAmount1.equals(new TokenAmount_1.TokenAmount(123456789n, token1))).to.true;
+    });
+});
+//# sourceMappingURL=TokenAmount.test.js.map

package/dist/token/TokenAmount.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokenAmount.test.js","sourceRoot":"","sources":["../../src/token/TokenAmount.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,mCAAgC;AAEhC,2DAAwD;AACxD,6CAA0C;AAE1C,mCAAgC;AAChC,+CAA4C;AAC5C,mDAAgD;AAEhD,MAAM,MAAM,GAAG,IAAI,aAAK,CAAC;IACvB,SAAS,EAAE,eAAM,CAAC,QAAQ;IAC1B,QAAQ,EAAE,6BAAa,CAAC,KAAK;IAC7B,cAAc,EAAE,eAAM,CAAC,SAAS,CAAC,WAAW;IAC5C,QAAQ,EAAE,CAAC;IACX,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,YAAY;CACnB,CAAC,CAAC;AACH,MAAM,MAAM,GAAG,aAAK,CAAC,4BAA4B,CAC/C,6BAAa,CAAC,eAAM,CAAC,OAAO,CAAC,CAC9B,CAAC;AAEF,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,YAAyB,CAAC;IAC9B,IAAI,YAAyB,CAAC;IAE9B,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;QACpB,YAAY,GAAG,IAAI,yBAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAClD,YAAY,GAAG,IAAI,yBAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAA,aAAM,EAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QACnC,IAAA,aAAM,EAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,IAAA,aAAM,EAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;QACnE,IAAA,aAAM,EAAC,YAAY,CAAC,yBAAyB,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;QACzB,IAAA,aAAM,EAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;QACzB,IAAA,aAAM,EAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QACtD,IAAA,aAAM,EAAC,YAAY,CAAC,MAAM,CAAC,IAAI,yBAAW,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/token/TokenConnection.d.ts

@@ -0,0 +1,87 @@
+import { z } from 'zod';
+import { Address, ProtocolType } from '@hyperlane-xyz/utils';
+import { ChainName } from '../types';
+import type { IToken } from './IToken';
+export declare enum TokenConnectionType {
+    Hyperlane = "hyperlane",
+    Ibc = "ibc",
+    IbcHyperlane = "ibc-hyperlane"
+}
+interface TokenConnectionBase {
+    type?: TokenConnectionType;
+    token: IToken;
+}
+export interface HyperlaneTokenConnection extends TokenConnectionBase {
+    type?: TokenConnectionType.Hyperlane;
+}
+export interface IbcTokenConnection extends TokenConnectionBase {
+    type: TokenConnectionType.Ibc;
+    sourcePort: string;
+    sourceChannel: string;
+}
+export interface IbcToHyperlaneTokenConnection extends TokenConnectionBase {
+    type: TokenConnectionType.IbcHyperlane;
+    sourcePort: string;
+    sourceChannel: string;
+    intermediateChainName: ChainName;
+    intermediateIbcDenom: string;
+    intermediateRouterAddress: Address;
+}
+export type TokenConnection = HyperlaneTokenConnection | IbcTokenConnection | IbcToHyperlaneTokenConnection;
+export declare const TokenConnectionConfigSchema: z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    type: z.ZodOptional<z.ZodLiteral<TokenConnectionType.Hyperlane>>;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    token: string;
+    type?: TokenConnectionType.Hyperlane | undefined;
+}, {
+    token: string;
+    type?: TokenConnectionType.Hyperlane | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<TokenConnectionType.Ibc>;
+    token: z.ZodString;
+    sourcePort: z.ZodString;
+    sourceChannel: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: TokenConnectionType.Ibc;
+    token: string;
+    sourcePort: string;
+    sourceChannel: string;
+}, {
+    type: TokenConnectionType.Ibc;
+    token: string;
+    sourcePort: string;
+    sourceChannel: string;
+}>]>, z.ZodObject<{
+    type: z.ZodLiteral<TokenConnectionType.IbcHyperlane>;
+    token: z.ZodString;
+    sourcePort: z.ZodString;
+    sourceChannel: z.ZodString;
+    intermediateChainName: z.ZodString;
+    intermediateIbcDenom: z.ZodString;
+    intermediateRouterAddress: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: TokenConnectionType.IbcHyperlane;
+    token: string;
+    sourcePort: string;
+    sourceChannel: string;
+    intermediateChainName: string;
+    intermediateIbcDenom: string;
+    intermediateRouterAddress: string;
+}, {
+    type: TokenConnectionType.IbcHyperlane;
+    token: string;
+    sourcePort: string;
+    sourceChannel: string;
+    intermediateChainName: string;
+    intermediateIbcDenom: string;
+    intermediateRouterAddress: string;
+}>]>;
+export declare function getTokenConnectionId(protocol: ProtocolType, chainName: ChainName, address: Address): string;
+export declare function parseTokenConnectionId(data: string): {
+    protocol: ProtocolType;
+    chainName: ChainName;
+    addressOrDenom: Address;
+};
+export {};
+//# sourceMappingURL=TokenConnection.d.ts.map