Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

The crates

CrateStatusWhat it does
libkeriworkingCore: CESR primitives, key events and key state, escrows, the stream parser, exn construction, and Habery/Hab for managing local identifiers
libkeri-httpworkingCESR-over-HTTP codec and an async client for witnesses and OOBIs, shared by the witness and the CLI
libkeri-witnessworkingA KERI witness. keripy can’t tell it apart from its own demo witnesses. No query or mailbox support yet
libkeri-cliworkingA kli-style command line, binary krust: init, incept, rotate, interact, multisig, delegation
libkeri-watcherworkingFollows another identifier’s KEL through its witnesses; the delegate uses it to wait for its delegator’s approval
libkeri-interopworkingScenarios against keripy 1.1, 1.2 and main, and the generator for the golden vectors
libkeri-mailboxplaceholderStore-and-forward mailbox, kept apart from the witness
libkeri-telplaceholderTransaction event logs: credential registries and status
libkeri-acdcplaceholderACDC credentials: building, schema validation, verification
libkeri-ipexplaceholderIPEX: exchanging credentials over exn
libkeri-suiteworkingThis site and the bootstrap script

How they depend on each other

libkeri                      core; depends on no other libkeri crate
├── libkeri-http             transport
├── libkeri-watcher          (libkeri-http only for its optional driver)
├── libkeri-mailbox
├── libkeri-tel
│   └── libkeri-acdc
│       └── libkeri-ipex
├── libkeri-witness          uses libkeri-http
└── libkeri-cli              uses libkeri-http, libkeri-watcher

Each crate depends on the others through git dependencies on GitLab main, so any one repo builds from a fresh clone. For working across several at once, see Getting started.

Why separate crates

keripy is one package that also runs its own event loop. Here each role is its own crate, so a consumer takes only what it needs and none of them forces a runtime on it. A few examples:

  • keripy’s witness also runs a mailbox; here those are libkeri-witness and libkeri-mailbox.
  • keripy bundles HTTP into its apps; here it is libkeri-http, and the core does no I/O at all.
  • keripy’s vdr and vc packages become libkeri-tel, libkeri-acdc and libkeri-ipex.