@layerzerolabs/lz-config-types 3.0.15 → 3.0.17

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @layerzerolabs/lz-config-types
 
+## 3.0.17
+
+### Patch Changes
+
+- 40f2269: islander mainnet
+- 40f2269: testnets
+- Updated dependencies [40f2269]
+- Updated dependencies [40f2269]
+  - @layerzerolabs/lz-core@3.0.17
+  - @layerzerolabs/lz-definitions@3.0.17
+
+## 3.0.16
+
+### Patch Changes
+
+- 87a4bc9: islander mainnet
+- Updated dependencies [87a4bc9]
+  - @layerzerolabs/lz-core@3.0.16
+  - @layerzerolabs/lz-definitions@3.0.16
+
 ## 3.0.15
 
 ### Patch Changes

package/README.md

@@ -1,4 +1,4 @@
-# layerzero-core
+# @layerzerolabs/lz-config-types
 
 This package defines the core interface for the tooling stack, and only includes neutral interfaces unrelated to the LayerZero protocol.
 
@@ -6,3 +6,103 @@ This package defines the core interface for the tooling stack, and only includes
 - `Provider` Interface: Define the connectors to a chain node.
 - `Signer` Interface: Sign message and transaction.
 - `Deployment` interface: Represent the structure for deployment information
+
+
+## Installation
+
+To install the LayerZero Config Types package, you can use npm or yarn:
+
+```sh
+npm install @layerzerolabs/lz-config-types
+```
+
+or
+
+```sh
+yarn add @layerzerolabs/lz-config-types
+```
+
+## Usage
+
+### Provider Configuration
+
+#### ProviderManager
+
+Provides methods to retrieve providers based on the specified chain and environment.
+
+- chain: The chain for which to retrieve the provider.
+- env: The environment for which to retrieve the provider.
+- Returns: A promise that resolves to the provider.
+
+```typescript
+import { ProviderManager } from "@layerzerolabs/lz-config-types";
+import { Chain, Environment } from "@layerzerolabs/lz-definitions";
+
+const providerManager: ProviderManager = {
+  async getProvider(chain: Chain, env: Environment): Promise<Provider> {
+    // Implementation to retrieve the provider
+  },
+};
+
+const chain: Chain = "ethereum";
+const env: Environment = "mainnet";
+
+providerManager.getProvider(chain, env).then((provider) => {
+  console.log(`Provider: ${provider}`);
+});
+```
+
+### Signer Configuration
+
+#### SignerManager
+
+Provides methods to retrieve signers based on the specified chain, stage, environment, and key name.
+
+- chain: The chain for which to retrieve the signer.
+- stage: The stage for which to retrieve the signer.
+- env: The environment for which to retrieve the signer.
+- keyName: The key name for which to retrieve the signer.
+- Returns: A promise that resolves to the signer.
+
+```typescript
+import { SignerManager } from "@layerzerolabs/lz-config-types";
+import { Chain, Stage, Environment } from "@layerzerolabs/lz-definitions";
+
+const signerManager: SignerManager = {
+  async getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer> {
+    // Implementation to retrieve the signer
+  },
+};
+
+const chain: Chain = "ethereum";
+const stage: Stage = "development";
+const env: Environment = "sandbox";
+const keyName = "key1";
+
+signerManager.getSigner(chain, stage, env, keyName).then((signer) => {
+  console.log(`Signer: ${signer}`);
+});
+```
+
+### Configuration Manager
+
+#### ConfigManager
+
+Provides methods to retrieve configuration values based on a specified path.
+
+- path: The path to the configuration value.
+- Returns: A promise that resolves to the configuration value.
+
+```typescript
+import { ConfigManager } from "@layerzerolabs/lz-config-types";
+
+const configManager: ConfigManager = {
+  async get(...path: (string | number | (string | number)[])[]): Promise<unknown> {
+    // Implementation to retrieve the configuration value
+  },
+};
+
+configManager.get("database", "host").then((value) => {
+  console.log(`Configuration Value: ${value}`);
+});
+```

package/dist/index.cjs

@@ -23,5 +23,5 @@ function isCombinedSquadsItemConfig(obj) {
 exports.isCombinedGnosisItemConfig = isCombinedGnosisItemConfig;
 exports.isCombinedSquadsItemConfig = isCombinedSquadsItemConfig;
 exports.isGnosisItemConfig = isGnosisItemConfig;
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/signer.ts"],"names":[],"mappings":";AAqEO,SAAS,mBAAmB,KAAuC;AACtE,MAAI,QAAQ,UAAa,QAAQ,MAAM;AACnC,WAAO;AAAA,EACX;AAEA,SAAO,OAAO,QAAQ,YAAY,aAAa,OAAO,iBAAiB;AAC3E;AAEO,SAAS,2BAA2B,KAA+C;AACtF,MAAI,QAAQ,UAAa,QAAQ,MAAM;AACnC,WAAO;AAAA,EACX;AAEA,SAAO,OAAO,QAAQ,YAAY,aAAa,OAAO,iBAAiB,QAAQ,cAAc,OAAO,QAAQ;AAChH;AAEO,SAAS,2BAA2B,KAA+C;AACtF,MAAI,QAAQ,UAAa,QAAQ,MAAM;AACnC,WAAO;AAAA,EACX;AAEA,SAAO,OAAO,QAAQ,YAAY,qBAAqB;AAC3D","sourcesContent":["import { ContractNetworksConfig } from '@safe-global/protocol-kit'\ntype ContractNetworkConfig = ContractNetworksConfig[string]\n\n// ------------------ Account/Signer Config ------------------\n\nimport { Signer } from '@layerzerolabs/lz-core'\nimport { Chain, ChainType, Environment, Stage } from '@layerzerolabs/lz-definitions'\n\nexport interface SignerItemConfig {\n    mnemonic?: string\n    path?: string\n    address?: string\n    pk?: string\n}\n\nexport interface GnosisItemConfig {\n    safeUrl: string\n    safeAddress: string\n    contractNetworks?: { [key: string]: Partial<ContractNetworkConfig> }\n}\n\nexport interface SquadsItemConfig {\n    multisigAddress: string\n}\n\nexport type GnosisStageConfig = {\n    [chainOrType in ChainType | Chain]?: { [key: string]: GnosisItemConfig | SquadsItemConfig }\n}\n\n// config by stage, chain, keyName\nexport type GnosisConfig = {\n    [stage in Stage]?: GnosisStageConfig\n}\n\nexport type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig\nexport type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig\n/**\n * config by stage, chain, keyName\n * example:\n * ```json\n * {\n *  \"sandbox\": {\n *    \"ethereum\": {\n *      \"key1\": {\n *        \"mnemonic\": \"xxx\",\n *         \"path\": \"xxx\"\n *       },\n *      \"key2\": {\n *        \"pk\": \"xxx\",\n *        \"path\": \"xxx\"\n *         safeUrl: \"xxx\",\n *         safeAddress: \"xxx\"\n *      }\n *    }\n *  }\n * }\n * ```\n */\nexport type SignerConfig = {\n    [stage in Stage]?: {\n        [chainOrType in ChainType | Chain]?: {\n            [key: string]: SignerItemConfig | CombinedGnosisItemConfig | CombinedSquadsItemConfig\n        }\n    }\n}\nexport interface SignerManager {\n    getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>\n}\n\nexport function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj\n}\n\nexport function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj && ('mnemonic' in obj || 'pk' in obj)\n}\n\nexport function isCombinedSquadsItemConfig(obj: unknown): obj is CombinedSquadsItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'multisigAddress' in obj\n}\n"]}
+{"version":3,"sources":["../src/signer.ts"],"names":[],"mappings":";;;AAgJO,SAAS,mBAAmB,GAAuC,EAAA;AACtE,EAAI,IAAA,GAAA,KAAQ,KAAa,CAAA,IAAA,GAAA,KAAQ,IAAM,EAAA;AACnC,IAAO,OAAA,KAAA;AAAA;AAGX,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAY,IAAA,SAAA,IAAa,OAAO,aAAiB,IAAA,GAAA;AAC3E;AAQO,SAAS,2BAA2B,GAA+C,EAAA;AACtF,EAAI,IAAA,GAAA,KAAQ,KAAa,CAAA,IAAA,GAAA,KAAQ,IAAM,EAAA;AACnC,IAAO,OAAA,KAAA;AAAA;AAGX,EAAO,OAAA,OAAO,QAAQ,QAAY,IAAA,SAAA,IAAa,OAAO,aAAiB,IAAA,GAAA,KAAQ,UAAc,IAAA,GAAA,IAAO,IAAQ,IAAA,GAAA,CAAA;AAChH;AAQO,SAAS,2BAA2B,GAA+C,EAAA;AACtF,EAAI,IAAA,GAAA,KAAQ,KAAa,CAAA,IAAA,GAAA,KAAQ,IAAM,EAAA;AACnC,IAAO,OAAA,KAAA;AAAA;AAGX,EAAO,OAAA,OAAO,GAAQ,KAAA,QAAA,IAAY,iBAAqB,IAAA,GAAA;AAC3D","file":"index.cjs","sourcesContent":["import { ContractNetworksConfig } from '@safe-global/protocol-kit'\ntype ContractNetworkConfig = ContractNetworksConfig[string]\n\n// ------------------ Account/Signer Config ------------------\n\nimport { Signer } from '@layerzerolabs/lz-core'\nimport { Chain, ChainType, Environment, Stage } from '@layerzerolabs/lz-definitions'\n\n/**\n * Interface representing the configuration for a signer item.\n */\nexport interface SignerItemConfig {\n    /**\n     * The mnemonic for the signer.\n     */\n    mnemonic?: string\n    /**\n     * The derivation path for the signer.\n     */\n    path?: string\n    /**\n     * The address of the signer.\n     */\n    address?: string\n    /**\n     * The private key of the signer.\n     */\n    pk?: string\n}\n\n/**\n * Interface representing the configuration for a Gnosis item.\n */\nexport interface GnosisItemConfig {\n    /**\n     * The URL of the Gnosis safe.\n     */\n    safeUrl: string\n    /**\n     * The address of the Gnosis safe.\n     */\n    safeAddress: string\n    /**\n     * The contract networks configuration for the Gnosis safe (optional).\n     * @see {@link ContractNetworksConfig}\n     */\n    contractNetworks?: { [key: string]: Partial<ContractNetworkConfig> }\n}\n\n/**\n * Interface representing the configuration for a Squads item.\n */\nexport interface SquadsItemConfig {\n    /**\n     * The address of the multisig.\n     */\n    multisigAddress: string\n}\n\n/**\n * Type representing the configuration for Gnosis by stage and chain.\n * @see {@link GnosisItemConfig}, {@link SquadsItemConfig}, {@link ChainType}, {@link Chain}\n */\nexport type GnosisStageConfig = {\n    [chainOrType in ChainType | Chain]?: { [key: string]: GnosisItemConfig | SquadsItemConfig }\n}\n\n/**\n * Type representing the configuration for Gnosis by stage.\n * This type maps stages to their corresponding Gnosis stage configurations.\n */\nexport type GnosisConfig = {\n    /**\n     * The stage of the configuration.\n     * @see {@link Stage}, {@link GnosisStageConfig}\n     */\n    [stage in Stage]?: GnosisStageConfig\n}\n\n/**\n * Type representing the combined configuration for Gnosis and signer items.\n */\nexport type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig\n\n/**\n * Type representing the combined configuration for Squads and signer items.\n */\nexport type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig\n/**\n * Type representing the configuration for signers by stage, chain, and key name.\n * @example\n * ```json\n * {\n *  \"sandbox\": {\n *    \"ethereum\": {\n *      \"key1\": {\n *        \"mnemonic\": \"xxx\",\n *         \"path\": \"xxx\"\n *       },\n *      \"key2\": {\n *        \"pk\": \"xxx\",\n *        \"path\": \"xxx\"\n *         safeUrl: \"xxx\",\n *         safeAddress: \"xxx\"\n *      }\n *    }\n *  }\n * }\n *\n * @see {@link SignerItemConfig}, {@link CombinedGnosisItemConfig}, {@link CombinedSquadsItemConfig}, {@link ChainType}, {@link Chain}\n * ```\n */\nexport type SignerConfig = {\n    [stage in Stage]?: {\n        [chainOrType in ChainType | Chain]?: {\n            [key: string]: SignerItemConfig | CombinedGnosisItemConfig | CombinedSquadsItemConfig\n        }\n    }\n}\n\n/**\n * Interface representing a signer manager.\n * Provides methods to retrieve signers based on the specified chain, stage, environment, and key name.\n */\nexport interface SignerManager {\n    /**\n     * Retrieves a signer based on the specified chain, stage, environment, and key name.\n     *\n     * @param {Chain} chain - The chain for which to retrieve the signer.\n     * @param {Stage} stage - The stage for which to retrieve the signer.\n     * @param {Environment} env - The environment for which to retrieve the signer.\n     * @param {string} keyName - The key name for which to retrieve the signer.\n     * @returns {Promise<Signer>} A promise that resolves to the signer.\n     */\n    getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>\n}\n\n/**\n * Checks if the given object is a Gnosis item configuration.\n *\n * @param {unknown} obj - The object to check.\n * @returns {boolean} True if the object is a Gnosis item configuration, false otherwise.\n * @see {@link GnosisItemConfig}\n */\nexport function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj\n}\n\n/**\n * Checks if the given object is a combined Gnosis item configuration.\n *\n * @param {unknown} obj - The object to check.\n * @returns {boolean} True if the object is a combined Gnosis item configuration, false otherwise.\n */\nexport function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj && ('mnemonic' in obj || 'pk' in obj)\n}\n\n/**\n * Checks if the given object is a combined Squads item configuration.\n *\n * @param {unknown} obj - The object to check.\n * @returns {boolean} True if the object is a combined Squads item configuration, false otherwise.\n */\nexport function isCombinedSquadsItemConfig(obj: unknown): obj is CombinedSquadsItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'multisigAddress' in obj\n}\n"]}

package/dist/index.d.mts

@@ -2,50 +2,123 @@ import { Provider, Signer } from '@layerzerolabs/lz-core';
 import { Environment, Chain, ChainType, Stage } from '@layerzerolabs/lz-definitions';
 import { ContractNetworksConfig } from '@safe-global/protocol-kit';
 
+/**
+ * Type representing the settings for a provider.
+ * It can be either an object with a URL and an optional API key, or a string representing the URL.
+ */
 type ProviderSetting = {
+    /**
+     * The URL of the provider.
+     */
     url: string;
+    /**
+     * The API key for the provider (optional).
+     */
     apiKey?: string;
 } | string;
+/**
+ * Type representing the configuration for providers.
+ * It maps environments to chains and their corresponding provider settings.
+ */
 type ProviderConfig = {
     [env in Environment]?: {
         [chain in Chain]?: ProviderSetting;
     };
 };
+/**
+ * Interface representing a provider manager.
+ * Provides methods to retrieve providers based on the specified chain and environment.
+ */
 interface ProviderManager {
+    /**
+     * Retrieves a provider based on the specified chain and environment.
+     *
+     * @param {Chain} chain - The chain for which to retrieve the provider.
+     * @param {Environment} env - The environment for which to retrieve the provider.
+     * @returns {Promise<Provider>} A promise that resolves to the provider.
+     */
     getProvider(chain: Chain, env: Environment): Promise<Provider>;
 }
 
 type ContractNetworkConfig = ContractNetworksConfig[string];
 
+/**
+ * Interface representing the configuration for a signer item.
+ */
 interface SignerItemConfig {
+    /**
+     * The mnemonic for the signer.
+     */
     mnemonic?: string;
+    /**
+     * The derivation path for the signer.
+     */
     path?: string;
+    /**
+     * The address of the signer.
+     */
     address?: string;
+    /**
+     * The private key of the signer.
+     */
     pk?: string;
 }
+/**
+ * Interface representing the configuration for a Gnosis item.
+ */
 interface GnosisItemConfig {
+    /**
+     * The URL of the Gnosis safe.
+     */
     safeUrl: string;
+    /**
+     * The address of the Gnosis safe.
+     */
     safeAddress: string;
+    /**
+     * The contract networks configuration for the Gnosis safe (optional).
+     * @see {@link ContractNetworksConfig}
+     */
     contractNetworks?: {
         [key: string]: Partial<ContractNetworkConfig>;
     };
 }
+/**
+ * Interface representing the configuration for a Squads item.
+ */
 interface SquadsItemConfig {
+    /**
+     * The address of the multisig.
+     */
     multisigAddress: string;
 }
+/**
+ * Type representing the configuration for Gnosis by stage and chain.
+ * @see {@link GnosisItemConfig}, {@link SquadsItemConfig}, {@link ChainType}, {@link Chain}
+ */
 type GnosisStageConfig = {
     [chainOrType in ChainType | Chain]?: {
         [key: string]: GnosisItemConfig | SquadsItemConfig;
     };
 };
+/**
+ * Type representing the configuration for Gnosis by stage.
+ * This type maps stages to their corresponding Gnosis stage configurations.
+ */
 type GnosisConfig = {
     [stage in Stage]?: GnosisStageConfig;
 };
+/**
+ * Type representing the combined configuration for Gnosis and signer items.
+ */
 type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig;
+/**
+ * Type representing the combined configuration for Squads and signer items.
+ */
 type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig;
 /**
- * config by stage, chain, keyName
- * example:
+ * Type representing the configuration for signers by stage, chain, and key name.
+ * @example
  * ```json
  * {
  *  "sandbox": {
@@ -63,6 +136,8 @@ type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig;
  *    }
  *  }
  * }
+ *
+ * @see {@link SignerItemConfig}, {@link CombinedGnosisItemConfig}, {@link CombinedSquadsItemConfig}, {@link ChainType}, {@link Chain}
  * ```
  */
 type SignerConfig = {
@@ -72,11 +147,43 @@ type SignerConfig = {
         };
     };
 };
+/**
+ * Interface representing a signer manager.
+ * Provides methods to retrieve signers based on the specified chain, stage, environment, and key name.
+ */
 interface SignerManager {
+    /**
+     * Retrieves a signer based on the specified chain, stage, environment, and key name.
+     *
+     * @param {Chain} chain - The chain for which to retrieve the signer.
+     * @param {Stage} stage - The stage for which to retrieve the signer.
+     * @param {Environment} env - The environment for which to retrieve the signer.
+     * @param {string} keyName - The key name for which to retrieve the signer.
+     * @returns {Promise<Signer>} A promise that resolves to the signer.
+     */
     getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>;
 }
+/**
+ * Checks if the given object is a Gnosis item configuration.
+ *
+ * @param {unknown} obj - The object to check.
+ * @returns {boolean} True if the object is a Gnosis item configuration, false otherwise.
+ * @see {@link GnosisItemConfig}
+ */
 declare function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig;
+/**
+ * Checks if the given object is a combined Gnosis item configuration.
+ *
+ * @param {unknown} obj - The object to check.
+ * @returns {boolean} True if the object is a combined Gnosis item configuration, false otherwise.
+ */
 declare function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig;
+/**
+ * Checks if the given object is a combined Squads item configuration.
+ *
+ * @param {unknown} obj - The object to check.
+ * @returns {boolean} True if the object is a combined Squads item configuration, false otherwise.
+ */
 declare function isCombinedSquadsItemConfig(obj: unknown): obj is CombinedSquadsItemConfig;
 
 export { type CombinedGnosisItemConfig, type CombinedSquadsItemConfig, type GnosisConfig, type GnosisItemConfig, type GnosisStageConfig, type ProviderConfig, type ProviderManager, type ProviderSetting, type SignerConfig, type SignerItemConfig, type SignerManager, type SquadsItemConfig, isCombinedGnosisItemConfig, isCombinedSquadsItemConfig, isGnosisItemConfig };

package/dist/index.d.ts

@@ -2,50 +2,123 @@ import { Provider, Signer } from '@layerzerolabs/lz-core';
 import { Environment, Chain, ChainType, Stage } from '@layerzerolabs/lz-definitions';
 import { ContractNetworksConfig } from '@safe-global/protocol-kit';
 
+/**
+ * Type representing the settings for a provider.
+ * It can be either an object with a URL and an optional API key, or a string representing the URL.
+ */
 type ProviderSetting = {
+    /**
+     * The URL of the provider.
+     */
     url: string;
+    /**
+     * The API key for the provider (optional).
+     */
     apiKey?: string;
 } | string;
+/**
+ * Type representing the configuration for providers.
+ * It maps environments to chains and their corresponding provider settings.
+ */
 type ProviderConfig = {
     [env in Environment]?: {
         [chain in Chain]?: ProviderSetting;
     };
 };
+/**
+ * Interface representing a provider manager.
+ * Provides methods to retrieve providers based on the specified chain and environment.
+ */
 interface ProviderManager {
+    /**
+     * Retrieves a provider based on the specified chain and environment.
+     *
+     * @param {Chain} chain - The chain for which to retrieve the provider.
+     * @param {Environment} env - The environment for which to retrieve the provider.
+     * @returns {Promise<Provider>} A promise that resolves to the provider.
+     */
     getProvider(chain: Chain, env: Environment): Promise<Provider>;
 }
 
 type ContractNetworkConfig = ContractNetworksConfig[string];
 
+/**
+ * Interface representing the configuration for a signer item.
+ */
 interface SignerItemConfig {
+    /**
+     * The mnemonic for the signer.
+     */
     mnemonic?: string;
+    /**
+     * The derivation path for the signer.
+     */
     path?: string;
+    /**
+     * The address of the signer.
+     */
     address?: string;
+    /**
+     * The private key of the signer.
+     */
     pk?: string;
 }
+/**
+ * Interface representing the configuration for a Gnosis item.
+ */
 interface GnosisItemConfig {
+    /**
+     * The URL of the Gnosis safe.
+     */
     safeUrl: string;
+    /**
+     * The address of the Gnosis safe.
+     */
     safeAddress: string;
+    /**
+     * The contract networks configuration for the Gnosis safe (optional).
+     * @see {@link ContractNetworksConfig}
+     */
     contractNetworks?: {
         [key: string]: Partial<ContractNetworkConfig>;
     };
 }
+/**
+ * Interface representing the configuration for a Squads item.
+ */
 interface SquadsItemConfig {
+    /**
+     * The address of the multisig.
+     */
     multisigAddress: string;
 }
+/**
+ * Type representing the configuration for Gnosis by stage and chain.
+ * @see {@link GnosisItemConfig}, {@link SquadsItemConfig}, {@link ChainType}, {@link Chain}
+ */
 type GnosisStageConfig = {
     [chainOrType in ChainType | Chain]?: {
         [key: string]: GnosisItemConfig | SquadsItemConfig;
     };
 };
+/**
+ * Type representing the configuration for Gnosis by stage.
+ * This type maps stages to their corresponding Gnosis stage configurations.
+ */
 type GnosisConfig = {
     [stage in Stage]?: GnosisStageConfig;
 };
+/**
+ * Type representing the combined configuration for Gnosis and signer items.
+ */
 type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig;
+/**
+ * Type representing the combined configuration for Squads and signer items.
+ */
 type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig;
 /**
- * config by stage, chain, keyName
- * example:
+ * Type representing the configuration for signers by stage, chain, and key name.
+ * @example
  * ```json
  * {
  *  "sandbox": {
@@ -63,6 +136,8 @@ type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig;
  *    }
  *  }
  * }
+ *
+ * @see {@link SignerItemConfig}, {@link CombinedGnosisItemConfig}, {@link CombinedSquadsItemConfig}, {@link ChainType}, {@link Chain}
  * ```
  */
 type SignerConfig = {
@@ -72,11 +147,43 @@ type SignerConfig = {
         };
     };
 };
+/**
+ * Interface representing a signer manager.
+ * Provides methods to retrieve signers based on the specified chain, stage, environment, and key name.
+ */
 interface SignerManager {
+    /**
+     * Retrieves a signer based on the specified chain, stage, environment, and key name.
+     *
+     * @param {Chain} chain - The chain for which to retrieve the signer.
+     * @param {Stage} stage - The stage for which to retrieve the signer.
+     * @param {Environment} env - The environment for which to retrieve the signer.
+     * @param {string} keyName - The key name for which to retrieve the signer.
+     * @returns {Promise<Signer>} A promise that resolves to the signer.
+     */
     getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>;
 }
+/**
+ * Checks if the given object is a Gnosis item configuration.
+ *
+ * @param {unknown} obj - The object to check.
+ * @returns {boolean} True if the object is a Gnosis item configuration, false otherwise.
+ * @see {@link GnosisItemConfig}
+ */
 declare function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig;
+/**
+ * Checks if the given object is a combined Gnosis item configuration.
+ *
+ * @param {unknown} obj - The object to check.
+ * @returns {boolean} True if the object is a combined Gnosis item configuration, false otherwise.
+ */
 declare function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig;
+/**
+ * Checks if the given object is a combined Squads item configuration.
+ *
+ * @param {unknown} obj - The object to check.
+ * @returns {boolean} True if the object is a combined Squads item configuration, false otherwise.
+ */
 declare function isCombinedSquadsItemConfig(obj: unknown): obj is CombinedSquadsItemConfig;
 
 export { type CombinedGnosisItemConfig, type CombinedSquadsItemConfig, type GnosisConfig, type GnosisItemConfig, type GnosisStageConfig, type ProviderConfig, type ProviderManager, type ProviderSetting, type SignerConfig, type SignerItemConfig, type SignerManager, type SquadsItemConfig, isCombinedGnosisItemConfig, isCombinedSquadsItemConfig, isGnosisItemConfig };

package/dist/index.mjs

@@ -19,5 +19,5 @@ function isCombinedSquadsItemConfig(obj) {
 }
 
 export { isCombinedGnosisItemConfig, isCombinedSquadsItemConfig, isGnosisItemConfig };
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/signer.ts"],"names":[],"mappings":";AAqEO,SAAS,mBAAmB,KAAuC;AACtE,MAAI,QAAQ,UAAa,QAAQ,MAAM;AACnC,WAAO;AAAA,EACX;AAEA,SAAO,OAAO,QAAQ,YAAY,aAAa,OAAO,iBAAiB;AAC3E;AAEO,SAAS,2BAA2B,KAA+C;AACtF,MAAI,QAAQ,UAAa,QAAQ,MAAM;AACnC,WAAO;AAAA,EACX;AAEA,SAAO,OAAO,QAAQ,YAAY,aAAa,OAAO,iBAAiB,QAAQ,cAAc,OAAO,QAAQ;AAChH;AAEO,SAAS,2BAA2B,KAA+C;AACtF,MAAI,QAAQ,UAAa,QAAQ,MAAM;AACnC,WAAO;AAAA,EACX;AAEA,SAAO,OAAO,QAAQ,YAAY,qBAAqB;AAC3D","sourcesContent":["import { ContractNetworksConfig } from '@safe-global/protocol-kit'\ntype ContractNetworkConfig = ContractNetworksConfig[string]\n\n// ------------------ Account/Signer Config ------------------\n\nimport { Signer } from '@layerzerolabs/lz-core'\nimport { Chain, ChainType, Environment, Stage } from '@layerzerolabs/lz-definitions'\n\nexport interface SignerItemConfig {\n    mnemonic?: string\n    path?: string\n    address?: string\n    pk?: string\n}\n\nexport interface GnosisItemConfig {\n    safeUrl: string\n    safeAddress: string\n    contractNetworks?: { [key: string]: Partial<ContractNetworkConfig> }\n}\n\nexport interface SquadsItemConfig {\n    multisigAddress: string\n}\n\nexport type GnosisStageConfig = {\n    [chainOrType in ChainType | Chain]?: { [key: string]: GnosisItemConfig | SquadsItemConfig }\n}\n\n// config by stage, chain, keyName\nexport type GnosisConfig = {\n    [stage in Stage]?: GnosisStageConfig\n}\n\nexport type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig\nexport type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig\n/**\n * config by stage, chain, keyName\n * example:\n * ```json\n * {\n *  \"sandbox\": {\n *    \"ethereum\": {\n *      \"key1\": {\n *        \"mnemonic\": \"xxx\",\n *         \"path\": \"xxx\"\n *       },\n *      \"key2\": {\n *        \"pk\": \"xxx\",\n *        \"path\": \"xxx\"\n *         safeUrl: \"xxx\",\n *         safeAddress: \"xxx\"\n *      }\n *    }\n *  }\n * }\n * ```\n */\nexport type SignerConfig = {\n    [stage in Stage]?: {\n        [chainOrType in ChainType | Chain]?: {\n            [key: string]: SignerItemConfig | CombinedGnosisItemConfig | CombinedSquadsItemConfig\n        }\n    }\n}\nexport interface SignerManager {\n    getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>\n}\n\nexport function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj\n}\n\nexport function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj && ('mnemonic' in obj || 'pk' in obj)\n}\n\nexport function isCombinedSquadsItemConfig(obj: unknown): obj is CombinedSquadsItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'multisigAddress' in obj\n}\n"]}
+{"version":3,"sources":["../src/signer.ts"],"names":[],"mappings":";AAgJO,SAAS,mBAAmB,GAAuC,EAAA;AACtE,EAAI,IAAA,GAAA,KAAQ,KAAa,CAAA,IAAA,GAAA,KAAQ,IAAM,EAAA;AACnC,IAAO,OAAA,KAAA;AAAA;AAGX,EAAA,OAAO,OAAO,GAAA,KAAQ,QAAY,IAAA,SAAA,IAAa,OAAO,aAAiB,IAAA,GAAA;AAC3E;AAQO,SAAS,2BAA2B,GAA+C,EAAA;AACtF,EAAI,IAAA,GAAA,KAAQ,KAAa,CAAA,IAAA,GAAA,KAAQ,IAAM,EAAA;AACnC,IAAO,OAAA,KAAA;AAAA;AAGX,EAAO,OAAA,OAAO,QAAQ,QAAY,IAAA,SAAA,IAAa,OAAO,aAAiB,IAAA,GAAA,KAAQ,UAAc,IAAA,GAAA,IAAO,IAAQ,IAAA,GAAA,CAAA;AAChH;AAQO,SAAS,2BAA2B,GAA+C,EAAA;AACtF,EAAI,IAAA,GAAA,KAAQ,KAAa,CAAA,IAAA,GAAA,KAAQ,IAAM,EAAA;AACnC,IAAO,OAAA,KAAA;AAAA;AAGX,EAAO,OAAA,OAAO,GAAQ,KAAA,QAAA,IAAY,iBAAqB,IAAA,GAAA;AAC3D","file":"index.mjs","sourcesContent":["import { ContractNetworksConfig } from '@safe-global/protocol-kit'\ntype ContractNetworkConfig = ContractNetworksConfig[string]\n\n// ------------------ Account/Signer Config ------------------\n\nimport { Signer } from '@layerzerolabs/lz-core'\nimport { Chain, ChainType, Environment, Stage } from '@layerzerolabs/lz-definitions'\n\n/**\n * Interface representing the configuration for a signer item.\n */\nexport interface SignerItemConfig {\n    /**\n     * The mnemonic for the signer.\n     */\n    mnemonic?: string\n    /**\n     * The derivation path for the signer.\n     */\n    path?: string\n    /**\n     * The address of the signer.\n     */\n    address?: string\n    /**\n     * The private key of the signer.\n     */\n    pk?: string\n}\n\n/**\n * Interface representing the configuration for a Gnosis item.\n */\nexport interface GnosisItemConfig {\n    /**\n     * The URL of the Gnosis safe.\n     */\n    safeUrl: string\n    /**\n     * The address of the Gnosis safe.\n     */\n    safeAddress: string\n    /**\n     * The contract networks configuration for the Gnosis safe (optional).\n     * @see {@link ContractNetworksConfig}\n     */\n    contractNetworks?: { [key: string]: Partial<ContractNetworkConfig> }\n}\n\n/**\n * Interface representing the configuration for a Squads item.\n */\nexport interface SquadsItemConfig {\n    /**\n     * The address of the multisig.\n     */\n    multisigAddress: string\n}\n\n/**\n * Type representing the configuration for Gnosis by stage and chain.\n * @see {@link GnosisItemConfig}, {@link SquadsItemConfig}, {@link ChainType}, {@link Chain}\n */\nexport type GnosisStageConfig = {\n    [chainOrType in ChainType | Chain]?: { [key: string]: GnosisItemConfig | SquadsItemConfig }\n}\n\n/**\n * Type representing the configuration for Gnosis by stage.\n * This type maps stages to their corresponding Gnosis stage configurations.\n */\nexport type GnosisConfig = {\n    /**\n     * The stage of the configuration.\n     * @see {@link Stage}, {@link GnosisStageConfig}\n     */\n    [stage in Stage]?: GnosisStageConfig\n}\n\n/**\n * Type representing the combined configuration for Gnosis and signer items.\n */\nexport type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig\n\n/**\n * Type representing the combined configuration for Squads and signer items.\n */\nexport type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig\n/**\n * Type representing the configuration for signers by stage, chain, and key name.\n * @example\n * ```json\n * {\n *  \"sandbox\": {\n *    \"ethereum\": {\n *      \"key1\": {\n *        \"mnemonic\": \"xxx\",\n *         \"path\": \"xxx\"\n *       },\n *      \"key2\": {\n *        \"pk\": \"xxx\",\n *        \"path\": \"xxx\"\n *         safeUrl: \"xxx\",\n *         safeAddress: \"xxx\"\n *      }\n *    }\n *  }\n * }\n *\n * @see {@link SignerItemConfig}, {@link CombinedGnosisItemConfig}, {@link CombinedSquadsItemConfig}, {@link ChainType}, {@link Chain}\n * ```\n */\nexport type SignerConfig = {\n    [stage in Stage]?: {\n        [chainOrType in ChainType | Chain]?: {\n            [key: string]: SignerItemConfig | CombinedGnosisItemConfig | CombinedSquadsItemConfig\n        }\n    }\n}\n\n/**\n * Interface representing a signer manager.\n * Provides methods to retrieve signers based on the specified chain, stage, environment, and key name.\n */\nexport interface SignerManager {\n    /**\n     * Retrieves a signer based on the specified chain, stage, environment, and key name.\n     *\n     * @param {Chain} chain - The chain for which to retrieve the signer.\n     * @param {Stage} stage - The stage for which to retrieve the signer.\n     * @param {Environment} env - The environment for which to retrieve the signer.\n     * @param {string} keyName - The key name for which to retrieve the signer.\n     * @returns {Promise<Signer>} A promise that resolves to the signer.\n     */\n    getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>\n}\n\n/**\n * Checks if the given object is a Gnosis item configuration.\n *\n * @param {unknown} obj - The object to check.\n * @returns {boolean} True if the object is a Gnosis item configuration, false otherwise.\n * @see {@link GnosisItemConfig}\n */\nexport function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj\n}\n\n/**\n * Checks if the given object is a combined Gnosis item configuration.\n *\n * @param {unknown} obj - The object to check.\n * @returns {boolean} True if the object is a combined Gnosis item configuration, false otherwise.\n */\nexport function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'safeUrl' in obj && 'safeAddress' in obj && ('mnemonic' in obj || 'pk' in obj)\n}\n\n/**\n * Checks if the given object is a combined Squads item configuration.\n *\n * @param {unknown} obj - The object to check.\n * @returns {boolean} True if the object is a combined Squads item configuration, false otherwise.\n */\nexport function isCombinedSquadsItemConfig(obj: unknown): obj is CombinedSquadsItemConfig {\n    if (obj === undefined || obj === null) {\n        return false\n    }\n\n    return typeof obj === 'object' && 'multisigAddress' in obj\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/lz-config-types",
-  "version": "3.0.15",
+  "version": "3.0.17",
   "description": "LayerZero Core Library",
   "license": "BUSL-1.1",
   "exports": {
@@ -23,20 +23,19 @@
     "clean-prebuild": "rimraf dist"
   },
   "dependencies": {
-    "@layerzerolabs/lz-core": "^3.0.15",
-    "@layerzerolabs/lz-definitions": "^3.0.15",
-    "@safe-global/protocol-kit": "^1.3.0",
-    "tiny-invariant": "^1.3.1"
+    "@layerzerolabs/lz-core": "^3.0.17",
+    "@layerzerolabs/lz-definitions": "^3.0.17",
+    "@safe-global/protocol-kit": "^1.3.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@layerzerolabs/tsup-config-next": "^3.0.15",
-    "@layerzerolabs/typescript-config-next": "^3.0.15",
+    "@layerzerolabs/tsup-config-next": "^3.0.17",
+    "@layerzerolabs/typescript-config-next": "^3.0.17",
     "@types/jest": "^29.5.10",
     "jest": "^29.7.0",
     "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1",
-    "tsup": "^8.0.1",
+    "tsup": "^8.3.5",
     "typescript": "~5.2.2"
   },
   "publishConfig": {