Installation

The bundler package is implemented in Go and is open source at github.com/stackup-wallet/stackup-bundler.

📘

Looking for a fully managed instance for your project instead?

Use our hosted services to get set up with a bundler in 2 minutes 🚀

Via go install

Make sure to have your environment variables configured before running the client. See the configuration page for details.

Install

To get the latest version:

go install github.com/stackup-wallet/stackup-bundler@latest

Alternatively, if you're looking for an older version:

# See github.com/stackup-wallet/stackup-bundler/releases for version releases
go install github.com/stackup-wallet/[email protected]

Running the bundler

🚧

Full access to a node is required.

A bundler should be considered as an extension, or a side-car, to a full node. It requires full access to the node's debug API for custom JS tracing. Most RPC providers do not support this.

For maximum performance, it is also recommended to run the bundler in the same machine as the node.

Run an instance in private mode:

stackup-bundler start --mode private

For a description on the CLI commands and other supported modes:

stackup-bundler start --help