https://github.com/joeblackwaslike/base58check

A python implementation of the Base58Check encoding scheme
https://github.com/joeblackwaslike/base58check

Last synced: about 2 months ago
JSON representation

A python implementation of the Base58Check encoding scheme

• Host: GitHub
• URL: https://github.com/joeblackwaslike/base58check
• Owner: joeblackwaslike
• License: mit
• Created: 2018-04-06T06:04:52.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-07T21:20:53.000Z (10 months ago)
• Last Synced: 2024-09-21T14:07:38.440Z (4 months ago)
• Language: Python
• Size: 12.7 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Base58Check

[![Build Status](https://travis-ci.org/joeblackwaslike/base58check.svg?branch=master)](https://travis-ci.org/joeblackwaslike/base58check) [![Github Repo](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/joeblackwaslike/base58check) [![Pypi Version](https://img.shields.io/pypi/v/base58check.svg)](https://pypi.python.org/pypi/base58check) [![Pypi License](https://img.shields.io/pypi/l/base58check.svg)](https://pypi.python.org/pypi/base58check) [![Pypi Wheel](https://img.shields.io/pypi/wheel/base58check.svg)](https://pypi.python.org/pypi/base58check) [![Pypi Versions](https://img.shields.io/pypi/pyversions/base58check.svg)](https://pypi.python.org/pypi/base58check)

## Maintainer

Joe Black |  | [github](https://github.com/joeblackwaslike)

## Introduction

A python implementation of the Base58Check encoding scheme.

The Base58Check encoding scheme is a modified Base 58 binary-to-text encoding.  More generically, Base58Check encoding is used for encoding byte arrays in Bitcoin into human-typable strings.

*PLEASE NOTE*: For consistency with encoding schemes in python, encode inputs must be bytes and will be enforced.  Use `.encode('ascii')` on text input to encode to bytes.

* ref: https://en.bitcoin.it/wiki/Base58Check_encoding

## Installation

```shell

pip3 install base58check

```

## Usage

```python

>>> import base58check

```

### encoding

```python

>>> base58check.b58encode(b'1BoatSLRHtKNngkdXEeobR76b53LETtpyT')

b'\x00v\x80\xad\xec\x8e\xab\xca\xba\xc6v\xbe\x9e\x83\x85J\xde\x0b\xd2,\xdb\x0b\xb9`\xde'

```

### decoding (input can be text or bytes here)

```python

>>> base58check.b58decode('\x00v\x80\xad\xec\x8e\xab\xca\xba\xc6v\xbe\x9e\x83\x85J\xde\x0b\xd2,\xdb\x0b\xb9`\xde')

b'1BoatSLRHtKNngkdXEeobR76b53LETtpyT'

```

## Changes

* [CHANGELOG](CHANGELOG.md)