README
¶
Monomer
Monomer uses the OP stack to make Cosmos applications deployable as Ethereum rollups.
⚠ Monomer is pre-production software and should be used with caution. ⚠
At a Glance
From the OP stack's perspective, Monomer replaces the default Ethereum compatible execution engine. From the Cosmos application's perspective, Monomer replaces the CometBFT consensus layer.
Development
We use Go 1.22. To run the e2e tests, you'll need the foundry tools and the submodules (git submodule update --init --recursive).
The Makefile includes commands for running tests and generating coverage profiles.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidForkchoiceUpdateResult ¶
func ValidForkchoiceUpdateResult(headBlockHash *common.Hash, id *engine.PayloadID) *opeth.ForkchoiceUpdatedResult
ValidForkchoiceUpdateResult returns a valid ForkchoiceUpdateResult with given head block hash.
Types ¶
type Application ¶
type Application interface {
// Info/Query Connection
Info(abcitypes.RequestInfo) abcitypes.ResponseInfo // Return application info
Query(req abcitypes.RequestQuery) (res abcitypes.ResponseQuery)
// Mempool Connection
CheckTx(abcitypes.RequestCheckTx) abcitypes.ResponseCheckTx // Validate a tx for the mempool
// Consensus Connection
InitChain(abcitypes.RequestInitChain) abcitypes.ResponseInitChain // Initialize blockchain w validators/other info from CometBFT
BeginBlock(abcitypes.RequestBeginBlock) abcitypes.ResponseBeginBlock // Signals the beginning of a block
DeliverTx(abcitypes.RequestDeliverTx) abcitypes.ResponseDeliverTx // Deliver a tx for full processing
EndBlock(abcitypes.RequestEndBlock) abcitypes.ResponseEndBlock // Signals the end of a block, returns changes to the validator set
Commit() abcitypes.ResponseCommit // Commit the state and return the application Merkle root hash
RollbackToHeight(uint64) error
}
type Block ¶
func (*Block) ToCometLikeBlock ¶
func (*Block) ToEthLikeBlock ¶
This trick is played by the eth rpc server too. Instead of constructing an actual eth block, simply create a map with the right keys so the client can unmarshal it into a block
type CosmosTxAdapter ¶
type CosmosTxAdapter func(cosmosTxs bfttypes.Txs) (ethtypes.Transactions, error)
CosmosTxAdapter transforms Cosmos transactions into Ethereum transactions.
In practice, this will use msg types from Monomer's rollup module, but importing the rollup module here would create a circular module dependency between Monomer, the SDK, and the rollup module. sdk -> monomer -> rollup -> sdk, where -> is "depends on".
type Header ¶
type PayloadAttributes ¶
type PayloadAttributes struct {
Timestamp uint64
PrevRandao [32]byte
SuggestedFeeRecipient common.Address
Withdrawals *ethtypes.Withdrawals
NoTxPool bool
GasLimit uint64
ParentBeaconBlockRoot *common.Hash
ParentHash common.Hash
Height int64
Transactions []hexutil.Bytes
CosmosTxs bfttypes.Txs
// contains filtered or unexported fields
}
func (*PayloadAttributes) ID ¶
func (p *PayloadAttributes) ID() *engine.PayloadID
ID returns a PaylodID (a hash) from a PayloadAttributes when it's applied to a head block. Hashing does not conform to go-ethereum/miner/payload_building.go PayloadID is only calculated once, and cached for future calls.
type PayloadTxAdapter ¶
PayloadTxAdapter transforms Op payload transactions into Cosmos transactions.
In practice, this will use msg types from Monomer's rollup module, but importing the rollup module here would create a circular module dependency between Monomer, the SDK, and the rollup module. sdk -> monomer -> rollup -> sdk, where -> is "depends on".
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
x
|
|
|
rollup/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |