WIP: feat: start using zod for schema validation and type definitions

local-tests/tests/testPkpEthersWithEoaSessionSigsToSignWithAuthContext.ts

@@ -24,7 +24,6 @@ export const testPkpEthersWithEoaSessionSigsToSignWithAuthContext = async (
     pkpPubKey: alice.pkp.publicKey,
     litNodeClient: devEnv.litNodeClient,
     authContext: {
-      client: devEnv.litNodeClient,
       getSessionSigsProps: {
         authNeededCallback: async function (
           params: AuthCallbackParams

package.json

@@ -69,7 +69,9 @@
     "tslib": "^2.7.0",
     "tweetnacl": "^1.0.3",
     "tweetnacl-util": "^0.15.1",
-    "uint8arrays": "^4.0.3"
+    "uint8arrays": "^4.0.3",
+    "zod": "^3.23.8",
+    "zod-validation-error": "^3.4.0"
   },
   "devDependencies": {
     "@nrwl/devkit": "19.6.3",

packages/access-control-conditions-schemas/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

packages/access-control-conditions-schemas/README.md

@@ -0,0 +1,22 @@
+# Lit Protocol Access Control Condition definitions
+
+The Lit Protocol Access Control Condition definitions are a set of Zod schemas that define the conditions that can be used to control access to a resource.
+
+## Condition definition
+
+A condition definition is a Zod schema that defines a condition that can be used to control access to a resource. More information can be found in the [Lit Protocol Access Control Condition definition specification](https://developer.litprotocol.com/v3/sdk/access-control/condition-types/unified-access-control-conditions)
+
+## Condition types
+
+The following condition types are defined:
+
+- EVM Basic Conditions
+- EVM Custom Contract Conditions
+- Solana RPC Conditions
+- Cosmos or Kyve Conditions
+
+Each has its own Zod schema that defines their properties.
+
+## Derived types
+
+Each condition type has a derived type that can be used to type the condition object when using Typescript.

packages/access-control-conditions-schemas/jest.config.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+export default {
+  displayName: 'access-control-conditions-schemas',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[t]s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory:
+    '../../coverage/packages/access-control-conditions-schemas',
+  setupFilesAfterEnv: ['../../jest.setup.js'],
+};

packages/access-control-conditions-schemas/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@lit-protocol/access-control-conditions-schemas",
+  "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"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "../../dist/packages/access-control-conditions-schemas"
+  },
+  "gitHead": "0d7334c2c55f448e91fe32f29edc5db8f5e09e4b",
+  "tags": [
+    "universal"
+  ],
+  "version": "7.0.0-alpha.8",
+  "main": "./dist/src/index.js",
+  "typings": "./dist/src/index.d.ts"
+}

packages/access-control-conditions-schemas/project.json

@@ -0,0 +1,56 @@
+{
+  "name": "access-control-conditions-schemas",
+  "$schema": "../../node_modules/nx/access-control-conditions-schemas/project-schema.json",
+  "sourceRoot": "packages/access-control-conditions-schemas/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/access-control-conditions-schemas",
+        "main": "packages/access-control-conditions-schemas/src/index.ts",
+        "tsConfig": "packages/access-control-conditions-schemas/tsconfig.lib.json",
+        "assets": ["packages/access-control-conditions-schemas/*.md"],
+        "updateBuildableProjectDepsInPackageJson": true
+      }
+    },
+    "generateDoc": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "yarn typedoc --entryPointStrategy expand packages/access-control-conditions-schemas/src --exclude packages/access-control-conditions-schemas/src/**/*.spec.** --tsconfig packages/access-control-conditions-schemas/tsconfig.json"
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "packages/access-control-conditions-schemas/**/*.ts"
+        ]
+      }
+    },
+    "testPackage": {
+      "executor": "@nx/jest:jest",
+      "outputs": [
+        "{workspaceRoot}/coverage/packages/access-control-conditions-schemas"
+      ],
+      "options": {
+        "jestConfig": "packages/access-control-conditions-schemas/jest.config.ts",
+        "passWithNoTests": true
+      }
+    },
+    "testWatch": {
+      "executor": "@nx/jest:jest",
+      "outputs": [
+        "{workspaceRoot}/coverage/packages/access-control-conditions-schemas"
+      ],
+      "options": {
+        "jestConfig": "packages/access-control-conditions-schemas/jest.config.ts",
+        "passWithNoTests": true,
+        "watch": true
+      }
+    }
+  },
+  "tags": []
+}

packages/access-control-conditions-schemas/src/index.ts

@@ -0,0 +1,6 @@
+export * from './lib/access-control-conditions';
+export * from './lib/AtomAcc';
+export * from './lib/EvmBasicAcc';
+export * from './lib/EvmContractAcc';
+export * from './lib/OperatorAcc';
+export * from './lib/SolAcc';

packages/access-control-conditions-schemas/src/lib/AtomAcc.spec.ts

@@ -0,0 +1,41 @@
+import { AtomAccSchema } from './AtomAcc';
+
+describe('AtomAccSchema', () => {
+  const validAtomAcc = {
+    conditionType: 'cosmos',
+    path: '/cosmos/bank/v1beta1/balances/:userAddress',
+    chain: 'cosmos',
+    returnValueTest: {
+      key: '$.balances[0].amount',
+      comparator: '>=',
+      value: '1000000',
+    },
+  };
+
+  it('should validate a valid Atom access control condition', () => {
+    expect(AtomAccSchema.safeParse(validAtomAcc).success).toBeTruthy();
+  });
+
+  it('should not validate an invalid Atom access control condition', () => {
+    expect(
+      AtomAccSchema.safeParse({
+        ...validAtomAcc,
+        path: undefined,
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      AtomAccSchema.safeParse({
+        ...validAtomAcc,
+        chain: 'invalidChain',
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      AtomAccSchema.safeParse({
+        ...validAtomAcc,
+        returnValueTest: undefined,
+      }).success
+    ).toBeFalsy();
+  });
+});

packages/access-control-conditions-schemas/src/lib/AtomAcc.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+import { ChainEnumAtom, ReturnValueTestSchema } from './common';
+
+export const AtomAccSchema = z
+  .object({
+    conditionType: z.literal('cosmos').optional(),
+    path: z.string(),
+    chain: ChainEnumAtom,
+    method: z.string().optional(),
+    parameters: z.array(z.string()).optional(),
+    returnValueTest: ReturnValueTestSchema,
+  })
+  .strict();
+
+export type AtomAcc = z.infer<typeof AtomAccSchema>;

packages/access-control-conditions-schemas/src/lib/EvmBasic.spec.ts

@@ -0,0 +1,70 @@
+import { EvmBasicAccSchema } from './EvmBasicAcc';
+
+describe('EvmBasicAccSchema', () => {
+  const validEVMBasicAcc = {
+    conditionType: 'evmBasic',
+    contractAddress: '0x50D8EB685a9F262B13F28958aBc9670F06F819d9',
+    standardContractType: 'MolochDAOv2.1',
+    chain: 'ethereum',
+    method: 'members',
+    parameters: [':userAddress'],
+    returnValueTest: {
+      comparator: '=',
+      value: 'true',
+    },
+  };
+
+  it('should validate a valid EVM basic access control condition', () => {
+    expect(EvmBasicAccSchema.safeParse(validEVMBasicAcc).success).toBeTruthy();
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        conditionType: undefined,
+      }).success
+    ).toBeTruthy();
+  });
+
+  it('should not validate an invalid EVM basic access control conditions', () => {
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        chain: 'invalidChain',
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        chain: undefined,
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        chain: 1,
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        method: undefined,
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        contractAddress: undefined,
+      }).success
+    ).toBeFalsy();
+
+    expect(
+      EvmBasicAccSchema.safeParse({
+        ...validEVMBasicAcc,
+        standardContractType: undefined,
+      }).success
+    ).toBeFalsy();
+  });
+});

packages/access-control-conditions-schemas/src/lib/EvmBasicAcc.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+
+import { EvmChainEnum, ReturnValueTestSchema } from './common';
+
+const StandardContractTypeEnum = z.enum([
+  '',
+  'ERC20',
+  'ERC721',
+  'ERC721MetadataName',
+  'ERC1155',
+  'CASK',
+  'Creaton',
+  'POAP',
+  'timestamp',
+  'MolochDAOv2.1',
+  'ProofOfHumanity',
+  'SIWE',
+  'PKPPermissions',
+  'LitAction',
+]);
+
+export const EvmBasicAccSchema = z
+  .object({
+    conditionType: z.literal('evmBasic').optional(),
+    contractAddress: z.string(),
+    chain: EvmChainEnum,
+    standardContractType: StandardContractTypeEnum,
+    method: z.string(),
+    parameters: z.array(z.string()),
+    returnValueTest: ReturnValueTestSchema.omit({ key: true }),
+  })
+  .strict();
+
+export type EvmBasicAcc = z.infer<typeof EvmBasicAccSchema>;