P-1499 Separate the types of client api (#3444)

* feat: initialize typescript-api package with type definitions for identity, omni and sidechain modules

* chore: remove client-api package and all related files

* rename

* fix name

* refactor: standardize metadata file paths and update package dependencies

* update pnpm-lock.yaml dependencies

* update client-api paths and metadata file locations across test scripts

* add pnpm generate step

* fix: change moduleResolution from Bundler to node in tsconfig.base.json

* update README

* style: format code with prettier and standardize indentation

* refactor: update import paths to use @heima-network/api-argument package

* refactor: update imports to use @heima-network/api-argument package instead of parachain-api in omni-excutor tests

* feat: extend CLI options and update metadata fetching in integration test script

* feat: add option to skip sidechain build and simplify integration test script

* feat: import trusted_operations types from identity module

* update imports from identity to omni module across test utils

* add identity and trusted_operations exports to omni

Author: 0xverin

tee-worker/client-api/.editorconfig

@@ -1,4 +1,19 @@
-build
-dist
-parachain-api/prepare-build/litentry-parachain-metadata.json
-sidechain-api/prepare-build/litentry-sidechain-metadata.json
+# Build outputs
+/dist
+/build
+
+# Generated files
+/src/*/build/
+/src/**/interfaces/**/*.ts
+!/src/**/interfaces/**/definitions.ts
+
+# Node modules
+node_modules
+
+# Metadata files
+metadata-*.json
+
+# IDE and OS files
+.DS_Store
+.idea
+.vscode

tee-worker/client-api/.gitignore

@@ -1,20 +1,24 @@
 ## Description
 
-Client-api of tee-worker
+Heima types augment for @polkadot/api
 
-## Purpose
+## Environment setup
 
-In order to enable the use of our parachain and sidechain types in client and other projects.
+- Install [nvm](https://github.com/nvm-sh/nvm)
 
-## Environment setup
+- Inside the repository, run
+
+  ```
+  nvm use
+  ```
 
--   Install [nvm](https://github.com/nvm-sh/nvm)
--   Inside the repository, run `nvm use` to set the correct Node version.
-    -   If the version is not installed, run `nvm install`.
+  to set the correct Node version.
+
+  - If the version is not installed, run `nvm install`.
 
 ## Installation
 
-```cd tee-worker/ts-tests
+```
 cd tee-worker/client-api
 nvm use
 corepack enable pnpm
@@ -23,21 +27,24 @@ pnpm install
 
 ## Type Generated
 
-Update parachain metadata: `pnpm --filter parachain-api run update-metadata` (requires the parachain is running)
-
-Update sidechain metadata: `pnpm --filter sidechain-api run update-metadata` (requires the worker is running)
+Update metadata: `pnpm load:metadata` or `pnpm load:metadata:identity` for specific directory
 
-Generate parachain type: `pnpm --filter parachain-api run build`
+Generate types:`pnpm generate`
 
-Generate sidechain type: `pnpm --filter sidechain-api run build`
+## Usage
 
-Alternatively, you can run `pnpm --run update-build` to do all things above in one go.
-
-## Test
-
-Once update the `client-api/parachain-api` or `client-api/sidechain-api`, all you need to do in the tee-worker/ts-tests is to re-install(run `pnpm install` in tee-worker/ts-tests) and then you can test directly.
+```
+pnpm run generate
+pnpm run build
+```
+- `import '@heima-network/api-augment/identity'` - applies Identity types and endpoint augmentation
+- `import '@heima-network/api-augment/omni'` - applies Omni types and endpoint augmentation
+- `import '@heima-network/api-augment/sidechain'` - applies Sidechain types and endpoint augmentation
 
 ## Publish
 
-1. [parachain-api](https://github.com/litentry/heima/blob/dev/tee-worker/identity/client-api/parachain-api/README.md#publish-new-versions)
-2. [sidechain-api](https://github.com/litentry/heima/blob/dev/tee-worker/identity/client-api/sidechain-api/README.md#publish-new-versions)
+```
+pnpm run generate
+pnpm run build
+pnpm run publish
+```

tee-worker/client-api/.prettierrc

@@ -1,17 +1,103 @@
 {
+    "name": "@heima-network/api-augment",
     "type": "module",
+    "description": "Heima types augment for @polkadot/api",
     "license": "ISC",
+    "author": "Heima dev",
+    "main": "./dist/identity/index.cjs",
+    "module": "./dist/identity/index.js",
+    "types": "./dist/identity/index.d.ts",
+    "version": "0.0.1",
+    "files": [
+        "dist",
+        "src",
+        "README.md"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/identity/index.d.ts",
+            "require": "./dist/identity/index.cjs",
+            "import": "./dist/identity/index.js"
+        },
+        "./identity": {
+            "types": "./dist/identity/index.d.ts",
+            "require": "./dist/identity/index.cjs",
+            "import": "./dist/identity/index.js"
+        },
+        "./omni": {
+            "types": "./dist/omni/index.d.ts",
+            "require": "./dist/omni/index.cjs",
+            "import": "./dist/omni/index.js"
+        },
+        "./sidechain": {
+            "types": "./dist/sidechain/index.d.ts",
+            "require": "./dist/sidechain/index.cjs",
+            "import": "./dist/sidechain/index.js"
+        }
+    },
+    "typesVersions": {
+        "*": {
+            "identity": [
+                "./dist/identity/index.d.ts"
+            ],
+            "omni": [
+                "./dist/omni/index.d.ts"
+            ],
+            "sidechain": [
+                "./dist/sidechain/index.d.ts"
+            ]
+        }
+    },
     "engines": {
         "node": ">=20.0.0"
     },
     "scripts": {
-        "update": "pnpm --filter parachain-api run update-metadata && pnpm --filter sidechain-api run update-metadata",
-        "build": "pnpm --filter parachain-api run build && pnpm --filter sidechain-api run build",
-        "build-parachain-api": "pnpm --filter parachain-api run build",
-        "update-build": "pnpm run update && pnpm run build",
-        "format": "pnpm run --recursive format",
-        "check-format": "pnpm run --recursive check-format",
-        "clean": "pnpm --filter parachain-api run clean && pnpm --filter sidechain-api run clean"
+        "clean": "rm -rf dist node_modules",
+        "generate": "pnpm generate:defs && pnpm generate:meta",
+        "load:metadata": "pnpm load:meta:identity && pnpm load:meta:identity && pnpm load:sidechain",
+        "load:metadata:identity": "curl -s -H \"Content-Type: application/json\" -d '{\"id\":\"1\", \"jsonrpc\":\"2.0\", \"method\": \"state_getMetadata\", \"params\":[]}' http://localhost:9944 > metadata-parachain.json",
+        "load:metadata:omni": "curl -s -H \"Content-Type: application/json\" -d '{\"id\":\"1\", \"jsonrpc\":\"2.0\", \"method\": \"state_getMetadata\", \"params\":[]}' http://localhost:9944 > metadata-parachain.json",
+        "load:metadata:sidechain": "../../identity/bin/litentry-cli print-sgx-metadata-raw > metadata-sidechain.json",
+        "generate:defs": "pnpm run generate:defs:identity && pnpm generate:defs:omni && pnpm generate:defs:sidechain",
+        "generate:defs:identity": "pnpm tsx node_modules/@polkadot/typegen/scripts/polkadot-types-from-defs.mjs --package @heima-network/api-augment/identity/interfaces --input ./src/identity/interfaces --endpoint ./metadata-parachain.json",
+        "generate:defs:omni": "pnpm tsx node_modules/@polkadot/typegen/scripts/polkadot-types-from-defs.mjs --package @heima-network/api-augment/omni/interfaces --input ./src/omni/interfaces --endpoint ./metadata-parachain.json",
+        "generate:defs:sidechain": "pnpm tsx node_modules/@polkadot/typegen/scripts/polkadot-types-from-defs.mjs --package @heima-network/api-augment/sidechain/interfaces --input ./src/sidechain/interfaces --endpoint ./metadata-sidechain.json",
+        "generate:meta": "pnpm run generate:meta:identity && pnpm generate:meta:omni && pnpm generate:meta:sidechain",
+        "generate:meta:identity": "pnpm tsx node_modules/@polkadot/typegen/scripts/polkadot-types-from-chain.mjs --endpoint ./metadata-parachain.json --package @heima-network/api-augment/identity/interfaces --output ./src/identity/interfaces",
+        "generate:meta:omni": "pnpm tsx node_modules/@polkadot/typegen/scripts/polkadot-types-from-chain.mjs --endpoint ./metadata-parachain.json --package @heima-network/api-augment/omni/interfaces --output ./src/omni/interfaces",
+        "generate:meta:sidechain": "pnpm tsx node_modules/@polkadot/typegen/scripts/polkadot-types-from-chain.mjs --endpoint ./metadata-sidechain.json --package @heima-network/api-augment/sidechain/interfaces --output ./src/sidechain/interfaces",
+        "build": "pnpm generate && tsup",
+        "publish": "pnpm generate && pnpm build && pnpm publish",
+        "format": "pnpm exec prettier --write .",
+        "check-format": "pnpm exec prettier --check .",
+        "lint": "tsc --noEmit --pretty",
+        "build-skip-sidechain": "pnpm generate:defs:identity && pnpm generate:defs:omni && pnpm generate:meta:identity && pnpm generate:meta:omni && SKIP_SIDECHAIN=true tsup"
+    },
+    "dependencies": {
+        "@polkadot/api": "*",
+        "@polkadot/api-augment": "*",
+        "@polkadot/api-base": "*",
+        "@polkadot/api-derive": "*",
+        "@polkadot/keyring": "^13.4.3",
+        "@polkadot/rpc-core": "*",
+        "@polkadot/types": "*",
+        "@polkadot/types-augment": "*",
+        "@polkadot/types-codec": "*",
+        "@polkadot/types-create": "*",
+        "@polkadot/types-known": "*",
+        "@polkadot/types-support": "*",
+        "@polkadot/typegen": "*",
+        "@types/node": "^20.4.4",
+        "prettier": "^2.8.3",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.1.0",
+        "tsx": "^4.19.3",
+        "@polkadot/util": "^13.4.3",
+        "@polkadot/util-crypto": "^13.4.3",
+        "tsup": "^8.4.0"
+    },
+    "publishConfig": {
+        "access": "public"
     },
     "packageManager": "pnpm@9.15.2"
 }