Struct Wallet 

pub struct Wallet(/* private fields */);

A wallet backed by a JSON file, holding the client’s chains and which one is the default.

Implementations

impl PersistentWallet

pub fn get(&self, id: ChainId) -> Option<Chain>

Returns the chain with the given ID, if it is in the wallet.

pub fn remove(&self, id: ChainId) -> Result<Option<Chain>, Error>

Removes the chain with the given ID, adjusting the default chain if needed, and saves.

pub fn items(&self) -> Vec<(ChainId, Chain)>

Returns all (chain ID, chain) pairs held by the wallet.

pub fn insert(&self, id: ChainId, chain: &Chain) -> Result<Option<Chain>, Error>

Inserts or replaces a chain, making it the default chain if it has an owner, and saves.

pub fn try_insert( &self, id: ChainId, chain: Chain, ) -> Result<Option<Chain>, Error>

Inserts a chain only if its ID is not already present, making it the default if it is the first chain, and saves.

pub fn create( path: &Path, genesis_config: GenesisConfig, ) -> Result<PersistentWallet, Error>

Creates a new wallet file at path for the given genesis configuration.

pub fn read(path: &Path) -> Result<PersistentWallet, Error>

Reads an existing wallet from the file at path.

pub fn genesis_config(&self) -> &GenesisConfig

Returns the network’s genesis configuration.

pub fn genesis_admin_chain_id(&self) -> ChainId

Returns the admin chain ID from the genesis configuration.

pub fn default_chain(&self) -> Option<ChainId>

Returns the default chain, if one is set.

pub fn set_default_chain(&mut self, id: ChainId) -> Result<(), Error>

Sets the default chain, which must already be in the wallet, and saves.

pub fn mutate<R>( &self, chain_id: ChainId, mutate: impl Fn(&mut Chain) -> R, ) -> Option<Result<R, Error>>

Applies a mutation to the chain with the given ID, saving afterwards. Returns None if the chain is not in the wallet.

pub fn forget_keys( &self, chain_id: ChainId, ) -> Result<Option<AccountOwner>, Error>

Removes and returns the owner of the given chain, if the chain and its owner are present.

pub fn forget_chain(&self, chain_id: ChainId) -> Result<Option<Chain>, Error>

Removes the chain with the given ID, saving if it was present, and returns it.

pub fn save(&self) -> Result<(), Error>

Writes the wallet to its file.

pub fn num_chains(&self) -> usize

Returns the number of chains in the wallet.

pub fn chain_ids(&self) -> Vec<ChainId>

Returns the IDs of all chains in the wallet.

pub fn owned_chain_ids(&self) -> Vec<ChainId>

Returns the list of all chain IDs for which we have a secret key.

Trait Implementations

impl Extend<(ChainId, Chain)> for PersistentWallet

fn extend<It>(&mut self, chains: It)

where It: IntoIterator<Item = (ChainId, Chain)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Wallet for PersistentWallet

type Error = Error

The error type returned by the wallet’s operations.

async fn get( &self, id: ChainId, ) -> Result<Option<Chain>, <PersistentWallet as Wallet>::Error>

Returns the state of the chain with the given ID, if it is tracked.

async fn remove( &self, id: ChainId, ) -> Result<Option<Chain>, <PersistentWallet as Wallet>::Error>

Removes the chain with the given ID, returning its previous state if any.

fn items( &self, ) -> impl Stream<Item = Result<(ChainId, Chain), <PersistentWallet as Wallet>::Error>>

Returns a stream over all tracked chains and their states.

async fn insert( &self, id: ChainId, chain: Chain, ) -> Result<Option<Chain>, <PersistentWallet as Wallet>::Error>

Inserts or replaces the state of the given chain, returning the previous state if any.

async fn try_insert( &self, id: ChainId, chain: Chain, ) -> Result<Option<Chain>, <PersistentWallet as Wallet>::Error>

Inserts the given chain only if it is not already tracked, returning the existing state otherwise.

async fn modify( &self, id: ChainId, f: impl Fn(&mut Chain) + Send, ) -> Result<Option<()>, <PersistentWallet as Wallet>::Error>

Modifies a chain in the wallet. Returns Ok(None) if the chain doesn’t exist.

fn chain_ids(&self) -> impl Stream<Item = Result<ChainId, Self::Error>> + Send

Returns a stream over the IDs of all tracked chains.

fn owned_chain_ids( &self, ) -> impl Stream<Item = Result<ChainId, Self::Error>> + Send

Returns a stream over the IDs of the tracked chains that have an owner.