package protowire

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc MessageStream (stream KaspadRequest, stream KaspadResponse)

  messages.proto:143

  message KaspadRequest

  messages.proto:6

  • uint64 id = 101

  • oneof payload

    • GetCurrentNetworkRequestMessage getCurrentNetworkRequest = 1001

    • SubmitBlockRequestMessage submitBlockRequest = 1003

    • GetBlockTemplateRequestMessage getBlockTemplateRequest = 1005

    • NotifyBlockAddedRequestMessage notifyBlockAddedRequest = 1007

    • GetPeerAddressesRequestMessage getPeerAddressesRequest = 1010

      BlockAddedNotificationMessage blockAddedNotification = 1009;

    • GetSinkRequestMessage GetSinkRequest = 1012

    • GetMempoolEntryRequestMessage getMempoolEntryRequest = 1014

    • GetConnectedPeerInfoRequestMessage getConnectedPeerInfoRequest = 1016

    • AddPeerRequestMessage addPeerRequest = 1018

    • SubmitTransactionRequestMessage submitTransactionRequest = 1020

    • NotifyVirtualChainChangedRequestMessage notifyVirtualChainChangedRequest = 1022

    • GetBlockRequestMessage getBlockRequest = 1025

      VirtualChainChangedNotificationMessage virtualChainChangedNotification = 1024;

    • GetSubnetworkRequestMessage getSubnetworkRequest = 1027

    • GetVirtualChainFromBlockRequestMessage getVirtualChainFromBlockRequest = 1029

    • GetBlocksRequestMessage getBlocksRequest = 1031

    • GetBlockCountRequestMessage getBlockCountRequest = 1033

    • GetBlockDagInfoRequestMessage getBlockDagInfoRequest = 1035

    • ResolveFinalityConflictRequestMessage resolveFinalityConflictRequest = 1037

    • NotifyFinalityConflictRequestMessage notifyFinalityConflictRequest = 1039

    • GetMempoolEntriesRequestMessage getMempoolEntriesRequest = 1043

      FinalityConflictNotificationMessage finalityConflictNotification = 1041; FinalityConflictResolvedNotificationMessage finalityConflictResolvedNotification = 1042;

    • ShutdownRequestMessage shutdownRequest = 1045

    • GetHeadersRequestMessage getHeadersRequest = 1047

    • NotifyUtxosChangedRequestMessage notifyUtxosChangedRequest = 1049

    • GetUtxosByAddressesRequestMessage getUtxosByAddressesRequest = 1052

      UtxosChangedNotificationMessage utxosChangedNotification = 1051;

    • GetSinkBlueScoreRequestMessage getSinkBlueScoreRequest = 1054

    • NotifySinkBlueScoreChangedRequestMessage notifySinkBlueScoreChangedRequest = 1056

    • BanRequestMessage banRequest = 1059

      SinkBlueScoreChangedNotificationMessage sinkBlueScoreChangedNotification = 1058;

    • UnbanRequestMessage unbanRequest = 1061

    • GetInfoRequestMessage getInfoRequest = 1063

    • StopNotifyingUtxosChangedRequestMessage stopNotifyingUtxosChangedRequest = 1065

    • NotifyPruningPointUtxoSetOverrideRequestMessage notifyPruningPointUtxoSetOverrideRequest = 1067

    • StopNotifyingPruningPointUtxoSetOverrideRequestMessage stopNotifyingPruningPointUtxoSetOverrideRequest = 1070

      PruningPointUtxoSetOverrideNotificationMessage pruningPointUtxoSetOverrideNotification = 1069;

    • EstimateNetworkHashesPerSecondRequestMessage estimateNetworkHashesPerSecondRequest = 1072

    • NotifyVirtualDaaScoreChangedRequestMessage notifyVirtualDaaScoreChangedRequest = 1074

    • GetBalanceByAddressRequestMessage getBalanceByAddressRequest = 1077

      VirtualDaaScoreChangedNotificationMessage virtualDaaScoreChangedNotification = 1076;

    • GetBalancesByAddressesRequestMessage getBalancesByAddressesRequest = 1079

    • NotifyNewBlockTemplateRequestMessage notifyNewBlockTemplateRequest = 1081

    • GetMempoolEntriesByAddressesRequestMessage getMempoolEntriesByAddressesRequest = 1084

      NewBlockTemplateNotificationMessage newBlockTemplateNotification = 1083;

    • GetCoinSupplyRequestMessage getCoinSupplyRequest = 1086

    • PingRequestMessage pingRequest = 1088

    • GetMetricsRequestMessage getMetricsRequest = 1090

    • GetServerInfoRequestMessage getServerInfoRequest = 1092

    • GetSyncStatusRequestMessage getSyncStatusRequest = 1094

    • GetDaaScoreTimestampEstimateRequestMessage getDaaScoreTimestampEstimateRequest = 1096

    • SubmitTransactionReplacementRequestMessage submitTransactionReplacementRequest = 1100

    • GetConnectionsRequestMessage getConnectionsRequest = 1102

    • GetSystemInfoRequestMessage getSystemInfoRequest = 1104

    • GetFeeEstimateRequestMessage getFeeEstimateRequest = 1106

    • GetFeeEstimateExperimentalRequestMessage getFeeEstimateExperimentalRequest = 1108

    • GetCurrentBlockColorRequestMessage getCurrentBlockColorRequest = 1110

    • GetUtxoReturnAddressRequestMessage getUtxoReturnAddressRequest = 1112

    • GetVirtualChainFromBlockV2RequestMessage getVirtualChainFromBlockV2Request = 1114

    • GetBlockRewardInfoRequestMessage getBlockRewardInfoRequest = 1116

  message KaspadResponse

  messages.proto:74

  • uint64 id = 101

  • oneof payload

    • GetCurrentNetworkResponseMessage getCurrentNetworkResponse = 1002

    • SubmitBlockResponseMessage submitBlockResponse = 1004

    • GetBlockTemplateResponseMessage getBlockTemplateResponse = 1006

    • NotifyBlockAddedResponseMessage notifyBlockAddedResponse = 1008

    • BlockAddedNotificationMessage blockAddedNotification = 1009

    • GetPeerAddressesResponseMessage getPeerAddressesResponse = 1011

    • GetSinkResponseMessage GetSinkResponse = 1013

    • GetMempoolEntryResponseMessage getMempoolEntryResponse = 1015

    • GetConnectedPeerInfoResponseMessage getConnectedPeerInfoResponse = 1017

    • AddPeerResponseMessage addPeerResponse = 1019

    • SubmitTransactionResponseMessage submitTransactionResponse = 1021

    • NotifyVirtualChainChangedResponseMessage notifyVirtualChainChangedResponse = 1023

    • VirtualChainChangedNotificationMessage virtualChainChangedNotification = 1024

    • GetBlockResponseMessage getBlockResponse = 1026

    • GetSubnetworkResponseMessage getSubnetworkResponse = 1028

    • GetVirtualChainFromBlockResponseMessage getVirtualChainFromBlockResponse = 1030

    • GetBlocksResponseMessage getBlocksResponse = 1032

    • GetBlockCountResponseMessage getBlockCountResponse = 1034

    • GetBlockDagInfoResponseMessage getBlockDagInfoResponse = 1036

    • ResolveFinalityConflictResponseMessage resolveFinalityConflictResponse = 1038

    • NotifyFinalityConflictResponseMessage notifyFinalityConflictResponse = 1040

    • FinalityConflictNotificationMessage finalityConflictNotification = 1041

    • FinalityConflictResolvedNotificationMessage finalityConflictResolvedNotification = 1042

    • GetMempoolEntriesResponseMessage getMempoolEntriesResponse = 1044

    • ShutdownResponseMessage shutdownResponse = 1046

    • GetHeadersResponseMessage getHeadersResponse = 1048

    • NotifyUtxosChangedResponseMessage notifyUtxosChangedResponse = 1050

    • UtxosChangedNotificationMessage utxosChangedNotification = 1051

    • GetUtxosByAddressesResponseMessage getUtxosByAddressesResponse = 1053

    • GetSinkBlueScoreResponseMessage getSinkBlueScoreResponse = 1055

    • NotifySinkBlueScoreChangedResponseMessage notifySinkBlueScoreChangedResponse = 1057

    • SinkBlueScoreChangedNotificationMessage sinkBlueScoreChangedNotification = 1058

    • BanResponseMessage banResponse = 1060

    • UnbanResponseMessage unbanResponse = 1062

    • GetInfoResponseMessage getInfoResponse = 1064

    • StopNotifyingUtxosChangedResponseMessage stopNotifyingUtxosChangedResponse = 1066

    • NotifyPruningPointUtxoSetOverrideResponseMessage notifyPruningPointUtxoSetOverrideResponse = 1068

    • PruningPointUtxoSetOverrideNotificationMessage pruningPointUtxoSetOverrideNotification = 1069

    • StopNotifyingPruningPointUtxoSetOverrideResponseMessage stopNotifyingPruningPointUtxoSetOverrideResponse = 1071

    • EstimateNetworkHashesPerSecondResponseMessage estimateNetworkHashesPerSecondResponse = 1073

    • NotifyVirtualDaaScoreChangedResponseMessage notifyVirtualDaaScoreChangedResponse = 1075

    • VirtualDaaScoreChangedNotificationMessage virtualDaaScoreChangedNotification = 1076

    • GetBalanceByAddressResponseMessage getBalanceByAddressResponse = 1078

    • GetBalancesByAddressesResponseMessage getBalancesByAddressesResponse = 1080

    • NotifyNewBlockTemplateResponseMessage notifyNewBlockTemplateResponse = 1082

    • NewBlockTemplateNotificationMessage newBlockTemplateNotification = 1083

    • GetMempoolEntriesByAddressesResponseMessage getMempoolEntriesByAddressesResponse = 1085

    • GetCoinSupplyResponseMessage getCoinSupplyResponse = 1087

    • PingResponseMessage pingResponse = 1089

    • GetMetricsResponseMessage getMetricsResponse = 1091

    • GetServerInfoResponseMessage getServerInfoResponse = 1093

    • GetSyncStatusResponseMessage getSyncStatusResponse = 1095

    • GetDaaScoreTimestampEstimateResponseMessage getDaaScoreTimestampEstimateResponse = 1097

    • SubmitTransactionReplacementResponseMessage submitTransactionReplacementResponse = 1101

    • GetConnectionsResponseMessage getConnectionsResponse = 1103

    • GetSystemInfoResponseMessage getSystemInfoResponse = 1105

    • GetFeeEstimateResponseMessage getFeeEstimateResponse = 1107

    • GetFeeEstimateExperimentalResponseMessage getFeeEstimateExperimentalResponse = 1109

    • GetCurrentBlockColorResponseMessage getCurrentBlockColorResponse = 1111

    • GetUtxoReturnAddressResponseMessage getUtxoReturnAddressResponse = 1113

    • GetVirtualChainFromBlockV2ResponseMessage getVirtualChainFromBlockV2Response = 1115

    • GetBlockRewardInfoResponseMessage getBlockRewardInfoResponse = 1117

AddPeerRequestMessage adds a peer to kaspad's outgoing connection list. This will, in most cases, result in kaspad connecting to said peer.

Used in: KaspadRequest

• string address = 1

• bool isPermanent = 2

  Whether to keep attempting to connect to this peer after disconnection

Used in: KaspadResponse

• optional RPCError error = 1000

BanRequestMessage bans the given ip.

Used in: KaspadRequest

• string ip = 1

Used in: KaspadResponse

• optional RPCError error = 1000

Used in: GetMetricsResponseMessage

• uint64 borshBytesTx = 61

• uint64 borshBytesRx = 62

• uint64 jsonBytesTx = 63

• uint64 jsonBytesRx = 64

• uint64 grpcP2pBytesTx = 65

• uint64 grpcP2pBytesRx = 66

• uint64 grpcUserBytesTx = 67

• uint64 grpcUserBytesRx = 68

BlockAddedNotificationMessage is sent whenever a blocks has been added (NOT accepted) into the DAG. See: NotifyBlockAddedRequestMessage

Used in: KaspadResponse

• optional RpcBlock block = 3

Used in: GetBlockRewardInfoResponseMessage

• UNKNOWN = 0

• BLUE = 1

• RED = 2

Used in: GetMetricsResponseMessage

• uint32 borshLiveConnections = 31

• uint64 borshConnectionAttempts = 32

• uint64 borshHandshakeFailures = 33

• uint32 jsonLiveConnections = 41

• uint64 jsonConnectionAttempts = 42

• uint64 jsonHandshakeFailures = 43

• uint32 activePeers = 51

Used in: GetConnectionsResponseMessage

• double cpuUsage = 1

• uint64 memoryUsage = 2

Used in: GetMetricsResponseMessage

• uint64 blocksSubmitted = 1

• uint64 headerCounts = 2

• uint64 depCounts = 3

• uint64 bodyCounts = 4

• uint64 txsCounts = 5

• uint64 chainBlockCounts = 6

• uint64 massCounts = 7

• uint64 blockCount = 11

• uint64 headerCount = 12

• uint64 mempoolSize = 13

• uint32 tipHashesCount = 14

• double difficulty = 15

• uint64 pastMedianTime = 16

• uint32 virtualParentHashesCount = 17

• uint64 virtualDaaScore = 18

Used in: KaspadRequest

• uint32 windowSize = 1

• string startHash = 2

Used in: KaspadResponse

• uint64 networkHashesPerSecond = 1

• optional RPCError error = 1000

Used in: KaspadResponse

• string violatingBlockHash = 1

Used in: KaspadResponse

• string finalityBlockHash = 1

GetBalanceByAddressRequest returns the total balance in unspent transactions towards a given address This call is only available when this kaspad was started with `--utxoindex`

Used in: KaspadRequest

• string address = 1

Used in: KaspadResponse

• uint64 balance = 1

• optional RPCError error = 1000

Used in: KaspadRequest

• repeated string addresses = 1

Used in: KaspadResponse

• repeated RpcBalancesByAddressesEntry entries = 1

• optional RPCError error = 1000

GetBlockCountRequestMessage requests the current number of blocks in this kaspad. Note that this number may decrease as pruning occurs.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• uint64 blockCount = 1

• uint64 headerCount = 2

• optional RPCError error = 1000

GetBlockDagInfoRequestMessage requests general information about the current state of this kaspad's DAG.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• string networkName = 1

• uint64 blockCount = 2

• uint64 headerCount = 3

• repeated string tipHashes = 4

• double difficulty = 5

• int64 pastMedianTime = 6

• repeated string virtualParentHashes = 7

• string pruningPointHash = 8

• uint64 virtualDaaScore = 9

• string sink = 10

• optional RPCError error = 1000

GetBlockRequestMessage requests information about a specific block

Used in: KaspadRequest

• string hash = 1

  The hash of the requested block

• bool includeTransactions = 3

  Whether to include transaction data in the response

Used in: KaspadResponse

• optional RpcBlock block = 3

• optional RPCError error = 1000

Used in: KaspadRequest

• string hash = 1

Used in: KaspadResponse

• optional RpcBlockHeader header = 1

• BlockColor blockColor = 2

• optional uint64 confirmationCount = 3

• optional string mergingChainBlockHash = 4

• optional uint64 rewardAmount = 5

• optional RPCError error = 1000

GetBlockTemplateRequestMessage requests a current block template. Callers are expected to solve the block template and submit it using the submitBlock call See: SubmitBlockRequestMessage

Used in: KaspadRequest

• string payAddress = 1

  Which kaspa address should the coinbase block reward transaction pay into

• string extraData = 2

Used in: KaspadResponse

• optional RpcBlock block = 3

• bool isSynced = 2

  Whether kaspad thinks that it's synced. Callers are discouraged (but not forbidden) from solving blocks when kaspad is not synced. That is because when kaspad isn't in sync with the rest of the network there's a high chance the block will never be accepted, thus the solving effort would have been wasted.

• optional RPCError error = 1000

GetBlocksRequestMessage requests blocks between a certain block lowHash up to this kaspad's current virtual.

Used in: KaspadRequest

• string lowHash = 1

• bool includeBlocks = 2

• bool includeTransactions = 3

Used in: KaspadResponse

• repeated string blockHashes = 4

• repeated RpcBlock blocks = 3

• optional RPCError error = 1000

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• uint64 maxSompi = 1

  note: this is a hard coded maxSupply, actual maxSupply is expected to deviate by upto -5%, but cannot be measured exactly.

• uint64 circulatingSompi = 2

• optional RPCError error = 1000

Used in: GetConnectedPeerInfoResponseMessage

• string id = 1

• string address = 2

• int64 lastPingDuration = 3

  How long did the last ping/pong exchange take

• bool isOutbound = 6

  Whether this kaspad initiated the connection

• int64 timeOffset = 7

• string userAgent = 8

• uint32 advertisedProtocolVersion = 9

  The protocol version that this peer claims to support

• int64 timeConnected = 10

  The timestamp of when this peer connected to this kaspad

• bool isIbdPeer = 11

  Whether this peer is the IBD peer (if IBD is running)

GetConnectedPeerInfoRequestMessage requests information about all the p2p peers currently connected to this kaspad.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• repeated GetConnectedPeerInfoMessage infos = 1

• optional RPCError error = 1000

Used in: KaspadRequest

• bool includeProfileData = 1

Used in: KaspadResponse

• uint32 clients = 1

• uint32 peers = 2

• optional ConnectionsProfileData profileData = 3

• optional RPCError error = 1000

Used in: KaspadRequest

• string hash = 1

Used in: KaspadResponse

• bool blue = 1

• optional RPCError error = 1000

GetCurrentNetworkRequestMessage requests the network kaspad is currently running against. Possible networks are: Mainnet, Testnet, Simnet, Devnet

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• string currentNetwork = 1

• optional RPCError error = 1000

Used in: KaspadRequest

• repeated uint64 daaScores = 1

Used in: KaspadResponse

• repeated uint64 timestamps = 1

• optional RPCError error = 1000

Used in: KaspadRequest

• bool verbose = 1

Used in: KaspadResponse

• optional RpcFeeEstimate estimate = 1

• optional RpcFeeEstimateVerboseExperimentalData verbose = 2

• optional RPCError error = 1000

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• optional RpcFeeEstimate estimate = 1

• optional RPCError error = 1000

GetHeadersRequestMessage requests headers between the given startHash and the current virtual, up to the given limit.

Used in: KaspadRequest

• string startHash = 1

• uint64 limit = 2

• bool isAscending = 3

Used in: KaspadResponse

• repeated string headers = 1

• optional RPCError error = 1000

GetInfoRequestMessage returns info about the node.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• string p2pId = 1

• uint64 mempoolSize = 2

• string serverVersion = 3

• bool isUtxoIndexed = 4

• bool isSynced = 5

• bool hasNotifyCommand = 11

• bool hasMessageId = 12

• optional RPCError error = 1000

Used in: KaspadRequest

• repeated string addresses = 1

• bool includeOrphanPool = 2

• bool filterTransactionPool = 3

Used in: KaspadResponse

• repeated RpcMempoolEntryByAddress entries = 1

• optional RPCError error = 1000

GetMempoolEntriesRequestMessage requests information about all the transactions currently in the mempool.

Used in: KaspadRequest

• bool includeOrphanPool = 1

• bool filterTransactionPool = 2

Used in: KaspadResponse

• repeated RpcMempoolEntry entries = 1

• optional RPCError error = 1000

GetMempoolEntryRequestMessage requests information about a specific transaction in the mempool.

Used in: KaspadRequest

• string txId = 1

  The transaction's TransactionID.

• bool includeOrphanPool = 2

• bool filterTransactionPool = 3

Used in: KaspadResponse

• optional RpcMempoolEntry entry = 1

• optional RPCError error = 1000

Used in: KaspadRequest

• bool processMetrics = 1

• bool connectionMetrics = 2

• bool bandwidthMetrics = 3

• bool consensusMetrics = 4

• bool storageMetrics = 5

• bool customMetrics = 6

Used in: KaspadResponse

• uint64 serverTime = 1

• optional ProcessMetrics processMetrics = 11

• optional ConnectionMetrics connectionMetrics = 12

• optional BandwidthMetrics bandwidthMetrics = 13

• optional ConsensusMetrics consensusMetrics = 14

• optional StorageMetrics storageMetrics = 15

• optional RPCError error = 1000

Used in: GetPeerAddressesResponseMessage

• string Addr = 1

GetPeerAddressesRequestMessage requests the list of known kaspad addresses in the current network. (mainnet, testnet, etc.)

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• repeated GetPeerAddressesKnownAddressMessage addresses = 1

• repeated GetPeerAddressesKnownAddressMessage bannedAddresses = 2

• optional RPCError error = 1000

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• uint32 rpcApiVersion = 1

• uint32 rpcApiRevision = 2

• string serverVersion = 3

• string networkId = 4

• bool hasUtxoIndex = 5

• bool isSynced = 6

• uint64 virtualDaaScore = 7

• optional RPCError error = 1000

GetSinkBlueScoreRequestMessage requests the blue score of the current selected parent of the virtual block.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• uint64 blueScore = 1

• optional RPCError error = 1000

GetSinkRequestMessage requests the hash of the current virtual's selected parent.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• string sink = 1

• optional RPCError error = 1000

GetSubnetworkRequestMessage requests information about a specific subnetwork Currently unimplemented

Used in: KaspadRequest

• string subnetworkId = 1

Used in: KaspadResponse

• uint64 gasLimit = 1

• optional RPCError error = 1000

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• bool isSynced = 1

• optional RPCError error = 1000

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• string version = 1

• string systemId = 2

• string gitHash = 3

• uint32 coreNum = 4

• uint64 totalMemory = 5

• uint32 fdLimit = 6

• uint32 proxySocketLimitPerCpuCore = 7

• optional RPCError error = 1000

Used in: KaspadRequest

• string txid = 1

• uint64 accepting_block_daa_score = 2

Used in: KaspadResponse

• string return_address = 1

• optional RPCError error = 1000

GetUtxosByAddressesRequestMessage requests all current UTXOs for the given kaspad addresses This call is only available when this kaspad was started with `--utxoindex`

Used in: KaspadRequest

• repeated string addresses = 1

Used in: KaspadResponse

• repeated RpcUtxosByAddressesEntry entries = 1

• optional RPCError error = 1000

/ GetVirtualChainFromBlockRequestMessage requests the virtual selected / parent chain from some startHash to this kaspad's current virtual / Note: / this call batches the response to: / a. the network's `mergeset size limit * 10` amount of added chain blocks, if `includeAcceptedTransactionIds = false` / b. or `mergeset size limit * 10` amount of merged blocks, if `includeAcceptedTransactionIds = true` / c. it does not batch the removed chain blocks, only the added ones.

Used in: KaspadRequest

• string startHash = 1

• bool includeAcceptedTransactionIds = 2

• optional uint64 minConfirmationCount = 3

Used in: KaspadResponse

• repeated string removedChainBlockHashes = 1

  The chain blocks that were removed, in high-to-low order

• repeated string addedChainBlockHashes = 3

  The chain blocks that were added, in low-to-high order

• repeated RpcAcceptedTransactionIds acceptedTransactionIds = 2

  The transactions accepted by each block in addedChainBlockHashes. Will be filled only if `includeAcceptedTransactionIds = true` in the request.

• optional RPCError error = 1000

/ GetVirtualChainFromBlockV2RequestMessage requests the virtual selected / parent chain from some startHash to this kaspad's current virtual

Used in: KaspadRequest

• string startHash = 1

• optional RpcDataVerbosityLevel dataVerbosityLevel = 2

• optional uint64 minConfirmationCount = 3

Used in: KaspadResponse

• repeated string removedChainBlockHashes = 1

  The chain blocks that were removed, in high-to-low order

• repeated string addedChainBlockHashes = 2

  The chain blocks that were added, in low-to-high order

• repeated RpcChainBlockAcceptedTransactions chainBlockAcceptedTransactions = 3

  Will be filled depending on the supplied RpcDataVerbosityLevel.

• optional RPCError error = 1000

NewBlockTemplateNotificationMessage is sent whenever a new updated block template is available for miners. See NotifyNewBlockTemplateRequestMessage

Used in: KaspadResponse

(message has no fields)

NotifyBlockAddedRequestMessage registers this connection for blockAdded notifications. See: BlockAddedNotificationMessage

Used in: KaspadRequest

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

Used in: KaspadRequest

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

NotifyNewBlockTemplateRequestMessage registers this connection for NewBlockTemplate notifications. See: NewBlockTemplateNotificationMessage

Used in: KaspadRequest

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

NotifyPruningPointUtxoSetOverrideRequestMessage registers this connection for pruning point UTXO set override notifications. This call is only available when this kaspad was started with `--utxoindex` See: NotifyPruningPointUtxoSetOverrideResponseMessage

Used in: KaspadRequest

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

NotifySinkBlueScoreChangedRequestMessage registers this connection for sinkBlueScoreChanged notifications. See: SinkBlueScoreChangedNotificationMessage

Used in: KaspadRequest

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

NotifyUtxosChangedRequestMessage registers this connection for utxoChanged notifications for the given addresses. This call is only available when this kaspad was started with `--utxoindex` See: UtxosChangedNotificationMessage

Used in: KaspadRequest

• repeated string addresses = 1

  UTXOs addresses to start/stop getting notified about Leave empty to start/stop all updates

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

NotifyVirtualChainChangedRequestMessage registers this connection for virtualChainChanged notifications. See: VirtualChainChangedNotificationMessage

Used in: KaspadRequest

• bool includeAcceptedTransactionIds = 1

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

NotifyVirtualDaaScoreChangedRequestMessage registers this connection for virtualDaaScoreChanged notifications. See: VirtualDaaScoreChangedNotificationMessage

Used in: KaspadRequest

• RpcNotifyCommand command = 101

Used in: KaspadResponse

• optional RPCError error = 1000

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• optional RPCError error = 1000

Used in: GetMetricsResponseMessage

• uint64 residentSetSize = 1

• uint64 virtualMemorySize = 2

• uint32 coreNum = 3

• float cpuUsage = 4

• uint32 fdNum = 5

• uint64 diskIoReadBytes = 6

• uint64 diskIoWriteBytes = 7

• float diskIoReadPerSec = 8

• float diskIoWritePerSec = 9

PruningPointUtxoSetOverrideNotificationMessage is sent whenever the UTXO index resets due to pruning point change via IBD. See NotifyPruningPointUtxoSetOverrideRequestMessage

Used in: KaspadResponse

(message has no fields)

RPCError represents a generic non-internal error. Receivers of any ResponseMessage are expected to check whether its error field is not null.

Used in: AddPeerResponseMessage, BanResponseMessage, EstimateNetworkHashesPerSecondResponseMessage, GetBalanceByAddressResponseMessage, GetBalancesByAddressesResponseMessage, GetBlockCountResponseMessage, GetBlockDagInfoResponseMessage, GetBlockResponseMessage, GetBlockRewardInfoResponseMessage, GetBlockTemplateResponseMessage, GetBlocksResponseMessage, GetCoinSupplyResponseMessage, GetConnectedPeerInfoResponseMessage, GetConnectionsResponseMessage, GetCurrentBlockColorResponseMessage, GetCurrentNetworkResponseMessage, GetDaaScoreTimestampEstimateResponseMessage, GetFeeEstimateExperimentalResponseMessage, GetFeeEstimateResponseMessage, GetHeadersResponseMessage, GetInfoResponseMessage, GetMempoolEntriesByAddressesResponseMessage, GetMempoolEntriesResponseMessage, GetMempoolEntryResponseMessage, GetMetricsResponseMessage, GetPeerAddressesResponseMessage, GetServerInfoResponseMessage, GetSinkBlueScoreResponseMessage, GetSinkResponseMessage, GetSubnetworkResponseMessage, GetSyncStatusResponseMessage, GetSystemInfoResponseMessage, GetUtxoReturnAddressResponseMessage, GetUtxosByAddressesResponseMessage, GetVirtualChainFromBlockResponseMessage, GetVirtualChainFromBlockV2ResponseMessage, NotifyBlockAddedResponseMessage, NotifyFinalityConflictResponseMessage, NotifyNewBlockTemplateResponseMessage, NotifyPruningPointUtxoSetOverrideResponseMessage, NotifySinkBlueScoreChangedResponseMessage, NotifyUtxosChangedResponseMessage, NotifyVirtualChainChangedResponseMessage, NotifyVirtualDaaScoreChangedResponseMessage, PingResponseMessage, ResolveFinalityConflictResponseMessage, RpcBalancesByAddressesEntry, ShutdownResponseMessage, StopNotifyingPruningPointUtxoSetOverrideResponseMessage, StopNotifyingUtxosChangedResponseMessage, SubmitBlockResponseMessage, SubmitTransactionReplacementResponseMessage, SubmitTransactionResponseMessage, UnbanResponseMessage

• string message = 1

Used in: KaspadRequest

• string finalityBlockHash = 1

Used in: KaspadResponse

• optional RPCError error = 1000

Used in: GetVirtualChainFromBlockResponseMessage, VirtualChainChangedNotificationMessage

• string acceptingBlockHash = 1

• repeated string acceptedTransactionIds = 2

Used in: GetBalancesByAddressesResponseMessage

• string address = 1

• uint64 balance = 2

• optional RPCError error = 1000

Used in: BlockAddedNotificationMessage, GetBlockResponseMessage, GetBlockTemplateResponseMessage, GetBlocksResponseMessage, SubmitBlockRequestMessage

• optional RpcBlockHeader header = 1

• repeated RpcTransaction transactions = 2

• optional RpcBlockVerboseData verboseData = 3

Used in: GetBlockRewardInfoResponseMessage, RpcBlock

• uint32 version = 1

• repeated RpcBlockLevelParents parents = 12

• string hashMerkleRoot = 3

• string acceptedIdMerkleRoot = 4

• string utxoCommitment = 5

• int64 timestamp = 6

• uint32 bits = 7

• uint64 nonce = 8

• uint64 daaScore = 9

• string blueWork = 10

• uint64 blueScore = 13

• string pruningPoint = 14

• string hash = 15

Used in: RpcBlockHeader

• repeated string parentHashes = 1

Used in: RpcOptionalHeader

• repeated string parentHashes = 1

• uint32 cumulativeLevel = 2

  must be <= 255 (u8)

Used in: RpcBlock

• string hash = 1

• double difficulty = 11

• string selectedParentHash = 13

• repeated string transactionIds = 14

• bool isHeaderOnly = 15

• uint64 blueScore = 16

• repeated string childrenHashes = 17

• repeated string mergeSetBluesHashes = 18

• repeated string mergeSetRedsHashes = 19

• bool isChainBlock = 20

Used in: GetVirtualChainFromBlockV2ResponseMessage

• optional RpcOptionalHeader chainBlockHeader = 2

• repeated RpcOptionalTransaction acceptedTransactions = 3

Used in: RpcNullableCovenantBinding, RpcTransactionOutput

• uint32 authorizing_input = 1

• string covenant_id = 2

Used in: GetVirtualChainFromBlockV2RequestMessage

• NONE = 0

• LOW = 1

• HIGH = 2

• FULL = 3

Data required for making fee estimates. Feerate values represent fee/mass of a transaction in `sompi/gram` units. Given a feerate value recommendation, calculate the required fee by taking the transaction mass and multiplying it by feerate: `fee = feerate * mass(tx)`

Used in: GetFeeEstimateExperimentalResponseMessage, GetFeeEstimateResponseMessage

• optional RpcFeerateBucket priorityBucket = 1

  Top-priority feerate bucket. Provides an estimation of the feerate required for sub-second DAG inclusion.

• repeated RpcFeerateBucket normalBuckets = 2

  A vector of *normal* priority feerate values. The first value of this vector is guaranteed to exist and provide an estimation for sub-*minute* DAG inclusion. All other values will have shorter estimation times than all `lowBucket` values. Therefor by chaining `[priority] | normal | low` and interpolating between them, one can compose a complete feerate function on the client side. The API makes an effort to sample enough "interesting" points on the feerate-to-time curve, so that the interpolation is meaningful.

• repeated RpcFeerateBucket lowBuckets = 3

  A vector of *low* priority feerate values. The first value of this vector is guaranteed to exist and provide an estimation for sub-*hour* DAG inclusion.

Used in: GetFeeEstimateExperimentalResponseMessage

• uint64 mempoolReadyTransactionsCount = 1

• uint64 mempoolReadyTransactionsTotalMass = 2

• uint64 networkMassPerSecond = 3

• double nextBlockTemplateFeerateMin = 11

• double nextBlockTemplateFeerateMedian = 12

• double nextBlockTemplateFeerateMax = 13

Used in: RpcFeeEstimate

• double feerate = 1

  Fee/mass of a transaction in `sompi/gram` units

• double estimatedSeconds = 2

Used in: GetMempoolEntriesResponseMessage, GetMempoolEntryResponseMessage, RpcMempoolEntryByAddress

• uint64 fee = 1

• optional RpcTransaction transaction = 3

• bool isOrphan = 4

Used in: GetMempoolEntriesByAddressesResponseMessage

• string address = 1

• repeated RpcMempoolEntry sending = 2

• repeated RpcMempoolEntry receiving = 3

Used in: NotifyBlockAddedRequestMessage, NotifyFinalityConflictRequestMessage, NotifyNewBlockTemplateRequestMessage, NotifyPruningPointUtxoSetOverrideRequestMessage, NotifySinkBlueScoreChangedRequestMessage, NotifyUtxosChangedRequestMessage, NotifyVirtualChainChangedRequestMessage, NotifyVirtualDaaScoreChangedRequestMessage

• NOTIFY_START = 0

• NOTIFY_STOP = 1

Used in: RpcOptionalTransactionOutput

• optional RpcCovenantBinding covenant = 1

Used in: RpcChainBlockAcceptedTransactions

• optional string hash = 2

• optional uint32 version = 3

• repeated RpcBlockLevelRun parentsByLevel = 4

• optional string hashMerkleRoot = 5

• optional string acceptedIdMerkleRoot = 6

• optional string utxoCommitment = 7

• optional int64 timestamp = 8

• optional uint32 bits = 9

• optional uint64 nonce = 10

• optional uint64 daaScore = 11

• optional string blueWork = 12

• optional uint64 blueScore = 13

• optional string pruningPoint = 14

Used in: RpcChainBlockAcceptedTransactions

• optional uint32 version = 2

• repeated RpcOptionalTransactionInput inputs = 3

• repeated RpcOptionalTransactionOutput outputs = 4

• optional uint64 lockTime = 5

• optional string subnetworkId = 6

• optional uint64 gas = 7

• optional string payload = 8

• optional uint64 mass = 9

• optional RpcOptionalTransactionVerboseData verboseData = 10

Used in: RpcOptionalTransaction

• optional RpcOptionalTransactionOutpoint previousOutpoint = 2

• optional string signatureScript = 3

• optional uint64 sequence = 4

• optional uint32 sigOpCount = 5

• optional RpcOptionalTransactionInputVerboseData verboseData = 6

• optional uint32 computeBudget = 7

  Replaces sigop count for tx version >= 1.

Used in: RpcOptionalTransactionInput

• optional RpcOptionalUtxoEntry utxoEntry = 2

Used in: RpcOptionalTransactionInput

• optional string transactionId = 2

• optional uint32 index = 3

Used in: RpcOptionalTransaction

• optional uint64 value = 2

• optional RpcScriptPublicKey scriptPublicKey = 3

• optional RpcOptionalTransactionOutputVerboseData verboseData = 4

• optional RpcNullableCovenantBinding covenant = 5

Used in: RpcOptionalTransactionOutput

• optional string scriptPublicKeyType = 2

• optional string scriptPublicKeyAddress = 3

Used in: RpcOptionalTransaction

• optional string transactionId = 2

• optional string hash = 3

• optional uint64 computeMass = 4

• optional string blockHash = 5

• optional uint64 blockTime = 6

Used in: RpcOptionalTransactionInputVerboseData

• optional uint64 amount = 2

• optional RpcScriptPublicKey scriptPublicKey = 3

• optional uint64 blockDaaScore = 4

• optional bool isCoinbase = 5

• optional RpcOptionalUtxoEntryVerboseData verboseData = 6

• optional string CovenantId = 7

Used in: RpcOptionalUtxoEntry

• optional string scriptPublicKeyType = 2

• optional string scriptPublicKeyAddress = 3

Used in: RpcTransactionInput, RpcUtxosByAddressesEntry

• string transactionId = 1

• uint32 index = 2

Used in: RpcOptionalTransactionOutput, RpcOptionalUtxoEntry, RpcTransactionOutput, RpcUtxoEntry

• uint32 version = 1

• string scriptPublicKey = 2

Used in: RpcBlock, RpcMempoolEntry, SubmitTransactionReplacementRequestMessage, SubmitTransactionReplacementResponseMessage, SubmitTransactionRequestMessage

• uint32 version = 1

• repeated RpcTransactionInput inputs = 2

• repeated RpcTransactionOutput outputs = 3

• uint64 lockTime = 4

• string subnetworkId = 5

• uint64 gas = 6

• string payload = 8

• optional RpcTransactionVerboseData verboseData = 9

• uint64 storage_mass = 10

Used in: RpcTransaction

• optional RpcOutpoint previousOutpoint = 1

• string signatureScript = 2

• uint64 sequence = 3

• uint32 sigOpCount = 5

• optional RpcTransactionInputVerboseData verboseData = 4

• uint32 computeBudget = 6

  Replaces sigop count for tx version >= 1.

Used in: RpcTransactionInput

• optional RpcUtxoEntry utxoEntry = 1

  this field is new, if this is null, the utxo cannot be found, or is coinbase.

Used in: RpcTransaction

• uint64 amount = 1

• optional RpcScriptPublicKey scriptPublicKey = 2

• optional RpcTransactionOutputVerboseData verboseData = 3

• optional RpcCovenantBinding covenant = 4

Used in: RpcTransactionOutput

• string scriptPublicKeyType = 5

• string scriptPublicKeyAddress = 6

Used in: RpcTransaction

• string transactionId = 1

• string hash = 2

• uint64 computeMass = 4

• string blockHash = 12

• uint64 blockTime = 14

Used in: RpcTransactionInputVerboseData, RpcUtxosByAddressesEntry

• uint64 amount = 1

• optional RpcScriptPublicKey scriptPublicKey = 2

• uint64 blockDaaScore = 3

• bool isCoinbase = 4

• optional RpcUtxoEntryVerboseData verboseData = 5

• string covenant_id = 6

Used in: RpcUtxoEntry

• string scriptPublicKeyType = 5

• string scriptPublicKeyAddress = 6

Used in: GetUtxosByAddressesResponseMessage, UtxosChangedNotificationMessage

• string address = 1

• optional RpcOutpoint outpoint = 2

• optional RpcUtxoEntry utxoEntry = 3

ShutdownRequestMessage shuts down this kaspad.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• optional RPCError error = 1000

SinkBlueScoreChangedNotificationMessage is sent whenever the blue score of the virtual's selected parent changes. See NotifySinkBlueScoreChangedRequestMessage

Used in: KaspadResponse

• uint64 sinkBlueScore = 1

StopNotifyingPruningPointUtxoSetOverrideRequestMessage unregisters this connection for pruning point UTXO set override notifications. This call is only available when this kaspad was started with `--utxoindex` See: PruningPointUtxoSetOverrideNotificationMessage This message only exists for backward compatibility reason with kaspad and is deprecated. Use instead NotifyPruningPointUtxoSetOverrideRequestMessage with command = NOTIFY_STOP.

Used in: KaspadRequest

(message has no fields)

Used in: KaspadResponse

• optional RPCError error = 1000

StopNotifyingUtxosChangedRequestMessage unregisters this connection for utxoChanged notifications for the given addresses. This call is only available when this kaspad was started with `--utxoindex` See: UtxosChangedNotificationMessage This message only exists for backward compatibility reason with kaspad and is deprecated. Use instead UtxosChangedNotificationMessage with command = NOTIFY_STOP.

Used in: KaspadRequest

• repeated string addresses = 1

Used in: KaspadResponse

• optional RPCError error = 1000

Used in: GetMetricsResponseMessage

• uint64 storageSizeBytes = 1

SubmitBlockRequestMessage requests to submit a block into the DAG. Blocks are generally expected to have been generated using the getBlockTemplate call. See: GetBlockTemplateRequestMessage

Used in: KaspadRequest

• optional RpcBlock block = 2

• bool allowNonDAABlocks = 3

Used in: KaspadResponse

• SubmitBlockResponseMessage.RejectReason rejectReason = 1

• optional RPCError error = 1000

Used in: SubmitBlockResponseMessage

• NONE = 0

• BLOCK_INVALID = 1

• IS_IN_IBD = 2

SubmitTransactionReplacementRequestMessage submits a transaction to the mempool, applying a mandatory Replace by Fee policy

Used in: KaspadRequest

• optional RpcTransaction transaction = 1

Used in: KaspadResponse

• string transactionId = 1

  The transaction ID of the submitted transaction

• optional RpcTransaction replacedTransaction = 2

  The previous transaction replaced in the mempool by the newly submitted one

• optional RPCError error = 1000

SubmitTransactionRequestMessage submits a transaction to the mempool

Used in: KaspadRequest

• optional RpcTransaction transaction = 1

• bool allowOrphan = 2

Used in: KaspadResponse

• string transactionId = 1

  The transaction ID of the submitted transaction

• optional RPCError error = 1000

UnbanRequestMessage unbans the given ip.

Used in: KaspadRequest

• string ip = 1

Used in: KaspadResponse

• optional RPCError error = 1000

UtxosChangedNotificationMessage is sent whenever the UTXO index had been updated. See: NotifyUtxosChangedRequestMessage

Used in: KaspadResponse

• repeated RpcUtxosByAddressesEntry added = 1

• repeated RpcUtxosByAddressesEntry removed = 2

VirtualChainChangedNotificationMessage is sent whenever the DAG's selected parent chain had changed. See: NotifyVirtualChainChangedRequestMessage

Used in: KaspadResponse

• repeated string removedChainBlockHashes = 1

  The chain blocks that were removed, in high-to-low order

• repeated string addedChainBlockHashes = 3

  The chain blocks that were added, in low-to-high order

• repeated RpcAcceptedTransactionIds acceptedTransactionIds = 2

  Will be filled only if `includeAcceptedTransactionIds = true` in the notify request.

VirtualDaaScoreChangedNotificationMessage is sent whenever the DAA score of the virtual changes. See NotifyVirtualDaaScoreChangedRequestMessage

Used in: KaspadResponse

• uint64 virtualDaaScore = 1