Struct lightning_block_sync::rest::RestClient

pub struct RestClient { /* private fields */ }

Available on crate feature rest-client only.

A simple REST client for requesting resources using HTTP GET.

Implementations

impl RestClient

pub fn new(endpoint: HttpEndpoint) -> Result<Self>

Creates a new REST client connected to the given endpoint.

The endpoint should contain the REST path component (e.g., http://127.0.0.1:8332/rest).

pub async fn request_resource<F, T>(&self, resource_path: &str) -> Result<T>where
    F: TryFrom<Vec<u8>, Error = Error> + TryInto<T, Error = Error>,

Requests a resource encoded in F format and interpreted as type T.

Trait Implementations

impl BlockSource for RestClient

fn get_header<'a>(
    &'a self,
    header_hash: &'a BlockHash,
    _height: Option<u32>
) -> AsyncBlockSourceResult<'a, BlockHeaderData>

Returns the header for a given hash. A height hint may be provided in case a block source cannot easily find headers based on a hash. This is merely a hint and thus the returned header must have the same hash as was requested. Otherwise, an error must be returned.

fn get_block<'a>(
    &'a self,
    header_hash: &'a BlockHash
) -> AsyncBlockSourceResult<'a, BlockData>

Returns the block for a given hash. A headers-only block source should return a Transient error.

fn get_best_block<'a>(
    &'a self
) -> AsyncBlockSourceResult<'a, (BlockHash, Option<u32>)>

Returns the hash of the best block and, optionally, its height.