@layerzerolabs/lz-config-types 2.3.30

package/README.md

@@ -0,0 +1,8 @@
+# layerzero-core
+
+This package defines the core interface for the tooling stack, and only includes neutral interfaces unrelated to the LayerZero protocol.
+
+- `Transaction` Interface: Used to express transactions in different stages.
+- `Provider` Interface: Define the connectors to a chain node.
+- `Signer` Interface: Sign message and transaction.
+- `Deployment` interface: Represent the structure for deployment information

package/dist/index.cjs

@@ -0,0 +1,27 @@
+'use strict';
+
+// src/signer.ts
+function isGnosisItemConfig(obj) {
+  if (obj === void 0 || obj === null) {
+    return false;
+  }
+  return typeof obj === "object" && "safeUrl" in obj && "safeAddress" in obj;
+}
+function isCombinedGnosisItemConfig(obj) {
+  if (obj === void 0 || obj === null) {
+    return false;
+  }
+  return typeof obj === "object" && "safeUrl" in obj && "safeAddress" in obj && ("mnemonic" in obj || "pk" in obj);
+}
+function isCombinedSquadsItemConfig(obj) {
+  if (obj === void 0 || obj === null) {
+    return false;
+  }
+  return typeof obj === "object" && "multisigAddress" in obj;
+}
+
+exports.isCombinedGnosisItemConfig = isCombinedGnosisItemConfig;
+exports.isCombinedSquadsItemConfig = isCombinedSquadsItemConfig;
+exports.isGnosisItemConfig = isGnosisItemConfig;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +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"]}

package/dist/index.d.mts

@@ -0,0 +1,82 @@
+import { Provider, Signer } from '@layerzerolabs/lz-core';
+import { Environment, Chain, ChainType, Stage } from '@layerzerolabs/lz-definitions';
+import { ContractNetworksConfig } from '@safe-global/protocol-kit';
+
+type ProviderSetting = {
+    url: string;
+    apiKey?: string;
+} | string;
+type ProviderConfig = {
+    [env in Environment]?: {
+        [chain in Chain]?: ProviderSetting;
+    };
+};
+interface ProviderManager {
+    getProvider(chain: Chain, env: Environment): Promise<Provider>;
+}
+
+type ContractNetworkConfig = ContractNetworksConfig[string];
+
+interface SignerItemConfig {
+    mnemonic?: string;
+    path?: string;
+    address?: string;
+    pk?: string;
+}
+interface GnosisItemConfig {
+    safeUrl: string;
+    safeAddress: string;
+    contractNetworks?: {
+        [key: string]: Partial<ContractNetworkConfig>;
+    };
+}
+interface SquadsItemConfig {
+    multisigAddress: string;
+}
+type GnosisStageConfig = {
+    [chainOrType in ChainType | Chain]?: {
+        [key: string]: GnosisItemConfig | SquadsItemConfig;
+    };
+};
+type GnosisConfig = {
+    [stage in Stage]?: GnosisStageConfig;
+};
+type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig;
+type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig;
+/**
+ * config by stage, chain, keyName
+ * example:
+ * ```json
+ * {
+ *  "sandbox": {
+ *    "ethereum": {
+ *      "key1": {
+ *        "mnemonic": "xxx",
+ *         "path": "xxx"
+ *       },
+ *      "key2": {
+ *        "pk": "xxx",
+ *        "path": "xxx"
+ *         safeUrl: "xxx",
+ *         safeAddress: "xxx"
+ *      }
+ *    }
+ *  }
+ * }
+ * ```
+ */
+type SignerConfig = {
+    [stage in Stage]?: {
+        [chainOrType in ChainType | Chain]?: {
+            [key: string]: SignerItemConfig | CombinedGnosisItemConfig | CombinedSquadsItemConfig;
+        };
+    };
+};
+interface SignerManager {
+    getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>;
+}
+declare function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig;
+declare function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig;
+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

@@ -0,0 +1,82 @@
+import { Provider, Signer } from '@layerzerolabs/lz-core';
+import { Environment, Chain, ChainType, Stage } from '@layerzerolabs/lz-definitions';
+import { ContractNetworksConfig } from '@safe-global/protocol-kit';
+
+type ProviderSetting = {
+    url: string;
+    apiKey?: string;
+} | string;
+type ProviderConfig = {
+    [env in Environment]?: {
+        [chain in Chain]?: ProviderSetting;
+    };
+};
+interface ProviderManager {
+    getProvider(chain: Chain, env: Environment): Promise<Provider>;
+}
+
+type ContractNetworkConfig = ContractNetworksConfig[string];
+
+interface SignerItemConfig {
+    mnemonic?: string;
+    path?: string;
+    address?: string;
+    pk?: string;
+}
+interface GnosisItemConfig {
+    safeUrl: string;
+    safeAddress: string;
+    contractNetworks?: {
+        [key: string]: Partial<ContractNetworkConfig>;
+    };
+}
+interface SquadsItemConfig {
+    multisigAddress: string;
+}
+type GnosisStageConfig = {
+    [chainOrType in ChainType | Chain]?: {
+        [key: string]: GnosisItemConfig | SquadsItemConfig;
+    };
+};
+type GnosisConfig = {
+    [stage in Stage]?: GnosisStageConfig;
+};
+type CombinedGnosisItemConfig = GnosisItemConfig & SignerItemConfig;
+type CombinedSquadsItemConfig = SquadsItemConfig & SignerItemConfig;
+/**
+ * config by stage, chain, keyName
+ * example:
+ * ```json
+ * {
+ *  "sandbox": {
+ *    "ethereum": {
+ *      "key1": {
+ *        "mnemonic": "xxx",
+ *         "path": "xxx"
+ *       },
+ *      "key2": {
+ *        "pk": "xxx",
+ *        "path": "xxx"
+ *         safeUrl: "xxx",
+ *         safeAddress: "xxx"
+ *      }
+ *    }
+ *  }
+ * }
+ * ```
+ */
+type SignerConfig = {
+    [stage in Stage]?: {
+        [chainOrType in ChainType | Chain]?: {
+            [key: string]: SignerItemConfig | CombinedGnosisItemConfig | CombinedSquadsItemConfig;
+        };
+    };
+};
+interface SignerManager {
+    getSigner(chain: Chain, stage: Stage, env: Environment, keyName: string): Promise<Signer>;
+}
+declare function isGnosisItemConfig(obj: unknown): obj is GnosisItemConfig;
+declare function isCombinedGnosisItemConfig(obj: unknown): obj is CombinedGnosisItemConfig;
+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

@@ -0,0 +1,23 @@
+// src/signer.ts
+function isGnosisItemConfig(obj) {
+  if (obj === void 0 || obj === null) {
+    return false;
+  }
+  return typeof obj === "object" && "safeUrl" in obj && "safeAddress" in obj;
+}
+function isCombinedGnosisItemConfig(obj) {
+  if (obj === void 0 || obj === null) {
+    return false;
+  }
+  return typeof obj === "object" && "safeUrl" in obj && "safeAddress" in obj && ("mnemonic" in obj || "pk" in obj);
+}
+function isCombinedSquadsItemConfig(obj) {
+  if (obj === void 0 || obj === null) {
+    return false;
+  }
+  return typeof obj === "object" && "multisigAddress" in obj;
+}
+
+export { isCombinedGnosisItemConfig, isCombinedSquadsItemConfig, isGnosisItemConfig };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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"]}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@layerzerolabs/lz-config-types",
+  "version": "2.3.30",
+  "description": "LayerZero Core Library",
+  "license": "BUSL-1.1",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts",
+      "require": "./src/index.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "$npm_execpath clean-prebuild && $npm_execpath build-ts",
+    "build-ts": "$npm_execpath tsc --noEmit && $npm_execpath tsup",
+    "clean": "$npm_execpath clean-prebuild && rimraf .turbo",
+    "clean-prebuild": "rimraf dist"
+  },
+  "dependencies": {
+    "@layerzerolabs/lz-core": "workspace:^",
+    "@layerzerolabs/lz-definitions": "workspace:^",
+    "@safe-global/protocol-kit": "^1.3.0",
+    "tiny-invariant": "^1.3.1"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@layerzerolabs/tsup-config-next": "workspace:^",
+    "@layerzerolabs/typescript-config-next": "workspace:^",
+    "@types/jest": "^29.5.10",
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "tsup": "^8.0.1",
+    "typescript": "~5.2.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.mjs",
+        "require": "./dist/index.cjs"
+      },
+      "./package.json": "./package.json"
+    },
+    "main": "./dist/index.cjs",
+    "types": "./dist/index.d.ts"
+  }
+}