types

type ChainType uint16

type ClientState struct {
	// This value strictly identifies the allowed enclave.
	Mrenclave []byte `protobuf:"bytes,1,opt,name=mrenclave,proto3" json:"mrenclave,omitempty"`
	// The `key_expiration` is used to determine the validity period of the EK.
	//
	// The logic for calculating EK validity periods slightly differs between IAS and DCAP:
	//
	// IAS:
	// - This value must be greater than 0.
	// - The EK validity ends at `ias_report.timestamp + key_expiration`.
	//
	// DCAP:
	// - If the value is 0, the EK validity ends at `output.validity.not_after`.
	// - If the value is greater than 0, the EK validity ends at:
	//   min(`qv_output.validity.not_before` + key_expiration, `output.validity.not_after`)
	//
	// Considerations:
	// - Operators should fetch the latest collateral from Intel Provisioning Certification Service (PCS) to ensure the EK validity starts close to the current time.
	// - When the EK expires and the TCB evaluation data number has been updated, operators might not be immediately ready
	//   to operate with the newly accepted TCB status, resulting in availability risks.
	//   To mitigate this risk, operators should set an appropriate `tcb_evaluation_data_number_update_grace_period`.
	KeyExpiration uint64 `protobuf:"varint,2,opt,name=key_expiration,json=keyExpiration,proto3" json:"key_expiration,omitempty"`
	// Indicates whether the client is frozen.
	Frozen bool `protobuf:"varint,3,opt,name=frozen,proto3" json:"frozen,omitempty"`
	// The height of the latest consensus state that the client has tracked
	LatestHeight types.Height `protobuf:"bytes,4,opt,name=latest_height,json=latestHeight,proto3" json:"latest_height"`
	// Determines which SGX enclave quote statuses are acceptable.
	//
	// Operators must configure this carefully based on their operational
	// security posture and environment-specific considerations.
	//
	// e.g. IAS: SW_HARDENING_NEEDED, CONFIGURATION_AND_SW_HARDENING_NEEDED
	//      DCAP: SWHardeningNeeded, ConfigurationAndSWHardeningNeeded
	AllowedQuoteStatuses []string `protobuf:"bytes,5,rep,name=allowed_quote_statuses,json=allowedQuoteStatuses,proto3" json:"allowed_quote_statuses,omitempty"`
	// Specifies Security Advisory IDs that operators explicitly allow.
	//
	// Operators must carefully consider the security implications of allowing specific advisories.
	//
	// e.g. INTEL-SA-00001, INTEL-SA-00002
	AllowedAdvisoryIds []string `protobuf:"bytes,6,rep,name=allowed_advisory_ids,json=allowedAdvisoryIds,proto3" json:"allowed_advisory_ids,omitempty"`
	// A list of LCP operator addresses (ethereum format) associated with this client.
	//
	// If this field is empty, operator signatures are not required, allowing any entity to act as an operator.
	//
	// Operational assumptions:
	// - At least one operator (including entities not listed in the `operators` field) is expected to promptly reference and report the latest TCB evaluation data number.
	//   - If no operator promptly reports the latest TCB number, the client continues accepting attestations based on outdated collateral for up to 12 months.
	// - Not all operators may immediately prepare an SGX environment compatible with the latest TCB level.
	//   - The `tcb_evaluation_data_number_update_grace_period` ensures that all operators have a guaranteed minimum period to update their SGX environments, maintaining overall availability.
	Operators [][]byte `protobuf:"bytes,7,rep,name=operators,proto3" json:"operators,omitempty"`
	// The current nonce used in operator updates.
	OperatorsNonce uint64 `protobuf:"varint,8,opt,name=operators_nonce,json=operatorsNonce,proto3" json:"operators_nonce,omitempty"`
	// The numerator of the signature threshold for operator updates.
	OperatorsThresholdNumerator uint64 `` /* 145-byte string literal not displayed */
	// The denominator of the signature threshold for operator updates.
	OperatorsThresholdDenominator uint64 `` /* 152-byte string literal not displayed */
	// The current TCB evaluation data number
	//
	// The client only accepts the zkDCAP output generated using collateral with a TCB evaluation data number equal to or greater than this number.
	CurrentTcbEvaluationDataNumber uint32 `` /* 159-byte string literal not displayed */
	// The grace period (in seconds) for operators to update their SGX environments to support a newly observed TCB evaluation data number.
	//
	// Notes:
	// - A shorter grace period could increase availability risk if operators are not given sufficient time
	//   to prepare the new SGX environment compatible with the updated TCB level.
	// - Conversely, a longer grace period could delay the adoption of the latest TCB level, potentially increasing security risks.
	// - Operators must carefully consider their operational preparation needs and security posture when configuring this value.
	//
	// When a new TCB evaluation data number greater than the current number is observed:
	//
	// - If the grace period is zero:
	//   - The current number is updated immediately.
	//
	// - If the grace period is non-zero:
	//   - The new number is reserved as `next_tcb_evaluation_data_number`.
	//   - `next_tcb_evaluation_data_number_update_time` is set to current timestamp plus the grace period.
	//
	// Edge cases:
	//
	//   - Edge case 1 (current < next < newly observed number):
	//     - Immediate activation of reserved next number, bypassing the remaining grace period.
	//     - Newly observed number is reserved as the next number.
	//
	//   - Edge case 2 (current < newly observed number < next):
	//     - Immediate activation of newly observed number, preserving the reserved next number.
	//
	// These edge cases can occur due to excessively long grace periods or frequent TCB Recovery Events occurring within shorter intervals than the typical 6-month update frequency.
	// Note that we assume operators can maintain an appropriate TCB status based on previous TCB collateral. Therefore, we expect that immediate updates in these edge cases do not cause operational issues.
	// Additionally, with a well-configured grace period aligned with typical TCB update intervals, the client will never skip the configured grace period for any TCB number update.
	TcbEvaluationDataNumberUpdateGracePeriod uint32 `` /* 193-byte string literal not displayed */
	// Next TCB evaluation data number scheduled to be updated
	//
	// Notes:
	// - Must be zero if and only if `next_tcb_evaluation_data_number_update_time` is zero.
	// - When `tcb_evaluation_data_number_update_grace_period` is zero, this field must always be zero.
	// - If this is non-zero, this number must be always greater than the `current_tcb_evaluation_data_number`.
	NextTcbEvaluationDataNumber uint32 `` /* 150-byte string literal not displayed */
	// Scheduled update time of the next TCB evaluation data number (UNIX time seconds)
	//
	// Notes:
	// - Must be zero if and only if `next_tcb_evaluation_data_number` is zero.
	// - When `tcb_evaluation_data_number_update_grace_period` is zero, this field must always be zero.
	NextTcbEvaluationDataNumberUpdateTime uint64 `` /* 184-byte string literal not displayed */
	// Contains verifier-specific information for zkDCAP proofs.
	//
	// Data format:
	// - First byte (0): zkVM type identifier.
	// - Remaining bytes (1–N): zkVM-specific data.
	//
	// Currently, only RISC Zero zkVM (type=1) is supported, with the following format:
	//
	// | Byte(s) | Description                 |
	// |---------|-----------------------------|
	// | 0       | zkVM type (fixed as 1)      |
	// | 1–31    | Reserved (set as zero)      |
	// | 32–63   | Image ID                    |
	ZkdcapVerifierInfos [][]byte `protobuf:"bytes,15,rep,name=zkdcap_verifier_infos,json=zkdcapVerifierInfos,proto3" json:"zkdcap_verifier_infos,omitempty"`
}

type CommitmentProofs struct {
	Message    []byte
	Signatures [][]byte
}

type ConsensusState struct {
	// An identifier that uniquely indicates the ELC state at a specific height
	//
	// Please check the state ID details: <https://docs.lcp.network/protocol/elc#state-id>
	StateId []byte `protobuf:"bytes,1,opt,name=state_id,json=stateId,proto3" json:"state_id,omitempty"`
	// The timestamp of the target chain's block corresponding to the consensus height,
	// expressed in UNIX time (seconds).
	Timestamp uint64 `protobuf:"varint,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
}

type EKInfo struct {
	ExpiredAt uint64
	Operator  common.Address
}

type ELCVerifyMembershipMessage struct {
	Prefix  []byte
	Path    []byte
	Value   [32]byte
	Height  clienttypes.Height
	StateID StateID
}

type EmittedState struct {
	Height clienttypes.Height
	State  codectypes.Any
}

type EmptyValidationContext struct{}

type HeaderedProxyMessage struct {
	Version uint16
	Type    uint16
	Message []byte
}

type MisbehaviourProxyMessage struct {
	PrevStates []struct {
		Height  clienttypes.Height
		StateID StateID
	}
	Context       ValidationContext
	ClientMessage []byte
}

type ProxyMessage interface{}

type RegisterEnclaveKeyMessage struct {
	// IAS report
	Report []byte `protobuf:"bytes,1,opt,name=report,proto3" json:"report,omitempty"`
	// A signature of the IAS report by the IAS signing key
	Signature []byte `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// A certificate of the IAS signing key
	SigningCert []byte `protobuf:"bytes,3,opt,name=signing_cert,json=signingCert,proto3" json:"signing_cert,omitempty"`
	// An operator's signature of the EIP-712 message `RegisterEnclaveKey`
	OperatorSignature []byte `protobuf:"bytes,4,opt,name=operator_signature,json=operatorSignature,proto3" json:"operator_signature,omitempty"`
}

type StateID [32]byte

type TrustingPeriodValidationContext struct {
	UntrustedHeaderTimestamp time.Time `json:"untrusted_header_timestamp"`
	TrustedStateTimestamp    time.Time `json:"trusted_state_timestamp"`
	TrustingPeriod           big.Int   `json:"trusting_period"`
	ClockDrift               big.Int   `json:"clock_drift"`
}

type UpdateClientMessage struct {
	// A proxy message generated by the LCP node running on the target platform
	ProxyMessage []byte `protobuf:"bytes,1,opt,name=proxy_message,json=proxyMessage,proto3" json:"proxy_message,omitempty"`
	// Signatures of the proxy message by the LCP node
	Signatures [][]byte `protobuf:"bytes,2,rep,name=signatures,proto3" json:"signatures,omitempty"`
}

type UpdateOperatorsMessage struct {
	// A nonce for this operators update
	Nonce uint64 `protobuf:"varint,1,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// A list of new operators
	NewOperators [][]byte `protobuf:"bytes,2,rep,name=new_operators,json=newOperators,proto3" json:"new_operators,omitempty"`
	// A numerator of the threshold of signatures required for new operators
	NewOperatorsThresholdNumerator uint64 `` /* 156-byte string literal not displayed */
	// A denominator of the threshold of signatures required for new operators
	NewOperatorsThresholdDenominator uint64 `` /* 162-byte string literal not displayed */
	// Signatures of the EIP-712 message `UpdateOperators` by the current operators
	Signatures [][]byte `protobuf:"bytes,5,rep,name=signatures,proto3" json:"signatures,omitempty"`
}

type UpdateStateProxyMessage struct {
	PrevHeight    *clienttypes.Height `json:"prev_height"`
	PrevStateID   *StateID            `json:"prev_state_id"`
	PostHeight    clienttypes.Height  `json:"post_height"`
	PostStateID   StateID             `json:"post_state_id"`
	Timestamp     *big.Int            `json:"timestamp"`
	Context       ValidationContext   `json:"context"`
	EmittedStates []EmittedState      `json:"emitted_states"`
}

type ValidationContext interface {
	Validate(time.Time) error
}

type ZKDCAPRegisterEnclaveKeyMessage struct {
	// A type of zkVM generated the `quote_verification_output` and `proof`
	ZkvmType uint32 `protobuf:"varint,1,opt,name=zkvm_type,json=zkvmType,proto3" json:"zkvm_type,omitempty"`
	// An output of the zkDCAP program that verifies the quote
	QuoteVerificationOutput []byte `` /* 132-byte string literal not displayed */
	// A proof of the zkVM generated the `quote_verification_output`
	Proof []byte `protobuf:"bytes,3,opt,name=proof,proto3" json:"proof,omitempty"`
	// An operator's signature of the EIP-712 message `ZKDCAPRegisterEnclaveKey`
	OperatorSignature []byte `protobuf:"bytes,4,opt,name=operator_signature,json=operatorSignature,proto3" json:"operator_signature,omitempty"`
}