spongewallet 0.1.0 → 0.1.1

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 (2) hide show
  1. package/README.md +113 -2
  2. package/package.json +13 -4
package/README.md CHANGED
@@ -1,10 +1,121 @@
1
1
  # spongewallet
2
2
 
3
- Thin CLI launcher for the SpongeWallet SDK.
3
+ CLI for creating, claiming, and using Sponge agent wallets from the terminal.
4
+
5
+ `spongewallet` is the terminal entrypoint for Sponge Wallet. It wraps the SDK CLI and exposes the common flows for onboarding, wallet operations, swaps, bridges, and paid API requests.
6
+
7
+ ## Install
8
+
9
+ Run it directly:
10
+
11
+ ```bash
12
+ npx spongewallet --help
13
+ ```
14
+
15
+ Or install it:
16
+
17
+ ```bash
18
+ npm install -g spongewallet
19
+ ```
20
+
21
+ ## Quickstart
22
+
23
+ Create an agent wallet:
4
24
 
5
25
  ```bash
6
26
  npx spongewallet init
27
+ ```
28
+
29
+ Restrict the later claim to one email:
30
+
31
+ ```bash
7
32
  npx spongewallet init --email alice@example.com
8
- npx spongewallet wallet balance
33
+ ```
34
+
35
+ Claim a pending agent or log in with device flow:
36
+
37
+ ```bash
38
+ npx spongewallet login
39
+ ```
40
+
41
+ Inspect the current session:
42
+
43
+ ```bash
44
+ npx spongewallet whoami
45
+ ```
46
+
47
+ Print MCP config for Claude Code or Cursor:
48
+
49
+ ```bash
50
+ npx spongewallet mcp print
51
+ ```
52
+
53
+ ## Core flow
54
+
55
+ 1. `init` creates an agent immediately, prints addresses and MCP config, and stores pending claim metadata locally.
56
+ 2. `login` claims that pending agent if claim metadata exists. Otherwise it falls back to normal device-flow authentication.
57
+ 3. Use grouped commands like `wallet`, `tx`, `swap`, `bridge`, and `pay` for day-to-day operations.
58
+
59
+ ## Common commands
60
+
61
+ ```bash
62
+ # Session
63
+ npx spongewallet init
64
+ npx spongewallet login
65
+ npx spongewallet whoami
66
+ npx spongewallet logout
9
67
  npx spongewallet mcp print
68
+
69
+ # Wallets and transfers
70
+ npx spongewallet wallet balance
71
+ npx spongewallet wallet send --chain base --to 0xabc... --amount 10 --asset USDC
72
+ npx spongewallet wallet history --chain base --limit 20
73
+
74
+ # Transactions, swaps, and bridges
75
+ npx spongewallet tx status --chain base --tx-hash 0x123...
76
+ npx spongewallet swap quote --chain solana --from SOL --to USDC --amount 1
77
+ npx spongewallet bridge --source-chain base --destination-chain solana --token USDC --amount 25
78
+
79
+ # Paid requests
80
+ npx spongewallet pay x402 --url https://api.example.com/premium
81
+ npx spongewallet pay mpp --url https://tempo.example.com/premium --chain tempo
82
+ ```
83
+
84
+ ## Command groups
85
+
86
+ - `init`, `login`, `logout`, `whoami`, `mcp`: session setup and authentication
87
+ - `wallet`, `tx`, `swap`, `bridge`, `pay`: balances, transfers, swaps, bridging, and payments
88
+ - `keys`, `card`, `plan`, `trade`, `auth`: stored secrets and approval flows
89
+ - `market`, `advanced`: venue-specific and low-level commands
90
+
91
+ ## Authentication
92
+
93
+ By default, the CLI uses Sponge device-flow authentication. After login, credentials are stored at:
94
+
95
+ ```text
96
+ ~/.spongewallet/credentials.json
97
+ ```
98
+
99
+ For non-interactive usage, set an API key:
100
+
101
+ ```bash
102
+ export SPONGE_API_KEY=<agent-api-key>
10
103
  ```
104
+
105
+ ## What It Wraps
106
+
107
+ This package is a thin launcher around `@paysponge/sdk`. If you want the SDK and the CLI in one dependency, install:
108
+
109
+ ```bash
110
+ npm install @paysponge/sdk
111
+ ```
112
+
113
+ ## Docs
114
+
115
+ - CLI docs: https://docs.paysponge.com/cli
116
+ - Authentication: https://docs.paysponge.com/authentication
117
+ - Overview: https://docs.paysponge.com
118
+
119
+ ## Notes
120
+
121
+ This is early access software. Command surface and flows may still change.
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "spongewallet",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "description": "CLI launcher for SpongeWallet onboarding and MCP setup",
6
6
  "bin": {
7
- "spongewallet": "./bin/spongewallet.js"
7
+ "spongewallet": "bin/spongewallet.js"
8
8
  },
9
9
  "files": [
10
10
  "bin",
11
11
  "README.md"
12
12
  ],
13
13
  "dependencies": {
14
- "@paysponge/sdk": "^0.1.16"
14
+ "@paysponge/sdk": "^0.1.21"
15
15
  },
16
16
  "keywords": [
17
17
  "wallet",
@@ -20,5 +20,14 @@
20
20
  "mcp",
21
21
  "crypto"
22
22
  ],
23
- "license": "MIT"
23
+ "license": "MIT",
24
+ "homepage": "https://docs.paysponge.com/cli",
25
+ "repository": {
26
+ "type": "git",
27
+ "url": "https://github.com/paysponge/sponge.git",
28
+ "directory": "mobwallet/packages/spongewallet-cli"
29
+ },
30
+ "bugs": {
31
+ "url": "https://github.com/paysponge/sponge/issues"
32
+ }
24
33
  }