graph TD
A[Ethereum Wayback Machine]
%% A --> C[Ethereum Settlement Layer]
A --> G[EWM Staking Contracts]
G --> J[EVM Execution Layer]
J --> C[Ethereum Settlement Layer]
%% C --> H[PeerDAS Data Availability]
A --> B[EWM ProofChain Execution Layer]
B --> F[CometBFT Data Availability Layer]
F <--> H[EWM Bridge Agent]
H --> C[Ethereum Settlement Layer]
A --> D[CometBFT Consensus Layer]
D --> F[CometBFT Data Availability Layer]
A --> E[IPFS Data Storage Layer]
E --> I[Light Client Verification Layer]
I --> C[Ethereum Settlement Layer]
A --> K[IBC Interoperability Layer]
H <--> G[EWM Staking Contracts]
%% C --> L[Ethereum DA]
This repo provides the golang types for interacting with modular EWM-ProofChain (fully equipped for future independent PoS operation) blockchain node. It is currently a straightforward "proof state-machine replication" engine built to scale CXT validator - EWM data object metadata "proof" submissions, using a CometBFT (previously Tendermint Byzantine Fault Tolerant) consensus layer for node replication and peer-to-peer communication.
At a very high level, the choice to pick Cosmos was due to its ability to provide full flexibility in defining the state machine replication execution layer of ProofChain. Additionally, it allows for modularity and extensibility using Golang and Protocol Buffers. In simpler terms, it can also be described as an application-specific blockchain.
Decentralized applications built with smart contracts are inherently capped in performance by the underlying environment. For a DApp to optimize its performance, it should be built as an application-specific blockchain. This approach allows for the choice of a novel consensus engine such as CometBFT. Additionally, an application-specific blockchain does not compete with others for computation and storage. This contrasts with non-sharded virtual machine blockchains where smart contracts compete for block space, i.e., computation and storage. The virtual machine is the biggest throughput bottleneck in the state-machine replication process, significantly increasing the computational complexity of processing data.
graph TD
A[Transaction relayed from the full-node's CometBFT engine to the node's application via DeliverTx] --> B[ewmd]
B --> C[Using baseapp's methods: Decode the Tx, extract and route the messages]
C --> D[Message routed to the correct module to be processed]
D --> E[AUTH MODULE]
D --> F[BANK MODULE]
D --> G[STAKING MODULE]
D --> H[EWMD MODULE]
E --> I[Handle message, Update state]
F --> J[Handle message, Update state]
G --> K[Handle message, Update state]
H --> L[Handle message, Update state]
I --> M[Return result to CometBFT `0=Ok, 1=Err`]
J --> M
K --> M
L --> M
Hence the EWM (Ethereum Wayback Machine) Proofchain is a specialized blockchain designed to handle and verify proofs related to Ethereum and other blockchain networks. To interact with an ewm-proofchain node, you need to understand and utilize various types defined in the system. This document provides an overview of these types and their usage.
The LiveProofSession represents an active proof session in the system.
type LiveProofSession struct {
Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
ProofType string `protobuf:"bytes,3,opt,name=proofType,proto3" json:"proofType,omitempty"`
BlockHeight uint64 `protobuf:"varint,4,opt,name=blockHeight,proto3" json:"blockHeight,omitempty"`
BlockHash string `protobuf:"bytes,5,opt,name=blockHash,proto3" json:"blockHash,omitempty"`
ProofHash string `protobuf:"bytes,6,opt,name=proofHash,proto3" json:"proofHash,omitempty"`
StoreAddress string `protobuf:"bytes,7,opt,name=storeAddress,proto3" json:"storeAddress,omitempty"`
ProofCount int32 `protobuf:"varint,8,opt,name=proofCount,proto3" json:"proofCount,omitempty"`
SessionMembers string `protobuf:"bytes,9,opt,name=sessionMembers,proto3" json:"sessionMembers,omitempty"`
SessionDeadline string `protobuf:"bytes,10,opt,name=sessionDeadline,proto3" json:"sessionDeadline,omitempty"`
Finalized bool `protobuf:"varint,11,opt,name=finalized,proto3" json:"finalized,omitempty"`
Expired bool `protobuf:"varint,12,opt,name=expired,proto3" json:"expired,omitempty"`
Creator string `protobuf:"bytes,13,opt,name=creator,proto3" json:"creator,omitempty"`
BeforeIndex string `protobuf:"bytes,14,opt,name=beforeIndex,proto3" json:"beforeIndex,omitempty"`
AfterIndex string `protobuf:"bytes,15,opt,name=afterIndex,proto3" json:"afterIndex,omitempty"`
}Key fields:
Index: Unique identifier for the sessionChainId: ID of the chain the proof is forProofType: Type of proof being processedBlockHeight: Height of the block being provedProofHash: Hash of the proofSessionMembers: Participants in the proof sessionFinalized: Whether the session is finalizedExpired: Whether the session has expired
The StoredProofSession represents a completed and archived proof session.
type StoredProofSession struct {
Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
ProofType string `protobuf:"bytes,3,opt,name=proofType,proto3" json:"proofType,omitempty"`
BlockHeight uint64 `protobuf:"varint,4,opt,name=blockHeight,proto3" json:"blockHeight,omitempty"`
BlockHash string `protobuf:"bytes,5,opt,name=blockHash,proto3" json:"blockHash,omitempty"`
ProofHash string `protobuf:"bytes,6,opt,name=proofHash,proto3" json:"proofHash,omitempty"`
StoreAddress string `protobuf:"bytes,7,opt,name=storeAddress,proto3" json:"storeAddress,omitempty"`
ProofCount int32 `protobuf:"varint,8,opt,name=proofCount,proto3" json:"proofCount,omitempty"`
SessionMembers string `protobuf:"bytes,9,opt,name=sessionMembers,proto3" json:"sessionMembers,omitempty"`
ArchivedTimestamp string `protobuf:"bytes,10,opt,name=archivedTimestamp,proto3" json:"archivedTimestamp,omitempty"`
Finalized bool `protobuf:"varint,11,opt,name=finalized,proto3" json:"finalized,omitempty"`
Creator string `protobuf:"bytes,12,opt,name=creator,proto3" json:"creator,omitempty"`
}Key fields are similar to LiveProofSession, with the addition of:
ArchivedTimestamp: When the session was archived
StoredChainRole defines the roles assigned to various participants for a specific chain and proof type.
type StoredChainRole struct {
Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
ProofSequencer string `protobuf:"bytes,3,opt,name=proofSequencer,proto3" json:"proofSequencer,omitempty"`
ProofOperator string `protobuf:"bytes,4,opt,name=proofOperator,proto3" json:"proofOperator,omitempty"`
ProofValidator string `protobuf:"bytes,5,opt,name=proofValidator,proto3" json:"proofValidator,omitempty"`
ProofType string `protobuf:"bytes,6,opt,name=proofType,proto3" json:"proofType,omitempty"`
Creator string `protobuf:"bytes,7,opt,name=creator,proto3" json:"creator,omitempty"`
ValidatorStatus map[string]bool `protobuf:"bytes,8,rep,name=validatorStatus,proto3" json:"validatorStatus,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"varint,2,opt,name=value,proto3"`
OpValPair map[string]string `protobuf:"bytes,9,rep,name=opValPair,proto3" json:"opValPair,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
Timestamp string `protobuf:"bytes,10,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
}Key fields:
ChainId: ID of the chainProofSequencer,ProofOperator,ProofValidator: Addresses of role assigneesValidatorStatus: Map of validator statusesOpValPair: Map of operator-validator pairs
StoredChainConfig holds the configuration for a specific chain and proof type.
type StoredChainConfig struct {
Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
ProofType string `protobuf:"bytes,3,opt,name=proofType,proto3" json:"proofType,omitempty"`
SrcBlockTimeSec string `protobuf:"bytes,4,opt,name=srcBlockTimeSec,proto3" json:"srcBlockTimeSec,omitempty"`
SnkBlockTimeSec string `protobuf:"bytes,5,opt,name=snkBlockTimeSec,proto3" json:"snkBlockTimeSec,omitempty"`
QuorumReq int32 `protobuf:"varint,6,opt,name=quorumReq,proto3" json:"quorumReq,omitempty"`
RewardAlloc string `protobuf:"bytes,7,opt,name=rewardAlloc,proto3" json:"rewardAlloc,omitempty"`
MinStakeReq string `protobuf:"bytes,8,opt,name=minStakeReq,proto3" json:"minStakeReq,omitempty"`
MinSubmissionsReq int32 `protobuf:"varint,9,opt,name=minSubmissionsReq,proto3" json:"minSubmissionsReq,omitempty"`
SessionTimeSec string `protobuf:"bytes,10,opt,name=sessionTimeSec,proto3" json:"sessionTimeSec,omitempty"`
Creator string `protobuf:"bytes,11,opt,name=creator,proto3" json:"creator,omitempty"`
LiveMode bool `protobuf:"varint,12,opt,name=liveMode,proto3" json:"liveMode,omitempty"`
SyncBlockLimit uint64 `protobuf:"varint,13,opt,name=syncBlockLimit,proto3" json:"syncBlockLimit,omitempty"`
Timestamp string `protobuf:"bytes,14,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
SyncLagLimit uint64 `protobuf:"varint,15,opt,name=syncLagLimit,proto3" json:"syncLagLimit,omitempty"`
SyncBlockStart uint64 `protobuf:"varint,16,opt,name=syncBlockStart,proto3" json:"syncBlockStart,omitempty"`
BridgeTxDayFreq int32 `protobuf:"varint,17,opt,name=bridgeTxDayFreq,proto3" json:"bridgeTxDayFreq,omitempty"`
}Key fields include various configuration parameters like quorum requirements, reward allocations, and sync settings.
Messages are used to interact with the ewm-proofchain node. Here are some key message types:
Used to submit a new proof to the system.
type MsgCreateProof struct {
Creator string `protobuf:"bytes,1,opt,name=creator,proto3" json:"creator,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
ProofType string `protobuf:"bytes,3,opt,name=proofType,proto3" json:"proofType,omitempty"`
BlockHeight uint64 `protobuf:"varint,4,opt,name=blockHeight,proto3" json:"blockHeight,omitempty"`
BlockHash string `protobuf:"bytes,5,opt,name=blockHash,proto3" json:"blockHash,omitempty"`
ProofHash string `protobuf:"bytes,6,opt,name=proofHash,proto3" json:"proofHash,omitempty"`
StoreAddress string `protobuf:"bytes,7,opt,name=storeAddress,proto3" json:"storeAddress,omitempty"`
}Assigns a proof operator to a specific chain and proof type.
type MsgAssignProofOperator struct {
Creator string `protobuf:"bytes,1,opt,name=creator,proto3" json:"creator,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
OperatorAddress string `protobuf:"bytes,3,opt,name=operatorAddress,proto3" json:"operatorAddress,omitempty"`
ProofType string `protobuf:"bytes,4,opt,name=proofType,proto3" json:"proofType,omitempty"`
}Similar messages exist for assigning sequencers and validators.
Updates the configuration for a specific chain and proof type.
type MsgUpdateChainProofConfig struct {
Creator string `protobuf:"bytes,1,opt,name=creator,proto3" json:"creator,omitempty"`
ChainId int32 `protobuf:"varint,2,opt,name=chainId,proto3" json:"chainId,omitempty"`
ProofType string `protobuf:"bytes,3,opt,name=proofType,proto3" json:"proofType,omitempty"`
QuorumReq int32 `protobuf:"varint,4,opt,name=quorumReq,proto3" json:"quorumReq,omitempty"`
RewardAlloc string `protobuf:"bytes,5,opt,name=rewardAlloc,proto3" json:"rewardAlloc,omitempty"`
MinStakeReq string `protobuf:"bytes,6,opt,name=minStakeReq,proto3" json:"minStakeReq,omitempty"`
MinSubmissionsReq int32 `protobuf:"varint,7,opt,name=minSubmissionsReq,proto3" json:"minSubmissionsReq,omitempty"`
SessionTimeSec string `protobuf:"bytes,8,opt,name=sessionTimeSec,proto3" json:"sessionTimeSec,omitempty"`
LiveMode bool `protobuf:"varint,9,opt,name=liveMode,proto3" json:"liveMode,omitempty"`
}Queries are used to retrieve information from the ewm-proofchain node. Some important query types include:
Retrieves information about a specific live proof session.
rpc LiveProofSession(QueryGetLiveProofSessionRequest) returns (QueryGetLiveProofSessionResponse) {
option (google.api.http).get = "/covalenthq/ewm/ewm/live_proof_session/{index}";
}Retrieves all stored chain configurations.
message QueryAllStoredChainConfigRequest {
cosmos.base.query.v1beta1.PageRequest pagination = 1;
}The GenesisState defines the initial state of the ewm module.
type GenesisState struct {
Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"`
SystemInfo SystemInfo `protobuf:"bytes,2,opt,name=systemInfo,proto3" json:"systemInfo"`
LiveProofSessionList []LiveProofSession `protobuf:"bytes,3,rep,name=liveProofSessionList,proto3" json:"liveProofSessionList"`
StoredChainRoleList []StoredChainRole `protobuf:"bytes,4,rep,name=storedChainRoleList,proto3" json:"storedChainRoleList"`
StoredChainConfigList []StoredChainConfig `protobuf:"bytes,5,rep,name=storedChainConfigList,proto3" json:"storedChainConfigList"`
StoredProofSessionList []StoredProofSession `protobuf:"bytes,6,rep,name=storedProofSessionList,proto3" json:"storedProofSessionList"`
}It includes initial parameters, system info, and lists of live proof sessions, stored chain roles, configs, and proof sessions.
Here are some suggested diagrams to include:
- EWM-Proofchain Architecture
+-------------------+
| EWM-Proofchain |
| Node |
+-------------------+
|
+-------v-------+
| Core Types |
+---------------+
| LiveProofSession |
| StoredProofSession|
| StoredChainRole |
| StoredChainConfig |
+---------------+
|
+-------v-------+
| Interactions |
+---------------+
| Messages (Tx) |
| Queries |
+---------------+
- Proof Session Lifecycle
+------------+ +-----------------+ +------------------+
| CreateProof| --> | LiveProofSession| --> | StoredProofSession|
+------------+ +-----------------+ +------------------+
|
+------v------+
| Validation |
+-------------+
- Chain Role Assignment
+------------------+ +-------------------+
| AssignProofOperator| | |
| AssignProofValidator| --> | StoredChainRole |
| AssignProofSequencer| | |
+------------------+ +-------------------+
Here are some examples of how to use these types:
- Creating a new proof:
proof := types.NewMsgCreateProof(
creator,
chainId,
proofType,
blockHeight,
blockHash,
proofHash,
storeAddress,
)- Querying a live proof session:
request := &types.QueryGetLiveProofSessionRequest{
Index: sessionIndex,
}
response, err := queryClient.LiveProofSession(context.Background(), request)- Updating chain proof config:
msg := types.NewMsgUpdateChainProofConfig(
creator,
chainId,
proofType,
quorumReq,
rewardAlloc,
minStakeReq,
minSubmissionsReq,
sessionTimeSec,
liveMode,
)These examples demonstrate how to construct messages and queries using the defined types to interact with the ewm-proofchain node.
Remember to include proper error handling and context in your actual implementation.