protocol/json/keybase1/merkle.json - master - githubmirror/client

protocol/json/keybase1/merkle.json

80 строк2 KB

Maxwell Krohn

verifyMerkleRootAndKBFS RPC (#12098)

30 май 2018, 22:04

30 май 2018, 22:049681504

{
  "protocol": "merkle",
  "imports": [
    {
      "path": "common.avdl",
      "type": "idl"
    },
    {
      "path": "upk.avdl",
      "type": "idl"
    }
  ],
  "types": [
    {
      "type": "record",
      "name": "MerkleRootAndTime",
      "fields": [
        {
          "type": "MerkleRootV2",
          "name": "root"
        },
        {
          "type": "Time",
          "name": "updateTime"
        },
        {
          "type": "Time",
          "name": "fetchTime"
        }
      ]
    },
    {
      "type": "record",
      "name": "KBFSRootHash",
      "fields": [],
      "typedef": "bytes"
    },
    {
      "type": "record",
      "name": "KBFSRoot",
      "fields": [
        {
          "type": "MerkleTreeID",
          "name": "treeID"
        },
        {
          "type": "KBFSRootHash",
          "name": "root"
        }
      ]
    }
  ],
  "messages": {
    "getCurrentMerkleRoot": {
      "request": [
        {
          "name": "freshnessMsec",
          "type": "int"
        }
      ],
      "response": "MerkleRootAndTime",
      "doc": "GetCurrentMerkleRoot gets the current-most Merkle root from the keybase server.\n    The caller can specify how stale a result can be with freshnessMsec.\n    If 0 is specified, then any amount of staleness is OK. If -1 is specified, then\n    we force a GET and a round-trip."
    },
    "verifyMerkleRootAndKBFS": {
      "request": [
        {
          "name": "root",
          "type": "MerkleRootV2"
        },
        {
          "name": "expectedKBFSRoot",
          "type": "KBFSRoot"
        }
      ],
      "response": null,
      "doc": "VerifyMerkleRootAndKBFS checks that the given merkle root is indeed a valid\n    root of the keybase server's Merkle tree, and that the given KBFS root\n    is included in that global root."
    }
  },
  "namespace": "keybase.1"
}