Crate brk_server

BRK Server

A crate that serves Bitcoin data and swappable front-ends, built on top of brk_indexer, brk_computer and brk_query.

The file handler, will serve the website specified by the user if any, which can be no website, default or custom (which is a blank folder for people to experiment). If a website is specified and the server is ran outside of the brk project and thus can’t find the requested website, it will download the whole project with the correct version from Github and store it in .brk to be able to serve to website. This is due to the crate size limit on crates.io and the various shenanigans that need to be done to have a website in a crate.

The API uses brk_query and so inherites all of its features including formats.

Endpoints

API

GET /api/vecs/index-count

Count of all possible indexes

GET /api/vecs/id-count

Count of all possible ids

GET /api/vecs/variant-count

Count of all possible variants

GET /api/vecs/indexes

A list of all possible vec indexes and their accepted variants

GET /api/vecs/ids

A list of all possible vec ids

GET /api/vecs/variants

A list of all possible variants

GET /api/vecs/id-to-indexes

A list of all possible vec ids and their supported vec indexes

GET /api/vecs/index-to-ids

A list of all possible vec indexes and their supported vec ids

GET /api/{INDEX}-to-{ID}

This endpoint retrieves data based on the specified vector index and id.

Parameters:

Parameter	Type	Required	Description
from	signed int	No	Inclusive starting index for pagination (default is 0).
to	signed int	No	Exclusive ending index for pagination (default is the total number of results). Overrides count
count	unsigned int	No	The number of values requested
format	string	No	The format of the response. Options include json, csv, tsv, or md (default is json).

Examples:

GET /api/date-to-close
GET /date-to-close?from=-100
GET /date-to-close?count=100&format=csv

GET /api/query

This endpoint retrieves data based on the specified vector index and values.

Parameters:

Parameter	Type	Required	Description
index	VecIndex	Yes	The vector index to query.
values	VecId[]	Yes	A comma or space-separated list of vector IDs to retrieve.
from	signed int	No	Inclusive starting index for pagination (default is 0).
to	signed int	No	Exclusive ending index for pagination (default is the total number of results). Overrides count
count	unsigned int	No	The number of values requested
format	string	No	The format of the response. Options include json, csv, tsv, or md (default is json).

Examples:

GET /api/query?index=date&values=ohlc
GET /api/query?index=week&values=ohlc,block-interval-average&from=0&to=20&format=md

Meta

GET /version

The version of the server and thus BRK.

Files

GET /*

Catch all.

When no pattern is found, the server will look for a match inside the folder of the chosen website, if any.

Example

use std::{path::Path, thread::sleep, time::Duration};

use bitcoincore_rpc::RpcApi;
use brk_computer::Computer;
use brk_core::default_bitcoin_path;
use brk_exit::Exit;
use brk_fetcher::Fetcher;
use brk_indexer::Indexer;
use brk_parser::Parser;
use brk_server::{Server, Website};
use brk_vec::{Computation, Format};

pub fn main() -> color_eyre::Result<()> {
    color_eyre::install()?;

    brk_logger::init(Some(Path::new(".log")));

    let process = true;

    let bitcoin_dir = default_bitcoin_path();

    let rpc = Box::leak(Box::new(bitcoincore_rpc::Client::new(
        "http://localhost:8332",
        bitcoincore_rpc::Auth::CookieFile(bitcoin_dir.join(".cookie")),
    )?));
    let exit = Exit::new();

    let parser = Parser::new(bitcoin_dir.join("blocks"), rpc);

    let outputs_dir = Path::new("../../_outputs");

    let format = Format::Compressed;

    let mut indexer = Indexer::new(outputs_dir, true)?;
    indexer.import_stores()?;
    indexer.import_vecs()?;

    let fetcher = Some(Fetcher::import(None)?);

    let mut computer = Computer::new(outputs_dir, fetcher, format);
    computer.import_stores(&indexer)?;
    computer.import_vecs(&indexer, Computation::Lazy)?;

    tokio::runtime::Builder::new_multi_thread()
        .enable_all()
        .build()?
        .block_on(async {
            let served_indexer = indexer.clone();
            let served_computer = computer.clone();

            let server = Server::new(served_indexer, served_computer, Website::Default)?;

            let server = tokio::spawn(async move {
                server.serve().await.unwrap();
            });

            if process {
                loop {
                    let block_count = rpc.get_block_count()?;

                    let starting_indexes = indexer.index(&parser, rpc, &exit)?;

                    computer.compute(&mut indexer, starting_indexes, &exit)?;

                    while block_count == rpc.get_block_count()? {
                        sleep(Duration::from_secs(1))
                    }
                }
            }

            #[allow(unreachable_code)]
            server.await.unwrap();

            Ok(())
        }) as color_eyre::Result<()>
}

Structs

AppState

Server

Enums

Website

Constants

VERSION