This repository has been archived by the owner on Jun 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from primevprotocol/ckartik/preconf-protocol-impl
Rough Implementation of Pre-Confirmations
- Loading branch information
Showing
8 changed files
with
565 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| vendor | ||
| **/.idea | ||
| **/.vscode | ||
| **/.vscode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| package preconfirmation | ||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/ecdsa" | ||
| "errors" | ||
| "math/big" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/primevprotocol/mev-commit/pkg/p2p" | ||
| "github.com/primevprotocol/mev-commit/pkg/p2p/msgpack" | ||
| "github.com/primevprotocol/mev-commit/pkg/structures/preconf" | ||
| "github.com/primevprotocol/mev-commit/pkg/topology" | ||
| ) | ||
|
|
||
| const ( | ||
| ProtocolName = "preconfirmation" | ||
| ProtocolVersion = "1.0.0" | ||
| ) | ||
|
|
||
| type Preconfirmation struct { | ||
| signer preconf.Signer | ||
| topo Topology | ||
| streamer p2p.Streamer | ||
| cs CommitmentsStore | ||
| us UserStore | ||
| } | ||
|
|
||
| type Topology interface { | ||
| GetPeers(topology.Query) []p2p.Peer | ||
| } | ||
|
|
||
| func New(topo Topology, streamer p2p.Streamer, key *ecdsa.PrivateKey, us UserStore, cs CommitmentsStore) *Preconfirmation { | ||
| return &Preconfirmation{ | ||
| topo: topo, | ||
| streamer: streamer, | ||
| signer: preconf.PrivateKeySigner{PrivKey: key}, | ||
| us: us, | ||
| cs: cs, | ||
| } | ||
| } | ||
|
|
||
| func (p *Preconfirmation) Protocol() p2p.ProtocolSpec { | ||
| return p2p.ProtocolSpec{ | ||
| Name: ProtocolName, | ||
| Version: ProtocolVersion, | ||
| StreamSpecs: []p2p.StreamSpec{ | ||
| { | ||
| Name: "bid", | ||
| Handler: p.handleBid, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // BidHash -> map of preconfs | ||
| // Key: BidHash | ||
| // Value: List of preconfs | ||
| // var commitments map[string][]preconf.PreconfCommitment | ||
| type CommitmentsStore interface { | ||
| GetCommitments(bidHash []byte) ([]preconf.PreconfCommitment, error) | ||
| AddCommitment(bidHash []byte, commitment *preconf.PreconfCommitment) error | ||
| } | ||
|
|
||
| type UserStore interface { | ||
| CheckUserRegistred(*common.Address) bool | ||
| } | ||
|
|
||
| // SendBid is meant to be called by the searcher to construct and send bids to the builder. | ||
| // It takes the txnHash, the bid amount in wei and the maximum valid block number. | ||
| // It waits for commitments from all builders and then returns. | ||
| // TODO(@ckartik): construct seperate go-routine to wait for commitments, with a context that cancels if a timeout is reached. | ||
| // | ||
| // It returns an error if the bid is not valid. | ||
| func (p *Preconfirmation) SendBid(ctx context.Context, txnHash string, bidamt *big.Int, blockNumber *big.Int) error { | ||
| signedBid, err := preconf.ConstructSignedBid(bidamt, txnHash, blockNumber, p.signer) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| builders := p.topo.GetPeers(topology.Query{Type: p2p.PeerTypeBuilder}) | ||
|
|
||
| // TODO(@ckartik): Push into a channel and process in parallel | ||
| for _, builder := range builders { | ||
| // Create a new connection | ||
| builderStream, err := p.streamer.NewStream(ctx, builder, ProtocolName, ProtocolVersion, "bid") | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| r, w := msgpack.NewReaderWriter[preconf.PreconfCommitment, preconf.PreConfBid](builderStream) | ||
| err = w.WriteMsg(ctx, signedBid) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| commitment, err := r.ReadMsg(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Process commitment as a searcher | ||
| _, err = commitment.VerifyBuilderSignature() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| _, err = commitment.VerifySearcherSignature() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Verify the bid details correspond. | ||
| err = p.cs.AddCommitment(signedBid.BidHash, commitment) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| var ErrInvalidSearcherTypeForBid = errors.New("invalid searcher type for bid") | ||
|
|
||
| // handlebid is the function that is called when a bid is received | ||
| // It is meant to be used by the builder exclusively to read the bid value from the searcher. | ||
| func (p *Preconfirmation) handleBid( | ||
| ctx context.Context, | ||
| peer p2p.Peer, | ||
| stream p2p.Stream, | ||
| ) error { | ||
| if peer.Type != p2p.PeerTypeSearcher { | ||
| return ErrInvalidSearcherTypeForBid | ||
| } | ||
|
|
||
| // TODO(@ckartik): Change to reader only once availble | ||
| r, w := msgpack.NewReaderWriter[preconf.PreConfBid, preconf.PreconfCommitment](stream) | ||
| bid, err := r.ReadMsg(ctx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| ethAddress, err := bid.VerifySearcherSignature() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if p.us.CheckUserRegistred(ethAddress) { | ||
| // More conditional Logic to determine signing of bid | ||
| commitment, err := preconf.ConstructCommitment(*bid, p.signer) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return w.WriteMsg(ctx, commitment) | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| package preconfirmation_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "math/big" | ||
| "sync" | ||
| "testing" | ||
|
|
||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/crypto" | ||
| "github.com/primevprotocol/mev-commit/pkg/p2p" | ||
| p2ptest "github.com/primevprotocol/mev-commit/pkg/p2p/testing" | ||
| "github.com/primevprotocol/mev-commit/pkg/preconfirmation" | ||
| "github.com/primevprotocol/mev-commit/pkg/structures/preconf" | ||
| "github.com/primevprotocol/mev-commit/pkg/topology" | ||
| ) | ||
|
|
||
| type testTopo struct { | ||
| mu sync.Mutex | ||
| peers []p2p.Peer | ||
| } | ||
|
|
||
| func (t *testTopo) AddPeers(peers ...p2p.Peer) { | ||
| t.mu.Lock() | ||
| defer t.mu.Unlock() | ||
|
|
||
| t.peers = append(t.peers, peers...) | ||
| } | ||
|
|
||
| func (t *testTopo) GetPeers(q topology.Query) []p2p.Peer { | ||
| t.mu.Lock() | ||
| defer t.mu.Unlock() | ||
|
|
||
| return []p2p.Peer{{EthAddress: common.HexToAddress("0x2"), Type: p2p.PeerTypeBuilder}} | ||
| } | ||
|
|
||
| func (t *testTopo) Connected(p2p.Peer) { | ||
| } | ||
|
|
||
| func (t *testTopo) Disconnected(p2p.Peer) { | ||
| } | ||
|
|
||
| type testCommitmentStore struct { | ||
| } | ||
|
|
||
| func (t *testCommitmentStore) GetCommitments(bidHash []byte) ([]preconf.PreconfCommitment, error) { | ||
| return []preconf.PreconfCommitment{}, nil | ||
| } | ||
|
|
||
| func (t *testCommitmentStore) AddCommitment(bidHash []byte, commitment *preconf.PreconfCommitment) error { | ||
| return nil | ||
| } | ||
|
|
||
| type testUserStore struct { | ||
| } | ||
|
|
||
| func (t *testUserStore) CheckUserRegistred(_ *common.Address) bool { | ||
| return true | ||
| } | ||
|
|
||
| func TestPreconfBidSubmission(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| t.Run("ok", func(t *testing.T) { | ||
| client := p2p.Peer{ | ||
| EthAddress: common.HexToAddress("0x1"), | ||
| Type: p2p.PeerTypeSearcher, | ||
| } | ||
| server := p2p.Peer{ | ||
| EthAddress: common.HexToAddress("0x2"), | ||
| Type: p2p.PeerTypeBuilder, | ||
| } | ||
|
|
||
| svc := p2ptest.New( | ||
| &client, | ||
| ) | ||
|
|
||
| topo := &testTopo{} | ||
| us := &testUserStore{} | ||
| cs := &testCommitmentStore{} | ||
| key, _ := crypto.GenerateKey() | ||
| p := preconfirmation.New(topo, svc, key, us, cs) | ||
|
|
||
| // svc.SetPeerHandler(client, p.Protocol()) | ||
| svc.SetPeerHandler(server, p.Protocol()) | ||
|
|
||
| err := p.SendBid(context.Background(), "0x4c03a845396b770ad41b975d6bd3bf8c2bd5cca36867a3301f9598f2e3e9518d", big.NewInt(10), big.NewInt(10)) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| }) | ||
| } |
Oops, something went wrong.