Merge pull request #60 from autonomys/fix-rpc-listen

update: type safe RPC APIs

Author: clostao

Makefile

@@ -0,0 +1,16 @@
+build:
+	yarn build
+
+models:
+	yarn models build
+rpc:
+	yarn rpc build
+
+common: models rpc
+
+indexer: common
+	yarn indexer build
+
+file-retriever: common
+	yarn file-retriever build
+

common/models/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@auto-files/models",
+  "version": "0.0.1",
+  "packageManager": "[email protected]",
+  "type": "module",
+  "dependencies": {
+    "@autonomys/rpc": "^1.4.9",
+    "zod": "^3.24.2"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  }
+}

common/models/src/index.ts

@@ -0,0 +1 @@
+export * from './mapping.js'

services/object-mapping-indexer/src/models/mapping.ts renamed to common/models/src/mapping.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "baseUrl": "src",
+    "paths": {
+      "*": ["*"]
+    },
+    "strict": true,
+    "allowJs": true,
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

common/models/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "name": "@auto-files/rpc-apis",
+  "version": "0.0.1",
+  "packageManager": "[email protected]",
+  "type": "module",
+  "dependencies": {
+    "@auto-files/models": "workspace:*",
+    "@autonomys/rpc": "^1.4.11",
+    "zod": "^3.24.2"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  }
+}

common/rpc-apis/package.json

@@ -0,0 +1,2 @@
+export * from './objectMappingIndexer.js'
+export * from './subspaceObjectListener.js'

common/rpc-apis/src/index.ts

@@ -0,0 +1,43 @@
+import { defineUnvalidatedType, createApiDefinition } from '@autonomys/rpc'
+import { z } from 'zod'
+import { ObjectMapping } from '@auto-files/models'
+
+export const ObjectMappingIndexerRPCApi = createApiDefinition({
+  methods: {
+    subscribe_object_mappings: {
+      params: defineUnvalidatedType<void>(),
+      returns: z.object({
+        subscriptionId: z.string(),
+      }),
+    },
+    unsubscribe_object_mappings: {
+      params: z.object({
+        subscriptionId: z.string(),
+      }),
+      returns: z.object({
+        success: z.boolean(),
+      }),
+    },
+    subscribe_recover_object_mappings: {
+      params: z.object({
+        pieceIndex: z.number(),
+      }),
+      returns: z.object({
+        subscriptionId: z.string(),
+      }),
+    },
+    unsubscribe_recover_object_mappings: {
+      params: z.object({
+        subscriptionId: z.string(),
+      }),
+      returns: z.object({
+        success: z.boolean(),
+      }),
+    },
+  },
+  notifications: {
+    object_mapping_list: {
+      content: defineUnvalidatedType<ObjectMapping[]>(),
+    },
+  },
+})

common/rpc-apis/src/objectMappingIndexer.ts

@@ -0,0 +1,22 @@
+import { ObjectMappingListEntry } from '@auto-files/models'
+import { createApiDefinition, defineUnvalidatedType } from '@autonomys/rpc'
+
+type SubscriptionResult<T> = {
+  subscriptionId: string
+  result: T
+}
+
+export const SubspaceObjectListenerAPI = createApiDefinition({
+  methods: {
+    subspace_subscribeObjectMappings: {
+      params: defineUnvalidatedType<void>(),
+      returns: defineUnvalidatedType<string>(),
+    },
+  },
+  notifications: {
+    subspace_object_mappings: {
+      content:
+        defineUnvalidatedType<SubscriptionResult<ObjectMappingListEntry>>(),
+    },
+  },
+})

common/rpc-apis/src/subspaceObjectListener.ts

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "baseUrl": "src",
+    "paths": {
+      "*": ["*"]
+    },
+    "strict": true,
+    "allowJs": true,
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}