plumb-xrpl 0.1.0__tar.gz

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,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 McDavid Charleston
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ plumb-xrpl
2
+ Copyright 2026 Plumb Data
3
+
4
+ Extracted from Plumb (verified-reads), the payment-proof layer of the Plumb Data Exchange.
5
+ Licensed under the Apache License, Version 2.0.
@@ -0,0 +1,149 @@
1
+ Metadata-Version: 2.4
2
+ Name: plumb-xrpl
3
+ Version: 0.1.0
4
+ Summary: XRP Ledger transactions and payments proven without trusting any server: pinned validator list -> quorum-signed ledger -> hash links -> rebuilt transaction tree.
5
+ Author: Plumb Data
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/Mlcharle518/plumb-xrpl
8
+ Project-URL: Issues, https://github.com/Mlcharle518/plumb-xrpl/issues
9
+ Keywords: xrpl,xrp,rlusd,payments,proof,verification,x402,agents,light-client
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: Apache Software License
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Topic :: Security :: Cryptography
18
+ Classifier: Topic :: Office/Business :: Financial
19
+ Requires-Python: >=3.11
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ License-File: NOTICE
23
+ Requires-Dist: xrpl-py>=5.2
24
+ Requires-Dist: coincurve>=20
25
+ Requires-Dist: cryptography>=42
26
+ Requires-Dist: websockets>=13
27
+ Provides-Extra: mcp
28
+ Requires-Dist: mcp>=1.20; extra == "mcp"
29
+ Provides-Extra: test
30
+ Requires-Dist: pytest>=8; extra == "test"
31
+ Dynamic: license-file
32
+
33
+ # plumb-xrpl
34
+
35
+ XRP Ledger transactions and payments **proven without trusting any server**. Servers are only a source of bytes;
36
+ every link of the chain of trust is checked on your machine:
37
+
38
+ 1. **Ripple's validator list** (vl.ripple.com): the publisher's manifest must be signed by the pinned publisher master
39
+ key, the list by the publisher's signing key, and every validator's manifest by its own master key. An expired list
40
+ is refused. Validators that rotated their signing key are refreshed with a newer manifest signed by the same master key.
41
+ 2. **A ledger signed by a quorum (80%)** of those validators: each validation's signature is checked against the
42
+ validator's current signing key, over the validation's own bytes.
43
+ 3. **Hash links** from that ledger back to the transaction's ledger: every header carries its parent's hash, and each
44
+ header's hash is recomputed here (SHA-512Half over `LWR\0` + header).
45
+ 4. **The ledger's transaction tree**, rebuilt from every transaction and its metadata (SHAMap) and compared with the
46
+ header's transaction root.
47
+ 5. **The payment itself**, from those proven bytes: a successful Payment, to the payee, of the right currency (issuer
48
+ included), the *delivered* amount (never the requested `Amount`) at least the minimum, optionally from one payer and
49
+ carrying one InvoiceID.
50
+
51
+ A lie at any link is caught by the tests (`tests/test_prover.py`): wrong publisher key, forged validation, broken
52
+ hash link, tampered transaction, wrong recipient, underpayment, partial payment, wrong invoice.
53
+
54
+ This is the XRPL prover of the [Plumb Data Exchange](https://numba2witcheese.tail7d8d44.ts.net:10000/llms.txt), where
55
+ it has proven live RLUSD, XRP, payment-channel, escrow and batch payments on mainnet since October 2026. It is published
56
+ so any seller, agent or wallet can hold a payment to the same standard.
57
+
58
+ ## Install
59
+
60
+ ```
61
+ pip install plumb-xrpl # library + CLI
62
+ pip install "plumb-xrpl[mcp]" # + the MCP server for agents
63
+ ```
64
+
65
+ Python 3.11+. Dependencies: `xrpl-py` (byte codecs only; every hash and signature is checked here), `coincurve`
66
+ (secp256k1), `cryptography` (ed25519), `websockets`.
67
+
68
+ ## Command line
69
+
70
+ ```
71
+ plumb-xrpl tx 71100808DD3DF3EA693471FA... # any transaction, proven: fields + metadata
72
+ plumb-xrpl pay 71100808... r9Y5...P2d --token RLUSD --min 50000 # was at least 0.05 RLUSD delivered to this account?
73
+ plumb-xrpl pay 3A3915B2... rXXX --invoice C08EC114... # ...and does the payment carry this InvoiceID?
74
+ plumb-xrpl record # keep quorum proofs (see "How old can a payment be?")
75
+ plumb-xrpl serve # MCP server over stdio (extra: plumb-xrpl[mcp])
76
+ ```
77
+
78
+ Output is JSON in one envelope shape:
79
+
80
+ ```json
81
+ {"verified": true,
82
+ "value": {"verdict": "paid", "paid_raw": "50000", "reason": "...",
83
+ "tx": {"tx_hash": "...", "block_number": 100000000, "block_hash": "...", "final": true, "...": "..."},
84
+ "xrpl": {"level": "unl_quorum", "validators": 28, "of": 35, "quorum": 28, "proof_ledger": 100000120,
85
+ "walked": 120, "from_archive": false, "delivered": "...", "invoice_id": "..."}},
86
+ "anchor": {"root": "<hash of the quorum-signed ledger>", "source": "XRPL validator list (vl.ripple.com seq N, pinned publisher ...): 28/35 validator signatures on ledger ..., 120 hash links back"}}
87
+ ```
88
+
89
+ `verified: false` always comes with a `reason` and never a guess. A transaction the servers do not yet report in a
90
+ validated ledger is `verdict: pending_validation` with `retry_after_s`.
91
+
92
+ Amounts are raw integers: XRP in **drops**, issued currencies (RLUSD, ...) in **millionths** (value x 10^6, rounded
93
+ down). Tokens: `XRP` (default), `RLUSD`, or `CURRENCY.rIssuer`.
94
+
95
+ ## Library
96
+
97
+ ```python
98
+ from plumb_xrpl import XrplHistory, envelope
99
+
100
+ h = XrplHistory()
101
+ proof = h.verify_payment(tx_hash, recipient="r9Y5...P2d", token="RLUSD", min_raw=50_000, invoice=None)
102
+ # proof["verdict"] in {"paid", "not_paid", "underpaid", "failed_transaction", ...}; proof["xrpl"]["validators"] etc.
103
+
104
+ tx = h.transaction(tx_hash) # any transaction type, decoded fields + metadata, proven
105
+ out = envelope(lambda: h.transaction(tx_hash)) # the CLI's {"verified": ..., "value": ..., "anchor": ...} shape
106
+ ```
107
+
108
+ What a proven *transaction* gives you beyond payments: the metadata's `AffectedNodes` carry the final fields of every
109
+ ledger object the transaction created or changed, so the state **as of that transaction** is proven too: account
110
+ balances after it, a trust line, an escrow or payment channel it created, a credential it issued.
111
+
112
+ ## MCP server
113
+
114
+ `plumb-xrpl serve` exposes two tools over stdio: `get_transaction(tx_hash)` and
115
+ `verify_payment(tx_hash, recipient, token="", min_amount_raw="0", payer="", invoice="")`. Same envelope as the CLI.
116
+
117
+ ## How old can a payment be?
118
+
119
+ Validator signatures exist only live; rippled servers do not keep them. So a quorum proof comes from one of two places:
120
+
121
+ - **the live stream**: for a fresh payment, walk back from a ledger being validated now (up to `MAX_WALK` ledgers);
122
+ - **the proof archive**: `plumb-xrpl record` keeps one quorum-signed ledger per 256 ledgers (about every 16 minutes)
123
+ in `~/.verified-reads/xrpl-proofs.jsonl` (override with `VR_XRPL_ARCHIVE`). Any older payment is then proven by hash
124
+ links from the nearest archived proof. Run it as a service if you need to prove payments older than a few hours.
125
+
126
+ A payment older than both is reported **unverifiable**, never guessed. The validator list is cached at
127
+ `~/.verified-reads/xrpl-unl.json` (`VR_XRPL_UNL_CACHE`) and refreshed hourly.
128
+
129
+ ## What this does not do
130
+
131
+ - It proves **transactions**, not the current state tree. "Current balance of account X" needs the full account-state
132
+ SHAMap, which no public server proves. Balances are proven as of a transaction (see Library).
133
+ - It does not submit or sign anything. Keys never enter this package.
134
+ - It trusts Ripple's **validator list publisher key**, pinned in the source, and the 80% quorum rule of the XRP Ledger.
135
+ That is the same trust assumption as a rippled node you run yourself, without running one.
136
+
137
+ ## Development
138
+
139
+ ```
140
+ pip install -e ".[test,mcp]"
141
+ python -m pytest -q
142
+ ```
143
+
144
+ Fixtures are real mainnet bytes recorded with `tests/record_fixtures.py`; the tests replay them through a fake source
145
+ and then tamper with each link.
146
+
147
+ ## License
148
+
149
+ Apache-2.0. See `LICENSE` and `NOTICE`.
@@ -0,0 +1,117 @@
1
+ # plumb-xrpl
2
+
3
+ XRP Ledger transactions and payments **proven without trusting any server**. Servers are only a source of bytes;
4
+ every link of the chain of trust is checked on your machine:
5
+
6
+ 1. **Ripple's validator list** (vl.ripple.com): the publisher's manifest must be signed by the pinned publisher master
7
+ key, the list by the publisher's signing key, and every validator's manifest by its own master key. An expired list
8
+ is refused. Validators that rotated their signing key are refreshed with a newer manifest signed by the same master key.
9
+ 2. **A ledger signed by a quorum (80%)** of those validators: each validation's signature is checked against the
10
+ validator's current signing key, over the validation's own bytes.
11
+ 3. **Hash links** from that ledger back to the transaction's ledger: every header carries its parent's hash, and each
12
+ header's hash is recomputed here (SHA-512Half over `LWR\0` + header).
13
+ 4. **The ledger's transaction tree**, rebuilt from every transaction and its metadata (SHAMap) and compared with the
14
+ header's transaction root.
15
+ 5. **The payment itself**, from those proven bytes: a successful Payment, to the payee, of the right currency (issuer
16
+ included), the *delivered* amount (never the requested `Amount`) at least the minimum, optionally from one payer and
17
+ carrying one InvoiceID.
18
+
19
+ A lie at any link is caught by the tests (`tests/test_prover.py`): wrong publisher key, forged validation, broken
20
+ hash link, tampered transaction, wrong recipient, underpayment, partial payment, wrong invoice.
21
+
22
+ This is the XRPL prover of the [Plumb Data Exchange](https://numba2witcheese.tail7d8d44.ts.net:10000/llms.txt), where
23
+ it has proven live RLUSD, XRP, payment-channel, escrow and batch payments on mainnet since October 2026. It is published
24
+ so any seller, agent or wallet can hold a payment to the same standard.
25
+
26
+ ## Install
27
+
28
+ ```
29
+ pip install plumb-xrpl # library + CLI
30
+ pip install "plumb-xrpl[mcp]" # + the MCP server for agents
31
+ ```
32
+
33
+ Python 3.11+. Dependencies: `xrpl-py` (byte codecs only; every hash and signature is checked here), `coincurve`
34
+ (secp256k1), `cryptography` (ed25519), `websockets`.
35
+
36
+ ## Command line
37
+
38
+ ```
39
+ plumb-xrpl tx 71100808DD3DF3EA693471FA... # any transaction, proven: fields + metadata
40
+ plumb-xrpl pay 71100808... r9Y5...P2d --token RLUSD --min 50000 # was at least 0.05 RLUSD delivered to this account?
41
+ plumb-xrpl pay 3A3915B2... rXXX --invoice C08EC114... # ...and does the payment carry this InvoiceID?
42
+ plumb-xrpl record # keep quorum proofs (see "How old can a payment be?")
43
+ plumb-xrpl serve # MCP server over stdio (extra: plumb-xrpl[mcp])
44
+ ```
45
+
46
+ Output is JSON in one envelope shape:
47
+
48
+ ```json
49
+ {"verified": true,
50
+ "value": {"verdict": "paid", "paid_raw": "50000", "reason": "...",
51
+ "tx": {"tx_hash": "...", "block_number": 100000000, "block_hash": "...", "final": true, "...": "..."},
52
+ "xrpl": {"level": "unl_quorum", "validators": 28, "of": 35, "quorum": 28, "proof_ledger": 100000120,
53
+ "walked": 120, "from_archive": false, "delivered": "...", "invoice_id": "..."}},
54
+ "anchor": {"root": "<hash of the quorum-signed ledger>", "source": "XRPL validator list (vl.ripple.com seq N, pinned publisher ...): 28/35 validator signatures on ledger ..., 120 hash links back"}}
55
+ ```
56
+
57
+ `verified: false` always comes with a `reason` and never a guess. A transaction the servers do not yet report in a
58
+ validated ledger is `verdict: pending_validation` with `retry_after_s`.
59
+
60
+ Amounts are raw integers: XRP in **drops**, issued currencies (RLUSD, ...) in **millionths** (value x 10^6, rounded
61
+ down). Tokens: `XRP` (default), `RLUSD`, or `CURRENCY.rIssuer`.
62
+
63
+ ## Library
64
+
65
+ ```python
66
+ from plumb_xrpl import XrplHistory, envelope
67
+
68
+ h = XrplHistory()
69
+ proof = h.verify_payment(tx_hash, recipient="r9Y5...P2d", token="RLUSD", min_raw=50_000, invoice=None)
70
+ # proof["verdict"] in {"paid", "not_paid", "underpaid", "failed_transaction", ...}; proof["xrpl"]["validators"] etc.
71
+
72
+ tx = h.transaction(tx_hash) # any transaction type, decoded fields + metadata, proven
73
+ out = envelope(lambda: h.transaction(tx_hash)) # the CLI's {"verified": ..., "value": ..., "anchor": ...} shape
74
+ ```
75
+
76
+ What a proven *transaction* gives you beyond payments: the metadata's `AffectedNodes` carry the final fields of every
77
+ ledger object the transaction created or changed, so the state **as of that transaction** is proven too: account
78
+ balances after it, a trust line, an escrow or payment channel it created, a credential it issued.
79
+
80
+ ## MCP server
81
+
82
+ `plumb-xrpl serve` exposes two tools over stdio: `get_transaction(tx_hash)` and
83
+ `verify_payment(tx_hash, recipient, token="", min_amount_raw="0", payer="", invoice="")`. Same envelope as the CLI.
84
+
85
+ ## How old can a payment be?
86
+
87
+ Validator signatures exist only live; rippled servers do not keep them. So a quorum proof comes from one of two places:
88
+
89
+ - **the live stream**: for a fresh payment, walk back from a ledger being validated now (up to `MAX_WALK` ledgers);
90
+ - **the proof archive**: `plumb-xrpl record` keeps one quorum-signed ledger per 256 ledgers (about every 16 minutes)
91
+ in `~/.verified-reads/xrpl-proofs.jsonl` (override with `VR_XRPL_ARCHIVE`). Any older payment is then proven by hash
92
+ links from the nearest archived proof. Run it as a service if you need to prove payments older than a few hours.
93
+
94
+ A payment older than both is reported **unverifiable**, never guessed. The validator list is cached at
95
+ `~/.verified-reads/xrpl-unl.json` (`VR_XRPL_UNL_CACHE`) and refreshed hourly.
96
+
97
+ ## What this does not do
98
+
99
+ - It proves **transactions**, not the current state tree. "Current balance of account X" needs the full account-state
100
+ SHAMap, which no public server proves. Balances are proven as of a transaction (see Library).
101
+ - It does not submit or sign anything. Keys never enter this package.
102
+ - It trusts Ripple's **validator list publisher key**, pinned in the source, and the 80% quorum rule of the XRP Ledger.
103
+ That is the same trust assumption as a rippled node you run yourself, without running one.
104
+
105
+ ## Development
106
+
107
+ ```
108
+ pip install -e ".[test,mcp]"
109
+ python -m pytest -q
110
+ ```
111
+
112
+ Fixtures are real mainnet bytes recorded with `tests/record_fixtures.py`; the tests replay them through a fake source
113
+ and then tamper with each link.
114
+
115
+ ## License
116
+
117
+ Apache-2.0. See `LICENSE` and `NOTICE`.
@@ -0,0 +1,12 @@
1
+ """plumb-xrpl: XRP Ledger transactions and payments proven without trusting any server.
2
+
3
+ Servers are only a source of bytes. Every link is checked here: Ripple's validator list against the pinned publisher
4
+ key, a ledger signed by 80% of those validators, hash links back to the payment's ledger, the ledger's rebuilt
5
+ transaction tree, and the payment itself from those proven bytes. See `plumb_xrpl.prover`.
6
+ """
7
+ from .prover import (Archive, HistoryError, PendingValidation, Source, XrplError, XrplHistory, envelope, judge,
8
+ parse_token, record)
9
+
10
+ __version__ = "0.1.0"
11
+ __all__ = ["Archive", "HistoryError", "PendingValidation", "Source", "XrplError", "XrplHistory", "envelope", "judge",
12
+ "parse_token", "record", "__version__"]
@@ -0,0 +1,3 @@
1
+ from .cli import main
2
+
3
+ main()
@@ -0,0 +1,65 @@
1
+ """Command line: `plumb-xrpl tx|pay|record|serve`. Output is JSON in Plumb's envelope shape:
2
+ {"verified": true, "value": ..., "anchor": {...}} or {"verified": false, "reason": "..."}."""
3
+ from __future__ import annotations
4
+
5
+ import argparse
6
+ import json
7
+ import sys
8
+
9
+ from . import __version__
10
+ from . import prover as X
11
+
12
+
13
+ def _print(o: object) -> None:
14
+ print(json.dumps(o, indent=2, default=str))
15
+
16
+
17
+ def cmd_tx(a: argparse.Namespace) -> None:
18
+ _print(X.envelope(lambda: X.XrplHistory().transaction(a.hash)))
19
+
20
+
21
+ def cmd_pay(a: argparse.Namespace) -> None:
22
+ _print(X.envelope(lambda: X.XrplHistory().verify_payment(a.hash, a.recipient, a.token, a.min, a.payer or None,
23
+ a.invoice or None)))
24
+
25
+
26
+ def cmd_record(a: argparse.Namespace) -> None:
27
+ print(f"recording XRPL validator-quorum proofs every {a.every} ledgers to {X.Archive().path} (Ctrl+C to stop)",
28
+ flush=True)
29
+ X.record(every=a.every)
30
+
31
+
32
+ def cmd_serve(_a: argparse.Namespace) -> None:
33
+ try:
34
+ from .server import main as serve
35
+ except ImportError as e: # the MCP server is an extra
36
+ sys.exit(f"the MCP server needs the extra: pip install plumb-xrpl[mcp] ({e})")
37
+ serve()
38
+
39
+
40
+ def main(argv: list[str] | None = None) -> None:
41
+ ap = argparse.ArgumentParser(prog="plumb-xrpl",
42
+ description="XRP Ledger transactions and payments proven without trusting any server.")
43
+ ap.add_argument("--version", action="version", version=f"plumb-xrpl {__version__}")
44
+ sub = ap.add_subparsers(dest="cmd", required=True)
45
+ p = sub.add_parser("tx", help="any transaction, proven: full fields + metadata")
46
+ p.add_argument("hash")
47
+ p.set_defaults(fn=cmd_tx)
48
+ p = sub.add_parser("pay", help="was this payment made? verdict bound to recipient, token, minimum, payer, invoice")
49
+ p.add_argument("hash")
50
+ p.add_argument("recipient")
51
+ p.add_argument("--token", default="", help="XRP (default), RLUSD, or CURRENCY.rIssuer")
52
+ p.add_argument("--min", type=int, default=0, help="minimum delivered amount: XRP drops or issued millionths")
53
+ p.add_argument("--from", dest="payer", default="", help="count only a payment from this account")
54
+ p.add_argument("--invoice", default="", help="the payment InvoiceID must equal this (64 hex)")
55
+ p.set_defaults(fn=cmd_pay)
56
+ p = sub.add_parser("record", help="keep validator-quorum proofs so payments older than the live stream stay provable")
57
+ p.add_argument("--every", type=int, default=X.ARCHIVE_EVERY)
58
+ p.set_defaults(fn=cmd_record)
59
+ sub.add_parser("serve", help="MCP server over stdio (extra: plumb-xrpl[mcp])").set_defaults(fn=cmd_serve)
60
+ a = ap.parse_args(argv)
61
+ a.fn(a)
62
+
63
+
64
+ if __name__ == "__main__":
65
+ main()