Module types 

Types used as operation parameters and responses.

Modules

defaults

Generation of default values for serde.

error

Error types.

Structs

AccountAddressesResponse

Contains the node’s native addresses.

AccountBalancesResponse

Contains all node’s and safe’s related balances.

AnnouncedPeerResponse

A peer that has been announced.

ApiError

Standardized error response for the API

ChannelDirectionQuery

Query parameters selecting which channel (incoming or outgoing) to address.

ChannelInfoResponse

General information about a channel state.

ChannelTicket

Represents a ticket in a channel.

ChannelsQueryRequest

Parameters for enumerating channels.

CloseChannelResponse

Status of the channel after a close operation.

ConnectedPeerResponse

Immediate observation data for a connected peer.

FundBodyRequest

Specifies the amount of HOPR tokens to fund a channel with.

FundChannelResponse

Response body for funding a channel.

MultiaddressSource

A multiaddress paired with its discovery origin.

NodeChannel

Channel information as seen by the node.

NodeChannelsResponse

Listing of channels.

NodeInfoResponse

Information about the current node. Covers network, addresses, eligibility, connectivity status, contracts addresses and indexer state.

NodePeerInfoResponse

Comprehensive information about a peer: multiaddresses, QoS observations, and channel state.

NodeTicketStatisticsResponse

Received tickets statistics.

NodeVersionResponse

Running node version.

OpenChannelBodyRequest

Request body for opening a channel.

OpenChannelResponse

Response body for opening a channel.

PeerChannelInfo

Channel information for a specific peer.

PeerQosInfo

QoS observation data for a peer.

PingResponse

Contains the latency and the reported version of a peer that has been pinged.

RedeemTicketsRequest

Request body for ticket redemption with optional fields.

SessionClientRequest

Request body for creating a new client session.

SessionClientResponse

Response body for creating a new client session.

SessionConfig

SessionConfig

TicketPriceResponse

Contains the ticket price in HOPR tokens.

TicketProbabilityResponse

Contains the winning probability of a ticket.

WithdrawBodyRequest

Request body for the withdrawal endpoint.

WithdrawResponse

Response body for the withdrawal endpoint.

Enums

AnnouncementOriginResponse

How a peer announcement was discovered.

ChannelDirection

Direction of a channel relative to this node.

IpProtocol

IP transport protocol

RoutingOptions

RoutingOptions

SessionCapability

Session capabilities that can be negotiated with the target peer.

SessionTargetSpec

Session target specification.