spec/Order.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. // eslint-disable-next-line no-unused-vars
  10. const algosdk = require('algosdk');
  11. /**
  12.  * # Order
  13.  *
  14.  * @example
  15.  * const validate = ajv.getSchema('Asset')
  16.  *
  17.  * @typedef {Object} Order
  18.  * @property {string} address Order Address
  19.  * @property {number} amount Amount in order
  20.  * @property {number} total Total of order
  21.  * @property {("maker"|"taker"|"market"|"both"|"execute"|"close")} execution Execution of order
  22.  * @property {Asset} asset Algorand Asset
  23.  * @property {number} price Asset Price
  24.  * @property {Object} [contract] Composed Contract State
  25.  * @property {number} contract.price Asset BaseUnit Price
  26.  * @property {number} contract.amount Asset BaseUnit Amount
  27.  * @property {number} contract.total Asset BaseUnit Total
  28.  * @property {number} contract.N Numerator
  29.  * @property {number} contract.D Denominator
  30.  * @property {algosdk.SuggestedParams} [contract.params] Suggested Params
  31.  * @property {algosdk.Algodv2} [client] Algosdk Client
  32.  * @namespace Order
  33.  */
  34. // "type": "sell",
  35. //     "price":  235.000000,
  36. //     "amount": 0.1,
  37. //     "total": 23.50000,
  38. //     "execution": "both",
  39. //     "address": "WYWRYK42XADLY3O62N52BOLT27DMPRA3WNBT2OBRT65N6OEZQWD4OSH6PI",
  40. //     "appId": 22045503,
  41. //     "version": 6
  42. /**
  43.  * JSON Schema Specification
  44.  * @type {Schema}
  45.  * @name Schema
  46.  * @memberOf Order
  47.  */
  48. module.exports = {
  49.   '$schema': 'http://json-schema.org/draft-07/schema',
  50.   '$id': 'https://schemas.algodex.com/v1/Order.json',
  51.   'title': 'Order',
  52.   'description': 'Algorand standard asset',
  53.   'type': 'object',
  54.   'properties': {
  55.     'type': {
  56.       'type': 'string',
  57.       'enum': ['buy', 'sell'],
  58.     },
  59.     'price': {
  60.       'type': 'number',
  61.       'multipleOf': 1,
  62.     },
  63.     'amount': {
  64.       'type': 'number',
  65.       'multipleOf': 1,
  66.     },
  67.     'total': {
  68.       'type': 'number',
  69.       'multipleOf': 1,
  70.     },
  71.     'execution': {
  72.       'type': 'string',
  73.       'enum': ['taker', 'both', 'maker', 'market'],
  74.     },
  75.     'address': {
  76.       'type': 'string',
  77.       'pattern': '[A-Z0-9]{58}',
  78.       'description': 'An account public key',
  79.     },
  80.     'appId': {
  81.       'type': 'number',
  82.       'multipleOf': 1,
  83.     },
  84.     'version': {
  85.       'type': 'number',
  86.       'multipleOf': 1,
  87.     },
  88.   },
  89. };
  90. JAVASCRIPT
    Copied!