Struct NymNodeApiClientRetriever 

pub struct NymNodeApiClientRetriever { /* private fields */ }

Builder-style helper for obtaining a validated crate::api::Client for a nym-node.

On top of the basic port-probing performed by try_get_valid_nym_node_api_client, this struct optionally:

• verifies that the node’s self-reported ed25519 identity matches an expected value (e.g. the identity committed on-chain during bonding), and
• checks the cryptographic signature on the node’s host information.

Both checks require an extra HTTP round-trip to the node’s /host-information endpoint and are skipped when neither option is enabled.

Implementations

impl NymNodeApiClientRetriever

pub fn new(user_agent: impl Into<UserAgent>) -> Self

Creates a new retriever with the given user agent. All optional checks (identity verification, host information signature) are disabled by default — use the builder methods to enable them.

pub fn with_expected_identity(self, expected_identity: Option<String>) -> Self

If set, the node’s self-reported ed25519 identity (from its /host-information endpoint) will be compared against this value. A mismatch produces crate::error::Error::MismatchedIdentity.

pub fn with_custom_port(self, port: Option<u16>) -> Self

Prepend http://<host>:<port> to the list of addresses probed during get_client, so it is tried before the standard ports.

pub fn with_verify_host_information(self) -> Self

Enable cryptographic verification of the node’s host information signature. When enabled, get_client will return crate::error::Error::MissignedHostInformation if the signature is invalid.

pub async fn get_client( self, base_host: &str, node_id: u32, ) -> Result<ApiClientWithHostInformation, Error>

Probe the node’s HTTP API, perform any configured verification, and return the client together with the SignedHostInformation if it was fetched.

The host information is only retrieved when identity verification or signature checking is enabled. When neither is active, the returned ApiClientWithHostInformation::host_information will be None.

Trait Implementations

impl Debug for NymNodeApiClientRetriever

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.