openclaw-storage-plugin 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# OpenClaw Storage Plugin
+
+A programmatic OpenClaw plugin that enables hash-based permanent storage for AI agents using the **Universal Hash Resolution Protocol (UHRP)**.
+
+## Key Features
+- **Integrity**: Every file is addressed by its hash, ensuring data cannot be tampered with.
+- **Efficiency**: Agents share large files via hashes instead of large message bodies.
+- **Shared Identity**: Uses the same BSV wallet as your other OpenClaw plugins.
+
+## AI Tool: `storage`
+Agents can use the `storage` tool to:
+- `upload`: Save local content to a UHRP storage host.
+- `download`: Retrieve and verify content using a SHA256 hash.
+
+## Architecture
+Built with the **OpenClaw Plugin SDK**, this extension interfaces with UHRP storage servers to provide agents with a decentralized "hard drive."
+
+## License
+MIT

package/SKILL.md

@@ -0,0 +1,41 @@
+---
+name: storage
+description: >
+  Hash-based permanent storage. Use for uploading large files, sharing datasets
+  between agents, or creating permanent records via UHRP.
+metadata: '{"openclaw": {"requires": {"bins": ["node"]}}}'
+---
+
+## Tool Actions
+
+| Action | Description |
+|--------|-------------|
+| `upload` | Upload local data and receive a SHA256 UHRP hash |
+| `download` | Retrieve and verify data using a hash |
+| `list` | See all files uploaded/cached by this agent |
+| `status` | Check storage host connection and pricing |
+
+## Usage Guidance
+
+### Handling Large Data
+If you generate a report, image, or large log file that is too big for a single message, upload it to storage and share the hash instead.
+
+```javascript
+storage({
+  action: "upload",
+  data: "This is a very long report content..."
+})
+```
+
+### Collaborative Knowledge
+Agents can share common datasets by exchanging UHRP hashes. This ensures everyone is working with the exact same version of the data.
+
+```javascript
+storage({
+  action: "download",
+  hash: "a1b2c3d4..."
+})
+```
+
+## Security
+Every download is automatically verified against its hash. If the data has been tampered with by the storage host, the tool will return an error.

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * OpenClaw Storage Plugin
+ * Enables UHRP hash-based storage for agent data.
+ */
+export default function register(api: any): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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,QAkDxC"}

package/dist/index.js

@@ -0,0 +1,57 @@
+import path from "node:path";
+import os from "node:os";
+/**
+ * OpenClaw Storage Plugin
+ * Enables UHRP hash-based storage for agent data.
+ */
+export default function register(api) {
+    const entry = api.getConfig?.()?.plugins?.entries?.['openclaw-storage'] || {};
+    const pluginConfig = { ...entry, ...(entry.config || {}), ...(api.config || {}) };
+    const storageHost = pluginConfig.storageHost || 'https://storage.bsv.direct';
+    const walletDir = pluginConfig.walletDir || path.join(os.homedir(), '.openclaw', 'bsv-wallet');
+    api.logger.info(`[storage] Initializing Storage Plugin (host: ${storageHost})`);
+    // Register the storage tool
+    api.registerTool({
+        name: "storage",
+        description: "Hash-based permanent storage for large assets",
+        parameters: {
+            type: "object",
+            properties: {
+                action: {
+                    type: "string",
+                    enum: ["upload", "download", "list", "status"],
+                    description: "Action to perform"
+                },
+                data: {
+                    type: "string",
+                    description: "Content to upload"
+                },
+                hash: {
+                    type: "string",
+                    description: "UHRP hash to download"
+                }
+            },
+            required: ["action"]
+        },
+        async execute(_id, params) {
+            try {
+                // Implementation logic using @bsv/storage-server client will go here
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Storage 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

@@ -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,KAAK,GAAG,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;IAC9E,MAAM,YAAY,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;IAClF,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,IAAI,4BAA4B,CAAC;IAC7E,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,gDAAgD,WAAW,GAAG,CAAC,CAAC;IAEhF,4BAA4B;IAC5B,GAAG,CAAC,YAAY,CAAC;QACf,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,+CAA+C;QAC5D,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC;oBAC9C,WAAW,EAAE,mBAAmB;iBACjC;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mBAAmB;iBACjC;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,uBAAuB;iBACrC;aACF;YACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;SACrB;QACD,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAW;YACpC,IAAI,CAAC;gBACH,qEAAqE;gBACrE,OAAO;oBACL,OAAO,EAAE,CAAC;4BACR,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,mBAAmB,MAAM,CAAC,MAAM,4CAA4C;yBACnF,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

@@ -0,0 +1,58 @@
+import path from "node:path";
+import os from "node:os";
+
+/**
+ * OpenClaw Storage Plugin
+ * Enables UHRP hash-based storage for agent data.
+ */
+export default function register(api: any) {
+  const entry = api.getConfig?.()?.plugins?.entries?.['openclaw-storage'] || {};
+  const pluginConfig = { ...entry, ...(entry.config || {}), ...(api.config || {}) };
+  const storageHost = pluginConfig.storageHost || 'https://storage.bsv.direct';
+  const walletDir = pluginConfig.walletDir || path.join(os.homedir(), '.openclaw', 'bsv-wallet');
+
+  api.logger.info(`[storage] Initializing Storage Plugin (host: ${storageHost})`);
+
+  // Register the storage tool
+  api.registerTool({
+    name: "storage",
+    description: "Hash-based permanent storage for large assets",
+    parameters: {
+      type: "object",
+      properties: {
+        action: {
+          type: "string",
+          enum: ["upload", "download", "list", "status"],
+          description: "Action to perform"
+        },
+        data: {
+          type: "string",
+          description: "Content to upload"
+        },
+        hash: {
+          type: "string",
+          description: "UHRP hash to download"
+        }
+      },
+      required: ["action"]
+    },
+    async execute(_id: string, params: any) {
+      try {
+        // Implementation logic using @bsv/storage-server client will go here
+        return {
+          content: [{
+            type: "text",
+            text: `Storage action '${params.action}' received. (Logic implementation pending)`
+          }]
+        };
+      } catch (error: any) {
+        return {
+          content: [{
+            type: "text",
+            text: `Error: ${error.message || String(error)}`
+          }]
+        };
+      }
+    }
+  });
+}

package/openclaw.plugin.json

@@ -0,0 +1,30 @@
+{
+  "id": "openclaw-storage",
+  "name": "BSV UHRP Storage",
+  "description": "Hash-based permanent storage for agent data",
+  "version": "0.1.0",
+  "skills": [
+    "./SKILL.md"
+  ],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "storageHost": {
+        "type": "string",
+        "default": "https://storage.bsv.direct",
+        "description": "Preferred UHRP storage host URL"
+      },
+      "walletDir": {
+        "type": "string",
+        "description": "Path to BSV wallet storage (defaults to ~/.openclaw/bsv-wallet)"
+      }
+    }
+  },
+  "uiHints": {
+    "storageHost": {
+      "label": "Storage Host",
+      "placeholder": "https://storage.bsv.direct"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "openclaw-storage-plugin",
+  "version": "0.1.0",
+  "description": "OpenClaw plugin for UHRP hash-based storage via BSV",
+  "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": "^2.0.13",
+    "@bsv/wallet-toolbox": "^2.1.17",
+    "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",
+    "storage",
+    "uhrp",
+    "hash"
+  ],
+  "author": "Tomás Díaz",
+  "license": "MIT"
+}