Review docstrings

ebellocchia · ebellocchia · commit 58facb64114e · 2026-02-27T20:56:17.000+01:00
diff --git a/bip_utils/addr/P2TR_addr.py b/bip_utils/addr/P2TR_addr.py
@@ -138,8 +138,8 @@ def TweakPublicKey(pub_key: IPublicKey) -> bytes:
 
 class P2TRAddrDecoder(IAddrDecoder):
     """
-    P2WPKH address decoder class.
-    It allows the Pay-to-Witness-Public-Key-Hash address decoding.
+    P2TR address decoder class.
+    It allows the Pay-to-Taproot address decoding.
     """
 
     @staticmethod
diff --git a/bip_utils/addr/eos_addr.py b/bip_utils/addr/eos_addr.py
@@ -123,7 +123,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not secp256k1
         """
diff --git a/bip_utils/addr/ergo_addr.py b/bip_utils/addr/ergo_addr.py
@@ -165,7 +165,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not secp256k1 or the network tag is not a ErgoNetworkTypes enum
         """
diff --git a/bip_utils/addr/eth_addr.py b/bip_utils/addr/eth_addr.py
@@ -128,7 +128,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not secp256k1
         """
diff --git a/bip_utils/addr/fil_addr.py b/bip_utils/addr/fil_addr.py
@@ -181,7 +181,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not secp256k1 or the address type is not valid
         """
diff --git a/bip_utils/addr/iaddr_decoder.py b/bip_utils/addr/iaddr_decoder.py
@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-"""Module with interface for address encoding classes."""
+"""Module with interface for address decoding classes."""
 
 # Imports
 from abc import ABC, abstractmethod
diff --git a/bip_utils/addr/iaddr_encoder.py b/bip_utils/addr/iaddr_encoder.py
@@ -44,7 +44,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not of the correct type (it depends on the address type)
         """
diff --git a/bip_utils/addr/icx_addr.py b/bip_utils/addr/icx_addr.py
@@ -96,7 +96,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not secp256k1
         """
diff --git a/bip_utils/addr/inj_addr.py b/bip_utils/addr/inj_addr.py
@@ -49,7 +49,7 @@ class InjAddrDecoder(IAddrDecoder):
     def DecodeAddr(addr: str,
                    **kwargs: Any) -> bytes:
         """
-        Decode an Algorand address to bytes.
+        Decode an Injective address to bytes.
 
         Args:
             addr (str): Address string
diff --git a/bip_utils/addr/one_addr.py b/bip_utils/addr/one_addr.py
@@ -44,7 +44,7 @@ class OneAddrDecoder(IAddrDecoder):
     def DecodeAddr(addr: str,
                    **kwargs: Any) -> bytes:
         """
-        Decode a OKEx Chain address to bytes.
+        Decode a Harmony One address to bytes.
 
         Args:
             addr (str): Address string
diff --git a/bip_utils/addr/substrate_addr.py b/bip_utils/addr/substrate_addr.py
@@ -119,7 +119,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
         """
         ss58_format = kwargs["ss58_format"]
@@ -178,7 +178,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
         """
         ss58_format = kwargs["ss58_format"]
diff --git a/bip_utils/addr/sui_addr.py b/bip_utils/addr/sui_addr.py
@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-"""Module for Solana address encoding/decoding."""
+"""Module for Sui address encoding/decoding."""
 
 # Imports
 from typing import Any, Union
diff --git a/bip_utils/addr/ton_addr.py b/bip_utils/addr/ton_addr.py
@@ -61,7 +61,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not ed25519
         """
diff --git a/bip_utils/addr/trx_addr.py b/bip_utils/addr/trx_addr.py
@@ -98,7 +98,7 @@ def EncodeKey(pub_key: Union[bytes, IPublicKey],
         Returns:
             str: Address string
 
-        Raised:
+        Raises:
             ValueError: If the public key is not valid
             TypeError: If the public key is not secp256k1
         """
diff --git a/bip_utils/algorand/mnemonic/algorand_mnemonic_decoder.py b/bip_utils/algorand/mnemonic/algorand_mnemonic_decoder.py
@@ -110,7 +110,7 @@ def __ValidateChecksum(entropy_bytes: bytes,
         Validate a mnemonic checksum.
 
         Args:
-            entropy_bytes (list)          : Entropy bytes
+            entropy_bytes (bytes)         : Entropy bytes
             chksum_word_idx_exp (int)     : Expected checksum word index
             words_list (MnemonicWordsList): Words list
 
diff --git a/bip_utils/algorand/mnemonic/algorand_mnemonic_utils.py b/bip_utils/algorand/mnemonic/algorand_mnemonic_utils.py
@@ -52,7 +52,7 @@ def ComputeChecksumWordIndex(data_bytes: bytes) -> int:
             data_bytes (bytes): Data bytes
 
         Returns:
-            str: Computed checksum word index
+            int: Computed checksum word index
         """
 
         # Compute checksum and convert it to 11-bit
diff --git a/bip_utils/base58/base58_xmr.py b/bip_utils/base58/base58_xmr.py
@@ -99,7 +99,7 @@ def __Pad(enc_str: str,
 class Base58XmrDecoder:
     """
     Base58 Monero decoder class.
-    It provides methods for decoding Base58 format with Monero variation (encoding by blocks of 8-byte).
+    It provides methods for decoding Base58 format with Monero variation (decoding by blocks of 8-byte).
     """
 
     @staticmethod
@@ -150,6 +150,6 @@ def __UnPad(dec_bytes: bytes,
             unpad_len (int): Unpad length
 
         Returns:
-            bytes: Unpadded string
+            bytes: Unpadded bytes
         """
         return dec_bytes[len(dec_bytes) - unpad_len:len(dec_bytes)]
diff --git a/bip_utils/bech32/bech32.py b/bip_utils/bech32/bech32.py
@@ -187,7 +187,7 @@ def _ComputeChecksum(hrp: str,
 class Bech32Decoder(Bech32DecoderBase):
     """
     Bech32 decoder class.
-    It provides methods for decoding  Bech32 format.
+    It provides methods for decoding Bech32 format.
     """
 
     @classmethod
diff --git a/bip_utils/bip/bip32/bip32_key_data.py b/bip_utils/bip/bip32/bip32_key_data.py
@@ -61,7 +61,7 @@ def __init__(self,
         Construct class.
 
         Args:
-            chaincode (bytes, optional): Fingerprint bytes (default: zero)
+            chaincode (bytes, optional): Chaincode bytes (default: zero)
 
         Raises:
             ValueError: If the chain code length is not valid
diff --git a/bip_utils/bip/bip32/slip10/bip32_slip10_secp256k1.py b/bip_utils/bip/bip32/slip10/bip32_slip10_secp256k1.py
@@ -35,7 +35,7 @@
 
 class Bip32Slip10Secp256k1(Bip32Base):
     """
-    BIP32 SLIP-0010 secp256k1 v.
+    BIP32 SLIP-0010 secp256k1 class.
     It allows master keys generation and keys derivation using secp256k1 curve.
     """
 
diff --git a/bip_utils/bip/bip38/bip38_ec.py b/bip_utils/bip/bip38/bip38_ec.py
@@ -194,7 +194,7 @@ def DeriveKeyHalves(passpoint: bytes,
                         address_hash: bytes,
                         owner_entropy: bytes) -> Tuple[bytes, bytes]:
         """
-        Compute the scrypt as specified in BIP38 (without EC multiplication)and derive the two key halves.
+        Compute the scrypt as specified in BIP38 (without EC multiplication) and derive the two key halves.
 
         Args:
             passpoint (bytes)    : Passpoint
diff --git a/bip_utils/bip/bip44_base/bip44_keys.py b/bip_utils/bip/bip44_base/bip44_keys.py
@@ -164,7 +164,7 @@ def Bip32Key(self) -> Bip32PrivateKey:
         Return the BIP32 key object.
 
         Returns:
-            Bip32PublicKey object: BIP32 key object
+            Bip32PrivateKey object: BIP32 key object
         """
         return self.m_priv_key
 
@@ -188,7 +188,7 @@ def ChainCode(self) -> Bip32ChainCode:
 
     def Raw(self) -> DataBytes:
         """
-        Return raw compressed public key.
+        Return raw private key.
 
         Returns:
             DataBytes object: DataBytes object
diff --git a/bip_utils/bip/conf/common/bip_bitcoin_cash_conf.py b/bip_utils/bip/conf/common/bip_bitcoin_cash_conf.py
@@ -62,7 +62,7 @@ def __init__(self,  # pylint: disable=too-many-arguments
             bip32_cls (Bip32Base class)             : Bip32 class
             addr_params (dict)                      : Address parameters
             addr_cls (IAddrEncoder class)           : Address class
-            addr_cls_legacy (IAddrEncoder class)    : Legacy ddress class
+            addr_cls_legacy (IAddrEncoder class)    : Legacy address class
         """
         super().__init__(coin_names=coin_names,
                          coin_idx=coin_idx,
diff --git a/bip_utils/brainwallet/brainwallet.py b/bip_utils/brainwallet/brainwallet.py
@@ -62,7 +62,7 @@ def Generate(cls,
             **algo_params               : Algorithm parameters, if any
 
         Returns:
-            Brainwallet object: Algorithm class
+            Brainwallet object: Generated Brainwallet object
 
         Raises:
             TypeError: If algorithm type is not of a BrainwalletAlgos enumerative
@@ -91,7 +91,7 @@ def GenerateWithCustomAlgo(cls,
             **algo_params                    : Algorithm parameters, if any
 
         Returns:
-            Brainwallet object: Algorithm class
+            Brainwallet object: Generated Brainwallet object
 
         Raises:
             TypeError: If algorithm type is not of a BrainwalletAlgos enumerative
diff --git a/bip_utils/brainwallet/brainwallet_algo_getter.py b/bip_utils/brainwallet/brainwallet_algo_getter.py
@@ -48,7 +48,7 @@ class BrainwalletAlgoGetterConst:
 class BrainwalletAlgoGetter:
     """
     Brainwallet algorithm getter class.
-    It allows to get the a specific brainwallet algorithm.
+    It allows to get a specific brainwallet algorithm.
     """
 
     @staticmethod
diff --git a/bip_utils/cardano/byron/cardano_byron_legacy.py b/bip_utils/cardano/byron/cardano_byron_legacy.py
@@ -161,7 +161,7 @@ def GetPrivateKey(self,
             second_idx (int or Bip32KeyIndex object): Second index
 
         Returns:
-            IPrivateKey object: IPrivateKey object
+            Bip32PrivateKey object: Bip32PrivateKey object
 
         Raises:
             Bip32KeyError: If the derivation results in an invalid key
@@ -177,13 +177,12 @@ def GetPublicKey(self,
         Derivation path: m/first_idx'/second_idx'
         The indexes will be automatically hardened if not (e.g. 0, 1' -> 0', 1').
 
-
         Args:
             first_idx (int or Bip32KeyIndex object) : First index
             second_idx (int or Bip32KeyIndex object): Second index
 
         Returns:
-            IPublicKey object: IPublicKey object
+            Bip32PublicKey object: Bip32PublicKey object
 
         Raises:
             Bip32KeyError: If the derivation results in an invalid key
diff --git a/bip_utils/cardano/shelley/cardano_shelley.py b/bip_utils/cardano/shelley/cardano_shelley.py
@@ -145,7 +145,7 @@ def Change(self,
         Derive a child key from the specified change type and return a new CardanoShelley object.
 
         Args:
-            change_type (Bip44Changes): Change type, must a Bip44Changes enum
+            change_type (Bip44Changes): Change type, must be a Bip44Changes enum
 
         Returns:
             CardanoShelley object: CardanoShelley object
diff --git a/bip_utils/coin_conf/coins_conf.py b/bip_utils/coin_conf/coins_conf.py
@@ -851,7 +851,7 @@ class CoinsConf:
         params={},
     )
 
-    # Configuration for Tron
+    # Configuration for TON
     Ton: CoinConf = CoinConf(
         coin_name=CoinNames("The Open Network", "TON"),
         params={
diff --git a/bip_utils/ecc/sr25519/sr25519_keys.py b/bip_utils/ecc/sr25519/sr25519_keys.py
@@ -33,7 +33,7 @@
 
 
 class Sr25519KeysConst:
-    """Class container for ed25519 keys constants."""
+    """Class container for sr25519 keys constants."""
 
     # Public key length in bytes
     PUB_KEY_BYTE_LEN: int = 32
diff --git a/bip_utils/electrum/mnemonic_v1/electrum_v1_mnemonic_utils.py b/bip_utils/electrum/mnemonic_v1/electrum_v1_mnemonic_utils.py
@@ -56,11 +56,11 @@ def GetByLanguage(self,
             MnemonicWordsList object: MnemonicWordsList object
 
         Raises:
-            TypeError: If the language is not a Bip39Languages enum
+            TypeError: If the language is not a ElectrumV1Languages enum
             ValueError: If loaded words list is not valid
         """
         if not isinstance(lang, ElectrumV1Languages):
-            raise TypeError("Language is not an enumerative of Bip39Languages")
+            raise TypeError("Language is not an enumerative of ElectrumV1Languages")
 
         return self._LoadWordsList(lang,
                                    self.__GetLanguageFile(lang),
@@ -72,7 +72,7 @@ def __GetLanguageFile(lang: MnemonicLanguages) -> str:
         Get the specified language file name.
 
         Args:
-            lang (Bip39Languages): Language
+            lang (ElectrumV1Languages): Language
 
         Returns:
             str: Language file name
diff --git a/bip_utils/monero/mnemonic/monero_mnemonic_encoder.py b/bip_utils/monero/mnemonic/monero_mnemonic_encoder.py
@@ -49,7 +49,7 @@ def __init__(self,
             lang (MoneroLanguages, optional): Language (default: English)
 
         Raises:
-            TypeError: If the language is not a Bip39Languages enum
+            TypeError: If the language is not a MoneroLanguages enum
             ValueError: If loaded words list is not valid
         """
         super().__init__(lang, MoneroWordsListGetter)
diff --git a/bip_utils/monero/monero_keys.py b/bip_utils/monero/monero_keys.py
@@ -85,7 +85,7 @@ def FromPoint(cls,
             MoneroPublicKey object: MoneroPublicKey object
 
         Raises:
-            Bip32KeyError: If the key constructed from the bytes is not valid
+            MoneroKeyError: If the key constructed from the bytes is not valid
         """
         return cls(cls.__KeyFromPoint(key_point))
 
diff --git a/bip_utils/slip/slip32/slip32.py b/bip_utils/slip/slip32/slip32.py
@@ -175,9 +175,6 @@ def __init__(self,
             path (Bip32Path object)           : BIP32 path
             chain_code (Bip32ChainCode object): Chain code
             is_public (bool)                  : True if the key is public, false otherwise
-
-        Returns:
-            str: Serialized public key
         """
         self.m_key_bytes = key_bytes
         self.m_path = path
diff --git a/bip_utils/ss58/ss58.py b/bip_utils/ss58/ss58.py
@@ -124,7 +124,7 @@ def Decode(data_str: str) -> Tuple[int, bytes]:
         Decode bytes from a SS58 string.
 
         Args:
-            data_str (string): Data string
+            data_str (str): Data string
 
         Returns:
             tuple[int, bytes]: SS58 format and data bytes
diff --git a/bip_utils/substrate/substrate.py b/bip_utils/substrate/substrate.py
@@ -185,7 +185,7 @@ def __init__(self,
         # Private key object
         if priv_key is not None:
             self.m_priv_key = SubstratePrivateKey.FromBytesOrKeyObject(priv_key, coin_conf)
-            # Use the provided public key if any. This is done because se25519 library returns both the
+            # Use the provided public key if any. This is done because sr25519 library returns both the
             # derived private and public keys, so we can avoid to compute the public key from the private key
             # that takes time
             self.m_pub_key = (SubstratePublicKey.FromBytesOrKeyObject(pub_key, coin_conf)
diff --git a/bip_utils/substrate/substrate_path.py b/bip_utils/substrate/substrate_path.py
@@ -181,7 +181,7 @@ def __ComputeChainCode(self) -> bytes:
     @staticmethod
     def __IsElemValid(elem: str) -> bool:
         """
-        Get a path element is valid.
+        Check if a path element is valid.
 
         Args:
             elem (str): Path element
@@ -268,7 +268,7 @@ def __str__(self) -> str:
         Get the path as a string.
 
         Returns:
-            str: Path as a list of integers
+            str: Path as a string
         """
         return self.ToStr()
 
diff --git a/bip_utils/ton/mnemonic/ton_seed_utils.py b/bip_utils/ton/mnemonic/ton_seed_utils.py
diff --git a/bip_utils/utils/conf/coin_names.py b/bip_utils/utils/conf/coin_names.py
diff --git a/bip_utils/utils/crypto/crc.py b/bip_utils/utils/crypto/crc.py
diff --git a/bip_utils/utils/misc/base64.py b/bip_utils/utils/misc/base64.py
diff --git a/bip_utils/utils/misc/bytes.py b/bip_utils/utils/misc/bytes.py
diff --git a/bip_utils/utils/misc/data_bytes.py b/bip_utils/utils/misc/data_bytes.py
diff --git a/bip_utils/utils/mnemonic/mnemonic_decoder_base.py b/bip_utils/utils/mnemonic/mnemonic_decoder_base.py
diff --git a/bip_utils/wif/wif.py b/bip_utils/wif/wif.py
