Skip to content

Commit

Permalink
refactoring README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnaudBger committed Feb 15, 2024
1 parent 4b3a88b commit 624981b
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 15 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.DS_Store
/substreams/blockmeta-service-v0.1.0.spkg
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# BlockMeta Service

Welcome to the main repository of our project. This repository is organized into two main sub-repositories, each dedicated to a specific component of the project.
For detailed information on each component, please refer to the respective `README.md` files within the sub-repositories.
This repository provides all the keys to run a block meta service that provides high-level data on blocks, for any blockchain supported by StreamingFast.
To make such a service, you will have to extract block meta data first, store them in a kv store and then serve it.

## Sub-Repositories
## Extracting and Storing data

### Server
To extract block meta data, you will need `substreams_spkg_path`. In order to get this package path, please visit the [substreams](./substreams/README.md).
Then you will need to run a substreams-sink-kv server, please refer to the [substreams-sink-kv](https://github.com/streamingfast/substreams-sink-kv)
repository that explains how to do so.

For information specific on the server, see the `README.md` in the `server` directory:
This server will then be able to extract block meta data from the substreams and store it in a key-value store.

- **Location**: [server/README.md](./server/README.md)
- **Contents**: This README contains details on how to run a server which provides block meta data, and some examples queries and responses when querying this server.
## Serving data

### Substreams
To serve block meta data, first be sure you have a substreams-sink-kv server running.
Then, you can run a block-meta server referring to the [block-meta documentation](./server/README.md).

For information specific on the project's substreams, consult the `README.md` in the `substreams` directory:

- **Location**: [substreams/README.md](./substreams/README.md)
- **Contents**: This README provides details on the substreams created for this project.
7 changes: 4 additions & 3 deletions server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ convert block IDs to block numbers, fetch the latest block information, and quer

## Running

To run a block-meta server, you can use the `blockmeta` binary.
The following command will start a block-meta server which will listen a specified address and will be connected to a specified sink-server
from which it will extract the block metadata.
Running a block-meta server, uses the `blockmeta` binary.
In order to run properly, the server has to be connected to a [substreams-sink-kv](https://github.com/streamingfast/substreams-sink-kv) server.
To connect to the sink server, you can provide the substreams-sink-kv server address within the `--sink-addr` flag.
The server will then connect to the sink server and start listening for gRPC requests on the address provided in the `--grpc-listen-addr` flag.

```bash
blockmeta --sink-addr localhost:9000 --grpc-listen-addr localhost:50051
Expand Down
9 changes: 9 additions & 0 deletions substreams/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# BlockMeta Substreams
This substreams provides high level information on block data for any blockchain supported by StreamingFast.
block number, hash or id and timestamp are the information provided by this substreams.

## Substreams package
- BlockMeta Substreams package is available here [releases](https://github.com/streamingfast/blockmeta-service/releases/)
- Package can also be built from source by running `make pack` in the substreams directory.

for more information on the substreams package, please visit the [substreams documentation](https://substreams.streamingfast.io/documentation/develop/)

0 comments on commit 624981b

Please sign in to comment.