https://github.com/AbdelStark/besu-storage-redis

Besu Redis key value store plugin
https://github.com/AbdelStark/besu-storage-redis

Last synced: 3 months ago
JSON representation

Besu Redis key value store plugin

• Host: GitHub
• URL: https://github.com/AbdelStark/besu-storage-redis
• Owner: AbdelStark
• License: apache-2.0
• Created: 2020-03-04T09:14:06.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-09T06:38:37.000Z (over 4 years ago)
• Last Synced: 2024-11-14T05:34:25.625Z (3 months ago)
• Language: Java
• Size: 144 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-besu - Besu Storage Redis - Besu Redis Key/Value store plugin. (Plugins)

README

        
# Besu Redis Key value store plugin

## Use case

Using a Redis cluster as a storage engine for Besu enables to specify multiple types of Besu nodes depending on the features. This approach would allow us to have optimized nodes for query the database. RocksDB's lock mechanism makes harder to have multiple instances of Besu accessing the same database. Redis on the other hand enables this use case, we can imagine a categorisation of Besu nodes like the following:

- **besu-tx**: Handling of local transaction pool.

- **besu-sync**: Handling of blockchain synchronisation through Ethereum P2P network. 

- **besu-query**: Handling of database queries.

## Architecture

![architecture](./src/main/resources/architecture.png)

## Usage

### Start Redis server.

Using docker compose:

```shell script

docker-compose -f ./docker/redis.yml up -d

```

Redis + Web UI

```shell script

docker-compose -f ./docker/redis.yml -f ./docker/redis-ui.yml up -d

```

Go to http://127.0.0.1:8081

Remove Redis volume:

```shell script

docker volume rm -f docker_redis_data

```

### Build Redis plugin

```shell script

./gradlew assemble

```

### Start Besu with the redis storage plugin.

```shell script

./besu.sh --key-value-storage=redis-storage --plugin-redis-storage-host=localhost --plugin-redis-storage-port=6379

```