Skip to content

Commit

Permalink
Address review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
2opremio committed Nov 14, 2024
1 parent d96d571 commit ba93ed2
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 57 deletions.
6 changes: 6 additions & 0 deletions docs/data/rpc/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: RPC Introduction
sidebar_position: 5
---

:::info

Stellar-RPC was previously known as Soroban-RPC. Soroban-RPC was renamed as Stellar-RPC in Nov 2024.

:::

The Stellar-RPC can be described as a "live network gateway for Soroban." It provides information that the network currently has in its view (i.e. current state). It also has the ability to send a transaction to the network, and query the network for the status of previously sent transactions. It is meant to be simple, minimal, scalable, and familiar to blockchain developers from other ecosystems.

Stellar-RPC should provide all the basic data that a dapp developer would need, provided they are:
Expand Down
22 changes: 11 additions & 11 deletions docs/data/rpc/admin-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Now you can replace `--network standalone` with `--network futurenet` (or whatev
We recommend the following ways to deploy your own RPC instance:

1. Deploy to Kubernetes using [Helm](https://helm.sh/docs/intro/install/)
2. Run the [stellar-rpc docker image](https://hub.docker.com/r/stellar/soroban-rpc) directly
2. Run the [stellar-rpc docker image](https://hub.docker.com/r/stellar/stellar-rpc) directly

### Hardware Requirements

Expand Down Expand Up @@ -182,7 +182,7 @@ helm repo update stellar
3. Deploy the RPC instance to Kubernetes using [our Helm chart](https://github.com/stellar/helm-charts/blob/main/charts/soroban-rpc):

```bash
helm install my-rpc stellar/soroban-rpc \
helm install my-rpc stellar/stellar-rpc \
--namespace my-rpc-namespace-on-cluster \
--set global.image.sorobanRpc.tag=20.0.0-rc4-40 \
--set sorobanRpc.ingress.host=myrpc.example.org \
Expand All @@ -194,7 +194,7 @@ helm install my-rpc stellar/soroban-rpc \

This example of Helm chart usage highlights some key aspects:

- Set the `global.image.sorobanRpc.tag` to a tag from the [stellar-rpc dockerhub repo](https://hub.docker.com/r/stellar/soroban-rpc) for the image version you want to run. Refer to [the software versions page](/docs/networks/software-versions) to find the correct tag for the Soroban release you are running.
- Set the `global.image.sorobanRpc.tag` to a tag from the [stellar-rpc dockerhub repo](https://hub.docker.com/r/stellar/stellar-rpc) for the image version you want to run. Refer to [the software versions page](/docs/networks/software-versions) to find the correct tag for the Soroban release you are running.

- The RPC server stores a revolving window of recent data from network ledgers to disk. The size of that data varies depending on the network and its transaction volumes, but it has an estimated range between 10 to 100 MB. To ensure the RPC pod has consistent access to disk storage space and read/write throughput, this example demonstrates how to optionally enable the Helm chart deployment to use a `PersistentVolumeClaim` (PVC) of 100MB from `default` storage class on Kubernetes by enabling these persistence parameters:

Expand Down Expand Up @@ -227,7 +227,7 @@ By default, this is disabled (`sorobanRpc.persistence.enabled=false`) and the RP
Even if you're not deploying Stellar RPC using Kubernetes, the manifests generated by the charts may still be a good reference for showing how to configure and run Stellar RPC as a docker container. Just run the `helm template` command to print the container configuration to screen:

```bash
helm template my-rpc stellar/soroban-rpc
helm template my-rpc stellar/stellar-rpc
```

### Docker Image
Expand All @@ -240,12 +240,12 @@ Although we have a [Quickstart Image](https://github.com/stellar/quickstart), it

:::

Here's how to run the [stellar-rpc docker image](https://hub.docker.com/r/stellar/soroban-rpc):
Here's how to run the [stellar-rpc docker image](https://hub.docker.com/r/stellar/stellar-rpc):

1. Pull the image at the version you'd like to run from [the tags](https://hub.docker.com/r/stellar/soroban-rpc/tags):
1. Pull the image at the version you'd like to run from [the tags](https://hub.docker.com/r/stellar/stellar-rpc/tags):

```bash
docker pull stellar/soroban-rpc
docker pull stellar/stellar-rpc
```

2. Create a configuration file for [Stellar Core](https://github.com/stellar/stellar-core). Here is a sample configuration file for Testnet:
Expand Down Expand Up @@ -289,7 +289,7 @@ HISTORY="curl -sf http://history.stellar.org/prd/core-testnet/core_testnet_003/{

```bash
docker run -p 8001:8001 -p 8000:8000 \
-v <STELLAR_CORE_CONFIG_FOLDER>:/config stellar/soroban-rpc \
-v <STELLAR_CORE_CONFIG_FOLDER>:/config stellar/stellar-rpc \
--captive-core-config-path="/config/<STELLAR_CORE_CONFIG_PATH>" \
--captive-core-storage-path="/var/lib/stellar/captive-core" \
--captive-core-use-db=true \
Expand All @@ -305,18 +305,18 @@ docker run -p 8001:8001 -p 8000:8000 \

#### Configuration

For production, we recommend running Stellar RPC with a [TOML](https://toml.io/en/) configuration file rather than CLI flags. This is similar to creating a configuration file for Stellar-Core as we did previously. For example, using [our docker image](https://hub.docker.com/r/stellar/soroban-rpc):
For production, we recommend running Stellar RPC with a [TOML](https://toml.io/en/) configuration file rather than CLI flags. This is similar to creating a configuration file for Stellar-Core as we did previously. For example, using [our docker image](https://hub.docker.com/r/stellar/stellar-rpc):

```bash
docker run -p 8001:8001 -p 8000:8000 \
-v <CONFIG_FOLDER>:/config stellar/soroban-rpc \
-v <CONFIG_FOLDER>:/config stellar/stellar-rpc \
--config-path <RPC_CONFIG_FILENAME>
```

You can use Stellar RPC itself to generate a starter configuration file:

```bash
docker run stellar/soroban-rpc gen-config-file > stellar-rpc-config.toml
docker run stellar/stellar-rpc gen-config-file > soroban-rpc-config.toml
```

The resulting configuration should look like this:
Expand Down
Loading

0 comments on commit ba93ed2

Please sign in to comment.