spec/APIProperties.js 

  1. /*
  2.  * Copyright (C) 2021-2022 Algodex VASP (BVI) Corp.
  3.  *
  4.  * This Source Code Form is subject to the terms of the Mozilla Public
  5.  * License, v. 2.0. If a copy of the MPL was not distributed with this
  6.  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  7.  */
  9. /**
  10.  * API Properties Specification
  11.  *
  12.  * @typedef {Object} APIProperties
  13.  * @property {Config} config Configuration
  14.  * @property {Asset} asset Asset
  15.  * @property {Wallet} wallet Wallet
  16.  * @namespace APIProperties
  17.  */
  19. /**
  20.  * JSON Schema Specification
  21.  * @type {Schema}
  22.  * @name APIPropertiesSchema
  23.  * @memberOf Schema
  24.  */
  25. module.exports = {
  26.   '$schema': 'http://json-schema.org/draft-07/schema',
  27.   '$id': 'https://schemas.algodex.com/v1/Algodex.json',
  28.   'title': 'API',
  29.   'type': 'object',
  30.   'examples': [
  31.     {
  32.       'type': 'API',
  33.       'config': {
  34.         'algod': {
  35.           'uri': 'https://testnet.algoexplorerapi.io',
  36.           'token': '',
  37.         },
  38.         'indexer': {
  39.           'uri': 'https://algoindexer.testnet.algoexplorerapi.io',
  40.           'token': '',
  41.         },
  42.         'dexd': {
  43.           'uri': 'https://testnet.algodex.com/algodex-backend',
  44.           'token': '',
  45.         },
  46.       },
  47.       'asset': {
  48.         'id': 224234,
  49.       },
  50.       'wallet': {
  51.         'address': 'WYWRYK42XADLY3O62N52BOLT27DMPRA3WNBT2OBRT65N6OEZQWD4OSH6PI',
  52.         'type': 'my-algo-wallet',
  53.         'assets': {224234: {'balance': 9, 'name': 'Amazing'}},
  54.       },
  55.     },
  56.   ],
  57.   'properties': {
  58.     'type': {
  59.       'const': 'API',
  60.     },
  61.     'config': {
  62.       '$ref': 'https://schemas.algodex.com/v1/Config.json',
  63.     },
  64.     'asset': {
  65.       '$ref': 'https://schemas.algodex.com/v1/Asset.json',
  66.     },
  67.     'wallet': {
  68.       '$ref': 'https://schemas.algodex.com/v1/Wallet.json',
  69.     },
  70.   },
  71.   'required': ['config'],
  72. };
  73. JAVASCRIPT
    Copied!