Crate kaspa_wrpc_client

Source
Expand description

§wRPC Client for Rusty Kaspa p2p Node

This crate provides a WebSocket RPC client for Rusty Kaspa p2p node. It is based on the wRPC crate that offers WebSocket RPC implementation for Rust based on Borsh and Serde JSON serialization. wRPC is a lightweight RPC framework meant to function as an IPC (Inter-Process Communication) mechanism for Rust applications.

Rust examples on using wRPC client can be found in the examples folder.

WASM bindings for wRPC client can be found in the kaspa-wrpc-wasm crate.

The main struct managing Kaspa RPC client connections is the KaspaRpcClient.

Re-exports§

pub use imports::KaspaRpcClient;
pub use imports::Resolver;

Modules§

client
Kaspa wRPC client implementation.
error
Error variants for the wRPC client library.
node
Node connection endpoint as provided by the Resolver.
parse
wRPC URL parsing and validation utilities.
prelude
Re-exports of the most commonly used types and traits.
resolver
Module implementing Resolver client for obtaining public Kaspa wRPC endpoints.
result
The Result type alias bound to the Error enum used in this crate.

Enums§

WrpcEncoding
wRPC protocol encoding: Borsh or JSON @category Transport