aboutsummaryrefslogtreecommitdiff
path: root/doc/schema/inclusion_proof.schema.json
diff options
context:
space:
mode:
Diffstat (limited to 'doc/schema/inclusion_proof.schema.json')
-rw-r--r--doc/schema/inclusion_proof.schema.json30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/schema/inclusion_proof.schema.json b/doc/schema/inclusion_proof.schema.json
new file mode 100644
index 0000000..3309d37
--- /dev/null
+++ b/doc/schema/inclusion_proof.schema.json
@@ -0,0 +1,30 @@
+{
+ "$schema": "https://json-schema.org/draft-07/schema#",
+ "title": "inclusion_proof",
+ "description": "JSON-formatted inclusion proof, version 0.",
+
+ "type": "object",
+ "required": [ "tree_size", "leaf_index", "inclusion_proof" ],
+ "properties": {
+ "tree_size": {
+ "description": "The Merkle tree size that the inclusion proof is based on.",
+ "type": "integer",
+ "minimum": 0
+ },
+ "leaf_index": {
+ "description": "The zero-based index of the leaf that the inclusion proof is for.",
+ "type": "integer",
+ "minimum": 0
+ },
+ "inclusion_proof": {
+ "description": "A list of base64-encoded node hashes that proves inclusion",
+ "type": "array",
+ "items": {
+ "description": "A node hash in base64",
+ "type": "string",
+ "minLength": 44,
+ "maxLength": 44
+ }
+ }
+ }
+}