Struct snarkos_rpc::RpcImpl[−][src]

pub struct RpcImpl<S: Storage + Send + Sync + 'static>(_);

Expand description

Implements JSON-RPC HTTP endpoint functions for a node. The constructor is given Arc::clone() copies of all needed node components.

Implementations

[src]

impl<S: Storage + Send + Sync + 'static> RpcImpl<S>

[src]

pub fn new(
    storage: Arc<MerkleTreeLedger<S>>, 
    credentials: Option<RpcCredentials>, 
    node: Node<S>
) -> Self

Creates a new struct for calling public and private RPC endpoints.

[src]

pub fn sync_handler(&self) -> Result<&Arc<Sync<S>>, RpcError>

[src]

pub fn consensus_parameters(&self) -> Result<&ConsensusParameters, RpcError>

[src]

pub fn dpc_parameters(&self) -> Result<&PublicParameters<Components>, RpcError>

[src]

pub fn memory_pool(&self) -> Result<&MemoryPool<Tx>, RpcError>

[src]

impl<S: Storage + Send + Sync + 'static> RpcImpl<S>

The following *_protected functions wrap an authentication check around sensitive functions before being exposed as an RPC endpoint

[src]

pub fn validate_auth(&self, meta: Meta) -> Result<(), Error>

Validate the authentication header in the request metadata

[src]

pub async fn create_raw_transaction_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around create_raw_transaction

[src]

pub async fn create_transaction_kernel_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around create_transaction_kernel

[src]

pub async fn create_transaction_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around create_transaction

[src]

pub async fn get_record_commitment_count_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around get_record_commitment_count

[src]

pub async fn get_record_commitments_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around get_record_commitments

[src]

pub async fn get_raw_record_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around get_raw_record

[src]

pub async fn decode_record_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around decode_record

[src]

pub async fn decrypt_record_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around decrypt_record

[src]

pub async fn create_account_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Wrap authentication around create_account

[src]

pub async fn disconnect_protected(
    self, 
    params: Params, 
    meta: Meta
) -> Result<Value, Error>

Disconnects from the given address

[src]

pub fn add_protected(&self, io: &mut MetaIoHandler<Meta>)

Expose the protected functions as RPC enpoints

Trait Implementations

[src]

impl<S: Storage + Send + Sync + 'static> Clone for RpcImpl<S>

[src]

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl<S: Storage + Send + Sync + 'static> Deref for RpcImpl<S>

type Target = RpcInner<S>

The resulting type after dereferencing.

[src]

fn deref(&self) -> &Self::Target

Dereferences the value.

[src]

impl<S: Storage + Send + Sync + 'static> ProtectedRpcFunctions for RpcImpl<S>

Functions that are sensitive and need to be protected with authentication. The authentication logic is defined in validate_auth

[src]

fn create_account(&self) -> Result<RpcAccount, RpcError>

Generate a new account private key, account view key, and account address.

[src]

fn create_raw_transaction(
    &self, 
    transaction_input: TransactionInputs
) -> Result<CreateRawTransactionOuput, RpcError>

Create a new transaction, returning the encoded transaction and the new records.

[src]

fn create_transaction_kernel(
    &self, 
    transaction_input: TransactionInputs
) -> Result<String, RpcError>

Generates and returns a new transaction kernel.

[src]

fn create_transaction(
    &self, 
    transaction_kernel: String
) -> Result<CreateRawTransactionOuput, RpcError>

Create a new transaction for a given transaction kernel.

[src]

fn get_record_commitment_count(&self) -> Result<usize, RpcError>

Returns the number of record commitments that are stored on the full node.

[src]

fn get_record_commitments(&self) -> Result<Vec<String>, RpcError>

Returns a list of record commitments that are stored on the full node.

[src]

fn get_raw_record(&self, record_commitment: String) -> Result<String, RpcError>

Returns the hex encoded bytes of a record from its record commitment

[src]

fn decrypt_record(
    &self, 
    decryption_input: DecryptRecordInput
) -> Result<String, RpcError>

Decrypts the record ciphertext and returns the hex encoded bytes of the record.

[src]

fn decode_record(&self, record_bytes: String) -> Result<RecordInfo, RpcError>

Returns information about a record from serialized record bytes.

[src]

fn disconnect(&self, address: SocketAddr)

[src]

impl<S: Storage + Send + Sync + 'static> RpcFunctions for RpcImpl<S>

[src]

fn get_block(&self, block_hash_string: String) -> Result<BlockInfo, RpcError>

Returns information about a block from a block hash.

[src]

fn get_block_count(&self) -> Result<u32, RpcError>

Returns the number of blocks in the canonical chain.

[src]

fn get_best_block_hash(&self) -> Result<String, RpcError>

Returns the block hash of the head of the canonical chain.

[src]

fn get_block_hash(&self, block_height: u32) -> Result<String, RpcError>

Returns the block hash of the index specified if it exists in the canonical chain.

[src]

fn get_raw_transaction(
    &self, 
    transaction_id: String
) -> Result<String, RpcError>

Returns the hex encoded bytes of a transaction from its transaction id.

[src]

fn get_transaction_info(
    &self, 
    transaction_id: String
) -> Result<TransactionInfo, RpcError>

Returns information about a transaction from a transaction id.

[src]

fn decode_raw_transaction(
    &self, 
    transaction_bytes: String
) -> Result<TransactionInfo, RpcError>

Returns information about a transaction from serialized transaction bytes.

[src]

fn send_raw_transaction(
    &self, 
    transaction_bytes: String
) -> Result<String, RpcError>

Send raw transaction bytes to this node to be added into the mempool. If valid, the transaction will be stored and propagated to all peers. Returns the transaction id if valid.

[src]

fn validate_raw_transaction(
    &self, 
    transaction_bytes: String
) -> Result<bool, RpcError>

Validate and return if the transaction is valid.

[src]

fn get_connection_count(&self) -> Result<usize, RpcError>

Fetch the number of connected peers this node has.

[src]

fn get_peer_info(&self) -> Result<PeerInfo, RpcError>

Returns this nodes connected peers.

[src]

fn get_node_info(&self) -> Result<NodeInfo, RpcError>

Returns data about the node.

[src]

fn get_node_stats(&self) -> Result<NodeStats, RpcError>

Returns statistics related to the node.

[src]

fn get_block_template(&self) -> Result<BlockTemplate, RpcError>

Returns the current mempool and sync information known by this node.

[src]

fn to_delegate<M: Metadata>(self) -> IoDelegate<Self, M>

Create an IoDelegate, wiring rpc calls to the trait methods.

Auto Trait Implementations

impl<S> !RefUnwindSafe for RpcImpl<S>

impl<S> Send for RpcImpl<S>

impl<S> Sync for RpcImpl<S>

impl<S> Unpin for RpcImpl<S>

impl<S> !UnwindSafe for RpcImpl<S>

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

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

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

impl<T> FmtForward for T

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

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

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

Causes self to use its Display implementation when Debug-formatted. Read more

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

Causes self to use its LowerExp implementation when Debug-formatted. Read more

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

Causes self to use its LowerHex implementation when Debug-formatted. Read more

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

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

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

Causes self to use its Pointer implementation when Debug-formatted. Read more

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

Causes self to use its UpperExp implementation when Debug-formatted. Read more

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

Causes self to use its UpperHex implementation when Debug-formatted. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Pipe for T where
    T: ?Sized,

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

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

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

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

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

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

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

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

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

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

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

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

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.

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. Read more

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

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

Immutable access to a value. Read more

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

Mutable access to a value. Read more

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

Immutable access to the Borrow of a value. Read more

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

Mutable access to the BorrowMut of a value. Read more

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

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

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

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

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

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

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

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

[src]

impl<T> ToOwned for T where
    T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

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

Attempts to convert self into T using TryInto<T>. Read more

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V