Clerk

Overview

Clerk manages generic state-sync from Ethereum chain to Bor chain. Heimdall agrees on state sync, which is initiated on the Ethereum chain using this module.

More details: State sync mechanism

Messages

MsgEventRecord

MsgEventRecord transaction is responsible for validating events from StateSender.sol and storing the state on Heimdall for Bor to use.

Handler for this transaction validates for any given msg.TxHash and msg.LogIndex. It throws Older invalid tx found error if trying to process the transaction more than once.

Here is the structure for the transaction message:

// MsgEventRecord - state msg
type MsgEventRecord struct {
    From     types.HeimdallAddress `json:"from"`
    TxHash   types.HeimdallHash    `json:"tx_hash"`
    LogIndex uint64                `json:"log_index"`
    ID       uint64                `json:"id"`
    ChainID  string                `json:"bor_chain_id"`
}

CLI commands

Send state record transaction

heimdallcli tx clerk record
    --log-index <log-index> 
    --tx-hash <transaction-hash> 
    --bor-chain-id <bor-chain-id>
    --chain-id <heimdall-chain-id>

To query already validated state event record

heimdallcli query clerk record --id <state-record-id>

REST APIs

Name	Method	Endpoint
Event record details	GET	/clerk/event-record/<record-id>
All event records	GET	/clerk/event-record/list

Overview#

Messages#

MsgEventRecord#

CLI commands#

Send state record transaction#

To query already validated state event record#

REST APIs#