package cometbft.services.pruning.v1

Get desktop application:
View/edit binary Protocol Buffers messages

PruningService provides privileged access to specialized pruning functionality on the CometBFT node to help control node storage.

• rpc SetBlockRetainHeight (SetBlockRetainHeightRequest, SetBlockRetainHeightResponse)

  service.proto:16

  SetBlockRetainHeightRequest indicates to the node that it can safely prune all block data up to the specified retain height. The lower of this retain height and that set by the application in its Commit response will be used by the node to determine which heights' data can be pruned.

  message SetBlockRetainHeightRequest

  pruning.proto:6

  SetBlockRetainHeightRequest sets the retain height for blocks.

  • uint64 height = 1

  message SetBlockRetainHeightResponse

  pruning.proto:11

  SetBlockRetainHeightResponse is empty.

  (message has no fields)

• rpc GetBlockRetainHeight (GetBlockRetainHeightRequest, GetBlockRetainHeightResponse)

  service.proto:20

  GetBlockRetainHeight returns information about the retain height parameters used by the node to influence block retention/pruning.

  message GetBlockRetainHeightRequest

  pruning.proto:14

  GetBlockRetainHeightRequest is a request for the retain height.

  (message has no fields)

  message GetBlockRetainHeightResponse

  pruning.proto:17

  GetBlockRetainHeightResponse returns the retain height for blocks.

  • uint64 app_retain_height = 1

    The retain height set by the application.

  • uint64 pruning_service_retain_height = 2

    The retain height set via the pruning service (e.g. by the data companion) specifically for blocks.

• rpc SetBlockResultsRetainHeight (SetBlockResultsRetainHeightRequest, SetBlockResultsRetainHeightResponse)

  service.proto:27

  SetBlockResultsRetainHeightRequest indicates to the node that it can safely prune all block results data up to the specified height. The node will always store the block results for the latest height to help facilitate crash recovery.

  message SetBlockResultsRetainHeightRequest

  pruning.proto:27

  SetBlockResultsRetainHeightRequest sets the retain height for block results.

  • uint64 height = 1

  message SetBlockResultsRetainHeightResponse

  pruning.proto:32

  SetBlockResultsRetainHeightResponse is empty.

  (message has no fields)

• rpc GetBlockResultsRetainHeight (GetBlockResultsRetainHeightRequest, GetBlockResultsRetainHeightResponse)

  service.proto:31

  GetBlockResultsRetainHeight returns information about the retain height parameters used by the node to influence block results retention/pruning.

  message GetBlockResultsRetainHeightRequest

  pruning.proto:35

  GetBlockResultsRetainHeightRequest is a request for the retain height.

  (message has no fields)

  message GetBlockResultsRetainHeightResponse

  pruning.proto:38

  GetBlockResultsRetainHeightResponse returns the retain height for block results.

  • uint64 pruning_service_retain_height = 1

    The retain height set by the pruning service (e.g. by the data companion) specifically for block results.

• rpc SetTxIndexerRetainHeight (SetTxIndexerRetainHeightRequest, SetTxIndexerRetainHeightResponse)

  service.proto:35

  SetTxIndexerRetainHeightRequest indicates to the node that it can safely prune all tx indices up to the specified retain height.

  message SetTxIndexerRetainHeightRequest

  pruning.proto:45

  SetTxIndexerRetainHeightRequest sets the retain height for the tx indexer.

  • uint64 height = 1

  message SetTxIndexerRetainHeightResponse

  pruning.proto:50

  SetTxIndexerRetainHeightResponse is empty.

  (message has no fields)

• rpc GetTxIndexerRetainHeight (GetTxIndexerRetainHeightRequest, GetTxIndexerRetainHeightResponse)

  service.proto:39

  GetTxIndexerRetainHeight returns information about the retain height parameters used by the node to influence TxIndexer pruning

  message GetTxIndexerRetainHeightRequest

  pruning.proto:53

  GetTxIndexerRetainHeightRequest is a request for the retain height.

  (message has no fields)

  message GetTxIndexerRetainHeightResponse

  pruning.proto:56

  GetTxIndexerRetainHeightResponse returns the retain height for the tx indexer.

  • uint64 height = 1

• rpc SetBlockIndexerRetainHeight (SetBlockIndexerRetainHeightRequest, SetBlockIndexerRetainHeightResponse)

  service.proto:43

  SetBlockIndexerRetainHeightRequest indicates to the node that it can safely prune all block indices up to the specified retain height.

  message SetBlockIndexerRetainHeightRequest

  pruning.proto:61

  SetBlockIndexerRetainHeightRequest sets the retain height for the block indexer.

  • uint64 height = 1

  message SetBlockIndexerRetainHeightResponse

  pruning.proto:66

  SetBlockIndexerRetainHeightResponse is empty.

  (message has no fields)

• rpc GetBlockIndexerRetainHeight (GetBlockIndexerRetainHeightRequest, GetBlockIndexerRetainHeightResponse)

  service.proto:47

  GetBlockIndexerRetainHeight returns information about the retain height parameters used by the node to influence BlockIndexer pruning

  message GetBlockIndexerRetainHeightRequest

  pruning.proto:69

  GetBlockIndexerRetainHeightRequest is a request for the retain height.

  (message has no fields)

  message GetBlockIndexerRetainHeightResponse

  pruning.proto:72

  GetBlockIndexerRetainHeightResponse returns the retain height for the block indexer.

  • uint64 height = 1