SdkBuilder

breez_sdk_spark

Struct SdkBuilder

pub struct SdkBuilder { /* private fields */ }

Expand description

Builder for creating BreezSdk instances with customizable components.

Implementations§

impl SdkBuilder

pub fn new(config: Config, seed: Seed) -> Self

Creates a new SdkBuilder with the provided configuration. Arguments:

config: The configuration to be used.
seed: The seed for wallet generation.

pub fn with_default_storage(self, storage_dir: String) -> Self

Sets the root storage directory to initialize the default storage with. This initializes both storage and real-time sync storage with the default implementations. Arguments:

storage_dir: The data directory for storage.

pub fn with_storage(self, storage: Arc<dyn Storage>) -> Self

Sets the storage implementation to be used by the SDK. Arguments:

storage: The storage implementation to be used.

pub fn with_real_time_sync_storage(self, storage: Arc<dyn SyncStorage>) -> Self

Sets the real-time sync storage implementation to be used by the SDK. Arguments:

storage: The sync storage implementation to be used.

pub fn with_key_set( self, key_set_type: KeySetType, use_address_index: bool, account_number: Option<u32>, ) -> Self

Sets the key set type to be used by the SDK. Arguments:

key_set_type: The key set type which determines the derivation path.
use_address_index: Controls the structure of the BIP derivation path.

pub fn with_chain_service( self, chain_service: Arc<dyn BitcoinChainService>, ) -> Self

Sets the chain service to be used by the SDK. Arguments:

chain_service: The chain service to be used.

pub fn with_rest_chain_service( self, url: String, credentials: Option<Credentials>, ) -> Self

Sets the REST chain service to be used by the SDK. Arguments:

url: The base URL of the REST API.
credentials: Optional credentials for basic authentication.

pub fn with_fiat_service(self, fiat_service: Arc<dyn FiatService>) -> Self

Sets the fiat service to be used by the SDK. Arguments:

fiat_service: The fiat service to be used.

pub fn with_lnurl_client(self, lnurl_client: Arc<dyn RestClient>) -> Self

pub fn with_lnurl_server_client( self, lnurl_serverclient: Arc<dyn LnurlServerClient>, ) -> Self

pub fn with_payment_observer( self, payment_observer: Arc<dyn PaymentObserver>, ) -> Self

Sets the payment observer to be used by the SDK. This observer will receive callbacks before outgoing payments for Lightning, Spark and onchain Bitcoin. Arguments:

payment_observer: The payment observer to be used.

pub async fn build(self) -> Result<BreezSdk, SdkError>

Builds the BreezSdk instance with the configured components.

Trait Implementations§

impl Clone for SdkBuilder

fn clone(&self) -> SdkBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

impl Freeze for SdkBuilder

impl !RefUnwindSafe for SdkBuilder

impl Send for SdkBuilder

impl Sync for SdkBuilder

impl Unpin for SdkBuilder

impl !UnwindSafe for SdkBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,