feat(networks): LIT-4101 - Define initial package structure/stubs for @lit-protocol/networks

MaximusHaximus · MaximusHaximus · commit 163e083d5c11 · 2025-02-10T21:44:57.000Z
diff --git a/local-tests/setup/networkContext.json b/local-tests/setup/networkContext.json
diff --git a/packages/networks/.babelrc b/packages/networks/.babelrc
@@ -0,0 +1,10 @@
+{
+  "presets": [
+    [
+      "@nx/web/babel",
+      {
+        "useBuiltIns": "usage"
+      }
+    ]
+  ]
+}
diff --git a/packages/networks/.eslintrc.json b/packages/networks/.eslintrc.json
@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}
diff --git a/packages/networks/README.md b/packages/networks/README.md
@@ -0,0 +1,9 @@
+# Quick Start
+
+This package contains network definitions for LIT protocol networks.  A network contains chain configuration and configuration used to control how consumers communicate with LIT Network nodes.
+
+### node.js / browser
+
+```
+yarn add @lit-protocol/networks
+```
diff --git a/packages/networks/index.ts b/packages/networks/index.ts
diff --git a/packages/networks/jest.config.ts b/packages/networks/jest.config.ts
@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: 'networks',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[t]s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/packages/networks',
+  setupFilesAfterEnv: ['../../jest.setup.js'],
+};
diff --git a/packages/networks/package.json b/packages/networks/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "@lit-protocol/networks",
+  "license": "MIT",
+  "homepage": "https://github.com/Lit-Protocol/js-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LIT-Protocol/js-sdk"
+  },
+  "keywords": [
+    "library"
+  ],
+  "bugs": {
+    "url": "https://github.com/LIT-Protocol/js-sdk/issues"
+  },
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public",
+    "directory": "../../dist/packages/networks"
+  },
+  "gitHead": "0d7334c2c55f448e91fe32f29edc5db8f5e09e4b",
+  "tags": [
+    "universal"
+  ],
+  "version": "8.0.0-alpha.0",
+  "main": "./dist/src/index.js",
+  "typings": "./dist/src/index.d.ts"
+}
diff --git a/packages/networks/project.json b/packages/networks/project.json
@@ -0,0 +1,35 @@
+{
+  "name": "networks",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/networks/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/networks",
+        "main": "packages/networks/src/index.ts",
+        "tsConfig": "packages/networks/tsconfig.lib.json",
+        "assets": ["packages/networks/*.md"],
+        "updateBuildableProjectDepsInPackageJson": true
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/networks/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/packages/networks"],
+      "options": {
+        "jestConfig": "packages/networks/jest.config.ts",
+        "passWithNoTests": true
+      }
+    }
+  },
+  "tags": []
+}
diff --git a/packages/networks/src/lib/LitNetwork.ts b/packages/networks/src/lib/LitNetwork.ts
@@ -0,0 +1,48 @@
+import { HTTP, HTTPS, LIT_ENDPOINT } from '@lit-protocol/constants';
+
+import type { LitChainConfig, LitNetworkConfig } from './types';
+
+export abstract class LitNetwork {
+  private readonly _name: string;
+  private readonly _chainConfig: LitChainConfig;
+  private readonly _endpoints: typeof LIT_ENDPOINT;
+  private readonly _httpProtocol: typeof HTTP | typeof HTTPS;
+  private readonly _options: unknown;
+
+  constructor(config: LitNetworkConfig) {
+    this._name = config.name;
+    this._chainConfig = config.chainConfig;
+    this._endpoints = config.endpoints;
+    this._httpProtocol = config.httpProtocol;
+    this._options = config.options;
+  }
+
+  get name() {
+    return this._name;
+  }
+
+  get endpoints() {
+    return this._endpoints;
+  }
+
+  get httpProtocol() {
+    return this._httpProtocol;
+  }
+
+  get options() {
+    return this._options;
+  }
+
+  get chainConfig() {
+    return this._chainConfig;
+  }
+
+  abstract createSignRequests(params: unknown): Promise<unknown>;
+  abstract handleSignResponses(params: unknown): Promise<unknown>;
+
+  abstract createDecryptRequests(params: unknown): Promise<unknown>;
+  abstract handleDecryptResponses(params: unknown): Promise<unknown>;
+
+  abstract createExecuteJsRequests(params: unknown): Promise<unknown>;
+  abstract handleExecuteJsResponses(params: unknown): Promise<unknown>;
+}
diff --git a/packages/networks/src/lib/chain/index.ts b/packages/networks/src/lib/chain/index.ts
@@ -0,0 +1 @@
+// Extract static methods for handling contract context and ABI/type inferrance into this folder
diff --git a/packages/networks/src/lib/networks/vDatil/index.ts b/packages/networks/src/lib/networks/vDatil/index.ts
@@ -0,0 +1 @@
+// Placeholder to show structure for multiple major network versions. Tree would mimic `vNaga` dir
diff --git a/packages/networks/src/lib/networks/vNaga/handlers/index.ts b/packages/networks/src/lib/networks/vNaga/handlers/index.ts
@@ -0,0 +1 @@
+// This directory to contain request handlers and response handlers that are identical for all naga-based networks
diff --git a/packages/networks/src/lib/networks/vNaga/naga-dev/handlers/index.ts b/packages/networks/src/lib/networks/vNaga/naga-dev/handlers/index.ts
@@ -0,0 +1,3 @@
+// TODO: Define request creator and response handlers in this folder; export object hash of them here for composition on to naga-dev object
+// TODO: Define local types.ts here just for these functions; they will be exposed using `Parameters<>` and `ReturnType<>` on the network object
+// Note that if handlers are the same for multiple networks, they can be defined in ../handlers or ../../handlers, and imported / composed on to each network they apply to
diff --git a/packages/networks/src/lib/networks/vNaga/naga-dev/index.ts b/packages/networks/src/lib/networks/vNaga/naga-dev/index.ts
@@ -0,0 +1,62 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { HTTPS, LIT_CHAINS, LIT_ENDPOINT } from '@lit-protocol/constants';
+import { _nagaDev } from '@lit-protocol/contracts';
+
+import { LitNetwork } from '../../../LitNetwork';
+
+import type { LitNetworkConfig } from '../../../types';
+
+export class NagaDev extends LitNetwork {
+  constructor(params: Partial<LitNetworkConfig>) {
+    // NOTE: only contractData is managed by network; LitChainClient must handle the full ContractContext as it needs to actually hit the chain
+    // to get contract addresses, and the LitNetwork doesn't use the chain directly
+    super({
+      name: 'naga-dev',
+      endpoints: LIT_ENDPOINT,
+      httpProtocol: HTTPS,
+      chainConfig: {
+        chain: LIT_CHAINS['yellowstone'],
+        contractData: _nagaDev.data.map((c) => ({
+          address: c.contracts[0].address_hash,
+          abi: c.contracts[0].ABI,
+          name: c.name,
+        })),
+      },
+      ...params,
+    });
+  }
+
+  // Note: Node selection logic happens in the createXXXRequest() methods, as it is network-specific
+
+  // TODO: Input: LitNodeClient.decrypt() params
+  // TODO: Output: LitNodeClient.sendCommandToNode() params array
+  async createDecryptRequests(params) {
+    return undefined;
+  }
+
+  // TODO: Input: Result from sending decrypt requests to all necessary nodes
+  // TODO: Output: LitNodeClient.decrypt() return value
+  async handleDecryptResponses(response) {
+    return {};
+  }
+
+  // TODO: LitNodeClient.executeJs() params
+  async createExecuteJsRequests(params) {
+    return undefined;
+  }
+
+  // TODO: LitNodeClient.executeJs() return value
+  async handleExecuteJsResponses(response) {
+    return {};
+  }
+
+  // TODO: LitNodeClient.pkpSign() params
+  async createSignRequests(params) {
+    return undefined;
+  }
+
+  // TODO: LitNodeClient.pkpSign() return value
+  async handleSignResponses(response) {
+    return {};
+  }
+}
diff --git a/packages/networks/src/lib/networks/vNaga/naga/handlers/index.ts b/packages/networks/src/lib/networks/vNaga/naga/handlers/index.ts
@@ -0,0 +1 @@
+// This directory to contain request/response handlers that are specific to mainnet naga; will compose from `../handlers/...` for shared handlers
diff --git a/packages/networks/src/lib/networks/vNaga/naga/index.ts b/packages/networks/src/lib/networks/vNaga/naga/index.ts
@@ -0,0 +1,62 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { HTTPS, LIT_CHAINS, LIT_ENDPOINT } from '@lit-protocol/constants';
+import { _nagaDev } from '@lit-protocol/contracts';
+
+import { LitNetwork } from '../../../LitNetwork';
+
+import type { LitNetworkConfig } from '../../../types';
+
+export class Naga extends LitNetwork {
+  constructor(params: Partial<LitNetworkConfig>) {
+    // NOTE: only contractData is managed by network; LitChainClient must handle the full ContractContext as it needs to actually hit the chain
+    // to get contract addresses, and the LitNetwork doesn't use the chain directly
+    super({
+      name: 'naga',
+      endpoints: LIT_ENDPOINT,
+      httpProtocol: HTTPS,
+      chainConfig: {
+        chain: LIT_CHAINS['yellowstone'],
+        contractData: _nagaDev.data.map((c) => ({
+          address: c.contracts[0].address_hash,
+          abi: c.contracts[0].ABI,
+          name: c.name,
+        })),
+      },
+      ...params,
+    });
+  }
+
+  // Note: Node selection logic happens in the createXXXRequest() methods, as it is network-specific
+
+  // TODO: Input: LitNodeClient.decrypt() params
+  // TODO: Output: LitNodeClient.sendCommandToNode() params array
+  async createDecryptRequests(params) {
+    return undefined;
+  }
+
+  // TODO: Input: Result from sending decrypt requests to all necessary nodes
+  // TODO: Output: LitNodeClient.decrypt() return value
+  async handleDecryptResponses(response) {
+    return {};
+  }
+
+  // TODO: LitNodeClient.executeJs() params
+  async createExecuteJsRequests(params) {
+    return undefined;
+  }
+
+  // TODO: LitNodeClient.executeJs() return value
+  async handleExecuteJsResponses(response) {
+    return {};
+  }
+
+  // TODO: LitNodeClient.pkpSign() params
+  async createSignRequests(params) {
+    return undefined;
+  }
+
+  // TODO: LitNodeClient.pkpSign() return value
+  async handleSignResponses(response) {
+    return {};
+  }
+}
diff --git a/packages/networks/src/lib/types.ts b/packages/networks/src/lib/types.ts
@@ -0,0 +1,19 @@
+import { LITEVMChain } from 'packages/constants/src/lib/constants/types';
+
+// TODO: These types can probably be moved into the `networks` package and only exposed by way of the `LitNetwork` if necessary
+import { LIT_ENDPOINT, HTTP, HTTPS } from '@lit-protocol/constants';
+
+import type { LitContract } from '@lit-protocol/types';
+
+export interface LitChainConfig {
+  chain: LITEVMChain;
+  contractData: LitContract[];
+}
+
+export interface LitNetworkConfig {
+  name: string;
+  chainConfig: LitChainConfig;
+  endpoints: typeof LIT_ENDPOINT;
+  httpProtocol: typeof HTTP | typeof HTTPS;
+  options?: unknown;
+}
diff --git a/packages/networks/tsconfig.json b/packages/networks/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}
diff --git a/packages/networks/tsconfig.lib.json b/packages/networks/tsconfig.lib.json
@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": []
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"]
+}
diff --git a/packages/networks/tsconfig.spec.json b/packages/networks/tsconfig.spec.json
@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"],
+    "allowJs": true
+  },
+  "include": ["jest.config.ts", "**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+// Extract static methods for handling contract context and ABI/type inferrance into this folder`