ecosystem_schema.yml

# Copyright 2022 Circle Internet Financial Trading Company Limited
---
$id: https://circle.com/ecosystem.schema.json
$schema: https://json-schema.org/draft/2020-12/schema

title: Circle Ecosystem Catalog YAML Schema

maintainers:
  - Thomas Low <thomas.low@circle.com>

description: The YAML schema reference for Circle Ecosystem Catalog.

type: object

properties:
  id:
    description: UUID of the app.
    type: string
    minLength: 36
    maxLength: 36
    pattern: "^[0-9a-f]{8}\\b-[0-9a-f]{4}\\b-[0-9a-f]{4}\\b-[0-9a-f]{4}\\b-[0-9a-f]{12}$"

  companyName:
    description: Name of the company.
    type: string
    minLength: 1
    maxLength: 50

  appName:
    description: Name of the app.
    type: string
    minLength: 1
    maxLength: 50

  logo:
    description: Directory path to the logo file.
    type: string
    maxLength: 150
    pattern: "catalog\\/.+\\/logos\\/.+\\.(png|jpg|jpeg|svg)$"

  website:
    description: URL of the app's website.
    type: string
    minLength: 8
    maxLength: 100
    pattern: "^https://.+"

  description:
    description: Description of the app.
    type: string
    minLength: 1
    maxLength: 200

  dao:
    description: If the app is run as a DAO or a traditional company (non-DAO).
    type: boolean

  fiatOnRamp:
    description: The ability to convert fiat currency (e.g. USD) to USDC within the app.
    type: boolean

  audiences:
    description: Array of all intended audiences of the app.
    type: array
    items:
      type: string
      enum:
        - consumers
        - businesses

  blockchains:
    description: Array of all applicable blockchains that the app supports.
    type: array
    items:
      type: string
      enum:
        - algorand
        - avalanche
        - cosmos
        - ethereum
        - fantom
        - flow
        - harmony
        - hedera
        - near
        - polkadot
        - polygon
        - solana
        - stellar
        - tron

  categories:
    description: Array of all the applicable use cases.
    type: array
    items:
      type: string
      enum:
        - banking
        - borrowing_lending
        - cefi
        - charity
        - debit_cards
        - defi
        - ecommerce
        - entertainment
        - gaming
        - investing_yield
        - nft_marketplaces
        - payroll
        - remittances
        - restaurants
        - trading_exchanges
        - wallets

  platforms:
    description: Array of all applicable platforms that the app supports.
    type: array
    items:
      type: string
      enum:
        - web
        - ios
        - android

  regions:
    description: Array of all applicable regions that the app operates in.
    type: array
    items:
      type: string
      enum:
        - na
        - latam
        - emea
        - apac

  twitter:
    description: Twitter handle.
    type: string
    minLength: 20
    maxLength: 75
    pattern: "^https://twitter.com/.+"

  telegram:
    description: Telegram handle.
    type: string
    minLength: 13
    maxLength: 50
    pattern: "^https://t.me/.+"

  discord:
    description: Discord server.
    type: string
    minLength: 19
    maxLength: 50
    pattern: "^https://discord.gg/.+"

required:
  - id
  - companyName
  - appName
  - logo
  - website
  - categories