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

coinex/ccxt/static_dependencies/bip/ecc/common/ikeys.py

@@ -0,0 +1,263 @@
+# 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 with interfaces for public/private keys classes."""
+
+# Imports
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+from .ipoint import IPoint
+from ..curve.elliptic_curve_types import EllipticCurveTypes
+from ...utils.misc import DataBytes
+
+
+class IPublicKey(ABC):
+    """
+    Interface for a generic elliptic curve public key.
+    Verify method is missing because not needed.
+    """
+
+    @classmethod
+    @abstractmethod
+    def FromBytes(cls,
+                  key_bytes: bytes) -> IPublicKey:
+        """
+        Construct class from key bytes.
+
+        Args:
+            key_bytes (bytes): Key bytes
+
+        Returns:
+            IPublicKey: IPublicKey object
+
+        Raises:
+            ValueError: If key bytes are not valid
+        """
+
+    @classmethod
+    @abstractmethod
+    def FromPoint(cls,
+                  key_point: IPoint) -> IPublicKey:
+        """
+        Construct class from key point.
+
+        Args:
+            key_point (IPoint object): Key point
+
+        Returns:
+            IPublicKey: IPublicKey object
+
+        Raises:
+            ValueError: If key point is not valid
+        """
+
+    @staticmethod
+    @abstractmethod
+    def CurveType() -> EllipticCurveTypes:
+        """
+        Get the elliptic curve type.
+
+        Returns:
+           EllipticCurveTypes: Elliptic curve type
+        """
+
+    @classmethod
+    def IsValidBytes(cls,
+                     key_bytes: bytes) -> bool:
+        """
+        Return if the specified bytes represents a valid public key.
+
+        Args:
+            key_bytes (bytes): Key bytes
+
+        Returns:
+            bool: True if valid, false otherwise
+        """
+        try:
+            cls.FromBytes(key_bytes)
+            return True
+        except ValueError:
+            return False
+
+    @classmethod
+    def IsValidPoint(cls,
+                     key_point: IPoint) -> bool:
+        """
+        Return if the specified point represents a valid public key.
+
+        Args:
+            key_point (IPoint object): Key point
+
+        Returns:
+            bool: True if valid, false otherwise
+        """
+        try:
+            cls.FromPoint(key_point)
+            return True
+        except ValueError:
+            return False
+
+    @staticmethod
+    @abstractmethod
+    def CompressedLength() -> int:
+        """
+        Get the compressed key length.
+
+        Returns:
+           int: Compressed key length
+        """
+
+    @staticmethod
+    @abstractmethod
+    def UncompressedLength() -> int:
+        """
+        Get the uncompressed key length.
+
+        Returns:
+           int: Uncompressed key length
+        """
+
+    @abstractmethod
+    def UnderlyingObject(self) -> Any:
+        """
+        Get the underlying object.
+
+        Returns:
+           Any: Underlying object
+        """
+
+    @abstractmethod
+    def RawCompressed(self) -> DataBytes:
+        """
+        Return raw compressed public key.
+
+        Returns:
+            DataBytes object: DataBytes object
+        """
+
+    @abstractmethod
+    def RawUncompressed(self) -> DataBytes:
+        """
+        Return raw uncompressed public key.
+
+        Returns:
+            DataBytes object: DataBytes object
+        """
+
+    @abstractmethod
+    def Point(self) -> IPoint:
+        """
+        Return the public key point.
+
+        Returns:
+            IPoint object: IPoint object
+        """
+
+
+class IPrivateKey(ABC):
+    """
+    Interface for a generic elliptic curve private key.
+    Sign method is missing because not needed.
+    """
+
+    @classmethod
+    @abstractmethod
+    def FromBytes(cls,
+                  key_bytes: bytes) -> IPrivateKey:
+        """
+        Construct class from key bytes.
+
+        Args:
+            key_bytes (bytes): Key bytes
+
+        Returns:
+            IPrivateKey: IPrivateKey object
+
+        Raises:
+            ValueError: If key bytes are not valid
+        """
+
+    @staticmethod
+    @abstractmethod
+    def CurveType() -> EllipticCurveTypes:
+        """
+        Get the elliptic curve type.
+
+        Returns:
+           EllipticCurveTypes: Elliptic curve type
+        """
+
+    @classmethod
+    def IsValidBytes(cls,
+                     key_bytes: bytes) -> bool:
+        """
+        Return if the specified bytes represent a valid private key.
+
+        Args:
+            key_bytes (bytes): key bytes
+
+        Returns:
+            bool: True if valid, false otherwise
+        """
+        try:
+            cls.FromBytes(key_bytes)
+            return True
+        except ValueError:
+            return False
+
+    @staticmethod
+    @abstractmethod
+    def Length() -> int:
+        """
+        Get the key length.
+
+        Returns:
+           int: Key length
+        """
+
+    @abstractmethod
+    def UnderlyingObject(self) -> Any:
+        """
+        Get the underlying object.
+
+        Returns:
+           Any: Underlying object
+        """
+
+    @abstractmethod
+    def Raw(self) -> DataBytes:
+        """
+        Return raw private key.
+
+        Returns:
+            DataBytes object: DataBytes object
+        """
+
+    @abstractmethod
+    def PublicKey(self) -> IPublicKey:
+        """
+        Get the public key correspondent to the private one.
+
+        Returns:
+            IPublicKey object: IPublicKey object
+        """

coinex/ccxt/static_dependencies/bip/ecc/common/ipoint.py

@@ -0,0 +1,190 @@
+# 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 with interfaces for point classes."""
+
+# Imports
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+from ..curve.elliptic_curve_types import EllipticCurveTypes
+from ...utils.misc import DataBytes
+
+
+class IPoint(ABC):
+    """Interface for a generic elliptic curve point."""
+
+    @classmethod
+    @abstractmethod
+    def FromBytes(cls,
+                  point_bytes: bytes) -> IPoint:
+        """
+        Construct class from point bytes.
+
+        Args:
+            point_bytes (bytes): Point bytes
+
+        Returns:
+            IPoint: IPoint object
+        """
+
+    @classmethod
+    @abstractmethod
+    def FromCoordinates(cls,
+                        x: int,
+                        y: int) -> IPoint:
+        """
+        Construct class from point coordinates.
+
+        Args:
+            x (int): X coordinate of the point
+            y (int): Y coordinate of the point
+
+        Returns:
+            IPoint: IPoint object
+        """
+
+    @staticmethod
+    @abstractmethod
+    def CurveType() -> EllipticCurveTypes:
+        """
+        Get the elliptic curve type.
+
+        Returns:
+           EllipticCurveTypes: Elliptic curve type
+        """
+
+    @staticmethod
+    @abstractmethod
+    def CoordinateLength() -> int:
+        """
+        Get the coordinate length.
+
+        Returns:
+           int: Coordinate key length
+        """
+
+    @abstractmethod
+    def UnderlyingObject(self) -> Any:
+        """
+        Get the underlying object.
+
+        Returns:
+           Any: Underlying object
+        """
+
+    @abstractmethod
+    def X(self) -> int:
+        """
+        Return X coordinate of the point.
+
+        Returns:
+            int: X coordinate of the point
+        """
+
+    @abstractmethod
+    def Y(self) -> int:
+        """
+        Return Y coordinate of the point.
+
+        Returns:
+            int: Y coordinate of the point
+        """
+
+    @abstractmethod
+    def Raw(self) -> DataBytes:
+        """
+        Return the point raw bytes.
+
+        Returns:
+            DataBytes object: DataBytes object
+        """
+
+    @abstractmethod
+    def RawEncoded(self) -> DataBytes:
+        """
+        Return the encoded point raw bytes.
+
+        Returns:
+            DataBytes object: DataBytes object
+        """
+
+    @abstractmethod
+    def RawDecoded(self) -> DataBytes:
+        """
+        Return the decoded point raw bytes.
+
+        Returns:
+            DataBytes object: DataBytes object
+        """
+
+    @abstractmethod
+    def __add__(self,
+                point: IPoint) -> IPoint:
+        """
+        Add point to another point.
+
+        Args:
+            point (IPoint object): IPoint object
+
+        Returns:
+            IPoint object: IPoint object
+        """
+
+    @abstractmethod
+    def __radd__(self,
+                 point: IPoint) -> IPoint:
+        """
+        Add point to another point.
+
+        Args:
+            point (IPoint object): IPoint object
+
+        Returns:
+            IPoint object: IPoint object
+        """
+
+    @abstractmethod
+    def __mul__(self,
+                scalar: int) -> IPoint:
+        """
+        Multiply point by a scalar.
+
+        Args:
+            scalar (int): scalar
+
+        Returns:
+            IPoint object: IPoint object
+        """
+
+    @abstractmethod
+    def __rmul__(self,
+                 scalar: int) -> IPoint:
+        """
+        Multiply point by a scalar.
+
+        Args:
+            scalar (int): scalar
+
+        Returns:
+            IPoint object: IPoint object
+        """

coinex/ccxt/static_dependencies/bip/ecc/conf.py

@@ -0,0 +1,28 @@
+# 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 ECC configuration."""
+
+
+class EccConf:
+    """ECC configuration class."""
+
+    # True for using coincurve for secp256k1, false for using ecdsa
+    USE_COINCURVE: bool = False

coinex/ccxt/static_dependencies/bip/ecc/curve/elliptic_curve.py

@@ -0,0 +1,121 @@
+# 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 with helper class for elliptic curves."""
+
+# Imports
+from typing import Type
+
+from ..common.ikeys import IPrivateKey, IPublicKey
+from ..common.ipoint import IPoint
+
+
+class EllipticCurve:
+    """
+    Class for a generic elliptic curve.
+    This is not meant to be complete but just the minimum required to abstract the bip module from
+    the specific ECC library.
+    """
+
+    m_name: str
+    m_order: int
+    m_generator: IPoint
+    m_point_cls: Type[IPoint]
+    m_pub_key_cls: Type[IPublicKey]
+    m_priv_key_cls: Type[IPrivateKey]
+
+    def __init__(self,  # pylint: disable=too-many-arguments
+                 name: str,
+                 order: int,
+                 generator: IPoint,
+                 point_cls: Type[IPoint],
+                 pub_key_cls: Type[IPublicKey],
+                 priv_key_cls: Type[IPrivateKey]):
+        """
+        Construct class.
+
+        Args:
+            name (str)                      : Curve name
+            order (int)                     : Curve order
+            generator (IPoint object)       : Curve generator point
+            point_cls (IPoint class)        : Point class
+            pub_key_cls (IPublicKey class)  : Public key class
+            priv_key_cls (IPrivateKey class): Private key class
+        """
+        self.m_name = name
+        self.m_order = order
+        self.m_generator = generator
+        self.m_point_cls = point_cls
+        self.m_pub_key_cls = pub_key_cls
+        self.m_priv_key_cls = priv_key_cls
+
+    def Name(self) -> str:
+        """
+        Return the curve name.
+
+        Returns:
+            str: Curve name
+        """
+        return self.m_name
+
+    def Order(self) -> int:
+        """
+        Return the curve order.
+
+        Returns:
+            int: Curve order
+        """
+        return self.m_order
+
+    def Generator(self) -> IPoint:
+        """
+        Get the curve generator point.
+
+        Returns:
+            IPoint object: IPoint object
+        """
+        return self.m_generator
+
+    def PointClass(self) -> Type[IPoint]:
+        """
+        Return the point class.
+
+        Returns:
+            IPoint class: Point class
+        """
+        return self.m_point_cls
+
+    def PublicKeyClass(self) -> Type[IPublicKey]:
+        """
+        Return the public key class.
+
+        Returns:
+            IPublicKey class: Public key class
+        """
+        return self.m_pub_key_cls
+
+    def PrivateKeyClass(self) -> Type[IPrivateKey]:
+        """
+        Return the private key class.
+
+        Returns:
+            IPrivateKey class: Private key class
+        """
+        return self.m_priv_key_cls

coinex/ccxt/static_dependencies/bip/ecc/curve/elliptic_curve_getter.py

@@ -0,0 +1,74 @@
+# 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 getting elliptic curves classes."""
+
+# Imports
+from typing import Dict
+
+from .elliptic_curve import EllipticCurve
+from .elliptic_curve_types import EllipticCurveTypes
+# from ..ed25519.ed25519 import Ed25519
+# from ..ed25519_blake2b.ed25519_blake2b import Ed25519Blake2b
+# from ..ed25519_kholaw.ed25519_kholaw import Ed25519Kholaw
+# from ..ed25519_monero.ed25519_monero import Ed25519Monero
+# from ..nist256p1.nist256p1 import Nist256p1
+from ..secp256k1.secp256k1 import Secp256k1
+# from ..sr25519.sr25519 import Sr25519
+
+
+class EllipticCurveGetterConst:
+    """Class container for elliptic curve getter constants."""
+
+    # Elliptic curve type to instance
+    TYPE_TO_INSTANCE: Dict[EllipticCurveTypes, EllipticCurve] = {
+        # EllipticCurveTypes.ED25519: Ed25519,
+        # EllipticCurveTypes.ED25519_BLAKE2B: Ed25519Blake2b,
+        # EllipticCurveTypes.ED25519_KHOLAW: Ed25519Kholaw,
+        # EllipticCurveTypes.ED25519_MONERO: Ed25519Monero,
+        # EllipticCurveTypes.NIST256P1: Nist256p1,
+        EllipticCurveTypes.SECP256K1: Secp256k1,
+        # EllipticCurveTypes.SR25519: Sr25519,
+    }
+
+
+class EllipticCurveGetter:
+    """
+    Elliptic curve getter class.
+    It allows to get the elliptic curve class from its type.
+    """
+
+    @staticmethod
+    def FromType(curve_type: EllipticCurveTypes) -> EllipticCurve:
+        """
+        Get the elliptic curve class from its type.
+
+        Args:
+            curve_type (EllipticCurveTypes): Curve type
+
+        Returns:
+            EllipticCurve object: EllipticCurve object
+
+        Raises:
+            TypeError: If curve type is not a EllipticCurveTypes enum
+        """
+        if not isinstance(curve_type, EllipticCurveTypes):
+            raise TypeError("Curve type is not an enumerative of EllipticCurveTypes")
+        return EllipticCurveGetterConst.TYPE_TO_INSTANCE[curve_type]