Skip to main content

PrivacyClient

Struct PrivacyClient 

Source
pub struct PrivacyClient<M: Middleware + Clone + 'static> { /* private fields */ }
Expand description

Main entry point for DarkPool operations. Queries can optionally route through the Mixnet.

Implementations§

Source§

impl<M: Middleware + Clone + 'static> PrivacyClient<M>

Source

pub async fn new( provider: Arc<M>, wallet: LocalWallet, dark_account: DarkAccount, config: PrivacyClientConfig, prover: Arc<dyn IProverService>, ) -> Result<Self, PrivacyClientError>

Source

pub async fn with_prover( provider: Arc<M>, wallet: LocalWallet, dark_account: DarkAccount, config: PrivacyClientConfig, prover: Arc<dyn IProverService>, ) -> Result<Self, PrivacyClientError>

Alias for new().

Source

pub fn balance(&self, asset: Address) -> U256

Source

pub fn merkle_root(&self) -> U256

Source

pub fn note_count(&self) -> usize

Source

pub fn receiving_key(&mut self) -> Result<(U256, U256), PrivacyClientError>

Source

pub fn advance_keys(&mut self, count: u64)

Source

pub fn save_state(&self, path: &Path) -> Result<(), PrivacyClientError>

Atomic write (temp file + rename). Pending spends are not persisted.

Source

pub fn load_state(&mut self, path: &Path) -> Result<bool, PrivacyClientError>

Returns Ok(true) if loaded, Ok(false) if file doesn’t exist (fresh wallet).

Source

pub async fn deposit( &mut self, amount: U256, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>

Requires prior ERC-20 approval for the DarkPool contract.

Source

pub async fn withdraw_with_transport( &mut self, transport: &Transport<'_>, amount: U256, asset: Address, recipient: Address, intent_hash: Option<U256>, ) -> Result<PrivacyTxResult, PrivacyClientError>

Source

pub async fn split_with_transport( &mut self, transport: &Transport<'_>, amount_a: U256, amount_b: U256, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>

Source

pub async fn join_with_transport( &mut self, transport: &Transport<'_>, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>

Source

pub async fn transfer_with_transport( &mut self, transport: &Transport<'_>, amount: U256, asset: Address, recipient_b: (U256, U256), recipient_p: (U256, U256), recipient_proof: DLEQProof, ) -> Result<PrivacyTxResult, PrivacyClientError>

Source

pub async fn public_claim( &mut self, memo_id: U256, value: U256, asset: Address, timelock: U256, owner_pk: (U256, U256), salt: U256, recipient_sk: U256, ) -> Result<PrivacyTxResult, PrivacyClientError>

Source

pub async fn public_claim_with_transport( &mut self, transport: &Transport<'_>, memo_id: U256, value: U256, asset: Address, timelock: U256, owner_pk: (U256, U256), salt: U256, recipient_sk: U256, ) -> Result<PrivacyTxResult, PrivacyClientError>

DarkPool.publicClaim() verifies proof only (no msg.sender check), so it can be relayed.

Source

pub async fn sync(&mut self) -> Result<ScanResult, PrivacyClientError>

Source

pub async fn withdraw( &mut self, amount: U256, asset: Address, recipient: Address, intent_hash: Option<U256>, ) -> Result<PrivacyTxResult, PrivacyClientError>

Direct-submission wrapper for withdraw_with_transport.

Source

pub async fn split( &mut self, amount_a: U256, amount_b: U256, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>

Direct-submission wrapper for split_with_transport.

Source

pub async fn join( &mut self, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>

Direct-submission wrapper for join_with_transport.

Source

pub async fn transfer( &mut self, amount: U256, asset: Address, recipient_b: (U256, U256), recipient_p: (U256, U256), recipient_proof: DLEQProof, ) -> Result<PrivacyTxResult, PrivacyClientError>

Direct-submission wrapper for transfer_with_transport.

Source

pub async fn verify_root_matches_chain(&self) -> Result<(), PrivacyClientError>

Post-sync sanity check: compares local root against getCurrentRoot() on-chain.

Source

pub async fn verify_root_is_known(&self) -> Result<(), PrivacyClientError>

Pre-proof check: verifies local root is in the contract’s root history ring buffer.

Source

pub fn utxos(&self) -> &UtxoStore

Source

pub fn tree(&self) -> &LocalMerkleTree

Source

pub fn keys(&self) -> &KeyRepository

Source

pub fn darkpool_address(&self) -> Address

Source

pub fn builder(&self) -> &TransactionBuilder

Auto Trait Implementations§

§

impl<M> Freeze for PrivacyClient<M>

§

impl<M> !RefUnwindSafe for PrivacyClient<M>

§

impl<M> Send for PrivacyClient<M>

§

impl<M> Sync for PrivacyClient<M>

§

impl<M> Unpin for PrivacyClient<M>

§

impl<M> UnsafeUnpin for PrivacyClient<M>

§

impl<M> !UnwindSafe for PrivacyClient<M>

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<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
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
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
Source§

impl<T> JsonSchemaMaybe for T