ts-stack/conformance/schema/vector.schema.json at main · ty-everett/ts-stack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://bsv-blockchain.github.io/ts-stack/conformance/schema/vector.schema.json",
  "title": "BSV Conformance Vector File",
  "description": "Schema for cross-language conformance test vector files",
  "type": "object",
  "required": ["id", "name", "version", "reference_impl", "parity_class", "vectors"],
  "properties": {
    "$schema": { "type": "string" },
    "id": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9]*(?:\\.[a-z][a-z0-9]*)*$",
      "description": "Stable dot-separated identifier, e.g. sdk.crypto.ecdsa"
    },
    "name": { "type": "string" },
    "brc": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Related BRC numbers, e.g. ['BRC-42']"
    },
    "version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+$"
    },
    "reference_impl": { "type": "string", "description": "e.g. ts-sdk@2.0.14" },
    "parity_class": {
      "type": "string",
      "enum": ["required", "intended", "best-effort", "unsupported"]
    },
    "vectors": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["id", "description", "input", "expected"],
        "properties": {
          "id": { "type": "string" },
          "description": { "type": "string" },
          "input": { "type": "object" },
          "expected": { "type": "object" },
          "tags": {
            "type": "array",
            "items": { "type": "string" }
          },
          "skip": { "type": "boolean", "description": "If true, skip in CI" },
          "skip_reason": { "type": "string" }
        }
      }
    }
  }
}