cyscale 0.1.0__tar.gz

cyscale-0.1.0/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 BD Himes
+Portions copyright 2018-2021 Stichting Polkascan (Polkascan Foundation)
+
+                                 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.

cyscale-0.1.0/NOTICE

@@ -0,0 +1,10 @@
+cyscale
+Copyright 2025 BD Himes
+
+This product is a derivative work of py-scale-codec:
+  Copyright 2018-2021 Stichting Polkascan (Polkascan Foundation)
+  https://github.com/polkascan/py-scale-codec
+
+The original work is licensed under the Apache License, Version 2.0.
+This derivative work is also distributed under the Apache License, Version 2.0.
+See the LICENSE file for the full license text.

cyscale-0.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: cyscale
+Version: 0.1.0
+Summary: Cython SCALE Codec Library
+Author-email: BD Himes <b@latent.to>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/thewhaleking/cy-scale-codec
+Project-URL: Bug Reports, https://github.com/thewhaleking/cy-scale-codec/issues
+Project-URL: Source, https://github.com/thewhaleking/cy-scale-codec
+Keywords: scale,codec,polkascan,polkadot,substrate,blockchain,kusama,cython,bittensor
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Cython
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: more-itertools
+Requires-Dist: base58>=2.0.1
+Requires-Dist: requests>=2.24.0
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: cython
+Requires-Dist: Cython>=3.0; extra == "cython"
+Dynamic: license-file
+
+# cyscale
+
+[![Latest Version](https://img.shields.io/pypi/v/cyscale.svg)](https://pypi.org/project/cyscale/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/cyscale.svg)](https://pypi.org/project/cyscale/)
+[![License](https://img.shields.io/pypi/l/cyscale.svg)](https://github.com/thewhaleking/cy-scale-codec/blob/master/LICENSE)
+
+Cython-accelerated [SCALE codec](https://docs.substrate.io/reference/scale-codec/) library for Substrate-based blockchains (Polkadot, Kusama, Bittensor, etc.).
+
+A drop-in replacement for [py-scale-codec](https://github.com/polkascan/py-scale-codec) — same `scalecodec` module name, same public API, compiled with Cython for improved throughput.
+
+## Installation
+
+```bash
+pip install cyscale
+```
+
+## Performance
+
+Benchmarked on Apple M-series (Python 3.13) against py-scale-codec 1.2.12.
+All timings are µs per call; speedup = py ÷ cy.
+
+### Primitives and small types
+
+| Benchmark                   | py (µs) | cy (µs) | speedup |
+|-----------------------------|---------|---------|---------|
+| u8 decode                   | 2.18    | 1.29    | 1.68×   |
+| u16 decode                  | 2.12    | 1.40    | 1.52×   |
+| u32 decode                  | 2.10    | 1.37    | 1.53×   |
+| u64 decode                  | 2.14    | 1.39    | 1.54×   |
+| u128 decode                 | 2.11    | 1.37    | 1.53×   |
+| Compact\<u32\> decode       | 6.94    | 4.94    | 1.40×   |
+| bool decode                 | 2.10    | 1.33    | 1.58×   |
+| H256 decode                 | 2.14    | 1.37    | 1.57×   |
+| AccountId decode (no SS58)  | 2.65    | 1.72    | 1.54×   |
+| Str decode                  | 9.20    | 6.37    | 1.44×   |
+| (u32, u64, bool) decode     | 16.11   | 10.69   | 1.51×   |
+| u32 encode                  | 1.65    | 0.98    | 1.68×   |
+| u64 encode                  | 1.68    | 0.98    | 1.71×   |
+| Compact\<u32\> encode       | 6.47    | 4.53    | 1.43×   |
+| H256 encode                 | 1.77    | 1.04    | 1.70×   |
+
+### Large payloads
+
+| Benchmark                                       | py (µs)    | cy (µs)    | speedup |
+|-------------------------------------------------|------------|------------|---------|
+| Vec\<u32\> decode (64 elements)                 | 160.57     | 105.46     | 1.52×   |
+| Vec\<u32\> decode (1,024 elements)              | 2,329.76   | 1,574.94   | 1.48×   |
+| Vec\<u32\> decode (16,384 elements)             | 37,470.39  | 24,791.11  | 1.51×   |
+| Bytes decode (1 KB)                             | 10.35      | 7.65       | 1.35×   |
+| Bytes decode (64 KB)                            | 46.01      | 45.50      | 1.01×   |
+| Bytes decode (512 KB)                           | 270.51     | 290.45     | 0.93×   |
+| Vec\<EventRecord\> decode (5 events, V10)       | 215.79     | 145.50     | 1.48×   |
+| MetadataVersioned decode (V10, 85 KB)           | 47,144.57  | 33,035.40  | 1.43×   |
+| MetadataVersioned decode (V13, 219 KB)          | 102,974.25 | 73,624.13  | 1.40×   |
+| MetadataVersioned decode (V14, 300 KB)          | 284,478.38 | 199,015.58 | 1.43×   |
+| Bittensor metadata + portable registry (254 KB) | 332,447.63 | 229,223.60 | 1.45×   |
+
+Primitives and small types see **~1.4–1.7× speedup**. Large metadata decoding
+sees **~1.4–1.5× speedup** — the gain compounds across thousands of recursive
+decode calls. Raw bulk byte operations (`Bytes`/`Vec<u8>`) above ~64 KB are
+dominated by `memcpy` and show no meaningful difference.
+
+To reproduce, run:
+
+```bash
+# save a py-scale-codec baseline
+python benchmarks/bench.py --save-baseline benchmarks/baseline_py.json
+
+# compare against cy-scale-codec
+PYTHONPATH=. python benchmarks/bench.py --compare benchmarks/baseline_py.json
+```
+
+## Examples of different types
+
+| Type | Description | Example SCALE decoding value | SCALE encoded value |
+|------|-------------|------------------------------|---------------------|
+| `bool` | Boolean values are encoded using the least significant bit of a single byte. | `True` | `0x01` |
+| `u16` | Basic integers are encoded using a fixed-width little-endian (LE) format. | `42` | `0x2a00` |
+| `Compact` | A "compact" or general integer encoding is sufficient for encoding large integers (up to 2\*\*536) and is more efficient at encoding most values than the fixed-width version. | `1` | `0x04` |
+| `Vec` | A collection of same-typed values is encoded, prefixed with a compact encoding of the number of items, followed by each item's encoding concatenated in turn. | `[4, 8, 15, 16, 23, 42]` | `0x18040008000f00100017002a00` |
+| `str`, `Bytes` | Strings are Vectors of bytes (`Vec<u8>`) containing a valid UTF8 sequence. | `"Test"` | `0x1054657374` |
+| `AccountId` | An [SS58 formatted](https://docs.substrate.io/reference/address-formats/) representation of an account. | `"5GDyPHLVHcQYPTWfygtPYeogQjyZy7J9fsi4brPhgEFq4pcv"` | `0xb80269ec...` |
+| `Enum` | A fixed number of variants, each mutually exclusive. Encoded as the first byte identifying the index of the variant. | `{'Int': 8}` | `0x002a` |
+| `Struct` | For structures, values are named but that is irrelevant for the encoding (only order matters). | `{"votes": [...], "id": 4}` | `0x04b80269...` |
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).

cyscale-0.1.0/README.md

@@ -0,0 +1,88 @@
+# cyscale
+
+[![Latest Version](https://img.shields.io/pypi/v/cyscale.svg)](https://pypi.org/project/cyscale/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/cyscale.svg)](https://pypi.org/project/cyscale/)
+[![License](https://img.shields.io/pypi/l/cyscale.svg)](https://github.com/thewhaleking/cy-scale-codec/blob/master/LICENSE)
+
+Cython-accelerated [SCALE codec](https://docs.substrate.io/reference/scale-codec/) library for Substrate-based blockchains (Polkadot, Kusama, Bittensor, etc.).
+
+A drop-in replacement for [py-scale-codec](https://github.com/polkascan/py-scale-codec) — same `scalecodec` module name, same public API, compiled with Cython for improved throughput.
+
+## Installation
+
+```bash
+pip install cyscale
+```
+
+## Performance
+
+Benchmarked on Apple M-series (Python 3.13) against py-scale-codec 1.2.12.
+All timings are µs per call; speedup = py ÷ cy.
+
+### Primitives and small types
+
+| Benchmark                   | py (µs) | cy (µs) | speedup |
+|-----------------------------|---------|---------|---------|
+| u8 decode                   | 2.18    | 1.29    | 1.68×   |
+| u16 decode                  | 2.12    | 1.40    | 1.52×   |
+| u32 decode                  | 2.10    | 1.37    | 1.53×   |
+| u64 decode                  | 2.14    | 1.39    | 1.54×   |
+| u128 decode                 | 2.11    | 1.37    | 1.53×   |
+| Compact\<u32\> decode       | 6.94    | 4.94    | 1.40×   |
+| bool decode                 | 2.10    | 1.33    | 1.58×   |
+| H256 decode                 | 2.14    | 1.37    | 1.57×   |
+| AccountId decode (no SS58)  | 2.65    | 1.72    | 1.54×   |
+| Str decode                  | 9.20    | 6.37    | 1.44×   |
+| (u32, u64, bool) decode     | 16.11   | 10.69   | 1.51×   |
+| u32 encode                  | 1.65    | 0.98    | 1.68×   |
+| u64 encode                  | 1.68    | 0.98    | 1.71×   |
+| Compact\<u32\> encode       | 6.47    | 4.53    | 1.43×   |
+| H256 encode                 | 1.77    | 1.04    | 1.70×   |
+
+### Large payloads
+
+| Benchmark                                       | py (µs)    | cy (µs)    | speedup |
+|-------------------------------------------------|------------|------------|---------|
+| Vec\<u32\> decode (64 elements)                 | 160.57     | 105.46     | 1.52×   |
+| Vec\<u32\> decode (1,024 elements)              | 2,329.76   | 1,574.94   | 1.48×   |
+| Vec\<u32\> decode (16,384 elements)             | 37,470.39  | 24,791.11  | 1.51×   |
+| Bytes decode (1 KB)                             | 10.35      | 7.65       | 1.35×   |
+| Bytes decode (64 KB)                            | 46.01      | 45.50      | 1.01×   |
+| Bytes decode (512 KB)                           | 270.51     | 290.45     | 0.93×   |
+| Vec\<EventRecord\> decode (5 events, V10)       | 215.79     | 145.50     | 1.48×   |
+| MetadataVersioned decode (V10, 85 KB)           | 47,144.57  | 33,035.40  | 1.43×   |
+| MetadataVersioned decode (V13, 219 KB)          | 102,974.25 | 73,624.13  | 1.40×   |
+| MetadataVersioned decode (V14, 300 KB)          | 284,478.38 | 199,015.58 | 1.43×   |
+| Bittensor metadata + portable registry (254 KB) | 332,447.63 | 229,223.60 | 1.45×   |
+
+Primitives and small types see **~1.4–1.7× speedup**. Large metadata decoding
+sees **~1.4–1.5× speedup** — the gain compounds across thousands of recursive
+decode calls. Raw bulk byte operations (`Bytes`/`Vec<u8>`) above ~64 KB are
+dominated by `memcpy` and show no meaningful difference.
+
+To reproduce, run:
+
+```bash
+# save a py-scale-codec baseline
+python benchmarks/bench.py --save-baseline benchmarks/baseline_py.json
+
+# compare against cy-scale-codec
+PYTHONPATH=. python benchmarks/bench.py --compare benchmarks/baseline_py.json
+```
+
+## Examples of different types
+
+| Type | Description | Example SCALE decoding value | SCALE encoded value |
+|------|-------------|------------------------------|---------------------|
+| `bool` | Boolean values are encoded using the least significant bit of a single byte. | `True` | `0x01` |
+| `u16` | Basic integers are encoded using a fixed-width little-endian (LE) format. | `42` | `0x2a00` |
+| `Compact` | A "compact" or general integer encoding is sufficient for encoding large integers (up to 2\*\*536) and is more efficient at encoding most values than the fixed-width version. | `1` | `0x04` |
+| `Vec` | A collection of same-typed values is encoded, prefixed with a compact encoding of the number of items, followed by each item's encoding concatenated in turn. | `[4, 8, 15, 16, 23, 42]` | `0x18040008000f00100017002a00` |
+| `str`, `Bytes` | Strings are Vectors of bytes (`Vec<u8>`) containing a valid UTF8 sequence. | `"Test"` | `0x1054657374` |
+| `AccountId` | An [SS58 formatted](https://docs.substrate.io/reference/address-formats/) representation of an account. | `"5GDyPHLVHcQYPTWfygtPYeogQjyZy7J9fsi4brPhgEFq4pcv"` | `0xb80269ec...` |
+| `Enum` | A fixed number of variants, each mutually exclusive. Encoded as the first byte identifying the index of the variant. | `{'Int': 8}` | `0x002a` |
+| `Struct` | For structures, values are named but that is irrelevant for the encoding (only order matters). | `{"votes": [...], "id": 4}` | `0x04b80269...` |
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).