config.schema.json

{
  "title": "Demex Webapp Config",
  "description": "demex-webapp-config is a repository to allow frontends to fetch metadata associated with Demex",
  "type": "object",
  "required": [
    "network",
    "featured_markets",
    "prelaunch_markets",
    "blacklisted_markets",
    "blacklisted_pools",
    "blacklisted_tokens",
    "transfer_options",
    "network_fees",
    "perp_pool_banners"
  ],
  "properties": {
    "network": {
      "type": "string",
      "enum": [
        "mainnet",
        "testnet",
        "devnet"
      ]
    },
    "featured_markets": {
      "type": "array",
      "description": "List of market names to be added to the Featured List",
      "items": {
        "$ref": "#/$defs/featured_market"
      }
    },
    "prelaunch_markets": {
      "type": "array",
      "description": "List of market names designated as Pre-Launch markets",
      "items": {
        "$ref": "#/$defs/prelaunch_market"
      }
    },
    "blacklisted_markets": {
      "type": "array",
      "description": "List of blacklisted market names",
      "items": {
        "$ref": "#/$defs/blacklisted_market"
      }
    },
    "blacklisted_pools": {
      "type": "array",
      "description": "List of blacklisted pool ids",
      "items": {
        "$ref": "#/$defs/blacklisted_pool"
      }
    },
    "blacklisted_tokens": {
      "type": "array",
      "description": "List of blacklisted token denoms",
      "items": {
        "$ref": "#/$defs/blacklisted_token"
      }
    },
    "transfer_options": {
      "type": "object",
      "description": "List of blockchain networks and their priority numbers, used to set their order in deposit and withdrawal forms transfer option dropdown",
      "patternProperties": {
        ".*": {
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "network_fees": {
      "type": "object",
      "description": "List of token denoms and their priority numbers, used to set their order in network fee preferences",
      "patternProperties": {
        ".*": {
          "type": "integer"
        }
      },
      "additionalProperties": false
    },
    "maintenance": {
      "type": "object",
      "description": "Dictates whether or not the maintenance page is displayed on each particular network.",
      "properties": {
        "title": {
          "type": "string",
          "description": "Title shown on maintenance page (optional). If not provided, the title of the page will default to \"Service Maintenance\""
        },
        "message": {
          "type": "string",
          "description": "Description shown on maintenance page (optional). If not provided, the description of the page will default to \"Website is temporily unavailable due to planned maintenance. We will be back soon.\""
        }
      }
    },
    "perp_pool_banners": {
      "type": "array",
      "description": "List of perp pool banners",
      "items": {
        "type": "object",
        "required": [
          "perp_pool_id",
          "title"
        ],  
        "properties": {
          "perp_pool_id": {
            "$ref": "#/$defs/perp_pool_id"
          },
          "show_from": {
            "$ref": "#/$defs/show_from"
          },
          "show_until": {
            "$ref": "#/$defs/show_until"
          },
          "title": {
            "$ref": "#/$defs/title"
          },
          "removed_markets": {
            "$ref": "#/$defs/removed_markets"
          },
          "added_markets": {
            "$ref": "#/$defs/added_markets"
          },
          "subtext": {
            "$ref": "#/$defs/subtext"
          }
        }
      }
    }
  },
  "$defs": {
    "featured_market": {
      "type": "string",
      "description": "Market name of market to be added to Featured list"
    },
    "prelaunch_market": {
      "type": "string",
      "description": "Market name of Pre-launch market"
    },
    "blacklisted_market": {
      "type": "string",
      "description": "Blacklisted market name"
    },
    "blacklisted_pool": {
      "type": "string",
      "description": "Blacklisted pool id (type: string)",
      "pattern": "^\\d+$"
    },
    "blacklisted_token": {
      "type": "string",
      "description": "Blacklisted token denom"
    },
    "perp_pool_id": {
      "type": "string",
      "description": "Perp pool id (type: string)",
      "pattern": "^\\d+$"
    },
    "show_from": {
      "type": "string",
      "description": "The date and time when the perp pool banner is scheduled to begin displaying (optional). If not provided, the banner will be shown immediately.",
      "pattern": "^\\d{4}(-\\d\\d(-\\d\\d(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?)?)?$"
    },
    "show_until": {
      "type": "string",
      "description": "The date and time when the perp pool banner is scheduled to stop displaying (optional). If not provided, the banner will continue to display indefinitely.",
      "pattern": "^\\d{4}(-\\d\\d(-\\d\\d(T\\d\\d:\\d\\d(:\\d\\d)?(\\.\\d+)?(([+-]\\d\\d:\\d\\d)|Z)?)?)?)?$"
    },
    "title": {
      "type": "string",
      "description": "The title shown on the banner"
    },
    "removed_markets": {
      "type": "string",
      "description": "The message shown on the banner describing markets being removed"
    },
    "added_markets": {
      "type": "string",
      "description": "The message shown on the banner describing markets being added"
    },
    "subtext": {
      "type": "string",
      "description": "The subtext shown on the banner"
    }
  }
}