-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* First draft of planned topic on RPC protocol * CLarify based on Nic's comments * Missing period Co-authored-by: NicNomadic <148877430+NicNomadic@users.noreply.github.com> * Format for updated date * Add link to full RPC API doc --------- Co-authored-by: NicNomadic <148877430+NicNomadic@users.noreply.github.com>
- Loading branch information
1 parent
3ba728c
commit 5d0b7d2
Showing
3 changed files
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
title: The RPC protocol | ||
authors: "Tim McMackin" | ||
last_update: | ||
date: 6 November 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. | ||
|
||
Tezos RPC uses JSON to send and receive data, but it does not adhere to the JSON-RPC specification. | ||
|
||
For a list of the endpoints in the Tezos RPC protocol, see [Shell RPCs - Reference](https://tezos.gitlab.io/shell/rpc.html#rpc-index-shell) in the Octez documentation. | ||
|
||
## Public and private RPC nodes | ||
|
||
All Tezos nodes run RPC servers, but the RPC interface is subject to an access policy. | ||
By default, RPC servers are private and do not accept all requests from every client. | ||
|
||
When you work with a Tezos client, such as the Octez command-line client or the Taquito SDK, you select a public RPC node to send transactions to, or you can use a private RPC node that you have access to. | ||
|
||
If you're using a testnet, you can get a list of public RPC nodes for that network at https://teztnets.xyz. | ||
|
||
Other sources of public nodes include: | ||
|
||
- [Community RPC Nodes](https://tezostaquito.io/docs/rpc_nodes) listed by ECAD Labs. | ||
- [SmartPy nodes](https://smartpy.io/nodes) | ||
- [RPC nodes](https://tezostaquito.io/docs/rpc_nodes) in the Taquito documentation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters