https://github.com/keis/base58

Base58 and Base58Check implementation compatible with what is used by the bitcoin network.
https://github.com/keis/base58

base58 bitcoin encoding python

Last synced: 11 days ago
JSON representation

Base58 and Base58Check implementation compatible with what is used by the bitcoin network.

• Host: GitHub
• URL: https://github.com/keis/base58
• Owner: keis
• License: mit
• Created: 2013-05-09T07:49:20.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T10:27:03.000Z (almost 2 years ago)
• Last Synced: 2024-10-30T01:02:29.551Z (14 days ago)
• Topics: base58, bitcoin, encoding, python
• Language: Python
• Homepage:
• Size: 91.8 KB
• Stars: 180
• Watchers: 6
• Forks: 59
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING

Awesome Lists containing this project

README

        
# base58

[![PyPI Version][pypi-image]](https://pypi.python.org/pypi?name=base58&:action=display)

[![PyPI Downloads][pypi-downloads-image]](https://pypi.python.org/pypi?name=base58&:action=display)

[![Build Status][travis-image]](https://travis-ci.org/keis/base58)

[![Coverage Status][coveralls-image]](https://coveralls.io/r/keis/base58?branch=master)

Base58 and Base58Check implementation compatible with what is used by the

bitcoin network. Any other alternative alphabet (like the XRP one) can be used.

Starting from version 2.0.0 **python2 is no longer supported** the 1.x series

will remain supported but no new features will be added.

## Command line usage

    $ printf "hello world" | base58

    StV1DL6CwTryKyV

    $ printf "hello world" | base58 -c

    3vQB7B6MrGQZaxCuFg4oh

    $ printf "3vQB7B6MrGQZaxCuFg4oh" | base58 -dc

    hello world

    $ printf "4vQB7B6MrGQZaxCuFg4oh" | base58 -dc

    Invalid checksum

## Module usage

    >>> import base58

    >>> base58.b58encode(b'hello world')

    b'StV1DL6CwTryKyV'

    >>> base58.b58decode(b'StV1DL6CwTryKyV')

    b'hello world'

    >>> base58.b58encode_check(b'hello world')

    b'3vQB7B6MrGQZaxCuFg4oh'

    >>> base58.b58decode_check(b'3vQB7B6MrGQZaxCuFg4oh')

    b'hello world'

    >>> base58.b58decode_check(b'4vQB7B6MrGQZaxCuFg4oh')

    Traceback (most recent call last):

      File "", line 1, in 

      File "base58.py", line 89, in b58decode_check

        raise ValueError("Invalid checksum")

    ValueError: Invalid checksum

    # Use another alphabet. Here, using the built-in XRP/Ripple alphabet.

    # RIPPLE_ALPHABET is provided as an option for compatibility with existing code

    # It is recommended to use XRP_ALPHABET instead

    >>> base58.b58encode(b'hello world', alphabet=base58.XRP_ALPHABET)

    b'StVrDLaUATiyKyV'

    >>> base58.b58decode(b'StVrDLaUATiyKyV', alphabet=base58.XRP_ALPHABET)

    b'hello world'

[pypi-image]: https://img.shields.io/pypi/v/base58.svg?style=flat

[pypi-downloads-image]: https://img.shields.io/pypi/dm/base58.svg?style=flat

[travis-image]: https://img.shields.io/travis/keis/base58.svg?style=flat

[coveralls-image]: https://img.shields.io/coveralls/keis/base58.svg?style=flat