nodeclient

type AddPeerRequest struct {
	// The libp2p multi address of the peer.
	MultiAddress string `json:"multiAddress"`
	// The alias of to iditify the peer.
	Alias *string `json:"alias,omitempty"`
}

type AliasesQuery struct {
	IndexerCursorParas
	IndexerCreationParas
	IndexerNativeTokenParas

	// Bech32-encoded state controller address that should be searched for.
	StateControllerBech32 string `qs:"stateController,omitempty"`
	// Bech32-encoded governor address that should be searched for.
	GovernorBech32 string `qs:"governor,omitempty"`
	// Filters outputs based on the presence of validated sender.
	SenderBech32 string `qs:"sender,omitempty"`
	// Filters outputs based on the presence of validated issuer.
	IssuerBech32 string `qs:"issuer,omitempty"`
}

type BasicOutputsQuery struct {
	IndexerCursorParas
	IndexerTimelockParas
	IndexerExpirationParas
	IndexerCreationParas
	IndexerStorageDepositParas
	IndexerNativeTokenParas

	// Bech32-encoded address that should be searched for.
	AddressBech32 string `qs:"address,omitempty"`
	// Filters outputs based on the presence of validated sender.
	SenderBech32 string `qs:"sender,omitempty"`
	// Filters outputs based on matching tag feature.
	Tag string `qs:"tag,omitempty"`
}

type BlockMetadataResponse struct {
	// The hex encoded ID of the block.
	BlockID string `json:"blockId"`
	// The hex encoded IDs of the parent block references.
	Parents []string `json:"parents"`
	// Whether the block is solid.
	Solid bool `json:"isSolid"`
	// The milestone index that references this block.
	ReferencedByMilestoneIndex iotago.MilestoneIndex `json:"referencedByMilestoneIndex,omitempty"`
	// If this block represents a milestone this is the milestone index
	MilestoneIndex iotago.MilestoneIndex `json:"milestoneIndex,omitempty"`
	// The ledger inclusion state of the transaction payload.
	LedgerInclusionState string `json:"ledgerInclusionState,omitempty"`
	// Whether the block should be promoted.
	ShouldPromote *bool `json:"shouldPromote,omitempty"`
	// Whether the block should be reattached.
	ShouldReattach *bool `json:"shouldReattach,omitempty"`
	// The reason why this block is marked as conflicting.
	ConflictReason uint8 `json:"conflictReason,omitempty"`
	// If this block is referenced by a milestone this returns the index of that block inside the milestone by whiteflag ordering.
	WhiteFlagIndex *uint32 `json:"whiteFlagIndex,omitempty"`
}

type ChildrenResponse struct {
	// The hex encoded block ID of the block.
	BlockID string `json:"blockId"`
	// The maximum count of results that are returned by the node.
	MaxResults uint32 `json:"maxResults"`
	// The actual count of results that are returned.
	Count uint32 `json:"count"`
	// The hex encoded IDs of the children of this block.
	Children []string `json:"children"`
}

type Client struct {
	// The base URL for all API calls.
	BaseURL string
	// contains filtered or unexported fields
}

type ClientOption func(opts *ClientOptions)

type ClientOptions struct {
	// contains filtered or unexported fields
}

type ComputeWhiteFlagMutationsRequest struct {
	// The index of the milestone.
	Index iotago.MilestoneIndex `json:"index"`
	// The timestamp of the milestone.
	Timestamp uint32 `json:"timestamp"`
	// The hex encoded IDs of the parent blocks the milestone references.
	Parents []string `json:"parents"`
	// The hex encoded milestone ID of the previous milestone.
	PreviousMilestoneID string `json:"previousMilestoneId"`
}

type ComputeWhiteFlagMutationsResponse struct {
	// The inclusion merkle tree root as a result of the white flag computation.
	InclusionMerkleRoot iotago.MilestoneMerkleProof
	// The applied merkle tree root as a result of the white flag computation.
	AppliedMerkleRoot iotago.MilestoneMerkleProof
}

type ComputeWhiteFlagMutationsResponseInternal struct {
	// The hex encoded inclusion merkle tree root as a result of the white flag computation.
	InclusionMerkleRoot string `json:"inclusionMerkleRoot"`
	// The hex encoded applied merkle tree root as a result of the white flag computation.
	AppliedMerkleRoot string `json:"appliedMerkleRoot"`
}

type EventAPIClient struct {
	Client *Client

	MQTTClient mqtt.Client
	// The context over the EventChannelsHandle.
	Ctx context.Context
	// A channel up on which errors are returned from within subscriptions or when the connection is lost.
	// Errors are dropped silently if no receiver is listening for them or can consume them fast enough.
	Errors chan error
}

type EventAPIClientSubscription struct {
	// contains filtered or unexported fields
}

type EventAPIUnlockCondition string

type FoundriesQuery struct {
	IndexerCursorParas
	IndexerCreationParas
	IndexerNativeTokenParas

	// Bech32-encoded address that should be searched for.
	AliasAddressBech32 string `qs:"aliasAddress,omitempty"`
}

type GossipHeartbeat struct {
	// The solid milestone of the node.
	SolidMilestoneIndex iotago.MilestoneIndex `json:"solidMilestoneIndex"`
	// The milestone index at which the node pruned its data.
	PrunedMilestoneIndex iotago.MilestoneIndex `json:"prunedMilestoneIndex"`
	// The latest known milestone index by the node.
	LatestMilestoneIndex iotago.MilestoneIndex `json:"latestMilestoneIndex"`
	// The amount of currently connected peers.
	ConnectedPeers int `json:"connectedPeers"`
	// The amount of currently connected peers who also
	// are synchronized with the network.
	SyncedPeers int `json:"syncedPeers"`
}

type GossipInfo struct {
	// The last received heartbeat by the given node.
	Heartbeat *GossipHeartbeat `json:"heartbeat"`
	// The metrics about sent and received protocol messages.
	Metrics PeerGossipMetrics `json:"metrics"`
}

type HTTPErrorResponseEnvelope struct {
	Error struct {
		Code    string `json:"code"`
		Message string `json:"message"`
	} `json:"error"`
}

type IndexerClient interface {
	// Outputs returns a handle to query for outputs.
	Outputs(ctx context.Context, query IndexerQuery) (*IndexerResultSet, error)
	// Alias queries for a specific iotago.AliasOutput by its identifier and returns the ledger index at which this output where available at.
	Alias(ctx context.Context, aliasID iotago.AliasID) (*iotago.OutputID, *iotago.AliasOutput, iotago.MilestoneIndex, error)
	// Foundry queries for a specific iotago.FoundryOutput by its identifier and returns the ledger index at which this output where available at.
	Foundry(ctx context.Context, foundryID iotago.FoundryID) (*iotago.OutputID, *iotago.FoundryOutput, iotago.MilestoneIndex, error)
	// NFT queries for a specific iotago.NFTOutput by its identifier and returns the ledger index at which this output where available at.
	NFT(ctx context.Context, nftID iotago.NFTID) (*iotago.OutputID, *iotago.NFTOutput, iotago.MilestoneIndex, error)
}

type IndexerCreationParas struct {
	// Return outputs that were created before a certain Unix timestamp.
	CreatedBefore uint32 `qs:"createdBefore,omitempty"`
	// Return outputs that were created after a certain Unix timestamp.
	CreatedAfter uint32 `qs:"createdAfter,omitempty"`
}

type IndexerCursorParas struct {
	// The maximum amount of items returned in one call.
	PageSize int `qs:"pageSize,omitempty"`
	// The offset from which to query from.
	Cursor *string `qs:"cursor,omitempty"`
}

type IndexerExpirationParas struct {
	// Filters outputs based on the presence of expiration unlock condition.
	HasExpiration *bool `qs:"hasExpiration,omitempty"`
	// Return outputs that expire before a certain Unix timestamp.
	ExpiresBefore uint32 `qs:"expiresBefore,omitempty"`
	// Return outputs that expire after a certain Unix timestamp.
	ExpiresAfter uint32 `qs:"expiresAfter,omitempty"`
	// Filter outputs based on the presence of a specific return address in the expiration unlock condition.
	ExpirationReturnAddressBech32 string `qs:"expirationReturnAddress,omitempty"`
}

type IndexerNativeTokenParas struct {
	// Filters outputs based on the presence of native tokens in the output.
	HasNativeTokens *bool `qs:"hasNativeTokens,omitempty"`
	// Filter outputs that have at least an amount of native tokens.
	MinNativeTokenCount *uint32 `qs:"minNativeTokenCount,omitempty"`
	// Filter outputs that have at the most an amount of native tokens.
	MaxNativeTokenCount *uint32 `qs:"maxNativeTokenCount,omitempty"`
}

type IndexerQuery interface {
	// SetOffset sets the offset for the query.
	SetOffset(offset *string)
	// URLParas returns the query parameters as URL encoded query parameters.
	URLParas() (string, error)
	// OutputType returns the output type for which the query is for.
	OutputType() iotago.OutputType
}

type IndexerResponse struct {
	// The ledger index at which these outputs where available at.
	LedgerIndex iotago.MilestoneIndex `json:"ledgerIndex"`
	// The maximum count of results that are returned by the node.
	PageSize int `json:"pageSize"`
	// The output IDs (transaction hash + output index) of the found outputs.
	Items iotago.HexOutputIDs `json:"items"`
	// The cursor to use for getting the next results.
	Cursor *string `json:"cursor"`
}

type IndexerResultSet struct {

	// The error which has occurred during querying.
	Error error
	// The response from the indexer after calling Next().
	Response *IndexerResponse
	// contains filtered or unexported fields
}

type IndexerStorageDepositParas struct {
	// Filters outputs based on the presence of storage deposit return unlock condition.
	HasStorageDepositReturn *bool `qs:"hasStorageDepositReturn,omitempty"`
	// Filter outputs based on the presence of a specific return address in the storage deposit return unlock condition.
	StorageDepositReturnAddressBech32 string `qs:"storageDepositReturnAddress,omitempty"`
}

type IndexerTimelockParas struct {
	// Filters outputs based on the presence of timelock unlock condition.
	HasTimelock *bool `qs:"hasTimelock,omitempty"`
	// Return outputs that are timelocked before a certain Unix timestamp.
	TimelockedBefore uint32 `qs:"timelockedBefore,omitempty"`
	// Return outputs that are timelocked after a certain Unix timestamp.
	TimelockedAfter uint32 `qs:"timelockedAfter,omitempty"`
}

type InfoResBaseToken struct {
	// The base token name.
	Name string `json:"name"`
	// The base token ticker symbol.
	TickerSymbol string `json:"tickerSymbol"`
	// The base token unit.
	Unit string `json:"unit"`
	// The base token subunit.
	Subunit string `json:"subunit,omitempty"`
	// The base token amount of decimals.
	Decimals uint32 `json:"decimals"`
	// The base token uses the metric prefix.
	UseMetricPrefix bool `json:"useMetricPrefix"`
}

type InfoResMetrics struct {
	// The current rate of new blocks per second.
	BlocksPerSecond float64 `json:"blocksPerSecond"`
	// The current rate of referenced blocks per second.
	ReferencedBlocksPerSecond float64 `json:"referencedBlocksPerSecond"`
	// The ratio of referenced blocks in relation to new blocks of the last confirmed milestone.
	ReferencedRate float64 `json:"referencedRate"`
}

type InfoResMilestone struct {
	// The index of the milestone.
	Index iotago.MilestoneIndex `json:"index"`
	// The unix time of the milestone payload.
	Timestamp uint32 `json:"timestamp,omitempty"`
	// The IO of the milestone.
	MilestoneID string `json:"milestoneId,omitempty"`
}

type InfoResStatus struct {
	// Whether the node is healthy.
	IsHealthy bool `json:"isHealthy"`
	// The latest known milestone index.
	LatestMilestone InfoResMilestone `json:"latestMilestone"`
	// The current confirmed milestone's index.
	ConfirmedMilestone InfoResMilestone `json:"confirmedMilestone"`
	// The milestone index at which the last pruning commenced.
	PruningIndex iotago.MilestoneIndex `json:"pruningIndex"`
}

type InfoResponse struct {
	// The name of the node software.
	Name string `json:"name"`
	// The semver version of the node software.
	Version string `json:"version"`
	// Status information.
	Status InfoResStatus `json:"status"`
	// Protocol information.
	Protocol iotago.ProtocolParameters `json:"protocol"`
	// BaseToken information.
	BaseToken *InfoResBaseToken `json:"baseToken"`
	// Metrics information.
	Metrics InfoResMetrics `json:"metrics"`
	// The features this node exposes.
	Features []string `json:"features"`
}

type MilestoneInfo struct {
	Index       iotago.MilestoneIndex `json:"index"`
	Timestamp   uint32                `json:"timestamp"`
	MilestoneID string                `json:"milestoneId"`
}

type MilestoneUTXOChangesResponse struct {
	// The index of the milestone.
	Index iotago.MilestoneIndex `json:"index"`
	// The output IDs (transaction hash + output index) of the newly created outputs.
	CreatedOutputs []string `json:"createdOutputs"`
	// The output IDs (transaction hash + output index) of the consumed (spent) outputs.
	ConsumedOutputs []string `json:"consumedOutputs"`
}

type NFTsQuery struct {
	IndexerCursorParas
	IndexerTimelockParas
	IndexerExpirationParas
	IndexerStorageDepositParas
	IndexerNativeTokenParas
	IndexerCreationParas

	// Bech32-encoded address that should be searched for.
	AddressBech32 string `qs:"address,omitempty"`
	// Filters outputs based on the presence of validated sender.
	SenderBech32 string `qs:"sender,omitempty"`
	// Filters outputs based on the presence of validated issuer.
	IssuerBech32 string `qs:"issuer,omitempty"`
	// Filters outputs based on matching tag feature.
	Tag string `qs:"tag,omitempty"`
}

type OutputMetadataResponse struct {
	// The hex encoded ID of the block.
	BlockID string `json:"blockId"`
	// The hex encoded transaction id from which this output originated.
	TransactionID string `json:"transactionId"`
	// The index of the output.
	OutputIndex uint16 `json:"outputIndex"`
	// Whether this output is spent.
	Spent bool `json:"isSpent"`
	// The milestone index at which this output was spent.
	MilestoneIndexSpent iotago.MilestoneIndex `json:"milestoneIndexSpent,omitempty"`
	// The milestone timestamp this output was spent.
	MilestoneTimestampSpent uint32 `json:"milestoneTimestampSpent,omitempty"`
	// The transaction this output was spent with.
	TransactionIDSpent string `json:"transactionIdSpent,omitempty"`
	// The milestone index at which this output was booked into the ledger.
	MilestoneIndexBooked iotago.MilestoneIndex `json:"milestoneIndexBooked"`
	// The milestone timestamp this output was booked in the ledger.
	MilestoneTimestampBooked uint32 `json:"milestoneTimestampBooked"`
	// The ledger index at which this output was available at.
	LedgerIndex iotago.MilestoneIndex `json:"ledgerIndex"`
}

type OutputResponse struct {
	Metadata *OutputMetadataResponse `json:"metadata"`
	// The output in its serialized form.
	RawOutput *json.RawMessage `json:"output"`
}

type PeerGossipMetrics struct {
	// The total amount of received new blocks.
	NewBlocks uint32 `json:"newBlocks"`
	// The total amount of received known blocks.
	KnownBlocks uint32 `json:"knownBlocks"`
	// The total amount of received blocks.
	ReceivedBlocks uint32 `json:"receivedBlocks"`
	// The total amount of received block requests.
	ReceivedBlockRequests uint32 `json:"receivedBlockRequests"`
	// The total amount of received milestone requests.
	ReceivedMilestoneRequests uint32 `json:"receivedMilestoneRequests"`
	// The total amount of received heartbeats.
	ReceivedHeartbeats uint32 `json:"receivedHeartbeats"`
	// The total amount of sent blocks.
	SentBlocks uint32 `json:"sentBlocks"`
	// The total amount of sent block request.
	SentBlockRequests uint32 `json:"sentBlockRequests"`
	// The total amount of sent milestone request.
	SentMilestoneRequests uint32 `json:"sentMilestoneRequests"`
	// The total amount of sent heartbeats.
	SentHeartbeats uint32 `json:"sentHeartbeats"`
	// The total amount of packets which couldn't be sent.
	DroppedPackets uint32 `json:"droppedPackets"`
}

type PeerResponse struct {
	// The libp2p identifier of the peer.
	ID string `json:"id"`
	// The libp2p multi addresses of the peer.
	MultiAddresses []string `json:"multiAddresses"`
	// The alias to identify the peer.
	Alias *string `json:"alias,omitempty"`
	// The relation (static, autopeered) of the peer.
	Relation string `json:"relation"`
	// Whether the peer is connected.
	Connected bool `json:"connected"`
	// The gossip related information about this peer.
	Gossip *GossipInfo `json:"gossip,omitempty"`
}

type RawDataEnvelope struct {
	// The encapsulated binary data.
	Data []byte
}

type ReceiptTuple struct {
	Receipt        *iotago.ReceiptMilestoneOpt `json:"receipt"`
	MilestoneIndex iotago.MilestoneIndex       `json:"milestoneIndex"`
}

type ReceiptsResponse struct {
	Receipts []*ReceiptTuple `json:"receipts"`
}

type RequestHeaderHook func(header http.Header)

type RequestURLHook func(url string) string

type RoutesResponse struct {
	Routes []string `json:"routes"`
}

type TipsResponse struct {
	// The hex encoded block IDs of the tips.
	TipsHex []string `json:"tips"`
}

type TreasuryResponse struct {
	MilestoneID string `json:"milestoneId"`
	Amount      string `json:"amount"`
}