BnkrWheel Documentation

BnkrWheel is a web interface that helps you configure automated buyback behavior for Base ecosystem tokens through BANKR-compatible local tooling. The UI is designed to keep setup simple, while execution and sensitive operations remain under your direct control in your own local environment.

This page explains how the interface works, how the command generation behaves, how to tune buyback parameters, and what security assumptions are built into the current version.

2. System Architecture

The current project is split into two primary pages:

  • Main site: product presentation, protocol explanation, feature highlights, and entry points to launch the bot screen.
  • Documentation site: this long-form guide with architecture, process notes, and operational recommendations.

Frontend stack and structure:

  • Vite as the build and dev server.
  • Static HTML + CSS + JavaScript (no framework required for the current UI).
  • Assets served from /public for deterministic paths in both development and production builds.

3. Requirements

To run and use the interface effectively, prepare the following:

  • Node.js 18+ recommended.
  • npm installed and available in your shell.
  • BANKR tooling/CLI installed and authenticated where required.
  • A target token contract address on Base.
  • A strategy for minimum execution thresholds and interval cadence.

4. Quick Start

  1. Install dependencies: npm install
  2. Run local development server: npm run dev
  3. Open the project URL displayed by Vite.
  4. Click any Launch Bot button to open the full bot configuration screen.
  5. Fill token, interval, threshold, and network values.
  6. Copy the generated command and run it in your local terminal environment.

5. Bot Screen Configuration

The bot screen is now full-page to improve readability and workflow continuity. It includes:

  • Token Contract Address: the token the strategy should buy back.
  • Buyback Interval: how often checks and potential execution are evaluated.
  • Minimum WETH Balance: threshold before buyback logic should trigger.
  • Network: currently configured for Base.
  • Generated Command: updated dynamically as form values change.

The screen intentionally avoids direct wallet key input. It is a config UI, not a signer.

6. Execution Flow

Conceptually, the strategy follows this loop:

  1. Read protocol fee state or claimable amount.
  2. Evaluate available balance against configured minimum threshold.
  3. When threshold conditions are met, execute buy action via the configured route.
  4. Wait for next interval and repeat.

In this interface, that behavior is represented as generated command parameters. The actual execution lifecycle remains local and tool-driven.

7. Parameter Guide

Token Address

Use a verified contract address. Invalid or wrong-chain addresses can cause failures or unexpected purchases.

Interval

Short intervals increase responsiveness but may lead to more frequent calls and higher cumulative gas overhead.

Minimum WETH

Set this to avoid small or inefficient swaps. A sensible threshold helps reduce fragmented execution and improves strategy quality.

Network

Base-only for now. Keep your runtime tooling and RPC configuration aligned with this setting.

8. Operational Guide

Recommended production-like workflow:

  • Start with conservative thresholds and moderate intervals.
  • Run in observation mode first to verify timing and generated command behavior.
  • Monitor logs for failed swaps, slippage events, or temporary RPC instability.
  • Tune threshold and interval after observing at least several execution windows.
  • Store credentials in local environment variables, not in frontend fields.

Good operational hygiene:

  • Keep Node, dependencies, and CLI tools updated.
  • Pin the runtime environment for reproducibility.
  • Document your strategy presets per token and market regime.

9. Security Model

The frontend does not request, store, or transmit private keys. Sensitive signing actions should happen through local wallet tooling or secured CLI execution paths.

Security principles used in this project:

  • No private key input in UI forms.
  • No browser persistence of signing secrets.
  • Execution performed locally from generated command context.
  • User-controlled runtime and key management outside the web layer.

10. Troubleshooting

Problem: Command is generated but execution fails.

  • Check Node/BANKR installation and shell PATH.
  • Validate token contract format and chain compatibility.
  • Confirm network RPC and account permissions.

Problem: The app runs but styles look broken.

  • Ensure assets exist in /public.
  • Hard-refresh browser cache.
  • Rebuild with npm run build and verify output.

Problem: Copy button works inconsistently on some environments.

  • Use HTTPS or localhost context for clipboard APIs.
  • Fallback to manual selection when browser policy restricts clipboard calls.

11. FAQ

Can I run this without exposing my private key?

Yes. That is the intended model. Use local wallet tooling or env-based secrets outside the UI.

Does this page execute transactions directly?

No. The page prepares configuration and command parameters. Runtime execution is external.

Can I support additional networks?

The current interface is Base-focused, but extending the network selector is straightforward in the next iteration.

12. Current Status and Roadmap

The current release includes a complete landing page, a full bot configuration screen, and this dedicated docs page.

Planned next-step improvements:

  • Preset profiles for interval and threshold strategies.
  • Optional runtime status panel integration.
  • More advanced docs with architecture diagrams and examples.
  • Expanded troubleshooting matrix for RPC and execution edge cases.
Back to top