Skip to content

Commit

Permalink
Drop: type column from const docs
Browse files Browse the repository at this point in the history
  • Loading branch information
axiom90 committed Jul 17, 2024
1 parent ad0d48d commit 684bab5
Showing 1 changed file with 54 additions and 54 deletions.
108 changes: 54 additions & 54 deletions hdwallet/const.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ class SLIP10_ED25519_CONST:
"""
``SLIP10-ED25519`` Constants.
+-------------------------+-----------+--------------+
| Name | Type | Value |
+=========================+===========+==============+
| PRIVATE_KEY_BYTE_LENGTH | ``int`` | 32 |
+-------------------------+-----------+--------------+
| PUBLIC_KEY_PREFIX | ``bytes`` | ``0x00`` |
+-------------------------+-----------+--------------+
| PUBLIC_KEY_BYTE_LENGTH | ``int`` | 32 |
+-------------------------+-----------+--------------+
+-------------------------+--------------+
| Name | Value |
+=========================+==============+
| PRIVATE_KEY_BYTE_LENGTH | 32 |
+-------------------------+--------------+
| PUBLIC_KEY_PREFIX | ``0x00`` |
+-------------------------+--------------+
| PUBLIC_KEY_BYTE_LENGTH | 32 |
+-------------------------+--------------+
"""

PRIVATE_KEY_BYTE_LENGTH: int = 32
Expand All @@ -62,15 +62,15 @@ class KHOLAW_ED25519_CONST(SLIP10_ED25519_CONST):
"""
``KHOLAW-ED25519`` Constants.
+-------------------------+-----------+--------------+
| Name | Type | Value |
+=========================+===========+==============+
| PRIVATE_KEY_BYTE_LENGTH | ``int`` | 64 |
+-------------------------+-----------+--------------+
| PUBLIC_KEY_PREFIX | ``bytes`` | ``0x00`` |
+-------------------------+-----------+--------------+
| PUBLIC_KEY_BYTE_LENGTH | ``int`` | 32 |
+-------------------------+-----------+--------------+
+-------------------------+--------------+
| Name | Value |
+=========================+==============+
| PRIVATE_KEY_BYTE_LENGTH | 64 |
+-------------------------+--------------+
| PUBLIC_KEY_PREFIX | ``0x00`` |
+-------------------------+--------------+
| PUBLIC_KEY_BYTE_LENGTH | 32 |
+-------------------------+--------------+
"""

PRIVATE_KEY_BYTE_LENGTH: int = 64
Expand All @@ -80,21 +80,21 @@ class SLIP10_SECP256K1_CONST:
"""
``SLIP10-SECP256K1`` Constants.
+-------------------------------------+-----------------------------------+-------------+
| Name | Type | Value |
+=====================================+===================================+=============+
| USE | ``Literal['coincurve', 'ecdsa']`` | 'coincurve' |
+-------------------------------------+-----------------------------------+-------------+
| POINT_COORDINATE_BYTE_LENGTH | ``int`` | 32 |
+-------------------------------------+-----------------------------------+-------------+
| PRIVATE_KEY_BYTE_LENGTH | ``int`` | 32 |
+-------------------------------------+-----------------------------------+-------------+
| PUBLIC_KEY_PREFIX | ``bytes`` | ``0x04`` |
+-------------------------------------+-----------------------------------+-------------+
| PUBLIC_KEY_COMPRESSED_BYTE_LENGTH | ``int`` | 33 |
+-------------------------------------+-----------------------------------+-------------+
| PUBLIC_KEY_UNCOMPRESSED_BYTE_LENGTH | ``int`` | 65 |
+-------------------------------------+-----------------------------------+-------------+
+-------------------------------------+-------------+
| Name | Value |
+=====================================+=============+
| USE | 'coincurve' |
+-------------------------------------+-------------+
| POINT_COORDINATE_BYTE_LENGTH | 32 |
+-------------------------------------+-------------+
| PRIVATE_KEY_BYTE_LENGTH | 32 |
+-------------------------------------+-------------+
| PUBLIC_KEY_PREFIX | ``0x04`` |
+-------------------------------------+-------------+
| PUBLIC_KEY_COMPRESSED_BYTE_LENGTH | 33 |
+-------------------------------------+-------------+
| PUBLIC_KEY_UNCOMPRESSED_BYTE_LENGTH | 65 |
+-------------------------------------+-------------+
"""

USE: Literal["coincurve", "ecdsa"] = "coincurve"
Expand Down Expand Up @@ -214,13 +214,13 @@ class PUBLIC_KEY_TYPES:
"""
``PUBLIC_KEY_TYPES`` Constants.
+----------------+-----------+-----------------+
| Name | Type | Value |
+================+===========+=================+
| COMPRESSED | ``str`` | 'uncompressed' |
+----------------+-----------+-----------------+
| UNCOMPRESSED | ``str`` | 'compressed' |
+----------------+-----------+-----------------+
+----------------+-----------------+
| Name | Value |
+================+=================+
| COMPRESSED | 'uncompressed' |
+----------------+-----------------+
| UNCOMPRESSED | 'compressed' |
+----------------+-----------------+
"""

UNCOMPRESSED: str = "uncompressed"
Expand All @@ -244,13 +244,13 @@ class WIF_TYPES:
"""
``WIF_TYPES`` Constants.
+----------------+-----------+------------------+
| Name | Type | Value |
+================+===========+==================+
| WIF | ``str`` | 'wif' |
+----------------+-----------+------------------+
| WIF_COMPRESSED | ``str`` | 'wif-compressed' |
+----------------+-----------+------------------+
+----------------+------------------+
| Name | Value |
+================+==================+
| WIF | 'wif' |
+----------------+------------------+
| WIF_COMPRESSED | 'wif-compressed' |
+----------------+------------------+
"""

WIF: str = "wif"
Expand All @@ -274,13 +274,13 @@ class ELECTRUM_V2_MODES:
"""
``PUBLIC_KEY_TYPES`` Constants.
+----------------+-----------+-----------------+
| Name | Type | Value |
+================+===========+=================+
| STANDARD | ``str`` | 'standard' |
+----------------+-----------+-----------------+
| SEGWIT | ``str`` | 'segwit' |
+----------------+-----------+-----------------+
+----------------+-----------------+
| Name | Value |
+================+=================+
| STANDARD | 'standard' |
+----------------+-----------------+
| SEGWIT | 'segwit' |
+----------------+-----------------+
"""

STANDARD: str = "standard"
Expand Down

0 comments on commit 684bab5

Please sign in to comment.