Struct ServerConnection 

pub struct ServerConnection {
    pub client: ArkServiceClient<InterceptedService<Channel, ProtocolVersionInterceptor>>,
    pub mailbox_client: MailboxServiceClient<InterceptedService<Channel, ProtocolVersionInterceptor>>,
    /* private fields */
}

A managed connection to the Ark server.

This type encapsulates:

• pver: The negotiated protocol version for the current session.
• info: The server’s ArkInfo configuration snapshot retrieved at connection time.
• client: A ready-to-use gRPC client bound to the same channel used for the handshake.

Fields

client: ArkServiceClient<InterceptedService<Channel, ProtocolVersionInterceptor>>

The gRPC client to call Ark RPCs.

mailbox_client: MailboxServiceClient<InterceptedService<Channel, ProtocolVersionInterceptor>>

The mailbox gRPC client to call mailbox RPCs.

Implementations

impl ServerConnection

pub async fn connect( address: &str, network: Network, ) -> Result<ServerConnection, ConnectError>

Establish a connection to an Ark server and perform protocol negotiation.

Steps performed:

1. Build and connect a gRPC channel to address (with TLS for https).
2. Perform the handshake RPC, sending the Bark client version.
3. Validate the server’s supported protocol range against MIN_PROTOCOL_VERSION..=MAX_PROTOCOL_VERSION and select a version.
4. Create a client with a protocol-version interceptor to tag future calls.
5. Fetch ArkInfo and verify it matches the provided Bitcoin Network.

Returns a ServerConnection with:

• the negotiated protocol version,
• the server’s configuration snapshot,
• and a gRPC client bound to the established channel.

Errors if the server cannot be reached, handshake fails, protocol versions are incompatible, or the server’s network does not match network.

pub async fn check_connection(&self) -> Result<(), ConnectError>

Checks the connection to the Ark server by performing an handshake request.

pub async fn ark_info(&self) -> Result<ArkInfo, ConnectError>

Returns a ArkInfoHandle

If the Ark info is outdated, a new request will be sent to the Ark server to refresh it asynchronously.

The handle also contains a receiver that will be signalled when the Ark info is successfully refreshed.

Trait Implementations

impl Clone for ServerConnection

fn clone(&self) -> ServerConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.