The cl-bip39 Reference Manual

This is the cl-bip39 Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:44:45 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-bip39

A Common Lisp implementation of BIP-0039

Author

Smith Dhumbumroong <>

License

MIT

Version

0.0.1

Dependencies
  • secure-random (system).
  • ironclad (system).
  • split-sequence (system).
  • trivial-utf-8 (system).
Source

cl-bip39.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-bip39/cl-bip39.asd

Source

cl-bip39.asd.

Parent Component

cl-bip39 (system).

ASDF Systems

cl-bip39.


3.1.2 cl-bip39/package.lisp

Source

cl-bip39.asd.

Parent Component

cl-bip39 (system).

Packages

cl-bip39.


3.1.3 cl-bip39/word-list-english.lisp

Dependency

package.lisp (file).

Source

cl-bip39.asd.

Parent Component

cl-bip39 (system).

Internals

*word-list-english* (special variable).


3.1.4 cl-bip39/cl-bip39.lisp

Dependency

word-list-english.lisp (file).

Source

cl-bip39.asd.

Parent Component

cl-bip39 (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-bip39

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: bip39-mnemonic-p (mnemonic)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: generate-bip39-mnemonic (&key entropy-size)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: generate-bip39-seed (mnemonic &optional passphase)
Package

cl-bip39.

Source

cl-bip39.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *word-list-english*
Package

cl-bip39.

Source

word-list-english.lisp.


5.2.2 Ordinary functions

Function: bit-string-to-int (bit-string)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: bits-to-bytes (bits)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: byte-array-to-int (byte-array)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: checksum-to-bit-string (checksum entropy-size)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: cs-position (ent+cs-bit-string)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: entropy-to-bit-string (entropy entropy-size)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: generate-initial-entropy (entropy-size)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: int-to-byte-array (int)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: mnemonic-word-to-index (mnemonic-word)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: sha256 (byte-sequence)
Package

cl-bip39.

Source

cl-bip39.lisp.

Function: split-mnemonic (mnemonic)
Package

cl-bip39.

Source

cl-bip39.lisp.


5.2.3 Generic functions

Generic Reader: len (condition)
Package

cl-bip39.

Methods
Reader Method: len ((condition invalid-mnemonic-sentence-length))
Source

cl-bip39.lisp.

Target Slot

len.

Generic Reader: size (condition)
Package

cl-bip39.

Methods
Reader Method: size ((condition invalid-entropy-size))
Source

cl-bip39.lisp.

Target Slot

size.

Generic Reader: word (condition)
Package

cl-bip39.

Methods
Reader Method: word ((condition invalid-word))
Source

cl-bip39.lisp.

Target Slot

word.


5.2.4 Conditions

Condition: invalid-entropy-size
Package

cl-bip39.

Source

cl-bip39.lisp.

Direct superclasses

error.

Direct methods

size.

Direct slots
Slot: size
Initargs

:size

Readers

size.

Writers

This slot is read-only.

Condition: invalid-mnemonic-sentence-length
Package

cl-bip39.

Source

cl-bip39.lisp.

Direct superclasses

error.

Direct methods

len.

Direct slots
Slot: len
Initargs

:len

Readers

len.

Writers

This slot is read-only.

Condition: invalid-word
Package

cl-bip39.

Source

cl-bip39.lisp.

Direct superclasses

error.

Direct methods

word.

Direct slots
Slot: word
Initargs

:word

Readers

word.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   B   C   E   F   G   I   L   M   S   W  
Index Entry  Section

B
bip39-mnemonic-p: Public ordinary functions
bit-string-to-int: Private ordinary functions
bits-to-bytes: Private ordinary functions
byte-array-to-int: Private ordinary functions

C
checksum-to-bit-string: Private ordinary functions
cs-position: Private ordinary functions

E
entropy-to-bit-string: Private ordinary functions

F
Function, bip39-mnemonic-p: Public ordinary functions
Function, bit-string-to-int: Private ordinary functions
Function, bits-to-bytes: Private ordinary functions
Function, byte-array-to-int: Private ordinary functions
Function, checksum-to-bit-string: Private ordinary functions
Function, cs-position: Private ordinary functions
Function, entropy-to-bit-string: Private ordinary functions
Function, generate-bip39-mnemonic: Public ordinary functions
Function, generate-bip39-seed: Public ordinary functions
Function, generate-initial-entropy: Private ordinary functions
Function, int-to-byte-array: Private ordinary functions
Function, mnemonic-word-to-index: Private ordinary functions
Function, sha256: Private ordinary functions
Function, split-mnemonic: Private ordinary functions

G
generate-bip39-mnemonic: Public ordinary functions
generate-bip39-seed: Public ordinary functions
generate-initial-entropy: Private ordinary functions
Generic Function, len: Private generic functions
Generic Function, size: Private generic functions
Generic Function, word: Private generic functions

I
int-to-byte-array: Private ordinary functions

L
len: Private generic functions
len: Private generic functions

M
Method, len: Private generic functions
Method, size: Private generic functions
Method, word: Private generic functions
mnemonic-word-to-index: Private ordinary functions

S
sha256: Private ordinary functions
size: Private generic functions
size: Private generic functions
split-mnemonic: Private ordinary functions

W
word: Private generic functions
word: Private generic functions