Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Latest commit

 

History

History
27 lines (20 loc) · 1.18 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.18 KB
Raw

Seahorse

A ledger-agnostic keystore toolkit for the CAP protocol.

Check the code documentation.

Usage

First, make sure you are implementing a decentralized ledger that follows the CAP protocol (possibly with some extra features). If not, this is not the keystore you're looking for.

Next, add to your Cargo.toml:

reef = { git = "https://github.com/EspressoSystems/reef.git" }
seahorse = { git = "https://github.com/EspressoSystems/seahorse.git" }

Implement the reef traits for your ledger (see reef::cap for an example of implementing the traits, using the basic cap types). Implement the KeystoreBackend trait from this crate. This trait allows the generic keystore functionality to talk to your specific network.

You can now instantiate Keystore using your implementation of KeystoreBackend. A generic cryptocurrency keystore interface is available to you for building Rust applications. You can also use the built-in CLI application (cli::cli_main) to interact with your keystore using a command line REPL.