Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
v1.17: docs: move rpc info to rpc docs (backport of #33723) (#33738)
Browse files Browse the repository at this point in the history
docs: move rpc info to rpc docs (#33723)

docs: link fixes

docs: link fixes

docs: link fixes
(cherry picked from commit 2c6cc4d)

Co-authored-by: Jacob Creech <82475023+jacobcreech@users.noreply.github.com>
  • Loading branch information
mergify[bot] and jacobcreech authored Oct 20, 2023
1 parent ae1bfff commit 685e329
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
15 changes: 0 additions & 15 deletions docs/src/running-validator/validator-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,18 +430,3 @@ 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.
17 changes: 16 additions & 1 deletion docs/src/validator/get-started/setup-an-rpc-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,19 @@ The identities of the [known validators](../../running-validator/validator-start

Additional examples of other Solana cluster specific validator commands can be found on the [Clusters](../../clusters.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.
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.

0 comments on commit 685e329

Please sign in to comment.