Resources lookup schema

Explore

Loading ....

View source

YAML

ethdebug/format/info/resources

$schema: "https://json-schema.org/draft/2020-12/schema"
$id: "schema:ethdebug/format/info/resources"

title: ethdebug/format/info/resources
description: |
  An object containing lookup tables for finding debugging resources by name.

type: object

properties:
  ethdebug:
    title: Stamp
    description: |
      Names this schema and the specification version. A resources
      object must carry this field. All objects of one compilation
      must name the same `version`.
    allOf:
      - $ref: "schema:ethdebug/format/data/stamp"
      # note: whitespace chars are \255 (nbsp)
      - title: '{ "schema": "ethdebug/format/info/resources" }'
        properties:
          schema:
            $dynamicRef: "#SchemaName"

  types:
    title: Types by name
    description: |
      A collection of types by name identifier.
    type: object
    additionalProperties:
      $ref: "schema:ethdebug/format/type"

  pointers:
    title: Pointer templates by name
    description: |
      A collection of pointer templates by name identifier.
    type: object
    additionalProperties:
      $ref: "schema:ethdebug/format/pointer/template"

  compilation:
    $ref: "schema:ethdebug/format/materials/compilation"

required:
  - ethdebug
  - types
  - pointers

$defs:
  SchemaName:
    $dynamicAnchor: SchemaName
    description: |
      The schema name that the `ethdebug` field's `schema` must give. A
      schema that references this one can supply its own name here with
      a `SchemaName` dynamic anchor.
    const: "ethdebug/format/info/resources"

examples:
  - ethdebug:
      schema: "ethdebug/format/info/resources"
      version: "0.1.0-draft.1"
    types:
      "struct__Coordinate":
        kind: struct
        contains:
          - name: x
            type:
              kind: uint
              bits: 128
          - name: y
            type:
              kind: uint
              bits: 128
        definition:
          name: Coordinate
          location:
            source:
              id: 5
            range:
              offset: 18
              length: 55

    pointers:
      "struct__Coordinate__storage":
        expect:
          - contract_variable_slot__struct__Coordinate__storage
        for:
          group:
            - name: member__x__struct__Coordinate__storage
              location: storage
              slot: contract_variable_slot__struct__Coordinate__storage
              offset: 0
              length: 16
            - name: member__y__struct__Coordinate__storage
              location: storage
              slot: contract_variable_slot__struct__Coordinate__storage
              offset:
                $sum:
                  - .offset: member__x__struct__Coordinate__storage
                  - .length: member__x__struct__Coordinate__storage
              length: 16

JSON

ethdebug/format/info/resources

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schema:ethdebug/format/info/resources",
  "title": "ethdebug/format/info/resources",
  "description": "An object containing lookup tables for finding debugging resources by name.\n",
  "type": "object",
  "properties": {
    "ethdebug": {
      "title": "Stamp",
      "description": "Names this schema and the specification version. A resources\nobject must carry this field. All objects of one compilation\nmust name the same `version`.\n",
      "allOf": [
        {
          "$ref": "schema:ethdebug/format/data/stamp"
        },
        {
          "title": "{ \"schema\": \"ethdebug/format/info/resources\" }",
          "properties": {
            "schema": {
              "$dynamicRef": "#SchemaName"
            }
          }
        }
      ]
    },
    "types": {
      "title": "Types by name",
      "description": "A collection of types by name identifier.\n",
      "type": "object",
      "additionalProperties": {
        "$ref": "schema:ethdebug/format/type"
      }
    },
    "pointers": {
      "title": "Pointer templates by name",
      "description": "A collection of pointer templates by name identifier.\n",
      "type": "object",
      "additionalProperties": {
        "$ref": "schema:ethdebug/format/pointer/template"
      }
    },
    "compilation": {
      "$ref": "schema:ethdebug/format/materials/compilation"
    }
  },
  "required": [
    "ethdebug",
    "types",
    "pointers"
  ],
  "$defs": {
    "SchemaName": {
      "$dynamicAnchor": "SchemaName",
      "description": "The schema name that the `ethdebug` field's `schema` must give. A\nschema that references this one can supply its own name here with\na `SchemaName` dynamic anchor.\n",
      "const": "ethdebug/format/info/resources"
    }
  },
  "examples": [
    {
      "ethdebug": {
        "schema": "ethdebug/format/info/resources",
        "version": "0.1.0-draft.1"
      },
      "types": {
        "struct__Coordinate": {
          "kind": "struct",
          "contains": [
            {
              "name": "x",
              "type": {
                "kind": "uint",
                "bits": 128
              }
            },
            {
              "name": "y",
              "type": {
                "kind": "uint",
                "bits": 128
              }
            }
          ],
          "definition": {
            "name": "Coordinate",
            "location": {
              "source": {
                "id": 5
              },
              "range": {
                "offset": 18,
                "length": 55
              }
            }
          }
        }
      },
      "pointers": {
        "struct__Coordinate__storage": {
          "expect": [
            "contract_variable_slot__struct__Coordinate__storage"
          ],
          "for": {
            "group": [
              {
                "name": "member__x__struct__Coordinate__storage",
                "location": "storage",
                "slot": "contract_variable_slot__struct__Coordinate__storage",
                "offset": 0,
                "length": 16
              },
              {
                "name": "member__y__struct__Coordinate__storage",
                "location": "storage",
                "slot": "contract_variable_slot__struct__Coordinate__storage",
                "offset": {
                  "$sum": [
                    {
                      ".offset": "member__x__struct__Coordinate__storage"
                    },
                    {
                      ".length": "member__x__struct__Coordinate__storage"
                    }
                  ]
                },
                "length": 16
              }
            ]
          }
        }
      }
    }
  ]
}

Playground

Loading playground...

Stamp

This object must carry a stamp in its ethdebug field; see Stamp.

An info document names ethdebug/format/info in its stamp instead.