From d245968b57ec1c292e99abd63538da2cc34028b9 Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Thu, 29 Feb 2024 09:06:22 -0500 Subject: [PATCH] The "RPC protocol" is better described as an interface (#341) * This is better described as an interface * Labels on links --- docs/architecture.md | 2 +- docs/architecture/rpc.md | 8 ++++---- docs/developing/information.md | 4 ++-- docs/unity/quickstart.md | 2 +- docs/unity/reference/TezosConfigSO.md | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 7ec5e8c3d..998b648b5 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -104,7 +104,7 @@ For example, different bakers may implement different transaction selection stra The node accepts calls from clients through its RPC interface. It has control over which clients to accept calls from, which calls to accept, or whether to accept RPC calls at all. -For more information on the RPC interface, see [The RPC protocol](./architecture/rpc). +For more information on the RPC interface, see [The RPC interface](./architecture/rpc). ### The baker daemon diff --git a/docs/architecture/rpc.md b/docs/architecture/rpc.md index 550b4fa0d..9032bbba9 100644 --- a/docs/architecture/rpc.md +++ b/docs/architecture/rpc.md @@ -1,13 +1,13 @@ --- -title: The RPC protocol +title: The RPC interface authors: "Tim McMackin" last_update: date: 6 February 2023 --- -The Tezos RPC (Remote Procedure Call) protocol is a specification for a REST API that clients use to interact with Tezos nodes and nodes use to communicate with each other. -Clients use this protocol to submit transactions and get information about the state of the blockchain, such as account balances and contract storage. -Tezos nodes act as servers and accept HTTP requests from clients and other nodes via this protocol. +The Tezos RPC (Remote Procedure Call) interface is a specification for a REST API that clients use to interact with Tezos nodes and nodes use to communicate with each other. +Clients use this interface to submit transactions and get information about the state of the blockchain, such as account balances and contract storage. +Tezos nodes act as servers and accept HTTP requests from clients and other nodes via this interface. Tezos RPC uses JSON to send and receive data, but it does not adhere to the JSON-RPC specification. diff --git a/docs/developing/information.md b/docs/developing/information.md index 03ad803f1..0ea27f890 100644 --- a/docs/developing/information.md +++ b/docs/developing/information.md @@ -16,9 +16,9 @@ For example, you can get the balance of an account with this command: octez-client get balance for tz1QCVQinE8iVj1H2fckqx6oiM85CNJSK9Sx ``` -## The RPC protocol +## The RPC interface -The [RPC](../architecture/rpc) protocol provides information about the blockchain that nodes use to communicate with each other. +[The RPC interface](../architecture/rpc) provides information about the blockchain that nodes use to communicate with each other. This data is not always in the format that developers and dApps need. For example, the RPC interface does not provide a way to get information about a specific operation by its hash. diff --git a/docs/unity/quickstart.md b/docs/unity/quickstart.md index 49d556de3..f87d8cf1b 100644 --- a/docs/unity/quickstart.md +++ b/docs/unity/quickstart.md @@ -342,7 +342,7 @@ private void OnPayloadSigned(SignResult obj) ## Changing the RPC node -As described in [The RPC protocol](../architecture/rpc), Tezos clients including the Unity SDK send transactions to RPC nodes. +As described in [The RPC interface](../architecture/rpc), Tezos clients including the Unity SDK send transactions to RPC nodes. By default, the SDK sends requests to a public RPC node that uses the Ghostnet test network, where you can test transactions without spending real tez. For more information about test networks, see [Testing on sandboxes and testnets](../developing/testnets). diff --git a/docs/unity/reference/TezosConfigSO.md b/docs/unity/reference/TezosConfigSO.md index 23bfdb4fc..e60d3db91 100644 --- a/docs/unity/reference/TezosConfigSO.md +++ b/docs/unity/reference/TezosConfigSO.md @@ -20,4 +20,4 @@ To use this object, create an instance of it, put your information in its fields - `Pinata Api Key`: The Pinata JWT (not the API key or secret key) to use to upload files and data to IPFS - `Data Provider Config`: The instance of the [DataProviderConfig](./DataProviderConfigSO) scriptable object to use -For more information about RPC nodes, see [The RPC protocol](../../architecture/rpc). +For more information about RPC nodes, see [The RPC interface](../../architecture/rpc).