versions.schema.json

{
  "$id": "https://sikka.tech/versions.schema.json",
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Versions",
  "description": "Versions.json is a metadata file that contains information about a cosmos sdk based chain's current and historical versions.",
  "type": "object",
  "required": [
    "chain_name",
    "versions"
  ],
  "properties": {
    "$schema": {
      "type": "string",
      "pattern": "^(\\.\\./)+versions\\.schema\\.json$"
    },
    "chain_name": {
      "type": "string",
      "pattern": "[a-z0-9]+"
    },
    "versions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Official Upgrade Name"
          },
          "tag": {
            "type": "string",
            "description": "Git Upgrade Tag"
          },
          "height": {
            "type": "number",
            "description": "Block Height"
          },
          "proposal": {
            "type": "number",
            "description": "Proposal that will officially signal community acceptance of the upgrade."
          },
          "previous_version_name": {
            "type": "string",
            "description": "[Optional] Name of the previous version"
          },
          "next_version_name": {
            "type": "string",
            "description": "[Optional] Name of the following version"
          },
          "recommended_version": {
            "type": "string"
          },
          "compatible_versions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "cosmos_sdk_version": {
            "type": "string"
          },
          "sdk": {
            "$ref": "#/$defs/sdk"
          },
          "consensus": {
            "$ref": "#/$defs/consensus"
          },
          "cosmwasm_version": {
            "type": "string"
          },
          "cosmwasm_enabled": {
            "type": "boolean"
          },
          "cosmwasm_path": {
            "type": "string",
            "description": "Relative path to the cosmwasm directory. ex. $HOME/.juno/data/wasm",
            "pattern": "^\\$HOME.*$"
          },
          "cosmwasm": {
            "$ref": "#/$defs/cosmwasm"
          },
          "ibc_go_version": {
            "type": "string"
          },
          "ibc": {
            "$ref": "#/$defs/ibc"
          },
          "go_version": {
            "type": "string"
          },
          "language": {
            "$ref": "#/$defs/language"
          },
          "ics_enabled": {
            "type": "array",
            "description": "List of IBC apps (usually corresponding to a ICS standard) which have been enabled on the network.",
            "items": {
              "type": "string",
              "description": "IBC app or ICS standard.",
              "enum": [
                "ics20-1",
                "ics27-1",
                "mauth"
              ]
            }
          },
          "binaries": {
            "$ref": "#/$defs/binaries"
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "repo": {
      "type": "string",
      "format": "uri",
      "minLength": 1,
      "description": "URL of the code repository."
    },
    "version": {
      "type": "string",
      "minLength": 1,
      "description": "Simple version string (e.g., 'v1.0.0')."
    },
    "tag": {
      "type": "string",
      "minLength": 1,
      "description": "Detailed version identifier (e.g., 'v1.0.0-a1s2f43g')."
    },
    "sdk": {
      "type": "object",
      "required": [ "type" ],
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "minLength": 1,
          "enum": ["cosmos", "penumbra", "other"]
        },
        "version": {
          "$ref": "#/$defs/version"
        },
        "repo": {
          "$ref": "#/$defs/repo"
        },
        "tag": {
          "$ref": "#/$defs/tag"
        }
      }
    },
    "ibc": {
      "type": "object",
      "required": [ "type" ],
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "minLength": 1,
          "enum": ["go", "rust", "other"]
        },
        "version": {
          "$ref": "#/$defs/version"
        },
        "repo": {
          "$ref": "#/$defs/repo"
        },
        "tag": {
          "$ref": "#/$defs/tag"
        },
        "ics_enabled": {
          "type": "array",
          "description": "List of IBC apps (usually corresponding to a ICS standard) which have been enabled on the network.",
          "items": {
            "type": "string",
            "minLength": 1,
            "description": "IBC app or ICS standard.",
            "enum": [ "ics20-1", "ics27-1", "mauth" ]
          }
        }
      }
    },
    "cosmwasm": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "version": {
          "$ref": "#/$defs/version"
        },
        "repo": {
          "$ref": "#/$defs/repo"
        },
        "tag": {
          "$ref": "#/$defs/tag"
        },
        "enabled": {
          "type": "boolean"
        },
        "path": {
          "type": "string",
          "minLength": 1,
          "description": "Relative path to the cosmwasm directory. ex. $HOME/.juno/data/wasm",
          "pattern": "^\\$HOME.*$"
        }
      }
    },
    "consensus": {
      "type": "object",
      "required": [ "type" ],
      "properties": {
        "type": {
          "type": "string",
          "minLength": 1,
          "enum": [ "tendermint", "cometbft", "sei-tendermint" ]
        },
        "version": {
          "$ref": "#/$defs/version"
        },
        "repo": {
          "$ref": "#/$defs/repo"
        },
        "tag": {
          "$ref": "#/$defs/tag"
        }
      },
      "additionalProperties": false
    },
    "language": {
      "type": "object",
      "required": [ "type" ],
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "minLength": 1,
          "enum": ["go", "rust", "solidity", "other"]
        },
        "version": {
          "$ref": "#/$defs/version"
        },
        "repo": {
          "$ref": "#/$defs/repo"
        },
        "tag": {
          "$ref": "#/$defs/tag"
        }
      }
    },
    "binaries": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "linux/amd64": {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        },
        "linux/arm64": {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        },
        "darwin/amd64": {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        },
        "darwin/arm64": {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        },
        "windows/amd64": {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        },
        "windows/arm64": {
          "type": "string",
          "minLength": 1,
          "format": "uri"
        }
      }
    }
  }
}