schema.json

{
  "title": "BlockProducer",
  "description": "Information about a block producer on AntelopeIO blockchains",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$defs": {
    "location": {
      "type": "object",
      "required": [
        "name",
        "country"
      ],
      "properties": {
        "name": {
          "description": "Location in human readable format [City, State]",
          "type": "string"
        },
        "country": {
          "description": "ISO 3166-1 alpha 2 country code [XX]",
          "type": "string",
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Z]+$"
        },
        "latitude": {
          "description": "Latitude in decimal degrees",
          "type": "number"
        },
        "longitude": {
          "description": "Longitude in decimal degrees",
          "type": "number"
        }
      }
    },
    "required_url": {
      "type": "string",
      "format": "uri",
      "pattern": "^https?://.+[^\/]$"
    },
    "optional_url": {
      "type": "string",
      "if": {
        "pattern": ".+"
      },
      "then": {
        "format": "uri",
        "pattern": "^https?://.+[^\/]$"
      }
    },
    "username": {
      "type": "string",
      "pattern": "^[\\w\\d_\\-\\.]*$"
    },
    "facebook_username": {
      "type": "string",
      "pattern": "^[\\w\\d_\\-\\./]*$"
    },
    "youtube_username": {
      "type": "string",
      "pattern": "^[\\w\\d_\\-\\./]*$"
    }
  },
  "type": "object",
  "required": [
    "producer_account_name",
    "org",
    "nodes"
  ],
  "additionalProperties": false,
  "properties": {
    "producer_account_name": {
      "$id": "/properties/producer_account_name",
      "description": "Producer account name",
      "type": "string",
      "maxLength": 12,
      "minLength": 1,
      "pattern": "^[\\.12345a-z]+$"
    },
    "org": {
      "type": "object",
      "properties": {
        "location": {
          "$ref": "#/$defs/location",
          "description": "Organization location"
        },
        "candidate_name": {
          "$id": "/properties/org/properties/candidate_name",
          "description": "Producer/organization name",
          "type": "string"
        },
        "website": {
          "$ref": "#/$defs/required_url",
          "description": "Organization website"
        },
        "code_of_conduct": {
          "$ref": "#/$defs/optional_url",
          "description": "Link to Code of Conduct"
        },
        "ownership_disclosure": {
          "$ref": "#/$defs/optional_url",
          "description": "Link to company ownership disclosure"
        },
        "email": {
          "$id": "/properties/org/properties/email",
          "description": "Organization email",
          "type": "string",
          "format": "email"
        },
        "github_user": {
          "$id": "/properties/org/properties/github_user",
          "description": "Operational github username",
          "oneOf": [
            {
              "type": "array",
              "uniqueItems": true,
              "items": {
                "type": "string",
                "pattern": "^[\\w\\d_\\-\\.]*$"
              }
            },
            {
              "type": "string",
              "pattern": "^[\\w\\d_\\-\\.]*$"
            }
          ]
        },
        "branding": {
          "type": "object",
          "properties": {
            "logo_256": {
              "$ref": "#/$defs/optional_url",
              "description": "Link to Organization logo [PNG format, 256x256]"
            },
            "logo_1024": {
              "$ref": "#/$defs/optional_url",
              "description": "Link to Organization logo [PNG format, 1024x1024]"
            },
            "logo_svg": {
              "$ref": "#/$defs/optional_url",
              "description": "Link to Organization logo [SVG format]"
            }
          }
        },
        "social": {
          "type": "object",
          "properties": {
            "facebook": {
              "$ref": "#/$defs/facebook_username",
              "description": "group/page address only, not the entire url"
            },
            "github": {
              "$ref": "#/$defs/username",
              "description": "username only"
            },
            "keybase": {
              "$ref": "#/$defs/username",
              "description": "username only"
            },
            "reddit": {
              "$ref": "#/$defs/username",
              "description": "username only"
            },
            "hive": {
              "$ref": "#/$defs/username",
              "description": "username only, WITHOUT @"
            },
            "telegram": {
              "$ref": "#/$defs/username",
              "description": "username only"
            },
            "twitter": {
              "$ref": "#/$defs/username",
              "description": "username only"
            },
            "wechat": {
              "$ref": "#/$defs/username",
              "description": "username only"
            },
            "youtube": {
              "$ref": "#/$defs/youtube_username",
              "description": "channel address only"
            },
            "medium": {
              "$ref": "#/$defs/username",
              "description": "medium username only"
            },
            "discord": {
              "$ref": "#/$defs/username",
              "description": "discord"
            }
          }
        },
        "chain_resources": {
          "$ref": "#/$defs/optional_url",
          "description": "URL with chain snapshots and other downloads"
        },
        "other_resources": {
          "type": "array",
          "uniqueItems": true,
          "description": "URLs to other relevant resources",
          "items": {
            "$ref": "#/$defs/optional_url"
          }
        }
      },
      "required": [
        "location",
        "candidate_name",
        "website"
      ]
    },
    "nodes": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "required": [
          "node_type",
          "full"
        ],
        "properties": {
          "location": {
            "$ref": "#/$defs/location",
            "description": "Node location"
          },
          "node_type": {
            "description": "Type of service",
            "oneOf": [
              {
                "type": "array",
                "uniqueItems": true,
                "items": {
                  "type": "string",
                  "enum": [
                    "producer",
                    "query",
                    "seed"
                  ]
                }
              },
              {
                "type": "string",
                "enum": [
                  "producer",
                  "query",
                  "seed"
                ]
              }
            ]
          },
          "full": {
            "description": "Provides full data history",
            "type": "boolean"
          },
          "p2p_endpoint": {
            "description": "Leap P2P endpoint (host:port)",
            "type": "string"
          },
          "api_endpoint": {
            "description": "Service HTTP endpoint (http://host:port)",
            "type": "string",
            "if": {
              "pattern": ".+"
            },
            "then": {
              "format": "uri",
              "pattern": "^http://"
            }
          },
          "ssl_endpoint": {
            "description": "Service HTTPS endpoint (https://host:port)",
            "type": "string",
            "if": {
              "pattern": ".+"
            },
            "then": {
              "format": "uri",
              "pattern": "^https://"
            }
          },
          "features": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string",
              "enum": [
                "chain-api",
                "account-query",
                "history-v1",
                "hyperion-v2",
                "dfuse",
                "fio-api",
                "snapshot-api",
                "dsp-api",
                "atomic-assets-api",
                "firehose",
                "light-api",
                "ipfs",
                "substreams"
              ]
            }
          }
        }
      }
    }
  }
}