flareforge-cli 0.2.0

FlareForge CLI: FDC mock proofs, FTSOv2 backtests, FAssets risk from the terminal.

flareforge-cli

Terminal companion for FlareForge. Generates mock Flare Data Connector proofs for Foundry/Hardhat tests, simulates FTSOv2 data-provider strategies against mainnet consensus, and queries live FAssets liquidation risk. Everything hits the public flareforge.io API, no auth, no API key.

Install

pipx install flareforge-cli
flareforge --version

Prefer pip? pip install flareforge-cli works the same, just not isolated.

Quickstart

# Oracle Lab
flareforge oracle feeds
flareforge oracle backtest \
    --feed-id 0x014254432f55534400000000000000000000000000 \
    --source kraken:8:1.0 \
    --source binance:6:1.5 \
    --aggregation weighted_mean \
    --hours 720

# FAssets risk (live from flareforge.io indexer)
flareforge agents risk

# CrossChain Sandbox — offline FDC proofs for local tests
flareforge sandbox init
flareforge sandbox types
flareforge sandbox generate Payment --source XRP --field transactionId=0x01
flareforge sandbox run scenarios.yaml

Commands

Oracle Lab

Command	Purpose
flareforge oracle feeds	Table of every active FTSOv2 feed with its latest value.
flareforge oracle backtest --feed-id X --source NAME:JITTER_BPS:WEIGHT [...] [--aggregation ...] [--hours N]	Simulate a data-provider strategy against hours of mainnet consensus. Prints tier A / B / OUT rate, reward score, median deviation. See the API guide for the full request shape.

FAssets Agent Monitor

Command	Purpose
flareforge agents risk	Aggregate liquidation-risk summary (safe / warning / danger / critical / unknown) plus worst offenders, computed from vault collateral cushion over mintingCR. See the Python guide for Discord webhook integration.

CrossChain Sandbox (FDC mocks)

Command	Purpose
flareforge sandbox init [DIR]	Copy a starter scenarios.yaml into DIR (cwd by default).
flareforge sandbox types	List every attestation type the sandbox can mock.
flareforge sandbox generate TYPE --source SRC [--field K=V ...] [--out FILE]	Generate one mock proof, print or write JSON. Covers Payment, EVMTransaction, AddressValidity, ConfirmedBlockHeightExists.
flareforge sandbox run PATH	Run every scenario in scenarios.yaml and print a pass/fail table. CI-friendly: exits non-zero on any failure.

Every command accepts --endpoint URL to target a self-hosted FlareForge backend instead of https://flareforge.io/api.

scenarios.yaml schema

endpoint: https://flareforge.io/api   # optional, overrides the default host

scenarios:
  - name: fasset-mint-payment-xrp
    type: Payment                     # attestation type_id
    source: XRP                       # source chain id
    params:
      transactionId: "0x..."          # request body fields
      inUtxo: 0
      utxo: 0

Five templates ship inside the package (FAssets mint, FAssets redemption, AddressValidity, ConfirmedBlockHeightExists, EVMTransaction). Drop one with flareforge sandbox init.

Links

• Dashboard: flareforge.io
• Written guides: flareforge.io/docs — full FTSOv2, FAssets, and FDC walkthroughs covering the same endpoints this CLI wraps.
• Changelog: flareforge.io/changelog + Atom feed.

Local development

git clone <your-fork> flareforge
cd flareforge/cli
uv pip install -e '.[dev]'
pytest
ruff check .
mypy src

License

Business Source License 1.1. See LICENSE for the full text. In short: free for non-production use and evaluation; production use of the hosted FlareForge services is the licensor's exclusive right until the conversion date, after which the code reverts to Apache 2.0.