# Packages
No description provided by the author
# Functions
IsValidEsdtPath returns true if the provided path is a valid esdt token type.
NewClosableComponentsHandler will return a new instance of closableComponentsHandler.
NewHyperblockApiResponse creates a HyperblockApiResponse.
NewTransactionWrapper returns a new instance of transactionWrapper.
# Constants
AvailabilityAll mean that the observer can be used for both real-time and historical requests.
AvailabilityRecent means that the observer can be used only for recent data.
FullHistoryNode identifier a node that has full history mode enabled.
No description provided by the author
No description provided by the author
Observer identifies a node which is a regular observer.
ReturnCodeInternalError defines a request which hasn't been executed successfully due to an internal error.
ReturnCodeRequestError defines a request which hasn't been executed successfully due to a bad request received.
ReturnCodeSuccess defines a successful request.
No description provided by the author
TxStatusUnknown defines the response that should be received from an observer when transaction status is unknown.
# Variables
ErrNilPubKeyConverter signals that a nil pub key converter has been provided.
ErrNilTransaction signals that a nil transaction has been provided.
ValidTokenTypes holds a slice containing the valid esdt token types.
# Structs
AboutInfo defines the structure needed for exposing app info.
Account defines the data structure for an account.
AccountApiResponse defines a wrapped account that the node respond with.
AccountKeyValueResponse defines the response for a request for a value of a key for an account.
AccountKeyValueResponseData follows the format of the data field on an account key-value response.
AccountModel defines an account model (with associated information).
AccountsApiResponse defines the response that will be returned by the node when requesting multiple accounts.
AccountsModel defines the model of the accounts response.
AlteredAccountsApiResponse is a response holding a altered accounts.
AlteredAccountsPayload wraps altered accounts payload.
APIPackageConfig holds the configuration for the routes of each package.
ApiRoutesConfig holds the configuration related to Rest API routes.
AuctionListAPIResponse respects the format the auction list received from the observers.
AuctionListResponse respects the format the auction list api response received from the observers.
AuctionListValidatorAPIResponse holds the data needed for an auction node validator for responding to API calls.
AuctionNode holds data needed for a node in auction to respond to API calls.
BlockApiResponse is a response holding a block.
BlockApiResponsePayload wraps a block.
BlockInfo defines the data structure for the block at which an resource (e.g.
BlocksApiResponse is a response holding(possibly) multiple block.
BlocksApiResponsePayload wraps a block.
ClosableComponentsHandler is a structure that holds a list of closable components and closes them when needed.
Credential holds an username and a password.
DatabaseTransaction extends indexer.Transaction with the 'hash' field that is not ignored in json schema.
Duration is a wrapper of the original Duration struct that has JSON marshal and unmarshal capabilities golang issue: https://github.com/golang/go/issues/10275.
EndpointHandlerData holds the items needed for creating a new HTTP endpoint.
EndpointMetrics holds statistics about the requests for a specific endpoint.
ESDTSupply is a DTO holding esdt supply.
ESDTSupplyResponse is a response holding esdt supply.
ExtendedApiSmartContractResult extends the structure transaction.ApiSmartContractResult with an extra field.
FundsRequest represents the data structure needed as input for sending funds from a node to an address.
GenericAPIResponse defines the structure of all responses on API endpoints.
GetSCRsResponse defines a response from the node holding the smart contract results.
GetSCRsResponseData follows the format of the data field of get smart contract results response.
GetTransactionResponse defines a response from the node holding the transaction sent from the chain.
GetTransactionResponseData follows the format of the data field of get transaction response.
HeartbeatApiResponse matches the output of an observer's heartbeat endpoint.
HeartbeatResponse matches the output structure the data field for an heartbeat response.
HyperblockApiResponse is a response holding a hyperblock.
HyperblockApiResponsePayload wraps a hyperblock.
InternalBlockApiResponse is a response holding an internal block.
InternalBlockApiResponsePayload wraps a internal generic block.
InternalMiniBlockApiResponse is a response holding an internal miniblock.
InternalMiniBlockApiResponsePayload wraps an internal miniblock.
InternalBlockApiResponsePayload wraps a internal generic validators info.
MultipleTransactionsResponseData holds the data which is returned when sending a bulk of transactions.
NetworkConfig is a dto that will keep information about the network config.
NodeData holds an observer data.
NodesReloadResponse is a DTO that holds details about nodes reloading.
NodeStatusAPIResponse represents the mapping of the response of a node's status.
NodeStatusAPIResponseData holds the mapping of the data field when returning the status of a node.
NodeStatusResponse holds the metrics returned from the node.
NodesVersionProxyResponseData maps the response data for the proxy's nodes version endpoint.
NodeVersionAPIResponse maps the format to be used when fetching the node version from API.
NonceGap represents a struct that holds a nonce gap from tx pool From - first unknown nonce To - last unknown nonce.
ProcessStatusResponse represents a structure that holds the process status of a transaction.
PubKeyHeartbeat represents the heartbeat status struct for one public key.
ResponseFunds defines the response structure for the node's generate-and-send-multiple endpoint.
ResponseMultipleTransactions defines a response from the node holding the number of transactions sent to the chain.
ResponseTransaction defines a response tx holding the resulting hash.
ResponseTransactionSimulation defines a response tx holding the results of simulating a transaction execution.
ResponseTransactionSimulationCrossShard defines a response tx holding the results of simulating a transaction execution in a cross-shard way.
ResponseTxCost defines a response from the node holding the transaction cost.
ResponseTxStatus defines a response from the node holding the transaction status.
ResponseVmValue defines a wrapper over string containing returned data in hex format.
RouteConfig holds the configuration for a single route.
SCQuery represents a prepared query for executing a function of the smart contract.
StatusResponse represents the status received when trying to find an online node.
Transaction represents the structure that maps and validates user input for publishing a new transaction.
TransactionResponseData represents the format of the data field of a transaction response.
TransactionSimulationResponseData represents the format of the data field of a transaction simulation response.
TransactionSimulationResponseDataCrossShard represents the format of the data field of a transaction simulation response in cross shard transactions.
TransactionSimulationResults holds the results of a transaction's simulation.
TransactionsPool represents a structure that holds all wrapped transactions from pool.
TransactionsPoolApiResponse matches the output of an observer's tx pool endpoint.
TransactionsPoolForSender represents a structure that holds wrapped transactions from pool for a sender.
TransactionsPoolForSenderApiResponse matches the output of an observer's tx pool for sender endpoint.
TransactionsPoolForSenderResponseData matches the data field of get tx pool for sender response.
TransactionsPoolLastNonceForSender matches the data field of get last nonce from pool for sender response.
TransactionsPoolLastNonceForSenderApiResponse matches the output of an observer's last nonce from tx pool for sender endpoint.
TransactionsPoolNonceGaps represents a structure that holds nonce gaps.
TransactionsPoolNonceGapsForSenderApiResponse matches the output of an observer's nonce gaps from tx pool for sender endpoint.
TransactionsPoolNonceGapsForSenderResponseData matches the data field of get nonce gaps from tx pool for sender response.
TransactionsPoolResponseData matches the data field of get tx pool response.
TrieStatisticsAPIResponse represents the mapping of the response of a node's trie statistics.
TrieStatisticsResponse holds trie statistics metrics.
TxCostResponseData follows the format of the data field of a transaction cost request.
ValidatorsInfoApiResponse is a response holding validators info.
ValidatorStatisticsApiResponse respects the format the validator statistics are received from the observers.
ValidatorStatisticsResponse respects the format the validator statistics are received from the observers.
VerifyProofRequest represents the parameters needed to verify a Merkle proof.
VersionData holds the components specific for each version.
VmValueRequest defines the request struct for values available in a VM.
VmValuesResponseData follows the format of the data field in an API response for a VM values query.
WaitingEpochsLeftApiResponse matches the output of an observer's waiting epochs left endpoint.
WaitingEpochsLeftResponse matches the output structure the data field for a waiting epochs left response.
WrappedTransaction represents a wrapped transaction that is received from tx pool.
# Interfaces
ApiHandler defines the actions that an api handler should be able to do.
FacadeHandler interface defines methods that can be used from facade context variable.
GroupHandler defines the actions that an api group handler should be able to do.
StatusMetricsProvider defines what a status metrics provider should do.
VersionsRegistryHandler defines the actions that a versions registry implementation has to do.
# Type aliases
NodeType is a type which identifies the type of a node (observer or full history).
ObserverDataAvailabilityType represents the type to be used for the observers' data availability.
ReturnCode defines the type defines to identify return codes.
ValidatorApiResponse represents the data which is fetched from each validator for returning it in API call.