Skip to main content

Python-based ABCI server for CometBFT

Project description

xian-abci

xian-abci is the CometBFT-facing Xian node application. It owns deterministic chain behavior, ABCI request handling, state export and restore flows, and node-adjacent services such as BDS and the optional dashboard.

The published PyPI package name is xian-tech-abci. The console entrypoints remain xian-abci, xian-dashboard, and the other xian-* commands exposed by this repo.

Quick Start

Run the ABCI application:

uv run xian-abci

Run the optional dashboard against a local CometBFT RPC endpoint:

uv run xian-dashboard --rpc-url http://127.0.0.1:26657

Inspect the backend-oriented CLI surface:

uv run xian-configure-node --help
uv run xian-export-state --help
uv run xian-state-snapshot --help

Principles

  • xian-abci owns deterministic node behavior and backend primitives, not the full operator UX.
  • Process supervision, Docker topology, and operator workflows belong in xian-stack, xian-cli, or external tooling such as systemd.
  • BDS, metrics, snapshots, and the dashboard are part of the node-adjacent runtime surface, but the core ABCI path should remain understandable without them.
  • Consensus-sensitive behavior belongs in reusable code, not ad hoc scripts or one-off operator commands.

How It Fits

  • use xian-abci when you need the actual node application or backend-oriented node tooling
  • use xian-cli when you want the operator-facing UX around manifests, profiles, health, and recovery flows
  • use xian-stack when you want the local Docker/Compose runtime and smoke flows
  • use xian-deploy when you want remote Linux host deployment

Key Directories

  • src/xian/methods/: ABCI request handlers and query surfaces
  • src/xian/services/: BDS, dashboard, metrics, state sync, and related services
  • src/xian/cli/: backend-oriented command entrypoints owned by this repo
  • src/xian/: node setup helpers, state export/import, and shared runtime code
  • scripts/: repo validation and protobuf generation helpers
  • tests/: unit, integration, governance, and system coverage

What It Covers

  • deterministic transaction processing and block finalization
  • node queries and simulation
  • state export, state snapshots, and state sync helpers
  • node setup, home configuration, and genesis-building primitives
  • BDS indexing and optional dashboard services
  • backend-oriented CLI entrypoints such as:
    • xian-configure-node
    • xian-export-state
    • xian-state-snapshot
    • xian-bds-reindex
    • xian-bds-snapshot
    • xian-bds-spool

Validation

UV_CACHE_DIR=/tmp/uv-cache uv sync --group dev
./scripts/validate-repo.sh

The BDS-backed test paths expect Postgres at postgres://postgres:1234@localhost:5432/xian.

Related Docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xian_tech_abci-0.8.4.tar.gz (168.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xian_tech_abci-0.8.4-py3-none-any.whl (246.4 kB view details)

Uploaded Python 3

File details

Details for the file xian_tech_abci-0.8.4.tar.gz.

File metadata

  • Download URL: xian_tech_abci-0.8.4.tar.gz
  • Upload date:
  • Size: 168.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xian_tech_abci-0.8.4.tar.gz
Algorithm Hash digest
SHA256 887ff8157c6e31cfba24b7e8c088c2b5e27080dc11e0062f191b56fecc80d90c
MD5 25f73cd7a87b3a5f6ede098d64b77370
BLAKE2b-256 b81cc306b27821bb668461b4f22884ec968016d5fc1af53cf97f685ac8ad0c25

See more details on using hashes here.

Provenance

The following attestation bundles were made for xian_tech_abci-0.8.4.tar.gz:

Publisher: release.yml on xian-technology/xian-abci

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xian_tech_abci-0.8.4-py3-none-any.whl.

File metadata

  • Download URL: xian_tech_abci-0.8.4-py3-none-any.whl
  • Upload date:
  • Size: 246.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xian_tech_abci-0.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 033bae84291fdf389374fdf28a806247a7ff16f8649f54061b159587d36638fd
MD5 801756e664f48a6f8ede944bcfb3b245
BLAKE2b-256 61cff871126baa530088650572d8f9658746f5358b13979974342922e74c95a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for xian_tech_abci-0.8.4-py3-none-any.whl:

Publisher: release.yml on xian-technology/xian-abci

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page