Expand description
Types used as operation parameters and responses.
Modules§
- error
- Error types.
Structs§
- Account
Addresses Response - Contains the node’s native addresses.
- Account
Balances Response - Contains all node’s and safe’s related balances.
- Announced
Peer - Represents a peer that has been announced on-chain.
- ApiError
- Standardized error response for the API
- Channel
Info Response - General information about a channel state.
- Channel
Ticket - Represents a ticket in a channel.
- Channels
Query Request - Parameters for enumerating channels.
- Close
Channel Response - Status of the channel after a close operation.
- Entry
Node - Reachable entry node information
- Fund
Body Request - Specifies the amount of HOPR tokens to fund a channel with.
- Fund
Channel Response - Response body for funding a channel.
- Heartbeat
Info - Heartbeat information for a peer.
- Node
Channel - Channel information as seen by the node.
- Node
Channels Response - Listing of channels.
- Node
Info Response - Information about the current node. Covers network, addresses, eligibility, connectivity status, contracts addresses and indexer state.
- Node
Peer Info Response - Contains the multiaddresses of peers that are
announcedon-chain andobservedby the node. - Node
Peers Query Request - Quality information for a peer.
- Node
Peers Response - All connected and announced peers.
- Node
Ticket Statistics Response - Received tickets statistics.
- Node
Version Response - Running node version.
- Open
Channel Body Request - Request body for opening a channel.
- Open
Channel Response - Response body for opening a channel.
- Peer
Observations - All information about a known peer.
- Peer
Packet Stats Response - Packet statistics for a peer.
- Ping
Response - Contains the latency and the reported version of a peer that has been pinged.
- Session
Client Request - Request body for creating a new client session.
- Session
Client Response - Response body for creating a new client session.
- Session
Config SessionConfig- Session
Stats Ack - Session acknowledgement metrics.
- Session
Stats Frame Buffer - Session frame buffer metrics.
- Session
Stats Lifetime - Session lifetime metrics.
- Session
Stats Response - Complete snapshot of session metrics.
- Session
Stats Surb - Session SURB (Single Use Reply Block) metrics.
- Session
Stats Transport - Session transport-level metrics.
- Ticket
Price Response - Contains the ticket price in HOPR tokens.
- Ticket
Probability Response - Contains the winning probability of a ticket.
- Withdraw
Body Request - Request body for the withdrawal endpoint.
- Withdraw
Response - Response body for the withdrawal endpoint.
Enums§
- IpProtocol
- IP transport protocol
- Routing
Options - Request parameters for creating a websocket session.
- Session
Capability - Session capabilities that can be negotiated with the target peer.
- Session
Stats AckMode - Session acknowledgement mode for metrics.
- Session
Stats State - Session lifecycle state for metrics.
- Session
Target Spec - Session target specification.