readerclient

type CompletionStatus string

type Input struct {
	// Input index starting from genesis
	Index int `json:"index"`
	// Status of the input
	Status CompletionStatus `json:"status"`
	// Address responsible for submitting the input
	MsgSender common.Address `json:"msgSender"`
	// Timestamp of the input submission, defined by the base layer's block where it was recorded
	Timestamp time.Duration `json:"timestamp"`
	// Number of the base layer block in which the input was recorded
	BlockNumber uint64 `json:"blockNumber"`
	// Input payload in Ethereum hex binary format, starting with '0x'
	Payload hexutil.Bytes `json:"payload"`
	// Notices from this particular input
	Notices []Notice `json:"notices"`
	// Vouchers from this particular input
	Vouchers []Voucher `json:"vouchers"`
	// Reports from this particular input
	Reports []Report `json:"reports"`
}

type Notice struct {
	// Notice index within the context of the input that produced it
	Index int `json:"index"`
	// Input whose processing produced the notice
	InputIndex int `json:"inputIndex"`
	// Notice data as a payload in Ethereum hex binary format, starting with '0x'
	Payload hexutil.Bytes `json:"payload"`
	// Proof object that allows this notice to be validated by the base layer blockchain
	Proof *Proof `json:"proof"`
}

type Proof struct {
	// Local input index within the context of the related epoch
	InputIndexWithinEpoch int `json:"inputIndexWithinEpoch"`
	// Output index within the context of the input that produced it
	OutputIndexWithinInput int `json:"outputIndexWithinInput"`
	// Merkle root of all output hashes of the related input
	// given in Ethereum hex binary format (32 bytes), starting with '0x'
	OutputHashesRootHash hexutil.Bytes `json:"outputHashesRootHash"`
	// Merkle root of all voucher hashes of the related epoch
	// given in Ethereum hex binary format (32 bytes), starting with '0x'
	VouchersEpochRootHash hexutil.Bytes `json:"vouchersEpochRootHash"`
	// Merkle root of all notice hashes of the related epoch
	// given in Ethereum hex binary format (32 bytes), starting with '0x'
	NoticesEpochRootHash hexutil.Bytes `json:"noticesEpochRootHash"`
	// Hash of the machine state claimed for the related epoch
	// given in Ethereum hex binary format (32 bytes), starting with '0x'
	MachineStateHash hexutil.Bytes `json:"machineStateHash"`
	// Proof that this output hash is in the output-hashes merkle tree.
	// This array of siblings is bottom-up ordered (from the leaf to the root).
	// Each hash is given in Ethereum hex binary format (32 bytes), starting with '0x'.
	OutputHashInOutputHashesSiblings []hexutil.Bytes `json:"outputHashInOutputHashesSiblings"`
	// Proof that this output-hashes root hash is in epoch's output merkle tree.
	// This array of siblings is bottom-up ordered (from the leaf to the root).
	// Each hash is given in Ethereum hex binary format (32 bytes), starting with '0x'.
	OutputHashesInEpochSiblings []hexutil.Bytes `json:"outputHashesInEpochSiblings"`
	// Data that allows the validity proof to be contextualized within submitted claims,
	// given as a payload in Ethereum hex binary format, starting with '0x'
	Context hexutil.Bytes `json:"context"`
}

type Report struct {
	// Report index within the context of the input that produced it
	Index int `json:"index"`
	// Input whose processing produced the report
	InputIndex int `json:"inputIndex"`
	// Report data as a payload in Ethereum hex binary format, starting with '0x'
	Payload hexutil.Bytes `json:"payload"`
}

type Voucher struct {
	// Voucher index within the context of the input that produced it
	Index int `json:"index"`
	// Input whose processing produced the voucher
	InputIndex int `json:"inputIndex"`
	// Transaction destination address in Ethereum hex binary format (20 bytes), starting with '0x'
	Destination common.Address `json:"destination"`
	// Voucher data as a payload in Ethereum hex binary format, starting with '0x'
	Payload hexutil.Bytes `json:"payload"`
	// Proof object that allows this voucher to be validated by the base layer blockchain
	Proof *Proof `json:"proof"`
}