npm - openclaw-simplesv-plugin - Versions diffs - 0.1.0 - Mend

openclaw-simplesv-plugin 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,25 @@
+# OpenClaw SimpleSV Plugin
+A programmatic OpenClaw plugin that provides a high-level blockchain "Utility Belt" using the **@bsv/simple** library.
+## Key Features
+- **DIDs**: Manage and resolve Decentralized Identifiers (`did:bsv`).
+- **PushDrop Tokens**: Issue and transfer tokens with encrypted state.
+- **Inscriptions**: Permanently write data to the BSV blockchain.
+- **Verifiable Credentials**: Issue W3C-compatible credentials for agents.
+## AI Tool: `simplesv`
+Agents can use the `simplesv` tool to:
+- `inscribe`: Store permanent JSON/Text records.
+- `token_issue`: Create new digital assets or state.
+- `resolve_did`: Look up agent profiles.
+- `vc_issue`: Certify facts about other agents.
+## Architecture
+Built with the **OpenClaw Plugin SDK**, this extension uses:
+- `@bsv/simple` for high-level blockchain APIs.
+- `@bsv/sdk` for identity and crypto.
+- Shared wallet identity with other overlay plugins.
+## License
+MIT

package/SKILL.md ADDED Viewed

@@ -0,0 +1,57 @@
+---
+name: simplesv
+description: >
+  High-level BSV blockchain operations. Use for managing on-chain identity (DIDs),
+  issuing and transferring tokens (PushDrop), permanently inscribing data,
+  and handling verifiable credentials.
+metadata: '{"openclaw": {"requires": {"bins": ["node"]}}}'
+---
+## Tool Actions
+| Action | Description |
+|--------|-------------|
+| `inscribe` | Permanently write JSON or text to the blockchain |
+| `token_issue` | Create a new PushDrop token with optional data |
+| `token_transfer` | Send a token you own to another identity key |
+| `resolve_did` | Resolve a `did:bsv:...` identifier to its public profile |
+| `pay_p2p` | Send a standard peer-to-peer payment |
+| `vc_issue` | Issue a W3C-compatible Verifiable Credential |
+| `status` | Show current DID, identity key, and wallet balance |
+## Usage Guidance
+### On-Chain Identity (DIDs)
+Every agent has a `did:bsv` derived from their identity key. Use `status` to see yours, and `resolve_did` to look up others.
+### Inscriptions (Permanent Storage)
+Use `inscribe` when you need to store data that must never be deleted or modified.
+```javascript
+simplesv({
+  action: "inscribe",
+  data: { report: "Final analysis...", hash: "abc..." }
+})
+```
+### Digital Assets (Tokens)
+Use tokens to represent state or access rights.
+```javascript
+simplesv({
+  action: "token_issue",
+  data: { type: "access_pass", expires: "2026-12-31" },
+  basket: "passes"
+})
+```
+### Verifiable Credentials (Web of Trust)
+Issue a VC to certify a fact about another agent.
+```javascript
+simplesv({
+  action: "vc_issue",
+  subjectDid: "did:bsv:03...",
+  claims: { audited: true, rating: "A+" }
+})
+```
+## Etiquette
+Blockchain operations cost small amounts of BSV (satoshis). Always check the agent's balance before performing multiple inscriptions or token issuances.

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+/**
+ * OpenClaw SimpleSV Plugin
+ * High-level blockchain utility belt (DIDs, Tokens, Inscriptions).
+ */
+export default function register(api: any): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,GAAG,EAAE,GAAG,QA4ExC"}

package/dist/index.js ADDED Viewed

@@ -0,0 +1,83 @@
+import path from "node:path";
+import os from "node:os";
+/**
+ * OpenClaw SimpleSV Plugin
+ * High-level blockchain utility belt (DIDs, Tokens, Inscriptions).
+ */
+export default function register(api) {
+    const pluginConfig = api.getConfig?.()?.plugins?.entries?.['openclaw-simplesv-plugin']?.config || api.config || {};
+    const network = pluginConfig.network || 'mainnet';
+    const walletDir = pluginConfig.walletDir || path.join(os.homedir(), '.openclaw', 'bsv-wallet');
+    api.logger.info(`[simplesv] Initializing SimpleSV Plugin (network: ${network})`);
+    // Register the simplesv tool
+    api.registerTool({
+        name: "simplesv",
+        description: "High-level BSV utility belt: DIDs, Tokens, and Inscriptions",
+        parameters: {
+            type: "object",
+            properties: {
+                action: {
+                    type: "string",
+                    enum: [
+                        "inscribe", "token_issue", "token_transfer",
+                        "resolve_did", "pay_p2p", "vc_issue", "status"
+                    ],
+                    description: "Action to perform"
+                },
+                data: {
+                    type: "object",
+                    description: "JSON data for inscriptions or tokens"
+                },
+                text: {
+                    type: "string",
+                    description: "Plain text for inscriptions"
+                },
+                recipientKey: {
+                    type: "string",
+                    description: "Target identity public key"
+                },
+                amount: {
+                    type: "number",
+                    description: "Amount in satoshis for payments"
+                },
+                did: {
+                    type: "string",
+                    description: "Decentralized Identifier to resolve"
+                },
+                subjectDid: {
+                    type: "string",
+                    description: "Subject DID for Verifiable Credentials"
+                },
+                claims: {
+                    type: "object",
+                    description: "Claims for the Verifiable Credential"
+                },
+                basket: {
+                    type: "string",
+                    description: "Basket name for tokens"
+                }
+            },
+            required: ["action"]
+        },
+        async execute(_id, params) {
+            try {
+                // Implementation logic using @bsv/simple will go here
+                return {
+                    content: [{
+                            type: "text",
+                            text: `SimpleSV action '${params.action}' received. (Logic implementation pending)`
+                        }]
+                };
+            }
+            catch (error) {
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Error: ${error.message || String(error)}`
+                        }]
+                };
+            }
+        }
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,GAAQ;IACvC,MAAM,YAAY,GAAG,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,0BAA0B,CAAC,EAAE,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;IACnH,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,IAAI,SAAS,CAAC;IAClD,MAAM,SAAS,GAAG,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAE/F,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,qDAAqD,OAAO,GAAG,CAAC,CAAC;IAEjF,6BAA6B;IAC7B,GAAG,CAAC,YAAY,CAAC;QACf,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,6DAA6D;QAC1E,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE;wBACJ,UAAU,EAAE,aAAa,EAAE,gBAAgB;wBAC3C,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ;qBAC/C;oBACD,WAAW,EAAE,mBAAmB;iBACjC;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sCAAsC;iBACpD;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,6BAA6B;iBAC3C;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,4BAA4B;iBAC1C;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iCAAiC;iBAC/C;gBACD,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qCAAqC;iBACnD;gBACD,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wCAAwC;iBACtD;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sCAAsC;iBACpD;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wBAAwB;iBACtC;aACF;YACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;SACrB;QACD,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAW;YACpC,IAAI,CAAC;gBACH,sDAAsD;gBACtD,OAAO;oBACL,OAAO,EAAE,CAAC;4BACR,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,oBAAoB,MAAM,CAAC,MAAM,4CAA4C;yBACpF,CAAC;iBACH,CAAC;YACJ,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO;oBACL,OAAO,EAAE,CAAC;4BACR,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,UAAU,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;yBACjD,CAAC;iBACH,CAAC;YACJ,CAAC;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/index.ts ADDED Viewed

@@ -0,0 +1,84 @@
+import path from "node:path";
+import os from "node:os";
+/**
+ * OpenClaw SimpleSV Plugin
+ * High-level blockchain utility belt (DIDs, Tokens, Inscriptions).
+ */
+export default function register(api: any) {
+  const pluginConfig = api.getConfig?.()?.plugins?.entries?.['openclaw-simplesv-plugin']?.config || api.config || {};
+  const network = pluginConfig.network || 'mainnet';
+  const walletDir = pluginConfig.walletDir || path.join(os.homedir(), '.openclaw', 'bsv-wallet');
+  api.logger.info(`[simplesv] Initializing SimpleSV Plugin (network: ${network})`);
+  // Register the simplesv tool
+  api.registerTool({
+    name: "simplesv",
+    description: "High-level BSV utility belt: DIDs, Tokens, and Inscriptions",
+    parameters: {
+      type: "object",
+      properties: {
+        action: {
+          type: "string",
+          enum: [
+            "inscribe", "token_issue", "token_transfer",
+            "resolve_did", "pay_p2p", "vc_issue", "status"
+          ],
+          description: "Action to perform"
+        },
+        data: {
+          type: "object",
+          description: "JSON data for inscriptions or tokens"
+        },
+        text: {
+          type: "string",
+          description: "Plain text for inscriptions"
+        },
+        recipientKey: {
+          type: "string",
+          description: "Target identity public key"
+        },
+        amount: {
+          type: "number",
+          description: "Amount in satoshis for payments"
+        },
+        did: {
+          type: "string",
+          description: "Decentralized Identifier to resolve"
+        },
+        subjectDid: {
+          type: "string",
+          description: "Subject DID for Verifiable Credentials"
+        },
+        claims: {
+          type: "object",
+          description: "Claims for the Verifiable Credential"
+        },
+        basket: {
+          type: "string",
+          description: "Basket name for tokens"
+        }
+      },
+      required: ["action"]
+    },
+    async execute(_id: string, params: any) {
+      try {
+        // Implementation logic using @bsv/simple will go here
+        return {
+          content: [{
+            type: "text",
+            text: `SimpleSV action '${params.action}' received. (Logic implementation pending)`
+          }]
+        };
+      } catch (error: any) {
+        return {
+          content: [{
+            type: "text",
+            text: `Error: ${error.message || String(error)}`
+          }]
+        };
+      }
+    }
+  });
+}

package/openclaw.plugin.json ADDED Viewed

@@ -0,0 +1,33 @@
+{
+  "id": "openclaw-simplesv-plugin",
+  "name": "BSV Simple Utility Belt",
+  "description": "High-level blockchain operations: DIDs, PushDrop tokens, and Inscriptions",
+  "version": "0.1.0",
+  "skills": [
+    "./SKILL.md"
+  ],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "network": {
+        "type": "string",
+        "enum": ["mainnet", "testnet"],
+        "default": "mainnet"
+      },
+      "walletDir": {
+        "type": "string",
+        "description": "Path to BSV wallet storage (defaults to ~/.openclaw/bsv-wallet)"
+      }
+    }
+  },
+  "uiHints": {
+    "network": {
+      "label": "Blockchain Network"
+    },
+    "walletDir": {
+      "label": "Wallet Directory",
+      "advanced": true
+    }
+  }
+}

package/package.json ADDED Viewed

@@ -0,0 +1,50 @@
+{
+  "name": "openclaw-simplesv-plugin",
+  "version": "0.1.0",
+  "description": "OpenClaw plugin for advanced BSV operations (DIDs, Tokens, Inscriptions) via @bsv/simple",
+  "type": "module",
+  "main": "dist/index.js",
+  "files": [
+    "index.ts",
+    "openclaw.plugin.json",
+    "src/",
+    "dist/",
+    "SKILL.md",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "lint": "eslint src/**/*.ts",
+    "test": "npx tsx src/**/*.test.ts"
+  },
+  "dependencies": {
+    "@bsv/sdk": "latest",
+    "@bsv/simple": "latest",
+    "@bsv/wallet-toolbox": "latest",
+    "better-sqlite3": "^12.8.0",
+    "knex": "^3.2.8",
+    "dotenv": "^17.3.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^6.0.2",
+    "eslint": "^10.1.0"
+  },
+  "openclaw": {
+    "extensions": [
+      "./index.ts"
+    ]
+  },
+  "keywords": [
+    "openclaw",
+    "plugin",
+    "bsv",
+    "did",
+    "tokens",
+    "pushdrop",
+    "inscription"
+  ],
+  "author": "Tomás Díaz",
+  "license": "MIT"
+}