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>
impl<M: Middleware + Clone + 'static> PrivacyClient<M>
pub async fn new( provider: Arc<M>, wallet: LocalWallet, dark_account: DarkAccount, config: PrivacyClientConfig, prover: Arc<dyn IProverService>, ) -> Result<Self, PrivacyClientError>
Sourcepub async fn with_prover(
provider: Arc<M>,
wallet: LocalWallet,
dark_account: DarkAccount,
config: PrivacyClientConfig,
prover: Arc<dyn IProverService>,
) -> Result<Self, PrivacyClientError>
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().
pub fn balance(&self, asset: Address) -> U256
pub fn merkle_root(&self) -> U256
pub fn note_count(&self) -> usize
pub fn receiving_key(&mut self) -> Result<(U256, U256), PrivacyClientError>
pub fn advance_keys(&mut self, count: u64)
Sourcepub fn save_state(&self, path: &Path) -> Result<(), PrivacyClientError>
pub fn save_state(&self, path: &Path) -> Result<(), PrivacyClientError>
Atomic write (temp file + rename). Pending spends are not persisted.
Sourcepub fn load_state(&mut self, path: &Path) -> Result<bool, PrivacyClientError>
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).
Sourcepub async fn deposit(
&mut self,
amount: U256,
asset: Address,
) -> Result<PrivacyTxResult, PrivacyClientError>
pub async fn deposit( &mut self, amount: U256, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>
Requires prior ERC-20 approval for the DarkPool contract.
pub async fn withdraw_with_transport( &mut self, transport: &Transport<'_>, amount: U256, asset: Address, recipient: Address, intent_hash: Option<U256>, ) -> Result<PrivacyTxResult, PrivacyClientError>
pub async fn split_with_transport( &mut self, transport: &Transport<'_>, amount_a: U256, amount_b: U256, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>
pub async fn join_with_transport( &mut self, transport: &Transport<'_>, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>
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>
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>
Sourcepub 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>
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.
pub async fn sync(&mut self) -> Result<ScanResult, PrivacyClientError>
Sourcepub async fn withdraw(
&mut self,
amount: U256,
asset: Address,
recipient: Address,
intent_hash: Option<U256>,
) -> Result<PrivacyTxResult, PrivacyClientError>
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.
Sourcepub async fn split(
&mut self,
amount_a: U256,
amount_b: U256,
asset: Address,
) -> Result<PrivacyTxResult, PrivacyClientError>
pub async fn split( &mut self, amount_a: U256, amount_b: U256, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>
Direct-submission wrapper for split_with_transport.
Sourcepub async fn join(
&mut self,
asset: Address,
) -> Result<PrivacyTxResult, PrivacyClientError>
pub async fn join( &mut self, asset: Address, ) -> Result<PrivacyTxResult, PrivacyClientError>
Direct-submission wrapper for join_with_transport.
Sourcepub async fn transfer(
&mut self,
amount: U256,
asset: Address,
recipient_b: (U256, U256),
recipient_p: (U256, U256),
recipient_proof: DLEQProof,
) -> Result<PrivacyTxResult, PrivacyClientError>
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.
Sourcepub async fn verify_root_matches_chain(&self) -> Result<(), PrivacyClientError>
pub async fn verify_root_matches_chain(&self) -> Result<(), PrivacyClientError>
Post-sync sanity check: compares local root against getCurrentRoot() on-chain.
Sourcepub async fn verify_root_is_known(&self) -> Result<(), PrivacyClientError>
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.
pub fn utxos(&self) -> &UtxoStore
pub fn tree(&self) -> &LocalMerkleTree
pub fn keys(&self) -> &KeyRepository
pub fn darkpool_address(&self) -> Address
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.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
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.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
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.