@cmdoss/suipay-mcp 0.2.1 → 0.2.2-dev.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.
- package/README.md +61 -8
- package/dist/bin/suipay.js +2 -3
- package/dist/chunk-K6WM4Z7H.js +46 -0
- package/dist/{chunk-XZQOOY66.js → chunk-NVTYOOMY.js} +3743 -1623
- package/dist/http-B4YTVw0k.d.ts +392 -0
- package/dist/http.d.ts +7 -2
- package/dist/http.js +1 -2
- package/dist/index.d.ts +109 -35
- package/dist/index.js +14 -3
- package/package.json +10 -8
- package/dist/chunk-A3JIIDYT.js +0 -161
- package/dist/chunk-TPW6S2K4.js +0 -39
- package/dist/http-BnIjiwcR.d.ts +0 -1149
- package/dist/personal-message-5PF4KVLF.js +0 -284
package/README.md
CHANGED
|
@@ -5,17 +5,19 @@ buyer-funded spend account. The buyer owns the account. The agent holds the
|
|
|
5
5
|
delegate key and can spend only under the on-chain grant (recipient bind,
|
|
6
6
|
per-payment cap, budget).
|
|
7
7
|
|
|
8
|
-
Pin `@cmdoss/suipay-mcp@0.2.
|
|
8
|
+
Pin `@cmdoss/suipay-mcp@0.2.2` in MCP config. `1.0.1` remains on the
|
|
9
9
|
registry as a historical release; do not install it for new agents.
|
|
10
10
|
|
|
11
11
|
## Install
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
claude mcp add --scope user suipay -- npx -y @cmdoss/suipay-mcp@0.2.
|
|
14
|
+
claude mcp add --scope user suipay -- npx -y @cmdoss/suipay-mcp@0.2.2
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
No wallet secret belongs in this command or MCP config. There is no
|
|
18
|
-
Sign-In With Sui (SIWS) step.
|
|
18
|
+
Sign-In With Sui (SIWS) step. To reuse an existing delegate seed locally,
|
|
19
|
+
set `SUIPAY_MCP_KEY` (64-hex or `suiprivkey1…`) in the MCP env — never in
|
|
20
|
+
the browser.
|
|
19
21
|
|
|
20
22
|
## First connection
|
|
21
23
|
|
|
@@ -26,8 +28,11 @@ First connection is a spend-account grant plus an agent-held delegate key.
|
|
|
26
28
|
2. Persist that delegate key locally at `~/.suipay/credentials.json`
|
|
27
29
|
(mode `0600`). The process that holds this key is the only process
|
|
28
30
|
that can settle.
|
|
29
|
-
3. Point MCP at
|
|
30
|
-
the
|
|
31
|
+
3. Point MCP at a gateway. Default is Railway **suipay-dev**. Pass
|
|
32
|
+
`suipay_login({ target: "local" })` or start the binary with `--local`
|
|
33
|
+
for the laptop stack. Env/CLI fill the process default until a
|
|
34
|
+
credential is bound; after login, stored `gatewayUrl` wins. Rebind
|
|
35
|
+
with `suipay_login({ target })`.
|
|
31
36
|
4. Call `pay`. The tool prepares unsigned `spend_account` settlement
|
|
32
37
|
bytes. If this process holds the grant's key it verifies and settles;
|
|
33
38
|
otherwise it returns the signing request.
|
|
@@ -36,16 +41,20 @@ The agent generates or is handed the delegate key. The key never enters
|
|
|
36
41
|
a browser URL, a SuiPay backend, logs, or a callback payload. Only the
|
|
37
42
|
public address leaves the local process. `suipay_login` mints or reuses
|
|
38
43
|
the local version-2 key at `~/.suipay/credentials.json` (mode `0600`) and
|
|
39
|
-
|
|
44
|
+
returns `{SUIPAY_CONSOLE_URL}/connect/agent?port=&delegateAddress=&connectState=&gateway=`
|
|
45
|
+
immediately. The owner signs in the browser; the loopback callback persists
|
|
46
|
+
key + gateway URL. Subsequent sessions reuse the file unless the grant is
|
|
47
|
+
missing, expired, or revoked.
|
|
40
48
|
|
|
41
49
|
## Tools
|
|
42
50
|
|
|
43
51
|
| Tool | Purpose |
|
|
44
52
|
| --- | --- |
|
|
45
|
-
| `discover` | Search live
|
|
53
|
+
| `discover` | Search live gateway resources. After login: `name`, `path`, `url`, `targetHash`, catalog price, and `affordable` (can this session cover one call — not authorization). `pay({ url })` still settles |
|
|
46
54
|
| `pay` | Fetch resource, prepare `spend_account` settlement, settle when this process holds the grant key |
|
|
47
55
|
| `receipts` | List settlement receipts, optionally by challenge ID |
|
|
48
|
-
| `
|
|
56
|
+
| `access_context` | Report current session / delegate / policy state (no secret material) |
|
|
57
|
+
| `suipay_login` | Mint or reuse the local delegate key and return a clickable console URL (does not wait for the wallet). Default target is Railway suipay-dev; pass `target: "local"` for the laptop stack |
|
|
49
58
|
| `suipay_logout` | Remove local credentials |
|
|
50
59
|
|
|
51
60
|
All tools remain visible before a grant is bound. `pay` and `receipts`
|
|
@@ -53,13 +62,57 @@ return instruction to run `suipay_login` and bind a spend-account grant
|
|
|
53
62
|
when no local credentials exist. Hosted `/mcp` never holds a spendable
|
|
54
63
|
key.
|
|
55
64
|
|
|
65
|
+
## Use from an agent
|
|
66
|
+
|
|
67
|
+
Install once (above). After that, paying is a prompt — paste it into Claude
|
|
68
|
+
(or any MCP host that has `suipay`). Do not write SDK code.
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
Pay this SuiPay resource with the suipay MCP `pay` tool. Do not write SDK code.
|
|
72
|
+
|
|
73
|
+
url: https://gateway.example/v1/image/generate
|
|
74
|
+
method: POST
|
|
75
|
+
json: {"prompt":"a cat"}
|
|
76
|
+
maxAmount: 50000
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
`pay` uses SDK `createPayer` internally. A delivered image is returned as an MCP
|
|
80
|
+
image block, not as a base64 wall in the JSON summary.
|
|
81
|
+
|
|
82
|
+
## Targets
|
|
83
|
+
|
|
84
|
+
Default is Railway **suipay-dev**. `--local` / `target: "local"` is laptop-only.
|
|
85
|
+
|
|
86
|
+
| Target | Console | Gateway | How |
|
|
87
|
+
| --- | --- | --- | --- |
|
|
88
|
+
| `dev` (default) | `https://suipay-dev.up.railway.app` | `https://gateway-dev-ba84.up.railway.app` | no flag, or `--dev` |
|
|
89
|
+
| `local` | `http://localhost:3000` | `http://127.0.0.1:4340` | `--local` / `-local`, or `suipay_login({ target: "local" })` |
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
# Railway suipay-dev (default)
|
|
93
|
+
npx @cmdoss/suipay-mcp@0.2.2
|
|
94
|
+
|
|
95
|
+
# Laptop stack
|
|
96
|
+
npx @cmdoss/suipay-mcp@0.2.2 --local
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
`SUIPAY_MCP_TARGET=local|dev` selects the same preset. Explicit
|
|
100
|
+
`SUIPAY_GATEWAY_URL` / `SUIPAY_CONSOLE_URL` fill the process default when no
|
|
101
|
+
credential is bound yet. After a successful login, `credentials.json`
|
|
102
|
+
`gatewayUrl` is the bound gateway: `pay` / `discover` / `suipay_login` without
|
|
103
|
+
`target` stay on that binding so a leftover env cannot silently retarget spend.
|
|
104
|
+
Rebind with `suipay_login({ target: "dev" | "local" })` (same key, new consent
|
|
105
|
+
if that stack has no live grant).
|
|
106
|
+
|
|
56
107
|
## Client environment
|
|
57
108
|
|
|
58
109
|
```bash
|
|
110
|
+
# Optional. Unset = Railway suipay-dev. --local uses localhost:3000 / 127.0.0.1:4340.
|
|
59
111
|
SUIPAY_GATEWAY_URL=https://gateway.example
|
|
60
112
|
SUIPAY_CONSOLE_URL=https://console.example
|
|
61
113
|
SUIPAY_RPC_URL=https://your-testnet-rpc.example
|
|
62
114
|
SUIPAY_NETWORK=testnet
|
|
115
|
+
SUIPAY_MCP_TARGET=dev
|
|
63
116
|
```
|
|
64
117
|
|
|
65
118
|
Optional:
|
package/dist/bin/suipay.js
CHANGED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import {
|
|
2
|
+
createServer,
|
|
3
|
+
loadLocalSigner,
|
|
4
|
+
loadLocalSigningKeyRecord,
|
|
5
|
+
loadMcpConfig,
|
|
6
|
+
loadPaymentProfile
|
|
7
|
+
} from "./chunk-NVTYOOMY.js";
|
|
8
|
+
|
|
9
|
+
// src/index.ts
|
|
10
|
+
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
11
|
+
function loadBootProfile(load = loadPaymentProfile) {
|
|
12
|
+
try {
|
|
13
|
+
return { profile: load(), unreadable: false };
|
|
14
|
+
} catch {
|
|
15
|
+
return { profile: null, unreadable: true };
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
async function main() {
|
|
19
|
+
const argv = process.argv.slice(2);
|
|
20
|
+
const cfg = loadMcpConfig(process.env, argv);
|
|
21
|
+
const target = cfg.target ?? "dev";
|
|
22
|
+
const server = createServer(cfg);
|
|
23
|
+
await server.connect(new StdioServerTransport());
|
|
24
|
+
try {
|
|
25
|
+
const boundGateway = loadLocalSigningKeyRecord()?.gatewayUrl ?? cfg.gatewayUrl;
|
|
26
|
+
const local = loadLocalSigner();
|
|
27
|
+
if (local) {
|
|
28
|
+
console.error(
|
|
29
|
+
`[suipay-mcp] ${target} ${boundGateway} \xB7 delegate ${local.address} \xB7 stdio ready`
|
|
30
|
+
);
|
|
31
|
+
} else {
|
|
32
|
+
console.error(
|
|
33
|
+
`[suipay-mcp] ${target} ${boundGateway} \xB7 not connected \xB7 run suipay_login \xB7 stdio ready`
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
} catch {
|
|
37
|
+
console.error(
|
|
38
|
+
`[suipay-mcp] ${target} ${cfg.gatewayUrl} \xB7 credentials unreadable: run suipay_login or suipay_logout force=true \xB7 stdio ready`
|
|
39
|
+
);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
export {
|
|
44
|
+
loadBootProfile,
|
|
45
|
+
main
|
|
46
|
+
};
|