janzeer-sdk 0.1.0__tar.gz

janzeer_sdk-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+site/
+.env

janzeer_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this package. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and the package follows [Semantic Versioning](https://semver.org/).
+
+## 0.1.0 — 2026-10-28
+
+First release on PyPI, for node 0.1.10 (API 1.1.0, protocol 3.4.0); the source has been public since 2026-10-01 and was
+verified against every node release from 0.1.0 to 0.1.10.
+
+- Keys: BIP39 mnemonics, Janzeer seed and `m/0/0/0` derivation, addresses with the EIP-55 display form, RFC-6979
+  low-S signatures.
+- Transactions: transfer, validator registration and exit, JZT-1 token operations; unsigned / signed objects.
+- Clients: REST and JSON-RPC over HTTP, blocking and `asyncio`; JSON-RPC over WebSocket with `newBlocks` and
+  `addressActivity` subscriptions and automatic resubscription.
+- Flows: `next_nonce`, `wait_for_finality`, `send_and_wait` and their async twins.
+- Vault: PBKDF2-HMAC-SHA256 (250,000 rounds) + AES-256-GCM, interoperable with the TypeScript, Dart and Kotlin SDKs.
+- WebSocket: a subscription is registered when its answer is read, so a notification sent right behind the answer is
+  never dropped.
+- Conformance: all vectors (format v2) and the 14-step end-to-end flow.

janzeer_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

janzeer_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.5
+Name: janzeer-sdk
+Version: 0.1.0
+Summary: Official Python SDK of the Janzeer blockchain: wallet keys and signing, transaction builders, REST, JSON-RPC and WebSocket clients.
+Project-URL: Homepage, https://janzeer.org
+Project-URL: Repository, https://github.com/janzeerorg/janzeer-sdk-python
+Project-URL: Documentation, https://github.com/janzeerorg/janzeer-sdk-python#readme
+Project-URL: Changelog, https://github.com/janzeerorg/janzeer-sdk-python/blob/master/CHANGELOG.md
+Author-email: Janzeer <info@janzeer.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: blockchain,janzeer,json-rpc,sdk,wallet
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: coincurve>=20
+Requires-Dist: httpx>=0.27
+Requires-Dist: pycryptodome>=3.20
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: websockets>=13; extra == 'dev'
+Provides-Extra: ws
+Requires-Dist: websockets>=13; extra == 'ws'
+Description-Content-Type: text/markdown
+
+# janzeer-sdk (Python)
+
+Official Python SDK for the [Janzeer](https://janzeer.org) blockchain — a stake-free, permissionless Layer-1 with
+instant finality. Wallet keys and signing, transaction builders, a REST client, JSON-RPC over HTTP and WebSocket
+subscriptions, blocking and `asyncio`. Non-custodial by construction: keys never leave your process, the node only
+verifies.
+
+![license](https://img.shields.io/badge/license-Apache--2.0-blue)
+![python](https://img.shields.io/badge/python-3.10%20%E2%80%93%203.13-blue)
+
+```bash
+pip install janzeer-sdk            # add [ws] for WebSocket subscriptions: pip install "janzeer-sdk[ws]"
+```
+
+Releases are published to PyPI from this repository's GitHub releases (trusted publishing, no stored token). To install the
+development head instead:
+
+```bash
+pip install "janzeer-sdk[ws] @ git+https://github.com/janzeerorg/janzeer-sdk-python"
+```
+
+## 60-second quickstart
+
+```python
+from janzeer import Account, JanzeerClient, JanzeerRpc, TxBuilder, format_jnz, wait_for_finality
+
+client = JanzeerClient("https://onion.janzeer.org")        # REST  (/api/v1)
+rpc    = JanzeerRpc("https://onion.janzeer.org")           # JSON-RPC (/rpc)
+me     = Account.from_mnemonic("abandon abandon … about")  # 12/24-word BIP39 phrase
+
+print(me.checksum_address, format_jnz(client.balance(me.address)))
+
+tx = me.sign_tx(TxBuilder.transfer(
+    sender=me.address, to="0x598b1301acef3baba6ce25e38dd17b723f7b98b1",
+    amount="1.25", data="hello", nonce=client.nonce(me.address),
+))
+client.submit(tx)                                          # HTTP 201, or a typed error
+final = wait_for_finality(rpc, tx.hash)                    # one or two 15-second slots
+print("final in block", final["blockHeight"])
+```
+
+That is the whole integration: derive → nonce → build → sign → submit → wait. A committed block is final
+(2f+1 BFT commit), so there is no confirmation count.
+
+The same with `asyncio`: `AsyncJanzeerClient`, `AsyncJanzeerRpc`, `JanzeerRpcWs` and `await_finality` have the same
+methods and return awaitables.
+
+## What is in the box
+
+| Area | Entry points | Guide |
+|---|---|---|
+| Keys & addresses | `mnemonic`, `Account`, `to_checksum_address`, `is_valid_address` | [wallet-and-keys](docs/wallet-and-keys.md) |
+| Transactions | `TxBuilder.transfer / register_validator / exit_validator / token.*` → `UnsignedTx` → `SignedTx` | [sending-transactions](docs/sending-transactions.md) |
+| Amounts | `to_scaled`, `from_scaled`, `format_jnz`, `parse_jnz`, `add_amounts`… | [sending-transactions](docs/sending-transactions.md#amounts) |
+| REST | `JanzeerClient` / `AsyncJanzeerClient`: balances, nonces, transactions, blocks, validators, tokens | [reading-chain-data](docs/reading-chain-data.md) |
+| JSON-RPC | `JanzeerRpc` / `AsyncJanzeerRpc` (HTTP, batches) and `JanzeerRpcWs` (WebSocket + `newBlocks` / `addressActivity`) | [json-rpc-and-subscriptions](docs/json-rpc-and-subscriptions.md) |
+| Flows | `wait_for_finality`, `send_and_wait`, `next_nonce` (and `await_finality`, `asend_and_wait`) | [json-rpc-and-subscriptions](docs/json-rpc-and-subscriptions.md#finality) |
+| Errors | `TxRejectedError`, `NonceMismatchError`, `RateLimitedError`, `RpcError`… | [errors](docs/errors.md) |
+| Vault | `encrypt_vault` / `decrypt_vault` (PBKDF2 + AES-GCM, compatible with the other SDKs) | [vault](docs/vault.md) |
+
+## Money is never a float
+
+Amounts are decimal **strings** (`"1.25"`), `int` (whole coins) or `decimal.Decimal`. A `float` is refused with a
+`TypeError` everywhere — in the builders, in the amount helpers and in request bodies — because `0.1` is not
+representable in binary and a payment must not depend on how a float prints. Responses are parsed losslessly:
+numbers with a fraction arrive as `Decimal`, `client.balance()` returns a decimal string.
+
+## Results are plain JSON
+
+Network calls return the node's JSON as `dict` / `list` values with the field names the node uses
+(`blockHeight`, `senderAddress`, …), documented in the
+[API reference](https://github.com/janzeerorg/janzeer-docs/blob/master/en/api-reference.md). Keys, transactions and
+errors are typed classes; the package ships `py.typed`.
+
+## Requirements
+
+- Python 3.10 – 3.13 on Linux, macOS or Windows.
+- `coincurve` (libsecp256k1), `pycryptodome` (keccak-256, AES-GCM), `httpx`; `websockets` for subscriptions.
+  Wheels exist for all three systems: no compiler is needed.
+
+## Compatibility
+
+| SDK | Node | REST envelope `version` | Wire protocol | Vectors |
+|---|---|---|---|---|
+| 0.1.x | 0.1.3 | 1.1.0 | 3.4.0 | v2 |
+
+`SPEC_VERSION` exports these values; the e2e test checks them against the node on the first call.
+
+## Examples
+
+Runnable scripts in [`examples/`](examples): a transfer to finality, an address-activity subscription, the token
+life cycle, a validator registration, and a vault round trip. They read the `JANZEER_*` environment variables
+described in [CONTRIBUTING](CONTRIBUTING.md).
+
+## Conformance
+
+This SDK reproduces, byte for byte, the public test vectors every Janzeer SDK is tested against (key derivation,
+addresses, every transaction preimage, hash and signature, the vault fixture) and passes the shared 14-step
+end-to-end flow: <https://github.com/janzeerorg/janzeer-sdk-conformance>. See [docs/conformance.md](docs/conformance.md).
+
+## Other SDKs
+
+[TypeScript](https://github.com/janzeerorg/janzeer-sdk-ts) · [Dart / Flutter](https://github.com/janzeerorg/janzeer-sdk-dart) ·
+[Kotlin / JVM / Android](https://github.com/janzeerorg/janzeer-sdk-kotlin) · [Go](https://github.com/janzeerorg/janzeer-sdk-go)
+
+## Licence
+
+Apache License 2.0 — see [LICENSE](LICENSE). Security reports: see [SECURITY](SECURITY.md).

janzeer_sdk-0.1.0/README.md

@@ -0,0 +1,108 @@
+# janzeer-sdk (Python)
+
+Official Python SDK for the [Janzeer](https://janzeer.org) blockchain — a stake-free, permissionless Layer-1 with
+instant finality. Wallet keys and signing, transaction builders, a REST client, JSON-RPC over HTTP and WebSocket
+subscriptions, blocking and `asyncio`. Non-custodial by construction: keys never leave your process, the node only
+verifies.
+
+![license](https://img.shields.io/badge/license-Apache--2.0-blue)
+![python](https://img.shields.io/badge/python-3.10%20%E2%80%93%203.13-blue)
+
+```bash
+pip install janzeer-sdk            # add [ws] for WebSocket subscriptions: pip install "janzeer-sdk[ws]"
+```
+
+Releases are published to PyPI from this repository's GitHub releases (trusted publishing, no stored token). To install the
+development head instead:
+
+```bash
+pip install "janzeer-sdk[ws] @ git+https://github.com/janzeerorg/janzeer-sdk-python"
+```
+
+## 60-second quickstart
+
+```python
+from janzeer import Account, JanzeerClient, JanzeerRpc, TxBuilder, format_jnz, wait_for_finality
+
+client = JanzeerClient("https://onion.janzeer.org")        # REST  (/api/v1)
+rpc    = JanzeerRpc("https://onion.janzeer.org")           # JSON-RPC (/rpc)
+me     = Account.from_mnemonic("abandon abandon … about")  # 12/24-word BIP39 phrase
+
+print(me.checksum_address, format_jnz(client.balance(me.address)))
+
+tx = me.sign_tx(TxBuilder.transfer(
+    sender=me.address, to="0x598b1301acef3baba6ce25e38dd17b723f7b98b1",
+    amount="1.25", data="hello", nonce=client.nonce(me.address),
+))
+client.submit(tx)                                          # HTTP 201, or a typed error
+final = wait_for_finality(rpc, tx.hash)                    # one or two 15-second slots
+print("final in block", final["blockHeight"])
+```
+
+That is the whole integration: derive → nonce → build → sign → submit → wait. A committed block is final
+(2f+1 BFT commit), so there is no confirmation count.
+
+The same with `asyncio`: `AsyncJanzeerClient`, `AsyncJanzeerRpc`, `JanzeerRpcWs` and `await_finality` have the same
+methods and return awaitables.
+
+## What is in the box
+
+| Area | Entry points | Guide |
+|---|---|---|
+| Keys & addresses | `mnemonic`, `Account`, `to_checksum_address`, `is_valid_address` | [wallet-and-keys](docs/wallet-and-keys.md) |
+| Transactions | `TxBuilder.transfer / register_validator / exit_validator / token.*` → `UnsignedTx` → `SignedTx` | [sending-transactions](docs/sending-transactions.md) |
+| Amounts | `to_scaled`, `from_scaled`, `format_jnz`, `parse_jnz`, `add_amounts`… | [sending-transactions](docs/sending-transactions.md#amounts) |
+| REST | `JanzeerClient` / `AsyncJanzeerClient`: balances, nonces, transactions, blocks, validators, tokens | [reading-chain-data](docs/reading-chain-data.md) |
+| JSON-RPC | `JanzeerRpc` / `AsyncJanzeerRpc` (HTTP, batches) and `JanzeerRpcWs` (WebSocket + `newBlocks` / `addressActivity`) | [json-rpc-and-subscriptions](docs/json-rpc-and-subscriptions.md) |
+| Flows | `wait_for_finality`, `send_and_wait`, `next_nonce` (and `await_finality`, `asend_and_wait`) | [json-rpc-and-subscriptions](docs/json-rpc-and-subscriptions.md#finality) |
+| Errors | `TxRejectedError`, `NonceMismatchError`, `RateLimitedError`, `RpcError`… | [errors](docs/errors.md) |
+| Vault | `encrypt_vault` / `decrypt_vault` (PBKDF2 + AES-GCM, compatible with the other SDKs) | [vault](docs/vault.md) |
+
+## Money is never a float
+
+Amounts are decimal **strings** (`"1.25"`), `int` (whole coins) or `decimal.Decimal`. A `float` is refused with a
+`TypeError` everywhere — in the builders, in the amount helpers and in request bodies — because `0.1` is not
+representable in binary and a payment must not depend on how a float prints. Responses are parsed losslessly:
+numbers with a fraction arrive as `Decimal`, `client.balance()` returns a decimal string.
+
+## Results are plain JSON
+
+Network calls return the node's JSON as `dict` / `list` values with the field names the node uses
+(`blockHeight`, `senderAddress`, …), documented in the
+[API reference](https://github.com/janzeerorg/janzeer-docs/blob/master/en/api-reference.md). Keys, transactions and
+errors are typed classes; the package ships `py.typed`.
+
+## Requirements
+
+- Python 3.10 – 3.13 on Linux, macOS or Windows.
+- `coincurve` (libsecp256k1), `pycryptodome` (keccak-256, AES-GCM), `httpx`; `websockets` for subscriptions.
+  Wheels exist for all three systems: no compiler is needed.
+
+## Compatibility
+
+| SDK | Node | REST envelope `version` | Wire protocol | Vectors |
+|---|---|---|---|---|
+| 0.1.x | 0.1.3 | 1.1.0 | 3.4.0 | v2 |
+
+`SPEC_VERSION` exports these values; the e2e test checks them against the node on the first call.
+
+## Examples
+
+Runnable scripts in [`examples/`](examples): a transfer to finality, an address-activity subscription, the token
+life cycle, a validator registration, and a vault round trip. They read the `JANZEER_*` environment variables
+described in [CONTRIBUTING](CONTRIBUTING.md).
+
+## Conformance
+
+This SDK reproduces, byte for byte, the public test vectors every Janzeer SDK is tested against (key derivation,
+addresses, every transaction preimage, hash and signature, the vault fixture) and passes the shared 14-step
+end-to-end flow: <https://github.com/janzeerorg/janzeer-sdk-conformance>. See [docs/conformance.md](docs/conformance.md).
+
+## Other SDKs
+
+[TypeScript](https://github.com/janzeerorg/janzeer-sdk-ts) · [Dart / Flutter](https://github.com/janzeerorg/janzeer-sdk-dart) ·
+[Kotlin / JVM / Android](https://github.com/janzeerorg/janzeer-sdk-kotlin) · [Go](https://github.com/janzeerorg/janzeer-sdk-go)
+
+## Licence
+
+Apache License 2.0 — see [LICENSE](LICENSE). Security reports: see [SECURITY](SECURITY.md).

janzeer_sdk-0.1.0/docs/conformance.md

@@ -0,0 +1,15 @@
+# Conformance
+
+Janzeer's signing scheme is custom (see [wallet-and-keys](wallet-and-keys.md)); a client that deviates by one byte
+produces transactions every node rejects. Two artefacts keep every official SDK in line:
+
+1. **Vectors** — `wallet-parity-vectors.json`, generated by the node's own cryptography: mnemonic → seed → key →
+   address, a raw-key address, and for each transaction type the exact signed bytes, hash and signature; plus an
+   EIP-55 table and an amount-scaling table. This SDK vendors them under `tests/vectors/` and `pytest` reproduces
+   every entry. The signature check is exact equality, which only holds with RFC-6979 and low-S.
+2. **The end-to-end flow** — `e2e/SPEC.md`, 14 steps against a real network: version gate, account, subscribe,
+   build and sign, submit over REST, idempotent resubmit over RPC, finality on another node, exact balance
+   arithmetic, the WebSocket notification, and three negative cases (nonce gap, forged signature, bad address).
+   `pytest -m e2e` runs it.
+
+Both live in <https://github.com/janzeerorg/janzeer-sdk-conformance>.

janzeer_sdk-0.1.0/docs/errors.md

@@ -0,0 +1,62 @@
+# Errors, nonces and rate limits
+
+Everything the SDK raises for a node or network problem extends `JanzeerError`. Branch on the class, never on message
+text. (Local input mistakes — a float amount, a bad address — raise the built-in `TypeError` / `ValueError`.)
+
+```
+JanzeerError
+├─ NetworkError              node unreachable / non-JSON / socket closed / timeout
+├─ TxRejectedError           the node refused a transaction — `type` names the rule
+│   └─ NonceMismatchError    `expected`, `got`, `address`
+├─ ApiError                  other REST errors: `status`, `type`, `body`
+│   ├─ ValidationError       400 with a list of field messages (`messages`)
+│   └─ NotFoundError         404
+├─ NotSynchronizedError      the node is still syncing (REST 400 / RPC -32002) — retry shortly
+├─ RateLimitedError          HTTP 429 / RPC -32004 — `retry_after` (seconds)
+├─ RpcError                  `code`, `data`
+│   ├─ RpcInvalidParamsError -32602 (data: field messages)
+│   ├─ RpcNotFoundError      -32000
+│   ├─ RpcLimitError         -32003 (range / timeout above the cap)
+│   └─ RpcMethodNotFoundError -32601
+└─ FinalityTimeoutError      wait_for_finality deadline (`last` view)
+```
+
+`TxRejectedError` and `NonceMismatchError` are the same classes on every transport (`transport` is `"rest"`, `"rpc"`
+or `"ws"`, with `http_status` or `rpc_code`).
+
+## Rejection types
+
+| `type` | Meaning | What to do |
+|---|---|---|
+| `INVALID_NONCE` | nonce ≠ the sender's next nonce (`NonceMismatchError.expected`) | refresh the nonce and rebuild |
+| `INCORRECT_SIGNATURE` | the signature does not verify | you signed other bytes — check the fields and the network id |
+| `INCORRECT_HASH` | `hash` ≠ double-SHA256 of the signed bytes | same |
+| `INCORRECT_ADDRESS` | `senderAddress` is not the address of `senderPublicKey` | derive both from one `Account` |
+| `INSUFFICIENT_ACTUAL_BALANCE` / `INSUFFICIENT_BALANCE` | not enough spendable balance for amount + fee | — |
+| `INCORRECT_PROMOTER_KEY` / `ALREADY_PROMOTER` | validator key invalid / already registered | — |
+
+A newer node may add types; `e.type` carries the string as received.
+
+## Nonce handling pattern
+
+```python
+def send_with_retry(build):                      # build(nonce) -> SignedTx
+    nonce = client.nonce(me.address)
+    for _ in range(3):
+        try:
+            return client.submit(build(nonce))
+        except NonceMismatchError as e:
+            if e.expected is None:
+                raise
+            nonce = e.expected
+    raise RuntimeError("could not agree on a nonce")
+```
+
+Pipelining: after submitting nonce `n`, `client.nonce()` already answers `n+1`; you may keep sending. If a pending
+transaction is dropped (6 h mempool expiry) the ones behind it become gaps — rebuild from `expected`.
+
+## Rate limits
+
+Nodes throttle `POST /api/v1/transactions/**` and `/rpc` per client IP (default 20 requests/s, burst 40). Reads are
+never limited. The clients retry **once** after a 429, honouring `Retry-After` (`retry_on_rate_limit=False` to
+disable); resubmitting a transaction is safe because acceptance is idempotent by hash.

janzeer_sdk-0.1.0/docs/json-rpc-and-subscriptions.md

@@ -0,0 +1,65 @@
+# JSON-RPC and subscriptions
+
+The node serves JSON-RPC 2.0 at `POST /rpc` and over WebSocket at `/rpc/ws` (the same methods, plus subscriptions).
+`JanzeerRpc`, `AsyncJanzeerRpc` and `JanzeerRpcWs` expose **one method per `janzeer_*` method**; `call()` sends
+anything else.
+
+```python
+rpc = JanzeerRpc("https://onion.janzeer.org")                 # '/rpc' appended automatically
+rpc.get_info(); rpc.get_chain_spec(); rpc.get_stats(); rpc.get_epoch(); rpc.get_genesis()
+rpc.get_account(addr); rpc.get_balance(addr); rpc.get_nonce(addr)
+rpc.get_transactions_by_address(addr, size=20)               # {list, pending, total…}
+rpc.get_transaction_by_hash(hash)                            # status FINAL | PENDING | UNKNOWN
+rpc.get_tip(); rpc.get_block_by_number(12, True); rpc.get_blocks(1, 100)
+rpc.list_validators(); rpc.get_active_validators(); rpc.get_validator(key)
+rpc.list_tokens(); rpc.get_token(token_id); rpc.get_token_holders(token_id)
+rpc.estimate_fee("transfer")                                 # {fee, rule: 'minimum' | 'exact'}
+rpc.send(signed_tx)
+rpc.call("janzeer_methods")                                  # raw
+```
+
+## Batches
+
+```python
+nonce, tip = rpc.batch([("janzeer_getNonce", {"address": addr}), ("janzeer_getTip", None)])
+```
+
+Up to 50 requests per batch, 512 KiB per body. Results keep the request order. One failing entry does not raise: its
+slot holds the error **instance** (`isinstance(x, JanzeerError)`), the others hold their results.
+
+## Finality
+
+`rpc.wait_for_finality(hash, timeout_ms)` is the node's long-poll (at most 60 s per call). The helper
+`wait_for_finality(rpc_or_client, hash, timeout=180)` chains calls until a client-side deadline, tolerates a dropped
+connection, and raises `FinalityTimeoutError` (with the last view) on expiry. Given a REST client it polls the
+transaction endpoints. `await_finality` is the async twin and also accepts a `JanzeerRpcWs`.
+
+A `FINAL` view carries `blockHash`, `blockHeight` and `receipt["successful"]`. The chain has instant finality (2f+1
+BFT commit), so no confirmation counting exists anywhere in the API.
+
+## WebSocket
+
+Install the extra: `pip install "janzeer-sdk[ws]"`.
+
+```python
+ws = await JanzeerRpcWs.connect("wss://onion.janzeer.org")         # http(s) URLs are converted
+await ws.get_tip()                                                 # every method works over the socket
+
+blocks = await ws.subscribe_new_blocks(print, from_height=100, include_transactions=True)
+watch  = await ws.subscribe_address_activity([addr1, addr2], lambda ev: print(ev["blockHeight"], ev["transaction"]["hash"]))
+await watch.unsubscribe()
+await ws.close()
+```
+
+- `newBlocks` replays committed blocks from `from_height`, then streams live ones — exactly once per height.
+- `addressActivity` fires for every **final** transaction whose sender, recipient or token recipient is in the list
+  (at most 1000 addresses, 16 subscriptions per socket).
+- A handler may be a plain function or an `async def`.
+- **Reconnect**: on a dropped socket the client reconnects with exponential backoff (1 s up to 30 s) and re-issues
+  every subscription; `subscription.id` changes, handlers stay. Pass `reconnect=False` to opt out and `on_event=` to
+  log `open` / `close` / `error` / `resubscribed`.
+- The node disconnects slow consumers (2 MiB send buffer, 5 s send timeout): keep handlers fast.
+
+## Errors
+
+JSON-RPC errors map to the same classes as REST — see [errors](errors.md).