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

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 Mon Feb 26 14:59:45 2024 GMT+0.

Next: Systems, Previous: The cl-bip39 Reference Manual, Up: The cl-bip39 Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-bip39 Reference Manual [Contents][Index]

2 Systems

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

cl-bip39

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

2.1 `cl-bip39`

A Common Lisp implementation of BIP-0039

Author

Smith Dhumbumroong <zodmaner@gmail.com>

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

package.lisp (file).
word-list-english.lisp (file).
cl-bip39.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-bip39 Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-bip39/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-bip39/cl-bip39.asd`

Source: cl-bip39.asd.
Parent Component: cl-bip39 (system).
ASDF Systems: cl-bip39.

Next: cl-bip39/word-list-english.lisp, Previous: cl-bip39/cl-bip39.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-bip39/package.lisp`

Source: cl-bip39.asd.
Parent Component: cl-bip39 (system).
Packages: cl-bip39.

Next: cl-bip39/cl-bip39.lisp, Previous: cl-bip39/package.lisp, Up: Lisp [Contents][Index]

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).

Previous: cl-bip39/word-list-english.lisp, Up: Lisp [Contents][Index]

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

bip39-mnemonic-p (function).
generate-bip39-mnemonic (function).
generate-bip39-seed (function).

Internals

bit-string-to-int (function).
bits-to-bytes (function).
byte-array-to-int (function).
checksum-to-bit-string (function).
cs-position (function).
entropy-to-bit-string (function).
generate-initial-entropy (function).
int-to-byte-array (function).
invalid-entropy-size (condition).
invalid-mnemonic-sentence-length (condition).
invalid-word (condition).
len (reader method).
mnemonic-word-to-index (function).
sha256 (function).
size (reader method).
split-mnemonic (function).
word (reader method).

Next: Definitions, Previous: Files, Up: The cl-bip39 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-bip39

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

4.1 `cl-bip39`

Source

package.lisp.

Use List

common-lisp.

Public Interface

bip39-mnemonic-p (function).
generate-bip39-mnemonic (function).
generate-bip39-seed (function).

Internals

*word-list-english* (special variable).
bit-string-to-int (function).
bits-to-bytes (function).
byte-array-to-int (function).
checksum-to-bit-string (function).
cs-position (function).
entropy-to-bit-string (function).
generate-initial-entropy (function).
int-to-byte-array (function).
invalid-entropy-size (condition).
invalid-mnemonic-sentence-length (condition).
invalid-word (condition).
len (generic reader).
mnemonic-word-to-index (function).
sha256 (function).
size (generic reader).
split-mnemonic (function).
word (generic reader).

Next: Indexes, Previous: Packages, Up: The cl-bip39 Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

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

5.2 Internals

Special variables
Ordinary functions
Generic functions
Conditions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *word-list-english* ¶

Package: cl-bip39.
Source: word-list-english.lisp.

Next: Generic functions, Previous: Special variables, Up: Internals [Contents][Index]

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.

Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]

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.

Previous: Generic functions, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The cl-bip39 Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* L S W

	Index Entry	Section

*
	`word-list-english`:	Private special variables

L
	`len`:	Private conditions

S
	`size`:	Private conditions
	`Slot, len`:	Private conditions
	`Slot, size`:	Private conditions
	`Slot, word`:	Private conditions
	`Special Variable, word-list-english`:	Private special variables

W
	`word`:	Private conditions

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

A.4 Data types

Jump to:	C F I P S W

	Index Entry	Section

C
	`cl-bip39`:	The cl-bip39 system
	`cl-bip39`:	The cl-bip39 package
	`cl-bip39.asd`:	The cl-bip39/cl-bip39․asd file
	`cl-bip39.lisp`:	The cl-bip39/cl-bip39․lisp file
	`Condition, invalid-entropy-size`:	Private conditions
	`Condition, invalid-mnemonic-sentence-length`:	Private conditions
	`Condition, invalid-word`:	Private conditions

F
	`File, cl-bip39.asd`:	The cl-bip39/cl-bip39․asd file
	`File, cl-bip39.lisp`:	The cl-bip39/cl-bip39․lisp file
	`File, package.lisp`:	The cl-bip39/package․lisp file
	`File, word-list-english.lisp`:	The cl-bip39/word-list-english․lisp file

I
	`invalid-entropy-size`:	Private conditions
	`invalid-mnemonic-sentence-length`:	Private conditions
	`invalid-word`:	Private conditions

P
	`Package, cl-bip39`:	The cl-bip39 package
	`package.lisp`:	The cl-bip39/package․lisp file

S
	`System, cl-bip39`:	The cl-bip39 system

W
	`word-list-english.lisp`:	The cl-bip39/word-list-english․lisp file

The cl-bip39 Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-bip39

3 Files

3.1 Lisp

3.1.1 cl-bip39/cl-bip39.asd

3.1.2 cl-bip39/package.lisp

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

3.1.4 cl-bip39/cl-bip39.lisp

4 Packages

4.1 cl-bip39

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-bip39`

3.1.1 `cl-bip39/cl-bip39.asd`

3.1.2 `cl-bip39/package.lisp`

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

3.1.4 `cl-bip39/cl-bip39.lisp`

4.1 `cl-bip39`