lumi-check 0.0.0-stage → 0.1.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.
@@ -0,0 +1,59 @@
1
+ # Funding a small XRPL test wallet
2
+
3
+ Use a dedicated wallet, never your main one. Values were checked on 2026-10-23 against xrpl.org
4
+ (<https://xrpl.org/docs/concepts/accounts/reserves>). Reserves are set by validator vote and can change, so look up the
5
+ live values with the `server_state` or `fee` API before you rely on them.
6
+
7
+ ## 1. Reserves (Mainnet)
8
+
9
+ | Item | XRP locked |
10
+ |---|---|
11
+ | Base reserve per account | 1 XRP |
12
+ | Owner reserve per ledger object (each trust line, offer, ...) | 0.2 XRP |
13
+
14
+ These are the values in force since the December 2024 fee vote, which lowered them from 10 and 2 XRP.
15
+
16
+ Reserved XRP cannot be sent, but it can pay transaction fees. An account with one RLUSD trust line needs
17
+ **1.2 XRP** locked.
18
+
19
+ **Suggested funding:** about **2 XRP** for a test wallet. That is 1.2 XRP of reserve plus about 0.8 XRP of headroom
20
+ for fees (about 0.00001 XRP each) and XRP-priced buys. Add a small amount of RLUSD (for example 0.10 RLUSD) for
21
+ RLUSD-priced buys.
22
+
23
+ ## 2. Create and activate
24
+
25
+ 1. Generate a wallet offline (for example with `xrpl.js` `Wallet.generate()`) and store the seed in a file with mode 600.
26
+ Never paste it into chats, logs or the kit's command line.
27
+ 2. Send at least 1 XRP (2 XRP suggested) to the new address from an exchange or another wallet. The account exists
28
+ once that payment validates. Note which wallet funded it: Lumi counts **funding sources**, so wallets funded from the
29
+ same source count as one for per-endpoint caps and for confirming negative findings.
30
+
31
+ ## 3. RLUSD trust line
32
+
33
+ RLUSD (Ripple USD) on XRPL Mainnet:
34
+
35
+ - issuer `rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De`
36
+ - currency code `RLUSD` (hex `524C555344000000000000000000000000000000`)
37
+
38
+ Submit a `TrustSet`:
39
+
40
+ ```json
41
+ {
42
+ "TransactionType": "TrustSet",
43
+ "Account": "<your test wallet>",
44
+ "LimitAmount": { "currency": "524C555344000000000000000000000000000000", "issuer": "rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De", "value": "10" }
45
+ }
46
+ ```
47
+
48
+ A low limit (here 10 RLUSD) is a safety cap on what the wallet can hold. The trust line adds 0.2 XRP to the reserve.
49
+ Then buy or receive a little RLUSD.
50
+
51
+ ## 4. Register with Lumi
52
+
53
+ Give Lumi the wallet **address** (never the seed) when your contributor key is issued. Set
54
+ `LUMI_KIT_XRPL_SEED_FILE=/path/to/wallet.json` for `lumi-scan report` or `lumi-scan buy --live`.
55
+
56
+ ## 5. Getting the reserve back
57
+
58
+ Deleting an account (`AccountDelete`) returns the base reserve minus the deletion fee (currently 0.2 XRP). You must
59
+ remove trust lines first, which needs a zero RLUSD balance.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,14 @@
1
+ Lumi Check
2
+ Copyright 2026 Lumi Trades
3
+
4
+ This product (the Lumi Check client code in this directory) is licensed under the Apache License,
5
+ Version 2.0. See LICENSE.
6
+
7
+ Scope. The license covers only the client source code distributed in this package. It does NOT grant any
8
+ rights in, and does not license:
9
+ - Lumi's pooled dataset of submissions, observations and test results;
10
+ - Lumi's scoring, selection, anti-fraud logic and verification server;
11
+ - contributor keys issued by Lumi (they are revocable credentials, not property);
12
+ - the names "Lumi", "Lumi Trades" and "Tested by Lumi", and Lumi's badges and logos.
13
+ Use of Lumi's API and contributor program is governed by Lumi's terms (TERMS.md, DRAFT), not by this license.
14
+ Apache-2.0 section 6 (Trademarks) applies: no permission is granted to use Lumi's trade names or marks.
package/README.md CHANGED
@@ -1,3 +1,177 @@
1
- # Temporary Holding Version
1
+ # Lumi Check
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ `npm install lumi-check` (Node >= 20). CLI: `npx lumi-check` or, once installed, `lumi-scan`.
4
+
5
+ A thin client for checking an x402 seller **before you pay** and, if you choose, contributing **signed,
6
+ on-ledger-verifiable delivery receipts** to Lumi ("Tested by Lumi"). Scoring, verification, the catalog and anti-fraud
7
+ stay on Lumi's server.
8
+
9
+ > **License scope.** This client code is open source under **Apache-2.0** (see `LICENSE`; it was chosen for the
10
+ > patent grant). The license covers **only the code in this package**. It does **not** cover Lumi's pooled dataset,
11
+ > scoring, verification server, contributor keys, the "Tested by Lumi" name or badges. Those stay Lumi's and are not
12
+ > licensed. See `NOTICE` and `TERMS.md`.
13
+
14
+ ## Pre-pay trust check
15
+
16
+ Free. Returns `allow`, `warn` or `block` with reasons, the seller's current Lumi score and a link to the live report.
17
+ Every verdict is **signed by Lumi** (ed25519) and verified locally before it is used. Only the URL's origin + path is
18
+ sent (query strings are dropped). Paying Lumi never changes any score, tier, ranking or badge.
19
+
20
+ ```js
21
+ import { createLumiCheck, x402BeforePaymentHook, mcpOnPaymentRequiredHook, withOutcomeReporting } from "lumi-check";
22
+
23
+ const lumi = createLumiCheck(); // fail-open, 2.5 s timeout; pin keys with { publicKeys: ["<hex>"] }
24
+
25
+ // From code
26
+ const r = await lumi.check({ url: "https://seller.example/x402/data", payTo: "0x...", amountUsd: 0.01, network: "eip155:8453" });
27
+ // r.decision, r.reasons, r.score, r.link, r.verified
28
+
29
+ // x402 client (@x402/core / @x402/fetch): abort the payment when Lumi says "block"
30
+ client.onBeforePaymentCreation(x402BeforePaymentHook(lumi)); // { blockOnWarn: true } to be stricter
31
+
32
+ // MCP client (@x402/mcp): tool payments are checked by payTo
33
+ mcpClient.onPaymentRequired(mcpOnPaymentRequiredHook(lumi));
34
+
35
+ // Optional: one tier-1 delivery outcome per paid call, only once the user has said yes (see "What is shared")
36
+ const paidFetch = withOutcomeReporting(wrapFetchWithPayment(fetch, client), lumi);
37
+ ```
38
+
39
+ CLI: `lumi-scan check https://seller.example/x402/data --pay-to 0x... --amount 0.01`.
40
+
41
+ **Fail mode (defaults):** `fail_mode: "open"` with `timeout_ms: 2500`. If Lumi is slow,
42
+ unreachable, or returns a verdict whose signature does not verify, the result is `warn` (`lumi_unreachable` /
43
+ `lumi_unverified`) and the payment goes ahead. Set `"fail_mode": "closed"` in the config (or `failMode: "closed"`) to
44
+ block instead. The detailed paid check (`/v1/trust/check`, x402) adds reason details and a signed `lumi_receipt`.
45
+
46
+ Verify any Lumi-signed response yourself: `verifyLumiSigned(response, { publicKeys })`, keys at
47
+ `/v1/check/keys` (or `/.well-known/lumi-keys.json`).
48
+
49
+ ## What is shared
50
+
51
+ **Nothing is shared until you say yes.** Right after your first `lumi-scan check` has printed its result, the CLI asks
52
+ once (Enter means yes):
53
+
54
+ ```text
55
+ Shares only the seller's host, delivered yes/no and status class after paid calls. No wallet addresses, amounts, tx hashes or URL paths. Turn off any time: lumi-scan telemetry off
56
+ Share your results to help improve Lumi's public trust list? [Y/n]
57
+ ```
58
+
59
+ - Your answer is saved on your machine in `~/.lumi-scanner-kit/config.json` (`"telemetry": true|false` and
60
+ `"share_answered_at"`; `LUMI_KIT_CONFIG` changes the path) and the question never shows again.
61
+ - Change it any time: `lumi-scan telemetry on` / `lumi-scan telemetry off`, env `LUMI_CHECK_TELEMETRY=on|off`, or edit
62
+ `"telemetry"` in the config. `lumi-scan setup` shows the full disclosure and asks again.
63
+ - Runs where the kit cannot ask (no terminal, CI, `LUMI_NO_PROMPT=1`, the MCP server, or the library used from code)
64
+ never assume yes: sharing stays off and one hint on how to turn it on is printed to stderr.
65
+ - Your answer only controls what is shared. It never changes a check, a verdict or how any score is computed.
66
+
67
+ | | Default | What is sent | Reward |
68
+ |---|---|---|---|
69
+ | **Tier 1: delivery outcomes ("share your results")** | **OFF until you say yes** | After each paid call: seller host (or Lumi vendor id), delivered yes/no, coarse status class (`2xx`/`4xx`/`5xx`/`timeout`), and a fresh random token per report. **No** wallet address, amount, tx hash, URL path or query, payload, or stable ID. | nothing |
70
+ | **Tier 2: signed receipts** | **OFF** (opt-in) | Full signed delivery receipts (below), including the payment's chain and transaction ID, which is **public on-chain and can be linked to your wallet**. Nothing is sent unless you turn it on. | a public badge (nothing of monetary value) |
71
+
72
+ - Tier 1 on/off (any one): `lumi-scan telemetry on|off`, env `LUMI_CHECK_TELEMETRY=on|off`, or `"telemetry": true|false` in
73
+ `~/.lumi-scanner-kit/config.json`.
74
+ - Tier 2 on/off: `lumi-scan sharing on|off`, `"share_receipts": true|false`, or env `LUMI_SHARE_RECEIPTS=1|0`.
75
+ - **What a tier-2 receipt shares about the payment:** only the chain and the transaction ID (tx hash). There is no
76
+ amount, price, asset or wallet field in it. A transaction ID is public on its blockchain: anyone who has it can look
77
+ it up and link it to the wallet that paid and the amount. Lumi uses it to confirm on the public ledger that the
78
+ wallet that signed the receipt paid the seller. Lumi does not store the amount. It keeps the paying wallet address
79
+ (read from the ledger) with the submission only for the anti-gaming checks (caps, funding clusters, near-duplicates);
80
+ it is never published or shown by any public route, and is removed on account deletion.
81
+ - Env always wins over the config file. `lumi-scan telemetry status` / `sharing status` show the effective setting.
82
+ - Retention: raw data (tier-1 outcome counters, tier-2 submissions) is kept for 90 days, then deleted, and a raw day is
83
+ deleted only after it has been rolled up. The daily per-seller summaries (delivered, failed, status-class counts; no
84
+ wallet, amount, tx, query or client id) are kept long-term. Contributor accounts are kept while active (a verified
85
+ receipt in the last 12 months). Tier-1 outcomes are never a scoring input.
86
+
87
+ ### Deleting your account
88
+
89
+ `lumi-scan account delete` (asks you to type your key id; `--confirm <key_id>` when not in a terminal) calls the signed
90
+ `DELETE /v1/contrib/me`. You can also email hello@lumitrades.io and Lumi deletes it for you the same way.
91
+
92
+ - Deleted at once: your key (it can never sign again), label, public key, registered wallets and the funding wallet
93
+ recorded for each, own domains, demand opt-in, last-activity date, your badge, and every tier-2 receipt you shared
94
+ (including the stored copy), except receipts Lumi has already cited in a published, dated test result.
95
+ Kept, with no link to you: those cited receipts, with your wallet signature, paying-wallet link, kit details and key id
96
+ removed (the transaction hash, seller and delivery result stay because the published result cites them; they still
97
+ fall under the 90-day raw retention), and the anonymous per-seller daily summaries and tier-1 counters, which never
98
+ had a link to you. What remains of the key is a tombstone (the random key id, status "deleted" and dates) so it cannot
99
+ be reused. Payments on a public blockchain cannot be deleted by anyone.
100
+
101
+ ## How contributing works (tier 2, opt-in)
102
+
103
+ 1. **Passive (default).** You already buy from x402 sellers. After a purchase, `lumi-scan report` looks the payment
104
+ up on-ledger, builds a `counterparty_delivery_receipt` and signs it with the **paying wallet**. You submit it,
105
+ signed with your **contributor key**. There is no new spend.
106
+ 2. **Optional test-buy.** `lumi-scan wanted` shows what Lumi would like tested next (chosen server-side).
107
+ `lumi-scan buy <url>` is a **dry run** unless you add `--live`. It is capped locally at 0.01 per buy, 0.05 per day
108
+ per asset and 3 buys per day by default. Hard ceilings cannot be raised: 0.05, 0.5 and 10. Live buys are XRPL-only
109
+ in v0.
110
+ 3. Lumi checks every receipt **on-ledger** before it counts. It rejects self-tests (your own endpoints or wallets) and
111
+ caps receipts per key, per endpoint and per funding source. A negative finding counts only once a second,
112
+ independent contributor (or a Lumi re-buy) confirms it, and sellers can dispute a finding.
113
+ 4. **What counts.** Lumi looks up who first funded each registered wallet (Base explorer, XRPL activation, Stellar
114
+ `create_account`) and groups wallets with the same funder into one cluster. A cluster counts at most once per seller
115
+ per UTC day, however many keys it uses. Receipts from a wallet funded by the seller's pay-to wallet (or the seller's
116
+ own funder) count for nothing, as do receipts from wallets without a wallet-control proof. A second receipt from the
117
+ same paying wallet to the same seller within two minutes of another is refused as a near-duplicate even with a new tx
118
+ hash. Zero-weight receipts are stored and shown to you with `weight: 0` and the reason, but do not count toward your
119
+ badge and can't confirm anyone's negative finding. Exchange and faucet wallets Lumi lists are ignored as funders.
120
+ 5. **Badge only.** Verified receipts earn a public contributor badge (`GET /v1/contrib/badge/<handle>`), optionally
121
+ with a count of verified contributions (one per unique seller per day; self-tests and duplicates do not count).
122
+ There are no credits, money, perks, rankings or rate-limit changes, and contributing never changes how any score is
123
+ computed.
124
+
125
+ ## Quick start
126
+
127
+ ```bash
128
+ cd packages/scanner-kit && npm install # Node >= 20
129
+ node bin/lumi-scan.js check https://seller.example/x402/data # free check; after the first one, asks once whether to share results
130
+ node bin/lumi-scan.js setup # shows what is shared; choose tier 1 / tier 2
131
+ node bin/lumi-scan.js keygen # writes ~/.lumi-scanner-kit/contributor_key.json (mode 600) and prints the PUBLIC key
132
+ node bin/lumi-scan.js prove-wallet --network xrpl:0 # signs a wallet-control proof locally (needs the wallet secret env below)
133
+ # Send Lumi the public key, the wallet address(es) you pay from and one proof per wallet. Lumi issues a key_id: add it to
134
+ # the key file as "key_id". Wallets registered without a proof do not count until you run `prove-wallet --submit`.
135
+
136
+ node bin/lumi-scan.js quote https://seller.example/x402/data # free: 402 quote, latency, price per chain
137
+ node bin/lumi-scan.js wanted --limit 5 # what to test next (server-chosen)
138
+
139
+ # Passive: report a purchase you already made (the wallet secret is read from env or a file and never printed)
140
+ export LUMI_KIT_XRPL_SEED_FILE=/path/to/wallet.json # {"seed": "..."}; or LUMI_KIT_STELLAR_SECRET(_FILE) / LUMI_KIT_EVM_KEY(_FILE)
141
+ node bin/lumi-scan.js report --endpoint https://seller.example/x402/data --network xrpl:0 \
142
+ --tx <TX_HASH> --status 200 --outcome delivered # prints the signed receipt
143
+ node bin/lumi-scan.js sharing on # tier 2 opt-in (required before --submit)
144
+ node bin/lumi-scan.js report ... --submit # sends it to Lumi
145
+
146
+ node bin/lumi-scan.js buy https://seller.example/x402/data # dry run: shows what would be paid, against your caps
147
+ node bin/lumi-scan.js me # your own submissions and badge
148
+ node bin/lumi-scan.js share-demand on # opt in to aggregate demand stats (off by default)
149
+ ```
150
+
151
+ Outcomes: `delivered`, `no_data`, `empty_result`, `error_status`, `timeout`, `wrong_data`, `other`, `inconclusive`.
152
+
153
+ Extra test data recorded with each receipt (all optional): latency, HTTP status, response size, response SHA-256,
154
+ schema fingerprint (field names and types, not values), data freshness, facilitator and settlement time. No prices
155
+ or amounts. Response bodies are never uploaded, only their hash and shape.
156
+
157
+ MCP: the `lumi-trades-mcp` branch build adds `lumi_scan_seller` (quote + dry-run plan) and `lumi_report_receipt`
158
+ (passive report; set `LUMI_CONTRIB_KEY_FILE`).
159
+
160
+ ## What you get back
161
+
162
+ - Your own submissions, with their status and findings, and your badge (`lumi-scan me`).
163
+ - Normal Lumi API access.
164
+ - **Not** the raw pooled database.
165
+
166
+ ## Files
167
+
168
+ - `RECEIPT_FORMAT.md`: the receipt, its mapping to ARS `counterparty_delivery_receipt` v0.1, and request signing.
169
+ - `FUNDING_XRPL.md`: funding a small XRPL test wallet (reserve, RLUSD trustline).
170
+ - `TERMS.md`: contributor terms (DRAFT).
171
+ - `LICENSE` (Apache-2.0) and `NOTICE` (what is not licensed).
172
+
173
+ ## Security
174
+
175
+ - Wallet secrets come from env or files only. They are never logged or sent; output passes through a redactor.
176
+ - The contributor key signs API requests only and cannot move funds. Lumi can revoke it instantly.
177
+ - Use a dedicated low-balance wallet for test-buys.
@@ -0,0 +1,84 @@
1
+ # Receipt format: `counterparty_delivery_receipt` v0.1 plus `x_lumi_contrib`
2
+
3
+ Contributor receipts use the same body Lumi uses for its own signed test-buy receipts: the proposed AgenticRiskStandard
4
+ (ARS) evidence type `counterparty_delivery_receipt`, version `ars-evidence/0.1`. Kit-specific data goes in one
5
+ extension block, `x_lumi_contrib`. ARS consumers can ignore it, but it is covered by the hash.
6
+
7
+ ## Body
8
+
9
+ ```json
10
+ {
11
+ "type": "counterparty_delivery_receipt",
12
+ "version": "ars-evidence/0.1",
13
+ "receipt_id": "contrib-xrpl-<tx_hash>",
14
+ "issued_at": "2026-10-23T21:00:00.000Z",
15
+ "issuer": { "name": "Lumi Check contributor", "methodology_url": "https://api.lumitrades.io/v1/trust/methodology", "methodology_version": "v0" },
16
+ "seller": { "endpoint": "https://seller.example/x402/data", "domain": "seller.example", "pay_to": "r..." },
17
+ "payment": { "network": "xrpl:0", "tx_hash": "<64 hex>" },
18
+ "delivery": { "observed_at": "2026-10-23T20:59:58Z", "http_status": 200, "data_returned": true, "outcome": "delivered", "latency_ms": 840, "source": "contributor" },
19
+ "x_lumi_contrib": {
20
+ "format": "lumi-contrib/0.1",
21
+ "kit": { "name": "lumi-scanner-kit", "version": "0.1.0" },
22
+ "mode": "passive",
23
+ "measurements": { "latency_ms": 840, "http_status": 200, "response_bytes": 1834, "response_sha256": "<64 hex>",
24
+ "schema_fingerprint": "<32 hex>", "data_timestamp": "...", "freshness_s": 42, "quote_latency_ms": 120,
25
+ "facilitator": "...", "settlement_ms": 2100 }
26
+ },
27
+ "receipt_hash": "<sha256 hex>",
28
+ "signer": { "key_type": "ripple-keypairs", "address": "r...", "public_key": "...", "message": "lumi-receipt:xrpl:0:<tx>:<hash>", "signature": "..." }
29
+ }
30
+ ```
31
+
32
+ ## Payment block: chain and transaction ID only
33
+
34
+ `payment` carries exactly two fields, `network` and `tx_hash`. The server refuses a contributed receipt with any other
35
+ payment field (HTTP 422 `receipt_payment_fields_not_allowed`). The amount, asset and paying wallet are not in the
36
+ receipt; the server reads the public ledger to confirm that the signing wallet paid `seller.pay_to` a non-zero amount.
37
+ The server does not store the amount. Measurements carry no prices, amounts or addresses: a receipt whose
38
+ `x_lumi_contrib.measurements` has a `quotes`, `amount`, `price`, `asset`, `pay_to` or `payer` key is refused the same way.
39
+
40
+ A transaction ID is public: anyone who has it can look it up on the blockchain and link it to the paying wallet. The
41
+ kit's tier-2 opt-in says so before sharing is turned on.
42
+
43
+ ## Hash and signature
44
+
45
+ - `receipt_hash` is the SHA-256 of the canonical JSON of the body without `receipt_hash` and `signer`. Canonical JSON
46
+ means keys sorted and no whitespace, in the RFC 8785 style.
47
+ - The **paying wallet** signs `lumi-receipt:<network>:<tx_hash>:<receipt_hash>`:
48
+ - XRPL: `ripple-keypairs` over the UTF-8 hex
49
+ - Base: EIP-191 `personal_sign`
50
+ - Stellar: ed25519 over the UTF-8 message, base64-encoded
51
+ - The signer must be the wallet that sent the payment on-ledger. The kit checks this locally before signing (the
52
+ ledger's payer is passed to `signReceipt(body, signer, { payer })` and not written into the body), and the server
53
+ checks it again on-ledger.
54
+ - Anyone can verify a receipt offline, or on-ledger with `POST /v1/trust/receipts/verify?ledger=1`.
55
+
56
+ ## Mapping to ARS `counterparty_delivery_receipt` v0.1
57
+
58
+ | ARS field | Kit value |
59
+ |---|---|
60
+ | `type`, `version` | Unchanged |
61
+ | `receipt_id` | `contrib-<chain>-<tx_hash>`. Lumi's own receipts use `lumi-<chain>-<tx>`. |
62
+ | `issuer` | The contributor, described generically. Contributor identity is held server-side by key id and never put in the receipt. |
63
+ | `seller.*` | Same. `vendor_id` is omitted; the server resolves it. |
64
+ | `payment.network` | `xrpl:0`, `eip155:8453` and **`stellar:pubnet`**. Stellar extends the v0.1 enum and is documented here. |
65
+ | `payment.*` | Only `network` and `tx_hash`. ARS's `asset`, `amount`, `payer` and `ledger_result` are left out on purpose (data minimisation); the server reads them from the ledger to verify and does not store the amount. |
66
+ | `delivery.outcome` | Same 8-value enum. `data_returned` is `null` for `inconclusive`. |
67
+ | `delivery.source` | `"contributor"`. Lumi's own receipts use a descriptive string such as `"Lumi daily test-buy (XRPL)"`. |
68
+ | `x_lumi_contrib` | Extension. `format` versions the block; `kit.version` lets the server retire old kits (HTTP 426). |
69
+ | `receipt_hash`, `signer` | Same scheme as Lumi's receipts |
70
+
71
+ ## Submission request
72
+
73
+ `POST /v1/contrib/submissions` with body `{"mode":"passive"|"test_buy","receipt":{...}}`. It is signed with the
74
+ **contributor key** (ed25519), not the wallet.
75
+
76
+ ```
77
+ Lumi-Contributor-Key: lck_<16 hex>
78
+ Lumi-Timestamp: <unix ms> (must be within 5 minutes)
79
+ Lumi-Signature: base64(ed25519("lumi-contrib/v0\n<METHOD>\n<path+query>\n<ts>\n<sha256 hex of body>"))
80
+ Lumi-Kit: lumi-scanner-kit/0.1.0
81
+ ```
82
+
83
+ A seller dispute (`POST /v1/contrib/disputes`) is signed by the seller's `pay_to` wallet over
84
+ `lumi-dispute:<tx_hash>:<sha256(reason)>`.
package/TERMS.md ADDED
@@ -0,0 +1,97 @@
1
+ # Lumi Check: Contributor Terms (DRAFT, not in effect)
2
+
3
+ > **DRAFT for review. Not legal advice and not yet offered to anyone.** v0 is a private dry run with Lumi's own
4
+ > agents (Lumi and Lumi Scout) as the first two contributors.
5
+
6
+ ## 1. What these terms cover
7
+
8
+ These terms cover taking part in Lumi's contributor program: submitting receipts with a Lumi-issued contributor key.
9
+ The kit's **client code** is licensed separately under Apache-2.0 (`LICENSE`). That license covers only the client
10
+ code. It does not cover Lumi's pooled dataset, scoring, verification server, contributor keys, the "Tested by Lumi"
11
+ name or badges. Those remain Lumi's, and nothing here or in the license grants rights in them.
12
+
13
+ ## 2. Contributor keys
14
+
15
+ - Lumi issues keys at its discretion and can **revoke a key instantly**, with or without notice, for example for
16
+ suspected self-testing, boosting, collusion, false reports or abuse.
17
+ - A key is a revocable credential tied to the wallets you register. It is not transferable and has no value of its own.
18
+ - On revocation for abuse, Lumi may remove your badge and refuse future keys for the same wallets.
19
+
20
+ ## 3. What you submit
21
+
22
+ - Only **test data** about purchases from x402 sellers: the payment's chain and transaction ID (checked on-ledger),
23
+ HTTP status, timing, response size, response hash, schema fingerprint, freshness, facilitator and settlement time.
24
+ No amounts or prices, no response bodies and no personal data. A transaction ID is public on its blockchain: anyone
25
+ who has it can look it up and link it to the wallet that paid.
26
+ - You prove control of each wallet you register by signing a message bound to your contributor key. Wallets without a
27
+ proof do not count toward a badge.
28
+ - Wallets funded from the same source count as one contributor: at most one counted receipt per seller per UTC day
29
+ across all of them. Receipts from wallets funded by the seller (its pay-to wallet or that wallet's funder) do not count.
30
+ Lumi looks up and caches each wallet's first funder from public ledger data for this.
31
+ - You confirm that you actually made each payment from a wallet you control, and that it reflects a real
32
+ interaction. Self-testing (your own endpoints, domains or wallets) is not allowed and is rejected.
33
+ - Lumi verifies each receipt on-ledger before it counts. It may reject, hold, down-weight or remove any submission,
34
+ including negative findings that are not independently confirmed or that a seller disputes.
35
+ - You grant Lumi a perpetual, irrevocable, worldwide, royalty-free licence to use, combine, analyse and publish your
36
+ submissions, including in aggregate scores and badges.
37
+
38
+ ## 4. Recognition (badge only)
39
+
40
+ - Contributors with a **verified** tier-2 receipt get a public, pseudonymous **contributor badge**, optionally shown
41
+ with a count of verified contributions. One receipt per unique seller per UTC day counts; self-tests, duplicates,
42
+ unconfirmed negatives and disputed findings do not. Tier-1 anonymous outcomes earn nothing.
43
+ - That is the only reward. There are **no** credits, money, payments, prizes, discounts, rankings, early access,
44
+ rate-limit changes or other perks, and the badge has no monetary value.
45
+ - Contributing never changes how any score is computed. Lumi may remove a badge for abuse.
46
+ - Nothing in these terms is an employment, partnership or agency relationship.
47
+
48
+ ## 5. Sharing tiers
49
+
50
+ - **Tier 1 (off until you say yes):** nothing is sent before you agree. After your first check, the CLI asks once:
51
+ "Share your results to help improve Lumi's public trust list? [Y/n]". If you say yes, after each paid call the kit
52
+ sends an anonymous delivery outcome: seller host (or Lumi vendor id), delivered yes/no, and a coarse status class. No
53
+ wallet address, amount, tx hash, URL path or query, payload, or stable identifier. Your answer is stored only on your
54
+ machine. Runs where the kit cannot ask (no terminal, CI, MCP server, code) stay off. Change it any time with
55
+ `lumi-scan telemetry on|off`, `LUMI_CHECK_TELEMETRY=on|off`, or `"telemetry": true|false`. Sharing never changes how
56
+ any score is computed.
57
+ - **Tier 2 (off by default, opt-in):** full signed receipts. Nothing is sent unless you turn it on (`lumi-scan sharing on`).
58
+ Each receipt shares the payment's chain and transaction ID, which is public on-chain and can be linked to the wallet
59
+ that paid. The receipt has no amount or wallet field. Lumi confirms the payment on the public ledger and does not
60
+ store the amount. It keeps the paying wallet address (read from the ledger) only for the anti-gaming checks in
61
+ section 3; it is never published or shown publicly, and is removed if you delete your account.
62
+ - **Retention.** Raw data (tier-1 outcome counters and tier-2 submissions, including the stored receipt copy) is kept for
63
+ 90 days, then deleted. A raw tier-1 day is deleted only after it has been summarised. The summaries, one row per seller
64
+ per UTC day with delivered, failed and status-class counts (no wallet, amount, tx hash, URL query, payload or identifier
65
+ of you), are kept long-term.
66
+ - Your contributor account (key id, public key, registered wallets) is kept while it is active, meaning you submitted a
67
+ verified receipt in the last 12 months. It is not deleted at 90 days.
68
+ - **Deleting your account.** You can delete it at any time yourself (`lumi-scan account delete`, which calls the signed
69
+ `DELETE /v1/contrib/me`) or by emailing hello@lumitrades.io. Deletion cannot be undone.
70
+ Deleted at once: your key (it can never sign again), label, public key, registered wallets and the funding wallet
71
+ recorded for each, own domains, demand opt-in, last-activity date, your badge, and every tier-2 receipt you shared
72
+ (including the stored copy), except receipts Lumi has already cited in a published, dated test result.
73
+ Kept, with no link to you: those cited receipts, with your wallet signature, paying-wallet link, kit details and key id
74
+ removed (the transaction hash, seller and delivery result stay because the published result cites them; they still
75
+ fall under the 90-day raw retention), and the anonymous per-seller daily summaries and tier-1 counters, which never
76
+ had a link to you. What remains of the key is a tombstone (the random key id, status "deleted" and dates) so it cannot
77
+ be reused. Payments on a public blockchain cannot be deleted by anyone.
78
+
79
+ ## 6. Demand data
80
+
81
+ - Off by default. If you opt in (`share-demand on`), Lumi may use your passive purchases in **aggregate demand
82
+ statistics only**, at domain level, with at least two contributors per row and no key ids or wallets. You can opt
83
+ out at any time; opting out applies to future submissions.
84
+
85
+ ## 7. What you get
86
+
87
+ - Your own submissions back, with status and findings, and your badge (`/v1/contrib/me`), plus normal Lumi API access.
88
+ - **Not** access to the raw pooled database.
89
+
90
+ ## 8. Sellers
91
+
92
+ Sellers can dispute a finding by signing with their pay-to wallet. Lumi reviews disputes and may uphold or clear them.
93
+
94
+ ## 9. No warranty; limits
95
+
96
+ The kit is provided "as is" (see `LICENSE`). Test-buys spend real funds: you are responsible for your wallets, caps
97
+ and any losses. Lumi is not liable for seller behaviour. These terms may change, and the current DRAFT is not in effect.