purechain-sdk 0.0.1__tar.gz

purechain_sdk-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,72 @@
+name: Release
+
+# Publishing is irreversible — PyPI never lets a version number be reused, even
+# after a release is deleted. So this fires only on an explicit version tag,
+# never on a push to main, and it runs the full gate before publishing.
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    # Requires a PyPI Trusted Publisher configured for this repo and workflow.
+    # That exchanges a short-lived OIDC token for upload rights, so no API token
+    # is ever stored as a repository secret.
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Verify the tag matches pyproject.toml
+        # A tag that disagrees with the manifest publishes the wrong version
+        # under the right name, and PyPI will not let it be corrected.
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          PKG=$(python -c "import tomllib;print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          if [ "$TAG" != "$PKG" ]; then
+            echo "Tag v$TAG does not match pyproject.toml version $PKG" >&2
+            exit 1
+          fi
+          echo "Publishing version $PKG"
+
+      - name: Install from the lockfile
+        run: uv sync --all-extras --frozen
+
+      - name: Typecheck and lint
+        run: |
+          uv run mypy
+          uv run ruff check src tests
+
+      - name: Test
+        # Offline suite only. The live suites reach the public network, and the
+        # write suite would broadcast real transactions from CI.
+        run: uv run pytest -q
+
+      - name: Build
+        run: uv build
+
+      - name: Check the wheel carries py.typed
+        # Without the PEP 561 marker the library ships untyped, silently
+        # discarding every annotation for consumers.
+        run: |
+          python - <<'EOF'
+          import glob, sys, zipfile
+          wheel = glob.glob("dist/*.whl")[0]
+          names = zipfile.ZipFile(wheel).namelist()
+          if "purechain/py.typed" not in names:
+              sys.exit("py.typed missing from the wheel — consumers would get no types")
+          print(f"py.typed present in {wheel}")
+          EOF
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

purechain_sdk-0.0.1/.gitignore

@@ -0,0 +1,30 @@
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+
+# Secrets. Keystores and key material must never be committed — the live write
+# tests generate throwaway keys at runtime and write nothing to disk.
+.env
+*.key
+keystore*.json

purechain_sdk-0.0.1/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 2026 Pure Wallet LLC
+
+   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.

purechain_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,320 @@
+Metadata-Version: 2.5
+Name: purechain-sdk
+Version: 0.0.1
+Summary: Client library for the PureChain network family (geth, besu, dag variants)
+Project-URL: Homepage, https://github.com/isongjosiah/purechain-py
+Project-URL: Repository, https://github.com/isongjosiah/purechain-py
+Project-URL: Issues, https://github.com/isongjosiah/purechain-py/issues
+Author: isongjosiah
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: blockchain,clique,ethereum,evm,purechain,web3,zero-gas
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: web3<9,>=7.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# purechain
+
+A client library for the PureChain network family. Three variants — `geth`,
+`besu`, `dag` — behind one interface, so application code does not change when
+the variant does.
+
+Status: the **geth** variant (the live public PureChain network) is implemented
+and tested against the real chain. `besu` and `dag` are stubs with the full
+interface in place; every call raises `NotImplementedError_` naming the variant.
+
+This is the Python half of a pair; the TypeScript library mirrors it method for
+method, with the same types, error codes, and defaults.
+
+```bash
+pip install purechain-sdk
+```
+
+> Installed as `purechain-sdk`, imported as `purechain` — the distribution name
+> and the import name are separate in Python. The TypeScript library is
+> `@purechain/client` on npm; the two registries differ only in the name, not in
+> the API.
+
+## Usage
+
+The API is async throughout.
+
+```python
+import asyncio
+from purechain import PrivateKeySigner, TxRequest, create_client
+
+async def main():
+    async with create_client(signer=PrivateKeySigner(PRIVATE_KEY)) as client:
+        tx_hash = await client.send_transaction(TxRequest(to="0xabc...", value=1))
+        receipt = await client.wait_for(tx_hash)
+        print(receipt.status, receipt.block_number)
+
+asyncio.run(main())
+```
+
+Point it at your own node, or at a private deployment with its own genesis:
+
+```python
+client = create_client(
+    url="http://localhost:8545",
+    network={"name": "devnet", "chain_id": 424242},
+)
+```
+
+## What this library does differently
+
+PureChain is a permissioned, free-gas EVM network, and three of its properties
+break assumptions that general-purpose Ethereum libraries build in. Each one is
+handled here by default rather than left to the caller.
+
+**Fees are zero, and the oracle is never consulted.** Transactions are built with
+zero fees and signed locally; `eth_gasPrice` is not called. A node started
+without the `--gpo.*` flags reports a non-zero price on a chain whose base fee is
+pinned to zero, so trusting the oracle is how callers end up overpaying — or
+getting rejected. Override with `fees` if a network ever charges:
+
+```python
+from purechain import TipFeePolicy
+create_client(fees=TipFeePolicy(tip_wei=1_000_000_000))
+```
+
+**Blocks are not produced on a fixed interval.** Smart Auto Mining seals only
+while transactions are pending and pauses when the network is idle, so a static
+head is healthy rather than stalled. `wait_for` therefore defaults to inclusion,
+not a confirmation count — waiting for depth on a chain that goes quiet right
+afterwards would never resolve. Depth is opt-in and always bounded:
+
+```python
+await client.wait_for(tx_hash)                                    # inclusion
+await client.wait_for(tx_hash, WaitOptions(until="final", confirmations=3))
+```
+
+A timeout against a head that never moved raises `ChainIdleError` rather than
+`TimeoutError_`, so "the network is quiet" is distinguishable from "something
+went wrong".
+
+**There is no replace-by-fee.** A pending transaction cannot be bumped or
+cancelled at zero fee — the pool requires a strictly higher fee, and nothing is
+higher than zero. Sends are serialised per sender so concurrent calls cannot
+collide on a nonce, because the usual escape hatch does not exist here.
+
+## Capabilities are detected, not assumed
+
+Which JSON-RPC namespaces are available is a property of the node you connected
+to, not of the variant. The public endpoints run `--http.api eth,net,web3`, so
+`clique_*`, `txpool_*`, `admin_*` and `debug_*` are absent even though
+purechain-geth implements them.
+
+```python
+caps = await client.capabilities()
+caps.zero_fee                    # True
+caps.replace_by_fee              # False
+caps.subscriptions               # False -- public endpoints are HTTP-only
+caps.has("clique_getSigners")    # False on the public RPC
+caps.validator_api               # "clique" | "qbft" | "ibft" | None
+```
+
+Anything outside the core surface is reachable through the raw escape hatch,
+once you have checked for it:
+
+```python
+if caps.has("clique_getSigners"):
+    signers = await client.rpc("clique_getSigners", [])
+```
+
+## Events
+
+`eth_subscribe` is unavailable on the public endpoints, so watching polls by
+default and tolerates idle gaps. Delivery is ordered and gap-free.
+
+```python
+sub = await client.watch_logs(
+    token.filter("Transfer"),
+    lambda log: print(token.decode_log(log).args),
+)
+await sub.close()
+```
+
+## Contracts
+
+ABIs are the JSON form (a list of dicts), as produced by `solc` and consumed by
+the rest of the Python ecosystem.
+
+```python
+from purechain import Contract, deploy_contract
+
+token = Contract("0xabc...", abi, client)
+balance = await token.read("balanceOf", [address])
+await token.write_and_wait("transfer", [to, 100])
+
+result = await deploy_contract(client, abi=abi, bytecode=bytecode)
+print(result.address)
+```
+
+Gas is free, so an account with a zero balance can deploy and call. No balance
+pre-check is performed; a balance is only needed to move value.
+
+## Development
+
+```bash
+uv sync --all-extras           # exact versions from uv.lock
+pytest                         # offline unit tests
+PURECHAIN_LIVE=1 pytest        # plus read-only tests against the public network
+mypy && ruff check src tests
+```
+
+`uv.lock` pins all 54 packages, so every machine and CI run resolves the same
+versions. Commit it. Use `uv lock --upgrade` to move dependencies forward
+deliberately, rather than letting a fresh install drift on its own.
+
+There is a third suite that **broadcasts real transactions** to the public
+network. It is behind its own flag so it never runs by accident:
+
+```bash
+PURECHAIN_LIVE_WRITE=1 pytest tests/test_live_write.py
+```
+
+It generates a throwaway key and sends zero-value transfers to itself. No
+funding is needed — gas is free, which is precisely what the test proves.
+
+## Design
+
+These are the rules the library is built on. New code should follow them.
+
+### Layout
+
+```
+src/purechain/
+  __init__.py   public API
+  wallet.py     keys, mnemonics, keystore, signature verification
+  units.py      PCN <-> wei
+  address.py    validate, checksum, compare
+  abi.py        offline encode / decode
+  metrics.py    throughput, block timing, gas utilisation (reads)
+  benchmark.py  latency and throughput under load (BROADCASTS)
+  core/         variant-agnostic types, errors, fee policy, capability detection
+  client/       the PureChainClient interface and the create_client factory
+  variants/
+    evm/        shared EVM engine, signing, contracts, waiting, watching
+    geth/       purechain-geth -- implemented
+    besu/       stub
+    dag/        stub
+```
+
+The root modules are the namespaces from rule 9. `metrics` only reads;
+`benchmark` writes to the chain, which is why they are separate. They sit beside `core`,
+`client` and `variants` because they are top-level concerns, not a sub-part of
+any of them. The TypeScript package has the same file names in the same places.
+
+### 1. One interface, three variants
+
+Every variant implements the same `PureChainClient` interface. That interface
+holds only what all three can genuinely do — the intersection, not the union.
+
+This is why `wait_for` is built around a finality level, with a confirmation
+count only as an opt-in extra: a DAG has no block depth to count. Anything one
+variant can do beyond the interface sits behind a capability check, or on that
+variant's own class.
+
+### 2. Three layers, one direction
+
+`core` → `client` → `variants`. Code in `core` never imports from `variants`.
+
+Nothing in `core` assumes blocks, a block interval, or an EVM. That single
+constraint is what keeps the DAG variant possible behind the same interface.
+
+### 3. Detect, don't assume
+
+What a node can do is a property of the node, not the variant. The same
+purechain-geth build exposes `clique_*` on your own machine and not on the
+public RPC.
+
+Capabilities are read once when the client connects, then cached. Check them
+before using anything outside the core surface.
+
+### 4. Defaults match this network, not the ecosystem
+
+Zero fees, and the gas-price oracle is never called. Wait for inclusion, not
+depth. Poll for events instead of subscribing.
+
+Each of those is unusual for an Ethereum library and correct here. Where the
+network forbids something outright — replace-by-fee — the library says so with a
+named error rather than failing in a confusing way.
+
+### 5. Wrap the cryptography, own the policy
+
+web3.py does three jobs: signing, ABI coding, transport. This library decides
+fees, nonces, waiting, and retries.
+
+web3 types never appear in the public API. That is what lets the TypeScript port
+sit on ethers and still behave identically.
+
+### 6. Always leave an escape hatch
+
+Blocks, transactions, receipts and logs all carry `raw` — the node's response
+untouched, including fields the typed surface does not name. Clients with a real
+backend also expose `rpc(method, params)`, which reaches any method at all. Stubs
+do not, because they have nothing to call.
+
+A typed API you cannot step outside of is a dead end on a network that adds its
+own methods.
+
+### 7. Errors carry codes
+
+Branch on `err.code`, never on the message text. Messages are written for humans
+and will change; codes will not. The code strings are identical in both
+languages.
+
+Two classes take a trailing underscore — `NotImplementedError_`, `TimeoutError_`
+— so they do not shadow Python builtins. Their `code` values match TypeScript.
+
+### 8. Stubs are honest
+
+An unfinished variant still exposes the whole interface, and every call fails
+with an error naming the variant. You find out at the call site, not three
+frames deep in an `AttributeError`.
+
+### 9. Objects hold state, namespaces hold pure functions
+
+A client owns a connection, so it is an object. Creating a key or parsing an
+amount needs no state, so those belong in namespaces — plain modules here, since
+a Python module already is a namespace:
+
+```python
+from purechain import address, units, wallet
+
+signer = wallet.create()            # no network needed
+wei = units.parse_pcn("1.5")
+ok = address.is_valid(some_string)
+```
+
+There are four: `wallet`, `units`, `address`, and `abi`. Binding an ABI to a
+deployed address needs a client, so that stays on the `Contract` class rather
+than becoming a fifth namespace — one way to do it, not two.
+
+### 10. The two libraries match
+
+Same folders, same module names, same method names, same error codes. The only
+intended difference is casing: `snake_case` here, `camelCase` in TypeScript.
+
+A change to one library is a change to both.
+
+Where a language convention genuinely differs, follow the local one and say so.
+Two cases exist today: ABIs are JSON lists here and may also be
+human-readable signature strings in TypeScript, and async iteration and context
+managers follow Python norms.