mnemospark 0.1.2

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 BlockRunAI
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,84 @@
1
+ # mnemospark
2
+
3
+ mnemospark is an OpenClaw plugin for storage workflow operations with wallet-based x402 USDC payments.
4
+
5
+ It focuses on:
6
+
7
+ - `/wallet` for wallet status and export
8
+ - `/cloud` for storage workflow commands (backup, price-storage, upload, ls, download, delete)
9
+ - A local proxy that forwards `/mnemospark/*` storage endpoints to the mnemospark backend with wallet-proof signing
10
+
11
+ ---
12
+
13
+ ## Quick start
14
+
15
+ ```bash
16
+ # Install plugin (from OpenClaw)
17
+ openclaw plugins install mnemospark
18
+
19
+ # (Optional) run standalone install to create or reuse a wallet
20
+ npx mnemospark install --standard
21
+
22
+ # (Optional) set wallet key explicitly; if omitted, mnemospark auto-generates one
23
+ export BLOCKRUN_WALLET_KEY=0x...
24
+
25
+ # (Optional) point to a custom mnemospark backend API base URL
26
+ export MNEMOSPARK_BACKEND_API_BASE_URL=https://your-backend.example.com
27
+
28
+ # Start OpenClaw gateway (starts mnemospark proxy in gateway mode)
29
+ openclaw gateway start
30
+ ```
31
+
32
+ In OpenClaw:
33
+
34
+ - `/wallet` to view wallet address and balance
35
+ - `/wallet export` to back up your private key
36
+ - `/cloud help` to view storage workflow commands
37
+
38
+ ---
39
+
40
+ ## Configuration
41
+
42
+ - **Directory layout:**
43
+ - Base directory: `~/.openclaw/mnemospark`
44
+ - Logs and object log: `~/.openclaw/mnemospark/object.log`
45
+ - Wallet directory: `~/.openclaw/mnemospark/wallet`
46
+ - Wallet key: `~/.openclaw/mnemospark/wallet/wallet.key` (or `~/.openclaw/blockrun/wallet.key` when reusing a legacy Blockrun wallet)
47
+ - Backup archives: `~/.openclaw/mnemospark/backup`
48
+ - **Wallet key:** `BLOCKRUN_WALLET_KEY` (optional). If not provided, mnemospark auto-generates a wallet and stores it under `~/.openclaw/mnemospark/wallet/wallet.key`.
49
+ - **Backend base URL:** `MNEMOSPARK_BACKEND_API_BASE_URL` (optional if default is acceptable).
50
+ - **No backend API key:** do not set `MNEMOSPARK_BACKEND_API_KEY` or `x-api-key`. Backend authentication uses wallet-proof signatures generated by the proxy.
51
+
52
+ Install flows:
53
+
54
+ - **Default install:** `npx mnemospark install --default` creates a new Base wallet for mnemospark under `~/.openclaw/mnemospark/wallet/wallet.key` (chmod 600).
55
+ - **Standard install:** `npx mnemospark install --standard` checks for an existing `~/.openclaw/blockrun/wallet.key` and, if present, offers to reuse it for mnemospark; otherwise it behaves like the default install.
56
+
57
+ ---
58
+
59
+ ## Workflow and product references
60
+
61
+ - [mnemospark full workflow](./.company/mnemospark_full_workflow.md)
62
+ - [mnemospark PRD](./.company/mnemospark_PRD.md)
63
+ - [mnemospark backend API spec](./.company/mnemospark_backend_api_spec.md)
64
+
65
+ ---
66
+
67
+ ## Python examples (uv)
68
+
69
+ Python tooling and examples use [uv](https://docs.astral.sh/uv/) for dependency management. From the repo root:
70
+
71
+ ```bash
72
+ # Install uv (macOS/Linux): curl -LsSf https://astral.sh/uv/install.sh | sh
73
+ uv sync --extra bcm-pricing
74
+ source .venv/bin/activate # or on Windows: .venv\Scripts\activate
75
+ python examples/s3_storage_cost_estimate.py --gb 100
76
+ python examples/data_transfer_cost_estimate.py --direction in --gb 100
77
+ python examples/data_transfer_cost_estimate.py --direction out --gb 500
78
+ ```
79
+
80
+ ---
81
+
82
+ ## License
83
+
84
+ MIT
package/dist/cli.d.ts ADDED
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node