Skip to main content

WalletRepository

Struct WalletRepository 

Source
pub struct WalletRepository { /* private fields */ }
Expand description

FFI-compatible WalletRepository

Implementations§

Source§

impl WalletRepository

Source

pub fn new(mnemonic: String, store: WalletStore) -> Result<Self, FfiError>

Create a new WalletRepository from locally persisted wallet state.

Construction does not make network requests to configured mints.

Accepts a WalletStore which can be:

  • Sqlite { path } — built-in Rust SQLite backend
  • Postgres { url } — built-in Rust Postgres backend
  • Custom { db } — foreign-language implementation of WalletDatabase
Source

pub fn new_with_proxy( mnemonic: String, store: WalletStore, proxy_url: String, ) -> Result<Self, FfiError>

Create a new WalletRepository with proxy configuration.

Construction restores locally persisted wallet state without making network requests to configured mints. The proxy is used by subsequent mint operations.

Source

pub async fn set_metadata_cache_ttl_for_mint( &self, mint_url: MintUrl, ttl_secs: Option<u64>, ) -> Result<(), FfiError>

Set metadata cache TTL (time-to-live) in seconds for a specific mint

Controls how long cached mint metadata (keysets, keys, mint info) is considered fresh before requiring a refresh from the mint server for a specific mint.

§Arguments
  • mint_url - The mint URL to set the TTL for
  • ttl_secs - Optional TTL in seconds. If None, cache never expires.
Source

pub async fn set_metadata_cache_ttl_for_all_mints(&self, ttl_secs: Option<u64>)

Set metadata cache TTL (time-to-live) in seconds for all mints

Controls how long cached mint metadata is considered fresh for all mints in this WalletRepository.

§Arguments
  • ttl_secs - Optional TTL in seconds. If None, cache never expires for any mint.
Source

pub async fn create_wallet( &self, mint_url: MintUrl, unit: Option<CurrencyUnit>, target_proof_count: Option<u32>, ) -> Result<(), FfiError>

Add a mint to this WalletRepository

Source

pub async fn remove_wallet( &self, mint_url: MintUrl, currency_unit: CurrencyUnit, ) -> Result<(), FfiError>

Remove mint from WalletRepository

Source

pub async fn has_mint(&self, mint_url: MintUrl) -> bool

Check if mint is in wallet

Source

pub fn mint_backup_public_key(&self) -> Result<String, FfiError>

Get the NUT-27 mint backup public key as hex.

Source

pub async fn backup_mints( &self, relays: Vec<String>, options: BackupOptions, ) -> Result<BackupResult, FfiError>

Backup the current mint list to Nostr relays using NUT-27.

Source

pub async fn restore_mints( &self, relays: Vec<String>, add_mints: bool, options: RestoreOptions, ) -> Result<RestoreResult, FfiError>

Restore the mint list from Nostr relays using NUT-27.

Source

pub async fn fetch_mint_backup( &self, relays: Vec<String>, options: RestoreOptions, ) -> Result<MintBackup, FfiError>

Fetch the NUT-27 mint backup without adding mints to the repository.

Source

pub async fn get_balances(&self) -> Result<HashMap<WalletKey, Amount>, FfiError>

Get wallet balances for all mints

Source

pub async fn get_wallets(&self) -> Vec<Arc<Wallet>>

Get all wallets from WalletRepository

Source

pub async fn get_wallet( &self, mint_url: MintUrl, unit: CurrencyUnit, ) -> Result<Arc<Wallet>, FfiError>

Get a specific wallet from WalletRepository by mint URL

Returns an error if no wallet exists for the given mint URL.

Source

pub async fn get_token_data( &self, token: Arc<Token>, ) -> Result<TokenData, FfiError>

Get token data, including the expected redemption fee, without redeeming it.

Trait Implementations§

Source§

impl<UT> LiftRef<UT> for WalletRepository

Source§

impl<UT> LowerError<UT> for WalletRepository

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for WalletRepository

Source§

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

The type that should be returned by scaffolding functions for this type. Read more
Source§

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

Lower the return value from an scaffolding call Read more
Source§

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

Lower the return value for failed argument lifts Read more
Source§

impl<UT> TypeId<UT> for WalletRepository

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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