Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/archway-network/cosmologger

Cosmologger listens to the NewBlock and TX events of a cosmos based network and logs the acquire information in a database for further usage.
https://github.com/archway-network/cosmologger

Last synced: 4 days ago
JSON representation

Cosmologger listens to the NewBlock and TX events of a cosmos based network and logs the acquire information in a database for further usage.

Host: GitHub
URL: https://github.com/archway-network/cosmologger
Owner: archway-network
License: apache-2.0
Created: 2022-01-28T19:43:48.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-05-25T14:54:40.000Z (over 2 years ago)
Last Synced: 2024-08-01T13:26:49.250Z (3 months ago)
Language: Go
Homepage:
Size: 160 KB
Stars: 1
Watchers: 6
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-ccamel - archway-network/cosmologger - Cosmologger listens to the NewBlock and TX events of a cosmos based network and logs the acquire information in a database for further usage. (Go)

README

# cosmologger
This is a logger tool that collects blocks and transactions as they are happening in a cosmos based network.

## Install
The best way to install it is to do it through a bundle called [testnet-evaluator](https://github.com/archway-network/testnet-evaluator/).

## Development

To have a development environment just run the following commands:
```bash
git clone [email protected]:archway-network/cosmologger.git
cd cosmologger
docker-compose up -d --build
```

Then enter the shell of the running dev-container:

```bash
docker exec -it cosmologger sh
```

To build and try:

```bash
clear && go build . && ./cosmologger
```

## Configuration

### ENV Variables

* **RPC_ADDRESS**: indicates the address to the RPC server
* **GRPC_ADDRESS**: indicates the address to the GRPC server
* **GRPC_TLS**: if you use TLS (ssl) security layer, this must be `true`

* **POSTGRES_DB**: The name of `postgres` database
* **POSTGRES_USER**: Database username
* **POSTGRES_PASSWORD**: Password for the database user
* **POSTGRES_PORT**: Port number of the database
* **POSTGRES_HOST**: Host address of the server running postgres

**Note**: `cosmologger` creates all the database schema on its first run, so make sure the database user has enough privilege to create tables and indexes.

### Config file
There is a `config.json` file, which has to be mapped into the app directory of the container. i.e. be in the same path of the executable.

Here is what is inside the conf file:

```json
{
"grpc":{
"api_call_retry": 20,
"call_timeout": 30
},

"tendermint_client": {
"subscriber_name":"cosmologger",
"connect_retry": 60
},

"bech32_prefix" : {
"account" :{
"address": "archway",
"pubkey": "archway"
},
"validator" :{
"address": "archwayvaloper",
"pubkey": "archwayvaloperpub"
},
"consensus" :{
"address": "archwayvalcons",
"pubkey": "archwayvalconspub"
}
}
}
```

`grpc` keeps the GRPC configs:

* `api_call_retry`: Since API calls sometimes fails due to network load or some other reasons, `cosmologger` tries multiple times to get the results. This parameter tells how many times it can try.
* `call_timeout`: GRPC API timeout

```json
"grpc":{
"api_call_retry": 20,
"call_timeout": 30
}
```

`tendermint_client` keeps the RPC configs

* `subscriber_name` is the arbitrary RPC subscriber
* `connect_retry` indicates how many times `cosmologger` should try to connect to the RPC server if it is not available. This feature comes handy when the RPC server is not ready yet. `cosmologger` waits a second before every trial.

```json
"tendermint_client": {
"subscriber_name":"cosmologger",
"connect_retry": 60
}
```

`bech32_prefix` Keeps the prefixes of the addresses and keys, it has to be configured according to the network configs that is being used.

```json
"bech32_prefix" : {
"account" :{
"address": "archway",
"pubkey": "archway"
},
"validator" :{
"address": "archwayvaloper",
"pubkey": "archwayvaloperpub"
},
"consensus" :{
"address": "archwayvalcons",
"pubkey": "archwayvalconspub"
}
}
```