api

type Balance struct {
	Error
	Amount uint64 `json:"amount"`
	LRBID  string `json:"lrbid"`
}

type BranchData struct {
	ID   string                        `json:"id"`
	Data multistate.BranchDataJSONAble `json:"data"`
}

type Bytecode struct {
	Bytecode string `json:"bytecode"`
}

type ChainOutput struct {
	Error
	OutputDataWithID
	// latest reliable branch used to extract chain ID
	LRBID string `json:"lrbid"`
}

type ChainedOutputs struct {
	Error
	Outputs map[string]string `json:"outputs,omitempty"`
	LRBID   string            `json:"lrbid"`
}

type Chains struct {
	Error
	Chains map[string]OutputDataWithID `json:"chains"`
	LRBID  string                      `json:"lrbid"`
}

type CheckTxIDInLRB struct {
	Error
	TxID         string `json:"txid"`
	LRBID        string `json:"lrbid"`
	FoundAtDepth int    `json:"found_at_depth"`
}

type DelegationData struct {
	Amount      uint64 `json:"amount"`
	SinceSlot   uint32 `json:"since_slot"`
	StartAmount uint64 `json:"start_amount"`
}

type DelegationsBySequencer struct {
	Error
	LRBID      string                            `json:"lrbid"`
	Sequencers map[string]DelegationsOnSequencer `json:"sequencers"`
}

type DelegationsOnSequencer struct {
	SequencerOutputID string                    `json:"seq_output_id"`
	SequencerName     string                    `json:"seq_name"`
	Balance           uint64                    `json:"balance"`
	Delegations       map[string]DelegationData `json:"delegations"`
}

type Error struct {
	// empty string when no error
	Error string `json:"error,omitempty"`
}

type Input struct {
	OutputID   string `json:"output_id"`
	UnlockData string `json:"unlock_data"`
}

type KnownLatestMilestones struct {
	Error
	Sequencers map[string]tippool.LatestSequencerTipDataJSONAble `json:"sequencers"`
}

type LatestReliableBranch struct {
	Error
	RootData multistate.RootRecordJSONAble `json:"root_record,omitempty"`
	BranchID ledger.TransactionID          `json:"branch_id,omitempty"`
}

type LedgerID struct {
	Error
	// hex-encoded ledger id bytes
	LedgerIDBytes string `json:"ledger_id_bytes,omitempty"`
}

type MainChain struct {
	Error
	Branches []BranchData `json:"branches"`
}

type MilestoneData struct {
	Name         string `json:"name"`
	MinimumFee   uint64 `json:"minimum_fee"`
	ChainHeight  uint32 `json:"chain_height"`
	BranchHeight uint32 `json:"branch_height"`
}

type OutputData struct {
	Error
	// hex-encoded output data
	OutputData string `json:"output_data,omitempty"`
	// latest reliable branch used to extract output
	LRBID string `json:"lrbid"`
}

type OutputDataWithID struct {
	// hex-encoded outputID
	ID string `json:"id"`
	// hex-encoded output data
	Data string `json:"data"`
}

type OutputList struct {
	Error
	// key is hex-encoded outputID bytes
	// value is hex-encoded raw output data
	Outputs map[string]string `json:"outputs,omitempty"`
	// latest reliable branch used to extract outputs
	LRBID string `json:"lrbid"`
}

type ParsedOutput struct {
	// raw hex-encoded output data
	Data string `json:"data"`
	// parsed constraints for display
	Constraints []string `json:"constraints"`
	// amount
	Amount uint64 `json:"amount"`
	// name of the lock constraint
	LockName string `json:"lock_name"`
	// Chain ID for chain outputs
	ChainID string `json:"chain_id,omitempty"`
}

type ParsedOutputList struct {
	Error
	// key is hex-encoded outputID bytes
	// value is hex-encoded raw output data
	Outputs map[string]ParsedOutput `json:"outputs,omitempty"`
	// latest reliable branch used to extract outputs
	LRBID string `json:"lrbid"`
}

type PeerInfo struct {
	// The libp2p identifier of the peer.
	ID string `json:"id"`
	// The libp2p multi addresses of the peer.
	MultiAddresses            []string `json:"multiAddresses,omitempty"`
	IsStatic                  bool     `json:"is_static"`
	RespondsToPull            bool     `json:"responds_to_pull"`
	IsAlive                   bool     `json:"is_alive"`
	WhenAdded                 int64    `json:"when_added"`
	LastHeartbeatReceived     int64    `json:"last_heartbeat_received"`
	ClockDifferencesQuartiles [3]int64 `json:"clock_differences_quartiles"`
	HBMsgDifferencesQuartiles [3]int64 `json:"hb_differences_quartiles"`
	NumIncomingHB             int      `json:"num_incoming_hb"`
	NumIncomingPull           int      `json:"num_incoming_pull"`
	NumIncomingTx             int      `json:"num_incoming_tx"`
}

type PeersInfo struct {
	Error
	HostID    string            `json:"host_id"`
	Peers     []PeerInfo        `json:"peers,omitempty"`
	Blacklist map[string]string `json:"blacklist,omitempty"` // map: peerID -> reason why it is in the blacklist
}

type ScriptSource struct {
	Source string `json:"source"`
}

type SequencerSyncInfo struct {
	Synced              bool   `json:"synced"`
	LatestHealthySlot   uint32 `json:"latest_healthy_slot"`
	LatestCommittedSlot uint32 `json:"latest_committed_slot"`
	LedgerCoverage      uint64 `json:"ledger_coverage"`
}

type SequencerTxData struct {
	SequencerID          string `json:"sequencer_id"`
	SequencerOutputIndex byte   `json:"sequencer_output_index"`
	StemOutputIndex      *byte  `json:"stem_output_index,omitempty"` // nil for non-branch transaction
	*MilestoneData       `json:"milestone_data,omitempty"`
}

type SyncInfo struct {
	Error
	Synced         bool                         `json:"synced"`
	CurrentSlot    uint32                       `json:"current_slot"`
	LrbSlot        uint32                       `json:"lrb_slot"`
	LedgerCoverage uint64                       `json:"ledger_coverage"`
	PerSequencer   map[string]SequencerSyncInfo `json:"per_sequencer,omitempty"`
}

type TransactionJSONAble struct {
	// hex-encoded transaction ID
	ID               string `json:"id"`
	TotalAmount      uint64 `json:"total_amount"`
	TotalInflation   uint64 `json:"total_inflation"`
	IsBranch         bool   `json:"is_branch"`
	*SequencerTxData `json:"sequencer_tx_data,omitempty"`
	Sender           string                                  `json:"sender"`
	Signature        string                                  `json:"signature"`
	Inputs           []Input                                 `json:"inputs"`
	Outputs          []ParsedOutput                          `json:"outputs"`
	Endorsements     []string                                `json:"endorsements,omitempty"`
	TxMetadata       *txmetadata.TransactionMetadataJSONAble `json:"tx_metadata,omitempty"`
}

type TxBytes struct {
	TxBytes    string                                  `json:"tx_bytes"`
	TxMetadata *txmetadata.TransactionMetadataJSONAble `json:"tx_metadata,omitempty"`
}

type VertexWithDependencies struct {
	ID                    string   `json:"id"`                // transaction ID in hex form
	TotalAmount           uint64   `json:"a"`                 // total produced amount on transaction
	TotalInflation        uint64   `json:"i,omitempty"`       // total inflation on transaction
	SequencerID           string   `json:"seqid,omitempty"`   // "" (omitted) for non-seq. Useful for coloring
	SequencerInputTxIndex *byte    `json:"seqidx,omitempty"`  // sequencer predecessor tx index for sequencer predecessor tx in the Inputs list, otherwise nil
	StemInputTxIndex      *byte    `json:"stemidx,omitempty"` // stem predecessor (branch) tx index for stem predecessor tx in the Inputs list, otherwise nil
	Inputs                []string `json:"in"`                // list of input IDs (not empty)
	Endorsements          []string `json:"endorse,omitempty"` // list of endorsements (can be nil)
}