From 357e574cf3c3425e95ac5806b09ca50d5e269530 Mon Sep 17 00:00:00 2001 From: Jacob Creech <82475023+jacobcreech@users.noreply.github.com> Date: Tue, 17 Oct 2023 14:55:29 -0500 Subject: [PATCH] docs: move rpc info to rpc docs (#33723) docs: link fixes docs: link fixes docs: link fixes --- docs/src/operations/guides/validator-start.md | 21 ------------------- docs/src/operations/setup-an-rpc-node.md | 17 ++++++++++++++- 2 files changed, 16 insertions(+), 22 deletions(-) diff --git a/docs/src/operations/guides/validator-start.md b/docs/src/operations/guides/validator-start.md index 605a5eacb760eb..d7684615fc6f9a 100644 --- a/docs/src/operations/guides/validator-start.md +++ b/docs/src/operations/guides/validator-start.md @@ -441,24 +441,3 @@ As mentioned earlier, be sure that if you use logrotate, any script you create which starts the solana validator process uses "exec" to do so (example: "exec solana-validator ..."); otherwise, when logrotate sends its signal to the validator, the enclosing script will die and take the validator process with it. - -### Account indexing - -As the number of populated accounts on the cluster grows, account-data RPC -requests that scan the entire account set -- like -[`getProgramAccounts`](../api/http#getprogramaccounts) and -[SPL-token-specific requests](../api/http#gettokenaccountsbydelegate) -- may -perform poorly. If your validator needs to support any of these requests, you -can use the `--account-index` parameter to activate one or more in-memory -account indexes that significantly improve RPC performance by indexing accounts -by the key field. Currently supports the following parameter values: - -- `program-id`: each account indexed by its owning program; used by - [getProgramAccounts](../api/http#getprogramaccounts) -- `spl-token-mint`: each SPL token account indexed by its token Mint; used by - [getTokenAccountsByDelegate](../api/http#gettokenaccountsbydelegate), and - [getTokenLargestAccounts](../api/http#gettokenlargestaccounts) -- `spl-token-owner`: each SPL token account indexed by the token-owner address; - used by [getTokenAccountsByOwner](../api/http#gettokenaccountsbyowner), and - [getProgramAccounts](../api/http#getprogramaccounts) requests that include an - spl-token-owner filter. diff --git a/docs/src/operations/setup-an-rpc-node.md b/docs/src/operations/setup-an-rpc-node.md index bd46e00494cce0..7c81517f594573 100644 --- a/docs/src/operations/setup-an-rpc-node.md +++ b/docs/src/operations/setup-an-rpc-node.md @@ -68,4 +68,19 @@ The identities of the [known validators](./guides/validator-start.md#known-valid Additional examples of other Solana cluster specific validator commands can be found on the [Clusters](../clusters/available.md) page. -Keep in mind, you will still need to customize these commands to operate as an RPC node, as well other operator specific configuration settings. \ No newline at end of file +Keep in mind, you will still need to customize these commands to operate as an RPC node, as well other operator specific configuration settings. + +## Account indexing + +As the number of populated accounts on the cluster grows, account-data RPC +requests that scan the entire account set -- like +[`getProgramAccounts`](../../api/http#getprogramaccounts) and +[SPL-token-specific requests](../../api/http#gettokenaccountsbydelegate) -- +may perform poorly. If your validator needs to support any of these requests, +you can use the `--account-index` parameter to activate one or more in-memory +account indexes that significantly improve RPC performance by indexing accounts +by the key field. Currently supports the following parameter values: + +- `program-id`: each account indexed by its owning program; used by [getProgramAccounts](../../api/http#getprogramaccounts) +- `spl-token-mint`: each SPL token account indexed by its token Mint; used by [getTokenAccountsByDelegate](../../api/http#gettokenaccountsbydelegate), and [getTokenLargestAccounts](../../api/http#gettokenlargestaccounts) +- `spl-token-owner`: each SPL token account indexed by the token-owner address; used by [getTokenAccountsByOwner](../../api/http#gettokenaccountsbyowner), and [getProgramAccounts](../../api/http#getprogramaccounts) requests that include an spl-token-owner filter.