View Code? Open in Web Editor NEW

This project forked from 0xsequence/bundler

ERC5189 p2p transaction bundler

JavaScript 0.14% Go 89.43% TypeScript 4.60% Makefile 0.77% Dockerfile 0.25% Solidity 4.80%

bundler's Introduction

ERC-5189 Mempool Bundler

Work in progress

This project is in the early stages of development and is not yet ready for production use.

Feature	Status
P2P Sharing of operations	✅ Implemented
Mempool limits (global and per-dependency)	✅ Implemented
Endorser reputation tracking	🔄 Partial
Untrusted env support (see 5189)	🔄 Partial
Simulation settings	✅ Implemented
Archival generation and broadcast	✅ Implemented
Metrics	✅ Implemented
Debug methods fallback to Anvil	✅ Implemented
Embedded sender	🔄 Partial
ERC20 Token fees support	🔄 Partial
Receipt Fetching	❌ Not implemented

Overview

The project is a mempool transaction bundler for general purpose "operations". The project uses ERC-5189 as the reference standard for how the operations are defined and how they should be handled. The project includes a built-in sender, but it is designed to be used with a separate sender (or block builder).

Usage

Create a copy of the /etc/bundler-node.conf.sample file and name it /etc/bundler-1.conf.
(Optional) Generate a random 12-word mnemonic and put it in the mnemonic field in the /etc/bundler-1.conf file.
Define the number of senders to run num_senders in the /etc/bundler-1.conf file.
Run with make run.

Consuming the API

The API can be consumed using the client that can be found in the /proto/client directory. Note that the API is not yet stable and is subject to change.