chik-base 0.1.7__tar.gz

chik_base-0.1.7/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2022 Chik Network Inc
+
+   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.

chik_base-0.1.7/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: chik_base
+Version: 0.1.7
+Summary: Common types and simple utilities used through chik code base
+Author-email: Richard Kiss <him@richardkiss.com>
+License: Apache-2.0
+Project-URL: Repository, https://github.com/Chik-Network/chik_base.git
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+chik_base: base data types for chik coins, spends and contract development

chik_base-0.1.7/README.md

@@ -0,0 +1 @@
+chik_base: base data types for chik coins, spends and contract development

chik_base-0.1.7/chik_base/atoms/__init__.py

@@ -0,0 +1,27 @@
+"""
+This module defines some useful atomic types for building more complex
+data structures.
+
+Except for `hexbytes` (which is just a hex-printing subclass of `bytes`,
+these types are all fixed-sized, simplifying serializing and parsing, like
+those used in `cbincode` (the slight modification to the `bincode` standard that
+chik uses).
+"""
+
+from .hexbytes import hexbytes
+from .ints import int8, uint8, int16, uint16, int32, uint32, int64, uint64
+from .sized_bytes import bytes32
+
+
+__all__ = [
+    "int8",
+    "int16",
+    "int32",
+    "int64",
+    "uint8",
+    "uint16",
+    "uint32",
+    "uint64",
+    "hexbytes",
+    "bytes32",
+]

chik_base-0.1.7/chik_base/atoms/hexbytes.py

@@ -0,0 +1,11 @@
+class hexbytes(bytes):
+    """
+    This is a subclass of bytes that prints itself out as hex,
+    which is much easier on the eyes for binary data that is very non-ascii .
+    """
+
+    def __str__(self):
+        return self.hex()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, str(self))

chik_base-0.1.7/chik_base/atoms/ints.py

@@ -0,0 +1,59 @@
+"""
+Some ints of fixed size. Their fixed size makes them easier to parse and serialize.
+
+Each implements these two class methods:
+
+*  `.parse(f: BinaryIO)`
+*  `._class_stream(obj, f: BinaryIO)`
+
+"""
+
+from .struct_stream import struct_stream
+
+
+class int8(int, struct_stream):
+    "signed 8-bit int"
+
+    PACK = "!b"
+
+
+class uint8(int, struct_stream):
+    "unsigned 8-bit int"
+
+    PACK = "!B"
+
+
+class int16(int, struct_stream):
+    "signed 16-bit int"
+
+    PACK = "!h"
+
+
+class uint16(int, struct_stream):
+    "unsigned 16-bit int"
+
+    PACK = "!H"
+
+
+class int32(int, struct_stream):
+    "signed 32-bit int"
+
+    PACK = "!l"
+
+
+class uint32(int, struct_stream):
+    "unsigned 32-bit int"
+
+    PACK = "!L"
+
+
+class int64(int, struct_stream):
+    "signed 64-bit int"
+
+    PACK = "!q"
+
+
+class uint64(int, struct_stream):
+    "unsigned 64-bit int"
+
+    PACK = "!Q"

chik_base-0.1.7/chik_base/atoms/sized_bytes.py

@@ -0,0 +1,43 @@
+from typing import BinaryIO
+from .hexbytes import hexbytes
+
+
+class SizedBytes(hexbytes):
+    """
+    Intended to be subclassed, this base class makes it easy to create
+    subclasses of `bytes` that require the length to be a specific value.
+
+    Having a specific number of bytes means we can easily parse and stream
+    """
+
+    _size: int
+
+    def __new__(cls, v):
+        "`v` must be castable to `bytes`"
+        v = bytes(v)
+        if not isinstance(v, bytes) or len(v) != cls._size:
+            raise ValueError("bad %s initializer %s" % (cls.__name__, v))
+        return hexbytes.__new__(cls, v)
+
+    @classmethod
+    def parse(cls, f: BinaryIO) -> bytes:
+        b = f.read(cls._size)
+        if len(b) != cls._size:
+            msg = f"unexpected EOS: {len(b)} bytes read, {cls._size} expected"
+            raise ValueError(msg)
+        return cls(b)
+
+    @classmethod
+    def _class_stream(cls, obj: bytes, f: BinaryIO) -> None:
+        if len(obj) != cls._size:
+            msg = f"got {len(obj)} bytes when we expected {cls._size}"
+            raise ValueError(msg)
+        f.write(obj)
+
+
+class bytes32(SizedBytes):
+    """
+    A subclass of `bytes` that requires the length to be 32.
+    """
+
+    _size = 32

chik_base-0.1.7/chik_base/atoms/struct_stream.py

@@ -0,0 +1,24 @@
+import struct
+
+from typing import BinaryIO, TypeVar, Type
+
+
+_T = TypeVar("_T", bound="struct_stream")
+
+
+class struct_stream:
+    """
+    This is a base class. Subclasses should define `cls.PACK` as a struct.pack
+    template string. In return, you get implementations of `parse` and
+    `_class_stream`.
+    """
+
+    PACK: str
+
+    @classmethod
+    def parse(cls: Type[_T], f: BinaryIO) -> _T:
+        return cls(*struct.unpack(cls.PACK, f.read(struct.calcsize(cls.PACK))))
+
+    @classmethod
+    def _class_stream(cls: Type[_T], obj: _T, f: BinaryIO) -> None:
+        f.write(struct.pack(cls.PACK, obj))

chik_base-0.1.7/chik_base/bls12_381/__init__.py

@@ -0,0 +1,11 @@
+"""
+The `chik_rs` wheel has some rough edges in its api. This module smooths them over
+with a more ergonomic api.
+"""
+
+from .bls_public_key import BLSPublicKey
+from .bls_secret_exponent import BLSSecretExponent
+from .bls_signature import BLSSignature
+
+
+__all__ = ["BLSPublicKey", "BLSSecretExponent", "BLSSignature"]

chik_base-0.1.7/chik_base/bls12_381/bls_public_key.py

@@ -0,0 +1,129 @@
+from typing import BinaryIO, List
+
+import chik_rs  # type: ignore
+
+from chik_base.atoms import hexbytes
+from chik_base.util.bech32 import bech32_decode, bech32_encode, Encoding
+
+from .secret_key_utils import public_key_from_int
+
+BECH32M_PUBLIC_KEY_PREFIX = "bls1238"
+
+
+class BLSPublicKey:
+    """
+    This corresponds to an element in bls12-381's G1 group, represented
+    when serialized by a 48-byte x element (with a few extra bits at the
+    beginning for metadata).
+    """
+    def __init__(self, g1: chik_rs.G1Element):
+        assert isinstance(g1, chik_rs.G1Element)
+        self._g1 = g1
+
+    @classmethod
+    def from_bytes(cls, blob):
+        "parse from a binary blob"
+        bls_public_hd_key = chik_rs.G1Element.from_bytes(blob)
+        return BLSPublicKey(bls_public_hd_key)
+
+    @classmethod
+    def parse(cls, f: BinaryIO):
+        "parse from a stream"
+        return cls.from_bytes(f.read(48))
+
+    @classmethod
+    def generator(cls):
+        "return the well-known generator"
+        return BLSPublicKey(chik_rs.G1Element.generator())
+
+    @classmethod
+    def zero(cls):
+        "return the well-known zero"
+        return cls(chik_rs.G1Element())
+
+    def stream(self, f: BinaryIO) -> None:
+        "write the serialized version to the file f"
+        f.write(bytes(self._g1))
+
+    def __add__(self, other):
+        "add two elements, returning the sum. Use `+`"
+        return BLSPublicKey(self._g1 + other._g1)
+
+    def __mul__(self, other: int):
+        "multiply an element by a scalar"
+        if other < 0:
+            raise ValueError("can't multiply by a negative value")
+        if self == self.generator():
+            # there is a special method in chik_rs that multiplies
+            # the generator by an integer that is not susceptible to
+            # timing attacks. Since public keys are generate times integer,
+            # using this method with the generator could expose to timing
+            # attacks. So instead we use the more clever code specifically
+            # for the generator
+            return BLSPublicKey(public_key_from_int(other))
+        if other == 0:
+            return self.zero()
+        if other == 1:
+            return self
+        # use recursion on `__mul__` in a sneaky clever way
+        parity = other & 1
+        v = self.__mul__(other >> 1)
+        v += v
+        if parity:
+            v += self
+        return v
+
+    def __rmul__(self, other: int):
+        return self.__mul__(other)
+
+    def __eq__(self, other):
+        if isinstance(other, type(self)):
+            return self._g1 == other._g1
+        return False
+
+    def __bytes__(self) -> bytes:
+        return hexbytes(self._g1)
+
+    def child(self, index: int) -> "BLSPublicKey":
+        "unhardened child derivation"
+        return BLSPublicKey(
+            chik_rs.AugSchemeMPL.derive_child_pk_unhardened(self._g1, index)
+        )
+
+    def child_for_path(self, path: List[int]) -> "BLSPublicKey":
+        "A path is a list of child integer derivations"
+        r = self
+        for index in path:
+            r = r.child(index)
+        return r
+
+    def fingerprint(self) -> int:
+        "return a 32-bit unsigned integer"
+        return self._g1.get_fingerprint()
+
+    def as_bech32m(self) -> str:
+        "convert to a bech32m string"
+        return bech32_encode(BECH32M_PUBLIC_KEY_PREFIX, bytes(self), Encoding.BECH32M)
+
+    @classmethod
+    def from_bech32m(cls, text: str) -> "BLSPublicKey":
+        "convert from a bech32m string"
+        r = bech32_decode(text, max_length=91)
+        if r is not None:
+            prefix, base8_data, encoding = r
+            if (
+                encoding == Encoding.BECH32M
+                and prefix == BECH32M_PUBLIC_KEY_PREFIX
+                and len(base8_data) == 49
+            ):
+                return cls.from_bytes(base8_data[:48])
+        raise ValueError("not bls12_381 bech32m pubkey")
+
+    def __hash__(self):
+        return bytes(self).__hash__()
+
+    def __str__(self):
+        return self.as_bech32m()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, self)

chik_base-0.1.7/chik_base/bls12_381/bls_secret_exponent.py

@@ -0,0 +1,138 @@
+from typing import BinaryIO, List, Optional
+
+import chik_rs  # type: ignore
+
+from chik_base.util.bech32 import bech32_decode, bech32_encode, Encoding
+
+from .bls_public_key import BLSPublicKey
+from .bls_signature import BLSSignature
+from .secret_key_utils import private_key_from_int
+
+
+BECH32M_SECRET_EXPONENT_PREFIX = "se"
+
+
+class BLSSecretExponent:
+    """
+    This is essentially an `int` with convenience functions.
+
+    We don't subclass `int` because we have a different implementation of
+    `__bytes__` which could cause confusion.
+    """
+
+    def __init__(self, sk: chik_rs.PrivateKey):
+        self._sk = sk
+
+    @classmethod
+    def from_seed(cls, seed: bytes) -> "BLSSecretExponent":
+        """
+        convert from a seed using the specification at
+        https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-bls-signature-05
+        """
+        return BLSSecretExponent(chik_rs.AugSchemeMPL.key_gen(seed))
+
+    @classmethod
+    def from_int(cls, secret_exponent) -> "BLSSecretExponent":
+        "convert from the given int"
+        return cls(private_key_from_int(secret_exponent))
+
+    @classmethod
+    def from_bytes(cls, blob) -> "BLSSecretExponent":
+        "deserialize from the given blob. A blob of length 32 bytes is expected"
+        return cls(chik_rs.PrivateKey.from_bytes(blob))
+
+    @classmethod
+    def parse(cls, f: BinaryIO):
+        "deserialize from the given stream"
+        return cls.from_bytes(f.read(32))
+
+    def stream(self, f: BinaryIO) -> None:
+        "serialize to the given stream"
+        f.write(bytes(self._sk))
+
+    def fingerprint(self) -> int:
+        "return a 32-bit unsigned integer. The public key fingerprint will match."
+        return self._sk.get_g1().get_fingerprint()
+
+    def sign(
+        self, message: bytes, final_public_key: Optional[BLSPublicKey] = None
+    ) -> BLSSignature:
+        "generate a signature"
+        if final_public_key:
+            return BLSSignature(
+                chik_rs.AugSchemeMPL.sign(self._sk, message, final_public_key._g1)
+            )
+        return BLSSignature(chik_rs.AugSchemeMPL.sign(self._sk, message))
+
+    def public_key(self) -> BLSPublicKey:
+        "return the corresponding public key"
+        return BLSPublicKey(self._sk.get_g1())
+
+    def secret_exponent(self) -> int:
+        "return the exponent as an `int`"
+        return int.from_bytes(bytes(self), "big")
+
+    def hardened_child(self, index: int) -> "BLSSecretExponent":
+        "return the hardened child"
+        return BLSSecretExponent(chik_rs.AugSchemeMPL.derive_child_sk(self._sk, index))
+
+    def child(self, index: int) -> "BLSSecretExponent":
+        "return the unhardened child. This will match the corresponding public_key child"
+        return BLSSecretExponent(
+            chik_rs.AugSchemeMPL.derive_child_sk_unhardened(self._sk, index)
+        )
+
+    def child_for_path(self, path: List[int]) -> "BLSSecretExponent":
+        "A path is a list of child integer derivations. Unhardened only"
+        r = self
+        for index in path:
+            r = r.child(index)
+        return r
+
+    def as_bech32m(self):
+        "convert to a bech32m string"
+        return bech32_encode(
+            BECH32M_SECRET_EXPONENT_PREFIX, bytes(self), Encoding.BECH32M
+        )
+
+    @classmethod
+    def from_bech32m(cls, text: str) -> "BLSSecretExponent":
+        "convert from a bech32m string"
+        r = bech32_decode(text)
+        if r is not None:
+            prefix, base8_data, encoding = r
+            if (
+                encoding == Encoding.BECH32M
+                and prefix == BECH32M_SECRET_EXPONENT_PREFIX
+                and len(base8_data) == 33
+            ):
+                return cls.from_bytes(base8_data[:32])
+        raise ValueError("not secret exponent")
+
+    @classmethod
+    def zero(cls) -> "BLSSecretExponent":
+        "returns the secret exponent corresponding to 0. This shouldn't be used to sign"
+        return ZERO
+
+    def __add__(self, other):
+        return self.from_int(int(self) + int(other))
+
+    def __int__(self):
+        return self.secret_exponent()
+
+    def __eq__(self, other):
+        if isinstance(other, int):
+            other = BLSSecretExponent.from_int(other)
+        return self._sk == other._sk
+
+    def __bytes__(self):
+        return bytes(self._sk)
+
+    def __str__(self):
+        return "<prv for:%s>" % self.public_key()
+
+    def __repr__(self):
+        return "<%s: %s>" % (self.__class__.__name__, self)
+
+
+ZERO = BLSSecretExponent.from_int(0)