Schema

Explore

Loading ....

View source

YAML

ethdebug/format/info

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

title: ethdebug/format/info
description: |
  Debugging information about a single compilation

type: object

$ref: "schema:ethdebug/format/info/resources"

properties:
  ethdebug:
    title: Stamp
    description: |
      Names this schema and the specification version. An info document
      must carry this field. A program in `programs` should not carry
      one; the stamp of this document covers it. 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" }'
        properties:
          schema:
            $dynamicRef: "#SchemaName"

  programs:
    type: array
    items:
      $ref: "schema:ethdebug/format/program"

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

required:
  - ethdebug
  - compilation
  - programs

unevaluatedProperties: false

$defs:
  SchemaName:
    $dynamicAnchor: SchemaName
    description: |
      The schema name that the `ethdebug` field's `schema` must give.
      This fills the slot that **ethdebug/format/info/resources**
      declares, so that an info document names **ethdebug/format/info**.
    const: "ethdebug/format/info"

examples:
  - ethdebug:
      schema: "ethdebug/format/info"
      version: "0.1.0-draft.1"
    compilation:
      id: __301f3b6d85831638
      compiler:
        name: egc
        version: 0.2.3+commit.8b37fa7a
      settings:
        turbo: true
      sources:
        - id: 1
          path: "Escrow.eg"
          language: examplelang
          contents: |
            import { Asset } from std::asset::fungible;

            type State = !slots[
              ready: bool,
              complete: bool,

              beneficiary: address,

              asset: Asset,
              amount: uint256,

              canRemit: () -> bool,
            ]

            @create
            func setup(
              beneficiary: address,
              asset: Asset,
              canRemit: () -> bool,
            ) -> State:
              return {
                ready = False,
                complete = False,
                beneficiary,
                asset,
                amount = 0,
                canRemit,
              }

            @abi
            @state(self: State)
            @account(self)
            func deposit(depositor: address, amount: uint256):
              require(!self.ready)
              require(!self.complete)

              # expects an existing allowance (also known as "approval")
              self.asset.transferFrom(depositor, self, amount)

              self.amount = amount
              self.ready = True

            @abi
            @state(self: State)
            func remit():
              require(self.ready)
              require(!self.complete)

              require(self.canRemit())

              asset.transfer(self.beneficiary, self.amount)

              self.complete = True

    types:
      # Define the State type structure
      State:
        kind: "struct"
        contains:
          - name: "ready"
            type:
              kind: "bool"
          - name: "complete"
            type:
              kind: "bool"
          - name: "beneficiary"
            type:
              kind: "address"
          - name: "asset"
            type:
              kind: "struct"
              contains:
                - name: "address"
                  type:
                    kind: "address"
          - name: "amount"
            type:
              kind: "uint"
              bits: 256
          - name: "canRemit"
            type:
              kind: "function"
              internal: true
              contains:
                parameters:
                  type:
                    kind: "tuple"
                    contains: []
                returns:
                  type:
                    kind: "bool"

    pointers:
      # Define storage layout for the State struct
      State_storage:
        expect: ["slot"]
        for:
          group:
            - name: "ready"
              location: "storage"
              slot: "slot"
              offset: 0
              length: 1
            - name: "complete"
              location: "storage"
              slot: "slot"
              offset: 1
              length: 1
            - name: "beneficiary"
              location: "storage"
              slot: { "$sum": ["slot", 1] }
            - name: "asset"
              location: "storage"
              slot: { "$sum": ["slot", 2] }
            - name: "amount"
              location: "storage"
              slot: { "$sum": ["slot", 3] }
            - name: "canRemit"
              location: "storage"
              slot: { "$sum": ["slot", 4] }

    programs:
      - contract:
          name: "Escrow"
          definition:
            source:
              id: 1
            range:
              offset: 0
              length: 891
        environment: "create"
        instructions:
          - offset: 0
            operation:
              mnemonic: "PUSH1"
              arguments: ["0x80"]
            context:
              code:
                source:
                  id: 1
                range:
                  offset: 891
                  length: 20

JSON

ethdebug/format/info

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schema:ethdebug/format/info",
  "title": "ethdebug/format/info",
  "description": "Debugging information about a single compilation\n",
  "type": "object",
  "$ref": "schema:ethdebug/format/info/resources",
  "properties": {
    "ethdebug": {
      "title": "Stamp",
      "description": "Names this schema and the specification version. An info document\nmust carry this field. A program in `programs` should not carry\none; the stamp of this document covers it. All objects of one\ncompilation must name the same `version`.\n",
      "allOf": [
        {
          "$ref": "schema:ethdebug/format/data/stamp"
        },
        {
          "title": "{ \"schema\": \"ethdebug/format/info\" }",
          "properties": {
            "schema": {
              "$dynamicRef": "#SchemaName"
            }
          }
        }
      ]
    },
    "programs": {
      "type": "array",
      "items": {
        "$ref": "schema:ethdebug/format/program"
      }
    },
    "compilation": {
      "$ref": "schema:ethdebug/format/materials/compilation"
    }
  },
  "required": [
    "ethdebug",
    "compilation",
    "programs"
  ],
  "unevaluatedProperties": false,
  "$defs": {
    "SchemaName": {
      "$dynamicAnchor": "SchemaName",
      "description": "The schema name that the `ethdebug` field's `schema` must give.\nThis fills the slot that **ethdebug/format/info/resources**\ndeclares, so that an info document names **ethdebug/format/info**.\n",
      "const": "ethdebug/format/info"
    }
  },
  "examples": [
    {
      "ethdebug": {
        "schema": "ethdebug/format/info",
        "version": "0.1.0-draft.1"
      },
      "compilation": {
        "id": "__301f3b6d85831638",
        "compiler": {
          "name": "egc",
          "version": "0.2.3+commit.8b37fa7a"
        },
        "settings": {
          "turbo": true
        },
        "sources": [
          {
            "id": 1,
            "path": "Escrow.eg",
            "language": "examplelang",
            "contents": "import { Asset } from std::asset::fungible;\n\ntype State = !slots[\n  ready: bool,\n  complete: bool,\n\n  beneficiary: address,\n\n  asset: Asset,\n  amount: uint256,\n\n  canRemit: () -> bool,\n]\n\n@create\nfunc setup(\n  beneficiary: address,\n  asset: Asset,\n  canRemit: () -> bool,\n) -> State:\n  return {\n    ready = False,\n    complete = False,\n    beneficiary,\n    asset,\n    amount = 0,\n    canRemit,\n  }\n\n@abi\n@state(self: State)\n@account(self)\nfunc deposit(depositor: address, amount: uint256):\n  require(!self.ready)\n  require(!self.complete)\n\n  # expects an existing allowance (also known as \"approval\")\n  self.asset.transferFrom(depositor, self, amount)\n\n  self.amount = amount\n  self.ready = True\n\n@abi\n@state(self: State)\nfunc remit():\n  require(self.ready)\n  require(!self.complete)\n\n  require(self.canRemit())\n\n  asset.transfer(self.beneficiary, self.amount)\n\n  self.complete = True\n"
          }
        ]
      },
      "types": {
        "State": {
          "kind": "struct",
          "contains": [
            {
              "name": "ready",
              "type": {
                "kind": "bool"
              }
            },
            {
              "name": "complete",
              "type": {
                "kind": "bool"
              }
            },
            {
              "name": "beneficiary",
              "type": {
                "kind": "address"
              }
            },
            {
              "name": "asset",
              "type": {
                "kind": "struct",
                "contains": [
                  {
                    "name": "address",
                    "type": {
                      "kind": "address"
                    }
                  }
                ]
              }
            },
            {
              "name": "amount",
              "type": {
                "kind": "uint",
                "bits": 256
              }
            },
            {
              "name": "canRemit",
              "type": {
                "kind": "function",
                "internal": true,
                "contains": {
                  "parameters": {
                    "type": {
                      "kind": "tuple",
                      "contains": []
                    }
                  },
                  "returns": {
                    "type": {
                      "kind": "bool"
                    }
                  }
                }
              }
            }
          ]
        }
      },
      "pointers": {
        "State_storage": {
          "expect": [
            "slot"
          ],
          "for": {
            "group": [
              {
                "name": "ready",
                "location": "storage",
                "slot": "slot",
                "offset": 0,
                "length": 1
              },
              {
                "name": "complete",
                "location": "storage",
                "slot": "slot",
                "offset": 1,
                "length": 1
              },
              {
                "name": "beneficiary",
                "location": "storage",
                "slot": {
                  "$sum": [
                    "slot",
                    1
                  ]
                }
              },
              {
                "name": "asset",
                "location": "storage",
                "slot": {
                  "$sum": [
                    "slot",
                    2
                  ]
                }
              },
              {
                "name": "amount",
                "location": "storage",
                "slot": {
                  "$sum": [
                    "slot",
                    3
                  ]
                }
              },
              {
                "name": "canRemit",
                "location": "storage",
                "slot": {
                  "$sum": [
                    "slot",
                    4
                  ]
                }
              }
            ]
          }
        }
      },
      "programs": [
        {
          "contract": {
            "name": "Escrow",
            "definition": {
              "source": {
                "id": 1
              },
              "range": {
                "offset": 0,
                "length": 891
              }
            }
          },
          "environment": "create",
          "instructions": [
            {
              "offset": 0,
              "operation": {
                "mnemonic": "PUSH1",
                "arguments": [
                  "0x80"
                ]
              },
              "context": {
                "code": {
                  "source": {
                    "id": 1
                  },
                  "range": {
                    "offset": 891,
                    "length": 20
                  }
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

Playground

Loading playground...

Stamp

This object must carry a stamp in its ethdebug field that names ethdebug/format/info. A program in programs should not carry the stamp. See Stamp.