Files
cdk/crates/cdk-mint-rpc
C ade48cd8a9 Introduce a SignatoryManager service. (#509)
* WIP: Introduce a SignatoryManager service.

The SignatoryManager manager provides an API to interact with keysets, private
keys, and all key-related operations, offering segregation between the mint and
the most sensible part of the mind: the private keys.

Although the default signatory runs in memory, it is completely isolated from
the rest of the system and can only be communicated through the interface
offered by the signatory manager. Only messages can be sent from the mintd to
the Signatory trait through the Signatory Manager.

This pull request sets the foundation for eventually being able to run the
Signatory and all the key-related operations in a separate service, possibly in
a foreign service, to offload risks, as described in #476.

The Signatory manager is concurrent and deferred any mechanism needed to handle
concurrency to the Signatory trait.

* Fixed missing default feature for signatory

* Do not read keys from the DB

* Removed KeysDatabase Trait from MintDatabase

All Keys operations should be done through the signatory

* Make sure signatory has all the keys in memory

Drop also foreign constraints on sqlite

* Fix race condition

* Adding debug info to failing test

* Add `sleep` in test

* Fixed issue with active auth keyset

* Fixed dependency

* Move all keys and keysets to an ArcSwap.

Since the keys and keysets exist in RAM, most wrapping functions are infallible
and synchronous, improving performance and adding breaking API changes.

The signatory will provide this information on the boot and update when the
`rotate_keyset` is executed.

Todo: Implement a subscription key to reload the keys when the GRPC server
changes the keys. For the embedded mode, that makes no sense since there is a
single way to rotate keys, and that bit is already covered.

* Implementing https://github.com/cashubtc/nuts/pull/250

* Add CLI for cdk-signatory to spawn an external signatory

Add to the pipeline the external signatory

* Update tests

* Apply suggestions from code review

Co-authored-by: ok300 <106775972+ok300@users.noreply.github.com>
Co-authored-by: thesimplekid <tsk@thesimplekid.com>

* Minor change

* Update proto buf to use the newest format

* Rename binary

* Add instrumentations

* Add more comments

* Use a single database for the signatory

Store all keys, even auth keys, in a single database. Leave the MintAuthDatabse
trait implementation for the CDK but not the signagtory

This commit also moves the cli mod to its own file

* Update dep

* Add `test_mint_keyset_gen` test

---------

Co-authored-by: ok300 <106775972+ok300@users.noreply.github.com>
Co-authored-by: thesimplekid <tsk@thesimplekid.com>
2025-05-28 11:43:30 -04:00
..
2025-03-25 23:27:38 +00:00
2025-04-02 18:29:18 +08:00

Cashu Mint Management RPC

This crate is a gRPC client and server to control and manage a CDK mint. This crate exposes a server component that can be imported as a library component, see its usage in cdk-mintd. The client can be used as a CLI by running cargo r --bin cdk-mint-cli.

The server can be run with or without certificate authentication. For running with authentication, see the Certificate Generation Guide for instructions on creating the necessary certificates using the included generate_certs.sh script.

Overview

The cdk-mint-rpc crate provides:

  1. A gRPC server for managing Cashu mints
  2. A CLI client (cdk-mint-cli) for interacting with the gRPC server

This allows mint operators to manage their Cashu mint instances remotely through a secure gRPC interface.

Features

  • Remote mint management via gRPC
  • Secure authentication
  • Command-line interface for common mint operations
  • Integration with other CDK components

Usage

CLI Client

The cdk-mint-cli provides a command-line interface for interacting with the mint:

# Using cargo to run the CLI with a specific address
cargo r --bin cdk-mint-cli -- --addr https://127.0.0.1:8086 get-info

This crate is part of the Cashu Development Kit (CDK) ecosystem:

  • cdk: Core Cashu protocol implementation
  • cdk-mintd: Cashu Mint Binary

License

MIT License