bittensor-sentinel 0.2.0

No project description provided

sentinel

    

Sentinel is a blockchain data extraction and monitoring tool designed to work with the Bittensor network.

Features:

• Extract extrinsics, events, and hyperparameters from Bittensor blockchain.
• Provides both a Python library and a command-line interface (CLI) for ease of use.

Installation

pip install bittensor-sentinel

Usage

[!IMPORTANT] This package uses ApiVer, make sure to import sentinel.v1.

As a library

from sentinel.v1.providers.bittensor import bittensor_provider
from sentinel.v1.services.extractors.extrinsics import get_hyperparam_extrinsics
from sentinel.v1.services.sentinel import sentinel_service

provider = bittensor_provider()
service = sentinel_service(provider)
block = service.ingest_block(resolved_block)
for extrinsic in block.extrinsics:
    print(extrinsic)

Pylon integration

Sentinel can be easily integrated with Pylon for advanced data processing and analysis.

1. Run a Pylon instance (see Pylon documentation).
2. Specify the Pylon integration when creating the Sentinel service:

from sentinel.v1.integrations.pylon import pylon_integration

integration = pylon_integration(pylon_url="http://localhost:8000")
service = sentinel_service(provider, integrations=[integration])

CLI

$ sentinel --help


Usage: sentinel [OPTIONS] COMMAND [ARGS]...

Sentinel CLI - Blockchain data extraction and monitoring tool.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --format              -f      [table|json]  Output format. [default: table]  │
│ --install-completion                        Install completion for the       │
│                                             current shell.                   │
│ --show-completion                           Show completion for the current  │
│                                             shell, to copy it or customize   │
│                                             the installation.                │
│ --help                                      Show this message and exit.      │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ extrinsics    Read extrinsics from a blockchain block.                       │
│ events        Read events from a blockchain block.                           │
│ hyperparams   Read hyperparameters for a subnet at a specific block.         │
│ block         Block-related commands.                                        │
╰──────────────────────────────────────────────────────────────────────────────╯

Versioning

This package uses Semantic Versioning. TL;DR you are safe to use compatible release version specifier ~=MAJOR.MINOR in your pyproject.toml or requirements.txt.

Additionally, this package uses ApiVer to further reduce the risk of breaking changes. This means, the public API of this package is explicitly versioned, e.g. sentinel.v1, and will not change in a backwards-incompatible way even when sentinel.v2 is released.

Internal packages, i.e. prefixed by sentinel._ do not share these guarantees and may change in a backwards-incompatible way at any time even in patch releases.

Development

Pre-requisites:

• uv
• nox
• docker and docker compose plugin

Ideally, you should run nox -t format lint before every commit to ensure that the code is properly formatted and linted. Before submitting a PR, make sure that tests pass as well, you can do so using:

nox -t check # equivalent to `nox -t format lint test`

If you wish to install dependencies into .venv so your IDE can pick them up, you can do so using:

uv sync --all-extras --dev

Release process

Run nox -s make_release -- X.Y.Z where X.Y.Z is the version you're releasing and follow the printed instructions.