Struct ConfigurableClientHost 

pub struct ConfigurableClientHost<S: ClientStorage> { /* private fields */ }

A configurable client host that holds raw secret keys and uses pluggable storage.

This provides a batteries-included implementation of SpilmanClientHost for applications that want to manage keys directly. For hardware wallet integration or external signers, implement SpilmanClientHost directly instead.

Key Management

Keys are stored in a HashMap indexed by their public key (hex-encoded). When signing operations are requested, the host looks up the corresponding secret key by the provided public key.

Storage

Channel data is stored via a ClientStorage implementation. The default MemoryClientStorage keeps everything in memory. For persistence, implement ClientStorage for your preferred backend.

Thread Safety

The storage is wrapped in RefCell for interior mutability, allowing the trait methods (which take &self) to modify storage. This means ConfigurableClientHost is not Sync and cannot be shared across threads. For multi-threaded use, wrap in Mutex or use a thread-safe storage backend.

Implementations

impl<S: ClientStorage> ConfigurableClientHost<S>

pub fn new(storage: S) -> Self

Create a new configurable client host with the given storage.

pub fn add_key(&mut self, secret: SecretKey)

Add a keypair to the host.

The key is indexed by its public key (hex-encoded). If a key with the same public key already exists, it is replaced.

pub fn add_key_from_hex(&mut self, secret_hex: &str) -> Result<String, String>

Add a keypair from hex-encoded secret key.

Returns an error if the hex string is invalid.

pub fn get_pubkeys(&self) -> Vec<String>

Get the public keys of all stored keys.

pub fn has_key(&self, pubkey_hex: &str) -> bool

Check if a key exists for the given public key.

pub fn remove_key(&mut self, pubkey_hex: &str) -> bool

Remove a key by public key.

Returns true if a key was removed, false if no key existed.

pub fn storage_mut(&mut self) -> &mut S

Get mutable access to the underlying storage.

Use with caution - this bypasses the normal host interface.

pub fn channel_count(&self) -> usize

Get the number of stored channels.

impl ConfigurableClientHost<MemoryClientStorage>

pub fn new_in_memory() -> Self

Create a new configurable client host with in-memory storage.

This is a convenience constructor for the common case of using MemoryClientStorage.

Trait Implementations

impl<S: Debug + ClientStorage> Debug for ConfigurableClientHost<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: ClientStorage> SpilmanClientHost for ConfigurableClientHost<S>

fn save_channel_funding(&self, channel_id: &str, funding: ClientChannelFunding)

Save funding data for a newly created channel.

fn get_channel_funding(&self, channel_id: &str) -> Option<ClientChannelFunding>

Get funding data for a channel.

fn get_payment_state(&self, channel_id: &str) -> Option<ClientPaymentState>

Get the current payment state for a channel.

fn record_payment(&self, channel_id: &str, state: ClientPaymentState)

Record a new payment state.

fn get_channel_state(&self, channel_id: &str) -> ClientChannelState

Get the lifecycle state of a channel.

fn mark_channel_closed(&self, channel_id: &str)

Mark a channel as closed.

fn list_channel_ids(&self) -> Vec<String>

List all stored channel IDs.

fn delete_channel(&self, channel_id: &str)

Delete a channel and all its data.

fn now_seconds(&self) -> u64

Get the current time in seconds since Unix epoch.

fn compute_channel_secret( &self, sender_pubkey_hex: &str, receiver_pubkey_hex: &str, ) -> Result<String, String>

Compute the hashed ECDH channel secret for a channel.

fn sign_with_tweaked_key( &self, signer_pubkey_hex: &str, message_hex: &str, tweak_scalar_hex: &str, ) -> Result<String, String>

Sign a message with a tweaked key (BIP-340 Schnorr).