JSON Schema Specification

📝 Asset Specification

🔧 Config Schema

JSON Schema of the HTTP configuration

{
  '$schema': 'http://json-schema.org/draft-07/schema',
  '$id': 'https://schemas.algodex.com/v1/Config.json',
  'type': 'object',
  'properties': {
    'algod': {
      'type': 'object',
      'properties': {
        'uri': {
          '$ref': 'https://schemas.algodex.com/v1/URI.json',
        },
        'token': {
          'type': 'string',
        },
        'port': {
          'type': 'number',
          'minimum': 1,
        },
      },
      'required': [
        'uri',
        'token',
      ],
    },
    'indexer': {
      'type': 'object',
      'properties': {
        'uri': {
          '$ref': 'https://schemas.algodex.com/v1/URI.json',
        },
        'token': {
          'type': 'string',
        },
      },
      'required': [
        'uri',
        'token',
      ],
    },
    'dexd': {
      'type': 'object',
      'properties': {
        'uri': {
          '$ref': 'https://schemas.algodex.com/v1/URI.json',
        },
        'token': {
          'type': 'string',
        },
      },
      'required': [
        'uri',
        'token',
      ],
    },
  },
  'required': ['algod', 'indexer', 'dexd'],
}

🕸 URI Schema

JSON Schema of a URI

{
  '$schema': 'http://json-schema.org/draft-07/schema',
  '$id': 'https://schemas.algodex.com/v1/URI.json',
  'type': 'string',
  'format': 'uri',
}

💰 Addresses Schema

JSON Schema of the Wallet. Used for validation in AlgodexApi#setAddresses

{
'$schema': 'http://json-schema.org/draft-07/schema',
  '$id': 'https://schemas.algodex.com/v1/Addresses.json',
  'type': 'array',
  'items': {
    '$ref': 'https://schemas.algodex.com/v1/Wallet.json',
  },
}

💰 Wallet Schema

JSON Schema of the Wallet. Used for validation in AlgodexApi#setWallet

{
  '$schema': 'http://json-schema.org/draft-07/schema',
  '$id': 'https://schemas.algodex.com/v1/Wallet.json',
  'type': 'object',
  'properties': {
    'type': {
      'type': 'string',
      'enum': ['my-algo-wallet', 'wallet-connect', 'sdk'],
    },
    'address': {
      'type': 'string',
      'pattern': '[A-Z0-9]{58}',
      'description': 'An account public key',
    },
    'name': {
      'type': 'string',
    },
    'algo': {
      '$ref': 'https://schemas.algodex.com/v1/Asset.json',
    },
    'assets': {
      'type': 'object',
      'additionalProperties': {
        '$ref': 'https://schemas.algodex.com/v1/Asset.json',
      },
    },
  },
}