transeptor bundler

A light weight blazing fast, modular ERC4337 TypeScript bundler built with functional programming.

transeptorlabs
26
4
TypeScript

A lightweight, blazing-fast, modular ERC-4337 TypeScript bundler built with functional programming

Node Version TypeScript codecov ESM Supported Docker pulls

⚠️ Please note that while the software is fully functional, it is important to know that it may contain bugs and incomplete features and undergo frequent updates.

Quick Start

To quickly start using Transeptor, follow the instructions in our Quick Start guide.

Development

Prerequisites

Follow these instructions to get the project up and running on your local machine for development purposes:

  1. git submodule update --init
  2. Use the correct node version nvm use
  3. Add PRIVATE_KEY to the contracts/.env file to deploy the entrypoint contract locally.
  4. Install dependencies yarn install
  5. Start local geth node and geth-tracer-node: yarn local-eth
    • Deploys the entrypoint contract to the local network.
    • Please wait for environment vars to be printed in the console and copy it to your .env files.
  6. In a new terminal window, start the bundler node in dev mode with a live watch for changes in the ./src path with auto restarts. There are three different dev modes:
    • yarn dev - To start the bundler node in safe mode with full storage and opcode checks.
    • yarn dev:unsafe - To start the bundler node in unsafe mode with no storage or opcode checks.
    • yarn dev:native-tracer - To start the bundler node in safe mode with full storage and opcode checks enabled by the native tracer.
  • The bundler node will start on http://localhost:4337/rpc.

Test

Run the test suite.

yarn test

Run an e2e script to send a userOp through the bundler.

yarn send-op

Lint

yarn lint
yarn lint:fix

Running Transeptor

Transeptor offers multiple options for installation and configuration. Refer to the Running Transeptor guide for details.

Node Configuration

For detailed configuration options, including command-line arguments and environment variables, visit the Node Configuration guide.

Contribute

We welcome contributions to enhance our ERC-4337 Bundler. Please follow our contribution guidelines..

Contact Us

If you have any questions or feedback about Transeptor, reach out to us:.

License

Licensed under the GPL-3.0 License.

Acknowledgements

We appreciate the open-source community and those who have shared their knowledge, enabling us to build on their work:

  • Infinitism - for inspiring our project and serving as a reference for implementation techniques.

Relevant Documents