The cl-base58 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-base58 Reference Manual

This is the cl-base58 Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:25:08 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 cl-base58/src

Parent

cl-base58 (system)

Location

src/

Component

cl-base58.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-base58.asd

Location

cl-base58.asd

Systems

cl-base58 (system)

Packages

cl-base58-asd


Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/cl-base58.lisp

Packages

base58

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-base58-asd

Source

cl-base58.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 base58

Source

cl-base58.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: divmod NUMBER DIVISOR
Package

base58

Source

cl-base58.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-base58.asd: The cl-base58<dot>asd file
cl-base58/src: The cl-base58/src module
cl-base58/src/cl-base58.lisp: The cl-base58/src/cl-base58<dot>lisp file

F
File, Lisp, cl-base58.asd: The cl-base58<dot>asd file
File, Lisp, cl-base58/src/cl-base58.lisp: The cl-base58/src/cl-base58<dot>lisp file

L
Lisp File, cl-base58.asd: The cl-base58<dot>asd file
Lisp File, cl-base58/src/cl-base58.lisp: The cl-base58/src/cl-base58<dot>lisp file

M
Module, cl-base58/src: The cl-base58/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   D   E   F  
Index Entry  Section

D
decode: Exported functions
divmod: Internal functions

E
encode: Exported functions

F
Function, decode: Exported functions
Function, divmod: Internal functions
Function, encode: Exported functions

Jump to:   D   E   F  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+alphabet+: Internal special variables
+len+: Internal special variables

S
Special Variable, +alphabet+: Internal special variables
Special Variable, +len+: Internal special variables

Jump to:   +  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   P   S  
Index Entry  Section

B
base58: The base58 package

C
cl-base58: The cl-base58 system
cl-base58-asd: The cl-base58-asd package

P
Package, base58: The base58 package
Package, cl-base58-asd: The cl-base58-asd package

S
System, cl-base58: The cl-base58 system

Jump to:   B   C   P   S