Struct NodeBuilder 

pub struct NodeBuilder { /* private fields */ }

Configurable Node construction. See module docs.

All fields are immutable after construction. Each with_* setter returns a fresh Arc<NodeBuilder> that shares ownership of any previously-installed modifiers via Arc<dyn …>. No interior mutability, no locks — the builder is a value, not a state machine.

Implementations

impl NodeBuilder

pub fn new(config: &Config) -> Arc<Self>

Create a builder for a Node with config. No I/O happens until you call connect / register / recover / register_or_recover.

pub fn with_event_listener( self: Arc<Self>, listener: Box<dyn NodeEventListener>, ) -> Arc<Self>

Install a node event listener. Events fire from the moment the gRPC stream is established by the build call (register / recover / connect / …), so attach the listener via the builder rather than after the fact to capture events from the very first moment.

Returns a new builder that shares the rest of the configuration. Build calls on the returned builder will install the listener; the original builder is unchanged.

pub fn register( &self, mnemonic: String, invite_code: Option<String>, ) -> Result<Arc<Node>, Error>

Register a new Greenlight node and return a connected Node with the SDK signer running and any configured modifiers applied.

mnemonic is required — registration drives the signer to sign the registration challenge, so the SDK must hold the seed for this call.

pub fn recover(&self, mnemonic: String) -> Result<Arc<Node>, Error>

Recover credentials for an existing node and return a connected Node with any configured modifiers applied.

mnemonic is required — recovery drives the signer to authenticate.

pub fn connect( &self, credentials: Vec<u8>, mnemonic: Option<String>, ) -> Result<Arc<Node>, Error>

Connect to an existing node using saved credentials and return a connected Node with any configured modifiers applied.

If mnemonic is Some(...), the SDK spawns a signer for the connected Node. If None, the Node is signerless and signing happens elsewhere (paired device, CLN node’s local signer, hardware signer).

pub fn register_or_recover( &self, mnemonic: String, invite_code: Option<String>, ) -> Result<Arc<Node>, Error>

Try to recover; if the node doesn’t exist, register a new one.

mnemonic is required — both recover and register drive the signer.

Trait Implementations

impl<UT> LiftRef<UT> for NodeBuilder

type LiftType = Arc<NodeBuilder>

impl<UT> LowerError<UT> for NodeBuilder

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for NodeBuilder

type ReturnType = <Arc<NodeBuilder> 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 NodeBuilder

const TYPE_ID_META: MetadataBuffer