Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/aurora-is-near/near-rpc-speedup

This repository provides a guide on how to set up and deploy the near-rpc-speedup project, which enhances the efficiency of NEAR protocol RPC nodes through caching. It includes step-by-step instructions for deploying two critical services using Docker and docker-compose
https://github.com/aurora-is-near/near-rpc-speedup

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/aurora-is-near/near-rpc-speedup
Owner: aurora-is-near
Created: 2024-06-07T11:54:01.000Z (7 months ago)
Default Branch: master
Last Pushed: 2024-07-15T22:05:39.000Z (6 months ago)
Last Synced: 2024-07-16T02:23:09.963Z (6 months ago)
Language: Shell
Size: 2.93 KB
Stars: 1
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# NEAR RPC Speedup Project

## Introduction

The `near-rpc-speedup` project is designed to enhance the efficiency of NEAR protocol RPC nodes by introducing a cache storage mechanism. This added communication layer enables faster distribution of chunks among nodes, optimizing data exchange and improving overall network performance.

This repository contains deployment information on two critical services:
- [**Caching Proxies Cache**](https://github.com/aurora-is-near/caching-proxies-cache): A web service facilitating chunk retrieval.
- [**Caching Proxies Terminal**](https://github.com/aurora-is-near/caching-proxies-terminal): Manages the submission of chunks to the cache.

## Deployment Guide

This guide walks you through deploying these services on your machine (where the validators are located) and outlines the necessary setup changes.

### Services Overview

Both services are written in Go. The recommended deployment method is to build both services using the provided Dockerfiles and deploy them using `docker-compose`. Docker is required for this setup.

### Docker Deployment (Recommended)

Using Docker and `docker-compose` is the preferred method for deploying these services due to its simplicity and ease of use. Below is a brief explanation of the provided `docker-compose` configuration.

#### Docker Compose Configuration for Testnet

```yaml
services:
cache:
image: caching-proxies-cache:latest
container_name: caching-proxies-cache-testnet
pull_policy: never
command:
- "./app/app"
- "-shard-prefix=shards"
- "-shards-to-listen=1,2,3,4,5,6"
- "-creds=config/testnet.creds"
- "-server=nats://rpc-speedup-nats.testnet.aurora.dev"
volumes:
- ./config:/app/config
restart: unless-stopped
ports:
- "1324:1324"

terminal:
image: caching-proxies-terminal:latest
container_name: caching-proxies-terminal-testnet
pull_policy: never
command:
- "./app/app"
- "-server=nats://rpc-speedup-nats.testnet.aurora.dev"
- "-submissions-verifier-host=https://rpc-speedup-verifier.testnet.aurora.dev/authenticate"
- "-shard-prefix=shards"
volumes:
- ./config:/app/config
restart: unless-stopped
ports:
- "1323:1323"
```

### Step-by-Step Setup Guide

1. **Clone the Repository and Create Config Directory**
```bash
git clone https://github.com/aurora-is-near/near-rpc-speedup.git
cd near-rpc-speedup
mkdir -p config
```

2. **Build the Docker Images**
Run the `build.sh` script to build the Docker images for `caching-proxies-cache` and `caching-proxies-terminal` services.
```bash
./build.sh
```

3. **Obtain Authentication Credentials**
Request a `token` and `testnet.creds` file to authenticate with the validator and allow your cache instance to communicate with the NATS server. Contact Aurora Labs to obtain these credentials.

4. **Place the `testnet.creds` file**
Place the `testnet.creds` file obtained from Aurora Labs into the `config` directory.

5. **Start the Services**
Use the following command to start the services:
```bash
docker-compose up -d --force-recreate
# or
./start.sh
```

6. **Integrate with NEAR Validator Node**
Modify the `config.json` of the NEAR node to include the following configuration:
```json
"chunk_distribution_network": {
"enabled": true,
"uris": {
"get": "http://caching-proxies-cache-testnet:1324/get",
"set": "http://caching-proxies-terminal-testnet:1323/process?token=[token]"
}
}
```
> **Important:** Replace `caching-proxies-cache-testnet` and `caching-proxies-terminal-testnet` with the actual hostname or IP address where the services are running. With Docker container setup, it could be as simple as `http://0.0.0.0`. Replace `[token]` with the token provided in step 3.

Example of a valid piece of `config.json` :
```json
{
...
"chunk_distribution_network": {
"enabled": true,
"uris": {
"get": "http://0.0.0.0:1324/get",
"set": "http://0.0.0.0:1323/process?token=ccc111ccc111ccc111ccc111"
}
}
...
}
```

7. **Restart the NEAR Node**
Restart the NEAR node to apply the changes.

### NEAR Core Version Requirement
It is mandatory that the version of NEAR Core is at least 1.40.0-rc.1 to ensure compatibility with the near-rpc-speedup project. Please update your NEAR Core version if necessary.
### Update

To update the services to the latest version, you can run the following command:
```bash
./update.sh
```
This will rebuild the Docker images and restart the services.