Struct NwcService 

pub struct NwcService { /* private fields */ }

A NIP-47 Nostr Wallet Connect wallet service bound to a CDK wallet.

Create one with NwcService::create (new connection) or NwcService::restore (existing connection from a persisted client secret), call NwcService::connection_uri to obtain the URI for the Nostr app, then NwcService::start to begin servicing requests.

Implementations

impl NwcService

pub fn create( wallet: Arc<Wallet>, relays: Vec<String>, service_secret_key: String, max_payment_msat: Option<u64>, ) -> Result<Self, FfiError>

Create a new wallet service with a freshly generated client connection.

Arguments

• wallet - The CDK wallet that backs the service.
• relays - Relay URLs the service connects to and listens on.
• service_secret_key - Secret key of the wallet service (the signer). Accepts hex or bech32 nsec. Derive a stable one from the wallet seed with nwc_derive_service_secret_key_from_seed.
• max_payment_msat - Optional cap (in millisatoshis) on any single pay_invoice request.

Errors

Returns an error if a key or relay URL is invalid, or no relays are given.

pub fn restore( wallet: Arc<Wallet>, relays: Vec<String>, service_secret_key: String, client_secret_key: String, max_payment_msat: Option<u64>, ) -> Result<Self, FfiError>

Restore a wallet service for an existing connection.

Use this to rebuild a service after a restart from a persisted client secret, so the previously issued connection URI keeps working.

Arguments

• client_secret_key - The client secret from the original connection URI (hex or nsec).

See Self::create for the other arguments.

Errors

Returns an error if a key or relay URL is invalid, or no relays are given.

pub fn connection_uri(&self) -> String

The nostr+walletconnect:// connection URI to hand to the Nostr app.

pub fn service_pubkey(&self) -> String

Hex-encoded public key of the wallet service (advertised in the URI).

pub fn client_pubkey(&self) -> String

Hex-encoded public key of the authorized client.

pub async fn start(&self) -> Result<(), FfiError>

Start servicing requests in the background.

Connects to the relays, publishes the info event, and begins answering commands. Returns immediately; the service runs until Self::stop is called. Per-request failures are answered with NIP-47 error responses and logged rather than surfaced here.

Errors

Returns an error if the service is already running.

pub async fn stop(&self) -> Result<(), FfiError>

Stop the background service if it is running.

pub fn is_running(&self) -> bool

Whether the background service is currently running.

Trait Implementations

impl Drop for NwcService

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<UT> LiftRef<UT> for NwcService

type LiftType = Arc<NwcService>

impl<UT> LowerError<UT> for NwcService

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for NwcService

type ReturnType = <Arc<NwcService> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for NwcService

const TYPE_ID_META: MetadataBuffer