@layerzerolabs/lz-definitions 3.0.15 → 3.0.17

package/dist/index.d.ts

@@ -1,8 +1,14 @@
+/**
+ * Enum representing different Aptos-compatible chains.
+ */
 declare enum AptosChain {
     APTOS = "aptos",
     MOVEMENT = "movement"
 }
 
+/**
+ * Enum representing different EVM-compatible chains.
+ */
 declare enum EvmChain {
     ETHEREUM = "ethereum",
     BSC = "bsc",
@@ -176,22 +182,39 @@ declare enum EvmChain {
     MOKSHA = "moksha",
     EDU = "edu",
     CITREA = "citrea",
-    ISLANDER = "islander"
+    ISLANDER = "islander",
+    BL3 = "bl3",
+    MP1 = "mp1"
 }
 
+/**
+ * Enum representing different Initia-compatible chains.
+ */
 declare enum InitiaChain {
     INITIA = "initia"
 }
 
+/**
+ * Enum representing different Solana-compatible chains.
+ */
 declare enum SolanaChain {
     SOLANA = "solana"
 }
 
+/**
+ * Enum representing different Ton-compatible chains.
+ */
 declare enum TonChain {
     TON = "ton"
 }
 
+/**
+ * Type representing a union of all supported chains.
+ */
 type Chain = EvmChain | AptosChain | SolanaChain | InitiaChain | TonChain;
+/**
+ * Object containing all supported chains.
+ */
 declare const Chain: {
     TON: TonChain.TON;
     INITIA: InitiaChain.INITIA;
@@ -371,8 +394,13 @@ declare const Chain: {
     EDU: EvmChain.EDU;
     CITREA: EvmChain.CITREA;
     ISLANDER: EvmChain.ISLANDER;
+    BL3: EvmChain.BL3;
+    MP1: EvmChain.MP1;
 };
 
+/**
+ * Enum representing different chain types.
+ */
 declare enum ChainType {
     UNKNOWN = "unknown",
     EVM = "evm",
@@ -383,6 +411,9 @@ declare enum ChainType {
 }
 
 declare const EndpointV2IdBase = 30000;
+/**
+ * Enum representing different endpoint ids on mainnet. (Adapt Endpoint V1)
+ */
 declare enum MainnetEndpointId {
     ETHEREUM_MAINNET = 101,
     BSC_MAINNET = 102,
@@ -492,6 +523,9 @@ declare enum MainnetEndpointId {
     HEMI_MAINNET = 329,
     ISLANDER_MAINNET = 330
 }
+/**
+ * Enum representing different endpoint ids on testnet. (Adapt Endpoint V1)
+ */
 declare enum TestnetEndpointId {
     BSC_TESTNET = 10102,
     AVALANCHE_TESTNET = 10106,
@@ -650,8 +684,13 @@ declare enum TestnetEndpointId {
     ODYSSEY_TESTNET = 10340,
     SOPHON_TESTNET = 10341,
     MOKSHA_TESTNET = 10342,
-    CITREA_TESTNET = 10344
+    CITREA_TESTNET = 10344,
+    MP1_TESTNET = 10345,
+    BL3_TESTNET = 10346
 }
+/**
+ * Enum representing different endpoint ids on sandbox. (Adapt Endpoint V1)
+ */
 declare enum SandboxEndpointId {
     BSC_SANDBOX = 20102,
     AVALANCHE_SANDBOX = 20106,
@@ -665,6 +704,9 @@ declare enum SandboxEndpointId {
     FANTOM_SANDBOX = 20112,
     METIS_SANDBOX = 20151
 }
+/**
+ * Enum representing different endpoint ids on mainnet. (Adapt Endpoint V2)
+ */
 declare enum MainnetV2EndpointId {
     ETHEREUM_V2_MAINNET = 30101,
     BSC_V2_MAINNET = 30102,
@@ -777,6 +819,9 @@ declare enum MainnetV2EndpointId {
     HEMI_V2_MAINNET = 30329,
     ISLANDER_V2_MAINNET = 30330
 }
+/**
+ * Enum representing different endpoint ids on testnet. (Adapt Endpoint V2)
+ */
 declare enum TestnetV2EndpointId {
     AVALANCHE_V2_TESTNET = 40106,
     POLYGON_V2_TESTNET = 40109,
@@ -936,8 +981,13 @@ declare enum TestnetV2EndpointId {
     SOPHON_V2_TESTNET = 40341,
     MOKSHA_V2_TESTNET = 40342,
     TON_V2_TESTNET = 40343,
-    CITREA_V2_TESTNET = 40344
+    CITREA_V2_TESTNET = 40344,
+    MP1_V2_TESTNET = 40345,
+    BL3_V2_TESTNET = 40346
 }
+/**
+ * Enum representing different endpoint ids on sandbox. (Adapt Endpoint V2)
+ */
 declare enum SandboxV2EndpointId {
     ETHEREUM_V2_SANDBOX = 50121,
     POLYGON_V2_SANDBOX = 50109,
@@ -954,6 +1004,10 @@ declare enum SandboxV2EndpointId {
     ARBITRUM_V2_SANDBOX = 50143,
     TON_V2_SANDBOX = 50343
 }
+/**
+ * Object containing all supported endpoint IDs.
+ * This object merges endpoint IDs from mainnet, testnet, and sandbox environments, including both V1 and V2 versions.
+ */
 declare const EndpointId: {
     [x: number]: string;
     ETHEREUM_V2_SANDBOX: SandboxV2EndpointId.ETHEREUM_V2_SANDBOX;
@@ -1129,6 +1183,8 @@ declare const EndpointId: {
     MOKSHA_V2_TESTNET: TestnetV2EndpointId.MOKSHA_V2_TESTNET;
     TON_V2_TESTNET: TestnetV2EndpointId.TON_V2_TESTNET;
     CITREA_V2_TESTNET: TestnetV2EndpointId.CITREA_V2_TESTNET;
+    MP1_V2_TESTNET: TestnetV2EndpointId.MP1_V2_TESTNET;
+    BL3_V2_TESTNET: TestnetV2EndpointId.BL3_V2_TESTNET;
     ETHEREUM_V2_MAINNET: MainnetV2EndpointId.ETHEREUM_V2_MAINNET;
     BSC_V2_MAINNET: MainnetV2EndpointId.BSC_V2_MAINNET;
     AVALANCHE_V2_MAINNET: MainnetV2EndpointId.AVALANCHE_V2_MAINNET;
@@ -1408,6 +1464,8 @@ declare const EndpointId: {
     SOPHON_TESTNET: TestnetEndpointId.SOPHON_TESTNET;
     MOKSHA_TESTNET: TestnetEndpointId.MOKSHA_TESTNET;
     CITREA_TESTNET: TestnetEndpointId.CITREA_TESTNET;
+    MP1_TESTNET: TestnetEndpointId.MP1_TESTNET;
+    BL3_TESTNET: TestnetEndpointId.BL3_TESTNET;
     ETHEREUM_MAINNET: MainnetEndpointId.ETHEREUM_MAINNET;
     BSC_MAINNET: MainnetEndpointId.BSC_MAINNET;
     AVALANCHE_MAINNET: MainnetEndpointId.AVALANCHE_MAINNET;
@@ -1516,8 +1574,15 @@ declare const EndpointId: {
     HEMI_MAINNET: MainnetEndpointId.HEMI_MAINNET;
     ISLANDER_MAINNET: MainnetEndpointId.ISLANDER_MAINNET;
 };
+/**
+ * Type representing a union of all supported endpoint IDs.
+ * This type includes endpoint IDs from mainnet, testnet, and sandbox environments, including both V1 and V2 versions.
+ */
 type EndpointId = MainnetEndpointId | TestnetEndpointId | SandboxEndpointId | MainnetV2EndpointId | TestnetV2EndpointId | SandboxV2EndpointId;
 
+/**
+ * Enum representing different environment.
+ */
 declare enum Environment {
     LOCAL = "local",
     DEVNET = "devnet",
@@ -1525,30 +1590,51 @@ declare enum Environment {
     MAINNET = "mainnet"
 }
 
+/**
+ * Enum representing different stages.
+ */
 declare enum Stage {
     MAINNET = "mainnet",
     TESTNET = "testnet",
     SANDBOX = "sandbox"
 }
 
+/**
+ * Enum representing different Endpoint versions.
+ */
 declare enum EndpointVersion {
     V1 = "v1",
     V2 = "v2"
 }
 
+/**
+ * Enum representing the versions for READ MessageLib.
+ */
 declare enum MessageLibCmdRead {
     V_10_0_2 = "10.0.2"
 }
+/**
+ * Enum representing the versions of MessageLib that support Endpoint V2.
+ */
 declare enum MessageLibVersionV2 {
     SIMPLE = "0.0.2",
     ULTRA_LIGHT_NODE_302 = "3.0.2"
 }
+/**
+ * Enum representing the versions of MessageLib that support Endpoint V1.
+ */
 declare enum MessageLibVersionV1 {
     ULTRA_LIGHT_NODE_301 = "3.0.1",
     ULTRA_LIGHT_NODE_201 = "2.0.1"
 }
+/**
+ * Type representing all possible versions for MessageLib.
+ */
 type MessageLibVersion = MessageLibVersionV2 | MessageLibVersionV1 | MessageLibCmdRead;
 
+/**
+ * Enum representing different chain keys.
+ */
 declare enum ChainKey {
     ETHEREUM = "ethereum",
     GOERLI = "goerli",
@@ -1833,86 +1919,318 @@ declare enum ChainKey {
     HEMI_TESTNET = "hemi-testnet",
     HEMI = "hemi",
     CITREA_TESTNET = "citrea-testnet",
-    ISLANDER = "islander"
+    ISLANDER = "islander",
+    BL3_TESTNET = "bl3-testnet",
+    MP1_TESTNET = "mp1-testnet"
 }
 
+/**
+ * Enum representing different read channel ids.
+ */
 declare enum ChannelId {
     READ_CHANNEL_1 = 4294967295,
     READ_CHANNEL_2 = 4294967294
 }
 
+/**
+ * A mapping of endpoint IDs to chain keys.
+ * This object maps each endpoint ID to its corresponding chain key.
+ *
+ * @type {Object.<EndpointId, ChainKey>}
+ */
 declare const CHAIN_KEY: {
     [endpointId in EndpointId]: ChainKey;
 };
 
+/**
+ * A mapping of endpoint IDs to environments.
+ * This object maps each endpoint ID to its corresponding environment.
+ *
+ * @type {Object.<EndpointId, Environment>}
+ */
 declare const ENVIRONMENT: {
     [endpointId in EndpointId]: Environment;
 };
 
+/**
+ * A list of endpoint IDs that support ULN (Ultra Light Node) version 1.
+ * This array contains the endpoint IDs for various blockchains that are compatible with ULN version 1.
+ *
+ * @type {EndpointId[]}
+ */
 declare const ULN_V1_CHAINS: (MainnetEndpointId | TestnetEndpointId | SandboxEndpointId)[];
 
+/**
+ * Enum representing the different versions of ULN (Ultra Light Node).
+ */
 declare enum UlnVersion {
     V1 = 1,
     V2 = 2,
     V3 = 3
 }
 
+/**
+ * Type representing a network name.
+ * The network name is a template literal type combining the chain, stage, and an optional '-local' suffix.
+ * @see {@link Chain}, {@link Stage}
+ */
 type Network = `${Chain}-${Stage}${'-local' | ''}`;
+/**
+ * Interface representing the specification of an endpoint.
+ */
 interface EndpointSpec {
+    /**
+     * The chain of the endpoint. {@link Chain}
+     */
     chain: Chain;
+    /**
+     * The stage of the endpoint. {@link Stage}
+     */
     stage: Stage;
+    /**
+     * The version of the endpoint. {@link EndpointVersion}
+     */
     version: EndpointVersion;
+    /**
+     * The environment of the endpoint. {@link Environment}
+     */
     env: Environment;
 }
 
+/**
+ * Converts a network name and version to an endpoint ID.
+ *
+ * @param {string} network - The network name.
+ * @param {EndpointVersion} version - The endpoint version.
+ * @returns {EndpointId} The corresponding endpoint ID.
+ * @throws {Error} If the network name is invalid.
+ */
 declare function networkToEndpointId(network: string, version: EndpointVersion): EndpointId;
+/**
+ * Converts a network name and version to an environment.
+ *
+ * @param {string} network - The network name.
+ * @param {EndpointVersion} version - The endpoint version.
+ * @returns {Environment} The corresponding environment.
+ */
 declare function networkToEnv(network: string, version: EndpointVersion): Environment;
+/**
+ * Converts a network name to a stage.
+ *
+ * @param {string} network - The network name.
+ * @returns {Stage} The corresponding stage.
+ * @throws {Error} If the network name is invalid.
+ */
 declare function networkToStage(network: string): Stage;
+/**
+ * Converts an endpoint ID to a network name.
+ *
+ * @param {number} endpointId - The endpoint ID.
+ * @param {Environment | boolean} [envOrIsLocal] - The environment or a boolean indicating if it's local.
+ * @returns {Network} The corresponding network name.
+ * @throws {Error} If the endpoint ID is invalid.
+ */
 declare function endpointIdToNetwork(endpointId: number, envOrIsLocal?: Environment | boolean): Network;
+/**
+ * Converts an endpoint ID to an endpoint version.
+ *
+ * @param {number} endpointId - The endpoint ID.
+ * @returns {EndpointVersion} The corresponding endpoint version.
+ * @throws {Error} If the endpoint ID is invalid.
+ */
 declare function endpointIdToVersion(endpointId: number): EndpointVersion;
+/**
+ * Converts an endpoint ID to a chain key.
+ *
+ * @param {number} endpointId - The endpoint ID.
+ * @returns {ChainKey} The corresponding chain key.
+ * @throws {Error} If the endpoint ID is invalid.
+ */
 declare function endpointIdToChainKey(endpointId: number): ChainKey;
+/**
+ * Converts a chain and stage to an endpoint ID.
+ *
+ * @param {Chain} chain - The chain.
+ * @param {Stage} stage - The stage.
+ * @param {EndpointVersion} version - The endpoint version.
+ * @returns {EndpointId} The corresponding endpoint ID.
+ * @throws {Error} If the key is invalid.
+ */
 declare function chainAndStageToEndpointId(chain: Chain, stage: Stage, version: EndpointVersion): EndpointId;
+/**
+ * Converts a chain and stage to a network name.
+ *
+ * @param {Chain} chain - The chain.
+ * @param {Stage} stage - The stage.
+ * @param {Environment | boolean} [envOrIsLocal] - The environment or a boolean indicating if it's local.
+ * @returns {Network} The corresponding network name.
+ */
 declare function chainAndStageToNetwork(chain: Chain, stage: Stage, envOrIsLocal?: Environment | boolean): Network;
+/**
+ * Converts an endpoint specification to a network name.
+ *
+ * @param {EndpointSpec} spec - The endpoint specification.
+ * @returns {Network} The corresponding network name.
+ */
 declare function endpointSpecToNetwork(spec: EndpointSpec): Network;
+/**
+ * Converts an endpoint specification to an environment.
+ *
+ * @param {EndpointSpec} spec - The endpoint specification.
+ * @returns {Environment} The corresponding environment.
+ */
 declare function endpointSpecToEnv(spec: EndpointSpec): Environment;
+/**
+ * Converts an endpoint specification to an endpoint ID.
+ *
+ * @param {EndpointSpec} spec - The endpoint specification.
+ * @returns {EndpointId} The corresponding endpoint ID.
+ */
 declare function endpointSpecToEndpointId(spec: EndpointSpec): EndpointId;
+/**
+ * Converts an endpoint ID and environment to an endpoint specification.
+ *
+ * @param {EndpointId} endpointId - The endpoint ID.
+ * @param {Environment} env - The environment.
+ * @returns {EndpointSpec} The corresponding endpoint specification.
+ */
 declare function endpointIdToEndpointSpec(endpointId: EndpointId, env: Environment): EndpointSpec;
+/**
+ * Converts a network name to a chain.
+ *
+ * @param {string} network - The network name.
+ * @returns {Chain} The corresponding chain.
+ */
 declare function networkToChain(network: string): Chain;
+/**
+ * Converts a network name to a chain type.
+ *
+ * @param {string} network - The network name.
+ * @returns {ChainType} The corresponding chain type.
+ */
 declare function networkToChainType(network: string): ChainType;
 /**
  * Returns the chain family for a given chain
- * @param chain
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {ChainType} The corresponding chain type.
  */
 declare function chainToChainType(chain: Chain): ChainType;
 /**
  * @deprecated Use `chainToChainType` instead
+ * Returns the chain type for a given chain.
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {ChainType} The corresponding chain type.
  */
 declare function getChainType(chain: Chain): ChainType;
+/**
+ * Converts an endpoint ID to a chain.
+ *
+ * @param {number} endpointId - The endpoint ID.
+ * @returns {Chain} The corresponding chain.
+ * @throws {Error} If the endpoint ID is invalid.
+ */
 declare function endpointIdToChain(endpointId: number): Chain;
+/**
+ * Converts an endpoint ID to a stage.
+ *
+ * @param {number} endpointId - The endpoint ID.
+ * @returns {Stage} The corresponding stage.
+ * @throws {Error} If the endpoint ID is invalid.
+ */
 declare function endpointIdToStage(endpointId: number): Stage;
+/**
+ * Converts an endpoint ID to a chain type.
+ *
+ * @param {number} endpointId - The endpoint ID.
+ * @returns {ChainType} The corresponding chain type.
+ */
 declare function endpointIdToChainType(endpointId: number): ChainType;
+/**
+ * Gets the networks for a given stage.
+ *
+ * @param {Stage} stage - The stage.
+ * @returns {string[]} The corresponding networks.
+ */
 declare function getNetworksForStage(stage: Stage): string[];
+/**
+ * Gets the endpoint version for a given ULN version.
+ *
+ * @param {string} ulnVersion - The ULN version.
+ * @returns {EndpointVersion} The corresponding endpoint version.
+ * @throws {Error} If the ULN version is invalid.
+ */
 declare const getEndpointVersionForUlnVersion: (ulnVersion: string) => EndpointVersion;
+/**
+ * Gets the chain ID for a given network.
+ *
+ * @param {string} chain - The chain.
+ * @param {string} stage - The stage.
+ * @param {string} ulnVersion - The ULN version.
+ * @returns {string} The corresponding chain ID.
+ */
 declare function getChainIdForNetwork(chain: string, stage: string, ulnVersion: string): string;
+/**
+ * Gets the network for a given chain ID.
+ *
+ * @param {number} targetChainId - The target chain ID.
+ * @returns {{ chainName: Chain; env: Stage; ulnVersion: string }} The corresponding network information.
+ */
 declare function getNetworkForChainId(targetChainId: number): {
     chainName: Chain;
     env: Stage;
     ulnVersion: string;
 };
+/**
+ * Checks if a network endpoint ID is supported.
+ *
+ * @param {string} network - The network name.
+ * @param {EndpointVersion} endpointVersion - The endpoint version.
+ * @returns {boolean} True if the network endpoint ID is supported, false otherwise.
+ */
 declare function isNetworkEndpointIdSupported(network: string, endpointVersion: EndpointVersion): boolean;
 /**
  * Determine if a chain is zkSync based.
- * @param {Chain} chain
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {boolean} True if the chain is zkSync based, false otherwise.
  */
 declare function isZKSyncBasedChain(chain: Chain): boolean;
 /**
- * Determine if a chain is tron.
- * @param {Chain} chain
+ * Determine if a chain is tron based.
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {boolean} True if the chain is Tron based, false otherwise.
  */
 declare function isTronChain(chain: Chain): boolean;
+/**
+ * Determines if a chain is EVM based.
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {boolean} True if the chain is EVM based, false otherwise.
+ */
 declare function isEvmChain(chain: Chain): boolean;
+/**
+ * Determines if a chain is Aptos based.
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {boolean} True if the chain is Aptos based, false otherwise.
+ */
 declare function isAptosChain(chain: Chain): boolean;
+/**
+ * Determines if a chain is Solana based.
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {boolean} True if the chain is Solana based, false otherwise.
+ */
 declare function isSolanaChain(chain: Chain): boolean;
+/**
+ * Determines if a chain is Initia based.
+ *
+ * @param {Chain} chain - The chain.
+ * @returns {boolean} True if the chain is Initia based, false otherwise.
+ */
 declare function isInitiaChain(chain: Chain): boolean;
 /**
  * Checks if the given value is a valid Chain. {@link Chain}
@@ -1922,14 +2240,46 @@ declare function isInitiaChain(chain: Chain): boolean;
  */
 declare function isChain(value: unknown): value is Chain;
 
+/**
+ * Interface representing the specification of a blockchain.
+ */
 interface ChainSpec {
+    /**
+     * The chain. {@link Chain}
+     */
     chain?: Chain;
+    /**
+     * The type of the chain. {@link ChainType}
+     */
     chainType: ChainType;
+    /**
+     * The size of the address in bytes.
+     */
     addressSizeInBytes: number;
+    /**
+     * The number of decimals used by the chain.
+     */
     decimals: number;
 }
+/**
+ * Class providing methods to get chain specifications.
+ */
 declare class ChainSpecs {
+    /**
+     * Gets the address size in bytes for a given chain.
+     *
+     * @param {Chain} chain - The chain.
+     * @returns {number} The address size in bytes.
+     */
     static getAddressSizeInBytes(chain: Chain): number;
+    /**
+     * Gets the chain specification for a given chain type and chain.
+     *
+     * @param {ChainType} chainType - The type of the chain.
+     * @param {Chain | 'default'} chain - The chain or 'default'.
+     * @returns {ChainSpec} The chain specification.
+     * @throws {Error} If the configuration for the chain type is not found.
+     */
     static getChainSpec(chainType: ChainType, chain: Chain | 'default'): ChainSpec;
 }