From ab91a56013f2ae8a390734586342d72c07779dc1 Mon Sep 17 00:00:00 2001 From: Prit Sheth Date: Mon, 30 Sep 2024 15:02:51 -0700 Subject: [PATCH] Rebrand soroban-rpc to stellar-rpc --- config/sidebars.ts | 2 +- .../guides/basics/automate-reset-data.mdx | 2 +- .../guides/conventions/extending-wasm-ttl.mdx | 2 +- docs/build/guides/dapps/docker.mdx | 2 +- docs/build/guides/dapps/initialization.mdx | 4 +-- docs/build/guides/dapps/state-archival.mdx | 2 +- docs/build/guides/events/consume.mdx | 4 +-- docs/build/guides/events/ingest.mdx | 14 ++++---- .../simulateTransaction-Deep-Dive.mdx | 2 +- .../submit-transaction-wait-js.mdx | 4 +-- .../resources/transactions/README.mdx | 2 +- .../resources/transactions/object.mdx | 2 +- docs/data/requirements.mdx | 2 +- docs/data/rpc/README.mdx | 2 +- docs/data/rpc/admin-guide.mdx | 32 +++++++++---------- docs/data/rpc/rpc-providers.mdx | 4 +-- .../encyclopedia/storage/state-archival.mdx | 6 ++-- docs/learn/fundamentals/networks.mdx | 4 +-- docs/learn/fundamentals/stellar-stack.mdx | 2 +- .../interactive/dapps/scaffold-soroban.mdx | 4 +-- .../migrate/evm/smart-contract-deployment.mdx | 2 +- docs/networks/README.mdx | 2 +- docs/tools/developer-tools/data-indexers.mdx | 2 +- docs/tools/developer-tools/lab/README.mdx | 2 +- docs/tools/sdks/library.mdx | 12 +++---- docs/validators/README.mdx | 2 +- openrpc/src/stellar-rpc/schemas/Hash.json | 2 +- .../stellar-rpc/schemas/LedgerCloseTime.json | 4 +-- .../stellar-rpc/schemas/LedgerSequence.json | 4 +-- .../stellar-rpc/schemas/NetworkConfig.json | 2 +- static/stellar-rpc.openrpc.json | 20 ++++++------ 31 files changed, 76 insertions(+), 76 deletions(-) diff --git a/config/sidebars.ts b/config/sidebars.ts index cb7497550..6840682c6 100644 --- a/config/sidebars.ts +++ b/config/sidebars.ts @@ -23,7 +23,7 @@ const sidebars: SidebarsConfig = { 'data/README', 'data/requirements', { type: 'html', value: 'Data Availability', defaultStyle: true, className: 'networkMenuHtmlItem'}, - { type: 'ref', id: 'data/rpc/README', label: 'Soroban RPC'}, + { type: 'ref', id: 'data/rpc/README', label: 'Stellar RPC'}, { type: 'ref', id: 'data/hubble/README', label: 'Hubble'}, { type: 'ref', id: 'data/horizon/README', label: 'Horizon'}, ], diff --git a/docs/build/guides/basics/automate-reset-data.mdx b/docs/build/guides/basics/automate-reset-data.mdx index 0cb95ab31..9228509bb 100644 --- a/docs/build/guides/basics/automate-reset-data.mdx +++ b/docs/build/guides/basics/automate-reset-data.mdx @@ -22,7 +22,7 @@ Stellar operates two primary testing environments: the [Testnet and the Futurene ## What is the Testnet and Futurenet reset? -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. +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. You can check current reset dates [here](../../../learn/fundamentals/networks.mdx#testnet-and-futurenet-data-reset). diff --git a/docs/build/guides/conventions/extending-wasm-ttl.mdx b/docs/build/guides/conventions/extending-wasm-ttl.mdx index d6fac11b0..332048cf0 100644 --- a/docs/build/guides/conventions/extending-wasm-ttl.mdx +++ b/docs/build/guides/conventions/extending-wasm-ttl.mdx @@ -14,7 +14,7 @@ This guide will show you how to extend the TTL of a deployed contract's Wasm cod ## Prerequisites - Stellar SDK: `npm install @stellar/stellar-sdk` -- A Soroban RPC endpoint (e.g., `https://soroban-testnet.stellar.org`) +- A Stellar RPC endpoint (e.g., `https://soroban-testnet.stellar.org`) - Basic knowledge of Stellar SDK ## Process overview diff --git a/docs/build/guides/dapps/docker.mdx b/docs/build/guides/dapps/docker.mdx index c16c174cc..1002ef49e 100644 --- a/docs/build/guides/dapps/docker.mdx +++ b/docs/build/guides/dapps/docker.mdx @@ -131,7 +131,7 @@ The `quickstart.sh` script sets up the Docker environment for running the dapp. - Creates the Docker network named `soroban-network` if it doesn't exist. - Removes any existing `soroban-preview` Docker container. - Runs the `soroban-preview` container, which provides the Soroban Preview environment for development. -- Runs the `stellar/quickstart` Docker image, which sets up the Stellar network using the chosen network type and enables Soroban RPC. +- Runs the `stellar/quickstart` Docker image, which sets up the Stellar network using the chosen network type and enables Stellar RPC. [`stellar/quickstart` docker image]: https://hub.docker.com/r/stellar/quickstart [example crowdfund dapp]: https://github.com/stellar/soroban-example-dapp diff --git a/docs/build/guides/dapps/initialization.mdx b/docs/build/guides/dapps/initialization.mdx index 548429a4d..f72bb9c0b 100644 --- a/docs/build/guides/dapps/initialization.mdx +++ b/docs/build/guides/dapps/initialization.mdx @@ -199,8 +199,8 @@ echo "Done" Here's a summary of what the `initialize.sh` script does: - Identifies the network (standalone or futurenet) based on user input -- Determines the Soroban RPC host URL depending on its execution environment (either inside the soroban-preview Docker container or locally) -- Sets the Soroban RPC URL based on the previously determined host URL +- Determines the Stellar RPC host URL depending on its execution environment (either inside the soroban-preview Docker container or locally) +- Sets the Stellar RPC URL based on the previously determined host URL - Sets the Soroban network passphrase and Friendbot URL depending on the chosen network - Adds the network configuration using `stellar network add` - Generates a token-admin identity using `stellar keys generate` diff --git a/docs/build/guides/dapps/state-archival.mdx b/docs/build/guides/dapps/state-archival.mdx index a2e66b784..86b012b96 100644 --- a/docs/build/guides/dapps/state-archival.mdx +++ b/docs/build/guides/dapps/state-archival.mdx @@ -131,7 +131,7 @@ When developing a dapp on Stellar, you may encounter situations where contract d - Stellar SDK: `npm install @stellar/stellar-sdk` - Freighter API: `npm install @stellar/freighter-api` -- A Soroban RPC endpoint (e.g., `https://soroban-testnet.stellar.org`) +- A Stellar RPC endpoint (e.g., `https://soroban-testnet.stellar.org`) #### Step 1: Set up the SDK and Freighter diff --git a/docs/build/guides/events/consume.mdx b/docs/build/guides/events/consume.mdx index 896ed38ba..d011b3c51 100644 --- a/docs/build/guides/events/consume.mdx +++ b/docs/build/guides/events/consume.mdx @@ -3,7 +3,7 @@ title: Consume previously ingested events description: Consume ingested events without querying the RPC again --- -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. +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. Let's get started! @@ -182,7 +182,7 @@ Event listener: {'topic_1': 'transfer', 'topic_2':
= 1.5K IOPS | [c5d.xlarge] | [n4-standard-4] | [Click here](./horizon/admin-guide/overview.mdx) | | 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) | -| Soroban RPC | 2 vCPU | 4 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] | [Click here](./rpc/admin-guide.mdx) | +| Stellar RPC | 2 vCPU | 4 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] | [Click here](./rpc/admin-guide.mdx) | _\* Assuming a 30-day retention window for data storage._ diff --git a/docs/data/rpc/README.mdx b/docs/data/rpc/README.mdx index 81d754d5d..19164e089 100644 --- a/docs/data/rpc/README.mdx +++ b/docs/data/rpc/README.mdx @@ -3,7 +3,7 @@ title: RPC Introduction sidebar_position: 5 --- -The Soroban-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. +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. Soroban-RPC should provide all the basic data that a dapp developer would need, provided they are: diff --git a/docs/data/rpc/admin-guide.mdx b/docs/data/rpc/admin-guide.mdx index fc4cc9c09..ad9f9ec24 100644 --- a/docs/data/rpc/admin-guide.mdx +++ b/docs/data/rpc/admin-guide.mdx @@ -22,12 +22,12 @@ We don't recommend running the Quickstart image in production. See the [deploy y The Quickstart image with the RPC service can run on a standard laptop with 8GB of RAM and has minimal storage and CPU requirements. It is a single container that runs everything you need to test against a fully featured network. It contains: - [Stellar Core] - Node software that runs the network, coordinates consensus, and finalizes ledgers. -- [Soroban RPC] server - JSON RPC server for interacting with Soroban contracts. +- [Stellar RPC] server - JSON RPC server for interacting with Soroban contracts. - [Horizon server] - HTTP API for accessing ledger state and historical transactions. - [Friendbot server] - HTTP API for creating and funding new accounts on test networks. [Stellar Core]: https://github.com/stellar/stellar-core -[Soroban RPC]: https://github.com/stellar/soroban-rpc/tree/main/cmd/soroban-rpc +[Stellar RPC]: https://github.com/stellar/soroban-rpc/tree/main/cmd/soroban-rpc [Horizon server]: https://github.com/stellar/go/tree/master/services/horizon [Friendbot server]: https://github.com/stellar/go/tree/master/services/friendbot @@ -154,15 +154,15 @@ We recommend the following ways to deploy your own RPC instance: ### Hardware Requirements -For deployments expecting up to 1000 requests per second to Soroban RPC, we recommend at least 4GB of RAM and at least a dual core CPU with a 2.4GHz clock speed. +For deployments expecting up to 1000 requests per second to Stellar RPC, we recommend at least 4GB of RAM and at least a dual core CPU with a 2.4GHz clock speed. -For deployments expecting 1000-10000+ requests per second to Soroban RPC, we recommend at least 8GB of RAM and at least a quad core CPU with a 2.4GHz clock speed. +For deployments expecting 1000-10000+ requests per second to Stellar RPC, we recommend at least 8GB of RAM and at least a quad core CPU with a 2.4GHz clock speed. For all deployments, we recommend at least 10GB of disk/storage space. | Node Type | CPU | RAM | Disk | AWS SKU | Google Cloud SKU | | --- | --- | --- | --- | --- | --- | -| Soroban RPC | 2 vCPU | 4-8 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] | +| Stellar RPC | 2 vCPU | 4-8 GB | 30 GB persistent volume >= 3K IOPS | [c5.large] | [n4-highcpu-2] | _\* Assuming a 7-day retention window for data storage._ @@ -224,7 +224,7 @@ By default, this is disabled (`sorobanRpc.persistence.enabled=false`) and the RP --set sorobanRpc.resources.limits.memory=2560Mi ``` -Even if you're not deploying Soroban RPC using Kubernetes, the manifests generated by the charts may still be a good reference for showing how to configure and run Soroban RPC as a docker container. Just run the `helm template` command to print the container configuration to screen: +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 @@ -305,7 +305,7 @@ docker run -p 8001:8001 -p 8000:8000 \ #### Configuration -For production, we recommend running Soroban 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/soroban-rpc): ```bash docker run -p 8001:8001 -p 8000:8000 \ @@ -313,7 +313,7 @@ docker run -p 8001:8001 -p 8000:8000 \ --config-path ``` -You can use Soroban RPC itself to generate a starter configuration file: +You can use Stellar RPC itself to generate a starter configuration file: ```bash docker run stellar/soroban-rpc gen-config-file > soroban-rpc-config.toml @@ -494,7 +494,7 @@ Note that the above generated configuration contains the default values and you ### Build From Source -Instructions for building Soroban RPC from source can be found [here](https://github.com/stellar/soroban-rpc/blob/main/cmd/soroban-rpc/README.md). +Instructions for building Stellar RPC from source can be found [here](https://github.com/stellar/soroban-rpc/blob/main/cmd/soroban-rpc/README.md). ## Use the RPC Instance @@ -522,14 +522,14 @@ When interacting with the network in production you should run your own soroban- ## Verify the RPC Instance -After installation, it will be worthwhile to verify the installation of Soroban RPC is healthy. There are two methods: +After installation, it will be worthwhile to verify the installation of Stellar RPC is healthy. There are two methods: 1. Access the health status endpoint of the JSON RPC service using an HTTP client -2. Use our pre-built [System Test Docker image](https://hub.docker.com/r/stellar/system-test/tags) as a tool to run a set of live tests against Soroban RPC +2. Use our pre-built [System Test Docker image](https://hub.docker.com/r/stellar/system-test/tags) as a tool to run a set of live tests against Stellar RPC ### Health Status Endpoint -If you send a JSON RPC HTTP request to your running instance of Soroban RPC: +If you send a JSON RPC HTTP request to your running instance of Stellar RPC: ```bash curl --location 'http://localhost:8000' \ @@ -570,7 +570,7 @@ docker.io/stellar/system-test:soroban-preview11 \ Make sure you configure the system test correctly: -- Use a published [system test tag](https://hub.docker.com/r/stellar/system-test/tags) that aligns with the deployed Soroban RPC release version. For each release, there will be two tags published for different CPU architectures. Make sure to use the tag that matches your host machine's CPU architecture: +- Use a published [system test tag](https://hub.docker.com/r/stellar/system-test/tags) that aligns with the deployed Stellar RPC release version. For each release, there will be two tags published for different CPU architectures. Make sure to use the tag that matches your host machine's CPU architecture: - `docker.io/stellar/system-test:` for machines with AMD/Intel-based CPUs - `docker.io/stellar/system-test:-arm64` for machines with ARM CPUs - Set `--TargetNetworkRPCURL` to your RPC HTTP URL @@ -586,7 +586,7 @@ Make sure you configure the system test correctly: ## Monitor the RPC Instance -If you run Soroban RPC with the `--admin-endpoint` configured and [expose the port](https://docs.docker.com/engine/reference/commandline/run/#publish), you'll have access to the [Prometheus](https://prometheus.io/) metrics via the `/metrics` endpoint. For example, if the admin endpoint is `0.0.0.0:8001` and you're running the Soroban RPC Docker image: +If you run Stellar RPC with the `--admin-endpoint` configured and [expose the port](https://docs.docker.com/engine/reference/commandline/run/#publish), you'll have access to the [Prometheus](https://prometheus.io/) metrics via the `/metrics` endpoint. For example, if the admin endpoint is `0.0.0.0:8001` and you're running the Stellar RPC Docker image: ```bash curl localhost:8001/metrics @@ -594,14 +594,14 @@ curl localhost:8001/metrics You will see many of the default Go and Process metrics (prefixed by `go_` and `process_` respectively) such as memory usage, CPU usage, number of threads, etc. -We also expose metrics related to Soroban RPC (prefixed by `soroban_rpc`). There are many, but some notable ones are: +We also expose metrics related to Stellar RPC (prefixed by `soroban_rpc`). There are many, but some notable ones are: - `soroban_rpc_transactions_count` - count of transactions ingested with a sliding window of 10m - `soroban_rpc_events_count` - count of events ingested with a sliding window of 10m - `soroban_rpc_ingest_local_latest_ledger` - latest ledger ingested - `soroban_rpc_db_round_trip_time_seconds` - time required to run `SELECT 1` query in the DATABASE -Soroban RPC also provides logging to console for: +Stellar RPC also provides logging to console for: - Startup activity - Ingesting, applying, and closing ledgers diff --git a/docs/data/rpc/rpc-providers.mdx b/docs/data/rpc/rpc-providers.mdx index cbc26a040..bde76e1e8 100644 --- a/docs/data/rpc/rpc-providers.mdx +++ b/docs/data/rpc/rpc-providers.mdx @@ -5,7 +5,7 @@ title: Ecosystem RPC Providers ## Ecosystem Providers -Multiple infrastructure providers have made Soroban RPC endpoint services available, and offer plans ranging from free to high throughput endpoints. These providers can be used for development, testing, and production. +Multiple infrastructure providers have made Stellar RPC endpoint services available, and offer plans ranging from free to high throughput endpoints. These providers can be used for development, testing, and production. These providers allow access to the Testnet and Mainnet networks. @@ -31,7 +31,7 @@ These providers allow access to the Testnet and Mainnet networks. ## SDF Provided RPC (Futurenet and Testnet only) {#sdf-provided-rpc} -SDF has made available Soroban RPC with access to the Futurenet and Testnet networks. These services are free to use, and are suitable for development and testing. +SDF has made available Stellar RPC with access to the Futurenet and Testnet networks. These services are free to use, and are suitable for development and testing. SDF will not be providing a publicly available RPC endpoint for Mainnet. Developers should select an ecosystem provider that works for their project before migrating to Mainnet. In some cases, projects may choose to [run their own RPC instance](./admin-guide.mdx). diff --git a/docs/learn/encyclopedia/storage/state-archival.mdx b/docs/learn/encyclopedia/storage/state-archival.mdx index fd90abae6..c6c77dcd1 100644 --- a/docs/learn/encyclopedia/storage/state-archival.mdx +++ b/docs/learn/encyclopedia/storage/state-archival.mdx @@ -176,13 +176,13 @@ The restored entry will have its live until ledger extended to the [minimum] the ## Examples -We've done our best to build tooling around state archival in both the Soroban RPC server as well as the JavaScript SDK to make it easier to deal with, and this set of examples demonstrates how to leverage it. +We've done our best to build tooling around state archival in both the Stellar RPC server as well as the JavaScript SDK to make it easier to deal with, and this set of examples demonstrates how to leverage it. ### Overview Both restoring and extending the TTL of ledger entries follows a three-step process regardless of their nature (contract data, instances, etc.): -1. **Identify the ledger entries**. This usually means acquiring them from a Soroban RPC server as part of your initial transaction simulation (see the [transaction simulation docs](../contract-development/contract-interactions/transaction-simulation.mdx) and the [`simulateTransaction`](../../../data/rpc/api-reference/methods/simulateTransaction.mdx) RPC method). +1. **Identify the ledger entries**. This usually means acquiring them from a Stellar RPC server as part of your initial transaction simulation (see the [transaction simulation docs](../contract-development/contract-interactions/transaction-simulation.mdx) and the [`simulateTransaction`](../../../data/rpc/api-reference/methods/simulateTransaction.mdx) RPC method). 2. **Prepare your operation**. This means describing the ledger entries within the corresponding operation (i.e. `ExtendFootprintTTLOp` or `RestoreFootprintOp`) and its ledger footprint (the `SorobanTransactionData` field), then simulating it to fill out fee and resource usage information (when restoring, you usually have simulation results already). @@ -197,7 +197,7 @@ Remember, though, that any combination of these scenarios can occur in reality. ### Preparation -In order to help the scaffolding of the code, we'll introduce some reusable components. The following is a simple, rudimentary looping mechanism to submit a transaction to Soroban RPC and wait for a result: +In order to help the scaffolding of the code, we'll introduce some reusable components. The following is a simple, rudimentary looping mechanism to submit a transaction to Stellar RPC and wait for a result: ```typescript import { diff --git a/docs/learn/fundamentals/networks.mdx b/docs/learn/fundamentals/networks.mdx index 6593e67be..08006a16e 100644 --- a/docs/learn/fundamentals/networks.mdx +++ b/docs/learn/fundamentals/networks.mdx @@ -40,7 +40,7 @@ If you are creating multiple accounts, you can fund your first account with Frie ## Testnet and Futurenet data reset -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. 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. +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. 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. Futurenet resets are on a less regular cadence than Testnet resets and don't have a set schedule. @@ -76,7 +76,7 @@ A script can automate this entire process by creating an account with Friendbot - Creating test accounts (with funding from Friendbot); - Developing applications and contracts and exploring tutorials on Stellar without the potential to lose any assets; -- Testing existing applications against new releases or release candidates of Stellar Core, Horizon, and the Soroban RPC; +- Testing existing applications against new releases or release candidates of Stellar Core, Horizon, and the Stellar RPC; - Performing data analysis on a smaller, non-trivial data set compared to the Mainnet. ### Testnet and Futurenet are bad for diff --git a/docs/learn/fundamentals/stellar-stack.mdx b/docs/learn/fundamentals/stellar-stack.mdx index 6cd52a4aa..dd63d2c4b 100644 --- a/docs/learn/fundamentals/stellar-stack.mdx +++ b/docs/learn/fundamentals/stellar-stack.mdx @@ -39,6 +39,6 @@ SDF does not provide a publicly available RPC endpoint for Mainnet. Developers s ## SDKs -SDKs simplify some of the work of accessing Horizon and the Soroban RPC by converting the data into friendlier formats and allowing you to program in the language of your choice. Stellar’s SDKs show you how to request data and create and submit transactions. Soroban's SDKs allow you to write smart contracts in Rust and interact with smart contracts in a myriad of other languages. +SDKs simplify some of the work of accessing Horizon and the Stellar RPC by converting the data into friendlier formats and allowing you to program in the language of your choice. Stellar’s SDKs show you how to request data and create and submit transactions. Soroban's SDKs allow you to write smart contracts in Rust and interact with smart contracts in a myriad of other languages. View Stellar's [SDK library](../../tools/sdks/library.mdx) to access our SDKs and their documentation. diff --git a/docs/learn/interactive/dapps/scaffold-soroban.mdx b/docs/learn/interactive/dapps/scaffold-soroban.mdx index 86fdc8be0..0304ede10 100644 --- a/docs/learn/interactive/dapps/scaffold-soroban.mdx +++ b/docs/learn/interactive/dapps/scaffold-soroban.mdx @@ -73,11 +73,11 @@ Dive in and discover the power of Soroban! With the introduction of these dapps, let's delve deeper into some of their [standout features](https://github.com/stellar/soroban-react-atomic-swap/blob/main/src/helpers/soroban.ts) that showcase the power and innovation behind the dapps: -Functionality behind the dapps is extensive and diverse, leveraging the `@stellar/stellar-sdk` library to integrate with the Soroban RPC and facilitating direct communication with Soroban using a JSON RPC interface on the Stellar network. They are equipped to communicate across different network setups, as they incorporate the `RPC_URLS` and `getServer` functionalities, providing adaptability that is crucial for various development and deployment scenarios. Users can retrieve user-friendly token information without engaging with complex blockchain operations, by utilizing functions like `getTokenSymbol`, `getTokenName`, and `getTokenDecimals`. +Functionality behind the dapps is extensive and diverse, leveraging the `@stellar/stellar-sdk` library to integrate with the Stellar RPC and facilitating direct communication with Soroban using a JSON RPC interface on the Stellar network. They are equipped to communicate across different network setups, as they incorporate the `RPC_URLS` and `getServer` functionalities, providing adaptability that is crucial for various development and deployment scenarios. Users can retrieve user-friendly token information without engaging with complex blockchain operations, by utilizing functions like `getTokenSymbol`, `getTokenName`, and `getTokenDecimals`. A significant feature is the `simulateTx` function, which allows users to preview the outcome of a transaction before actually executing it. `simulateTx` allows users to submit a trial contract invocation by first running a simulation of the contract invocation as defined on the incoming transaction. The results are then applied to a new copy of the transaction, which is returned with the ledger footprint and authorization set, making it ready for signing and sending. The returned transaction will also have an updated fee, the sum of the fee set on the incoming transaction with the contract resource fees estimated from the simulation. It is advisable to check the fee on the returned transaction and validate or take appropriate measures for interaction with the user to confirm it is acceptable. -Other utilities such as `accountToScVal` and `numberToI128` are also provided to simplify transaction creation by converting user-friendly inputs into the formats expected by the Soroban RPC on the Stellar network. Furthermore, the dapps are built with premade helper functions such as the `makePayment` function which facilitates streamlined "transfer" operations and also includes memos for supplementary transaction-related information. +Other utilities such as `accountToScVal` and `numberToI128` are also provided to simplify transaction creation by converting user-friendly inputs into the formats expected by the Stellar RPC on the Stellar network. Furthermore, the dapps are built with premade helper functions such as the `makePayment` function which facilitates streamlined "transfer" operations and also includes memos for supplementary transaction-related information. The code referenced showcases various functionalities including sending transactions, retrieving token information, simulating transactions, building swaps, and authorizing contract calls, all of which are ready to be cloned, customized, and expanded upon to suit your unique needs and ideas. diff --git a/docs/learn/migrate/evm/smart-contract-deployment.mdx b/docs/learn/migrate/evm/smart-contract-deployment.mdx index d5a111d98..6d6fcee13 100644 --- a/docs/learn/migrate/evm/smart-contract-deployment.mdx +++ b/docs/learn/migrate/evm/smart-contract-deployment.mdx @@ -62,7 +62,7 @@ async function main() { ### Soroban Client -Soroban offers a comparable library, [`stellar-sdk`](../../../tools/sdks/library.mdx#javascript-sdk), that enables seamless interaction smart contracts deployed on the Stellar Network. This library supplies a comprehensive networking layer API for Soroban RPC methods as well as the traditional Horizon API, simplifying the process of building and signing transactions. Additionally, `stellar-sdk` streamlines communication with RPC instances and supports submitting transactions or querying network state with ease. +Soroban offers a comparable library, [`stellar-sdk`](../../../tools/sdks/library.mdx#javascript-sdk), that enables seamless interaction smart contracts deployed on the Stellar Network. This library supplies a comprehensive networking layer API for Stellar RPC methods as well as the traditional Horizon API, simplifying the process of building and signing transactions. Additionally, `stellar-sdk` streamlines communication with RPC instances and supports submitting transactions or querying network state with ease. ### Scripts diff --git a/docs/networks/README.mdx b/docs/networks/README.mdx index f1b04fc3f..be9fbbb22 100644 --- a/docs/networks/README.mdx +++ b/docs/networks/README.mdx @@ -16,7 +16,7 @@ Read more about the different networks in the [Networks section](../learn/fundam | :-- | --- | --- | --- | | Network Passphrase | `Public Global Stellar Network ; September 2015` | `Test SDF Network ; September 2015` | `Test SDF Future Network ; October 2022` | | Horizon API | See available [Horizon ecosystem providers] | https://horizon-testnet.stellar.org | https://horizon-futurenet.stellar.org | -| Soroban RPC | See available [RPC ecosystem providers] | `https://soroban-testnet.stellar.org` | `https://rpc-futurenet.stellar.org` | +| Stellar RPC | See available [RPC ecosystem providers] | `https://soroban-testnet.stellar.org` | `https://rpc-futurenet.stellar.org` | | Friendbot API | N/A | `https://friendbot.stellar.org` | `https://friendbot-futurenet.stellar.org` | | Validator | `core-live-a.stellar.org` `core-live-b.stellar.org` `core-live-c.stellar.org` | `core-live-testnet.stellar.org` | `core-live-futurenet.stellar.org` | | History Archive | `http://history.stellar.org/prd/core-live/core_live_001/`, `http://history.stellar.org/prd/core-live/core_live_002/`, `http://history.stellar.org/prd/core-live/core_live_003/` | https://history-testnet.stellar.org | https://history-futurenet.stellar.org | diff --git a/docs/tools/developer-tools/data-indexers.mdx b/docs/tools/developer-tools/data-indexers.mdx index 79c62fdbd..40e7a7ee7 100644 --- a/docs/tools/developer-tools/data-indexers.mdx +++ b/docs/tools/developer-tools/data-indexers.mdx @@ -15,7 +15,7 @@ Also offers RPC and Horizon instances. ### [BlockEden](https://blockeden.xyz/stellar-soroban/) -An all-in-one Soroban RPC, indexer GraphQL API, and data analytics web portal. +An all-in-one Stellar RPC, indexer GraphQL API, and data analytics web portal. ### [Goldsky](https://goldsky.com/) diff --git a/docs/tools/developer-tools/lab/README.mdx b/docs/tools/developer-tools/lab/README.mdx index c2decfad8..464b1f58c 100644 --- a/docs/tools/developer-tools/lab/README.mdx +++ b/docs/tools/developer-tools/lab/README.mdx @@ -16,7 +16,7 @@ Stellar Lab is our new go-to tool for development, experimenting, and testing, a ### Features of Stellar Lab - Easily Create Accounts: Create Accounts on Mainnet, Testnet, and Futurenet using a web UI. You can use Friendbot to fund those accounts directly on Lab for Testnet and Futurenet. -- Access RPC Methods and Horizon Endpoints: Leverage powerful Soroban RPC methods and Stellar Horizon endpoints in a web UI to interact with the Stellar network and obtain crucial data. Try RPC methods to get states from the ledger like accounts, trustlines, contract wasm, and more. +- Access RPC Methods and Horizon Endpoints: Leverage powerful Stellar RPC methods and Stellar Horizon endpoints in a web UI to interact with the Stellar network and obtain crucial data. Try RPC methods to get states from the ledger like accounts, trustlines, contract wasm, and more. - Simulate and Submit: Lab supports the ability to use custom RPC providers so that you could simulate transactions, save transactions, and submit transactions directly using Lab. You can also submit transactions using Horizon. - Save and Share API Requests: Easily save your requests and transactions for the future or share them with teammates to build faster together. - XDR ⇔ JSON Support: We have introduced a canonical [XDR to JSON mapping](https://www.npmjs.com/package/@stellar/stellar-xdr-json-web) which is used on Stellar Lab (also used in the [Stellar CLI](https://github.com/stellar/stellar-cli)). You can see this at work in the Lab where [XDR can be converted to JSON](https://lab.stellar.org/xdr/view). diff --git a/docs/tools/sdks/library.mdx b/docs/tools/sdks/library.mdx index c06aa07d1..f7684fa02 100644 --- a/docs/tools/sdks/library.mdx +++ b/docs/tools/sdks/library.mdx @@ -39,11 +39,11 @@ The AssemblyScript Soroban SDK is maintained by dedicated community developer, S [JavaScript SDK](https://github.com/stellar/js-stellar-sdk) | [Docs](https://stellar.github.io/js-stellar-sdk/) | [NPM](https://www.npmjs.com/package/@stellar/stellar-sdk) -`stellar-sdk` is the JavaScript library for communicating with a Soroban RPC server, communicating with the Horizon API, and building transactions on the Stellar network. It is used for building Stellar apps either on Node.js or in the browser. +`stellar-sdk` is the JavaScript library for communicating with a Stellar RPC server, communicating with the Horizon API, and building transactions on the Stellar network. It is used for building Stellar apps either on Node.js or in the browser. It provides: -- A networking layer API for Soroban RPC methods and the Horizon API. +- A networking layer API for Stellar RPC methods and the Horizon API. - Facilities for building and signing transactions, for communicating with an RPC instance, for communicating with a Horizon instance, and for submitting transactions or querying network state. ### Python SDK @@ -63,7 +63,7 @@ It provides: [iOS SDK](https://github.com/Soneso/stellar-ios-mac-sdk) | [Docs](https://github.com/Soneso/stellar-ios-mac-sdk/tree/master/docs) | [Smart Contract Docs](https://github.com/Soneso/stellar-ios-mac-sdk/blob/master/soroban.md) -The `stellar-ios-mac-sdk` is an open source Stellar SDK for iOS & Mac. It provides APIs to build transactions and connect to Horizon. It also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Soroban RPC Server. +The `stellar-ios-mac-sdk` is an open source Stellar SDK for iOS & Mac. It provides APIs to build transactions and connect to Horizon. It also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Stellar RPC Server. The iOS SDK is maintained by dedicated community developer, Soneso. @@ -71,7 +71,7 @@ The iOS SDK is maintained by dedicated community developer, Soneso. [Flutter SDK](https://github.com/Soneso/stellar_flutter_sdk) | [Docs](https://github.com/Soneso/stellar_flutter_sdk/blob/master/soroban.md) -The `stellar-flutter-sdk` is an open source Stellar SDK for Flutter developers. It provides APIs to build transactions and connect to Horizon. It also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Soroban RPC Server. +The `stellar-flutter-sdk` is an open source Stellar SDK for Flutter developers. It provides APIs to build transactions and connect to Horizon. It also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Stellar RPC Server. The Flutter Stellar SDK is maintained by dedicated community developer, Soneso. @@ -79,7 +79,7 @@ The Flutter Stellar SDK is maintained by dedicated community developer, Soneso. [PHP SDK](https://github.com/Soneso/stellar-php-sdk) | [Docs](https://github.com/Soneso/stellar-php-sdk/blob/main/soroban.md) -The `stellar-php-sdk` is an open source Stellar SDK for PHP developers. It provides APIs to build transactions and connect to Horizon. It also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Soroban RPC Server. +The `stellar-php-sdk` is an open source Stellar SDK for PHP developers. It provides APIs to build transactions and connect to Horizon. It also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Stellar RPC Server. The PHP Stellar SDK is maintained by dedicated community developer, Soneso. @@ -93,7 +93,7 @@ This SDK is maintained by dedicated community developers, kommitters Open Source [Java SDK](https://github.com/lightsail-network/java-stellar-sdk) | [Docs](https://lightsail-network.github.io/java-stellar-sdk/) -`java-stellar-sdk` provides APIs to build transactions and connect to Horizon and also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Soroban RPC Server. +`java-stellar-sdk` provides APIs to build transactions and connect to Horizon and also provides functionality to deploy and invoke Soroban smart contracts and communicates with the Stellar RPC Server. ### Go diff --git a/docs/validators/README.mdx b/docs/validators/README.mdx index d3bec8db7..848b0f179 100644 --- a/docs/validators/README.mdx +++ b/docs/validators/README.mdx @@ -10,7 +10,7 @@ Stellar is a peer-to-peer network made up of nodes, which are computers that kee This section of the docs explains how to run a validator node, which participates in consensus to validate transactions and determine network settings. A validator node _should not_ be used for network data access and transaction submission. There are two varieties of _non-validating_ nodes that can be used for those purposes, each of which has its own process for set up, interaction, maintenance, and monitoring. They are: 1. [**Horizon Nodes**](../data/horizon/README.mdx) can be used for submitting transactions, as well as exposing a REST API service to query and retrieve network state. -2. [**Soroban RPC Nodes**](../data/rpc/README.mdx) can be used for simulating and/or submitting transactions, as well as exposing an RPC service to query and retrieve current network state. +2. [**Stellar RPC Nodes**](../data/rpc/README.mdx) can be used for simulating and/or submitting transactions, as well as exposing an RPC service to query and retrieve current network state. If you are interested in Horizon or RPC nodes, please explore those docs. diff --git a/openrpc/src/stellar-rpc/schemas/Hash.json b/openrpc/src/stellar-rpc/schemas/Hash.json index f12fe2cfc..dd20709d6 100644 --- a/openrpc/src/stellar-rpc/schemas/Hash.json +++ b/openrpc/src/stellar-rpc/schemas/Hash.json @@ -13,7 +13,7 @@ }, "LedgerHash": { "title": "id", - "description": "Hash identifier of the latest ledger (as a hex-encoded string) known to Soroban RPC at the time it handled the request.", + "description": "Hash identifier of the latest ledger (as a hex-encoded string) known to Stellar RPC at the time it handled the request.", "$ref": "#/components/schemas/Hash" } } diff --git a/openrpc/src/stellar-rpc/schemas/LedgerCloseTime.json b/openrpc/src/stellar-rpc/schemas/LedgerCloseTime.json index ba6df7fea..81c16b8e6 100644 --- a/openrpc/src/stellar-rpc/schemas/LedgerCloseTime.json +++ b/openrpc/src/stellar-rpc/schemas/LedgerCloseTime.json @@ -6,12 +6,12 @@ }, "LatestLedgerCloseTime": { "title": "latestLedgerCloseTime", - "description": "The unix timestamp of the close time of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The unix timestamp of the close time of the latest ledger known to Stellar RPC at the time it handled the request.", "$ref": "#/components/schemas/LedgerCloseTime" }, "OldestLedgerCloseTime": { "title": "oldestLedgerCloseTime", - "description": "The unix timestamp of the close time of the oldest ledger ingested by Soroban RPC at the time it handled the request.", + "description": "The unix timestamp of the close time of the oldest ledger ingested by Stellar RPC at the time it handled the request.", "$ref": "#/components/schemas/LedgerCloseTime" } } diff --git a/openrpc/src/stellar-rpc/schemas/LedgerSequence.json b/openrpc/src/stellar-rpc/schemas/LedgerSequence.json index bd097ba91..ebfe2b6fd 100644 --- a/openrpc/src/stellar-rpc/schemas/LedgerSequence.json +++ b/openrpc/src/stellar-rpc/schemas/LedgerSequence.json @@ -6,12 +6,12 @@ }, "LatestLedger": { "title": "latestLedger", - "description": "The sequence number of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", "$ref": "#/components/schemas/LedgerSequence" }, "OldestLedger": { "title": "oldestLedger", - "description": "The sequence number of the oldest ledger ingested by Soroban RPC at the time it handled the request.", + "description": "The sequence number of the oldest ledger ingested by Stellar RPC at the time it handled the request.", "$ref": "#/components/schemas/LedgerSequence" } } diff --git a/openrpc/src/stellar-rpc/schemas/NetworkConfig.json b/openrpc/src/stellar-rpc/schemas/NetworkConfig.json index fdcf3a990..88bc9cd69 100644 --- a/openrpc/src/stellar-rpc/schemas/NetworkConfig.json +++ b/openrpc/src/stellar-rpc/schemas/NetworkConfig.json @@ -6,7 +6,7 @@ }, "NetworkPassphrase": { "title": "networkPassphrase", - "description": "Network passphrase configured for this Soroban RPC node.", + "description": "Network passphrase configured for this Stellar RPC node.", "type": "string" } } diff --git a/static/stellar-rpc.openrpc.json b/static/stellar-rpc.openrpc.json index 3998c52b8..bc6516666 100644 --- a/static/stellar-rpc.openrpc.json +++ b/static/stellar-rpc.openrpc.json @@ -127,7 +127,7 @@ "properties": { "latestLedger": { "title": "latestLedger", - "description": "The sequence number of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", "type": "number" }, "events": { @@ -491,7 +491,7 @@ }, "latestLedger": { "title": "latestLedger", - "description": "The sequence number of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", "type": "number" } } @@ -617,7 +617,7 @@ "minLength": 64, "maxLength": 64, "pattern": "^[a-f\\d]{64}$", - "description": "Hash identifier of the latest ledger (as a hex-encoded string) known to Soroban RPC at the time it handled the request." + "description": "Hash identifier of the latest ledger (as a hex-encoded string) known to Stellar RPC at the time it handled the request." }, "protocolVersion": { "title": "protocolVersion", @@ -626,7 +626,7 @@ }, "sequence": { "title": "latestLedger", - "description": "The sequence number of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", "type": "number" } } @@ -682,7 +682,7 @@ "properties": { "latestLedger": { "title": "latestLedger", - "description": "The sequence number of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", "type": "number" }, "entries": { @@ -826,7 +826,7 @@ "properties": { "passphrase": { "title": "networkPassphrase", - "description": "Network passphrase configured for this Soroban RPC node.", + "description": "Network passphrase configured for this Stellar RPC node.", "type": "string" }, "protocolVersion": { @@ -917,22 +917,22 @@ }, "latestLedger": { "title": "latestLedger", - "description": "The sequence number of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The sequence number of the latest ledger known to Stellar RPC at the time it handled the request.", "type": "number" }, "latestLedgerCloseTime": { "title": "latestLedgerCloseTime", - "description": "The unix timestamp of the close time of the latest ledger known to Soroban RPC at the time it handled the request.", + "description": "The unix timestamp of the close time of the latest ledger known to Stellar RPC at the time it handled the request.", "type": "string" }, "oldestLedger": { "title": "oldestLedger", - "description": "The sequence number of the oldest ledger ingested by Soroban RPC at the time it handled the request.", + "description": "The sequence number of the oldest ledger ingested by Stellar RPC at the time it handled the request.", "type": "number" }, "oldestLedgerCloseTime": { "title": "oldestLedgerCloseTime", - "description": "The unix timestamp of the close time of the oldest ledger ingested by Soroban RPC at the time it handled the request.", + "description": "The unix timestamp of the close time of the oldest ledger ingested by Stellar RPC at the time it handled the request.", "type": "string" }, "ledger": {