praesia-verify 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,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.
@@ -0,0 +1,2 @@
1
+ Praesia chain verifier
2
+ Copyright 2026 Praesia SAS
@@ -0,0 +1,152 @@
1
+ Metadata-Version: 2.4
2
+ Name: praesia-verify
3
+ Version: 0.1.0
4
+ Summary: Verify a Praesia journal file on your own machine
5
+ Author: Praesia
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://praesia.ai
8
+ Requires-Python: >=3.11
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE
11
+ License-File: NOTICE
12
+ Dynamic: license-file
13
+
14
+ # praesia-verify
15
+
16
+ `praesia-verify` is a command-line tool that verifies a
17
+ [Praesia](https://praesia.ai) journal file on your own machine. It needs no
18
+ Praesia account, no network connection, and no third-party packages.
19
+
20
+ Praesia keeps a journal for each organization, with one record for each event,
21
+ such as a payment decision or the approval of a mandate. Each record holds the
22
+ hash of the previous record, so a change to one record breaks the journal at
23
+ that record. `praesia-verify` recomputes every hash and every link in the file.
24
+
25
+ ## Requirements
26
+
27
+ Python 3.11 or later.
28
+
29
+ ## Installation
30
+
31
+ ```text
32
+ pip install praesia-verify
33
+ ```
34
+
35
+ Some Python installations refuse `pip install` outside a virtual environment,
36
+ for example Homebrew Python and the system Python on Debian and Ubuntu. On
37
+ these installations, create a virtual environment first:
38
+
39
+ ```text
40
+ python3 -m venv praesia-check
41
+ praesia-check/bin/pip install praesia-verify
42
+ ```
43
+
44
+ Then run the tool as `praesia-check/bin/praesia-verify`.
45
+
46
+ On Windows, use the following commands:
47
+
48
+ ```text
49
+ py -m venv praesia-check
50
+ praesia-check\Scripts\pip install praesia-verify
51
+ ```
52
+
53
+ Then run the tool as `praesia-check\Scripts\praesia-verify`.
54
+
55
+ ## Usage
56
+
57
+ 1. In the Praesia console, open **Journal** and click **Download the journal**.
58
+ The file name contains your organization and the export time in UTC.
59
+ 1. Run `praesia-verify` on the file:
60
+
61
+ ```text
62
+ praesia-verify praesia-acme-journal-20261026T164047Z.jsonl
63
+ ```
64
+
65
+ The tool prints a report:
66
+
67
+ ```text
68
+ praesia chain verifier (chain-spec/1)
69
+
70
+ file /home/you/Downloads/praesia-acme-journal-20261026T164047Z.jsonl
71
+ format praesia-journal/1
72
+ organization 0193a4a0-1111-7000-8000-000000000001
73
+ mode sandbox
74
+ exported at 2026-10-26T14:00:00.000000Z
75
+ target sequence 3 verified 1..3
76
+ check 1 envelope recomputation ....... checked, clean
77
+ check 2 linkage ...................... checked, clean
78
+ check 3 sequence integrity ........... checked, clean (1..3, gap-free)
79
+ check 4 genesis rule ................. checked, clean (genesis: first record is (1, prev_hash null))
80
+
81
+ last hash 12a42f82babed52924fd670d622f7902af5e1d93309c6754cdcd616d58236748
82
+
83
+ result: clean
84
+ ```
85
+
86
+ 1. Compare `last hash` in the report with **Last hash** on the **Journal** page.
87
+
88
+ If the result is `clean` and the two hashes match, the file contains the journal
89
+ that the page shows, with its records intact and in order.
90
+
91
+ If a check fails, the result names the first sequence where the file breaks and
92
+ the check that found the break.
93
+
94
+ ## Checks
95
+
96
+ The tool runs every check on the records of the file, in the order of the lines:
97
+
98
+ 1. **Envelope recomputation:** the hash of each record equals the SHA-256 of its
99
+ eleven members in canonical form.
100
+ 1. **Linkage:** each record names the hash of the previous record.
101
+ 1. **Sequence integrity:** the records run from the first sequence to the target
102
+ sequence of the file with no gap, and the last record has the target hash of
103
+ the file.
104
+ 1. **Genesis rule:** the first record is record 1, with no previous record.
105
+
106
+ ## Exit codes
107
+
108
+ | Code | Meaning |
109
+ |---|---|
110
+ | `0` | Every check is clean. |
111
+ | `1` | A check failed. |
112
+ | `2` | The tool could not run the checks. |
113
+
114
+ The tool exits with code `2` in the following cases:
115
+
116
+ - A usage error.
117
+ - A file that is missing or unreadable.
118
+ - A file that is not a journal in the `praesia-journal/1` format.
119
+ - A report that the tool could not write.
120
+ - A Python version earlier than 3.11.
121
+
122
+ ## JSON output
123
+
124
+ To write the report as one JSON document to standard output, use
125
+ `--format json`:
126
+
127
+ ```text
128
+ praesia-verify praesia-acme-journal-20261026T164047Z.jsonl --format json
129
+ ```
130
+
131
+ The document contains the following members:
132
+
133
+ - `chain_spec`: the chain format that the tool checked.
134
+ - `verifier`: the name and format version of the tool.
135
+ - `result`: `clean` or `failed`.
136
+ - `file`: the path, format, organization, mode, export time, target sequence,
137
+ checked range, last hash, first failure, and the four checks.
138
+
139
+ ## File format
140
+
141
+ `chain-spec-1.md`, in the source distribution of this package, specifies the
142
+ journal and the journal file. You can write another verifier from it.
143
+
144
+ ## Limitations
145
+
146
+ - The tool reads the whole file into memory before it checks the file. It never
147
+ reports part of a file as clean.
148
+
149
+ ## License
150
+
151
+ This package is licensed under the Apache License, Version 2.0. See `LICENSE`
152
+ and `NOTICE`.
@@ -0,0 +1,139 @@
1
+ # praesia-verify
2
+
3
+ `praesia-verify` is a command-line tool that verifies a
4
+ [Praesia](https://praesia.ai) journal file on your own machine. It needs no
5
+ Praesia account, no network connection, and no third-party packages.
6
+
7
+ Praesia keeps a journal for each organization, with one record for each event,
8
+ such as a payment decision or the approval of a mandate. Each record holds the
9
+ hash of the previous record, so a change to one record breaks the journal at
10
+ that record. `praesia-verify` recomputes every hash and every link in the file.
11
+
12
+ ## Requirements
13
+
14
+ Python 3.11 or later.
15
+
16
+ ## Installation
17
+
18
+ ```text
19
+ pip install praesia-verify
20
+ ```
21
+
22
+ Some Python installations refuse `pip install` outside a virtual environment,
23
+ for example Homebrew Python and the system Python on Debian and Ubuntu. On
24
+ these installations, create a virtual environment first:
25
+
26
+ ```text
27
+ python3 -m venv praesia-check
28
+ praesia-check/bin/pip install praesia-verify
29
+ ```
30
+
31
+ Then run the tool as `praesia-check/bin/praesia-verify`.
32
+
33
+ On Windows, use the following commands:
34
+
35
+ ```text
36
+ py -m venv praesia-check
37
+ praesia-check\Scripts\pip install praesia-verify
38
+ ```
39
+
40
+ Then run the tool as `praesia-check\Scripts\praesia-verify`.
41
+
42
+ ## Usage
43
+
44
+ 1. In the Praesia console, open **Journal** and click **Download the journal**.
45
+ The file name contains your organization and the export time in UTC.
46
+ 1. Run `praesia-verify` on the file:
47
+
48
+ ```text
49
+ praesia-verify praesia-acme-journal-20261026T164047Z.jsonl
50
+ ```
51
+
52
+ The tool prints a report:
53
+
54
+ ```text
55
+ praesia chain verifier (chain-spec/1)
56
+
57
+ file /home/you/Downloads/praesia-acme-journal-20261026T164047Z.jsonl
58
+ format praesia-journal/1
59
+ organization 0193a4a0-1111-7000-8000-000000000001
60
+ mode sandbox
61
+ exported at 2026-10-26T14:00:00.000000Z
62
+ target sequence 3 verified 1..3
63
+ check 1 envelope recomputation ....... checked, clean
64
+ check 2 linkage ...................... checked, clean
65
+ check 3 sequence integrity ........... checked, clean (1..3, gap-free)
66
+ check 4 genesis rule ................. checked, clean (genesis: first record is (1, prev_hash null))
67
+
68
+ last hash 12a42f82babed52924fd670d622f7902af5e1d93309c6754cdcd616d58236748
69
+
70
+ result: clean
71
+ ```
72
+
73
+ 1. Compare `last hash` in the report with **Last hash** on the **Journal** page.
74
+
75
+ If the result is `clean` and the two hashes match, the file contains the journal
76
+ that the page shows, with its records intact and in order.
77
+
78
+ If a check fails, the result names the first sequence where the file breaks and
79
+ the check that found the break.
80
+
81
+ ## Checks
82
+
83
+ The tool runs every check on the records of the file, in the order of the lines:
84
+
85
+ 1. **Envelope recomputation:** the hash of each record equals the SHA-256 of its
86
+ eleven members in canonical form.
87
+ 1. **Linkage:** each record names the hash of the previous record.
88
+ 1. **Sequence integrity:** the records run from the first sequence to the target
89
+ sequence of the file with no gap, and the last record has the target hash of
90
+ the file.
91
+ 1. **Genesis rule:** the first record is record 1, with no previous record.
92
+
93
+ ## Exit codes
94
+
95
+ | Code | Meaning |
96
+ |---|---|
97
+ | `0` | Every check is clean. |
98
+ | `1` | A check failed. |
99
+ | `2` | The tool could not run the checks. |
100
+
101
+ The tool exits with code `2` in the following cases:
102
+
103
+ - A usage error.
104
+ - A file that is missing or unreadable.
105
+ - A file that is not a journal in the `praesia-journal/1` format.
106
+ - A report that the tool could not write.
107
+ - A Python version earlier than 3.11.
108
+
109
+ ## JSON output
110
+
111
+ To write the report as one JSON document to standard output, use
112
+ `--format json`:
113
+
114
+ ```text
115
+ praesia-verify praesia-acme-journal-20261026T164047Z.jsonl --format json
116
+ ```
117
+
118
+ The document contains the following members:
119
+
120
+ - `chain_spec`: the chain format that the tool checked.
121
+ - `verifier`: the name and format version of the tool.
122
+ - `result`: `clean` or `failed`.
123
+ - `file`: the path, format, organization, mode, export time, target sequence,
124
+ checked range, last hash, first failure, and the four checks.
125
+
126
+ ## File format
127
+
128
+ `chain-spec-1.md`, in the source distribution of this package, specifies the
129
+ journal and the journal file. You can write another verifier from it.
130
+
131
+ ## Limitations
132
+
133
+ - The tool reads the whole file into memory before it checks the file. It never
134
+ reports part of a file as clean.
135
+
136
+ ## License
137
+
138
+ This package is licensed under the Apache License, Version 2.0. See `LICENSE`
139
+ and `NOTICE`.