CLI Tool (yqctl)

yqctl is the command-line tool for interacting with the YoorQuezt MEV engine. It provides subcommands for bundle management, auction monitoring, transaction protection, intent submission, relay management, and system health checks.

Installation

go install github.com/yoorquezt-labs/yqctl/cmd/yqctl@latest

Subcommands

CommandSubcommandDescription
bundlesubmitSubmit a bundle to the MEV engine
bundlegetGet a submitted bundle by ID
auctionView current auction pool
protectsubmitSubmit a transaction with MEV protection
protectstatusCheck protection status by tx ID
intentsubmitSubmit a new intent
intentgetGet intent by ID
relayregisterRegister a new relay
relaylistList connected relays
relaystatsShow relay marketplace statistics
blocksList recent blocks and landed bundles
bundlesList stored bundles
watchLive-stream events (auction, blocks, mempool, protect, intents)
healthCheck engine and gateway health
orderflowsummaryOrderflow statistics

Usage Examples

Bundle Operations

# Submit a bundle
yqctl bundle submit \
  --tx '0xsigned_tx_1' \
  --tx '0xsigned_tx_2' \
  --bid 1000000000000000 \
  --target-block 19482300 \
  --chain ethereum

# Get bundle by ID
yqctl bundle get 0xbundle_hash_here

# List all stored bundles
yqctl bundles

Auction

# View current auction pool
yqctl auction

Transaction Protection

# Protect a transaction
yqctl protect submit \
  --from 0xYourAddress \
  --to 0xContractAddress \
  --payload 0xcalldata \
  --value 0 \
  --chain ethereum

# Check protection status
yqctl protect status 0xtx_id_here

Intent Operations

# Submit an intent
yqctl intent submit \
  --type swap \
  --chain ethereum \
  --token-in 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 \
  --token-out 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 \
  --amount-in 1500000000000000000 \
  --min-out 3000000000

# Get intent by ID
yqctl intent get intent_abc123

Relay Management

# Register a relay
yqctl relay register \
  -url https://relay.example.com \
  -name my-relay \
  -owner 0xOwnerAddress \
  -stake 1000000000000000000 \
  -chains ethereum,arbitrum

# List connected relays
yqctl relay list

# Relay statistics
yqctl relay stats

Blocks and Monitoring

# Recent blocks
yqctl blocks

# Live event stream (topics: auction, blocks, mempool, protect, intents)
yqctl watch auction
yqctl watch blocks

# Health check
yqctl health

# Orderflow summary
yqctl orderflow summary

Configuration

Environment Variables

VariableDescriptionDefault
YQMEV_GATEWAYGateway WebSocket URLws://localhost:9099/ws
YQCTL_API_KEYAPI key for authentication(none)

CLI flags -gw (gateway URL) and -key (API key) override environment variables.

Global Flags

FlagShortDescription
--gw-gGateway WebSocket URL
--key-kAPI key / bearer token
--help-hShow help
Edit this page