update sdk

ntduan · ntduan · commit a7aafcb6df18 · 2025-07-02T12:12:40.000+12:00
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,63 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+          
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+          
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: latest
+          
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+          
+      - name: Setup pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+            
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+        
+      - name: Build SDK
+        run: |
+          cd sdk
+          pnpm build
+          
+      - name: Run tests
+        run: |
+          cd sdk
+          pnpm test
+          
+      - name: Publish to npm
+        run: |
+          cd sdk
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 
diff --git a/README.md b/README.md
@@ -5,16 +5,53 @@ A TypeScript SDK for interacting with PolkaVM Query (PVQ)
 ## Installation
 
 ```bash
+# Install the published package
+npm install @open-web3/pvq
+# or
+yarn add @open-web3/pvq
+# or
+pnpm add @open-web3/pvq
+
+# Or install from source
 pnpm add pvq-sdk
 ```
 
+## Quick Start
+
+```typescript
+import { ApiPromise } from '@polkadot/api';
+import { PvqProgram } from '@open-web3/pvq';
+
+// Connect to a Polkadot node
+const api = await ApiPromise.create({
+  provider: 'ws://localhost:9944'
+});
+
+// Create PVQ program instance
+const program = new PvqProgram(
+  api,
+  guestProgramBytes, // Uint8Array or hex string
+  programMetadata    // Program metadata object
+);
+
+// Execute a query
+const result = await program.entrypoint.sumBalance([
+  21, 
+  ['15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5']
+], { 
+  gasLimit: 1000000000000000000n 
+});
+
+console.log('Query result:', result);
+```
+
 ## Usage Examples
 
 ### Basic Program Execution
 
 ```typescript
 import { ApiPromise, WsProvider } from '@polkadot/api';
-import { PvqProgram } from 'pvq-sdk';
+import { PvqProgram } from '@open-web3/pvq';
 
 async function executeProgram() {
   const provider = new WsProvider('ws://127.0.0.1:8000');
@@ -60,7 +97,7 @@ const result = await program.executeQuery('sum_balance', { gasLimit: 1000000n },
 
 ```typescript
 // Fetch metadata from the chain
-const metadata = await program.metadata();
+const metadata = await program.getMetadata();
 console.log('Chain metadata:', metadata);
 ```
 
@@ -75,6 +112,33 @@ console.log('Extensions matched:', matched); // true or throws error if not matc
 console.log('Cached result:', program.extensionsMatched); // true/false/undefined
 ```
 
+## API Reference
+
+### PvqProgram
+
+Main class for interacting with PVQ programs.
+
+#### Constructor
+
+```typescript
+new PvqProgram(
+  api: ApiBase<ApiTypes>,
+  guestProgram: Uint8Array | `0x${string}`,
+  programMetadata: Record<string, unknown>
+)
+```
+
+#### Methods
+
+- `executeQuery(entrypoint, options, params)` - Execute a query on the program
+- `checkExtensions()` - Check if required extensions are available
+- `getMetadata()` - Get runtime metadata
+
+#### Properties
+
+- `entrypoint` - Object containing all available entrypoints as camelCase methods
+- `extensionsMatched` - Boolean indicating if extensions check passed
+
 ## Program Metadata Format
 
 Your program metadata should follow this structure:
diff --git a/sdk/.npmignore b/sdk/.npmignore
@@ -0,0 +1,32 @@
+# Source files
+src/
+*.ts
+*.tsx
+
+# Build artifacts
+*.map
+dist/**/*.map
+
+# Test files
+*.test.js
+*.test.d.ts
+**/*.test.*
+
+# Development files
+.git/
+.gitignore
+.eslintrc*
+.prettierrc*
+tsconfig*.json
+build.cjs
+bun.lockb
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db 
diff --git a/sdk/README.md b/sdk/README.md
@@ -0,0 +1,85 @@
+# @open-web3/pvq
+
+PVQ (Programmable Virtual Query) SDK for Polkadot ecosystem
+
+## Installation
+
+```bash
+npm install @open-web3/pvq
+# or
+yarn add @open-web3/pvq
+# or
+pnpm add @open-web3/pvq
+```
+
+## Usage
+
+```typescript
+import { ApiPromise } from '@polkadot/api';
+import { PvqProgram } from '@open-web3/pvq';
+
+// Connect to a Polkadot node
+const api = await ApiPromise.create({
+  provider: 'ws://localhost:9944'
+});
+
+// Create PVQ program instance
+const program = new PvqProgram(
+  api,
+  guestProgramBytes, // Uint8Array or hex string
+  programMetadata    // Program metadata object
+);
+
+// Execute a query
+const result = await program.entrypoint.sumBalance([
+  21, 
+  ['15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5']
+], { 
+  gasLimit: 1000000000000000000n 
+});
+
+console.log('Query result:', result);
+```
+
+## API Reference
+
+### PvqProgram
+
+Main class for interacting with PVQ programs.
+
+#### Constructor
+
+```typescript
+new PvqProgram(
+  api: ApiBase<ApiTypes>,
+  guestProgram: Uint8Array | `0x${string}`,
+  programMetadata: Record<string, unknown>
+)
+```
+
+#### Methods
+
+- `executeQuery(entrypoint, options, params)` - Execute a query on the program
+- `checkExtensions()` - Check if required extensions are available
+- `getMetadata()` - Get runtime metadata
+
+#### Properties
+
+- `entrypoint` - Object containing all available entrypoints as camelCase methods
+- `extensionsMatched` - Boolean indicating if extensions check passed
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the SDK
+cd sdk && pnpm build
+
+# Run tests
+pnpm test
+
+# Run linting
+pnpm lint
+```
diff --git a/sdk/build.cjs b/sdk/build.cjs
@@ -1,7 +1,12 @@
 import { build } from "esbuild";
 
 await build({
-  entryPoints: ["src/index.ts"],
+  entryPoints: [
+    "src/pvq.ts",
+    "src/program-registry.ts",
+    "src/types.ts",
+    "src/typesdef.ts"
+  ],
   outdir: "dist/esm",
   bundle: false,
   format: "esm",
@@ -11,7 +16,12 @@ await build({
 });
 
 await build({
-  entryPoints: ["src/index.ts"],
+  entryPoints: [
+    "src/pvq.ts",
+    "src/program-registry.ts",
+    "src/types.ts",
+    "src/typesdef.ts"
+  ],
   outdir: "dist/cjs",
   bundle: false,
   format: "cjs",
diff --git a/sdk/package.json b/sdk/package.json
@@ -1,26 +1,33 @@
 {
-  "name": "pvq-sdk",
+  "name": "@open-web3/pvq",
+  "version": "0.0.1",
   "type": "module",
   "devDependencies": {
     "@types/bun": "latest",
     "esbuild": "^0.25.2",
     "prettier": "^3.5.3",
     "eslint": "^9.0.0"
   },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "types": "dist/types/index.d.ts",
+  "main": "dist/cjs/pvq.js",
+  "module": "dist/esm/pvq.js",
+  "types": "dist/types/pvq.d.ts",
   "exports": {
-    "require": "./dist/cjs/index.js",
-    "import": "./dist/esm/index.js"
+    "require": "./dist/cjs/pvq.js",
+    "import": "./dist/esm/pvq.js"
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
     "test": "bun test",
     "build": "bun run build:js && bun run build:types",
     "build:js": "bun run build.cjs",
     "build:types": "tsc -p tsconfig.types.json",
     "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint src/**/*.ts --fix"
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "prepublishOnly": "pnpm build",
+    "clean": "rm -rf dist"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
diff --git a/sdk/tsconfig.types.json b/sdk/tsconfig.types.json
@@ -3,7 +3,17 @@
     "emitDeclarationOnly": true,
     "declaration": true,
     "outDir": "dist/types",
-    "strict": true
+    "strict": true,
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "downlevelIteration": true,
+    "lib": ["ES2020", "DOM"]
   },
-  "include": ["src"]
+  "include": ["src"],
+  "exclude": ["src/**/*.test.ts"]
 }
