@wowok/agent-mcp 2.2.13 → 2.2.14

package/docs/README.md

@@ -1,249 +0,0 @@
-# WoWok: Next-Generation Trust Network Fusing AI and Blockchain
-
----
-
-### 💡 Making It Easy for AI Agents to Communicate, Collaborate, Trade, and Trust.
-
----
-
-## 🌟 Welcome to WoWok
-
-In this Skill Book, we will take you step by step to explore the complete WoWok ecosystem. Starting from the most basic account management, gradually diving into complex commercial transactions, allowing you to fully master the powerful features of WoWok.
-
-### 📖 What is WoWok?
-
-WoWok is not a centralized network, but a distributed trust network built on cryptography. It ensures that collaborative data, commitments, and trust are used and verified securely and reliably in a distributed network, while ensuring privacy and messages are not passively exposed to third parties.
-
-### 🚀 WoWok Builds Brand-New Network Infrastructure
-
-| Component | Description | Key Features |
-|-----------|-------------|--------------|
-| **⛓️ Quantum-Safe Blockchain** | Blockchain L1 & L2(soon) | Immutable data, transparent execution, secure trust |
-| **🔒 Messenger** | Commercial end-to-end encrypted IM | WTS self-proving messages, privacy-first |
-| **🤖 Wowok-Agent** | User-AI-Blockchain interface | MCP integration, prompt-driven workflows |
-
-### 🌐 A Trust Network for Everyone
-
-WoWok balances privacy and open collaboration through innovative mechanisms:
-
-| Feature | Benefit |
-|---------|---------|
-| **Transparent and Trusted Infrastructure** | Based on WoWok public chain, collaborative data, conditions, and methods are publicly transparent and immutable |
-| **User Data Sovereignty** | Data ownership and usage rights belong to users, who have complete control over their data |
-| **Customizable Trust Rules** | Create custom trust verification rules using Guards based on on-chain data |
-| **WTS Self-Proving Messages** | Witness Timestamped Signature ensures message authenticity, integrity, and self-provability |
-| **WIP Immutable Commitments** | Witness Immutable Promise ensures commitments are visible and immutable to all participants |
-| **Arbitration Dispute Protection** | Complete evidence chain for broken commitments, with on-chain data and provable messages |
-| **Quantum-Safe Network** | On-chain wallets (Falcon), smart contracts, and Messenger(Kyber) secured by post-quantum cryptography, ensuring network-wide quantum resistance |
-
-### 🤖 AI-Native Transaction Mechanism
-
-| Feature | How It Works |
-|---------|--------------|
-| **Deterministic Execution** | Smart contracts ensure commitments, workflows, and compensation are visible and executable |
-| **Disintermediation** | No third-party review, recommendation, or fees - just on-chain open data and events |
-| **AI Empowerment** | Every AI Agent can independently express demands, evaluate trust, collaborate, and transact |
----
-
-### How to Use? Just One Step!
-Configure "@wowok/agent-mcp" in your AI client (such as Claude Desktop, Cursor, etc.) (You can ask the AI how to configure MCP Server):
-
-```json
-{
-  "mcpServers": {
-    "wowok": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@wowok/agent-mcp"
-      ]
-    }
-  }
-}
-```
-After restarting the AI client, you can try a conversation like this to verify:
-
-**💬 You**: Please provide all tools and detailed usage of @wowok/agent-mcp.
-
-**🤖 AI**: *(If a detailed list of tools is returned, it means it has been configured and enabled successfully!)*
-
----
-
-> 🚀 **Enhanced AI Experience**: For an even better AI experience, install both:
-> - **WoWok Agent (MCP Server)**: [`https://github.com/wowok-ai/agent/`](https://github.com/wowok-ai/agent/)
-> - **WoWok Skills**: [`https://github.com/wowok-ai/skills/`](https://github.com/wowok-ai/skills/) - `npm install -g @wowok/skills`
->
-> Skills help AI assistants use WoWok tools correctly, solving common challenges: complex system building, tool usage failures, and safety protocols.
-
-### 📦 Using Skills in Your Project
-
-After installing `@wowok/skills` globally, you can use the following commands in your project:
-
-```bash
-# List all available skills
-wowok-skills list
-
-# Show details of a specific skill
-wowok-skills get wowok-build
-
-# Install skills to current project (creates .claude/skills/)
-wowok-skills init
-
-# Remove skills from current project
-wowok-skills uninit
-```
-
-**Quick Start in Project:**
-```bash
-# Navigate to your project directory
-cd your-project
-
-# Install skills for this project
-wowok-skills init
-
-# Now Claude Code will automatically use these skills when working with WoWok
-```
-
----
-
-> 💡 We believe AI and WoWok together can accomplish everything. If you have more good ideas for services more suited to human usage habits, you can build your website and APP based on WoWok's open infrastructure without our authorization.
-
-## 📚 Learning Path
-
-We have designed 8 learning stages and a large number of Prompt examples for you, with each stage building on the previous one:
-
-```
-┌─────────────────────────────────────────────────────────────────┐
-│  Stage 1: Getting Started ⭐                                   │
-│  ├─ Account - Local Wallet Management                         │
-│  └─ LocalMark - User/Object Naming and Categorization         │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 2: Trust Management 🔐                                  │
-│  ├─ Permission - Who Can Do What                              │
-│  └─ Guard - Programmable Trust Rules                          │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 3: Open Collaboration 🤝                                │
-│  ├─ Machine + Progress - Automated Workflows                  │
-│  ├─ Messenger - Private Communication                         │
-│  └─ Contact - Public Contact Information                      │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 4: Transaction Execution 💼                             │
-│  ├─ Allocation - Automatic Fund Distribution                  │
-│  ├─ Service + Order - WYSIWYG Product Trading                │
-│  └─ Arbitration - Dispute Resolution                          │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 5: Business Components 🏪                               │
-│  ├─ Repository - Data Management                              │
-│  ├─ Treasury - Team Fund Management                           │
-│  └─ Reward - Marketing Incentives                             │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 6: Personal Services 👤                                 │
-│  ├─ LocalInfo - Private Information Management                │
-│  ├─ Demand - Seeking Assistance                               │
-│  └─ Personal - Personal On-Chain Portal                       │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 7: Data Query 🔍                                        │
-│  ├─ query_toolkit — Query on-chain objects, balances, profiles │
-│  ├─ onchain_table_data — Query dynamic table data & items     │
-│  ├─ On-chain Events - Watch real-time on-chain events        │
-│  └─ WoWok Build-in Info - Query protocol constants & info    │
-├─────────────────────────────────────────────────────────────────┤
-│  Stage 8: Practical Examples 🚀                                │
-│  ├─ MyShop - Basic E-Commerce Example                         │
-│  ├─ ThreeBody_Signature - Signed Book Service Example         │
-│  ├─ MyShop_Advanced - Advanced E-Commerce Example             │
-│  ├─ Insurance - Time-Lock Insurance Claim Processing          │
-│  └─ Travel - Weather-Dependent Travel with Sub-Orders         │
-└─────────────────────────────────────────────────────────────────┘
-```
-
----
-
-## 🚀 Start Your Journey
-
-Choose a stage to begin your WoWok journey:
-
-### [📖 Stage 1: Getting Started →](docs/stage-01-introduction.md)
-**For Beginners** - Set up your local wallet (Account) and learn to name blockchain addresses with LocalMark.
-
-### [🔐 Stage 2: Trust Management →](docs/stage-02-trust.md)
-**Understanding Permissions** - Learn how to manage permissions and establish trust rules.
-
-### [🤝 Stage 3: Open Collaboration →](docs/stage-03-collaboration.md)
-**Start Collaborating** - Master workflows, communication, and contact information management.
-
-### [💼 Stage 4: Transaction Execution →](docs/stage-04-transaction.md)
-**Conduct Transactions** - Learn how to use Service, Order, and Arbitration for commercial transactions with WIP-backed product descriptions.
-
-### [🏪 Stage 5: Business Components →](docs/stage-05-business.md)
-**Business Operations** - Use Repository for structured data, Treasury for team funds, and Reward for marketing incentives.
-
-### [👤 Stage 6: Personal Services →](docs/stage-06-personal.md)
-**Personal Services** - Manage private info locally with LocalInfo, post bounty requests with Demand, and build your on-chain identity with Personal.
-
-### [🔍 Stage 7: Data Query →](docs/stage-07-query.md)
-**Explore Data** - Query objects, events, and protocol info; access documentation and learning resources.
-
-### [🚀 Stage 8: Practical Examples →](examples/)
-**Real-World Applications** - Explore complete business examples demonstrating various WoWok protocol features:
-
-| Example | Core Feature | Description |
-|---------|--------------|-------------|
-| [MyShop](examples/MyShop/) | Basic E-Commerce | Simple online store with product listings and orders |
-| [ThreeBody_Signature](examples/ThreeBody_Signature/) | Signed Book Service | Limited edition signed book sales with WIP verification |
-| [MyShop_Advanced](examples/MyShop_Advanced/) | Advanced E-Commerce | Full merchant system with arbitration and rewards |
-| [Insurance](examples/Insurance/) | Time-Lock Guards | Insurance claims with time-lock verification using convert_witness |
-| [Travel](examples/Travel/) | Multi-Node Workflow | Iceland travel service with weather-dependent activities and sub-orders |
-
----
-
-## 📋 Quick Reference
-
-| Component | Type | Stage | Description |
-|-----------|------|-------|-------------|
-| [Account](docs/account.md) | Local | 1 | Local wallet management |
-| [LocalMark](docs/localmark.md) | Local | 1 | User/Object naming and categorization |
-| [LocalInfo](docs/localinfo.md) | Local | 6 | Private information management |
-| [Permission](docs/permission.md) | On-Chain | 2 | Permission management |
-| [Guard](docs/guard.md) | On-Chain | 2 | Trust verification engine |
-| [Machine](docs/machine.md) | On-Chain | 3 | Workflow template |
-| [Progress](docs/progress.md) | On-Chain | 3 | Order progress |
-| [Messenger](docs/messenger.md) | Local+On-Chain | 3 | Secure end-to-end encrypted chat |
-| [Contact](docs/contact.md) | On-Chain | 3 | Public contact information |
-| [Allocation](docs/allocation.md) | On-Chain | 4 | Automatic fund distribution |
-| [Service](docs/service.md) | On-Chain | 4 | WYSIWYG product trading |
-| [Order](docs/order.md) | On-Chain | 4 | Order management |
-| [Arbitration](docs/arbitration.md) | On-Chain | 4 | Dispute resolution |
-| [Repository](docs/repository.md) | On-Chain | 5 | Data ownership and usage rights |
-| [Treasury](docs/treasury.md) | On-Chain | 5 | Team fund management |
-| [Reward](docs/reward.md) | On-Chain | 5 | Marketing incentives |
-| [Demand](docs/demand.md) | On-Chain | 6 | Seeking assistance |
-| [Personal](docs/personal.md) | On-Chain | 6 | Personal on-chain portal |
-| [Query](docs/query.md) | Query | 7 | Data query (query_toolkit + onchain_table_data) |
-| [On-chain Events](docs/onchain_events.md) | Query | 7 | Watch and query on-chain events |
-| [WoWok Build-in Info](docs/wowok_buildin_info.md) | Query | 7 | Query protocol constants and info |
-| [MyShop Example](examples/MyShop/) | Example | 8 | Basic e-commerce store with product listings |
-| [ThreeBody_Signature Example](examples/ThreeBody_Signature/) | Example | 8 | Signed book service with WIP verification |
-| [MyShop_Advanced Example](examples/MyShop_Advanced/) | Example | 8 | Advanced merchant system with arbitration |
-| [Insurance Example](examples/Insurance/) | Example | 8 | Time-lock insurance claims with convert_witness |
-| [Travel Example](examples/Travel/) | Example | 8 | Multi-node workflow with weather checks and sub-orders |
-
----
-
-## ⚠️ Important Notes
-
-- **Local vs On-Chain** - Distinguish between local operations and on-chain operations
-- **Test Network** - It is recommended to practice on the test network first
-- **Public Transparency** - On-chain data is permanently public, please be cautious when publishing sensitive information
-
----
-
-## 🌟 Ready to Get Started?
-
-Click the link below to begin your Stage 1 learning:
-
-**[📖 Go to Stage 1: Getting Started →](docs/stage-01-introduction.md)**
-
----
-
-*WoWok - Making It Easy for AI Agents to Communicate, Collaborate, Trade and Trust.* 💎

package/docs/WIP.md

@@ -1,388 +0,0 @@
-# WIP — Witness Immutable Promise
-
----
-
-## Overview
-
-**WIP** (Witness Immutable Promise) is a JSON-based file format for conveying **tamper-proof commitments** over networks, designed primarily for AI agents and automated systems. It ensures content integrity through cryptographic hashing and optional digital signatures, supporting rich text and multiple embedded images.
-
-A WIP file serves as a **self-verifiable promise** — any recipient can independently verify that the content has not been altered since creation, without trusting the sender or any intermediary.
-
-### Key Properties
-
-| Property | Mechanism |
-|----------|-----------|
-| **Tamper Detection** | SHA-256 hash covers the schema identifier and entire payload |
-| **Non-Repudiation** | Optional Falcon-512 digital signature over the entire metadata block |
-| **Self-Verifiable** | All verification data is embedded in the file; no external trust required |
-| **AI-Native** | Designed for AI agents to create, exchange, and verify commitments autonomously |
-
----
-
-## Schema
-
-### JSON Structure
-
-```
-{
-  "wip": "https://github.com/wowok-ai/docs/blob/main/WIP.md",
-  "payload": { ... },
-  "meta": { ... }
-}
-```
-
----
-
-## Field Reference
-
-### Root Level
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `wip` | `string` | **Yes** | Schema identifier URL. Fixed value: `"https://github.com/wowok-ai/docs/blob/main/WIP.md"` |
-| `payload` | `object` | **Yes** | The commitment content (text + optional media) |
-| `meta` | `object` | **Yes** | Metadata including integrity hash and optional signatures |
-
----
-
-### `payload` — Content Payload
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `payload.content` | `object` | **Yes** | Text content of the commitment |
-| `payload.content.text` | `string` | **Yes** | The commitment text. Max 10,000 characters (~5,000 Chinese characters) |
-| `payload.content.format` | `enum` | **Yes** | Text format: `"plain"` \| `"markdown"` \| `"html"` |
-| `payload.media` | `array` | **Yes** | Array of embedded media files (can be empty `[]`) |
-
-#### `payload.media[]` — Media Item
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `id` | `string` | **Yes** | Unique identifier for this media item (e.g., `"img-001"`) |
-| `type` | `enum` | **Yes** | MIME type: `"image/png"` \| `"image/jpeg"` \| `"image/gif"` \| `"image/webp"` |
-| `data` | `string` | **Yes** | Base64-encoded file data |
-| `filename` | `string` | No | Original filename (e.g., `"contract-signature.png"`) |
-
----
-
-### `meta` — Metadata
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `meta.type` | `string` | **Yes** | File type identifier. Fixed value: `"wip"` |
-| `meta.version` | `string` | **Yes** | Format version. Current: `"1.0.0"` |
-| `meta.created` | `string` | **Yes** | Creation timestamp in ISO 8601 format (e.g., `"2024-03-15T08:30:00Z"`) |
-| `meta.hash` | `string` | **Yes** | SHA-256 hash of `{ wip, payload }` as a lowercase hex string (no prefix) |
-| `meta.algorithm` | `string` | **Yes** | Hash algorithm identifier. Fixed value: `"sha256"` |
-| `meta.signature` | `object` or `array` | No | Digital signature(s). Single object or array for multi-signature support |
-
-#### `meta.signature` — Signature Object
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `value` | `string` | **Yes** | Base64-encoded signature bytes |
-| `publicKey` | `string` | **Yes** | Public key for verification (Base64-encoded, 897 bytes for Falcon-512) |
-| `algorithm` | `string` | **Yes** | Signature algorithm. Fixed value: `"Falcon512"` |
-| `address` | `string` | No | Signer's blockchain address (hex-encoded, `0x` prefix) |
-
----
-
-## Integrity Model
-
-### Hash Computation
-
-The `meta.hash` is computed as:
-
-```
-hash = SHA-256( canonicalizeJson({ wip: schemaUrl, payload: payload }) )
-```
-
-This covers **both** the schema identifier and the entire payload, preventing:
-- Tampering with the `wip` field (e.g., disguising a WIP as another format)
-- Tampering with any payload content (text or media)
-
-### Signature Computation
-
-When present, `meta.signature` is a Falcon-512 signature over:
-
-```
-metaHash = SHA-256( canonicalizeJson(meta_without_signature) )
-```
-
-Where `meta_without_signature` is the `meta` object with the `signature` field excluded. This covers **all** metadata fields (`type`, `version`, `created`, `hash`, `algorithm`), preventing tampering with any meta field.
-
-### Verification Chain
-
-```
-{ wip, payload }  ──SHA-256──►  meta.hash  ──(part of)──►  meta
-                                                              │
-meta (excluding signature)  ──SHA-256──►  metaHash  ──Falcon-512──►  meta.signature
-```
-
-### Tamper Detection Matrix
-
-| Tampered Field | Detected By |
-|----------------|-------------|
-| `wip` (schema URL) | Hash mismatch |
-| `payload.content.text` | Hash mismatch |
-| `payload.content.format` | Hash mismatch |
-| `payload.media[].data` | Hash mismatch |
-| `meta.type` | Signature mismatch |
-| `meta.version` | Signature mismatch |
-| `meta.created` | Signature mismatch |
-| `meta.hash` | Hash mismatch **+** Signature mismatch |
-| `meta.algorithm` | Signature mismatch |
-| `meta.signature` | Signature mismatch |
-
----
-
-## Canonical JSON Serialization
-
-To ensure deterministic hash computation, all JSON objects are serialized using **canonical JSON** before hashing:
-
-1. Object keys are sorted alphabetically
-2. No whitespace between tokens
-3. Strings use standard JSON escaping (`\"`, `\\`, `\n`, etc.)
-4. Numbers are serialized without unnecessary precision
-
-**Example:**
-
-```json
-{"b":2,"a":1}
-```
-Canonical form:
-```
-{"a":1,"b":2}
-```
-
----
-
-## Size Limits
-
-| Limit | Value | Description |
-|-------|-------|-------------|
-| Max image size | 2 MB | Per embedded image (before Base64 encoding) |
-| Max total size | 10 MB | Entire WIP file as JSON string |
-| Max image count | 10 | Number of media items in `payload.media` |
-| Max text length | 10,000 chars | Length of `payload.content.text` |
-
----
-
-## Examples
-
-### Minimal WIP (No Signature, No Media)
-
-```json
-{
-  "wip": "https://github.com/wowok-ai/docs/blob/main/WIP.md",
-  "payload": {
-    "content": {
-      "text": "I commit to delivering the project by December 31, 2024.",
-      "format": "plain"
-    },
-    "media": []
-  },
-  "meta": {
-    "type": "wip",
-    "version": "1.0.0",
-    "created": "2024-03-15T08:30:00Z",
-    "hash": "3a6eb0790f39ac87c94f3856b2dd2c5d110e6811602261a9a923d3bb23adc8b7",
-    "algorithm": "sha256"
-  }
-}
-```
-
-### Full WIP (Markdown + Image + Signature)
-
-```json
-{
-  "wip": "https://github.com/wowok-ai/docs/blob/main/WIP.md",
-  "payload": {
-    "content": {
-      "text": "# Service Agreement\n\n## Scope\nComplete website development including:\n- Frontend (React)\n- Backend (Node.js)\n- Database design\n\n## Timeline\nDelivery by **2024-12-31**.",
-      "format": "markdown"
-    },
-    "media": [
-      {
-        "id": "img-001",
-        "type": "image/png",
-        "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
-        "filename": "contract-signature.png"
-      }
-    ]
-  },
-  "meta": {
-    "type": "wip",
-    "version": "1.0.0",
-    "created": "2024-03-15T08:30:00Z",
-    "hash": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2",
-    "algorithm": "sha256",
-    "signature": {
-      "value": "base64EncodedSignatureValueHere...",
-      "publicKey": "Bwl0UgpjuBhHXtrC09LAW30exFURxRBB...",
-      "algorithm": "Falcon512",
-      "address": "0x3a15ed459db7b7bcd9e1c7cd49c8a58aed5e1fd169cc2a99ead2201fa3ee54a4"
-    }
-  }
-}
-```
-
-### Multi-Signature WIP
-
-```json
-{
-  "wip": "https://github.com/wowok-ai/docs/blob/main/WIP.md",
-  "payload": {
-    "content": {
-      "text": "We jointly commit to the terms outlined in this agreement.",
-      "format": "plain"
-    },
-    "media": []
-  },
-  "meta": {
-    "type": "wip",
-    "version": "1.0.0",
-    "created": "2024-03-15T08:30:00Z",
-    "hash": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4",
-    "algorithm": "sha256",
-    "signature": [
-      {
-        "value": "signatureFromPartyA...",
-        "publicKey": "publicKeyOfPartyA...",
-        "algorithm": "Falcon512",
-        "address": "0xaaaa..."
-      },
-      {
-        "value": "signatureFromPartyB...",
-        "publicKey": "publicKeyOfPartyB...",
-        "algorithm": "Falcon512",
-        "address": "0xbbbb..."
-      }
-    ]
-  }
-}
-```
-
----
-
-## API Reference
-
-### `generate_wip(options, outputPath)`
-
-Creates a WIP file and saves it to disk. Optionally signs it with a local account.
-
-**Parameters:**
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `options.markdown_text` | `string` | **Yes** | Commitment text in Markdown format |
-| `options.images` | `ImageSource[]` | No | Array of image sources |
-| `options.account` | `string` | No | Account name/address for signing. If omitted, no signature is added |
-| `outputPath` | `string` | **Yes** | File path to save the WIP file |
-
-**Returns:** `Promise<string>` — Path to the generated WIP file.
-
-**ImageSource:**
-
-| Field | Type | Required | Description |
-|-------|------|----------|-------------|
-| `source` | `string` | **Yes** | File path, HTTPS URL, or data URL |
-| `id` | `string` | No | Custom media ID |
-| `filename` | `string` | No | Custom filename |
-
----
-
-### `verify_wip(wipFilePath, hash_equal?, requireSignature?)`
-
-Verifies a WIP file's integrity and signatures.
-
-**Parameters:**
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `wipFilePath` | `string` | **Yes** | Path to the WIP file (local path or HTTPS URL) |
-| `hash_equal` | `string` | No | Expected hash value for additional verification |
-| `requireSignature` | `boolean` | No | If `true`, the file must have at least one valid signature |
-
-**Returns:** `Promise<WipVerificationResult>`
-
-**WipVerificationResult:**
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `valid` | `boolean` | Overall verification result |
-| `error` | `string` | Error message if verification failed |
-| `hashValid` | `boolean` | Whether the content hash matches |
-| `signatureValid` | `boolean` | Whether all signatures are valid (undefined if no signature) |
-| `hasSignature` | `boolean` | Whether the file contains any signature |
-| `signatures` | `WipSignatureVerification[]` | Per-signature verification details |
-
----
-
-### `sign_wip(wipFilePath, account, outputPath?)`
-
-Adds a digital signature to an existing WIP file. Supports multi-signature — if the file already has signatures, the new one is appended (or replaces an existing signature from the same public key).
-
-**Parameters:**
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `wipFilePath` | `string` | **Yes** | Path to the WIP file |
-| `account` | `string` | **Yes** | Account name or address for signing |
-| `outputPath` | `string` | No | Output path (defaults to overwriting the input file) |
-
-**Returns:** `Promise<string>` — Path to the signed WIP file.
-
----
-
-### `wip2html(wipPath, options?)`
-
-Converts a WIP file (or directory of WIP files) to human-readable HTML.
-
-**Parameters:**
-
-| Parameter | Type | Required | Description |
-|-----------|------|----------|-------------|
-| `wipPath` | `string` | **Yes** | Path to a `.wip` file or directory containing `.wip` files |
-| `options.title` | `string` | No | Custom HTML page title |
-| `options.theme` | `enum` | No | `"light"` or `"dark"` |
-| `options.outputPath` | `string` | No | Output file path (for single file) or directory (for batch) |
-
-**Returns:** `Promise<string | string[]>` — Output file path(s).
-
----
-
-## Use Cases
-
-| Scenario | How WIP Is Used |
-|----------|-----------------|
-| **Service Listings** | Merchants attach WIP files to Service products as immutable product descriptions. Buyers verify the WIP hash at purchase time. |
-| **Contractual Commitments** | Parties create and sign WIP files documenting agreed terms. Each party's signature provides non-repudiation. |
-| **AI Agent Promises** | AI agents generate WIP files to record commitments made during automated negotiations or workflows. |
-| **Legal Evidence** | Signed WIP files serve as tamper-proof records of promises, usable in arbitration or dispute resolution. |
-| **Cross-System Communication** | Systems exchange WIP files as self-verifiable data packets without needing a trusted intermediary. |
-
----
-
-## Relationship with Other Components
-
-| Component | Relationship |
-|-----------|-------------|
-| **Service** | WIP files are attached to Service products via the `wip` field. The `wip_hash` is extracted and stored on-chain. |
-| **Order** | Buyers must provide the matching `wip_hash` when purchasing a WIP-backed product. |
-| **Messenger** | WIP files can be sent as file attachments through the encrypted Messenger. |
-| **Arbitration** | WIP files serve as evidence in dispute resolution, providing immutable records of original commitments. |
-| **Account** | Signatures are created using local Account keys (Falcon-512 keypairs). |
-
----
-
-## File Extension & MIME Type
-
-| Property | Value |
-|----------|-------|
-| File extension | `.wip` |
-| MIME type | `application/json` |
-| Encoding | UTF-8 |
-
----
-