pub struct Owner {
pub chain: Weak<Chain>,
pub peers: Weak<Peers>,
pub sync_state: Weak<SyncState>,
}
Expand description
Fields§
§chain: Weak<Chain>
§peers: Weak<Peers>
§sync_state: Weak<SyncState>
Implementations§
source§impl Owner
impl Owner
sourcepub fn new(
chain: Weak<Chain>,
peers: Weak<Peers>,
sync_state: Weak<SyncState>
) -> Self
pub fn new( chain: Weak<Chain>, peers: Weak<Peers>, sync_state: Weak<SyncState> ) -> Self
Create a new API instance with the chain, transaction pool, peers and sync_state
. All subsequent
API calls will operate on this instance of node API.
§Arguments
chain
- A non-owning reference of the chain.tx_pool
- A non-owning reference of the transaction pool.peers
- A non-owning reference of the peers.sync_state
- A non-owning reference of thesync_state
.
§Returns
- An instance of the Node holding references to the current chain, transaction pool, peers and sync_state.
sourcepub fn get_status(&self) -> Result<Status, Error>
pub fn get_status(&self) -> Result<Status, Error>
sourcepub fn validate_chain(
&self,
assume_valid_rangeproofs_kernels: bool
) -> Result<(), Error>
pub fn validate_chain( &self, assume_valid_rangeproofs_kernels: bool ) -> Result<(), Error>
Trigger a validation of the chain state.
§Arguments
assume_valid_rangeproofs_kernels
- if false, will validate rangeproofs, kernel signatures and sum of kernel excesses. if true, will only validate the sum of kernel excesses should equal the sum of unspent outputs minus total supply.
§Returns
- Result Containing:
Ok(())
if the validation was done successfully- or
Error
if an error is encountered.
sourcepub fn compact_chain(&self) -> Result<(), Error>
pub fn compact_chain(&self) -> Result<(), Error>
pub fn reset_chain_head(&self, hash: String) -> Result<(), Error>
pub fn invalidate_header(&self, hash: String) -> Result<(), Error>
sourcepub fn get_connected_peers(&self) -> Result<Vec<PeerInfoDisplay>, Error>
pub fn get_connected_peers(&self) -> Result<Vec<PeerInfoDisplay>, Error>
Retrieves a list of all connected peers.
§Returns
- Result Containing:
- A vector of
PeerInfoDisplay
- or
Error
if an error is encountered.
sourcepub fn unban_peer(&self, addr: SocketAddr) -> Result<(), Error>
pub fn unban_peer(&self, addr: SocketAddr) -> Result<(), Error>
Trait Implementations§
source§impl OwnerRpc for Owner
impl OwnerRpc for Owner
source§fn get_status(&self) -> Result<Status, Error>
fn get_status(&self) -> Result<Status, Error>
Networked version of Owner::get_status. Read more
source§fn validate_chain(
&self,
assume_valid_rangeproofs_kernels: bool
) -> Result<(), Error>
fn validate_chain( &self, assume_valid_rangeproofs_kernels: bool ) -> Result<(), Error>
Networked version of Owner::validate_chain. Read more
fn reset_chain_head(&self, hash: String) -> Result<(), Error>
fn invalidate_header(&self, hash: String) -> Result<(), Error>
source§fn compact_chain(&self) -> Result<(), Error>
fn compact_chain(&self) -> Result<(), Error>
Networked version of Owner::compact_chain. Read more
source§fn get_peers(&self, addr: Option<SocketAddr>) -> Result<Vec<PeerData>, Error>
fn get_peers(&self, addr: Option<SocketAddr>) -> Result<Vec<PeerData>, Error>
Networked version of Owner::get_peers. Read more
source§fn get_connected_peers(&self) -> Result<Vec<PeerInfoDisplay>, Error>
fn get_connected_peers(&self) -> Result<Vec<PeerInfoDisplay>, Error>
Networked version of Owner::get_connected_peers. Read more
source§fn ban_peer(&self, addr: SocketAddr) -> Result<(), Error>
fn ban_peer(&self, addr: SocketAddr) -> Result<(), Error>
Networked version of Owner::ban_peer. Read more
source§fn unban_peer(&self, addr: SocketAddr) -> Result<(), Error>
fn unban_peer(&self, addr: SocketAddr) -> Result<(), Error>
Networked version of Owner::unban_peer. Read more
Auto Trait Implementations§
impl Freeze for Owner
impl !RefUnwindSafe for Owner
impl Send for Owner
impl Sync for Owner
impl Unpin for Owner
impl !UnwindSafe for Owner
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
Mutably borrows from an owned value. Read more