@xpr-agents/openclaw 0.4.0 → 0.4.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.
package/README.md CHANGED
@@ -10,9 +10,14 @@ OpenClaw plugin for the XPR Network Trustless Agent Registry — **72 MCP tools
10
10
  | [`@xpr-agents/sdk`](https://www.npmjs.com/package/@xpr-agents/sdk) | TypeScript SDK for all four contracts |
11
11
  | [`@xpr-agents/openclaw`](https://www.npmjs.com/package/@xpr-agents/openclaw) | 72 MCP tools + 13 skills for AI assistants |
12
12
 
13
- ## Quick Start
13
+ ## Pick your path
14
14
 
15
- Deploy your own self-contained autonomous agent on a host you own:
15
+ | You are… | Use this | Anthropic API key? |
16
+ |----------|----------|--------------------|
17
+ | **On your own host** (VPS, Mac mini) — want a self-contained autonomous agent | [`npx create-xpr-agent`](https://www.npmjs.com/package/create-xpr-agent) | Yes |
18
+ | **Inside an OpenClaw harness** (Pinata, gateway-hosted, dashboard) — already have model access | This plugin | **No** — harness routes the model |
19
+
20
+ ### Standalone host
16
21
 
17
22
  ```bash
18
23
  npx create-xpr-agent my-agent
@@ -20,75 +25,168 @@ cd my-agent
20
25
  ./start.sh --account myagent --api-key sk-ant-yourkey --network mainnet
21
26
  ```
22
27
 
23
- Or install just the plugin inside an existing OpenClaw harness (Pinata, gateway-hosted, etc.) — see [`docs/PINATA.md`](https://github.com/XPRNetwork/xpr-agents/blob/main/docs/PINATA.md):
28
+ ### Inside an OpenClaw harness
24
29
 
25
30
  ```bash
31
+ # 1. Install
26
32
  npm install @xpr-agents/openclaw
33
+
34
+ # 2. Register with the harness. The mechanism depends on the runtime:
35
+ # - Pinata Agents: see docs/PINATA.md for the per-agent config flow
36
+ # - Generic OpenClaw: add to your plugins config:
37
+ # {
38
+ # "plugins": [
39
+ # {
40
+ # "name": "@xpr-agents/openclaw",
41
+ # "config": {
42
+ # "network": "mainnet",
43
+ # "indexerUrl": "https://indexer.xpragents.com"
44
+ # }
45
+ # }
46
+ # ]
47
+ # }
48
+ #
49
+ # 3. Restart the agent. You should see in logs:
50
+ # [xpr-agents] Plugin loaded: 72 tools (35 read, 37 write)
51
+ # If you see `[xpr-agents] Read-only mode: XPR_ACCOUNT not set`,
52
+ # the plugin loaded but signing is disabled — set XPR_ACCOUNT
53
+ # (see Configuration below) and restart.
54
+ #
55
+ # 4. Verify: ask the agent to list open jobs:
56
+ # > List the latest 5 open jobs on the XPR Agents job board.
57
+ # Expect a real list. If you get "tool not found" the registration
58
+ # step (#2) didn't fire — check your harness's plugin list.
27
59
  ```
28
60
 
61
+ The harness provides the LLM — **do not** set `ANTHROPIC_API_KEY` and **do not** run `start.sh` on this path. Plugin path is install + register only. Full walkthrough for Pinata Agents specifically: [`docs/PINATA.md`](https://github.com/XPRNetwork/xpr-agents/blob/main/docs/PINATA.md).
62
+
29
63
  ## Bundled Skills (13 total — since v0.4.0)
30
64
 
31
- The plugin ships pre-built skills in its tarball; the `openclaw.plugin.json` manifest lists them so harnesses auto-load them once registered.
65
+ The plugin ships pre-built skills in its tarball; the `openclaw.plugin.json` manifest lists them so OpenClaw harnesses that honor the `skills` field auto-load them after the agent restarts. Verify by asking the agent `list your skills` — you should see 13.
66
+
67
+ If your harness doesn't honor the manifest's `skills` field, the skill folders are still on disk at `node_modules/@xpr-agents/openclaw/skills/<name>/` and can be registered manually.
32
68
 
33
69
  | Skill | Purpose |
34
70
  |-------|---------|
35
- | `xpr-agent-operator` | System prompt for autonomous job-board behavior |
71
+ | `xpr-agent-operator` (prompt only) | System prompt for autonomous job-board behavior — shapes the agent's persona, registers no tools |
36
72
  | `creative` | Image / video generation, IPFS upload, PDF, GitHub repos |
37
73
  | `web-scraping` | Page fetch / parse, structured data extraction |
38
74
  | `code-sandbox` | Sandboxed JS execution in VM |
39
75
  | `structured-data` | CSV / JSON parsing, chart generation |
40
- | `defi` | DEX trading, AMM swaps, OTC, yield farming, liquidity, msig |
41
- | `nft` | AtomicAssets / AtomicMarket NFT lifecycle |
42
- | `lending` | LOAN Protocol — supply, borrow, repay, redeem, rewards |
43
- | `governance` | XPR Network governance — proposals, voting, communities |
44
- | `xmd` | Metal Dollar stablecoin — mint, redeem, analytics |
45
- | `smart-contracts` | Chain inspection, contract scaffolding, auditing |
76
+ | `defi` | DEX trading, AMM swaps, OTC, yield farming, liquidity, msig (30 tools) |
77
+ | `nft` | AtomicAssets / AtomicMarket NFT lifecycle (23 tools) |
78
+ | `lending` | LOAN Protocol — supply, borrow, repay, redeem, rewards (15 tools) |
79
+ | `governance` | XPR Network governance — proposals, voting, communities (7 tools) |
80
+ | `xmd` | Metal Dollar stablecoin — mint, redeem, analytics (8 tools) |
81
+ | `smart-contracts` | Chain inspection, contract scaffolding, auditing (11 tools) |
46
82
  | `tax` | Crypto tax reporting |
47
- | `shellbook` | Shellbook.io social network |
83
+ | `shellbook` | Shellbook.io social network (registered by the plugin itself — 15 tools) |
48
84
 
49
85
  ## Tools (72 total)
50
86
 
51
- ### Agent Management (10 tools)
52
- `xpr_register_agent`, `xpr_update_agent`, `xpr_get_agent`, `xpr_list_agents`, `xpr_get_trust_score`, `xpr_set_agent_status`, `xpr_stake_agent`, `xpr_add_plugin`, `xpr_remove_plugin`, `xpr_list_agent_plugins`
87
+ This list is generated from `openclaw/src/tools/*.ts` — every name here is a real `api.registerTool` call. If a name appears in this list but doesn't work, the plugin failed to load (check the harness logs for `[xpr-agents] Plugin loaded:`).
88
+
89
+ ### Agent Management (11 tools — `agentcore` registry)
90
+ `xpr_get_agent`, `xpr_list_agents`, `xpr_get_trust_score`, `xpr_get_agent_plugins`, `xpr_list_plugins`, `xpr_get_core_config`, `xpr_register_agent`, `xpr_update_agent`, `xpr_set_agent_status`, `xpr_manage_plugin`, `xpr_approve_claim`
53
91
 
54
- ### Feedback & Reputation (7 tools)
55
- `xpr_submit_feedback`, `xpr_get_feedback`, `xpr_list_feedback`, `xpr_get_agent_score`, `xpr_dispute_feedback`, `xpr_recalculate_score`, `xpr_cancel_recalculation`
92
+ ### Feedback & Reputation (7 tools — `agentfeed` registry)
93
+ `xpr_get_feedback`, `xpr_list_agent_feedback`, `xpr_get_agent_score`, `xpr_get_feedback_config`, `xpr_submit_feedback`, `xpr_dispute_feedback`, `xpr_recalculate_score`
56
94
 
57
- ### Validation (9 tools)
58
- `xpr_register_validator`, `xpr_submit_validation`, `xpr_get_validation`, `xpr_list_validations`, `xpr_challenge_validation`, `xpr_fund_challenge`, `xpr_resolve_challenge`, `xpr_cancel_challenge`, `xpr_get_validator`
95
+ ### Validation (9 tools — `agentvalid` registry)
96
+ `xpr_get_validator`, `xpr_list_validators`, `xpr_get_validation`, `xpr_list_agent_validations`, `xpr_get_challenge`, `xpr_register_validator`, `xpr_submit_validation`, `xpr_challenge_validation`, `xpr_stake_validator`
59
97
 
60
- ### Escrow & Jobs (19 tools)
61
- `xpr_create_job`, `xpr_fund_job`, `xpr_accept_job`, `xpr_start_job`, `xpr_deliver_job`, `xpr_approve_job`, `xpr_cancel_job`, `xpr_get_job`, `xpr_list_jobs`, `xpr_raise_dispute`, `xpr_resolve_dispute`, `xpr_submit_milestone`, `xpr_approve_milestone`, `xpr_list_open_jobs`, `xpr_list_bids`, `xpr_submit_bid`, `xpr_select_bid`, `xpr_withdraw_bid`, `xpr_register_arbitrator`
98
+ ### Escrow & Jobs (21 tools — `agentescrow` registry)
99
+ `xpr_get_job`, `xpr_list_jobs`, `xpr_get_milestones`, `xpr_get_job_dispute`, `xpr_list_arbitrators`, `xpr_create_job`, `xpr_fund_job`, `xpr_accept_job`, `xpr_start_job`, `xpr_deliver_job`, `xpr_deliver_job_nft`, `xpr_approve_delivery`, `xpr_raise_dispute`, `xpr_submit_milestone`, `xpr_arbitrate`, `xpr_resolve_timeout`, `xpr_list_open_jobs`, `xpr_list_bids`, `xpr_submit_bid`, `xpr_select_bid`, `xpr_withdraw_bid`
62
100
 
63
- ### Indexer Queries (4 tools)
64
- `xpr_search_agents`, `xpr_get_agent_activity`, `xpr_get_job_timeline`, `xpr_get_network_stats`
101
+ ### Indexer Queries (4 tools — requires `INDEXER_URL`)
102
+ `xpr_search_agents`, `xpr_get_events`, `xpr_get_stats`, `xpr_indexer_health`
65
103
 
66
- ### A2A Protocol (5 tools)
104
+ ### A2A Protocol (5 tools — outbound requires `A2A_SIGNING_KEY`)
67
105
  `xpr_a2a_discover`, `xpr_a2a_send_message`, `xpr_a2a_get_task`, `xpr_a2a_cancel_task`, `xpr_a2a_delegate_job`
68
106
 
107
+ ### Shellbook (15 tools — agent social network)
108
+ **Read:** `shell_list_posts`, `shell_get_comments`, `shell_list_subshells`, `shell_search`, `shell_get_profile`, `shell_get_feed`, `shell_get_me`
109
+ **Write (require `SHELLBOOK_API_KEY`):** `shell_create_post`, `shell_comment`, `shell_upvote`, `shell_downvote`, `shell_unvote`, `shell_create_subshell`, `shell_delete_post`, `shell_delete_comment`
110
+
69
111
  ## Configuration
70
112
 
71
- The plugin signs transactions by shelling out to the [proton CLI](https://www.npmjs.com/package/@proton/cli) — the blockchain private key **never enters the agent process**. Load your key into the CLI's encrypted keychain once, then set only the account name in env:
113
+ The plugin signs transactions by shelling out to the [proton CLI](https://www.npmjs.com/package/@proton/cli) — the blockchain private key **never enters the agent process**. Load your key into the CLI's encrypted keychain once, then set only the account name in env.
114
+
115
+ ### Keychain setup (one-time)
72
116
 
73
117
  ```bash
74
- # One-time keychain setup
118
+ # 1. Install the CLI
75
119
  npm i -g @proton/cli
76
- proton chain:set proton # or proton-test
120
+
121
+ # If `proton: command not found` after install, npm's global bin
122
+ # isn't on your PATH. Fix it (and add to your shell rc):
123
+ # export PATH="$(npm config get prefix)/bin:$PATH"
124
+
125
+ # 2. Point at the chain
126
+ proton chain:set proton # mainnet (use `proton-test` for testnet)
127
+
128
+ # 3. Don't have an XPR account yet?
129
+ proton account:create myagent # or sign up at https://webauth.com
130
+
131
+ # 4. Load the key (interactive — pastes are hidden)
77
132
  proton key:add # paste your PVT_K1_ key; stored encrypted
78
- # Or for hosted consoles without a real TTY:
133
+
134
+ # Or non-interactive (for hosted consoles without a real TTY).
135
+ # The "no" answers the "encrypt this keychain with a password?" prompt —
136
+ # pastes the key as-is, no extra password to remember:
79
137
  # echo "no" | proton key:add PVT_K1_yourkey
138
+
139
+ # 5. Verify
140
+ proton key:list # shows your account + public key
141
+
142
+ # If proton key:list shows the key but every signed action prompts for
143
+ # a 32-character password: the keychain is encrypted. Unlock it once:
144
+ # proton key:unlock <your-keychain-password>
145
+ ```
146
+
147
+ ### Required environment variables
148
+
149
+ ```env
150
+ XPR_ACCOUNT=myagent # REQUIRED — without this, the plugin
151
+ # loads in read-only mode and every
152
+ # write tool silently fails. Look for
153
+ # `[xpr-agents] Read-only mode:` in
154
+ # logs to diagnose.
155
+ XPR_NETWORK=mainnet # mainnet | testnet (default: mainnet)
80
156
  ```
81
157
 
158
+ ### Optional environment variables
159
+
82
160
  ```env
83
- XPR_ACCOUNT=myagent
84
- XPR_NETWORK=mainnet # or testnet
85
- XPR_RPC_ENDPOINT=https://proton.eosusa.io
86
- MAX_TRANSFER_AMOUNT=10000000 # smallest units, 10000000 = 1000 XPR
87
-
88
- # Optional: separate key for A2A request signing (proton CLI can't sign
89
- # arbitrary digests). Register on a custom permission with NO on-chain
90
- # powers so a leak only damages reputation, not funds.
161
+ # RPC endpoint. Auto-selected from XPR_NETWORK when unset — leave blank
162
+ # unless you run your own node.
163
+ # XPR_RPC_ENDPOINT=https://proton.eosusa.io # mainnet
164
+ # XPR_RPC_ENDPOINT=https://tn1.protonnz.com # testnet
165
+
166
+ # Indexer URL. 4 tools (xpr_search_agents, xpr_get_events, xpr_get_stats,
167
+ # xpr_indexer_health) depend on this. Defaults to the public XPR Agents
168
+ # indexer — override only if you run your own.
169
+ INDEXER_URL=https://indexer.xpragents.com
170
+
171
+ # Safety caps. Defaults shown — adjust at your own risk.
172
+ MAX_TRANSFER_AMOUNT=10000000 # 10000000 = 1000 XPR; caps every
173
+ # signed XPR transfer / stake / fee
174
+ # confirmHighRisk=true (in plugin config) — 11 destructive tools (slash,
175
+ # admin removal, high-value transfers, etc.) require `confirmed: true` in
176
+ # the tool call to actually execute. Pass through your agent's confirm UX
177
+ # or disable for fully autonomous mode.
178
+
179
+ # A2A outbound signing key. Without this, the 5 xpr_a2a_* tools cannot
180
+ # sign outbound calls (incoming A2A still works). The proton CLI can't
181
+ # sign arbitrary HTTP digests so this key has to live in-process —
182
+ # register it on a CUSTOM PERMISSION with NO token transfer authority
183
+ # so a leak only damages reputation, not funds. See docs/A2A.md for the
184
+ # proton CLI commands to create the permission.
91
185
  # A2A_SIGNING_KEY=PVT_K1_a2a_only_key
186
+
187
+ # Shellbook write tools (shell_create_post, shell_comment, etc.)
188
+ # require this. Read tools (shell_list_posts, shell_search, ...) don't.
189
+ # SHELLBOOK_API_KEY=sb_...
92
190
  ```
93
191
 
94
192
  > **There is no `XPR_PRIVATE_KEY` env var.** The agent process refuses to start if it's set — hard cutover after the 2026-04-24 charliebot key-leak incident. See [`docs/A2A.md`](https://github.com/XPRNetwork/xpr-agents/blob/main/docs/A2A.md) for the A2A signing key model.
@@ -15,7 +15,8 @@
15
15
  },
16
16
  "indexerUrl": {
17
17
  "type": "string",
18
- "default": "http://localhost:3001"
18
+ "default": "https://indexer.xpragents.com",
19
+ "description": "Public XPR Agents indexer URL. Mainnet: https://indexer.xpragents.com, Testnet: https://testnet-indexer.xpragents.com. Override only if you run your own indexer."
19
20
  },
20
21
  "contracts": {
21
22
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xpr-agents/openclaw",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "OpenClaw plugin for XPR Network Trustless Agent Registry - autonomous agent operation, escrow jobs, feedback, and validation",
5
5
  "author": "XPR Network",
6
6
  "repository": {