package protocol

Get desktop application:
View/edit binary Protocol Buffers messages

Unused numbers in the list below may have been used previously. Please don't reassign them for reuse unless you are 100% certain that there won't be a conflict. Even if you're sure, it's probably best to assign a new type.

• mtMANIFESTS = 2

• mtPING = 3

• mtCLUSTER = 5

• mtENDPOINTS = 15

• mtTRANSACTION = 30

• mtGET_LEDGER = 31

• mtLEDGER_DATA = 32

• mtPROPOSE_LEDGER = 33

• mtSTATUS_CHANGE = 34

• mtHAVE_SET = 35

• mtVALIDATION = 41

• mtGET_OBJECTS = 42

• mtGET_SHARD_INFO = 50

• mtSHARD_INFO = 51

• mtGET_PEER_SHARD_INFO = 52

• mtPEER_SHARD_INFO = 53

• mtVALIDATORLIST = 54

• mtSQUELCH = 55

• mtVALIDATORLISTCOLLECTION = 56

• mtPROOF_PATH_REQ = 57

• mtPROOF_PATH_RESPONSE = 58

• mtREPLAY_DELTA_REQ = 59

• mtREPLAY_DELTA_RESPONSE = 60

• mtGET_PEER_SHARD_INFO_V2 = 61

• mtPEER_SHARD_INFO_V2 = 62

• mtHAVE_TRANSACTIONS = 63

• mtTRANSACTIONS = 64

Used in: TMStatusChange

• neCLOSING_LEDGER = 1

  closing a ledger because its close time has come

• neACCEPTED_LEDGER = 2

  accepting a closed ledger, we have finished computing it

• neSWITCHED_LEDGER = 3

  changing due to network consensus

• neLOST_SYNC = 4

Used in: TMStatusChange

• nsCONNECTING = 1

  acquiring connections

• nsCONNECTED = 2

  convinced we are connected to the real network

• nsMONITORING = 3

  we know what the previous ledger is

• nsVALIDATING = 4

  we have the full ledger contents

• nsSHUTTING = 5

  node is shutting down

The status of all nodes in the cluster

• repeated TMClusterNode clusterNodes = 1

• repeated TMLoadSource loadSources = 2

The status of a node in our cluster

Used in: TMCluster

• required string publicKey = 1

• required uint32 reportTime = 2

• required uint32 nodeLoad = 3

• optional string nodeName = 4

• optional string address = 5

An array of Endpoint messages

• required uint32 version = 1

  This field is used to allow the TMEndpoints message format to be modified as necessary in the future.

• repeated TMEndpoints.TMEndpointv2 endpoints_v2 = 3

An update to the Endpoint type that uses a string to represent endpoints, thus allowing ipv6 or ipv4 addresses

Used in: TMEndpoints

• required string endpoint = 1

• required uint32 hops = 2

• required TMLedgerInfoType itype = 1

• optional TMLedgerType ltype = 2

• optional bytes ledgerHash = 3

  Can also be the transaction set hash if liTS_CANDIDATE

• optional uint32 ledgerSeq = 4

• repeated bytes nodeIDs = 5

• optional uint64 requestCookie = 6

• optional TMQueryType queryType = 7

• optional uint32 queryDepth = 8

  How deep to go, number of extra levels

• required TMGetObjectByHash.ObjectType type = 1

• required bool query = 2

  is this a query or a reply?

• optional uint32 seq = 3

  used to match replies to queries

• optional bytes ledgerHash = 4

  the hash of the ledger these queries are for

• optional bool fat = 5

  return related nodes

• repeated TMIndexedObject objects = 6

  the specific objects requested

Used in: TMGetObjectByHash

• otUNKNOWN = 0

• otLEDGER = 1

• otTRANSACTION = 2

• otTRANSACTION_NODE = 3

• otSTATE_NODE = 4

• otCAS_OBJECT = 5

• otFETCH_PACK = 6

• otTRANSACTIONS = 7

Request info on shards held

• required uint32 hops = 1

  number of hops to travel

• optional bool lastLink = 2

  true if last link in the peer chain

• repeated TMLink peerChain = 3

  public keys used to route messages

Request peer shard information

• repeated TMPublicKey peerChain = 1

  Peer public keys used to route messages

• required uint32 relays = 2

  Remaining times to relay

• required TxSetStatus status = 1

• required bytes hash = 2

• repeated bytes hashes = 1

Used in: TMGetObjectByHash

• optional bytes hash = 1

• optional bytes nodeID = 2

• optional bytes index = 3

• optional bytes data = 4

• optional uint32 ledgerSeq = 5

• required bytes ledgerHash = 1

• required uint32 ledgerSeq = 2

• required TMLedgerInfoType type = 3

• repeated TMLedgerNode nodes = 4

• optional uint32 requestCookie = 5

• optional TMReplyError error = 6

Used in: TMGetLedger, TMLedgerData

• liBASE = 0

  basic ledger info

• liTX_NODE = 1

  transaction node

• liAS_NODE = 2

  account state node

• liTS_CANDIDATE = 3

  candidate transaction set

Used in: TMProofPathRequest, TMProofPathResponse

• lmTRANASCTION = 1

  transaction map

• lmACCOUNT_STATE = 2

  account state map

Used in: TMLedgerData

• required bytes nodedata = 1

• optional bytes nodeid = 2

  missing for ledger base data

Used in: TMGetLedger

• ltACCEPTED = 0

• ltCURRENT = 1

  no longer supported

• ltCLOSED = 2

Node public key

Used in: TMGetPeerShardInfo, TMPeerShardInfo

• required bytes nodePubKey = 1

  node public key

Sources that are placing load on the server

Used in: TMCluster

• required string name = 1

• required uint32 cost = 2

• optional uint32 count = 3

  number of connections

Provides the current ephemeral key for a validator.

Used in: TMManifests

• required bytes stobject = 1

  A Manifest object in the Ripple serialization format.

• repeated TMManifest list = 1

• optional bool history = 2

  The manifests sent when a peer first connects to another peer are `history`.

Info about shards held

• required string shardIndexes = 1

  rangeSet of shard indexes

• optional bytes nodePubKey = 2

  node public key

• optional string endpoint = 3

  ipv6 or ipv4 address

• optional bool lastLink = 4

  true if last link in the peer chain

• repeated TMLink peerChain = 5

  public keys used to route messages

Peer shard information

• required uint32 timestamp = 1

  Message creation time

• repeated TMPeerShardInfoV2.TMIncomplete incomplete = 2

  Incomplete shards being acquired or verified

• optional string finalized = 3

  Verified immutable shards (RangeSet)

• required bytes publicKey = 4

  Public key of node that authored the shard info

• required bytes signature = 5

  Digital signature of node that authored the shard info

• repeated TMPublicKey peerChain = 6

  Peer public keys used to route messages

Used in: TMPeerShardInfoV2

• required uint32 shardIndex = 1

• required uint32 state = 2

• optional uint32 progress = 3

  State completion percent, 1 - 100

• required TMPing.pingType type = 1

• optional uint32 seq = 2

  detect stale replies, ensure other side is reading

• optional uint64 pingTime = 3

  know when we think we sent the ping

• optional uint64 netTime = 4

Used in: TMPing

• ptPING = 0

  we want a reply

• ptPONG = 1

  this is a reply

• required bytes key = 1

• required bytes ledgerHash = 2

• required TMLedgerMapType type = 3

• required bytes key = 1

• required bytes ledgerHash = 2

• required TMLedgerMapType type = 3

• optional bytes ledgerHeader = 4

• repeated bytes path = 5

• optional TMReplyError error = 6

Announce to the network our position on a closing ledger

• required uint32 proposeSeq = 1

• required bytes currentTxHash = 2

  the hash of the ledger we are proposing

• required bytes nodePubKey = 3

• required uint32 closeTime = 4

• required bytes signature = 5

  signature of above fields

• required bytes previousledger = 6

• repeated bytes addedTransactions = 10

  not required if number is large

• repeated bytes removedTransactions = 11

  not required if number is large

• optional bool checkedSignature = 7

  node vouches signature is correct

• optional uint32 hops = 12

  Number of hops traveled

Peer public key

Used in: TMGetPeerShardInfoV2, TMPeerShardInfoV2

• required bytes publicKey = 1

Used in: TMGetLedger

• qtINDIRECT = 0

• required bytes ledgerHash = 1

• required bytes ledgerHash = 1

• optional bytes ledgerHeader = 2

• repeated bytes transaction = 3

• optional TMReplyError error = 4

Used in: TMLedgerData, TMProofPathResponse, TMReplayDeltaResponse

• reNO_LEDGER = 1

  We don't have the ledger you are asking about

• reNO_NODE = 2

  We don't have any of the nodes you are asking for

• reBAD_REQUEST = 3

  The request is wrong, e.g. wrong format

• required bool squelch = 1

  squelch if true, otherwise unsquelch

• required bytes validatorPubKey = 2

  validator's public key

• optional uint32 squelchDuration = 3

  squelch duration in seconds

• optional NodeStatus newStatus = 1

• optional NodeEvent newEvent = 2

• optional uint32 ledgerSeq = 3

• optional bytes ledgerHash = 4

• optional bytes ledgerHashPrevious = 5

• optional uint64 networkTime = 6

• optional uint32 firstSeq = 7

• optional uint32 lastSeq = 8

Used in: TMTransactions

• required bytes rawTransaction = 1

• required TransactionStatus status = 2

• optional uint64 receiveTimestamp = 3

• optional bool deferred = 4

  not applied to open ledger

• repeated TMTransaction transactions = 1

Used to sign a final closed ledger after reprocessing

• required bytes validation = 1

  The serialized validation

• optional bool checkedSignature = 2

  node vouches signature is correct

• optional uint32 hops = 3

  Number of hops traveled

Validator list (UNL)

• required bytes manifest = 1

• required bytes blob = 2

• required bytes signature = 3

• required uint32 version = 4

Collection of Validator List v2 (UNL)

• required uint32 version = 1

• required bytes manifest = 2

• repeated ValidatorBlobInfo blobs = 3

Used in: TMTransaction

• tsNEW = 1

  origin node did/could not validate

• tsCURRENT = 2

  scheduled to go in this ledger

• tsCOMMITED = 3

  in a closed ledger

• tsREJECT_CONFLICT = 4

• tsREJECT_INVALID = 5

• tsREJECT_FUNDS = 6

• tsHELD_SEQ = 7

• tsHELD_LEDGER = 8

  held for future ledger

Used in: TMHaveTransactionSet

• tsHAVE = 1

  We have this set locally

• tsCAN_GET = 2

  We have a peer with this set

• tsNEED = 3

  We need this set and can't get it

Validator List v2

Used in: TMValidatorListCollection

• optional bytes manifest = 1

• required bytes blob = 2

• required bytes signature = 3