package tari.rpc

Get desktop application:
View/edit binary Protocol Buffers messages

The gRPC interface for interacting with the base node.

• rpc ListHeaders (ListHeadersRequest, stream BlockHeaderResponse)

  base_node.proto:35

  Lists headers in the current best chain

  message ListHeadersRequest

  base_node.proto:310

  The request used for querying headers from the base node. The parameters `from_height` and `num_headers` can be used to page through the current best chain.

  • uint64 from_height = 1

    The height to start at. Depending on sorting, will either default to use the tip or genesis block, for `SORTING_DESC` and `SORTING_ASC` respectively, if a value is not provided. The first header returned will be at this height followed by `num_headers` - 1 headers in the direction specified by `sorting`. If greater than the current tip, the current tip will be used.

  • uint64 num_headers = 2

    The number of headers to return. If not specified, it will default to 10

  • Sorting sorting = 3

    The ordering to return the headers in. If not specified will default to SORTING_DESC. Note that if `from_height` is not specified or is 0, if `sorting` is SORTING_DESC, the tip will be used as `from_height`, otherwise the block at height 0 will be used.

• rpc GetHeaderByHash (GetHeaderByHashRequest, BlockHeaderResponse)

  base_node.proto:37

  Get header by hash

  message GetHeaderByHashRequest

  base_node.proto:289

  Request that returns a header based by hash

  • bytes hash = 1

    The hash of the block header

• rpc GetBlocks (GetBlocksRequest, stream HistoricalBlock)

  base_node.proto:39

  Returns blocks in the current best chain. Currently only supports querying by height

• rpc GetBlockTiming (HeightRequest, BlockTimingResponse)

  base_node.proto:41

  Returns the block timing for the chain heights

  message BlockTimingResponse

  base_node.proto:282

  The return type of the rpc GetBlockTiming

  • uint64 max = 1

  • uint64 min = 2

  • double avg = 3

• rpc GetConstants (BlockHeight, ConsensusConstants)

  base_node.proto:43

  Returns the network Constants

  message BlockHeight

  types.proto:36

  / Define an interface for block height

  • uint64 block_height = 1

  message ConsensusConstants

  types.proto:112

  / Consensus Constants response

  • uint64 coinbase_min_maturity = 1

  • uint32 blockchain_version = 2

  • uint64 future_time_limit = 3

  • uint64 difficulty_block_window = 5

  • uint64 max_block_transaction_weight = 7

  • uint64 pow_algo_count = 8

  • uint64 median_timestamp_count = 9

  • uint64 emission_initial = 10

  • repeated uint64 emission_decay = 11

  • uint64 emission_tail = 12

  • uint64 min_sha3x_pow_difficulty = 13

  • uint64 block_weight_inputs = 14

  • uint64 block_weight_outputs = 15

  • uint64 block_weight_kernels = 16

  • uint64 pre_mine_value = 17

  • uint64 max_script_byte_size = 18

  • uint64 validator_node_validity_period = 19

  • uint64 effective_from_height = 20

  • optional Range valid_blockchain_version_range = 21

  • uint64 max_randomx_seed_height = 22

  • map<uint32, PowAlgorithmConstants> proof_of_work = 23

  • optional WeightParams transaction_weight = 24

  • optional Range input_version_range = 26

  • optional OutputsVersion output_version_range = 27

  • optional Range kernel_version_range = 28

  • repeated OutputType permitted_output_types = 29

  • uint64 epoch_length = 30

  • uint64 validator_node_registration_min_deposit_amount = 31

  • uint64 validator_node_registration_min_lock_height = 32

  • uint64 validator_node_registration_shuffle_interval_epoch = 33

  • repeated PermittedRangeProofs permitted_range_proof_types = 34

  • uint64 inflation_bips = 35

  • uint64 tail_epoch_length = 36

  • uint64 max_block_coinbase_count = 37

• rpc GetBlockSize (BlockGroupRequest, BlockGroupResponse)

  base_node.proto:45

  Returns Block Sizes

• rpc GetBlockFees (BlockGroupRequest, BlockGroupResponse)

  base_node.proto:47

  Returns Block Fees

• rpc GetVersion (Empty, StringValue)

  base_node.proto:49

  Get Version

  message StringValue

  base_node.proto:238

  A generic String value

  • string value = 1

• rpc CheckForUpdates (Empty, SoftwareUpdate)

  base_node.proto:51

  Check for new updates

  message SoftwareUpdate

  network.proto:84

  • bool has_update = 1

  • string version = 2

  • string sha = 3

  • string download_url = 4

• rpc GetTokensInCirculation (GetBlocksRequest, stream ValueAtHeightResponse)

  base_node.proto:53

  Get coins in circulation

  message ValueAtHeightResponse

  base_node.proto:227

  A generic single value response for a specific height

  • uint64 value = 1

  • uint64 height = 2

• rpc GetNetworkDifficulty (HeightRequest, stream NetworkDifficultyResponse)

  base_node.proto:55

  Get network difficulties

  message NetworkDifficultyResponse

  base_node.proto:214

  Network difficulty response

  • uint64 difficulty = 1

  • uint64 estimated_hash_rate = 2

  • uint64 height = 3

  • uint64 timestamp = 4

  • uint64 pow_algo = 5

  • uint64 sha3x_estimated_hash_rate = 6

  • uint64 randomx_estimated_hash_rate = 7

  • uint64 num_coinbases = 8

  • repeated bytes coinbase_extras = 9

• rpc GetNewBlockTemplate (NewBlockTemplateRequest, NewBlockTemplateResponse)

  base_node.proto:57

  Get the block template

  message NewBlockTemplateRequest

  base_node.proto:185

  / return type of NewBlockTemplateRequest

  • optional PowAlgo algo = 1

  • uint64 max_weight = 2

    This field should be moved to optional once optional keyword is standard

  message NewBlockTemplateResponse

  base_node.proto:178

  / return type of GetNewBlockTemplate

  • optional NewBlockTemplate new_block_template = 1

  • bool initial_sync_achieved = 3

  • optional MinerData miner_data = 4

• rpc GetNewBlock (NewBlockTemplate, GetNewBlockResult)

  base_node.proto:59

  Construct a new block from a provided template

• rpc GetNewBlockWithCoinbases (GetNewBlockWithCoinbasesRequest, GetNewBlockResult)

  base_node.proto:61

  Construct a new block from a provided template

  message GetNewBlockWithCoinbasesRequest

  base_node.proto:200

  / request type of GetNewBlockWithCoinbasesRequest

  • optional NewBlockTemplate new_template = 1

  • repeated NewBlockCoinbase coinbases = 2

• rpc GetNewBlockTemplateWithCoinbases (GetNewBlockTemplateWithCoinbasesRequest, GetNewBlockResult)

  base_node.proto:63

  Construct a new block from a provided template

  message GetNewBlockTemplateWithCoinbasesRequest

  base_node.proto:192

  / return type of NewBlockTemplateRequest

  • optional PowAlgo algo = 1

  • uint64 max_weight = 2

    This field should be moved to optional once optional keyword is standard

  • repeated NewBlockCoinbase coinbases = 3

• rpc GetNewBlockBlob (NewBlockTemplate, GetNewBlockBlobResult)

  base_node.proto:65

  Construct a new block and header blob from a provided template

  message GetNewBlockBlobResult

  base_node.proto:388

  This is the message that is returned for a miner after it asks for a new block.

  • bytes block_hash = 1

    This is the header hash of the completed block

  • bytes header = 2

    This is the completed block's header

  • bytes block_body = 3

    This is the completed block's body

  • bytes merge_mining_hash = 4

  • bytes utxo_mr = 5

  • bytes tari_unique_id = 6

• rpc SubmitBlock (Block, SubmitBlockResponse)

  base_node.proto:67

  Submit a new block for propagation

• rpc SubmitBlockBlob (BlockBlobRequest, SubmitBlockResponse)

  base_node.proto:69

  Submit a new mined block blob for propagation

  message BlockBlobRequest

  base_node.proto:154

  • bytes header_blob = 1

  • bytes body_blob = 2

• rpc SubmitTransaction (SubmitTransactionRequest, SubmitTransactionResponse)

  base_node.proto:71

  Submit a transaction for propagation

  message SubmitTransactionRequest

  base_node.proto:434

  • optional Transaction transaction = 1

  message SubmitTransactionResponse

  base_node.proto:438

  • SubmitTransactionResult result = 1

• rpc GetSyncInfo (Empty, SyncInfoResponse)

  base_node.proto:73

  Get the base node sync information

  message SyncInfoResponse

  base_node.proto:353

  • uint64 tip_height = 1

  • uint64 local_height = 2

  • repeated bytes peer_node_id = 3

• rpc GetSyncProgress (Empty, SyncProgressResponse)

  base_node.proto:75

  Get the base node sync information

  message SyncProgressResponse

  base_node.proto:359

  • uint64 tip_height = 1

  • uint64 local_height = 2

  • SyncState state = 3

  • string short_desc = 4

  • uint64 initial_connected_peers = 5

• rpc GetTipInfo (Empty, TipInfoResponse)

  base_node.proto:77

  Get the base node tip information

  message TipInfoResponse

  base_node.proto:160

  / return type of GetTipInfo

  • optional MetaData metadata = 1

  • bool initial_sync_achieved = 2

  • BaseNodeState base_node_state = 3

  • bool failed_checkpoints = 4

• rpc SearchKernels (SearchKernelsRequest, stream HistoricalBlock)

  base_node.proto:79

  Search for blocks containing the specified kernels

  message SearchKernelsRequest

  base_node.proto:410

  This is the request type for the Search Kernels rpc

  • repeated Signature signatures = 1

• rpc SearchUtxos (SearchUtxosRequest, stream HistoricalBlock)

  base_node.proto:81

  Search for blocks containing the specified commitments

  message SearchUtxosRequest

  base_node.proto:415

  This is the request type for the Search Utxo rpc

  • repeated bytes commitments = 1

• rpc FetchMatchingUtxos (FetchMatchingUtxosRequest, stream FetchMatchingUtxosResponse)

  base_node.proto:83

  Fetch any utxos that exist in the main chain

  message FetchMatchingUtxosRequest

  base_node.proto:419

  • repeated bytes hashes = 1

  message FetchMatchingUtxosResponse

  base_node.proto:423

  • optional TransactionOutput output = 1

• rpc GetPeers (GetPeersRequest, stream GetPeersResponse)

  base_node.proto:85

  get all peers from the base node

  message GetPeersRequest

  base_node.proto:432

  (message has no fields)

  message GetPeersResponse

  base_node.proto:428

  This is the request type of the get all peers rpc call

  • optional Peer peer = 1

• rpc GetMempoolTransactions (GetMempoolTransactionsRequest, stream GetMempoolTransactionsResponse)

  base_node.proto:86

  message GetMempoolTransactionsRequest

  base_node.proto:451

  (message has no fields)

  message GetMempoolTransactionsResponse

  base_node.proto:455

  • optional Transaction transaction = 1

• rpc TransactionState (TransactionStateRequest, TransactionStateResponse)

  base_node.proto:87

  message TransactionStateRequest

  base_node.proto:459

  • optional Signature excess_sig = 1

  message TransactionStateResponse

  base_node.proto:463

  • TransactionLocation result = 1

• rpc Identify (Empty, NodeIdentity)

  base_node.proto:89

  This returns the node's network identity

  message NodeIdentity

  network.proto:28

  • bytes public_key = 1

  • repeated string public_addresses = 2

  • bytes node_id = 3

• rpc GetNetworkStatus (Empty, NetworkStatusResponse)

  base_node.proto:91

  Get Base Node network connectivity status

  message NetworkStatusResponse

  network.proto:63

  • ConnectivityStatus status = 1

  • uint32 avg_latency_ms = 2

  • uint32 num_node_connections = 3

• rpc ListConnectedPeers (Empty, ListConnectedPeersResponse)

  base_node.proto:93

  List currently connected peers

  message ListConnectedPeersResponse

  network.proto:80

  • repeated Peer connected_peers = 1

• rpc GetMempoolStats (Empty, MempoolStatsResponse)

  base_node.proto:95

  Get mempool stats

  message MempoolStatsResponse

  base_node.proto:474

  • uint64 unconfirmed_txs = 2

  • uint64 reorg_txs = 3

  • uint64 unconfirmed_weight = 4

• rpc GetActiveValidatorNodes (GetActiveValidatorNodesRequest, stream GetActiveValidatorNodesResponse)

  base_node.proto:97

  Get VNs

  message GetActiveValidatorNodesRequest

  base_node.proto:480

  • uint64 height = 1

  message GetActiveValidatorNodesResponse

  base_node.proto:484

  • bytes shard_key = 1

  • bytes public_key = 2

• rpc GetShardKey (GetShardKeyRequest, GetShardKeyResponse)

  base_node.proto:98

  message GetShardKeyRequest

  base_node.proto:489

  • uint64 height = 1

  • bytes public_key = 2

  message GetShardKeyResponse

  base_node.proto:494

  • bytes shard_key = 1

  • bool found = 2

• rpc GetTemplateRegistrations (GetTemplateRegistrationsRequest, stream GetTemplateRegistrationResponse)

  base_node.proto:100

  Get templates

  message GetTemplateRegistrationsRequest

  base_node.proto:499

  • bytes start_hash = 1

  • uint64 count = 2

  message GetTemplateRegistrationResponse

  base_node.proto:504

  • bytes utxo_hash = 1

  • optional TemplateRegistration registration = 2

• rpc GetSideChainUtxos (GetSideChainUtxosRequest, stream GetSideChainUtxosResponse)

  base_node.proto:101

  message GetSideChainUtxosRequest

  base_node.proto:515

  • bytes start_hash = 1

  • uint64 count = 2

  message GetSideChainUtxosResponse

  base_node.proto:520

  • optional BlockInfo block_info = 1

  • repeated TransactionOutput outputs = 2

• rpc GetNetworkState (GetNetworkStateRequest, GetNetworkStateResponse)

  base_node.proto:102

  message GetNetworkStateRequest

  base_node.proto:525

  (message has no fields)

  message GetNetworkStateResponse

  base_node.proto:528

  • optional MetaData metadata = 1

    metadata

  • bool initial_sync_achieved = 2

    has the base node synced

  • BaseNodeState base_node_state = 3

    current state of the base node

  • bool failed_checkpoints = 4

    do we have failed checkpoints

  • uint64 reward = 5

    The block reward of the next tip

  • uint64 sha3x_estimated_hash_rate = 6

    estimate sha3x hash rate

  • uint64 randomx_estimated_hash_rate = 7

    estimate randomx hash rate

Used in: Peer

• bytes address = 1

• string last_seen = 2

• uint32 connection_attempts = 3

• optional AverageLatency avg_latency = 5

The components of the block or transaction. The same struct can be used for either, since in Mimblewimble, cut-through means that blocks and transactions have the same structure. The inputs, outputs and kernels should be sorted by their Blake2b-256bit digest hash

Used in: Block, NewBlockTemplate, Transaction

• repeated TransactionInput inputs = 1

  List of inputs spent by the transaction.

• repeated TransactionOutput outputs = 2

  List of outputs the transaction produces.

• repeated TransactionKernel kernels = 3

  Kernels contain the excesses and their signatures for transaction

Used in: Address

• uint64 latency = 1

Used in: GetNetworkStateResponse, TipInfoResponse

• START_UP = 0

• HEADER_SYNC = 1

• HORIZON_SYNC = 2

• CONNECTING = 3

• BLOCK_SYNC = 4

• LISTENING = 5

• SYNC_FAILED = 6

A Minotari block. Blocks are linked together into a blockchain.

Used as request type in: BaseNode.SubmitBlock

Used as field type in: GetNewBlockResult, HistoricalBlock

• optional BlockHeader header = 1

  The BlockHeader contains all the metadata for the block, including proof of work, a link to the previous block and the transaction kernels.

• optional AggregateBody body = 2

  The components of the block or transaction. The same struct can be used for either, since in Mimblewimble, blocks consist of inputs, outputs and kernels, rather than transactions.

/ GetBlockSize / GetBlockFees Request / Either the starting and ending heights OR the from_tip param must be specified

Used as request type in: BaseNode.GetBlockFees, BaseNode.GetBlockSize

• uint64 from_tip = 1

  The height from the chain tip (optional)

• uint64 start_height = 2

  The starting height (optional)

• uint64 end_height = 3

  The ending height (optional)

• CalcType calc_type = 4

  / The type of calculation required (optional) / Defaults to median / median, mean, quartile, quantile

/ GetBlockSize / GetBlockFees Response

Used as response type in: BaseNode.GetBlockFees, BaseNode.GetBlockSize

• repeated double value = 1

• CalcType calc_type = 2

The BlockHeader contains all the metadata for the block, including proof of work, a link to the previous block and the transaction kernels.

Used in: Block, BlockHeaderResponse

• bytes hash = 1

  The hash of the block

• uint32 version = 2

  Version of the block

• uint64 height = 3

  Height of this block since the genesis block (height 0)

• bytes prev_hash = 4

  Hash of the block previous to this in the chain.

• uint64 timestamp = 5

  Timestamp at which the block was built.

• bytes output_mr = 6

  This is the UTXO merkle root of the outputs in the blockchain

• bytes block_output_mr = 7

  This is the merkle root of all outputs in this block

• bytes kernel_mr = 8

  This is the MMR root of the kernels

• bytes input_mr = 9

  This is the Merkle root of the inputs in this block

• bytes total_kernel_offset = 10

  Total accumulated sum of kernel offsets since genesis block. We can derive the kernel offset sum for *this* block from the total kernel offset of the previous block header.

• uint64 nonce = 11

  Nonce increment used to mine this block.

• optional ProofOfWork pow = 12

  Proof of work metadata

• uint64 kernel_mmr_size = 13

  Kernel MMR size

• uint64 output_mmr_size = 14

  Output MMR size

• bytes total_script_offset = 15

  Sum of script offsets for all kernels in this block.

• bytes validator_node_mr = 16

  Merkle root of validator nodes

• uint64 validator_node_size = 17

  Validator size

Used as response type in: BaseNode.GetHeaderByHash, BaseNode.ListHeaders

• optional BlockHeader header = 1

  The block header

• uint64 confirmations = 2

  The number of blocks from the tip of this block (a.k.a depth)

• uint64 reward = 3

  The block reward i.e mining reward + fees

• uint64 difficulty = 4

  Achieved difficulty

• uint32 num_transactions = 5

  The number of transactions contained in the block

Used in: GetSideChainUtxosResponse

• uint64 height = 1

• bytes hash = 2

• bytes next_block_hash = 3

Used in: TemplateRegistration

• string repo_url = 1

• bytes commit_hash = 2

Used in: BlockGroupRequest, BlockGroupResponse

• MEAN = 0

• MEDIAN = 1

• QUANTILE = 2

• QUARTILE = 3

Define the explicit ComAndPubSignature implementation for the Minotari base layer. A different signature scheme can be employed by redefining this type.

Used in: TransactionInput, TransactionOutput, UnblindedOutput

• bytes ephemeral_commitment = 1

• bytes ephemeral_pubkey = 2

• bytes u_a = 3

• bytes u_x = 4

• bytes u_y = 5

Define the explicit CommitmentSignature implementation for the Minotari base layer. A different signature scheme can be employed by redefining this type

• bytes public_nonce = 1

• bytes u = 2

• bytes v = 3

Used in: SideChainFeature

• bytes claim_public_key = 1

Used in: NetworkStatusResponse

• Initializing = 0

• Online = 1

• Degraded = 2

• Offline = 3

/ An Empty placeholder for endpoints without request parameters

Used as request type in: BaseNode.CheckForUpdates, BaseNode.GetMempoolStats, BaseNode.GetNetworkStatus, BaseNode.GetSyncInfo, BaseNode.GetSyncProgress, BaseNode.GetTipInfo, BaseNode.GetVersion, BaseNode.Identify, BaseNode.ListConnectedPeers

(message has no fields)

Used in: TemplateType

(message has no fields)

• bytes asset_public_key = 1

• string name = 2

• string description = 3

• string image = 4

• bytes owner_commitment = 5

• optional OutputFeatures features = 6

• uint64 mined_height = 7

• bytes mined_in_block = 8

The request used for querying blocks in the base node's current best chain. Currently only querying by height is available. Multiple blocks may be queried.e.g. [189092,100023,122424]. The order in which they are returned is not guaranteed.

Used as request type in: BaseNode.GetBlocks, BaseNode.GetTokensInCirculation

• repeated uint64 heights = 1

The return type of the rpc GetBlocks. Blocks are not guaranteed to be returned in the order requested.

• repeated HistoricalBlock blocks = 1

(message has no fields)

• bytes public_key = 1

• string public_address = 2

• bytes node_id = 3

This is the message that is returned for a miner after it asks for a new block.

Used as response type in: BaseNode.GetNewBlock, BaseNode.GetNewBlockTemplateWithCoinbases, BaseNode.GetNewBlockWithCoinbases

• bytes block_hash = 1

  This is the header hash of the completed block

• optional Block block = 2

  This is the completed block

• bytes merge_mining_hash = 3

• bytes tari_unique_id = 4

• optional MinerData miner_data = 5

• bytes asset_public_key = 1

• repeated bytes unique_ids = 2

  Optionally get a set of specific unique_ids

• bytes unique_id = 1

• bytes asset_public_key = 2

• bytes owner_commitment = 3

• bytes mined_in_block = 4

• uint64 mined_height = 5

• optional OutputFeatures features = 6

• bytes script = 7

The request used for querying a function that requires a height, either between 2 points or from the chain tip If start_height and end_height are set and > 0, they take precedence, otherwise from_tip is used

Used as request type in: BaseNode.GetBlockTiming, BaseNode.GetNetworkDifficulty

• uint64 from_tip = 1

  The height from the chain tip (optional)

• uint64 start_height = 2

  The starting height (optional)

• uint64 end_height = 3

  The ending height (optional)

The representation of a historical block in the blockchain. It is essentially identical to a protocol-defined block but contains some extra metadata that clients such as Block Explorers will find interesting.

Used as response type in: BaseNode.GetBlocks, BaseNode.SearchKernels, BaseNode.SearchUtxos

Used as field type in: GetBlocksResponse

• uint64 confirmations = 1

  The number of blocks that have been mined since this block, including this one. The current tip will have one confirmation.

• optional Block block = 2

  The underlying block

A generic uint value

• uint64 value = 1

• uint64 offset = 2

• uint64 count = 3

• bytes asset_public_key = 1

• bytes unique_id = 2

• bytes owner_commitment = 3

• uint64 mined_height = 4

• bytes mined_in_block = 5

• optional OutputFeatures features = 6

• bytes script = 7

Used in: TemplateType

(message has no fields)

Used in: GetNetworkStateResponse, TipInfoResponse

• uint64 best_block_height = 1

  The current chain height, or the block number of the longest valid chain, or `None` if there is no chain

• bytes best_block_hash = 2

  The block hash of the current tip of the longest valid chain, or `None` for an empty chain

• bytes accumulated_difficulty = 5

  The current geometric mean of the pow of the chain tip, or `None` if there is no chain

• uint64 pruned_height = 6

  This is the min height this node can provide complete blocks for. A 0 here means this node is archival and can provide complete blocks for every height.

• uint64 timestamp = 7

This is mining data for the miner asking for a new block

Used in: GetNewBlockResult, NewBlockTemplateResponse

• optional PowAlgo algo = 1

• uint64 target_difficulty = 2

• uint64 reward = 3

• uint64 total_fees = 5

  bytes merge_mining_hash =4;

Used in: GetNewBlockTemplateWithCoinbasesRequest, GetNewBlockWithCoinbasesRequest

• string address = 1

• uint64 value = 2

• bool stealth_payment = 3

• bool revealed_value_proof = 4

• bytes coinbase_extra = 5

The NewBlockHeaderTemplate is used for the construction of a new mine-able block. It contains all the metadata for the block that the Base Node is able to complete on behalf of a Miner.

Used in: NewBlockTemplate

• uint32 version = 1

  Version of the block

• uint64 height = 2

  Height of this block since the genesis block (height 0)

• bytes prev_hash = 3

  Hash of the block previous to this in the chain.

• bytes total_kernel_offset = 4

  Total accumulated sum of kernel offsets since genesis block. We can derive the kernel offset sum for *this* block from the total kernel offset of the previous block header.

• optional ProofOfWork pow = 5

  Proof of work metadata

• bytes total_script_offset = 7

  Sum of script offsets for all kernels in this block.

The new block template is used constructing a new partial block, allowing a miner to added the coinbase utxo and as a final step the Base node to add the MMR roots to the header.

Used as request type in: BaseNode.GetNewBlock, BaseNode.GetNewBlockBlob

Used as field type in: GetNewBlockWithCoinbasesRequest, NewBlockTemplateResponse

• optional NewBlockHeaderTemplate header = 1

  The NewBlockHeaderTemplate is used for the construction of a new mineable block. It contains all the metadata for the block that the Base Node is able to complete on behalf of a Miner.

• optional AggregateBody body = 2

  This flag indicates if the inputs, outputs and kernels have been sorted internally, that is, the sort() method has been called. This may be false even if all components are sorted.

• bool is_mempool_in_sync = 3

  Sometimes the mempool has not synced to the latest tip, this flag indicates if the mempool is out of sync. In most cases the next call to get_new_block_template will return a block with the mempool in sync.

Options for UTXOs

Used in: GetAssetMetadataResponse, GetTokensResponse, ListAssetRegistrationsResponse, TransactionInput, TransactionOutput, UnblindedOutput

• uint32 version = 1

  Version

• uint32 output_type = 2

  The type of output, eg Coinbase, all of which have different consensus rules

• uint64 maturity = 3

  The maturity of the specific UTXO. This is the min lock height at which an UTXO can be spend. Coinbase UTXO require a min maturity of the Coinbase_lock_height, this should be checked on receiving new blocks.

• bytes coinbase_extra = 4

  Additional arbitrary info in coinbase transactions supplied by miners

• optional SideChainFeature sidechain_feature = 5

  Features that are specific to a side chain

• uint32 range_proof_type = 6

  The type of range proof used in the output

/ Output types

Used in: ConsensusConstants, PermittedRangeProofs

• STANDARD = 0

• COINBASE = 1

• BURN = 2

• VALIDATOR_NODE_REGISTRATION = 3

• CODE_TEMPLATE_REGISTRATION = 4

/ Output version

Used in: ConsensusConstants

• optional Range outputs = 1

• optional Range features = 2

Used in: GetPeersResponse, ListConnectedPeersResponse

• bytes public_key = 1

  / Public key of the peer

• bytes node_id = 2

  / NodeId of the peer

• repeated Address addresses = 3

  / Peer's addresses

• uint64 last_connection = 4

  / Last connection attempt to peer

• uint32 flags = 5

  / Flags for the peer.

• uint64 banned_until = 6

• string banned_reason = 7

• uint64 offline_at = 8

• uint32 features = 9

  / Features supported by the peer

• repeated bytes supported_protocols = 11

  / used as information for more efficient protocol negotiation.

• string user_agent = 12

  / User agent advertised by the peer

Used in: ConsensusConstants

• OutputType output_type = 1

• repeated RangeProofType range_proof_types = 2

This is used to request the which pow algo should be used with the block template

Used in: GetNewBlockTemplateWithCoinbasesRequest, MinerData, NewBlockTemplateRequest

• PowAlgo.PowAlgos pow_algo = 1

  The pow algo to use

The permitted pow algorithms

Used in: PowAlgo

• POW_ALGOS_RANDOMX = 0

  Accessible as `grpc::pow_algo::PowAlgos::Randomx`

• POW_ALGOS_SHA3X = 1

  Accessible as `grpc::pow_algo::PowAlgos::Sha3x`

/ PoW Algorithm constants

Used in: ConsensusConstants

• uint64 min_difficulty = 2

• uint64 max_difficulty = 3

• uint64 target_time = 4

The proof of work data structure that is included in the block header.

Used in: BlockHeader, NewBlockHeaderTemplate

• uint64 pow_algo = 1

  The algorithm used to mine this block 0 = Monero 1 = Sha3X

• bytes pow_data = 4

  Supplemental proof of work data. For example for Sha3x, this would be empty (only the block header is required), but for Monero merge mining we need the Monero block header and RandomX seed hash.

/ An unsigned range interface to more accurately represent Rust native Range's

Used in: ConsensusConstants, OutputsVersion

• uint64 min = 1

• uint64 max = 2

/ Range proof

Used in: TransactionOutput, UnblindedOutput

• bytes proof_bytes = 1

/ Range proof types

Used in: PermittedRangeProofs

• BULLETPROOF_PLUS = 0

• REVEALED_VALUE = 1

Used in: OutputFeatures

• oneof side_chain_feature

  • ValidatorNodeRegistration validator_node_registration = 1

  • TemplateRegistration template_registration = 2

  • ConfidentialOutputData confidential_output = 3

Define the explicit Signature implementation for the Minotari base layer. A different signature scheme can be employed by redefining this type.

Used in: SearchKernelsRequest, TemplateRegistration, TransactionKernel, TransactionStateRequest, ValidatorNodeRegistration

• bytes public_nonce = 1

• bytes signature = 2

Used in: ListHeadersRequest

• SORTING_DESC = 0

• SORTING_ASC = 1

Used as response type in: BaseNode.SubmitBlock, BaseNode.SubmitBlockBlob

• bytes block_hash = 1

Used in: SubmitTransactionResponse

• NONE = 0

• ACCEPTED = 1

• NOT_PROCESSABLE_AT_THIS_TIME = 2

• ALREADY_MINED = 3

• REJECTED = 4

Used in: SyncProgressResponse

• STARTUP = 0

• HEADER_STARTING = 1

• HEADER = 2

• BLOCK_STARTING = 3

• BLOCK = 4

• DONE = 5

Used in: GetTemplateRegistrationResponse, SideChainFeature

• bytes author_public_key = 1

• optional Signature author_signature = 2

• string template_name = 3

• uint32 template_version = 4

• optional TemplateType template_type = 5

• optional BuildInfo build_info = 6

• bytes binary_sha = 7

• string binary_url = 8

Used in: TemplateRegistration

• oneof template_type

  • WasmInfo wasm = 1

  • FlowInfo flow = 2

  • ManifestInfo manifest = 3

A transaction which consists of a kernel offset and an aggregate body made up of inputs, outputs and kernels.

Used in: GetMempoolTransactionsResponse, SubmitTransactionRequest

• bytes offset = 1

• optional AggregateBody body = 2

• bytes script_offset = 3

A transaction input. Primarily a reference to an output being spent by the transaction.

Used in: AggregateBody

• optional OutputFeatures features = 1

  The features of the output being spent. We will check maturity for all outputs.

• bytes commitment = 2

  The commitment referencing the output being spent.

• bytes hash = 3

  Hash of the input, as it appears in the MMR

• bytes script = 4

  The serialised script

• bytes input_data = 5

  The script input data, if any

• optional ComAndPubSignature script_signature = 7

  A signature with k_s, signing the script, input data, and mined height

• bytes sender_offset_public_key = 8

  The offset public key, K_O

• bytes output_hash = 9

  The hash of the output this input is spending

• bytes covenant = 10

  Covenant

• uint32 version = 11

  Version

• bytes encrypted_data = 12

  The encrypted data

• uint64 minimum_value_promise = 13

  The minimum value of the commitment that is proven by the range proof (in MicroMinotari)

• optional ComAndPubSignature metadata_signature = 14

  The metadata signature for output this input is spending

• bytes rangeproof_hash = 15

  The rangeproof hash for output this input is spending

The transaction kernel tracks the excess for a given transaction. For an explanation of what the excess is, and why it is necessary, refer to the [Mimblewimble TLU post](https://tlu.tarilabs.com/protocols/mimblewimble-1/sources/PITCHME.link.html?highlight=mimblewimble#mimblewimble). The kernel also tracks other transaction metadata, such as the lock height for the transaction (i.e. the earliest this transaction can be mined) and the transaction fee, in cleartext.

Used in: AggregateBody

• uint32 features = 1

  Options for a kernel's structure or use

• uint64 fee = 2

  / Fee originally included in the transaction this proof is for (in MicroMinotari)

• uint64 lock_height = 3

  This kernel is not valid earlier than lock_height blocks The max lock_height of all *inputs* to this transaction

• bytes excess = 6

  Remainder of the sum of all transaction commitments. If the transaction is well formed, amounts components should sum to zero and the excess is hence a valid public key.

• optional Signature excess_sig = 7

  The signature proving the excess is a valid public key, which signs the transaction fee.

• bytes hash = 8

  The hash of the kernel, as it appears in the MMR

• uint32 version = 9

  Version

• bytes burn_commitment = 10

  Optional burned commitment

Used in: TransactionStateResponse

• UNKNOWN = 0

• MEMPOOL = 1

• MINED = 2

• NOT_STORED = 3

Output for a transaction, defining the new ownership of coins that are being transferred. The commitment is a blinded value for the output while the range proof guarantees the commitment includes a positive value without overflow and the ownership of the private key.

Used in: AggregateBody, FetchMatchingUtxosResponse, GetSideChainUtxosResponse

• optional OutputFeatures features = 1

  Options for an output's structure or use

• bytes commitment = 2

  The homomorphic commitment representing the output amount

• optional RangeProof range_proof = 3

  A proof that the commitment is in the right range

• bytes hash = 4

  The hash of the output, as it appears in the MMR

• bytes script = 5

  Tari script serialised script

• bytes sender_offset_public_key = 6

  Tari script offset public key, K_O

• optional ComAndPubSignature metadata_signature = 7

  Metadata signature with the homomorphic commitment private values (amount and blinding factor) and the sender offset private key

• bytes covenant = 8

  Covenant

• uint32 version = 9

  Version

• bytes encrypted_data = 10

  Encrypted Pedersen commitment openings (value and mask) for the output

• uint64 minimum_value_promise = 11

  The minimum value of the commitment that is proven by the range proof (in MicroMinotari)

• uint64 value = 1

  Value of the output

• bytes spending_key = 2

  Spending key of the output

• optional OutputFeatures features = 3

  Options for an output's structure or use

• bytes script = 4

  Tari script serialised script

• bytes input_data = 5

  Tari script input data for spending

• bytes script_private_key = 7

  Tari script private key

• bytes sender_offset_public_key = 8

  Tari script offset pubkey, K_O

• optional ComAndPubSignature metadata_signature = 9

  UTXO signature with the script offset private key, k_O

• uint64 script_lock_height = 10

  The minimum height the script allows this output to be spent

• bytes covenant = 11

  Covenant

• bytes encrypted_data = 12

  Encrypted data

• uint64 minimum_value_promise = 13

  The minimum value of the commitment that is proven by the range proof (in MicroMinotari)

• optional RangeProof range_proof = 14

  The range proof

Used in: SideChainFeature

• bytes public_key = 1

• optional Signature signature = 2

Used in: TemplateType

• uint32 abi_version = 1

/ Weight params

Used in: ConsensusConstants

• uint64 kernel_weight = 1

• uint64 input_weight = 2

• uint64 output_weight = 3

• uint64 features_and_scripts_bytes_per_gram = 4