README.md

Seed Keeper Workspace

Image of Architecture:

• seed-keeper-core: Core functionality for Seed generation & encryption.
• seed-keeper-wallet: Wasm Interface Type (WIT) Component for using Seed-Keeper-Core in Apps.
• seed-keeper-wit-ui: A User Interface built on top of Wasm Component Model for the Seed Keeper.

Example usage:

To make use of the seed keeper, we need a user that uses the key for something useful, like signing a message. We can compose the seed keeper with a WIT component that can sign messages, and a WIT component that can display the signature.

• examples/crates/edwards-wit: A simple WIT component for signing messages using Edwards25519.
• examples/crates/edwards-ui: A simple User Interface for the Edwards WIT component.
• examples/aggregate-wit-ui: An example of how to compose multiple WIT components into a single WIT component.
• examples/sveltekit: An example of how to use the built Seed Keeper Wasm binary in a SvelteKit app. Any front end can use Wasm, I just really like Svelte and Vite. React would work similarly.

Seed Keeper

The Seed Keeper is a tool for generating, encrypting and managing Seeds. It is used to generate, encrypt, decrypt, and view Seeds.

Build

A Justfile contains all the build scripts, just run it:

just build

Or build using cargo-component directly:

cargo component build

Compose

Compose the seed-keeper-wallet, seed-keeper-wit-ui, and the seed consumers of your choice into a single Wasm component for use in an App using wasm-tools compose:

wasm-tools compose ./target/wasm32-wasi/release/seed_keeper_wit_ui.wasm -d ./target/wasm32-wasi/release/seed_keeper_wit.wasm -o examples/composed-wallet.wasm

Examples

We can compose together an Edwards25519 Signer and an Edwards25519 User Interface (UI) to create a mini wallet that can sign messages. If we start without the seed-keeper we would need to provide the import to get the seed each time (which we can do with JavaScript).

First we need to composed the Edwards Signer backend with the Edwards "input message & display signature" UI:

cargo component build --workspace --release
wasm-tools compose ./target/wasm32-wasi/release/edwards_ui.wasm -d ./target/wasm32-wasi/release/edwards_wit.wasm -o examples/edwards-only.wasm

Then we can load this edwards only composed component into our Svelte app, using a simple seed provider import.

We can see the interface for our new composed component by running:

wasm-tools component wit examples/edwards-only.wasm

Which shows our interfaces:

package root:component;

world root {
  import component:wurbo/wurbo-types;
  import component:wurbo/wurbo-in;  
  import component:wallet/config@0.1.0;

  export example:edwards-ui/wurbo-out;
}

Tests

Run all tests:

cargo test --workspace --all-targets

Extensibility: Buidl your own wallet

Plugins

A seed is not much good without functions that use the seed in a cryptographic fashion. The Seed Keeper is designed to be extensible, and plugins can be added to the Seed Keeper to provide additional functionality.

These plugins could be of Wasm Interface Types (WIT) components that are loaded into the App using the Seed Keeper. The Seed Keeper provides a way to load and unload plugins, and to call functions on the plugins.

Build Your Own Wallet

If you have more than one app which uses a seed, you can compose these WIT components together with the Seed Keeper to create a wallet that can be used to manage multiple apps from the same wallet.

Each App should bring it's own User Interface, otherwise the Seed Keeper would have to build each conceivable UI for each app. The Seed Keeper provides the functionality, and the App provides the UI and usage implementation.

Another benefit is that the Seed Keeper staying lightwieght and loads quickly, and each app component is loaded asynchronusly as needed.