Struct sn_client::Client

pub struct Client { /* private fields */ }

Client API implementation to store and get data.

Implementations

impl Client

pub async fn new( signer: SecretKey, peers: Option<Vec<Multiaddr>>, req_response_timeout: Option<Duration> ) -> Result<Self, Error>

Instantiate a new client.

pub fn events_channel(&self) -> ClientEventsReceiver

Get the client events channel.

pub fn sign<T: AsRef<[u8]>>(&self, data: T) -> Signature

Sign the given data

pub fn signer(&self) -> &SecretKey

Return a reference to the signer secret key

pub fn signer_pk(&self) -> PublicKey

Return the public key of the data signing key

pub async fn get_signed_register_from_network( &self, address: RegisterAddress ) -> Result<SignedRegister, Error>

Get a register from network

pub async fn get_register( &self, address: RegisterAddress ) -> Result<ClientRegister, Error>

Retrieve a Register from the network.

pub async fn create_register( &self, meta: XorName, wallet_client: &mut WalletClient, verify_store: bool ) -> Result<ClientRegister, Error>

Create a new Register on the Network.

pub async fn get_chunk(&self, address: ChunkAddress) -> Result<Chunk, Error>

Retrieve a Chunk from the kad network.

pub async fn verify_chunk_stored( &self, address: ChunkAddress ) -> Result<Chunk, Error>

Verify if a Chunk is stored by expected nodes on the network.

pub async fn get_spend_from_network( &self, unique_pubkey: &UniquePubkey ) -> Result<SignedSpend, Error>

Get a cash_note spend from network

pub async fn get_store_costs_at_address( &self, address: &NetworkAddress ) -> Result<Vec<(MainPubkey, NanoTokens)>, Error>

Get the store cost at a given address

pub fn subscribe_to_topic(&self, topic_id: String) -> Result<(), Error>

Subscribe to given gossipsub topic

pub fn unsubscribe_from_topic(&self, topic_id: String) -> Result<(), Error>

Unsubscribe from given gossipsub topic

pub fn publish_on_topic( &self, topic_id: String, msg: Vec<u8> ) -> Result<(), Error>

Publish message on given topic

impl Client

pub async fn send( &self, spend_requests: impl Iterator<Item = &SignedSpend>, verify_store: bool ) -> WalletResult<()>

Send a spend request to the network. This can optionally verify the spend has been correctly stored before returning

pub async fn receive( &self, transfer: Transfer, wallet: &LocalWallet ) -> WalletResult<Vec<CashNote>>

Receive a Transfer, verify and redeem CashNotes from the Network.

pub async fn verify(&self, cash_note: &CashNote) -> WalletResult<()>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.