paths.schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Relayer Paths",
  "description": "Path metadata to relay packets between two different chains.",
  "type": "object",
  "required": [
    "paths"
  ],
  "properties": {
    "paths": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "src",
          "dst",
          "channels"
        ],
        "properties": {
          "src": {
            "type": "object",
            "required": [
              "client-id",
              "connection-id"
            ],
            "properties": {
              "client-id": {
                "type": "string",
                "description": "#/$defs/client-id-description"
              },
              "connection-id": {
                "type": "string",
                "description": "#/$defs/connection-id-description"
              }
            }
          },
          "dst": {
            "type": "object",
            "required": [
              "chain-name",
              "client-id",
              "connection-id"
            ],
            "properties": {
              "chain-name": {
                "type": "string"
              },
              "client-id": {
                "type": "string",
                "description": "#/$defs/client-id-description"
              },
              "connection-id": {
                "type": "string",
                "description": "#/$defs/connection-id-description"
              }
            }
          },
          "channels": {
            "type": "array",
            "items": [
              {
                "type": "object",
                "required": [
                  "src",
                  "dst",
                  "ordering",
                  "version"
                ],
                "properties": {
                  "src": {
                    "$ref": "#/$defs/channel_info"
                  },
                  "dst": {
                    "$ref": "#/$defs/channel_info"
                  },
                  "ordering": {
                    "type": "string",
                    "description": "Determines if packets from a sending module must be ORDERED or UNORDERED."
                  },
                  "version": {
                    "type": "string",
                    "description": "IBC Version"
                  },
                  "tags": {
                    "type": "object",
                    "description": "Human readable key:value pair that describes what the path is servicing. E.g. 'DEX': 'Osmosis'"
                  }
                }
              }
            ]
          }
        }
      }
    }
  },
  "$defs": {
    "channel_info": {
      "type": "object",
      "required": [
        "channel-id",
        "port-id"
      ],
      "properties": {
        "channel-id": {
          "type": "string",
          "description": "The channel ID on the corresponding chain's connection representing a channel on the other chain."
        },
        "port-id": {
          "type": "string",
          "description": "The IBC port ID which a relevant module binds to on the corresponding chain."
        }
      }
    },
    "client-id-description": "The client ID on the corresponding chain representing the other chain's light client.",
    "connection-id-description": "The connection ID on the corresponding chain representing a connection to the other chain."
  }
}