The cl-base58 Reference Manual

Table of Contents

The cl-base58 Reference Manual

This is the cl-base58 Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:02:50 2020 GMT+0.

1 Introduction

This library implements the base58 encoding algorithm. It's basically base64 but with a smaller alphabet (58, as in the title) that doesn't include similar looking characters, among other things.

The implementation is essentially a carbon copy of Gavin Andresen's Python code.

Usage

cl-user> (base58:encode "this is a test")
"jo91waLQA1NNeBmZKUF"
cl-user> (base58:decode "jo91waLQA1NNeBmZKUF")
"this is a test"

Tests

The encoded strings in the tests were created with Andresen's unmodified code, so they are correct. Probably.

License

Copyright (c) 2014 Fernando Borretti (eudoxiahp@gmail.com)

Licensed under the MIT License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-base58

Author

Fernando Borretti

Home Page

https://github.com/eudoxia0/cl-base58

License

MIT

Description

An implementation of base58 for Common Lisp

Long Description

This library implements the base58 encoding algorithm. It’s basically base64 but with a smaller alphabet (58, as in the title) that doesn’t include similar looking characters,
[among other things](https://github.com/bitcoin/bitcoin/blob/master/src/base58.h).

The implementation is essentially a carbon copy of Gavin Andresen’s
[Python code](https://bitcointalk.org/index.php?topic=1026.0).

# Usage

“‘lisp
cl-user> (base58:encode "this is a test")
"jo91waLQA1NNeBmZKUF"
cl-user> (base58:decode "jo91waLQA1NNeBmZKUF")
"this is a test"
“‘

# Tests

The encoded strings in the tests were created with Andresen’s unmodified code, so they are correct. Probably.

# License

Copyright (c) 2014 Fernando Borretti (eudoxiahp@gmail.com)

Licensed under the MIT License.

Version

0.1

Source

cl-base58.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-base58/src

Parent

cl-base58 (system)

Location

src/

Component

cl-base58.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-base58.asd

Location

cl-base58.asd

Systems

cl-base58 (system)

Packages

cl-base58-asd

4.1.2 cl-base58/src/cl-base58.lisp

Parent

src (module)

Location

src/cl-base58.lisp

Packages

base58

Exported Definitions

• decode (function)
• encode (function)

Internal Definitions

• +alphabet+ (special variable)
• +len+ (special variable)
• divmod (function)

5 Packages

Packages are listed by definition order.

5.1 cl-base58-asd

Source

cl-base58.asd

Use List

• asdf/interface
• common-lisp

5.2 base58

Source

cl-base58.lisp (file)

Use List

common-lisp

Exported Definitions

• decode (function)
• encode (function)

Internal Definitions

• +alphabet+ (special variable)
• +len+ (special variable)
• divmod (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Functions

Function: decode STR &optional LENGTH

Package

base58

Source

cl-base58.lisp (file)

Function: encode STR

Package

base58

Source

cl-base58.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: +alphabet+

Package

base58

Source

cl-base58.lisp (file)

Special Variable: +len+

Package

base58

Source

cl-base58.lisp (file)

6.2.2 Functions

Function: divmod NUMBER DIVISOR

Package

base58

Source

cl-base58.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types