@layerzerolabs/static-chain-info 0.0.8

package/dist/staticChainInfo.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+var VK5U52R7_cjs = require('./VK5U52R7.cjs');
+
+
+
+Object.defineProperty(exports, "ChainSubType", {
+  enumerable: true,
+  get: function () { return VK5U52R7_cjs.ChainSubType; }
+});
+Object.defineProperty(exports, "isZkChain", {
+  enumerable: true,
+  get: function () { return VK5U52R7_cjs.isZkChain; }
+});
+Object.defineProperty(exports, "staticConfig", {
+  enumerable: true,
+  get: function () { return VK5U52R7_cjs.staticConfig; }
+});
+//# sourceMappingURL=staticChainInfo.cjs.map
+//# sourceMappingURL=staticChainInfo.cjs.map

package/dist/staticChainInfo.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"staticChainInfo.cjs"}

package/dist/staticChainInfo.d.ts

@@ -0,0 +1,22 @@
+import { ChainName } from '@layerzerolabs/layerzero-definitions';
+export declare enum ChainSubType {
+    ARBSTACK = 0,
+    OPSTACK = 1,
+    AVALANCHE = 2,
+    TRON = 3
+}
+export interface StaticInfoForChain {
+    chainSubType?: ChainSubType;
+    addressSizeInBytes: number;
+    decimals: number;
+    mptBaseGas?: number;
+    fpBaseGas: number;
+    symbol: string;
+    chainLayer?: number;
+}
+export interface StaticConfig {
+    [baseName: string]: StaticInfoForChain;
+}
+export declare const staticConfig: StaticConfig;
+export declare const isZkChain: (chainName: ChainName) => boolean;
+//# sourceMappingURL=staticChainInfo.d.ts.map

package/dist/staticChainInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticChainInfo.d.ts","sourceRoot":"","sources":["../src/staticChainInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAC;AAEjE,oBAAY,YAAY;IACpB,QAAQ,IAAA;IACR,OAAO,IAAA;IACP,SAAS,IAAA;IACT,IAAI,IAAA;CACP;AAED,MAAM,WAAW,kBAAkB;IAC/B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IACzB,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,CAAC;CAC1C;AAWD,eAAO,MAAM,YAAY,EAAE,YAkiD1B,CAAC;AAEF,eAAO,MAAM,SAAS,GAAI,WAAW,SAAS,KAAG,OAWhD,CAAC"}

package/dist/staticChainInfo.js

@@ -0,0 +1,3 @@
+export { ChainSubType, isZkChain, staticConfig } from './FJ5AKDP4.js';
+//# sourceMappingURL=staticChainInfo.js.map
+//# sourceMappingURL=staticChainInfo.js.map

package/dist/staticChainInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"staticChainInfo.js"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@layerzerolabs/static-chain-info",
+  "version": "0.0.8",
+  "private": false,
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.js",
+    "default": "./dist/index.cjs"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@layerzerolabs/lz-definitions": "3.0.115",
+    "@layerzerolabs/chain-utils": "0.0.8",
+    "@layerzerolabs/common-chain-model": "0.0.8",
+    "@layerzerolabs/common-utils": "0.0.8",
+    "@layerzerolabs/layerzero-definitions": "0.0.8"
+  },
+  "devDependencies": {
+    "bs58": "^5.0.0",
+    "tsup": "^8.4.0",
+    "vitest": "^3.2.3",
+    "@layerzerolabs/tsup-configuration": "0.0.8",
+    "@layerzerolabs/typescript-configuration": "0.0.8"
+  },
+  "publishConfig": {
+    "access": "restricted",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf ./node_modules .turbo ./dist",
+    "dev": "tsup --watch",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix --max-warnings 0",
+    "test": "vitest --run --pass-with-no-tests"
+  }
+}

package/src/index.ts

@@ -0,0 +1,185 @@
+import { getAddressAsBytes32HexString } from '@layerzerolabs/chain-utils';
+import type { HexAddress } from '@layerzerolabs/common-chain-model';
+import { ensure0xPrefixed, hexToBase58, hexZeroPad, isBase58 } from '@layerzerolabs/common-utils';
+import type { Environment } from '@layerzerolabs/layerzero-definitions';
+import { ChainName } from '@layerzerolabs/layerzero-definitions';
+import { EndpointVersion, UlnVersion } from '@layerzerolabs/layerzero-definitions';
+import type { Chain, EndpointId, Stage } from '@layerzerolabs/lz-definitions';
+import {
+    chainAndStageToEndpointId,
+    ChannelId,
+    EndpointV2IdBase,
+    getChainIdForNetwork,
+    getNetworkForChainId,
+} from '@layerzerolabs/lz-definitions';
+
+import { ChainSubType, staticConfig } from './staticChainInfo';
+
+export { ChainSubType };
+
+export * from './staticChainInfo';
+
+export const getChainName = (chainId: string | number | bigint): ChainName => {
+    return getNetworkForChainId(parseInt(chainId.toString()))?.chainName! as unknown as ChainName;
+};
+
+export const isLzReadEndpointId = (endpointId: number | bigint | string) => {
+    return Object.values(ChannelId).includes(Number(endpointId));
+};
+
+export const getLZEndpointVersionFromChainId = (chainId: number): EndpointVersion => {
+    if (isLzReadEndpointId(chainId)) {
+        return EndpointVersion.V2;
+    }
+    return chainId < EndpointV2IdBase ? EndpointVersion.V1 : EndpointVersion.V2;
+};
+
+export const chainIdToEndpointVersion = (chainId: string | number): EndpointVersion => {
+    const asNumber = Number(chainId);
+    if (!Number.isInteger(asNumber) || asNumber < 0)
+        throw new Error('Argument must be positive integer!');
+    return getLZEndpointVersionFromChainId(asNumber);
+};
+
+export const getEnvFromChainId = (chainId: string): string => {
+    return getNetworkForChainId(parseInt(chainId))!['env'];
+};
+
+export const getUlnVersionFromChainId = (chainId: string): UlnVersion => {
+    const ulnVersionString = getNetworkForChainId(parseInt(chainId))!['ulnVersion'];
+    return { '2': UlnVersion.V2 }[ulnVersionString]!; // V1 will not be supported anymore
+};
+
+export const getEndpointVersionFromUlnVersion = (ulnVersion: UlnVersion): EndpointVersion => {
+    if (ulnVersion === UlnVersion.V1) {
+        throw new Error('UlnVersion.V1 is not supported');
+    }
+    switch (ulnVersion) {
+        case UlnVersion.V2:
+        case UlnVersion.V301:
+            return EndpointVersion.V1;
+        case UlnVersion.V300:
+        case UlnVersion.ReadV1002:
+        case UlnVersion.V302:
+            return EndpointVersion.V2;
+        default:
+            throw new Error(`Unknown UlnVersion: ${ulnVersion}`);
+    }
+};
+
+/**
+ * @deprecated Use getChainIdForEndpointVersion instead
+ */
+export const getChainId = (
+    chainName: ChainName,
+    environment: Environment,
+    ulnVersion: UlnVersion,
+): string => {
+    const ulnVer = {
+        [UlnVersion.V1]: '1',
+        [UlnVersion.V2]: '2',
+        [UlnVersion.V300]: '3.0.2', // simpleMessageLib should get V302 chainIds
+        [UlnVersion.V301]: '3.0.1',
+        [UlnVersion.V302]: '3.0.2',
+        [UlnVersion.ReadV1002]: '10.0.2',
+    }[ulnVersion];
+
+    return getChainIdForNetwork(chainName, environment, ulnVer).valueOf().toString();
+};
+
+// Note: This doesn't work for UlnVersion.V1
+export const getChainIdForEndpointVersion = (
+    chainName: ChainName,
+    environment: Environment,
+    version: EndpointVersion,
+): EndpointId => {
+    // FIXME-STARKNET: Remove this once we have a proper ChainId for Starknet
+    if (chainName === ChainName.STARKNET) {
+        return 80085 as EndpointId;
+    }
+
+    // TODO: This is essentially 'getChainIdForNetwork' but skipping the UlnVersion -> EndpointVersion step, refactor monorepo to export this function
+    return chainAndStageToEndpointId(
+        chainName as unknown as Chain,
+        environment as unknown as Stage,
+        version,
+    );
+};
+
+export const getVId = (chainName: ChainName, environment: Environment): string => {
+    // By convention the vid is alwayd the endpointV1 chainId
+    // TODO: Monorepo doesnt have these chains for EndpointVersion.V1
+    if (['solana', 'ton', 'initia', 'movement'].includes(chainName)) {
+        const eid = getChainIdForEndpointVersion(chainName, environment, EndpointVersion.V2);
+        return (parseInt(eid.toString()) % 30000).toString();
+    }
+    return getChainIdForEndpointVersion(chainName, environment, EndpointVersion.V1).toString();
+};
+
+export class StaticChainConfigs {
+    static getChainName(chainId: string | number): ChainName {
+        return getChainName(chainId);
+    }
+    static getAddressSizeInBytesFromChainId(chainId: string | number): number {
+        return StaticChainConfigs.getAddressSizeInBytes(StaticChainConfigs.getChainName(chainId));
+    }
+    static getAddressSizeInBytes(chainName: ChainName): number {
+        return staticConfig[chainName].addressSizeInBytes;
+    }
+    static getSymbol(chainName: ChainName): string {
+        return staticConfig[chainName].symbol;
+    }
+
+    static getDecimals(chainName: ChainName): number {
+        return staticConfig[chainName].decimals;
+    }
+
+    static getMptBaseFee(chainName: ChainName): number {
+        return staticConfig[chainName].mptBaseGas!;
+    }
+
+    static getChainLayer(chainName: ChainName): number {
+        return staticConfig[chainName].chainLayer ?? 1;
+    }
+
+    static getChainSubType(chainName: ChainName): ChainSubType | undefined {
+        return staticConfig[chainName].chainSubType;
+    }
+}
+
+// TODO should be replaces with AddressParserSDK once it is written https://linear.app/layerzerolabs/issue/BE-1876
+export function getAddressEncodedByChain(chainName: ChainName, address: HexAddress): string {
+    // SOLANA addresses is base58 encoded and should not be lower cased
+    // or web3.js cannot convert it to PublicKey
+    if (chainName === ChainName.SOLANA) {
+        return isBase58(address) ? address : hexToBase58(address);
+    } else if (['aptos', 'movement', 'initia', 'ton'].includes(chainName)) {
+        const addressSizeInBytes = StaticChainConfigs.getAddressSizeInBytes(chainName);
+        // APTOS addresses is bytes32 hex encoded
+        return hexZeroPad(ensure0xPrefixed(address), addressSizeInBytes).toLowerCase();
+    }
+    // EVM addresses are 20 bytes
+    // The getAddress(...).toLowerCase() does not change the address in this case but it does some validation
+    return hexZeroPad(ensure0xPrefixed(address), 32).slice(-40).toLowerCase();
+}
+
+export function convertNativeAddressToHex(nativeAddress: {
+    nativeAddress: string;
+    chainName: ChainName;
+}): HexAddress {
+    const { nativeAddress: address, chainName } = nativeAddress;
+    // SOLANA addresses is base58 encoded and should not be lower cased
+    // or web3.js cannot convert it to PublicKey
+    if (chainName === ChainName.SOLANA) {
+        return getAddressAsBytes32HexString(address);
+    } else if (['aptos', 'movement', 'initia', 'ton'].includes(chainName)) {
+        const addressSizeInBytes = StaticChainConfigs.getAddressSizeInBytes(chainName);
+        // APTOS addresses is bytes32 hex encoded
+        return ensure0xPrefixed(
+            hexZeroPad(address, addressSizeInBytes).toLowerCase(),
+        ) as HexAddress;
+    }
+    // EVM addresses are 20 bytes
+    // The getAddress(...).toLowerCase() does not change the address in this case but it does some validation
+    return ensure0xPrefixed(hexZeroPad(address, 32).slice(-40).toLowerCase()) as HexAddress;
+}