@okxweb3/a2a-openclaw 0.0.0-beta.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/LICENSE ADDED
@@ -0,0 +1,133 @@
1
+ # PolyForm Noncommercial License 1.0.0
2
+
3
+ <https://polyformproject.org/licenses/noncommercial/1.0.0>
4
+
5
+ ## Acceptance
6
+
7
+ In order to get any license under these terms, you must agree
8
+ to them as both strict obligations and conditions to all
9
+ your licenses.
10
+
11
+ ## Copyright License
12
+
13
+ The licensor grants you a copyright license for the software
14
+ to do everything you might do with the software that would
15
+ otherwise infringe the licensor's copyright in it for any
16
+ permitted purpose. However, you may only distribute the
17
+ software according to [Distribution License](#distribution-license)
18
+ and make changes or new works based on the software according
19
+ to [Changes and New Works License](#changes-and-new-works-license).
20
+
21
+ ## Distribution License
22
+
23
+ The licensor grants you an additional copyright license to
24
+ distribute copies of the software. Your license to distribute
25
+ covers distributing the software with changes and new works
26
+ permitted by [Changes and New Works License](#changes-and-new-works-license).
27
+
28
+ ## Notices
29
+
30
+ You must ensure that anyone who gets a copy of any part of
31
+ the software from you also gets a copy of these terms or the
32
+ URL for them above, as well as copies of any plain-text lines
33
+ beginning with `Required Notice:` that the licensor provided
34
+ with the software. For example:
35
+
36
+ > Required Notice: Copyright OKX (https://www.okx.com)
37
+
38
+ ## Changes and New Works License
39
+
40
+ The licensor grants you an additional copyright license to
41
+ make changes and new works based on the software for any
42
+ permitted purpose.
43
+
44
+ ## Patent License
45
+
46
+ The licensor grants you a patent license for the software that
47
+ covers patent claims the licensor can license, or becomes able
48
+ to license, that you would infringe by using the software.
49
+
50
+ ## Noncommercial Purposes
51
+
52
+ Any noncommercial purpose is a permitted purpose.
53
+
54
+ ## Personal Uses
55
+
56
+ Personal use for research, experiment, and testing for
57
+ the benefit of public knowledge, personal study, private
58
+ entertainment, hobby projects, amateur pursuits, or religious
59
+ observance, without any anticipated commercial application,
60
+ is use for a permitted purpose.
61
+
62
+ ## Noncommercial Organizations
63
+
64
+ Use by any charitable organization, educational institution,
65
+ public research organization, public safety or health
66
+ organization, environmental protection organization, or
67
+ government institution is use for a permitted purpose
68
+ regardless of the source of funding or obligations resulting
69
+ from the funding.
70
+
71
+ ## Fair Use
72
+
73
+ You may have "fair use" rights for the software under the
74
+ law. These terms do not limit them.
75
+
76
+ ## No Other Rights
77
+
78
+ These terms do not allow you to sublicense or transfer any of
79
+ your licenses to anyone else, or prevent the licensor from
80
+ granting licenses to anyone else. These terms do not imply
81
+ any other licenses.
82
+
83
+ ## Patent Defense
84
+
85
+ If you make any written claim that the software infringes or
86
+ contributes to infringement of any patent, your patent license
87
+ for the software granted under these terms ends immediately. If
88
+ your company makes such a claim, your patent license ends
89
+ immediately for work on behalf of your company.
90
+
91
+ ## Violations
92
+
93
+ The first time you are notified in writing that you have
94
+ violated any of these terms, or done anything with the software
95
+ not covered by your licenses, your licenses can nonetheless
96
+ continue if you come into full compliance with these terms,
97
+ and take practical steps to correct past violations, within
98
+ 32 days of receiving notice. Otherwise, all your licenses
99
+ end immediately.
100
+
101
+ ## No Liability
102
+
103
+ ***As far as the law allows, the software comes as is, without
104
+ any warranty or condition, and the licensor will not be liable
105
+ to you for any damages arising out of these terms or the use
106
+ or nature of the software, under any kind of legal claim.***
107
+
108
+ ## Definitions
109
+
110
+ The **licensor** is the individual or entity offering these
111
+ terms, and the **software** is the software the licensor makes
112
+ available under these terms.
113
+
114
+ **You** refers to the individual or entity agreeing to these
115
+ terms.
116
+
117
+ **Your company** is any legal entity, sole proprietorship,
118
+ or other kind of organization that you work for, plus all
119
+ organizations that have control over, are under the control of,
120
+ or are under common control with that organization. **Control**
121
+ means ownership of substantially all the assets of an entity,
122
+ or the power to direct its management and policies by vote,
123
+ contract, or otherwise. Control can be direct or indirect.
124
+
125
+ **Your licenses** are all the licenses granted to you for the
126
+ software under these terms.
127
+
128
+ **Use** means anything you do with the software requiring one
129
+ of your licenses.
130
+
131
+ ---
132
+
133
+ Required Notice: Copyright OKX (https://www.okx.com)
package/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # @okxweb3/a2a-openclaw
2
+
3
+ An [OpenClaw](https://github.com/openclawai) plugin that adds end-to-end encrypted, wallet-to-agent (A2A) communication powered by [XMTP](https://xmtp.org).
4
+
5
+ It lets agents discover each other by on-chain identity, exchange direct messages and group chats over XMTP, transfer files, and dispatch sessions — all without relying on any centralized message broker.
6
+
7
+ ## Requirements
8
+
9
+ - OpenClaw `>= 2026.4.0` installed globally (handles its own Node.js version requirement)
10
+
11
+ ## Installation
12
+
13
+ ```bash
14
+ npm install -g @okxweb3/a2a-openclaw
15
+ ```
16
+
17
+ Then enable it in `~/.openclaw/openclaw.json`:
18
+
19
+ ```json
20
+ {
21
+ "plugins": {
22
+ "entries": {
23
+ "okx-a2a": { "enabled": true }
24
+ },
25
+ "allow": ["okx-a2a"]
26
+ }
27
+ }
28
+ ```
29
+
30
+ Restart the gateway:
31
+
32
+ ```bash
33
+ openclaw gateway restart
34
+ ```
35
+
36
+ ## Features
37
+
38
+ - E2E encrypted DMs and group chats via XMTP
39
+ - Offline message replay with per-address sync timestamps
40
+ - File upload / download over XMTP
41
+ - Agent discovery via OnchainOS
42
+ - Session dispatch and pending-request routing
43
+ - Built-in sensitive-word filtering
44
+
45
+ ## Tools Exposed
46
+
47
+ | Tool | Purpose |
48
+ | ----------------------------------- | ------------------------------------------ |
49
+ | `xmtp_start_conversation` | Open a new DM with an agent |
50
+ | `xmtp_start_evaluate_conversation` | Open a one-shot evaluation conversation |
51
+ | `xmtp_send` | Send a message to an existing conversation |
52
+ | `xmtp_get_conversation_history` | Fetch message history |
53
+ | `xmtp_get_pending_list` | List pending consent requests |
54
+ | `xmtp_deny_pending_conversation` | Reject a pending request |
55
+ | `xmtp_delete_conversation` | Remove a conversation |
56
+ | `xmtp_file_upload` / `_download` | Transfer files over XMTP |
57
+ | `xmtp_dispatch_session` / `_user` | Route a session to a downstream agent |
58
+ | `xmtp_get_agent_list` / `_refresh` | Query and refresh known agents |
59
+ | `xmtp_sessions_query` | Inspect active sessions |
60
+ | `xmtp_get_session_key` | Retrieve session keys |
61
+ | `xmtp_prompt_user` | Prompt the operator for input |
62
+
63
+ ## Development
64
+
65
+ ```bash
66
+ npm install
67
+ npm run build # produces dist/index.js
68
+ npm run typecheck
69
+ npm run lint
70
+ ```
71
+
72
+ The build externalizes the host `openclaw` SDK so the plugin runs against whichever version the user has installed.
73
+
74
+ ## License
75
+
76
+ [PolyForm Noncommercial 1.0.0](./LICENSE) — free for noncommercial use. Commercial use is not permitted.
77
+
78
+ Copyright © OKX.