Base58check

Common errors

• ValueError: Invalid base58check string

  cause Attempting to decode a string that is not a valid Base58Check format (e.g., incorrect characters, wrong length, or a failed checksum verification).
  fix Ensure the input string was originally encoded using Base58Check and is not corrupted. Implement `try...except ValueError` for robust error handling.

• AttributeError: module 'base58check' has no attribute 'encode'

  cause Trying to use `base58check.encode()` or `base58check.decode()` directly instead of the library's specific function names `base58check.b58encode()` and `base58check.b58decode()`.
  fix Correct the function call to `base58check.b58encode()` for encoding and `base58check.b58decode()` for decoding.

Warnings

• gotcha The library implements Base58Check encoding/decoding, which includes a checksum. It does not provide plain Base58 encoding without the checksum. Ensure your application requires the checksum for security and integrity.
  Fix: Always use this library when a Base58Check checksum is required. If plain Base58 is needed, use a different library (e.g., `base58`).
• gotcha When decoding, an invalid Base58Check string (e.g., incorrect characters, wrong length, or a failed checksum) will raise a `ValueError`. It's essential to handle these exceptions gracefully.
  Fix: Wrap decoding calls in a `try...except ValueError` block to manage invalid input strings. For example: `try: data = base58check.b58decode(s) except ValueError: print('Invalid string')`.
• gotcha The `b58encode` function accepts either a string or bytes. While it converts strings to bytes internally using UTF-8, it is generally best practice to explicitly provide `bytes` for binary data encoding to avoid potential encoding issues.
  Fix: Ensure your input for `b58encode` is a `bytes` object (e.g., `b'my_data'`) for clarity and to prevent unexpected behavior with non-ASCII characters if not explicitly handled.

Install

• pip install base58check Install stable version

Imports

• b58encode
  wrong:

  from base58check import encode

  correct:

  import base58check
  encoded_data = base58check.b58encode(b'my_data')

  The functions are named `b58encode` and `b58decode` within the module.
• b58decode
  wrong:

  from base58check import decode

  correct:

  import base58check
  decoded_data = base58check.b58decode('encodedstring')

  The functions are named `b58encode` and `b58decode` within the module.

Quickstart

Demonstrates encoding a byte string and decoding it back, along with a simple example of a Bitcoin-like address encoding pattern.

import base58check

# Encode binary data
original_data = b"Hello, Base58Check!"
encoded_string = base58check.b58encode(original_data)
print(f"Encoded: {encoded_string}")

# Decode a Base58Check string
decoded_data = base58check.b58decode(encoded_string)
print(f"Decoded: {decoded_data}")

# Example with a Bitcoin-like address (simulated for demonstration)
simulated_address_bytes = b'\x00' + b'\x01\x09\x66\x77\x60\x06\x95\x3D\x55\x67\x43\x9E\x5E\x39\x8E\x8B\x0D\x9C\x1C\x00\x10' # Example payload
simulated_address_encoded = base58check.b58encode(simulated_address_bytes)
print(f"Simulated Address: {simulated_address_encoded}")