Merge pull request #285 from ckb-cell/release/0.6.0

Merge release/0.6.0 to main branch

Author: ShookLyngs

.eslintrc.json

@@ -3,6 +3,7 @@
     "browser": true,
     "es2021": true
   },
+  "ignorePatterns": ["dist/"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended"

.github/workflows/integration-test.yaml

@@ -29,12 +29,12 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20.x
+          node-version: 21
 
       - uses: pnpm/action-setup@v3
         name: Install -g pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
       - name: Install dependencies

.github/workflows/release.yml

@@ -23,12 +23,12 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 21
 
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
       - name: Get pnpm store directory

.github/workflows/snapshot.yml

@@ -22,12 +22,12 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 21
 
       - uses: pnpm/action-setup@v3
         name: Install pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
       - name: Get pnpm store directory

.github/workflows/test.yaml

@@ -19,12 +19,12 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20.x
+          node-version: 21
 
       - uses: pnpm/action-setup@v3
         name: Install -g pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
       - name: Get pnpm store directory
@@ -47,11 +47,16 @@ jobs:
         run: pnpm run build:packages
 
       - name: Lint packages
-        run: pnpm run lint:packages
+        run: pnpm run lint
 
-      - name: Run tests for packages
+      - name: Run unit tests for the packages
         run: pnpm run test:packages
         env:
+          VITE_CKB_NODE_URL: https://testnet.ckb.dev/rpc
+          VITE_CKB_INDEXER_URL: https://testnet.ckb.dev/indexer
           VITE_BTC_SERVICE_URL: https://btc-assets-api.testnet.mibao.pro
           VITE_BTC_SERVICE_TOKEN: ${{ secrets.TESTNET_SERVICE_TOKEN }}
           VITE_BTC_SERVICE_ORIGIN: https://btc-assets-api.testnet.mibao.pro
+
+      - name: Run unit tests for the rgbpp-sdk-service
+        run: pnpm run test:service

README.md

@@ -63,7 +63,8 @@ This repository offers utilities for Bitcoin and RGB++ asset integration.
 
 ### Notes
 
-- `Bitcoin/RGB++ Assets Service` is designed to streamline the transaction workflow. Developers have the option to implement its features by themselves without limitation.
+- [`Bitcoin/RGB++ Assets Service`](https://github.com/ckb-cell/btc-assets-api) is an open-source project designed to streamline the transaction workflow for Bitcoin and RGB++ Assets. Developers have the option to enhance it by implementing its features by themselves without limitations. 
+- For those who prefer to deploy their own `Bitcoin/RGB++ Assets Service`, please follow the instructions at the [Deployment](https://github.com/ckb-cell/btc-assets-api#deployment) section in the btc-assets-api repository.
 
 
 ## FAQ

apps/service/package.json

@@ -1,10 +1,7 @@
 {
   "name": "rgbpp-sdk-service",
   "version": "0.0.1",
-  "description": "",
-  "author": "",
   "private": true,
-  "license": "UNLICENSED",
   "scripts": {
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\"",
@@ -14,54 +11,40 @@
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/src/main",
     "lint": "eslint \"src/**/*.ts\" --fix",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "test:cov": "vitest run --coverage",
+    "test:debug": "vitest --inspect-brk --inspect --logHeapUsage --threads=false"
   },
   "dependencies": {
     "@nestjs/common": "^10.0.0",
     "@nestjs/config": "^3.2.2",
     "@nestjs/core": "^10.3.9",
     "@nestjs/platform-fastify": "^10.3.9",
-    "convert-keys": "^1.3.4",
+    "camelcase-keys": "^7.0.2",
     "json-rpc-2.0": "^1.7.0",
+    "lodash": "^4.17.21",
     "reflect-metadata": "^0.2.0",
     "rgbpp": "workspace:*",
     "rxjs": "^7.8.1",
+    "snakecase-keys": "^8.0.1",
     "zod": "^3.23.8"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.0.0",
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
-    "@types/jest": "^29.5.2",
+    "@swc/core": "^1.7.11",
     "@types/node": "^20.3.1",
     "@types/supertest": "^6.0.0",
+    "@vitest/coverage-v8": "^2.0.5",
     "source-map-support": "^0.5.21",
     "supertest": "^6.3.3",
-    "ts-jest": "^29.1.0",
     "ts-loader": "^9.4.3",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.1.3"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
+    "type-fest": "^4.24.0",
+    "typescript": "^5.1.3",
+    "unplugin-swc": "^1.5.1"
   }
 }

apps/service/src/app.module.ts

@@ -1,17 +1,18 @@
 import { Global, Module } from '@nestjs/common';
 import { ConfigModule, ConfigService } from '@nestjs/config';
+import { BtcAssetsApi } from 'rgbpp/service';
+import { BTCTestnetType, Collector } from 'rgbpp/ckb';
 import JsonRpcModule from './json-rpc/json-rpc.module';
 import { RgbppModule } from './rgbpp/rgbpp.module';
 import { AppService } from './app.service';
 import { envSchema } from './env';
-import { BTCTestnetType, Collector } from 'rgbpp/ckb';
-import { BtcAssetsApi } from 'rgbpp';
 
 @Global()
 @Module({
   imports: [
     ConfigModule.forRoot({
       validate: envSchema.parse,
+      envFilePath: ['.env', '.env.local'],
     }),
     JsonRpcModule.forRoot({
       path: '/json-rpc',
@@ -31,7 +32,7 @@ import { BtcAssetsApi } from 'rgbpp';
       inject: [ConfigService],
     },
     {
-      provide: 'COLLECTOR',
+      provide: 'CKB_COLLECTOR',
       useFactory: (configService: ConfigService) => {
         const ckbRpcUrl = configService.get('CKB_RPC_URL');
         return new Collector({
@@ -52,6 +53,6 @@ import { BtcAssetsApi } from 'rgbpp';
       inject: [ConfigService],
     },
   ],
-  exports: ['IS_MAINNET', 'COLLECTOR', 'BTC_ASSETS_API', 'BTC_TESTNET_TYPE'],
+  exports: ['IS_MAINNET', 'CKB_COLLECTOR', 'BTC_ASSETS_API', 'BTC_TESTNET_TYPE'],
 })
 export class AppModule {}

apps/service/src/app.service.ts

@@ -1,5 +1,5 @@
-import { RpcHandler, RpcMethodHandler } from 'src/json-rpc/json-rpc.decorators';
-import * as pkg from '../package.json';
+import { RpcHandler, RpcMethodHandler } from './json-rpc/json-rpc.decorators.js';
+import pkg from '../package.json';
 
 @RpcHandler()
 export class AppService {

apps/service/src/json-rpc/json-rpc.server.ts

@@ -50,7 +50,7 @@ export class JsonRpcServer {
         }
         const name = metadata.name
           ? `${metadata.name}.${methodMetadata.name ?? methodName}`
-          : methodMetadata.name ?? methodName;
+          : (methodMetadata.name ?? methodName);
         const handler = (params: unknown) => {
           const instanceRef = this.moduleRef.get(instance.constructor, { strict: false });
           return instanceRef[methodName](params);