pomade

KO | EN

gitlite — search

#python #llm #golang #go #android #deep-learning #docker #awesome #cli #kubernetes #awesome-list #pytorch #ios #openai

(★ 12)

Email recovery protocol and implementation for nostr multisig signers.

pomade Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pomade

A recovery protocol and implementation for nostr multisig signers.

For protocol specification and implementation details, see [PROTOCOL.md](PROTOCOL.md)

## Security Warning

**ALPHA SOFTWARE** - This project should be considered ALPHA and not ready for production use.

- Neither the protocol nor the code has been audited
- There could be fatal flaws resulting in key loss, theft, denial of service, or metadata leakage
- Use at your own risk

## Getting Started

### Clients

To add pomade support to your client, simply add it to your project:

```sh
pnpm install @pomade/core
```

Then, follow the guide [here](INTEGRATION.md).

### Signers

Clients need to register at least `threshold` signers for storing user key shares. Client developers are responsible to ensure that:

- Signers are run by multiple independent parties that can be trusted not to collude to steal key material.
- Signers remain responsive; if a signer goes down users should be encouraged to rotate to a new set using the key recovery flow.
- Signer implementations are secure and up to date; multiple implementations are provided which should be mixed to diffuse attack surface area.

Client developers SHOULD run one signer themselves. They MAY also consider deploying an embedded signer to their client application (an in-memory typescript signer implementation is provided in @pomade/core) to hold one user key share. For all third party signers, client developers may either manually select their own trusted parties, or select signers from the list below.

- https://pomade.coracle.social - run by [@hodlbod](https://coracle.social/hodlbod@coracle.social)
- https://pomade.nostrver.se - run by [@sebastix](https://coracle.social/_@sebastix.dev)
- https://pomade.scuttle.works - run by [@mplorentz](https://coracle.social/_@mattlorentz.com)
- https://pomade.fiatjaf.com - run by [@fiatjaf](https://coracle.social/_@fiatjaf.com)

Note that when logging in all signers need to be contacted, which involves some pretty computationally-intensive hashing operations. For that reason, you should avoid adding a large number of signers to your app; 7-10 should be more than enough.

To run your own signer see [DEPLOY.md](DEPLOY.md) for detailed instructions, or visit the README for the package you're planning to run to cut to the chase:

- [pomade-signer-rust](pomade-signer-rust/README.md)
- [pomade-signer-go](pomade-signer-rust/README.md)
- [pomade-signer-ts](packages/signer/README.md)

## Package Details

### @pomade/core

The core library that can be integrated into any project. Provides:

- Protocol type definitions and schemas
- Client API for interacting with signers
- Signer class that can be used for demos or for managing a local shard

See [the readme](packages/core/README.md) for detailed documentation.

### @pomade/templates

A tiny repository for generating HTML email templates using MJML.

### @pomade/tests

Integration tests which run a test suite against different combinations of signer implementations.

### @pomade/signer

Standalone signer service that manages multisig sessions, handles signing requests, and coordinates recovery flows.

See [the readme](packages/signer/README.md) for configuration and deployment.

### frost-taproot-rust

Rust implementation of BIP-340 FROST signatures including trusted key dealer and DKG flows, compatible with the @cmdruid/frost typescript implementation.

See [the readme](frost-taproot-rust/README.md) for configuration and deployment.

### pomade-signer-rust

Rust signer server with sled storage.

See [the readme](pomade-signer-rust/README.md) for configuration and deployment.

### frost-taproot-go

Go implementation of BIP-340 FROST signatures including trusted key dealer and DKG flows, compatible with the @cmdruid/frost typescript implementation.

See [the readme](frost-taproot-go/README.md) for configuration and deployment.

### pomade-signer-go

Go signer server with bbolt storage.

See [the readme](pomade-signer-go/README.md) for configuration and deployment.

## License

MIT

pomade

pomade Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pomade

pomade Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README