coinex-api 0.0.89__py3-none-any.whl → 0.0.110__py3-none-any.whl

coinex/ccxt/static_dependencies/bip/bip32/slip10/bip32_slip10_key_derivator.py

@@ -0,0 +1,200 @@
+# Copyright (c) 2021 Emanuele Bellocchia
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+Module for BIP32 SLIP-0010 keys derivation.
+
+References:
+    https://github.com/satoshilabs/slips/blob/master/slip-0010.md
+    https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
+"""
+
+# Imports
+from typing import Tuple, Union
+
+from ..base import IBip32KeyDerivator
+from ..bip32_ex import Bip32KeyError
+from ..bip32_key_data import Bip32KeyIndex
+from ..bip32_keys import Bip32PrivateKey, Bip32PublicKey
+from ...ecc import IPoint
+from ...utils.crypto import HmacSha512
+from ...utils.misc import BytesUtils, IntegerUtils
+
+
+class Bip32Slip10DerivatorConst:
+    """Class container for BIP32 SLIP-0010 derivator constants."""
+
+    # Private key prefix
+    PRIV_KEY_PREFIX: bytes = b"\x00"
+
+
+class Bip32Slip10EcdsaDerivator(IBip32KeyDerivator):
+    """
+    BIP32 SLIP-0010 ECDSA key derivator class.
+    It allows keys derivation for ECDSA curves in according to BIP32 SLIP-0010.
+    """
+
+    @staticmethod
+    def IsPublicDerivationSupported() -> bool:
+        """
+        Get if public derivation is supported.
+
+        Returns:
+            bool: True if supported, false otherwise.
+        """
+        return True
+
+    @classmethod
+    def CkdPriv(cls,
+                priv_key: Bip32PrivateKey,
+                pub_key: Bip32PublicKey,
+                index: Bip32KeyIndex) -> Tuple[bytes, bytes]:
+        """
+        Derive a child key with the specified index using private derivation.
+
+        Args:
+            priv_key (Bip32PrivateKey object): Bip32PrivateKey object
+            pub_key (Bip32PublicKey object)  : Bip32PublicKey object
+            index (Bip32KeyIndex object)     : Key index
+
+        Returns:
+            tuple[bytes, bytes]: Private key bytes (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the index results in an invalid key
+        """
+        curve = pub_key.Curve()
+        priv_key_bytes = priv_key.Raw().ToBytes()
+
+        # Data for HMAC
+        if index.IsHardened():
+            data_bytes = (Bip32Slip10DerivatorConst.PRIV_KEY_PREFIX
+                          + priv_key_bytes
+                          + index.ToBytes())
+        else:
+            data_bytes = pub_key.RawCompressed().ToBytes() + index.ToBytes()
+
+        # Compute HMAC halves
+        il_bytes, ir_bytes = HmacSha512.QuickDigestHalves(priv_key.ChainCode().ToBytes(),
+                                                          data_bytes)
+
+        # Construct new key secret from iL and current private key
+        il_int = BytesUtils.ToInteger(il_bytes)
+        priv_key_int = BytesUtils.ToInteger(priv_key_bytes)
+        new_priv_key_bytes = IntegerUtils.ToBytes((il_int + priv_key_int) % curve.Order(),
+                                                  bytes_num=curve.PrivateKeyClass().Length())
+
+        return new_priv_key_bytes, ir_bytes
+
+    @classmethod
+    def CkdPub(cls,
+               pub_key: Bip32PublicKey,
+               index: Bip32KeyIndex) -> Tuple[Union[bytes, IPoint], bytes]:
+        """
+        Derive a child key with the specified index using public derivation.
+
+        Args:
+            pub_key (Bip32PublicKey object): Bip32PublicKey object
+            index (Bip32KeyIndex object)   : Key index
+
+        Returns:
+            tuple[bytes or IPoint, bytes]: Public key bytes or point (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the index results in an invalid key
+        """
+        # Data for HMAC, same of CkdPriv() for public child key
+        data_bytes = pub_key.RawCompressed().ToBytes() + index.ToBytes()
+
+        # Get HMAC of data
+        il_bytes, ir_bytes = HmacSha512.QuickDigestHalves(pub_key.ChainCode().ToBytes(),
+                                                          data_bytes)
+        il_int = BytesUtils.ToInteger(il_bytes)
+
+        # Get a new public key point: pub_key_point + G*iL
+        new_pub_key_point = pub_key.Point() + (pub_key.Curve().Generator() * il_int)
+
+        return new_pub_key_point, ir_bytes
+
+
+class Bip32Slip10Ed25519Derivator(IBip32KeyDerivator):
+    """
+    BIP32 SLIP-0010 ed25519 key derivator class.
+    It allows keys derivation for ed25519 curves in according to BIP32 SLIP-0010.
+    """
+
+    @staticmethod
+    def IsPublicDerivationSupported() -> bool:
+        """
+        Get if public derivation is supported.
+
+        Returns:
+            bool: True if supported, false otherwise.
+        """
+        return False
+
+    @classmethod
+    def CkdPriv(cls,
+                priv_key: Bip32PrivateKey,
+                pub_key: Bip32PublicKey,
+                index: Bip32KeyIndex) -> Tuple[bytes, bytes]:
+        """
+        Derive a child key with the specified index using private derivation.
+
+        Args:
+            priv_key (Bip32PrivateKey object): Bip32PrivateKey object
+            pub_key (Bip32PublicKey object)  : Bip32PublicKey object
+            index (Bip32KeyIndex object)     : Key index
+
+        Returns:
+            tuple[bytes, bytes]: Private key bytes (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the index results in an invalid key
+        """
+        if not index.IsHardened():
+            raise Bip32KeyError("Private child derivation with not-hardened index is not supported")
+
+        # Data for HMAC
+        data_bytes = (Bip32Slip10DerivatorConst.PRIV_KEY_PREFIX
+                      + priv_key.Raw().ToBytes()
+                      + index.ToBytes())
+        # Compute HMAC halves
+        return HmacSha512.QuickDigestHalves(priv_key.ChainCode().ToBytes(),
+                                            data_bytes)
+
+    @classmethod
+    def CkdPub(cls,
+               pub_key: Bip32PublicKey,
+               index: Bip32KeyIndex) -> Tuple[Union[bytes, IPoint], bytes]:
+        """
+        Derive a child key with the specified index using public derivation.
+
+        Args:
+            pub_key (Bip32PublicKey object): Bip32PublicKey object
+            index (Bip32KeyIndex object)   : Key index
+
+        Returns:
+            tuple[bytes or IPoint, bytes]: Public key bytes or point (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the index results in an invalid key
+        """
+        raise Bip32KeyError("Public child derivation is not supported")

coinex/ccxt/static_dependencies/bip/bip32/slip10/bip32_slip10_mst_key_generator.py

@@ -0,0 +1,168 @@
+# Copyright (c) 2021 Emanuele Bellocchia
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""
+Module for BIP32 SLIP-0010 master key generation.
+Reference: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
+"""
+
+# Imports
+from typing import Tuple
+
+from ..base import IBip32MstKeyGenerator
+from ...ecc import EllipticCurveGetter, EllipticCurveTypes
+from ...utils.crypto import HmacSha512
+
+
+class Bip32Slip10MstKeyGeneratorConst:
+    """Class container for BIP32 SLIP-0010 master key generator constants."""
+
+    # Minimum length in bytes for seed
+    SEED_MIN_BYTE_LEN: int = 16
+    # HMAC keys for different curves
+    HMAC_KEY_ED25519_BYTES: bytes = b"ed25519 seed"
+    HMAC_KEY_NIST256P1_BYTES: bytes = b"Nist256p1 seed"
+    HMAC_KEY_SECP256K1_BYTES: bytes = b"Bitcoin seed"
+
+
+class _Bip32Slip10MstKeyGenerator:
+    """
+    BIP32 SLIP-0010 generic master key generator class.
+    It allows master keys generation in according to BIP32 SLIP-0010.
+    """
+
+    @staticmethod
+    def GenerateFromSeed(seed_bytes: bytes,
+                         hmac_key_bytes: bytes,
+                         curve_type: EllipticCurveTypes) -> Tuple[bytes, bytes]:
+        """
+        Generate a master key from the specified seed and return a Bip32Base object.
+
+        Args:
+            seed_bytes (bytes)                      : Seed bytes
+            hmac_key_bytes (bytes)                  : HMAC key bytes
+
+        Returns:
+            Bip32Base object: Bip32Base object
+
+        Raises:
+            Bip32KeyError: If the seed is not suitable for master key generation
+            ValueError: If seed length is not valid
+        """
+        if len(seed_bytes) < Bip32Slip10MstKeyGeneratorConst.SEED_MIN_BYTE_LEN:
+            raise ValueError(f"Invalid seed length ({len(seed_bytes)})")
+
+        hmac_half_len = HmacSha512.DigestSize() // 2
+        priv_key_cls = EllipticCurveGetter.FromType(curve_type).PrivateKeyClass()
+
+        # Compute HMAC, retry if the resulting private key is not valid
+        hmac = b""
+        hmac_data = seed_bytes
+        success = False
+
+        while not success:
+            hmac = HmacSha512.QuickDigest(hmac_key_bytes, hmac_data)
+            # If private key is not valid, the new HMAC data is the current HMAC
+            success = priv_key_cls.IsValidBytes(hmac[:hmac_half_len])
+            if not success:
+                hmac_data = hmac
+
+        return hmac[:hmac_half_len], hmac[hmac_half_len:]
+
+
+class Bip32Slip10Ed2519MstKeyGenerator(IBip32MstKeyGenerator):
+    """
+    BIP32 SLIP-0010 ed25519 master key generator class.
+    It allows master keys generation in according to BIP32 SLIP-0010 for ed25519 curve.
+    """
+
+    @classmethod
+    def GenerateFromSeed(cls,
+                         seed_bytes: bytes) -> Tuple[bytes, bytes]:
+        """
+        Generate a master key from the specified seed.
+
+        Args:
+            seed_bytes (bytes): Seed bytes
+
+        Returns:
+            tuple[bytes, bytes]: Private key bytes (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the seed is not suitable for master key generation
+            ValueError: If seed length is not valid
+        """
+        return _Bip32Slip10MstKeyGenerator.GenerateFromSeed(seed_bytes,
+                                                            Bip32Slip10MstKeyGeneratorConst.HMAC_KEY_ED25519_BYTES,
+                                                            EllipticCurveTypes.ED25519)
+
+
+class Bip32Slip10Nist256p1MstKeyGenerator(IBip32MstKeyGenerator):
+    """
+    BIP32 SLIP-0010 nist256p1 master key generator class.
+    It allows master keys generation in according to BIP32 SLIP-0010 for nist256p1 curve.
+    """
+
+    @classmethod
+    def GenerateFromSeed(cls,
+                         seed_bytes: bytes) -> Tuple[bytes, bytes]:
+        """
+        Generate a master key from the specified seed.
+
+        Args:
+            seed_bytes (bytes): Seed bytes
+
+        Returns:
+            tuple[bytes, bytes]: Private key bytes (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the seed is not suitable for master key generation
+            ValueError: If seed length is not valid
+        """
+        return _Bip32Slip10MstKeyGenerator.GenerateFromSeed(seed_bytes,
+                                                            Bip32Slip10MstKeyGeneratorConst.HMAC_KEY_NIST256P1_BYTES,
+                                                            EllipticCurveTypes.NIST256P1)
+
+
+class Bip32Slip10Secp256k1MstKeyGenerator(IBip32MstKeyGenerator):
+    """
+    BIP32 SLIP-0010 secp256k1 master key generator class.
+    It allows master keys generation in according to BIP32 SLIP-0010 for secp256k1 curve.
+    """
+
+    @classmethod
+    def GenerateFromSeed(cls,
+                         seed_bytes: bytes) -> Tuple[bytes, bytes]:
+        """
+        Generate a master key from the specified seed.
+
+        Args:
+            seed_bytes (bytes): Seed bytes
+
+        Returns:
+            tuple[bytes, bytes]: Private key bytes (index 0) and chain code bytes (index 1)
+
+        Raises:
+            Bip32KeyError: If the seed is not suitable for master key generation
+            ValueError: If seed length is not valid
+        """
+        return _Bip32Slip10MstKeyGenerator.GenerateFromSeed(seed_bytes,
+                                                            Bip32Slip10MstKeyGeneratorConst.HMAC_KEY_SECP256K1_BYTES,
+                                                            EllipticCurveTypes.SECP256K1)

coinex/ccxt/static_dependencies/bip/bip32/slip10/bip32_slip10_secp256k1.py

@@ -0,0 +1,82 @@
+# Copyright (c) 2021 Emanuele Bellocchia
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""Module for derivation scheme based on secp256k1 curve as defined by BIP32 SLIP-0010."""
+
+# Imports
+from typing import Type
+
+from ..base import Bip32Base, IBip32KeyDerivator, IBip32MstKeyGenerator
+from ..bip32_const import Bip32Const
+from ..bip32_key_net_ver import Bip32KeyNetVersions
+from .bip32_slip10_key_derivator import Bip32Slip10EcdsaDerivator
+from .bip32_slip10_mst_key_generator import Bip32Slip10Secp256k1MstKeyGenerator
+from ...ecc import EllipticCurveTypes
+
+
+class Bip32Slip10Secp256k1(Bip32Base):
+    """
+    BIP32 SLIP-0010 secp256k1 v.
+    It allows master keys generation and keys derivation using secp256k1 curve.
+    """
+
+    @staticmethod
+    def CurveType() -> EllipticCurveTypes:
+        """
+        Return the elliptic curve type.
+
+        Returns:
+            EllipticCurveTypes: Curve type
+        """
+        return EllipticCurveTypes.SECP256K1
+
+    @staticmethod
+    def _DefaultKeyNetVersion() -> Bip32KeyNetVersions:
+        """
+        Return the default key net version.
+
+        Returns:
+            Bip32KeyNetVersions object: Bip32KeyNetVersions object
+        """
+        return Bip32Const.MAIN_NET_KEY_NET_VERSIONS
+
+    @staticmethod
+    def _KeyDerivator() -> Type[IBip32KeyDerivator]:
+        """
+        Return the key derivator class.
+
+        Returns:
+            IBip32KeyDerivator class: Key derivator class
+        """
+        return Bip32Slip10EcdsaDerivator
+
+    @staticmethod
+    def _MasterKeyGenerator() -> Type[IBip32MstKeyGenerator]:
+        """
+        Return the master key generator class.
+
+        Returns:
+            IBip32MstKeyGenerator class: Master key generator class
+        """
+        return Bip32Slip10Secp256k1MstKeyGenerator
+
+
+# Deprecated: only for compatibility
+Bip32Secp256k1 = Bip32Slip10Secp256k1

coinex/ccxt/static_dependencies/bip/bip44/__init__.py

@@ -0,0 +1 @@
+from .bip44 import Bip44