mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-06-10 15:03:32 -07:00
readme: update
This commit is contained in:
@@ -14,7 +14,7 @@
|
||||
|
||||
## Description
|
||||
|
||||
While [mempool.space](https://mempool.space) gives a very micro view of the network where you can follow the journey of any address, this tool is the exact opposite and very complimentary by giving you a much more global/macro view of the flow and various dynamics of the network via thousands of charts.
|
||||
While [mempool.space](https://mempool.space) gives a very detailed view of the network where you can follow the journey of any address, this tool is the exact opposite and very complimentary by giving you a much more global/macro view of the flow and various dynamics of the network via thousands of charts.
|
||||
|
||||
To promote even more transparency and trust in the network, this project is committed to making on-chain data accessible and verifiable by all, no matter your intentions or financial situation. That is why, the whole project is completely free, from code to services, including a real-time API with thousands and thousands of routes which can be used at will.
|
||||
|
||||
@@ -36,7 +36,7 @@ If you're a potential sponsor, feel free to contact me in Nostr !
|
||||
|
||||
## Warning
|
||||
|
||||
This project is in a very early stage. Until more people look at the code and check the various computations, the datasets might be in the worst case completely false.
|
||||
This project is in a very early stage. Until more people look at the code and check the various computations in it, the datasets might be, in the worst case, completely false.
|
||||
|
||||
## Instances
|
||||
|
||||
@@ -63,53 +63,70 @@ Coming soon
|
||||
|
||||
### Manual
|
||||
|
||||
#### 1. Dependencies
|
||||
|
||||
First we need to install Rust
|
||||
First we need to install Rust (https://www.rust-lang.org/tools/install)
|
||||
|
||||
```bash
|
||||
# Source: https://www.rust-lang.org/tools/install
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
```
|
||||
|
||||
Then we need to `cargo-watch` for the server
|
||||
If you already had Rust installed you could update it just in case
|
||||
|
||||
```bash
|
||||
rustup update
|
||||
```
|
||||
|
||||
Optionally, you can also install `cargo-watch` for the server to automatically restart it on file change, which will be triggered by new code and new datasets from the parser (https://github.com/watchexec/cargo-watch?tab=readme-ov-file#install)
|
||||
|
||||
```bash
|
||||
# Source: https://github.com/watchexec/cargo-watch?tab=readme-ov-file#install
|
||||
cargo install cargo-watch --locked
|
||||
```
|
||||
|
||||
#### 2. Git
|
||||
Then you need to choose a path where all files related to **kibō** will live
|
||||
|
||||
```bash
|
||||
git clone https://github.com/satonomics-org/satonomics.git
|
||||
|
||||
cd satonomics
|
||||
cd ???
|
||||
```
|
||||
|
||||
#### 3. Parser
|
||||
We can now clone the repository
|
||||
|
||||
```bash
|
||||
cd parser
|
||||
git clone https://github.com/kibo-money/kibo.git
|
||||
```
|
||||
|
||||
# The first run needs several information about your bitcoin-core config
|
||||
In a new terminal, go to the `parser`'s folder of the repository
|
||||
|
||||
```bash
|
||||
cd ???/kibo/parser
|
||||
```
|
||||
|
||||
Now we can finally start by running the parser, you need to use the `./run.sh` script instead of `cargo run -r` as we need to set various system variables for the program to run smoothly
|
||||
|
||||
For the first launch, the parser will need several information such as:
|
||||
- `--datadir`: which is bitcoin data directory path
|
||||
- `--rpcuser`: the username of the RPC credentials to talk to the bitcoin server
|
||||
- `--rpcpassword`: the password of the RPC credentials
|
||||
|
||||
Everything will be saved in a `config.toml` file, which will allow you to simply run `./run.sh` next time
|
||||
|
||||
Here's an example
|
||||
|
||||
```bash
|
||||
./run.sh --datadir=$HOME/Developer/bitcoin --rpcuser=satoshi --rpcpassword=nakamoto
|
||||
|
||||
# Next time you can just do: ./run.sh
|
||||
# As everything is saved in
|
||||
|
||||
cd ..
|
||||
```
|
||||
|
||||
#### Server
|
||||
In a new terminal, go to the `server`'s folder of the repository
|
||||
|
||||
```bash
|
||||
cd server
|
||||
cd ???/kibo/server
|
||||
```
|
||||
|
||||
And start it also with the `run.sh` script instead of `cargo run -r`
|
||||
|
||||
```bash
|
||||
./run.sh
|
||||
```
|
||||
|
||||
Then the easiest to let others access your server is with `cloudflared` which will also cache requests.
|
||||
Then the easiest to let others access your server is to use `cloudflared` which will also cache requests. For more information go to: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/
|
||||
|
||||
## Philosophy
|
||||
|
||||
@@ -140,12 +157,13 @@ The orange background is a wink to Bitcoin and when in a circle, it also represe
|
||||
## Roadmap
|
||||
|
||||
- **More Datasets/Charts**: If a dataset can be computed, it should exist and have its related charts
|
||||
- **Simulations**: Such as DCA simulation over a period of time with various strategies
|
||||
- **Dashboards**: For a quick and real-time view of the latest data of all the datasets
|
||||
- **Nostr integration**: First to save preferences, later to add some social functionnality
|
||||
- **Datasets by block timestamp**: In addition to having datasets by date and height
|
||||
- **Descriptions**: Add text to describe all charts and what they mean
|
||||
- **Start9 support**: By making the whole suite much easier to self-host, it's quite rough right now
|
||||
- **API Documentation**: Highly needed to explain what's what
|
||||
- **Datasets by block timestamp**: In addition to having datasets by date and height
|
||||
|
||||
## Infrastructure
|
||||
|
||||
|
||||
Reference in New Issue
Block a user