You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
galactus c6f2d52278
Merge pull request #211 from blockworks-foundation/galactus_change_logs_21_09_2023
7 hours ago
.github/workflows spit validator test 3 days ago
bench removing unwanted file 3 weeks ago
benches use postitional_arg helper 6 months ago
cd Deploy QUIC Proxy (#187) 2 weeks ago
cluster-endpoints implementing history, block storage method 12 hours ago
core implementing history, block storage method 12 hours ago
docs change consensus domain name to validator and simplify schema 7 days ago
history implementing history, block storage method 12 hours ago
lite-rpc implementing history, block storage method 12 hours ago
migrations implement parsing of compute budget instructions (#123) 5 months ago
quic-forward-proxy Merge pull request #168 from blockworks-foundation/groovie/tpu-proxy-improved-docs 1 week ago
quic-forward-proxy-integration-test Merge pull request #204 from blockworks-foundation/fixing_blockhash_valid_checks 12 hours ago
services implementing history, block storage method 12 hours ago
tests Revert "Block Listner Channel Fix (#137)" 5 months ago
.dockerignore Add docker build, fly config 8 months ago
.gitignore optimized create_n_users bench and ignore out.json 6 months ago
CHANGELOG.md Updating changelog.md 11 hours ago
Cargo.lock implementing history, block storage method 12 hours ago
Cargo.toml implementing history, block storage method 12 hours ago
Dockerfile removing quic forward proxy from the fly 2 weeks ago
LICENSE switch to AGPL 6 months ago
README.md Merge pull request #168 from blockworks-foundation/groovie/tpu-proxy-improved-docs 1 week ago
fly.toml removing quic forward proxy from the fly 2 weeks ago
jest.config.js typescript tests 9 months ago
package-lock.json add MAX_RECENT_BLOCKHASSHES and some logs (#49) 7 months ago
package.json random string 6 months ago
rust-toolchain.toml add rust-toolchain.toml with rust 1.70.0 3 days ago
test.bash minor fixed in test.bash 3 days ago
tsconfig.json add MAX_RECENT_BLOCKHASSHES and some logs (#49) 7 months ago
yarn.lock random string 6 months ago

README.md

Lite RPC For Solana Blockchain

Submitting a transaction to be executed on the solana blockchain, requires the client to identify the next few leaders based on the leader schedule, look up their peering information in gossip and connect to them via the quic protocol. In order to simplify the process so it can be triggered from a web browser, most applications run full validators that forward the transactions according to the protocol on behalf of the web browser. Running full solana validators is incredibly resource intensive (>256GB RAM), the goal of this project would be to create a specialized micro-service that allows to deploy this logic quickly and allows horizontal scalability with commodity vms. Optionally the Lite RCP micro-services can be configured to send the transactions to a complementary QUIC forward proxy instead of the solana tpu (details).

Confirmation strategies

  1. Subscribe to new blocks using blockSubscribe
  2. Subscribing to signatures with pool of rpc servers. (Under development)
  3. Listening to gossip protocol. (Future roadmap)

Executing

make sure solana-validator is running in the background with --rpc-pubsub-enable-block-subscription

run using

$ cargo run --release

to know about command line options

$ cargo run --release -- --help

Test and Bench

Make sure both solana-validator and lite-rpc is running

test

$ cargo test

bench

$ cd bench and cargo run --release

Find a new file named metrics.csv in the project root.

Deployment

Environment Variables

env purpose required?
RPC_URL HTTP URL for a full RPC node yes, for docker
WS_URL WS URL for a full RPC node yes, for docker
IDENTITY Staked validator identity keypair no
PG_ENABLED Set to anything but 'false' to enable Postgres no
PG_CONFIG Postgres Connection Config if postgres enabled
CA_PEM_B64 Base64 encoded ca.pem if postgres enabled
CLIENT_PKS_B64 Base64 encoded client.pks if postgres enabled
CLIENT_PKS_PASS Password to client.pks if postgres enabled

Postgres

lite-rpc implements an optional postgres service that can write to postgres database tables as defined in ./migrations. This can be enabled by either setting the environment variable PG_ENABLED to true or by passing the -p option when launching the executable. If postgres is enabled then the optional environment variables shown above must be set.

Metrics

Various Prometheus metrics are exposed on localhost:9091/metrics which can be used to monitor the health of the application in production. Grafana dashboard coming soon!

Deployment on fly.io

While lite-rpc can be deployed on any cloud infrastructure, it has been tested extensively on https://fly.io. An example configuration has been provided in fly.toml. We recommend a dedicated-cpu-2x VM with at least 4GB RAM.

The app listens by default on ports 8890 and 8891 for HTTP and Websockets respectively. Since only a subset of RPC methods are implemented, we recommend serving unimplemented methods from a full RPC node using a reverse proxy such as HAProxy or Kong. Alternatively, you can connect directly to lite-rpc using a web3.js Connection object that is only used for sending and confirming transactions.

Example

fly apps create my-lite-rpc
fly secrets set -a my-lite-rpc RPC_URL=... WS_URL=...   # See above table for env options
fly scale vm dedicated-cpu-2x --memory 4096 -a my-lite-rpc
fly deploy -a my-lite-rpc --remote-only # To just launch lite-rpc
fly deploy -c cd/lite-rpc.toml -a my-lite-rpc --remote-only # To launch lite-rpc with proxy mode

Copyright (c) 2022 Blockworks Foundation

Licensed under the AGPL-3.0 license