@hyperlane-xyz/utils 3.10.0 → 3.10.1-beta0

package/README.md

@@ -0,0 +1,20 @@
+# Hyperlane Utils
+
+A collection of various utilities and types for building applications with Hyperlane.
+Typically not used directly but through the [Hyperlane SDK](https://www.npmjs.com/package/@hyperlane-xyz/sdk) instead.
+
+## Install
+
+```bash
+# Install with NPM
+npm install @hyperlane-xyz/utils
+
+# Or with Yarn
+yarn add @hyperlane-xyz/utils
+```
+
+Note, this package uses [ESM Modules](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#pure-esm-package)
+
+## License
+
+Apache 2.0

package/dist/addresses.d.ts

@@ -0,0 +1,42 @@
+import { Address, HexString, ProtocolType } from './types.js';
+export declare function isAddressEvm(address: Address): boolean;
+export declare function isAddressSealevel(address: Address): boolean;
+export declare function isAddressCosmos(address: Address): boolean;
+export declare function getAddressProtocolType(address: Address): ProtocolType.Ethereum | ProtocolType.Sealevel | ProtocolType.Cosmos | undefined;
+export declare function isAddress(address: Address): boolean;
+export declare function isValidAddressEvm(address: Address): boolean;
+export declare function isValidAddressSealevel(address: Address): boolean;
+export declare function isValidAddressCosmos(address: Address): boolean;
+export declare function isValidAddress(address: Address, protocol?: ProtocolType): boolean;
+export declare function normalizeAddressEvm(address: Address): string;
+export declare function normalizeAddressSealevel(address: Address): string;
+export declare function normalizeAddressCosmos(address: Address): string;
+export declare function normalizeAddress(address: Address, protocol?: ProtocolType): string;
+export declare function eqAddressEvm(a1: Address, a2: Address): boolean;
+export declare function eqAddressSol(a1: Address, a2: Address): boolean;
+export declare function eqAddressCosmos(a1: Address, a2: Address): boolean;
+export declare function eqAddress(a1: Address, a2: Address): boolean;
+export declare function isValidTransactionHashEvm(input: string): boolean;
+export declare function isValidTransactionHashSealevel(input: string): boolean;
+export declare function isValidTransactionHashCosmos(input: string): boolean;
+export declare function isValidTransactionHash(input: string, protocol: ProtocolType): boolean;
+export declare function isZeroishAddress(address: Address): boolean;
+export declare function shortenAddress(address: Address, capitalize?: boolean): string;
+export declare function capitalizeAddress(address: Address): string;
+export declare function addressToBytes32Evm(address: Address): string;
+export declare function bytes32ToAddress(bytes32: HexString): Address;
+export declare function addressToBytesEvm(address: Address): Uint8Array;
+export declare function addressToBytesSol(address: Address): Uint8Array;
+export declare function addressToBytesCosmos(address: Address): Uint8Array;
+export declare function addressToBytes(address: Address, protocol?: ProtocolType): Uint8Array;
+export declare function addressToByteHexString(address: string, protocol?: ProtocolType): string;
+export declare function addressToBytes32(address: Address, protocol?: ProtocolType): string;
+export declare function bytesToBytes32(bytes: Uint8Array): string;
+export declare function bytesToAddressEvm(bytes: Uint8Array): Address;
+export declare function bytesToAddressSol(bytes: Uint8Array): Address;
+export declare function bytesToAddressCosmos(bytes: Uint8Array, prefix: string): Address;
+export declare function bytesToProtocolAddress(bytes: Uint8Array, toProtocol: ProtocolType, prefix?: string): string;
+export declare function convertToProtocolAddress(address: string, protocol: ProtocolType, prefix?: string): string;
+export declare function ensure0x(hexstr: string): string;
+export declare function strip0x(hexstr: string): string;
+//# sourceMappingURL=addresses.d.ts.map

package/dist/addresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses.d.ts","sourceRoot":"","sources":["../src/addresses.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AA0B9D,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,WAE5C;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,WAEjD;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,WAM/C;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,mFAWtD;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,WAEzC;AAeD,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,WAQjD;AAGD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,WAOtD;AAGD,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,WAWpD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,YAAY,WAWvE;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,UAOnD;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,OAAO,UAOxD;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,UAOtD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,YAAY,UAWzE;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,WAEpD;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,WAEpD;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,WAEvD;AAED,wBAAgB,SAAS,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,WAcjD;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,WAEtD;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,MAAM,WAE3D;AAED,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,MAAM,WAEzD;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,WAU3E;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,WAMhD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,UASpE;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,UAIjD;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAI5D;AAGD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAE5D;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAG9D;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAE9D;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAEjE;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,YAAY,GACtB,UAAU,CAgBZ;AAED,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,YAAY,UAKxB;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,YAAY,GACtB,MAAM,CAOR;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CASxD;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE5D;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE5D;AAED,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CAGT;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,YAAY,EACxB,MAAM,CAAC,EAAE,MAAM,UAehB;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,YAAY,EACtB,MAAM,CAAC,EAAE,MAAM,UAQhB;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,UAEtC;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,UAErC"}

package/dist/addresses.js

@@ -0,0 +1,292 @@
+import { fromBech32, normalizeBech32, toBech32 } from '@cosmjs/encoding';
+import { PublicKey } from '@solana/web3.js';
+import { utils as ethersUtils } from 'ethers';
+import { isNullish } from './typeof.js';
+import { ProtocolType } from './types.js';
+import { assert } from './validation.js';
+const EVM_ADDRESS_REGEX = /^0x[a-fA-F0-9]{40}$/;
+const SEALEVEL_ADDRESS_REGEX = /^[a-zA-Z0-9]{36,44}$/;
+const HEX_BYTES32_REGEX = /^0x[a-fA-F0-9]{64}$/;
+// https://github.com/cosmos/cosmos-sdk/blob/84c33215658131d87daf3c629e909e12ed9370fa/types/coin.go#L601C17-L601C44
+const COSMOS_DENOM_PATTERN = `[a-zA-Z][a-zA-Z0-9]{2,127}`;
+// https://en.bitcoin.it/wiki/BIP_0173
+const BECH32_ADDRESS_PATTERN = `[a-zA-Z]{1,83}1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{38,58}`;
+const COSMOS_ADDRESS_REGEX = new RegExp(`^${BECH32_ADDRESS_PATTERN}$`);
+const IBC_DENOM_REGEX = new RegExp(`^ibc/([A-Fa-f0-9]{64})$`);
+const COSMOS_FACTORY_TOKEN_REGEX = new RegExp(`^factory/(${BECH32_ADDRESS_PATTERN})/${COSMOS_DENOM_PATTERN}$`);
+const EVM_TX_HASH_REGEX = /^0x([A-Fa-f0-9]{64})$/;
+const SEALEVEL_TX_HASH_REGEX = /^[a-zA-Z1-9]{88}$/;
+const COSMOS_TX_HASH_REGEX = /^(0x)?[A-Fa-f0-9]{64}$/;
+const EVM_ZEROISH_ADDRESS_REGEX = /^(0x)?0*$/;
+const SEALEVEL_ZEROISH_ADDRESS_REGEX = /^1+$/;
+const COSMOS_ZEROISH_ADDRESS_REGEX = /^[a-z]{1,10}?1[0]+$/;
+export function isAddressEvm(address) {
+    return EVM_ADDRESS_REGEX.test(address);
+}
+export function isAddressSealevel(address) {
+    return SEALEVEL_ADDRESS_REGEX.test(address);
+}
+export function isAddressCosmos(address) {
+    return (COSMOS_ADDRESS_REGEX.test(address) ||
+        IBC_DENOM_REGEX.test(address) ||
+        COSMOS_FACTORY_TOKEN_REGEX.test(address));
+}
+export function getAddressProtocolType(address) {
+    if (!address)
+        return undefined;
+    if (isAddressEvm(address)) {
+        return ProtocolType.Ethereum;
+    }
+    else if (isAddressCosmos(address)) {
+        return ProtocolType.Cosmos;
+    }
+    else if (isAddressSealevel(address)) {
+        return ProtocolType.Sealevel;
+    }
+    else {
+        return undefined;
+    }
+}
+export function isAddress(address) {
+    return !!getAddressProtocolType(address);
+}
+function routeAddressUtil(fns, param, fallback, protocol) {
+    protocol ||= getAddressProtocolType(param);
+    if (protocol && fns[protocol])
+        return fns[protocol](param);
+    else if (!isNullish(fallback))
+        return fallback;
+    else
+        throw new Error(`Unsupported protocol ${protocol}`);
+}
+// Slower than isAddressEvm above but actually validates content and checksum
+export function isValidAddressEvm(address) {
+    // Need to catch because ethers' isAddress throws in some cases (bad checksum)
+    try {
+        const isValid = address && ethersUtils.isAddress(address);
+        return !!isValid;
+    }
+    catch (error) {
+        return false;
+    }
+}
+// Slower than isAddressSealevel above but actually validates content and checksum
+export function isValidAddressSealevel(address) {
+    try {
+        const isValid = address && new PublicKey(address).toBase58();
+        return !!isValid;
+    }
+    catch (error) {
+        return false;
+    }
+}
+// Slower than isAddressCosmos above but actually validates content and checksum
+export function isValidAddressCosmos(address) {
+    try {
+        const isValid = address &&
+            (IBC_DENOM_REGEX.test(address) ||
+                COSMOS_FACTORY_TOKEN_REGEX.test(address) ||
+                fromBech32(address));
+        return !!isValid;
+    }
+    catch (error) {
+        return false;
+    }
+}
+export function isValidAddress(address, protocol) {
+    return routeAddressUtil({
+        [ProtocolType.Ethereum]: isValidAddressEvm,
+        [ProtocolType.Sealevel]: isValidAddressSealevel,
+        [ProtocolType.Cosmos]: isValidAddressCosmos,
+    }, address, false, protocol);
+}
+export function normalizeAddressEvm(address) {
+    if (isZeroishAddress(address))
+        return address;
+    try {
+        return ethersUtils.getAddress(address);
+    }
+    catch (error) {
+        return address;
+    }
+}
+export function normalizeAddressSealevel(address) {
+    if (isZeroishAddress(address))
+        return address;
+    try {
+        return new PublicKey(address).toBase58();
+    }
+    catch (error) {
+        return address;
+    }
+}
+export function normalizeAddressCosmos(address) {
+    if (isZeroishAddress(address))
+        return address;
+    try {
+        return normalizeBech32(address);
+    }
+    catch (error) {
+        return address;
+    }
+}
+export function normalizeAddress(address, protocol) {
+    return routeAddressUtil({
+        [ProtocolType.Ethereum]: normalizeAddressEvm,
+        [ProtocolType.Sealevel]: normalizeAddressSealevel,
+        [ProtocolType.Cosmos]: normalizeAddressCosmos,
+    }, address, address, protocol);
+}
+export function eqAddressEvm(a1, a2) {
+    return normalizeAddressEvm(a1) === normalizeAddressEvm(a2);
+}
+export function eqAddressSol(a1, a2) {
+    return normalizeAddressSealevel(a1) === normalizeAddressSealevel(a2);
+}
+export function eqAddressCosmos(a1, a2) {
+    return normalizeAddressCosmos(a1) === normalizeAddressCosmos(a2);
+}
+export function eqAddress(a1, a2) {
+    const p1 = getAddressProtocolType(a1);
+    const p2 = getAddressProtocolType(a2);
+    if (p1 !== p2)
+        return false;
+    return routeAddressUtil({
+        [ProtocolType.Ethereum]: (_a1) => eqAddressEvm(_a1, a2),
+        [ProtocolType.Sealevel]: (_a1) => eqAddressSol(_a1, a2),
+        [ProtocolType.Cosmos]: (_a1) => eqAddressCosmos(_a1, a2),
+    }, a1, false, p1);
+}
+export function isValidTransactionHashEvm(input) {
+    return EVM_TX_HASH_REGEX.test(input);
+}
+export function isValidTransactionHashSealevel(input) {
+    return SEALEVEL_TX_HASH_REGEX.test(input);
+}
+export function isValidTransactionHashCosmos(input) {
+    return COSMOS_TX_HASH_REGEX.test(input);
+}
+export function isValidTransactionHash(input, protocol) {
+    if (protocol === ProtocolType.Ethereum) {
+        return isValidTransactionHashEvm(input);
+    }
+    else if (protocol === ProtocolType.Sealevel) {
+        return isValidTransactionHashSealevel(input);
+    }
+    else if (protocol === ProtocolType.Cosmos) {
+        return isValidTransactionHashCosmos(input);
+    }
+    else {
+        return false;
+    }
+}
+export function isZeroishAddress(address) {
+    return (EVM_ZEROISH_ADDRESS_REGEX.test(address) ||
+        SEALEVEL_ZEROISH_ADDRESS_REGEX.test(address) ||
+        COSMOS_ZEROISH_ADDRESS_REGEX.test(address));
+}
+export function shortenAddress(address, capitalize) {
+    if (!address)
+        return '';
+    if (address.length < 8)
+        return address;
+    const normalized = normalizeAddress(address);
+    const shortened = normalized.substring(0, 5) +
+        '...' +
+        normalized.substring(normalized.length - 4);
+    return capitalize ? capitalizeAddress(shortened) : shortened;
+}
+export function capitalizeAddress(address) {
+    if (address.startsWith('0x'))
+        return '0x' + address.substring(2).toUpperCase();
+    else
+        return address.toUpperCase();
+}
+export function addressToBytes32Evm(address) {
+    return ethersUtils
+        .hexZeroPad(ethersUtils.hexStripZeros(address), 32)
+        .toLowerCase();
+}
+// For EVM addresses only, kept for backwards compatibility and convenience
+export function bytes32ToAddress(bytes32) {
+    return ethersUtils.getAddress(bytes32.slice(-40));
+}
+export function addressToBytesEvm(address) {
+    const addrBytes32 = addressToBytes32Evm(address);
+    return Buffer.from(strip0x(addrBytes32), 'hex');
+}
+export function addressToBytesSol(address) {
+    return new PublicKey(address).toBytes();
+}
+export function addressToBytesCosmos(address) {
+    return fromBech32(address).data;
+}
+export function addressToBytes(address, protocol) {
+    const bytes = routeAddressUtil({
+        [ProtocolType.Ethereum]: addressToBytesEvm,
+        [ProtocolType.Sealevel]: addressToBytesSol,
+        [ProtocolType.Cosmos]: addressToBytesCosmos,
+    }, address, new Uint8Array(), protocol);
+    assert(bytes.length && !bytes.every((b) => b == 0), 'address bytes must not be empty');
+    return bytes;
+}
+export function addressToByteHexString(address, protocol) {
+    return ensure0x(Buffer.from(addressToBytes(address, protocol)).toString('hex'));
+}
+export function addressToBytes32(address, protocol) {
+    // If the address is already bytes32, just return, avoiding a regression
+    // where an already bytes32 address cannot be categorized as a protocol address.
+    if (HEX_BYTES32_REGEX.test(ensure0x(address)))
+        return ensure0x(address);
+    const bytes = addressToBytes(address, protocol);
+    return bytesToBytes32(bytes);
+}
+export function bytesToBytes32(bytes) {
+    if (bytes.length > 32) {
+        throw new Error('bytes must be 32 bytes or less');
+    }
+    // This 0x-prefixes the hex string
+    return ethersUtils.hexZeroPad(ensure0x(Buffer.from(bytes).toString('hex')), 32);
+}
+export function bytesToAddressEvm(bytes) {
+    return bytes32ToAddress(Buffer.from(bytes).toString('hex'));
+}
+export function bytesToAddressSol(bytes) {
+    return new PublicKey(bytes).toBase58();
+}
+export function bytesToAddressCosmos(bytes, prefix) {
+    if (!prefix)
+        throw new Error('Prefix required for Cosmos address');
+    return toBech32(prefix, bytes);
+}
+export function bytesToProtocolAddress(bytes, toProtocol, prefix) {
+    assert(bytes.length && !bytes.every((b) => b == 0), 'address bytes must not be empty');
+    if (toProtocol === ProtocolType.Ethereum) {
+        return bytesToAddressEvm(bytes);
+    }
+    else if (toProtocol === ProtocolType.Sealevel) {
+        return bytesToAddressSol(bytes);
+    }
+    else if (toProtocol === ProtocolType.Cosmos) {
+        return bytesToAddressCosmos(bytes, prefix);
+    }
+    else {
+        throw new Error(`Unsupported protocol for address ${toProtocol}`);
+    }
+}
+export function convertToProtocolAddress(address, protocol, prefix) {
+    const currentProtocol = getAddressProtocolType(address);
+    if (!currentProtocol)
+        throw new Error(`Unknown address protocol for ${address}`);
+    if (currentProtocol === protocol)
+        return address;
+    const addressBytes = addressToBytes(address, currentProtocol);
+    return bytesToProtocolAddress(addressBytes, protocol, prefix);
+}
+export function ensure0x(hexstr) {
+    return hexstr.startsWith('0x') ? hexstr : `0x${hexstr}`;
+}
+export function strip0x(hexstr) {
+    return hexstr.startsWith('0x') ? hexstr.slice(2) : hexstr;
+}
+//# sourceMappingURL=addresses.js.map

package/dist/addresses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses.js","sourceRoot":"","sources":["../src/addresses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAsB,YAAY,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAChD,MAAM,sBAAsB,GAAG,sBAAsB,CAAC;AAEtD,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAEhD,mHAAmH;AACnH,MAAM,oBAAoB,GAAG,4BAA4B,CAAC;AAC1D,sCAAsC;AACtC,MAAM,sBAAsB,GAAG,0DAA0D,CAAC;AAC1F,MAAM,oBAAoB,GAAG,IAAI,MAAM,CAAC,IAAI,sBAAsB,GAAG,CAAC,CAAC;AACvE,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC,yBAAyB,CAAC,CAAC;AAC9D,MAAM,0BAA0B,GAAG,IAAI,MAAM,CAC3C,aAAa,sBAAsB,KAAK,oBAAoB,GAAG,CAChE,CAAC;AAEF,MAAM,iBAAiB,GAAG,uBAAuB,CAAC;AAClD,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AACnD,MAAM,oBAAoB,GAAG,wBAAwB,CAAC;AAEtD,MAAM,yBAAyB,GAAG,WAAW,CAAC;AAC9C,MAAM,8BAA8B,GAAG,MAAM,CAAC;AAC9C,MAAM,4BAA4B,GAAG,qBAAqB,CAAC;AAE3D,MAAM,UAAU,YAAY,CAAC,OAAgB;IAC3C,OAAO,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,OAAO,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAgB;IAC9C,OAAO,CACL,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC;QAClC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;QAC7B,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,CACzC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,OAAgB;IACrD,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,OAAO,YAAY,CAAC,QAAQ,CAAC;IAC/B,CAAC;SAAM,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,YAAY,CAAC,MAAM,CAAC;IAC7B,CAAC;SAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,YAAY,CAAC,QAAQ,CAAC;IAC/B,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAgB;IACxC,OAAO,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,gBAAgB,CACvB,GAAwD,EACxD,KAAa,EACb,QAAY,EACZ,QAAuB;IAEvB,QAAQ,KAAK,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,IAAI,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC;QAAE,OAAO,GAAG,CAAC,QAAQ,CAAE,CAAC,KAAK,CAAC,CAAC;SACvD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;;QAC1C,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,8EAA8E;IAC9E,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,OAAO,IAAI,WAAW,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1D,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,sBAAsB,CAAC,OAAgB;IACrD,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,OAAO,IAAI,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC7D,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,oBAAoB,CAAC,OAAgB;IACnD,IAAI,CAAC;QACH,MAAM,OAAO,GACX,OAAO;YACP,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;gBAC5B,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC;gBACxC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QACzB,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAgB,EAAE,QAAuB;IACtE,OAAO,gBAAgB,CACrB;QACE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,iBAAiB;QAC1C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,sBAAsB;QAC/C,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,oBAAoB;KAC5C,EACD,OAAO,EACP,KAAK,EACL,QAAQ,CACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IAClD,IAAI,gBAAgB,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC9C,IAAI,CAAC;QACH,OAAO,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAgB;IACvD,IAAI,gBAAgB,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC9C,IAAI,CAAC;QACH,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,OAAgB;IACrD,IAAI,gBAAgB,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC9C,IAAI,CAAC;QACH,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAgB,EAAE,QAAuB;IACxE,OAAO,gBAAgB,CACrB;QACE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,mBAAmB;QAC5C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,wBAAwB;QACjD,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,sBAAsB;KAC9C,EACD,OAAO,EACP,OAAO,EACP,QAAQ,CACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,EAAW,EAAE,EAAW;IACnD,OAAO,mBAAmB,CAAC,EAAE,CAAC,KAAK,mBAAmB,CAAC,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,EAAW,EAAE,EAAW;IACnD,OAAO,wBAAwB,CAAC,EAAE,CAAC,KAAK,wBAAwB,CAAC,EAAE,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,EAAW,EAAE,EAAW;IACtD,OAAO,sBAAsB,CAAC,EAAE,CAAC,KAAK,sBAAsB,CAAC,EAAE,CAAC,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,EAAW,EAAE,EAAW;IAChD,MAAM,EAAE,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC;IACtC,MAAM,EAAE,GAAG,sBAAsB,CAAC,EAAE,CAAC,CAAC;IACtC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAC5B,OAAO,gBAAgB,CACrB;QACE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC;QACvD,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,CAAC;QACvD,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,CAAC;KACzD,EACD,EAAE,EACF,KAAK,EACL,EAAE,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACrD,OAAO,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,KAAa;IAC1D,OAAO,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,OAAO,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAa,EAAE,QAAsB;IAC1E,IAAI,QAAQ,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;QACvC,OAAO,yBAAyB,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;SAAM,IAAI,QAAQ,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC9C,OAAO,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;SAAM,IAAI,QAAQ,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;QAC5C,OAAO,4BAA4B,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,OAAO,CACL,yBAAyB,CAAC,IAAI,CAAC,OAAO,CAAC;QACvC,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC;QAC5C,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,CAC3C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAgB,EAAE,UAAoB;IACnE,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,OAAO,CAAC;IACvC,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,SAAS,GACb,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1B,KAAK;QACL,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9C,OAAO,UAAU,CAAC,CAAC,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;QAC1B,OAAO,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;;QAC9C,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IAClD,OAAO,WAAW;SACf,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;SAClD,WAAW,EAAE,CAAC;AACnB,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,gBAAgB,CAAC,OAAkB;IACjD,OAAO,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,MAAM,WAAW,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAgB;IAChD,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAgB;IACnD,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,OAAgB,EAChB,QAAuB;IAEvB,MAAM,KAAK,GAAG,gBAAgB,CAC5B;QACE,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,iBAAiB;QAC1C,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,iBAAiB;QAC1C,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,oBAAoB;KAC5C,EACD,OAAO,EACP,IAAI,UAAU,EAAE,EAChB,QAAQ,CACT,CAAC;IACF,MAAM,CACJ,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAC3C,iCAAiC,CAClC,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,OAAe,EACf,QAAuB;IAEvB,OAAO,QAAQ,CACb,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAC/D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,OAAgB,EAChB,QAAuB;IAEvB,wEAAwE;IACxE,gFAAgF;IAChF,IAAI,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAAE,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAChD,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAiB;IAC9C,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IACD,kCAAkC;IAClC,OAAO,WAAW,CAAC,UAAU,CAC3B,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAC5C,EAAE,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAiB;IACjD,OAAO,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAiB;IACjD,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,KAAiB,EACjB,MAAc;IAEd,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACnE,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,KAAiB,EACjB,UAAwB,EACxB,MAAe;IAEf,MAAM,CACJ,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAC3C,iCAAiC,CAClC,CAAC;IACF,IAAI,UAAU,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;QACzC,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,UAAU,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;QAChD,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;SAAM,IAAI,UAAU,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;QAC9C,OAAO,oBAAoB,CAAC,KAAK,EAAE,MAAO,CAAC,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,QAAsB,EACtB,MAAe;IAEf,MAAM,eAAe,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,CAAC,eAAe;QAClB,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,EAAE,CAAC,CAAC;IAC7D,IAAI,eAAe,KAAK,QAAQ;QAAE,OAAO,OAAO,CAAC;IACjD,MAAM,YAAY,GAAG,cAAc,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC9D,OAAO,sBAAsB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc;IACrC,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,MAAc;IACpC,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAC5D,CAAC"}

package/dist/addresses.test.d.ts

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

package/dist/addresses.test.d.ts.map

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

package/dist/addresses.test.js

@@ -0,0 +1,44 @@
+import { expect } from 'chai';
+import { addressToBytes, bytesToProtocolAddress, isZeroishAddress, } from './addresses.js';
+import { ProtocolType } from './types.js';
+const ETH_ZERO_ADDR = '0x0000000000000000000000000000000000000000';
+const ETH_NON_ZERO_ADDR = '0x0000000000000000000000000000000000000001';
+const COS_ZERO_ADDR = 'cosmos1000';
+const COS_NON_ZERO_ADDR = 'neutron1jyyjd3x0jhgswgm6nnctxvzla8ypx50tew3ayxxwkrjfxhvje6kqzvzudq';
+const SOL_ZERO_ADDR = '111111';
+const SOL_NON_ZERO_ADDR = 'TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb';
+// TODO increase address utility test coverage
+describe('Address utilities', () => {
+    describe('isZeroishAddress', () => {
+        it('Identifies 0-ish addresses', () => {
+            expect(isZeroishAddress('0x')).to.be.true;
+            expect(isZeroishAddress(ETH_ZERO_ADDR)).to.be.true;
+            expect(isZeroishAddress(COS_ZERO_ADDR)).to.be.true;
+            expect(isZeroishAddress(SOL_ZERO_ADDR)).to.be.true;
+        });
+        it('Identifies non-0-ish addresses', () => {
+            expect(isZeroishAddress(ETH_NON_ZERO_ADDR)).to.be.false;
+            expect(isZeroishAddress(COS_NON_ZERO_ADDR)).to.be.false;
+            expect(isZeroishAddress(SOL_NON_ZERO_ADDR)).to.be.false;
+        });
+    });
+    describe('addressToBytes', () => {
+        it('Converts addresses to bytes', () => {
+            expect(addressToBytes(ETH_NON_ZERO_ADDR).length).to.equal(32);
+        });
+        it('Rejects zeroish addresses', () => {
+            expect(() => addressToBytes(ETH_ZERO_ADDR)).to.throw(Error);
+            expect(() => addressToBytes(COS_ZERO_ADDR)).to.throw(Error);
+            expect(() => addressToBytes(SOL_ZERO_ADDR)).to.throw(Error);
+        });
+    });
+    describe('bytesToProtocolAddress', () => {
+        it('Converts bytes to address', () => {
+            expect(bytesToProtocolAddress(addressToBytes(ETH_NON_ZERO_ADDR), ProtocolType.Ethereum)).to.equal(ETH_NON_ZERO_ADDR);
+        });
+        it('Rejects zeroish addresses', () => {
+            expect(() => bytesToProtocolAddress(new Uint8Array([0, 0, 0]), ProtocolType.Ethereum)).to.throw(Error);
+        });
+    });
+});
+//# sourceMappingURL=addresses.test.js.map

package/dist/addresses.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses.test.js","sourceRoot":"","sources":["../src/addresses.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,aAAa,GAAG,4CAA4C,CAAC;AACnE,MAAM,iBAAiB,GAAG,4CAA4C,CAAC;AACvE,MAAM,aAAa,GAAG,YAAY,CAAC;AACnC,MAAM,iBAAiB,GACrB,oEAAoE,CAAC;AACvE,MAAM,aAAa,GAAG,QAAQ,CAAC;AAC/B,MAAM,iBAAiB,GAAG,6CAA6C,CAAC;AAExE,8CAA8C;AAC9C,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC1C,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACnD,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACnD,MAAM,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACxD,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACxD,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CACJ,sBAAsB,CACpB,cAAc,CAAC,iBAAiB,CAAC,EACjC,YAAY,CAAC,QAAQ,CACtB,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,GAAG,EAAE,CACV,sBAAsB,CACpB,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EACzB,YAAY,CAAC,QAAQ,CACtB,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/amount.d.ts

@@ -0,0 +1,45 @@
+import { BigNumber } from 'bignumber.js';
+/**
+ * Convert the given Wei value to Ether value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export declare function fromWei(value: BigNumber.Value | null | undefined, decimals?: number): string;
+/**
+ * Convert the given Wei value to Ether value,
+ * round to set number of decimals with a minimum floor, configured per token
+ * @param value The value to convert.
+ * @param decimals
+ * @returns Converted value in string type.
+ */
+export declare function fromWeiRounded(value: BigNumber.Value | null | undefined, decimals?: number, displayDecimals?: number): string;
+/**
+ * Convert the given value to Wei value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export declare function toWei(value: BigNumber.Value | null | undefined, decimals?: number): string;
+/**
+ * Try to parse the given value into BigNumber.js BigNumber
+ * @param value The value to parse.
+ * @returns Parsed value in BigNumber.js BigNumber type.
+ */
+export declare function tryParseAmount(value: BigNumber.Value | null | undefined): BigNumber | null;
+/**
+ * Checks if an amount is equal of nearly equal to balance within a small margin of error
+ * Necessary because amounts in the UI are often rounded
+ * @param amount1 The amount to compare.
+ * @param amount2 The amount to compare.
+ * @returns true/false.
+ */
+export declare function eqAmountApproximate(amount1: BigNumber.Value, amount2: BigNumber.Value, maxDifference: BigNumber.Value): boolean;
+/**
+ * Converts a value with `fromDecimals` decimals to a value with `toDecimals` decimals.
+ * Incurs a loss of precision when `fromDecimals` > `toDecimals`.
+ * @param fromDecimals The number of decimals `value` has.
+ * @param toDecimals The number of decimals to convert `value` to.
+ * @param value The value to convert.
+ * @returns `value` represented with `toDecimals` decimals in string type.
+ */
+export declare function convertDecimals(fromDecimals: number, toDecimals: number, value: BigNumber.Value): string;
+//# sourceMappingURL=amount.d.ts.map

package/dist/amount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../src/amount.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAKzC;;;;GAIG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,SAAyB,GAChC,MAAM,CAKR;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,SAAyB,EACjC,eAAe,CAAC,EAAE,MAAM,GACvB,MAAM,CAOR;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CACnB,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,SAAyB,GAChC,MAAM,CAmBR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,SAAS,CAAC,KAAK,GAAG,IAAI,GAAG,SAAS,GACxC,SAAS,GAAG,IAAI,CASlB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,SAAS,CAAC,KAAK,EACxB,OAAO,EAAE,SAAS,CAAC,KAAK,EACxB,aAAa,EAAE,SAAS,CAAC,KAAK,GAC7B,OAAO,CAGT;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,CAAC,KAAK,GACrB,MAAM,CAgBR"}

package/dist/amount.js

@@ -0,0 +1,114 @@
+import { formatUnits, parseUnits } from '@ethersproject/units';
+import { BigNumber } from 'bignumber.js';
+const DEFAULT_DISPLAY_DECIMALS = 4;
+const DEFAULT_TOKEN_DECIMALS = 18;
+/**
+ * Convert the given Wei value to Ether value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export function fromWei(value, decimals = DEFAULT_TOKEN_DECIMALS) {
+    if (!value)
+        return (0).toString();
+    const valueString = value.toString(10).trim();
+    const flooredValue = BigNumber(valueString).toFixed(0, BigNumber.ROUND_FLOOR);
+    return parseFloat(formatUnits(flooredValue, decimals)).toString();
+}
+/**
+ * Convert the given Wei value to Ether value,
+ * round to set number of decimals with a minimum floor, configured per token
+ * @param value The value to convert.
+ * @param decimals
+ * @returns Converted value in string type.
+ */
+export function fromWeiRounded(value, decimals = DEFAULT_TOKEN_DECIMALS, displayDecimals) {
+    if (!value)
+        return '0';
+    const flooredValue = BigNumber(value).toFixed(0, BigNumber.ROUND_FLOOR);
+    const amount = BigNumber(formatUnits(flooredValue, decimals));
+    if (amount.isZero())
+        return '0';
+    displayDecimals ??= amount.gte(10000) ? 2 : DEFAULT_DISPLAY_DECIMALS;
+    return amount.toFixed(displayDecimals, BigNumber.ROUND_FLOOR);
+}
+/**
+ * Convert the given value to Wei value
+ * @param value The value to convert.
+ * @returns Converted value in string type.
+ */
+export function toWei(value, decimals = DEFAULT_TOKEN_DECIMALS) {
+    if (!value)
+        return BigNumber(0).toString();
+    // First convert to a BigNumber, and then call `toString` with the
+    // explicit radix 10 such that the result is formatted as a base-10 string
+    // and not in scientific notation.
+    const valueBN = BigNumber(value);
+    const valueString = valueBN.toString(10).trim();
+    const components = valueString.split('.');
+    if (components.length === 1) {
+        return parseUnits(valueString, decimals).toString();
+    }
+    else if (components.length === 2) {
+        const trimmedFraction = components[1].substring(0, decimals);
+        return parseUnits(`${components[0]}.${trimmedFraction}`, decimals).toString();
+    }
+    else {
+        throw new Error(`Cannot convert ${valueString} to wei`);
+    }
+}
+/**
+ * Try to parse the given value into BigNumber.js BigNumber
+ * @param value The value to parse.
+ * @returns Parsed value in BigNumber.js BigNumber type.
+ */
+export function tryParseAmount(value) {
+    try {
+        if (!value)
+            return null;
+        const parsed = BigNumber(value);
+        if (!parsed || parsed.isNaN() || !parsed.isFinite())
+            return null;
+        else
+            return parsed;
+    }
+    catch (error) {
+        return null;
+    }
+}
+/**
+ * Checks if an amount is equal of nearly equal to balance within a small margin of error
+ * Necessary because amounts in the UI are often rounded
+ * @param amount1 The amount to compare.
+ * @param amount2 The amount to compare.
+ * @returns true/false.
+ */
+export function eqAmountApproximate(amount1, amount2, maxDifference) {
+    // Is difference btwn amounts less than maxDifference
+    return BigNumber(amount1).minus(amount2).abs().lte(maxDifference);
+}
+/**
+ * Converts a value with `fromDecimals` decimals to a value with `toDecimals` decimals.
+ * Incurs a loss of precision when `fromDecimals` > `toDecimals`.
+ * @param fromDecimals The number of decimals `value` has.
+ * @param toDecimals The number of decimals to convert `value` to.
+ * @param value The value to convert.
+ * @returns `value` represented with `toDecimals` decimals in string type.
+ */
+export function convertDecimals(fromDecimals, toDecimals, value) {
+    const amount = BigNumber(value);
+    if (fromDecimals === toDecimals)
+        return amount.toString(10);
+    else if (fromDecimals > toDecimals) {
+        const difference = fromDecimals - toDecimals;
+        return amount
+            .div(BigNumber(10).pow(difference))
+            .integerValue(BigNumber.ROUND_FLOOR)
+            .toString(10);
+    }
+    // fromDecimals < toDecimals
+    else {
+        const difference = toDecimals - fromDecimals;
+        return amount.times(BigNumber(10).pow(difference)).toString(10);
+    }
+}
+//# sourceMappingURL=amount.js.map

package/dist/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../src/amount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AACnC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC;;;;GAIG;AACH,MAAM,UAAU,OAAO,CACrB,KAAyC,EACzC,QAAQ,GAAG,sBAAsB;IAEjC,IAAI,CAAC,KAAK;QAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9C,MAAM,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IAC9E,OAAO,UAAU,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAyC,EACzC,QAAQ,GAAG,sBAAsB,EACjC,eAAwB;IAExB,IAAI,CAAC,KAAK;QAAE,OAAO,GAAG,CAAC;IACvB,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9D,IAAI,MAAM,CAAC,MAAM,EAAE;QAAE,OAAO,GAAG,CAAC;IAChC,eAAe,KAAK,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC;IACrE,OAAO,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,KAAK,CACnB,KAAyC,EACzC,QAAQ,GAAG,sBAAsB;IAEjC,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3C,kEAAkE;IAClE,0EAA0E;IAC1E,kCAAkC;IAClC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAChD,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,UAAU,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IACtD,CAAC;SAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,eAAe,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC7D,OAAO,UAAU,CACf,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,EACrC,QAAQ,CACT,CAAC,QAAQ,EAAE,CAAC;IACf,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,kBAAkB,WAAW,SAAS,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAyC;IAEzC,IAAI,CAAC;QACH,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YAAE,OAAO,IAAI,CAAC;;YAC5D,OAAO,MAAM,CAAC;IACrB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAwB,EACxB,OAAwB,EACxB,aAA8B;IAE9B,qDAAqD;IACrD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,YAAoB,EACpB,UAAkB,EAClB,KAAsB;IAEtB,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAEhC,IAAI,YAAY,KAAK,UAAU;QAAE,OAAO,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SACvD,IAAI,YAAY,GAAG,UAAU,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,YAAY,GAAG,UAAU,CAAC;QAC7C,OAAO,MAAM;aACV,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;aAClC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC;aACnC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IACD,4BAA4B;SACvB,CAAC;QACJ,MAAM,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;QAC7C,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC"}

package/dist/amount.test.d.ts

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

package/dist/amount.test.d.ts.map

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