# Functions
New returns a new Client using the given base URL.
WithHTTPClient sets the used HTTP Client.
WithRequestURLHook is used to modify the URL before sending a request.
WithUserInfo sets the Userinfo used to add basic auth "Authorization" headers to the requests.
# Constants
EventAPIAliasOutputs is the name of the Alias output event channel to retrieve Alias mutations by their ID.
EventAPIBlockMetadata is the name of the block metadata event channel.
EventAPIBlockMetadataReferenced is the name of the referenced blocks metadata event channel.
EventAPIBlocks is the name of the received blocks event channel.
EventAPIBlocksTaggedData is the name of the blocks containing tagged data event channel.
EventAPIBlocksTaggedDataTag is the name of the blocks containing a specific tagged data event channel.
EventAPIBlocksTransaction is the name of the blocks containing transactions event channel.
EventAPIBlocksTransactionTaggedData is the name of the blocks containing transaction with tagged data event channel.
EventAPIBlocksTransactionTaggedDataTag is the name of the blocks containing transaction with a specific tagged data event channel.
EventAPIFoundryOutputs is the name of the Foundry output event channel to retrieve Foundry mutations by their ID.
EventAPIMilestoneInfoConfirmed is the name of the confirmed milestone info event channel.
EventAPIMilestoneInfoLatest is the name of the latest milestone info event channel.
EventAPIMilestones is the name of the milestone event channel.
EventAPINFTOutputs is the name of the NFT output event channel to retrieve NFT mutations by their ID.
EventAPIOutputs is the name of the outputs event channel.
EventAPIOutputsByUnlockConditionAndAddress is the name of the outputs by unlock condition address event channel.
EventAPIReceipts is the name of the receipts event channel.
EventAPISpentOutputsByUnlockConditionAndAddress is the name of the spent outputs by unlock condition address event channel.
EventAPITransactionsIncludedBlock is the name of the included transaction block event channel.
IndexerPluginName is the name for the indexer plugin.
No description provided by the author
No description provided by the author
MQTTPluginName is the name for the MQTT plugin.
RouteBlock is the route for getting a block by its ID.
RouteBlockChildren is the route for getting block IDs of the children of a block, identified by its block ID.
RouteBlockMetadata is the route for getting block metadata by its ID.
RouteBlocks is the route for creating new blocks.
RouteComputeWhiteFlagMutations is the route to compute the white flag mutations for the cone of the given parents.
RouteHealth is the route for querying a node's health status.
RouteInfo is the route for getting the node info.
RouteMilestoneByID is the route for getting a milestone by its ID.
RouteMilestoneByIDUTXOChanges is the route for getting all UTXO changes of a milestone by its ID.
RouteMilestoneByIndex is the route for getting a milestone by its milestoneIndex.
RouteMilestoneByIndexUTXOChanges is the route for getting all UTXO changes of a milestone by its milestoneIndex.
RouteOutput is the route for getting an output by its outputID (transactionHash + outputIndex).
RouteOutputMetadata is the route for getting output metadata by its outputID (transactionHash + outputIndex) without getting the data again.
RoutePeer is the route for getting peers by their peerID.
RoutePeers is the route for getting all peers of the node.
RouteReceipts is the route for getting all persisted receipts on a node.
RouteReceiptsMigratedAtIndex is the route for getting all persisted receipts for a given migrated at index on a node.
RouteRoutes is the route for getting the routes the node supports.
RouteTips is the route for getting tips.
RouteTransactionsIncludedBlock is the route for getting the block that was included in the ledger for a given transaction ID.
RouteTreasury is the route for getting the current treasury output.
Unlock conditions.
Unlock conditions.
Unlock conditions.
Unlock conditions.
Unlock conditions.
Unlock conditions.
Unlock conditions.
# Variables
ErrEventAPIClientInactive gets returned when an EventAPIClient is inactive.
ErrHTTPBadRequest gets returned for 400 bad request HTTP responses.
ErrHTTPInternalServerError gets returned for 500 internal server error HTTP responses.
ErrHTTPNotFound gets returned for 404 not found error HTTP responses.
ErrHTTPNotImplemented gets returned for 501 not implemented error HTTP responses.
ErrHTTPServiceUnavailable gets returned for 503 service unavailable error HTTP responses.
ErrHTTPUnauthorized gets returned for 401 unauthorized error HTTP responses.
ErrHTTPUnknownError gets returned for unknown error HTTP responses.
ErrIndexerNotFound gets returned when the indexer doesn't find any result.
ErrIndexerPluginNotAvailable is returned when the indexer plugin is not available on the node.
ErrMQTTPluginNotAvailable is returned when the MQTT plugin is not available on the node.
Indexer plugin routes.
Indexer plugin routes.
Indexer plugin routes.
Indexer plugin routes.
Indexer plugin routes.
Indexer plugin routes.
Indexer plugin routes.
RequestHeaderHookAcceptIOTASerializerV1 is used to set the request "Accept" header to MIMEApplicationVendorIOTASerializerV1.
RequestHeaderHookAcceptJSON is used to set the request "Accept" header to MIMEApplicationJSON.
# Structs
No description provided by the author
AliasesQuery defines parameters for an alias outputs query.
BasicOutputsQuery defines parameters for an basic outputs query.
No description provided by the author
No description provided by the author
Client is a client for node HTTP REST API endpoints.
ClientOptions define options for the Client.
No description provided by the author
No description provided by the author
No description provided by the author
EventAPIClient represents a handle to retrieve channels for node events.
EventAPIClientSubscription holds any error that happened when trying to subscribe to an event.
FoundriesQuery defines parameters for a foundry outputs query.
No description provided by the author
No description provided by the author
HTTPErrorResponseEnvelope defines the error response schema for node API responses.
IndexerCreationParas define creation time query parameters.
IndexerCursorParas define page size and cursor query parameters.
IndexerExpirationParas define expiration query parameters.
IndexerNativeTokenParas define native token based query parameters.
IndexerResponse is the standard successful response by the indexer.
IndexerResultSet is a handle for indexer queries.
IndexerStorageDepositParas define storage deposit based query parameters.
IndexerTimelockParas define timelock query parameters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MilestoneInfo is an informative struct holding a milestone index, milestone ID and timestamp.
No description provided by the author
NFTsQuery defines parameters for an NFT outputs query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RawDataEnvelope is used internally to encapsulate binary data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
ClientOption is a function setting a Client option.
EventAPIUnlockCondition denotes the different unlock conditions.
RequestHeaderHook is a function to modify the request header before sending a request.
RequestURLHook is a function to modify the URL before sending a request.