Skip to content

Commit 479cc1d

Browse files
authored
Rename Soroban RPC to Stellar RPC (#1064)
1 parent 143aee6 commit 479cc1d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+149
-143
lines changed

config/sidebars.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const sidebars: SidebarsConfig = {
2323
'data/README',
2424
'data/requirements',
2525
{ type: 'html', value: '<small>Data Availability</small>', defaultStyle: true, className: 'networkMenuHtmlItem'},
26-
{ type: 'ref', id: 'data/rpc/README', label: 'Soroban RPC'},
26+
{ type: 'ref', id: 'data/rpc/README', label: 'Stellar RPC'},
2727
{ type: 'ref', id: 'data/hubble/README', label: 'Hubble'},
2828
{ type: 'ref', id: 'data/horizon/README', label: 'Horizon'},
2929
{ type: 'ref', id: 'data/galexie/README', label: 'Galexie'},
@@ -91,7 +91,7 @@ const sidebars: SidebarsConfig = {
9191
soroban_rpc: [
9292
{
9393
type: "category",
94-
label: "Soroban RPC",
94+
label: "Stellar RPC",
9595
items: [
9696
{
9797
type: 'autogenerated',

docs/build/guides/basics/automate-reset-data.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Stellar operates two primary testing environments: the [Testnet and the Futurene
2222

2323
## What is the Testnet and Futurenet reset?
2424

25-
Testnet and Futurenet are reset periodically to the genesis ledger to declutter the network, remove spam, reduce the time needed to catch up on the latest ledger, and help maintain the system. These resets take place approximately quarterly. Resets clear all ledger entries (accounts, trustlines, offers, smart contract data, etc.), transactions, and historical data from Stellar Core, Horizon, and the Soroban RPC, which is why developers should not rely on the persistence of accounts or the state of any balances when using Testnet or Futurenet.
25+
Testnet and Futurenet are reset periodically to the genesis ledger to declutter the network, remove spam, reduce the time needed to catch up on the latest ledger, and help maintain the system. These resets take place approximately quarterly. Resets clear all ledger entries (accounts, trustlines, offers, smart contract data, etc.), transactions, and historical data from Stellar Core, Horizon, and the Stellar RPC, which is why developers should not rely on the persistence of accounts or the state of any balances when using Testnet or Futurenet.
2626

2727
You can check current reset dates [here](../../../learn/fundamentals/networks.mdx#testnet-and-futurenet-data-reset).
2828

docs/build/guides/conventions/extending-wasm-ttl.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This guide will show you how to extend the TTL of a deployed contract's Wasm cod
1414
## Prerequisites
1515

1616
- Stellar SDK: `npm install @stellar/stellar-sdk`
17-
- A Soroban RPC endpoint (e.g., `https://soroban-testnet.stellar.org`)
17+
- A Stellar RPC endpoint (e.g., `https://soroban-testnet.stellar.org`)
1818
- Basic knowledge of Stellar SDK
1919

2020
## Process overview

docs/build/guides/dapps/docker.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ The `quickstart.sh` script sets up the Docker environment for running the dapp.
131131
- Creates the Docker network named `soroban-network` if it doesn't exist.
132132
- Removes any existing `soroban-preview` Docker container.
133133
- Runs the `soroban-preview` container, which provides the Soroban Preview environment for development.
134-
- Runs the `stellar/quickstart` Docker image, which sets up the Stellar network using the chosen network type and enables Soroban RPC.
134+
- Runs the `stellar/quickstart` Docker image, which sets up the Stellar network using the chosen network type and enables Stellar RPC.
135135

136136
[`stellar/quickstart` docker image]: https://hub.docker.com/r/stellar/quickstart
137137
[example crowdfund dapp]: https://github.com/stellar/soroban-example-dapp

docs/build/guides/dapps/frontend-guide.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,7 @@ This is made possible by using the `server.getEvents` method which allows you to
743743

744744
We will be editing the `CounterPage` component to read events from the counter smart contract immediately the page loads to get the initial counter value and update instead of using "Unknown". Before we continue, please take a look at the [contract code](https://github.com/stellar/soroban-examples/blob/main/events/src/lib.rs). In the contract code, an event named `increment` is emitted whenever the `increment` function is called. It is published over 2 topics, `increment` and `COUNTER` and we need to listen to these topics to get the events.
745745

746-
The topics are stored in a data type called `symbol` and we will need to convert both `increment` and `COUNTER` to `symbol` before we can use them in the [`server.getEvents`](https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents) method. At maximum, soroban RPCs keep track of events for 7 days and you can query events that happened within the last 7 days, so if you need to store events for longer, you may need to make use of an [indexer](/docs/tools/developer-tools/data-indexers).
746+
The topics are stored in a data type called `symbol` and we will need to convert both `increment` and `COUNTER` to `symbol` before we can use them in the [`server.getEvents`](https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents) method. At maximum, stellar RPCs keep track of events for 7 days and you can query events that happened within the last 7 days, so if you need to store events for longer, you may need to make use of an [indexer](/docs/tools/developer-tools/data-indexers).
747747

748748
To use events,we edit our counter page and add the following code:
749749

docs/build/guides/dapps/initialization.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,8 @@ echo "Done"
199199
Here's a summary of what the `initialize.sh` script does:
200200

201201
- Identifies the network (standalone or futurenet) based on user input
202-
- Determines the Soroban RPC host URL depending on its execution environment (either inside the soroban-preview Docker container or locally)
203-
- Sets the Soroban RPC URL based on the previously determined host URL
202+
- Determines the Stellar RPC host URL depending on its execution environment (either inside the soroban-preview Docker container or locally)
203+
- Sets the Stellar RPC URL based on the previously determined host URL
204204
- Sets the Soroban network passphrase and Friendbot URL depending on the chosen network
205205
- Adds the network configuration using `stellar network add`
206206
- Generates a token-admin identity using `stellar keys generate`

docs/build/guides/dapps/state-archival.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ When developing a dapp on Stellar, you may encounter situations where contract d
131131

132132
- Stellar SDK: `npm install @stellar/stellar-sdk`
133133
- Freighter API: `npm install @stellar/freighter-api`
134-
- A Soroban RPC endpoint (e.g., `https://soroban-testnet.stellar.org`)
134+
- A Stellar RPC endpoint (e.g., `https://soroban-testnet.stellar.org`)
135135

136136
#### Step 1: Set up the SDK and Freighter
137137

docs/build/guides/events/consume.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Consume previously ingested events
33
description: Consume ingested events without querying the RPC again
44
---
55

6-
Once events have been ingested into a database, for instance as done in the [ingest guide], they can be consumed without having the need to query again Soroban RPC. In the following, we will show how we can consume these events.
6+
Once events have been ingested into a database, for instance as done in the [ingest guide], they can be consumed without having the need to query again Stellar RPC. In the following, we will show how we can consume these events.
77

88
Let's get started!
99

@@ -182,7 +182,7 @@ Event listener: {'topic_1': 'transfer', 'topic_2': <Address [type=ACCOUNT, addre
182182
INFO sqlalchemy.engine.Engine COMMIT
183183
```
184184

185-
Congratulations, you are ready to consume events from Soroban RPC!
185+
Congratulations, you are ready to consume events from Stellar RPC!
186186

187187
## Going further
188188

docs/build/guides/events/ingest.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Ingest events published from a contract
3-
description: Use Soroban RPC's getEvents method for querying events, with a 7 day retention window
3+
description: Use Stellar RPC's getEvents method for querying events, with a 7 day retention window
44
---
55

66
import Tabs from "@theme/Tabs";
@@ -10,7 +10,7 @@ Soroban RPC provides a `getEvents` method which allows you to query events from
1010

1111
There are many strategies you can use to ingest and keep the events published by a smart contract. Among the simplest might be using a community-developed tool such as [Mercury](https://mercurydata.app) which will take all the infrastructure work off your plate for a low subscription fee.
1212

13-
Another approach we'll explore here is using a cron job to query Soroban RPC periodically and store the relevant events in a locally stored SQLite database. We are going to use an Object Relational Mapper (ORM), allowing us to write database query directly in Python or JavaScript.
13+
Another approach we'll explore here is using a cron job to query Stellar RPC periodically and store the relevant events in a locally stored SQLite database. We are going to use an Object Relational Mapper (ORM), allowing us to write database query directly in Python or JavaScript.
1414

1515
## Setup
1616

@@ -125,13 +125,13 @@ Using a database model is very convenient as it allows us to control the databas
125125

126126
We'll use this model to create and query for the events stored in our database.
127127

128-
## Query Events from Soroban RPC
128+
## Query Events from Stellar RPC
129129

130-
First, we'll need to query the events from Soroban RPC. This simple example makes an RPC request using the `getEvents` method, filtering for all `transfer` events that are emitted by the native XLM contract.
130+
First, we'll need to query the events from Stellar RPC. This simple example makes an RPC request using the `getEvents` method, filtering for all `transfer` events that are emitted by the native XLM contract.
131131

132132
:::note
133133

134-
We are making some assumptions here. We'll assume that your contract sees enough activity, and that you are querying for events frequently enough that you aren't in danger of needing to figure out the oldest ledger Soroban RPC is aware of. The approach we're taking is to find the largest (most recent) ledger sequence number in the database and query for events starting there. Your use-case may require some logic to determine what the latest ledger is, and what the oldest ledger available is, etc.
134+
We are making some assumptions here. We'll assume that your contract sees enough activity, and that you are querying for events frequently enough that you aren't in danger of needing to figure out the oldest ledger Stellar RPC is aware of. The approach we're taking is to find the largest (most recent) ledger sequence number in the database and query for events starting there. Your use-case may require some logic to determine what the latest ledger is, and what the oldest ledger available is, etc.
135135

136136
:::
137137

@@ -158,7 +158,7 @@ with orm.Session(engine) as session:
158158
ledger = session.scalars(stmt).first()
159159
```
160160

161-
Let's get events from Soroban RPC!
161+
Let's get events from Stellar RPC!
162162

163163
```python
164164
from stellar_sdk.soroban_rpc import EventFilter, EventFilterType

docs/build/guides/rpc/retrieve-contract-code-js.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ console.log(
9292
// OUTPUT: AAAAB+QzbW3JDhlUbDVW/C+1/5SIQDstqORuhpCyl73O1vH6
9393
```
9494

95-
Now, finally we have a `LedgerKey` that correspond to the Wasm byte-code that has been deployed under the `ContractId` we started out with so very long ago. This `LedgerKey` can be used in a final request to the Soroban-RPC endpoint.
95+
Now, finally we have a `LedgerKey` that correspond to the Wasm byte-code that has been deployed under the `ContractId` we started out with so very long ago. This `LedgerKey` can be used in a final request to the Stellar-RPC endpoint.
9696

9797
```json
9898
{

docs/build/guides/rpc/retrieve-contract-code-python.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ print(
9090
# OUTPUT: AAAAB+QzbW3JDhlUbDVW/C+1/5SIQDstqORuhpCyl73O1vH6
9191
```
9292

93-
Now, finally we have a `LedgerKey` that correspond to the Wasm byte-code that has been deployed under the `ContractId` we started out with so very long ago. This `LedgerKey` can be used in a final request to the Soroban-RPC endpoint.
93+
Now, finally we have a `LedgerKey` that correspond to the Wasm byte-code that has been deployed under the `ContractId` we started out with so very long ago. This `LedgerKey` can be used in a final request to the Stellar-RPC endpoint.
9494

9595
```json
9696
{

docs/build/guides/transactions/invoke-contract-tx-sdk.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Please go to [the project homepage](https://github.com/stellar/js-stellar-sdk) o
3737
"SCQN3XGRO65BHNSWLSHYIR4B65AHLDUQ7YLHGIWQ4677AZFRS77TCZRB",
3838
);
3939

40-
// Configure SorobanClient to use the `soroban-rpc` instance of your
40+
// Configure SorobanClient to use the `stellar-rpc` instance of your
4141
// choosing.
4242
const server = new SorobanRpc.Server(
4343
"https://soroban-testnet.stellar.org:443",
@@ -89,7 +89,7 @@ Please go to [the project homepage](https://github.com/stellar/js-stellar-sdk) o
8989
.toXDR("base64")}`,
9090
);
9191

92-
// Submit the transaction to the Soroban-RPC server. The RPC server will
92+
// Submit the transaction to the Stellar-RPC server. The RPC server will
9393
// then submit the transaction into the network for us. Then we will have to
9494
// wait, polling `getTransaction` until the transaction completes.
9595
try {
@@ -160,7 +160,7 @@ network_passphrase = Network.TESTNET_NETWORK_PASSPHRASE
160160
contract_id = "CDOGJBJMRVVXW5K3UJ5BGVJ5RSQXQB4UFVQYVFOIARC2UYXSEPF4YAVR"
161161
# The source account will be used to sign and send the transaction.
162162
source_keypair = Keypair.from_secret(secret)
163-
# Configure SorobanClient to use the `soroban-rpc` instance of your choosing.
163+
# Configure SorobanClient to use the `stellar-rpc` instance of your choosing.
164164
soroban_server = SorobanServer(rpc_server_url)
165165
# Transactions require a valid sequence number (which varies from one account to another).
166166
# We fetch this sequence number from the RPC server.
@@ -198,7 +198,7 @@ tx.sign(source_keypair)
198198
# Let's see the base64-encoded XDR of the transaction we just built.
199199
print(f"Signed prepared transaction XDR: {tx.to_xdr()}")
200200

201-
# Submit the transaction to the Soroban-RPC server. The RPC server will
201+
# Submit the transaction to the Stellar-RPC server. The RPC server will
202202
# then submit the transaction into the network for us. Then we will have to
203203
# wait, polling `get_transaction` until the transaction completes.
204204
send_transaction_data = soroban_server.send_transaction(tx)
@@ -266,7 +266,7 @@ public class Example {
266266
// The source account will be used to sign and send the transaction.
267267
KeyPair sourceKeypair = KeyPair.fromSecretSeed("SAAPYAPTTRZMCUZFPG3G66V4ZMHTK4TWA6NS7U4F7Z3IMUD52EK4DDEV");
268268

269-
// Configure SorobanClient to use the `soroban-rpc` instance of your choosing.
269+
// Configure SorobanClient to use the `stellar-rpc` instance of your choosing.
270270
SorobanServer sorobanServer = new SorobanServer("https://soroban-testnet.stellar.org");
271271

272272
// Here we will use a deployed instance of the `increment` example contract.
@@ -314,7 +314,7 @@ public class Example {
314314
// Let's see the base64-encoded XDR of the transaction we just built.
315315
System.out.println("Signed prepared transaction XDR: " + transaction.toEnvelopeXdrBase64());
316316

317-
// Submit the transaction to the Soroban-RPC server. The RPC server will then
317+
// Submit the transaction to the Stellar-RPC server. The RPC server will then
318318
// submit the transaction into the network for us. Then we will have to wait,
319319
// polling `getTransaction` until the transaction completes.
320320
SendTransactionResponse response = sorobanServer.sendTransaction(transaction);

docs/build/guides/transactions/simulateTransaction-Deep-Dive.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: simulateTransaction examples and tutorials guide
55

66
## Overview
77

8-
The `simulateTransaction` endpoint in Soroban RPC allows you to submit a trial contract invocation to simulate how it would be executed by the Stellar network. This simulation calculates the effective transaction data, required authorizations, and minimal resource fee. It provides a way to test and analyze the potential outcomes of a transaction without actually submitting it to the network. It can be a nice way to get contract data as well sometimes.
8+
The `simulateTransaction` endpoint in Stellar RPC allows you to submit a trial contract invocation to simulate how it would be executed by the Stellar network. This simulation calculates the effective transaction data, required authorizations, and minimal resource fee. It provides a way to test and analyze the potential outcomes of a transaction without actually submitting it to the network. It can be a nice way to get contract data as well sometimes.
99

1010
While calling the method on the rpc server is not the ONLY way to simulate a transaction, it will likely be the most common and easiest way.
1111

docs/build/guides/transactions/submit-transaction-wait-js.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Submit a transaction to Soroban RPC using the JavaScript SDK
2+
title: Submit a transaction to Stellar RPC using the JavaScript SDK
33
hide_table_of_contents: true
44
description: Use a looping mechanism to submit a transaction to the RPC
55
---
66

7-
Here is a simple, rudimentary looping mechanism to submit a transaction to Soroban RPC and wait for a result.
7+
Here is a simple, rudimentary looping mechanism to submit a transaction to Stellar RPC and wait for a result.
88

99
```typescript
1010
import {

docs/data/horizon/api-reference/resources/transactions/README.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ order: 0
55

66
:::info
77

8-
Transaction meta `result_meta_xdr` will be removed from the SDF hosted Horizon API (`horizon.stellar.org`) in Q3 2024. Instead of using Horizon to access transaction metadata, developers could access it with the [`getTransactions`](../../../../rpc/api-reference/methods/getTransactions.mdx) endpoint in the Soroban RPC.
8+
Transaction meta `result_meta_xdr` will be removed from the SDF hosted Horizon API (`horizon.stellar.org`) in Q3 2024. Instead of using Horizon to access transaction metadata, developers could access it with the [`getTransactions`](../../../../rpc/api-reference/methods/getTransactions.mdx) endpoint in the Stellar RPC.
99

1010
:::
1111

docs/data/horizon/api-reference/resources/transactions/object.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ order: 10
55

66
:::info
77

8-
Transaction meta `result_meta_xdr` will be removed from the SDF hosted Horizon API (`horizon.stellar.org`) in Q3 2024. Instead of using Horizon to access transaction metadata, developers could access it with the [`getTransactions`](../../../../rpc/api-reference/methods/getTransactions.mdx) endpoint in the Soroban RPC.
8+
Transaction meta `result_meta_xdr` will be removed from the SDF hosted Horizon API (`horizon.stellar.org`) in Q3 2024. Instead of using Horizon to access transaction metadata, developers could access it with the [`getTransactions`](../../../../rpc/api-reference/methods/getTransactions.mdx) endpoint in the Stellar RPC.
99

1010
:::
1111

docs/data/requirements.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Here you can find the requirements for running the various types of nodes the op
1010
| Core Validator Node | 8x Intel Xeon @ 3.4 GHz | 16 GB | 100 GB NVMe SSD | [c5d.2xlarge] | [n4-highcpu-8] | [Click here](../validators/admin-guide/README.mdx) |
1111
| Horizon API Service | 4 vCPU | 16 GB | 100 GB SSD >= 1.5K IOPS | [c5d.xlarge] | [n4-standard-4] | [Click here](./horizon/admin-guide/overview.mdx) |
1212
| Horizon PostgreSQL | 4 vCPU | 32 GB | 2 TB\* SSD (NVMe or Direct Attached Storage) >= 7K IOPS | [i4g.xlarge] | [c3-highmem-8] | [Click here](./horizon/admin-guide/overview.mdx) |
13-
| Soroban RPC | 2 vCPU | 4 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] | [Click here](./rpc/admin-guide.mdx) |
13+
| Stellar RPC | 2 vCPU | 4 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] | [Click here](./rpc/admin-guide.mdx) |
1414

1515
_\* Assuming a 30-day retention window for data storage._
1616

0 commit comments

Comments
 (0)