# Packages
No description provided by the author
# Functions
ComposeAPI composes a new API from the given settings and provider.
NewHTTPClient creates a new Http Provider.
NewQuorumHTTPClient creates a new quorum based Http Provider.
# Constants
API command names.
API command names.
API command names.
API command names.
DefaultLocalIRIURI is the default URI used when none is given in HTTPClientSettings.
API command names.
API command names.
API command names.
API command names.
API command names.
API command names.
API command names.
API command names.
API command names.
MinimumQuorumThreshold is the minimum threshold the quorum settings must have.
package quorum levels.
package quorum levels.
package quorum levels.
API command names.
API command names.
API command names.
# Variables
errors produced by the quorum http provider.
errors produced by the quorum http provider.
errors produced by the quorum http provider.
errors produced by the quorum http provider.
errors produced by the quorum http provider.
errors produced by the quorum http provider.
errors produced by the quorum http provider.
# Structs
AccountData is an object containing an account's current state derived from the available data given by nodes during the current snapshot epoch.
AddNeighborsCommand represents the payload to the AddNeighbor API call.
AddNeighborsResponse is the response from the AddNeighbor API call.
API defines an object encapsulating the communication to connected nodes and API calls.
AttachToTangleCommand represents the payload to the AttachToTangle API call.
AttachToTangleResponse is the response from the AttachToTangle API call.
Balances represents the payload of the GetBalances API (with parsed balances instead of strings).
BroadcastTransactionsCommand represents the payload to the BroadcastTransactions API call.
CheckConsistencyCommand represents the payload to the CheckConsistency API call.
CheckConsistencyResponse is the response from the CheckConsistency API call.
No description provided by the author
ErrRequestError encapsulates errors given by the connected node or parse errors.
FindTransactionsCommand represents the payload to the FindTransactions API call.
FindTransactionsQuery represents the payload to the FindTransactions API call.
FindTransactionsResponse is the response from the FindTransactions API call.
GetAccountDataOptions are options for when creating a new AccountData object via GetAccountData().
GetBalancesCommand represents the payload to the GetBalances API call.
GetBalancesResponse is the response from the GetBalances API call.
GetInclusionStatesCommand represents the payload to the GetInclusionStates API call.
GetInclusionStatesResponse is the response from the GetInclusionStates API call.
GetInputsOptions are options for when gathering Inputs via GetInputs().
GetLatestSolidSubtangleMilestoneCommand represents the payload to the GetNodeInfo API call.
GetLatestSolidSubtangleMilestoneResponse is the response from the GetNodeInfo API call but reduced to just the latest subtangle milestone data.
GetNeighborsCommand represents the payload to the GetNeighbors API call.
GetNeighborsResponse is the response from the GetNeighbors API call.
GetNewAddressOptions are options for when generating new addresses via GetNewAddress().
GetNodeInfoCommand represents the payload to the GetNodeInfo API call.
GetNodeInfoResponse is the response from the GetNodeInfo API call.
GetTransactionsToApproveCommand represents the payload to the GetTransactionsToApprove API call.
GetTransactionsToApproveResponse is the response from the GetTransactionsToApprove API call.
GetTransfersOptions are options for when gathering Bundles via GetTransfers().
GetTrytesCommand represents the payload to the GetTrytes API call.
GetTrytesResponse is the response from the GetTrytes API call.
GetWhiteFlagConfirmationCommand represents the payload to the GetWhiteFlagConfirmation API call.
GetWhiteFlagConfirmationResponse defines the response of a getWhiteFlagConfirmation API call.
HTTPClientSettings defines a set of settings for when constructing a new Http Provider.
Input is an address from which to withdraw the total available balance to fulfill a transfer's overall output value.
Inputs is a set of Input(s) and the total balance from them.
InterruptAttachToTangleCommand represents the payload to the InterruptAttachToTangle API call.
Neighbor is a node which is connected to the current connected node and gossips transactions with it.
PrepareTransfersOptions are options for when preparing transfers via PrepareTransfers().
PromoteTransactionOptions are options for when promoting a transaction via PromoteTransaction().
QuorumDefaults defines optional default values when a quorum couldn't be reached.
QuorumHTTPClientSettings defines a set of settings for when constructing a new Http Provider.
RemoveNeighborsCommand represents the payload to the RemoveNeighbors API call.
RemoveNeighborsResponse is the response from the RemoveNeighbors API call.
SendTransfersOptions are options for when sending bundle transaction trytes via SendTransfer().
StoreTransactionsCommand represents the payload to the StoreTransactions API call.
TransactionsToApprove represents tips which can be approved by a new transaction.
WereAddressesSpentFromCommand represents the payload to the WereAddressesSpentFrom API call.
WereAddressesSpentFromResponse is the response from the WereAddressesSpentFrom API call.
WhiteFlagConfirmation contains the milestone bundle and all bundles of the white-flag confirmation.
# Interfaces
No description provided by the author
HTTPClient defines an object being able to do Http calls.
A Provider is able to send API commands.
QuorumHTTPClient defines an object being able to do Http calls.
Settings can supply different options for Provider creation.
# Type aliases
Balance represents a non negative balance.
CreateProviderFunc is a function which creates a new Provider given some settings.
IRICommand defines a command name for IRI API calls.
Neighbors is a slice of Neighbor.
QuorumLevel defines the percentage needed for a quorum.