Skip to main content

Crate hoprd_api

Crate hoprd_api 

Source
Expand description

REST API for the HOPRd node.

Modulesยง

account ๐Ÿ”’
channels ๐Ÿ”’
checks ๐Ÿ”’
config
env ๐Ÿ”’
middleware ๐Ÿ”’
network ๐Ÿ”’
node ๐Ÿ”’
peers ๐Ÿ”’
root ๐Ÿ”’
session ๐Ÿ”’
tickets ๐Ÿ”’

Structsยง

ApiDoc
ApiError ๐Ÿ”’
Standardized error response for the API
AppState ๐Ÿ”’
InternalState ๐Ÿ”’
RestApiParameters
Parameters needed to construct the Rest API via serve_api.
SecurityAddon

Enumsยง

ApiErrorStatus ๐Ÿ”’
Enumerates all API request errors Note that ApiError should not be instantiated directly, but always rather through the ApiErrorStatus.

Constantsยง

BASE_PATH ๐Ÿ”’

Functionsยง

build_api ๐Ÿ”’
checksum_address_serializer ๐Ÿ”’
serve_api
Starts the Rest API listener and router.

Type Aliasesยง

HoprBlokliConnector ๐Ÿ”’
HoprNode ๐Ÿ”’
MessageEncoder