BitExplorerAPI.yaml

openapi: 3.0.0
info:
  version: '1.0.0'
  title: 'Enecuum Node API'
  description: |
    # Introduction
  
    Enecuum is a cryptocurrency project designed to involve both mobile and desktop devices into one blockchain network. Enecuum provides a payment platform with the use of a native token. Enecuum's native token, ENQ, can be bought on the exchange, by card, or mined on PCs and smartphones. 

    Below, you can read a short explanation of the basic terms and concepts related to Enecuum and cryptocurrency in general. The description will help you better understand the Enecuum API. **Be aware that the API and its documentation is a work in progress and is constantly updated.** 
    
    The methods' parameters and returned values are thoroughly explained in schemas, which you can access by clicking "Schema" next to the "Example Value".
    
    # How Enecuum Works
    
    When a user creates an account in the Enecuum network, a pair of public and private keys is generated. 

    **The public key** is a user's identification. It is used as a wallet address. The user can safely share the public key to receive payments.

    **The private key** acts as a password. It is used to access the account. The user must never share the private key. The private key needs to be backed up. If a private key is lost, the account will never be recovered.
    
    You can read more about the key pair generation in the according section down below.
    
    Be aware that any wallet, including the one created for technical purposes, can receive referral rewards. This can happen if someone decides to use the wallet's referral address as their referral agent. These rewards are marked accordingly in the blockchain.

    Enecuum has a native token, ENQ, which is used for payments in the Enecuum network, as well as a non-tradable token BIT designed for testing. Enecuum also allows the issue of custom tokens. Each token has two unique identifiers: ticker and hash. A **ticker** is a 1-6 letter name used for convenience. A **hash** is a 64-character sequence that acts as a technical identification. ENQ has an all-zero token hash (64 zeroes). Non-zero values mean that you deal with an asset other than Enecuum. Custom tokens have a random hexadecimal string as a token ID.

    Each token token has a fixed number of **decimal places**. When using Enecuum API, the methods will return the token amount as an integer. Because of this, the returned amount is multiplied by 10^*d*, where *d* stands for the number of decimal places. For example, ENQ has 10 decimal places. The returned amount 250050000000 correlates with 25.005 ENQ.
    
    The tokens are used to perform transactions. After making the request to perform a transaction, it is sent to the main node. Then, it is processed by miners. Finally, the transaction is recorded in the blockchain. **Rejected transactions are also recorded.**
    
    <details>
    <summary> **click to expand**
    # Enecuum Account Generation 
    </summary>
    
    Enecuum account is a keypair of private and public key. Public key is also used as a Enecuum address. 
    
    To create a key pair, we use the secp256k1 elliptic curve. First, a random 32-bytes number is generated, and a public key is generated from it by secp256k1 rules. The received public key in the format 04 + x_coord + y_coord (65 total bytes, 130 symbols in string format) is converted to a compressed public key 02/03 + x_coord (33 total bytes, 66 symbols in string format) depending on the sign of y_coord. Most cryptographic libraries convert a key pair into a standard certificate formats (PEM, PKCS, etc...), but we use a simplified raw private and public key representation.
    
    So here is an example of Enecuum account:
    
    ```
    {
       "prvkey" : "5caf0e01227bc31771dd7ea804c022796da2355452d93396e7e3802f0099f276",
       "pubkey" : "026f6be1bc2cba807b9e5f22f79df985ff021db77f853a36a200b8dd6a9bd0af9b"
      }
    ```
    
    You can create an Enecuum BIT network wallet at [bit-wallet.enecuum.com/login](https://bit-wallet.enecuum.com/login).
    
    
    Here is a NodeJS example using standard crypto package:
    
    ```
    const crypto = require('crypto');
    function gen_keys(){
       const user = crypto.createECDH('secp256k1');
       user.generateKeys();
       return {
           prvkey : user.getPrivateKey().toString('hex'),
           pubkey : crypto.ECDH.convertKey(user.getPublicKey().toString('hex'), 'secp256k1', 'hex', 'hex', 'compressed')
       };
    }
    console.log(gen_keys());
    ```
    
    Here is an NodeJS example using elliptic package. Note that you can set a private key by yourself, which can’t be achieved in crypto package by simple steps. You also can use Browserify to use it at client-side.
    
    ```
    let EC = require('elliptic').ec;
    function gen_keys(prvkey) {
       let ec = new EC('secp256k1');
       let key = ec.keyFromPrivate(prvkey, "hex");
       let pubkey = key.getPublic(true, 'hex');
       return {
           prvkey : prvkey,
           pubkey : pubkey
       };
    }
    let prvkey = '75587f836841d72c7b8bf5b7e514bd4b83dcb9503ed89b0032e519e9a3eaa5f9';
    console.log(gen_keys(prvkey));
    ```
    </details>
  
servers:
  # Added by API Auto Mocking Plugin
#  - description: SwaggerHub API Auto Mocking
#    url: https://virtserver.swaggerhub.com/enecuum/BitExplorerAPI/1.0.0
  # Added by API Auto Mocking Plugin
#  - description: SwaggerHub API Auto Mocking
#    url: https://virtserver.swaggerhub.com/enecuum/BitExplorerAPI/1.0.0
  # Added by API Auto Mocking Plugin
  # Added by API Auto Mocking Plugin
  - description: SwaggerHub API Auto Mocking
    url: https://virtserver.swaggerhub.com/enecuum/BitExplorerAPI/1.0.0
  - description: Enecuum BIT Network. New API is first deployed here.
    url: http://bit.enecuum.com/api/v1/ #bit.enecuum.com/api/v1
  - description: Enecuum Pulse Network (main network). Some API methods may be missing.
    url: https://pulse.enecuum.com/api/v1
# Added3 by API Auto Mocking Plugin
#  - description: SwaggerHub API Auto Mocking
#    url: https://virtserver.swaggerhub.com/enecuum/EnecuumNodeAPI/1.0.0

# NETWORK METHODS
  
paths:
  /network_info:
    get:
      tags:
        - Network
      summary: 'Retrieves network information'
      description: 'Returns network info'
      responses:
        '200':
          description: Successfully returned.
          content:
            application/json:
              schema:
                properties:
                  target_speed: 
                    type: integer
                    description: desired interval between block release in seconds
                    example: 15
                  reward_ratio:
                    type: object
                    description: Shares of the native token block reward by node types (10,000 = 100%)   
                    properties: 
                      pos: 
                        type: integer
                        description: Reward ratio for PoS nodes
                        example: 5500
                      poa:
                         type: integer
                         description: Reward ratio for PoA nodes
                         example: 3181
                      pow:
                         type: integer
                         description: Reward ratio for PoW nodes
                         example: 500
                      ref:
                        type: integer
                        description: Reward ratio for referrals
                        example: 819
                  transfer_lock:
                    type: integer
                    description: Minimal amount of blocks between undelegation and transfer so that the transfer is valid 
                    example: 5
                  pos_min_stake:
                    type: integer
                    description: Minimal stake for a PoS node
                    example: 25000000000
                  native_token:
                    type: object
                    description: Native token properties
                    properties: 
                      hash: 
                        type: string
                        description: Native token hash
                        example: 0000000000000000000000000000000000000000000000000000000000000001
                      owner:
                        type: string
                        description: Address of the wallet that created the native token
                        example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
                      fee_type:
                        type: integer
                        description: Fee type (see comment below, TO BE CLARIFIED - see comment below)
                        # 0 - flat fee for owner upon transaction in reward tokens, 1 - percent fee in reward tokens, 2 - native fee, fixed, charged in native tokens)
                        example: 0
                      fee_value:
                        type: integer
                        description: Fee value
                        example: 1000000000
                      ticker:
                        type: string
                        description: Native token ticker
                        example: BIT
                      decimals:
                        type: integer
                        description: Number of decimal places
                        example: 10
                      total_supply:
                        type: string
                        description: Total supply of native tokens
                        example: 2455559059822244864
                      caption:
                        type: string
                        description: Token name
                        example: Enecuum Testnet BIT
                      active:
                        type: integer
                        description: TO BE EXPLAINED
                        # has something to do with mining slots?
                        example: 1
                      reissuable:
                        type: integer
                        description: (1 stands for tokens that can be minted and burned?)
                        example: 0
                      minable:
                        type: integer
                        description: Whether a token can be mined or not
                        example: 1
                      max_supply:
                        type: integer
                        description: Maximum token supply
                        example: 3500000000000000000
                      block_reward:
                        type: integer
                        description: Reward for the mining of a block
                        example: 30460000000
                      min_stake:
                        type: integer
                        description: The minimal stake for a PoA node (applies to mineable tokens only? null for others)
                        example: 250000000000
                      referrer_stake:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 10000000000000
                      ref_share:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 2574
                      txs_count:
                        type: integer
                        description: (TO BE CLARIFIED) amount of transactions with this token
                        example: 6406044
                      cg_price_usd:
                        type: integer
                        description: CoinGecko price of the token in USDT? (TO BE CLARIFIED)
                        example: 0.03952753
                      dex_price_usd:
                        type: integer
                        description: Price of the token on pour DEX (ENEX? TO BE CLARIFIED)
                        example: 0.03952753
                      price_raw:
                        type: object
                        description: a different representation of cg_price_usd and dex_price_usd
                        properties:
                          cg_price:
                            type: integer
                            description: CoinGecko price, different representation
                            example: 395275300
                          dex_price:
                            type: integer
                            description: Our DEX price, different representation
                            example: 395275300
                          decimals:
                            type: integer
                            description: Number of decimal places
                            example: 10
                  origin:
                    type: object
                    description: TO BE EXPLAINED
                    properties:
                      publisher:
                        type: string
                        description: TO BE EXPLAINED
                        example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
                      reward:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 2449913938434801029
                      hash:
                        type: string
                        description: TO BE EXPLAINED
                        example: BITGENESIS
                      link:
                        type: string
                        description: TO BE EXPLAINED
                        example: BITGENESIS
                      sprout:
                        type: string
                        description: TO BE EXPLAINED
                        example: BITGENESIS
                      time:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 0
                  fee_shares:
                    type: object
                    description: TO BE EXPLAINED
                    properties:
                      gen_share:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 300
                      pow_share:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 50
                      ldr_share:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 50
                      pos_share:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 9600
                  MPK:
                    type: object
                    description: TO BE EXPLAINED
                    properties: 
                      x:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 1 1887977886599394063028178950947279860127724050479032082036805996418912013153131127696715993837524647383570338355695255786360661495991220227612598684883028 3780267397673468252343519622281735554920859525529214838409547998448097213079684300112811104508239777017758612507356636174013439449215588949644233352733139
                      y: 
                        type: integer
                        description: TO BE EXPLAINED
                        example: 1 607218419856648654813472028821287383397295365990787484847671131205048590195733091420684296247120974745720384180519261046258140424163987254801646299078125 3574484102938033217678888696334982695759754668992496989785966938244090853405896393856377280681069520660874902711918462986779665727013338716276831662950626
                  mblock_slots:
                    type: object
                    description: TO BE EXPLAINED
                    properties:
                      size:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 2
                      count:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 2
                      min_stake:
                        type: integer
                        description: TO BE EXPLAINED - minimal stake
                        example: 5000000000000000
                  dex:
                    type: object
                    description: TO BE EXPLAINED
                    properties:
                      DEX_COMMANDER_ADDRESS:
                        type: string
                        description: TO BE EXPLAINED
                        example: 033333333333333333333333333333333333333333333333333333333333333333
                      DEX_BURN_ADDRESS:
                        type: string
                        description: TO BE EXPLAINED
                        example: 02dead000000000000000000000000000000000000000000000000000000000000
                      DEX_ENX_TOKEN_HASH:
                        type: string
                        description: TO BE EXPLAINED
                        example: 824e7b171c01e971337c1b25a055023dd53c003d4aa5aa8b58a503d7c622651e
                      DEX_SPACE_STATION_ID:
                        type: string
                        description: TO BE EXPLAINED
                        example: 50789932e52d80ff65a56547274498d865ce1d85f14bbacdcd5b575191f87621
                      DEX_COMMANDER_FEE:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 5
                      DEX_POOL_FEE:
                        type: integer
                        description: TO BE EXPLAINED
                        example: 30
                      DEX_TRUSTED_TOKENS:
                        type: string
                        description: TO BE EXPLAINED
                        example: 824e7b171c01e971337c1b25a055023dd53c003d4aa5aa8b58a503d7c622651e
  /stats:
    get: 
      tags: 
        - Network
      summary: 'Returns network stats.'
      description: 'Returns network stats. Check response schema for more details.'
      responses:
        '200':
            description: Successfully returned network stats.
            content:
              application/json:
                schema:
                  properties:
                    accounts:
                      type: integer
                      description: Number of accounts.
                      example: 2128
                    apkUrl:
                      type: integer
                      description: URL for the latest version Android Masternode App download.
                      example: 
                    block_time_24h_avg:
                      type: integer
                      description: Average time in seconds between k-block generation in the last 24 hours.
                      example: 15
                    block_time_30d_avg:
                      type: integer
                      description: Average time in seconds between k-block generation in the last 30 days.
                      example: 13
                    block_time_target:
                      type: integer
                      description: Targeted time in seconds between k-block generation.
                      example: 15
                    calc_rois:
                      type: integer
                      description: The balance the PoA node will have after mining for 24 hours with a *calc_stakes* stake.
                      example: 250008797842
                    calc_stakes:
                      type: integer
                      description: The stake that is used to calculate *calc_rois*.
                      example: 250000000000
                    cashier_ptr:
                      type: integer
                      description: Block hash that is used for cashier calculation.
                      example: 6
                    cg_btc:
                      type: number
                      description: Current ENQ value in BTC based on [CoinGecko](https://www.coingecko.com/en/coins/enecuum).
                      example: 0.00000122
                    cg_eth:
                      type: number
                      description: Current ENQ value in ETH based on [CoinGecko](https://www.coingecko.com/en/coins/enecuum).
                      example: 0.00004273
                    cg_usd:
                      type: number
                      description: Current ENQ value in USD based on [CoinGecko](https://www.coingecko.com/en/coins/enecuum).
                      example: 0.01615963
                    csup:
                      type: integer
                      description: ENQ circulating supply, i.e., the total ENQ supply minus [team wallet](https://pulse.enecuum.com/#!/account/0270a88ea6f7c5ea2a2ec3878008d878a70fd5d4ca27d5866d0eec3594cab0b912/0) and [fund wallet](https://pulse.enecuum.com/#!/account/026df0aa41967d8d47082c36b29a164aa1c90cdd07cb02d373daaba90b8eca5301/0). The returned value is multiplied by 10^10.
                      example: 3407411488880000000
                    difficulty:
                      type: number
                      description: Mining difficulty.
                      example: 9.69
                    engaged_balance:
                      type: integer
                      description: Total stakes of PoA and PoS nodes. The returned value is multiplied by 10^10.
                      example: 3272847385977657300
                    full_count:
                      type: integer
                      description: Number of active Full nodes.
                      example: 2
                    height:
                      $ref: '#/components/schemas/Height'
                    indexer_ptr:
                      type: integer
                      description: Block hash that is used by the explorer.
                      example: 0
                    maxApkVersion:
                      type: integer
                      description: This is used for auto updating of Enecuum Masternode Android app.
                      example: 0
                    max_stake:
                      type: integer
                      description: PoA stake threshold. Having greater stake results in no additional rewards. The returned value is multiplied by 10^10.
                      example: 250000000000000
                    max_tps:
                      type: integer
                      description: Current maximum number of transactions per second. This is NOT the maximum possible TPS for Enecuum.
                      example: 17
                    minApkVersion:
                      type: integer
                      description: Minimum version of Enecuum Android App required for mining.
                      example: 0
                    min_stake:
                      $ref: '#/components/schemas/MinStake'
                    network_hashrate:
                      type: integer
                      description: Network hashrate in hashes per second.
                      example: 826
                    poa_capable_count:
                      type: integer
                      description: The number of PoA accounts capable of mining, i.e., with  available balance of at least minimum stake.
                      example: 2109
                    poa_count:
                      type: integer
                      description: Number of active PoA nodes.
                      example: 648
                    pos_active_count:
                      type: integer
                      description: Number of PoS contracts that have received rewards in the last X blocks (the value may be different, currently X = 5760).
                      example: 1
                    pos_count:
                      type: integer
                      description: Number of active PoS nodes.
                      example: null
                    pos_total_count:
                      type: integer
                      description: Number of all PoS contracts.
                      example: 23
                    pow_count:
                      type: integer
                      description: Number of active PoW nodes.
                      example: 1
                    proposed_inflation:
                      type: integer
                      description: Proposed inflation calculated as yearly rewards divided by total supply.
                      example: 0
                    referrer_stake:
                      $ref: '#/components/schemas/ReferrerStake'
                    reward_poa:
                      type: integer
                      description: Rewards received by PoA nodes in the last 24 hours. The returned value is multiplied by 10^10.
                      example: 1016375584599730
                    reward_pos:
                      type: integer
                      description: Rewards received by PoS nodes in the last 24 hours. The returned value is multiplied by 10^10.
                      example: 291775352000000
                    reward_pow:
                      type: integer
                      description: Rewards received by PoW nodes in the last 24 hours. The returned value is multiplied by 10^10.
                      example: 26525032000000
                    total_daily_pos_stake:
                      type: integer
                      description: TODO.
                      example: 0
                    total_daily_stake:
                      type: integer
                      description: Total PoA nodes stake. The returned value is multiplied by 10^10.
                      example: 3272841444722907600
                    tps:
                      type: integer
                      description: Transactions per second.
                      example: 0
                    tsup:
                      type: integer
                      description: ENQ total supply. The returned value is multiplied by 10^10.
                      example: 1901936042160000000
                    txfee_daily_30d_avg:
                      type: integer
                      description: Average transaction fees in the last 30 days.
                      example: 28560
                    txfee_hourly_24h_avg:
                      type: integer
                      description: Average transaction fees in the last 24 hours.
                      example: 2071

  /tps: 
    get:
      tags:
        - Network
      summary: 'Returns TPS (transactions per second) value'
      responses:
        '200':
          description: Successfully returned.
          content:
            application/json:
              schema:
                properties:
                  tps:
                    type: integer
                    description: 'Average rounded aount of transactions during the last 300 seconds'
                    example: 1

  /get_tokens_count:
    get:
      tags:
        - Network
      summary: 'Returns the number of tokens deployed on the network and the breakdown of those tokens by type.'
      responses:
        '200':
          description: 'The number of tokens and their breakdown by type.'
          content:
            application/json:
              schema:
                properties:
                  count:
                    type: integer
                    description: 'The total number of tokens deployed on the network.'
                    example: 1427
                  non_reissuable:
                    type: integer
                    description: 'The number of non-reissuable tokens.'
                    example: 873
                  reissuable:
                    type: integer
                    description: 'The number of reissuable tokens.'
                    example: 279
                  minable:
                    type: integer
                    description: 'The number of minable tokens.'
                    example: 275

  /get_token_holder_count:
    get:
      tags:
        - Network
      summary: 'Returns the amount of accounts that hold the specified token. If no token is specified, it returns the amount of accounts that hold the native token (BIT)'
      parameters:
        - in: query
          name: hash
          required: false
          description: 'Token hash.'
          schema:
            type: string
      responses:
        '200':
          description: The amount of token holders.
          content:
            application/json:
              schema:
                properties:
                  count:
                    type: integer
                    description: 'The amount of token holding accounts'
                    example: 34676

  /get_tickers_all: 
    get:
      tags:
        - Network
      summary: 'Returns the list of all token tickers on the network, including token hashes and captions.'
      responses:
        '200':
          description: 'The list of all token tickers on the network, including token hashes and captions.'
          content:
            application/json:
              schema:
                properties:
                  hash:
                    type: string
                    description: 'Token hash.'
                    example: 0000000000000000000000000000000000000000000000000000000000000001
                  ticker:
                    type: string
                    description: 'Token ticker.'
                    example: BIT
                  caption:
                    type: string
                    description: 'Token caption (long name).'
                    example: Enecuum testnet BIT
  /get_transfer_lock:
    get:
      tags: 
        - Network
      summary: 'Returns asset lock duration.'
      description: 'Returns asset lock duration.' #TODO: elaborate
      responses:
        '200':
          description: Successfully returned transfer lock.
          content:
            application/json:
             schema:
              properties:
                transfer_lock:
                  type: integer
                  description: Transfer lock duration. #TODO: elaborate
                  example: 5
  /peer_map:
    get:
      tags:
        - Network
      summary: 'Returns the map of peer nodes on the blockchain'
      description: 'Returns a breakdown of peer nodes by location'
      responses:
        '200':
          description: Peer node properties
          content:
           application/json:
            schema:
              type: array
              description: Peer info by location
              items:
                type: object
                properties:
                  type: 
                    type: integer
                    description: 'Peer type.' # (to be expanded)
                    example: 2
                  city:
                    type: string
                    description: 'City where the peers are based'
                    example: 'Beverwijk'
                  lat:
                    type: number
                    description: 'Latitude of the city where the peers is based'
                    example: 52.4847
                  lon:
                    type: number
                    description: 'Longitude of the city where the peers are based'
                    example: 4.6543
                  count: 
                    type: integer
                    description: 'Total count of nodes based in the city'
                    example: 10   
  /height:
    get:
      tags:
        - Network
      summary: 'Returns blockchain height.'
      description: 'Returns the last block number, i.e., the total number of blocks in the blockchain. The block count starts with 0.'
      responses:
        '200':
            description: Successfully returned block height.
            content:
              application/json:
                schema:
                  properties:
                    height:
                      $ref: '#/components/schemas/Height'
  /difficulty:
    get:
      tags:
        - Network
      summary: 'Returns block mining difficulty.'
      description: 'Returns block mining difficulty.'
      responses:
        '200':
            description: Successfully returns mining difficulty.
            content:
              application/json:
                schema:
                  properties:
                    difficulty:
                      type: number
                      format: float
                      description: 'Block mining difficulty'
                      example: 0.00

  /ext/plain/hashrate:
    get:
      tags:
        - Network
      summary:  'Returns blockchain hash rate.'
      description: 'Returns blockchain hash rate.'
      responses:
        '200':
          description: 'Successfully returns blockchain hash rate.'
          content:
            application/json:
              schema:
                properties:
                  hashrate:
                    type: number
                    description: 'Blockchain hash rate.'
                    example: 2.0139111001134378

### TOKEN METHODS

  /native_token:
    get:
      tags: 
        - Token
      summary: 'Returns token info about the native token of the network.'
      responses:
        '200':
          description: Token info.
          content:
            application/json:
              schema:
                properties: 
                  hash: 
                    type: string
                    description: Token hash
                    example: '0000000000000000000000000000000000000000000000000000000000000001'
                  owner:
                    type: string
                    description: Address of the account that created the token
                    example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
                  fee_type:
                    type: integer
                    description: Fee type (see comment below, TO BE CLARIFIED - see comment below)
                    # 0 - flat fee for owner upon transaction in reward tokens, 1 - percent fee in reward tokens, 2 - native fee, fixed, charged in native tokens)
                    example: 0
                  fee_value:
                    type: integer
                    description: Fee value
                    example: 1000000000
                  fee_min:
                    type: integer
                    description: Minimal fee
                    example: 1000000000
                  ticker:
                        type: string
                        description: Token ticker
                        example: BIT
                  decimals:
                    type: integer
                    description: Number of decimal places
                    example: 10
                  total_supply:
                    type: string
                    description: Total supply of the token
                    example: 2455559059822244864
                  caption:
                    type: string
                    description: Long token name
                    example: Enecuum Testnet BIT
                  active:
                    type: integer
                    description: TO BE EXPLAINED
                    # has something to do with mining slots?
                    example: 0
                  reissuable:
                    type: integer
                    description: Indicates whether the token is reissuable (can be minted and burned)
                    example: 0
                  minable:
                    type: integer
                    description: Indicates whether a token can be mined
                    example: 1
                  max_supply:
                    type: integer
                    description: Maximum token supply
                    example: 3500000000000000000
                  block_reward:
                    type: integer
                    description: Reward for the mining of a block
                    example: 30460000000
                  min_stake:
                    type: integer
                    description: Minimal stake for a PoS node
                    example: 250000000000
                  referrer_stake:
                    type: integer
                    description: TO BE EXPLAINED
                    example: 10000000000000
                  ref_share:
                    type: integer
                    description: TO BE EXPLAINED
                    example: 2574
                  txs_count:
                    type: integer
                    description: (TO BE CLARIFIED) Amount of transactions with this token
                    example: 6406044
                  cg_price_usd:
                    type: integer
                    description: CoinGecko price of the token in USD (TO BE CLARIFIED)
                    example: 0.03952753
                  dex_price_usd:
                    type: integer
                    description: Price of the token on pour DEX (ENEX? TO BE CLARIFIED)
                    example: 0.03952753
                  price_raw:
                    type: object
                    description: another ("raw", without decimal point) representation of cg_price_usd and dex_price_usd
                    properties:
                      cg_price:
                        type: integer
                        description: CoinGecko price, different representation
                        example: 395275300
                      dex_price:
                        type: integer
                        description: Our DEX price, different representation
                        example: 395275300
                      decimals:
                        type: integer
                        description: Number of decimal places
                        example: 10

  /token_info:
    get: 
      tags: 
        - Token
      summary: 'Returns information about the token.'
      description: 'Returns general information about the token. Multiple examples of possible responses can be chosen below. The description of the response can be found in the response schema.'
      parameters: 
        - name: hash
          in: query
          required: true
          description: 'Token hash.'
          schema:
            $ref: '#/components/schemas/Token'
      responses:
        '200':
            description: Successfully returned token info.
            content:
              application/json:
                schema:
                  type: array
                  items:
                    type: object
                    properties:
                      hash:
                        $ref: '#/components/schemas/Token'
                      owner:
                        $ref: '#/components/schemas/Owner'
                      fee_type:
                        type: integer
                        description: |
                          One of the following fee types is possible:
                          - 0 means flat fee;
                          - 1 means percent fee.
                        enum: [0,1]
                        example: 0
                      fee_value:
                        type: integer
                        description: For flat fee, the fee amount is multiplied by 10^*d*, where *d* stands for the number of decimal places. For percent fee, the fee amount is multiplied by 100.
                        example: 10000000000
                      fee_min:
                        type: integer
                        description: The minimum flat fee in case the token uses percent fee. 
                        example: 10000000000
                      ticker:
                        $ref: '#/components/schemas/Ticker'
                      decimals:
                        $ref: '#/components/schemas/Decimals'
                      total_supply:
                        type: integer
                        description: The token emission. The amount is multiplied by 10^*d*, where *d* stands for the number of decimal places. 
                        example: 5010637449999934464
                      caption:
                        type: string
                        description: A 0-40 character token description. Can be empty.
                        example: mining token 2
                      active:
                        type: integer
                        description: |
                          One of the following statuses is possible:
                          - 0 means inactive;
                          - 1 means active.
                        enum: [0,1]
                        example: 1
                      reissuable:
                        $ref: '#/components/schemas/Reissuable'
                      minable:
                        $ref: '#/components/schemas/Minable'
                      max_supply:
                        type: integer
                        description: A maximum token emission. Upon reaching this number, the token can no longer be mined.
                        example: 10000000000000000000
                      block_reward:
                        type: integer
                        description: A reward for each mined macroblock. This number includes the referral reward.
                        example: 50000000000
                      min_stake:
                        $ref: '#/components/schemas/MinStake'
                      referrer_stake:
                        $ref: '#/components/schemas/ReferrerStake'
                      ref_share:
                        type: integer
                        description: A share of the total block reward that determines the referral reward amount. The referral reward is distributed among the referral and their agent equally
                        example: 1000
                      txs_count:
                        type: integer
                        description: The number of transactions with this token (within which timeframe?)
                        example: 1
                      cg_price_usd:
                        type: integer
                        description: CoinGecko price of the token
                        example: null
                      dex_price_usd:
                        type: integer
                        description: Price of the token on pour DEX (ENEX? TO BE CLARIFIED)
                        example: 0.0361261927
                      price_raw:
                        type: object
                        description: another ("raw", without decimal point) representation of cg_price_usd and dex_price_usd
                        properties:
                          cg_price:
                            type: integer
                            description: CoinGecko price, different representation
                            example: null
                          dex_price:
                            type: integer
                            description: Our DEX price, different representation
                            example: 361261927
                          decimals:
                            type: integer
                            description: Number of decimal places
                            example: 10
                examples:
                  reissuable:
                    description: Tokens with a flexible supply. After the token release, its supply can be changed by issuing or burning of coins.
                    value:
                      - hash: "0000000000000000000000000000000000000000000000000000000000000000"
                        owner: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
                        fee_type: 0
                        fee_value: 100000000
                        fee_min: 0
                        ticker: BIT
                        decimals: 10
                        total_supply: 3493999410335106560
                        caption: Enecuum testnet BIT
                        active: 0
                        reissuable: 1
                        minable: 0
                        max_supply: null
                        block_reward: null
                        min_stake: null
                        referrer_stake: null
                        ref_share: null
                  non-reissuable:
                    description: Tokens with a fixed supply. After the token release, extra token coins can not be emitted.
                    value:
                      - hash: "0000000000000000000000000000000000000000000000000000000000000000"
                        owner: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
                        fee_type: 0
                        fee_value: 100000000
                        fee_min: 0
                        ticker: BIT
                        decimals: 10
                        total_supply: 3493999410335106560
                        caption: Enecuum testnet BIT
                        active: 0
                        reissuable: 0
                        minable: 0
                        max_supply: null
                        block_reward: null
                        min_stake: null
                        referrer_stake: null
                        ref_share: null
                  mineable:
                    description: Tokens that can be mined. Some volume is selected for instant release (pre-mine), and the rest is mined by users.
                    value:
                      - hash: "0000000000000000000000000000000000000000000000000000000000000000"
                        owner: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
                        fee_type: 0
                        fee_value: 100000000
                        fee_min: 0
                        ticker: BIT
                        decimals: 10
                        total_supply: 3493999410335106560
                        caption: Enecuum testnet BIT
                        active: 0
                        reissuable: 0
                        minable: 1
                        max_supply: 9000000000000000000
                        block_reward: 96560000000
                        min_stake: 250000000000
                        referrer_stake: 10000000000000
                        ref_share: 1000

  /get_token_info_page:
    get:
      tags:
        - Token
      summary: 'Returns the properties of the tokens listed on a specific BIT Explorer page. If no page number is specified, the amount of tokens to be displayed on a page and the total number of token info pages are returned.'
      # I really don't know whether the output should include ALL ten tokens listed on a page - to be clarified!
      parameters:
        - in: query
          name: page
          required: false
          description: 'Page number.'
          schema:
            type: integer
      responses:
        '200':
          description: Properties of the tokens listed on the specified page. 
          content:
            application/json:
              schema:
                properties: 
                  hash: 
                    type: string
                    description: Token hash
                    example: '0000000000000000000000000000000000000000000000000000000000000001'
                  owner:
                    type: string
                    description: Address of the account that created the token
                    example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
                  fee_type:
                    type: integer
                    enum: [0,1,2]
                    description: Fee type |
                      0 - flat fee for owner upon transaction in reward tokens
                      1 - percentage fee in reward tokens
                      2 - fixed fee, charged in native tokens
#                    (see comment below, TO BE CLARIFIED - see comment below)
                    # 0 - flat fee for owner upon transaction in reward tokens, 1 - percentage fee in reward tokens, 2 - fixed fee, charged in native tokens)
                    example: 0
                  fee_value:
                    type: integer
                    description: Fee value
                    example: 1000000000
                  fee_min:
                    type: integer
                    description: Minimal fee
                    example: 1000000000
                  ticker:
                    type: string
                    description: Token ticker
                    example: BIT
                  decimals:
                    type: integer
                    description: Number of decimal places
                    example: 10
                  total_supply:
                    type: string
                    description: Total supply of the token
                    example: 2455559059822244864
                  caption:
                    type: string
                    description: Long token name
                    example: Enecuum Testnet BIT
                  active:
                    type: integer
                    enum: [0,1]
                    description: TO BE EXPLAINED (something to do with mining slots?)
                    example: 0
                  reissuable:
                    type: integer
                    enum: [0,1]
                    description: Indicates whether the token is reissuable (can be minted and burned)
                    example: 0
                  minable:
                    type: integer
                    enum: [0,1]
                    description: Indicates whether a token can be mined
                    example: 1
                  max_supply:
                    type: integer
                    description: Maximum token supply
                    example: 3500000000000000000
                  block_reward:
                    type: integer
                    description: Reward for the mining of a block
                    example: 30460000000
                  min_stake:
                    type: integer
                    description: Minimal stake for a PoA node (apples if the token is mineable) 
                    example: 250000000000
                  referrer_stake:
                    type: integer
                    description: TO BE EXPLAINED
                    example: 10000000000000
                  ref_share:
                    type: integer
                    description: TO BE EXPLAINED
                    example: 2574
                  txs_count:
                    type: integer
                    description: (TO BE CLARIFIED) Amount of transactions with this token
                    example: 6406044
                  in_slot:
                    type: integer
                    description: Describes whether the token is in the (current) mining slot (TO BE CLARIFIED)
                    example: 0
                  cg_price_usd:
                    type: integer
                    description: CoinGecko price of the token in USD (TO BE CLARIFIED)
                    example: 0.03952753
                  dex_price_usd:
                    type: integer
                    description: Price of the token on pour DEX (ENEX? TO BE CLARIFIED)
                    example: 0.03952753
                  price_raw:
                    type: object
                    description: another ("raw", without decimal point) representation of cg_price_usd and dex_price_usd
                    properties:
                      cg_price:
                        type: integer
                        description: CoinGecko price, different representation
                        example: 395275300
                      dex_price:
                        type: integer
                        description: Our DEX price, different representation
                        example: 395275300
                      decimals:
                        type: integer
                        description: Number of decimal places
                        example: 10

                        
  /get_tokens_by_owner:
    get:
      tags: 
        - Token
      summary: 'Returns tokens by owner.'
      description: 'Returns a list of tokens of the specified wallet.'
      parameters: 
        - name: owner
          in: query
          required: true
          description: 'Token owner address.'
          schema:
            $ref: '#/components/schemas/Owner'
      responses:
        '200':
            description: Successfully returned a list of tokens by owner.
            content:
              application/json:
                schema:
                  type: array
                  items:
                    type: object
                    properties:
                      token_hash:
                        $ref: '#/components/schemas/Token'
                      total_supply:
                        type: integer
                        description: A token supply at the time of the issue. 
                        example: 9510000000000
                      fee_type:
                        type: integer
                        description: Determines whether the fee is fixed or percentage. 0 means fixed, 1 means percentage. 
                        example: 0
                      fee_value:
                        type: integer
                        description: An exact fee amount for token transactions. If the fee is fixed, the value is multiplied by 10^*d*, where *d* stands for the number of decimal places. If the fee is percentage, the value is multiplied by 100 (e.g. a 1% fee is returned as 100). 
                        example: 10000000000
                      fee_min:
                        type: integer
                        description: A minimum fee for token transactions if the token type is percentage. For fixed fees, fee_min equals fee_value.
                        example: 10000000000
                      reissuable:
                        $ref: '#/components/schemas/Reissuable'
                      minable:
                        $ref: '#/components/schemas/Minable'

  /macroblock:
    get:
      tags:
        - Block
      summary: 'Returns macroblock info by its hash.'
      description: 'Returns k-block, microblocks and s-blocks attached to it. Microblock hashes are sorted lexicographically in hexadecimal format.'
      parameters:
        - name: hash
          in: query
          required: true
          description: 'Macroblock (k-block) hash'
          schema:
            type: string
            example: '8f92f307503fe2877415b8d1818765aa6ab3196a26abc453f99f72173d0c8c8b'
      responses:
        '200':
          description: Successfully returned macroblock content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  kblock:
                    type: object
                    description: 'K-block content. A macroblock can contain only one k-block.'
                    properties:
                      hash: 
                        allOf:
                          - $ref: '#/components/schemas/Hash'
                          - example: 0028caa83e2cba8d32e6448130805f168d9348218ce37d7d35993ad050b7952b
                      n:
                        type: integer
                        description: 'Height of the macroblock.' 
                        example: 5211
                      time:
                        type: integer
                        description: 'K-block publishing time in Unix Time format.' 
                        example: 1592385962
                      publisher:
                        type: string
                        description: 'Public key of a k-block publisher.' 
                        example: 034b4875bf08ffd5a4f0b06c21f951aa3e2f979d2d9f1bb4a64e0600eac2350beb
                      nonce:
                        allOf:
                          - $ref: '#/components/schemas/Nonce'
                          - example: 41
                      link:
                        type: string
                        description: 'Previous k-block hash.' 
                        example: 00fb459c1f8de0b24d074641a76878ab9528acaf62a9a33a0d9874a92e3349b5
                      sprout:
                        type: string
                        description: 'Merkle tree top hash.' 
                        example: BITGENESIS
                      m_root:
                        type: string
                        description: 'Merkle tree root.' 
                        example: 61b80791bfdd95cf958b3eb21412dc15634f15b5e692e68401abdf9b1d794135
                      reward:
                        type: integer
                        description: 'Reward for k-block mining.' 
                        example: 15449600000
                      target_diff:
                        type: integer
                        description: 'Hash calculation difficulty.' 
                        example: 141304204
                  mblocks:
                    type: array
                    description: 'Microblock content. There can be multiple microblocks. In each microblock, there can be multiple transactions.'
                    items:
                      type: object
                      properties:
                        hash:
                          $ref: '#/components/schemas/Hash'
                        tx_cnt:
                          type: integer
                          description: 'The amount of transactions in a microblock.'
                    example:
                      - hash: bfac67dcb2f2b7a8275f0787c8c98f356b6a51635de61bc981c0eec386453fe7
                        tx_cnt: 3
                      - hash: caa23e95b2cd0f11f5713a340309c1148a9519c4178330f03e95a82b612758bb
                        tx_cnt: 3
                  sblocks:
                    type: array
                    description: 'Statblock content. There can be multiple statblocks.'
                    items:
                      type: object
                      properties:
                        hash:
                          $ref: '#/components/schemas/Hash'
                    example:
                      - hash: 57c5d28b3e82508a873d0c311aeabdc87642e6f6802196110a7c0146f6fb9991
                  snapshot_hash:
                    type: integer
                    description: 'To be clarified!'
                    example: null
                    
  /macroblock_by_height:
    get:
      tags:
        - Block
      summary: 'Returns macroblock info by its height.'
      description: 'Returns k-block, microblocks and s-blocks attached to it. Microblock hashes are sorted lexicographically in hexadecimal format.'
      parameters:
        - name: height
          in: query
          required: true
          description: 'Block number (height)'
          schema:
            type: integer
            example: 5211
      responses:
        '200':
          description: Successfully returned macroblock content.
          content:
            application/json:
              schema:
                type: object
                properties:
                  kblock:
                    type: object
                    description: 'K-block content. A macroblock can contain only one k-block.'
                    properties:
                      hash: 
                        allOf:
                          - $ref: '#/components/schemas/Hash'
                          - example: 0028caa83e2cba8d32e6448130805f168d9348218ce37d7d35993ad050b7952b
                      n:
                        type: integer
                        description: 'Height of the macroblock.' 
                        example: 5211
                      time:
                        type: integer
                        description: 'K-block publishing time in Unix Time format.' 
                        example: 1592385962
                      publisher:
                        type: string
                        description: 'Public key of a k-block publisher.' 
                        example: 034b4875bf08ffd5a4f0b06c21f951aa3e2f979d2d9f1bb4a64e0600eac2350beb
                      nonce:
                        allOf:
                          - $ref: '#/components/schemas/Nonce'
                          - example: 41
                      link:
                        type: string
                        description: 'Previous k-block hash.' 
                        example: 00fb459c1f8de0b24d074641a76878ab9528acaf62a9a33a0d9874a92e3349b5
                      sprout:
                        type: string
                        description: 'Merkle tree top hash.' 
                        example: BITGENESIS
                      m_root:
                        type: string
                        description: 'Merkle tree root.' 
                        example: 61b80791bfdd95cf958b3eb21412dc15634f15b5e692e68401abdf9b1d794135
                      reward:
                        type: integer
                        description: 'Reward for k-block mining.' 
                        example: 15449600000
                      target_diff:
                        type: integer
                        description: 'Hash calculation difficulty.' 
                        example: 141304204
                  mblocks:
                    type: array
                    description: 'Microblock content. There can be multiple microblocks. In each microblock, there can be multiple transactions.'
                    items:
                      type: object
                      properties:
                        hash:
                          $ref: '#/components/schemas/Hash'
                        tx_cnt:
                          type: integer
                          description: 'The amount of transactions in a microblock.'
                    example:
                      - hash: bfac67dcb2f2b7a8275f0787c8c98f356b6a51635de61bc981c0eec386453fe7
                        tx_cnt: 3
                      - hash: caa23e95b2cd0f11f5713a340309c1148a9519c4178330f03e95a82b612758bb
                        tx_cnt: 3
                  sblocks:
                    type: array
                    description: 'Statblock content. There can be multiple statblocks.'
                    items:
                      type: object
                      properties:
                        hash:
                          $ref: '#/components/schemas/Hash'
                    example:
                      - hash: 57c5d28b3e82508a873d0c311aeabdc87642e6f6802196110a7c0146f6fb9991   


  /mblock:
    get:
      tags: 
        - Block
      summary: 'Returns the contents of a microblock.'
      description: 'Returns microblock transactions and header. A microblock is a part of a macroblock. Microblocks contain transactions, which are sorted lexicographically by hexadecimal hash.'
      parameters: 
        - name: hash
          in: query
          required: true
          description: 'Microblock hash.'
          schema:
            allOf:
              - $ref: '#/components/schemas/Hash'
              - example: 9508e1b33a7ed92dc8c37a08c6ecbba22cc38af3e33bf57dc0af0fa808f27d46
      responses:
        '200':
          description: Successfully returned microblock contents.
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactions:
                    type: array
                    description: 'Transaction content. There can be multiple transactions.'
                    items:
                      type: object
                      properties:
                        hash:
                          $ref: '#/components/schemas/Hash'
                        from:
                          $ref: '#/components/schemas/From'
                        to:
                          $ref: '#/components/schemas/To'
                        amount:
                          $ref: '#/components/schemas/Amount'
                        mblocks_hash:
                          type: string
                          description: M-block hash. M-blocks contain transactions.
                          example: a0477381285cdb1815cb7bb939baf9bd1785c76792be82d7a310818189ff9dbd
                        nonce:
                          $ref: '#/components/schemas/Nonce'
                        status:
                          $ref: '#/components/schemas/Status'
                        sign:
                          $ref: '#/components/schemas/Sign'
                        ticker:
                          $ref: '#/components/schemas/Token' 
                        data:
                          $ref: '#/components/schemas/Data'
                  header:
                    type: object
                    description: 'Microblock header.'
                    properties:
                      kblocks_hash: 
                        allOf:
                          - $ref: '#/components/schemas/Hash'
                          - example: 007bbe8c1256915d5ebdc51ff9cec9792d79b2d533832e5fe203129cb949360f
                      publisher:
                        type: string
                        description: 'Public key of a k-block publisher.' 
                        example: 034b4875bf08ffd5a4f0b06c21f951aa3e2f979d2d9f1bb4a64e0600eac2350beb
                      referrer:
                        type: string
                        description: 'Public key of a referrer. Can be null.' 
                        nullable: true
                        example: null
                      mblocks_hash:
                        allOf:
                          - $ref: '#/components/schemas/Hash'
                          - example: fb263c111d0b07afb2fb0125f7e1b48060d4b24eaeef83afed9d570b5cbc0f09
                      reward:
                        type: integer
                        description: 'A reward for the microblock publication.' 
                        example: 4387962285
                      nonce:
                        $ref: '#/components/schemas/Nonce'
                      token:
                        $ref: '#/components/schemas/Token'

# /mblocks - QUITE MYSTERIOUS, check Explorer.JS line 468 and onwards - still investigating

  /sblock:
    get:
      tags: 
        - Block
      summary: 'Returns contents of a statblock.'
      description: 'Returns statblock header. A statblock is a part of a macroblock.'
      parameters: 
        - name: hash
          in: query
          required: true
          description: 'Statblock hash.'
          schema:
            allOf:
              - $ref: '#/components/schemas/Hash'
              - example: f6503f7f6388e53a0284f641c1872b61b62bcec3adb5420d430c2676455d4c2b
      responses:
        '200':
            description: Successfully returned statblock contents.
            content:
              application/json:
                schema:
                  type: object
                  properties:
                    header:
                      type: object
                      properties:
                        kblocks_hash: 
                          allOf:
                            - $ref: '#/components/schemas/Hash'
                            - example: 007bbe8c1256915d5ebdc51ff9cec9792d79b2d533832e5fe203129cb949360f
                        publisher:
                          type: string
                          description: 'Public key of a k-block publisher.' 
                          example: 034b4875bf08ffd5a4f0b06c21f951aa3e2f979d2d9f1bb4a64e0600eac2350beb
                        sblocks_hash:
                          $ref: '#/components/schemas/Hash'
                        reward:
                          type: integer
                          description: 'A reward for the statblock publication.' 
                          example: 4387962285
                        
  /lastblocks:
    get:
      tags:
        - Block
      summary: 'Returns the information on the last 10 macroblocks.'
      description: 'Returns the information on the last 10 macroblocks, sorted by height.'
      responses:
        '200':
          description: Successfully returned macroblock content.
          content:
            application/json:
              schema:
                type: array
                description: 'Last 10 macroblocks as shown on the Explorer main page.'
                items:
                  type: object
                  properties:
                    hash: 
                      allOf:
                        - $ref: '#/components/schemas/Hash'
                        - example: 0029d169e059ad1c352106ed980a958b2cce285db007a32d014e3ae6f1d96a4f
                    n:
                      type: integer
                      description: 'Height of the macroblock.' 
                      example: 283672
                    time:
                      type: integer
                      description: 'K-block publishing time in Unix Time format.' 
                      example: 1654100000
                    publisher:
                      type: string
                      description: 'Public key of the publisher of the k-block.' 
                      example: 03a3a059b05feb9443c9cc352161f1873b97e0dff61c939e77f1923113631cf8ea
                    nonce:
                      allOf:
                        - $ref: '#/components/schemas/Nonce'
                        - example: 1809989526
                    link:
                      type: string
                      description: 'Previous k-block hash.' 
                      example: 001f6a2364a363b6caf31ce1a6eee32de2fbcc2b645ce43fdfb6166479c13b62
                    sprout:
                      type: string
                      description: 'Merkle tree top hash.' 
                      example: BITGENESIS
                    m_root:
                      type: string
                      description: 'Merkle tree root.' 
                      example: 79653c77a7313f90d1debee6c8c9cd797e8594def478a8b9d3f3b0a5b83c2f33
                    leader_sign:
                      type: object
                      description: 'Macroblock signature TO BE CLARIFIED.'
                      properties: 
                        type:
                          type: string
                          description: 'TBC!!!'
                          example: 'Buffer'
                        data:
                          $ref: '#/components/schemas/Data'
                    reward:
                      type: integer
                      description: 'Reward for k-block mining.' 
                      example: 1523000000
                    target_diff:
                      type: integer
                      description: 'Hash calculation difficulty.' 
                      example: 168922851
                    


# /lastblocks on page - TO BE ADDED

### ACCOUNT INFO (all to be added!!!)

### BALANCE

  /balance:
    get:
      tags: 
        - Balance
      summary: 'Returns wallet balance.'
      description: 'Returns the token amount held on the specified wallet address if the address exists. If no token is specified, returns ENQ.'
      parameters: 
        - name: id
          in: query
          required: true
          description: The wallet address (public key). 
          schema:
            type: string
            example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
        - name: token
          in: query
          required: false
          description: 'Token hash.'
          schema:
            $ref: '#/components/schemas/Token'
      responses:
        '200':
          description: Successfully returned wallet balance.
          content:
            application/json:
             schema:
              properties:
                amount:
                  $ref: '#/components/schemas/Amount'
                token:
                  $ref: '#/components/schemas/Token'
                ticker:
                  $ref: '#/components/schemas/Ticker'
                decimals:
                  $ref: '#/components/schemas/Decimals'
                delegated:
                  type: integer
                  description: The number of delegated (lent) coins. #TODO: elaborate
                  example: 0
                transit:
                  type: integer
                  description: The number of coins for transit. #TODO: elaborate
                  example: 0
                undelegated:
                  type: integer
                  description: The number of undelegated coins. #TODO: elaborate
                  example: 0
                reward:
                  type: integer
                  description: The number of earned coins. #TODO: elaborate
                  example: 0


### TRANSACTIONS

  /tx:
    post:
      tags: 
        - Transactions
      summary: 'Performs transaction.'
      description: |
        Performes transaction using the request body. After performing the transaction, its status can be checked with the GET /tx method. In the response body, you can view both successful and unsuccessful results. Click "success" or "error" to access them.
        
        The **amount** for transfer needs to be set depending on the number of decimal places the token has. For example, ENQ token has 10 decimal places. To send 25.005 ENQ, the amount needs to be set to 250050000000. 
        
        **Data** is used for storing additional information like smart contracts. Can be left empty. Click below to read more about it:
        
        <details>
        <summary> **click to expand**
        ### Data generation
        </summary>
        ## The coding principle of the Data field
        Enecuum basic contracts are called by transferring the contract parameters to the data field in a normal transaction. 
        Example:

        ```00920300000b0e00sum007f0f00000e0d00pos_id004807009261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9000e0d00amount0013090010000000000```

        The data field is a recursive container structure, each chunk is represented as “container length in bytes || data marker || data".

        Container Length is 4 bytes, including container length bytes.
        Data marker is 4 bytes.


        Depending on the data, the appropriate marker should be used:
   
        | data| marker|
        |---|---|
        | "key" | 0d00 |
        | "procedure_name" | 0e00|
        | "parameters" | 0f00 |
        | "string" | 0700 |
        | "int" | 0800 |
        | "bigint" | 0900 |
        | "create_pos" | 1000 |
        | "pos_reward" | 1100 |
        | "transfer" | 1200 |
        | "delegate" | 0300 |
        | "undelegate" | 0400 |
        | "mint" | 1300 |
        | "burn" | 1400 |

        The contents of the data field can be represented as the structure of nested arrays:
        ```
        [
          ["delegate", [
            ["procedure_name", "sum"],
            ["parameters", [
              ["key", "pos_id"],
              ["string", "9261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9"],
              ["key", "amount"],
              ["bigint", "10000000000"]
            ]]
          ]]
        ]
        ```

        Here is the same structure but with the length bytes and type markers:
        
        ```
        00920300
            000b0e00sum
            007f0f00
                000e0d00pos_id
                004807009261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9
                000e0d00amount
                0013090010000000000
        ```

        All elements are strings and, in result, are concatenated into one string, which goes to the data field of the transaction.

        ## JavaScript code

        JavaScript code implementation that allows encoding a JSON object of the following form

        ```
        {
            type : "contract_type",
            parameters : {
                key1 : value1,
                key2 : value2,
                key3 : value3
            }
        }
        ```

        It is strongly recommended that you fully use this code, or rewrite it to a preferred programming language.

        ```
        let schema = {
            "delegate" :        "0300",
            "undelegate" :      "0400",
            "string" :          "0700",
            "int" :             "0800",
            "bigint" :          "0900",
            "object" :          "0c00",
            "key" :             "0d00",
            "parameters" :      "0f00",
            "create_pos" :      "1000",
            "pos_reward" :      "1100",
            "transfer" :        "1200",
            "mint" :            "1300",
            "burn" :            "1400"
        };

        function toHex(d) {
            let hex = Number(d).toString(16);
            while ((hex.length % 2) !== 0) {
                hex = "0" + hex;
            }
            return hex;
        }
        function sizeMarker(size) {
            let markerSize = 0xFFFF; // Max chunk size
            if(size > markerSize)
                throw new OutOfRangeError(`Size can't be bigger than ${markerSize}`);
            let marker = toHex(size);
            while (marker.length < 4) {
                marker = "0" + marker;
            }
            return marker;
        }

        function dataFromObject(obj){
            let res = {
                parameters : []
            };
            for(let param in obj.parameters){
                let type = undefined;
                switch (typeof obj.parameters[param]){
                    case "bigint" : {
                        type = "bigint";
                        break;
                    }
                    case "string" : {
                        type = "string";
                        break;
                    }
                    default : type = "int";
                }
                //let type = (typeof obj.parameters[param] === "string") ? "string" : "int";
                res.parameters.push({key : param, [type] : obj.parameters[param]})
            }
            return serialize_object({
                [obj.type] : res
            });
        }
        function serialize_object(obj){
            let binary = "";
            if((!(Array.isArray(obj))) && (typeof obj !== "object"))
                return obj.toString();
            if(Array.isArray(obj)){
                for (let el of obj){
                    let res = serialize_object(el);
                    binary += res;
                }
            }
            else {
                for (let key in obj) {
                    let code = schema[key];
                    let res = serialize_object(obj[key]);
                    binary += sizeMarker(res.length + 8) + code + res;
                }
            }
            return binary;
        }

        //
        //  Usage
        //
        let data_create_pos = {
            type : "create_pos",
            parameters : {
                fee : 100n,
                name : "Greatest POS of all time"
            }
        };
        console.log(dataFromObject(data_create_pos));

        let data_delegate = {
            type : "delegate",
            parameters : {
                pos_id : "509a266d46c2f395ff3021f09ddb58d018e60c51ba6dd63f41f8a91a913756d8",
                amount : 1000000000000n
            }
        };
        console.log(dataFromObject(data_delegate));

        let data_undelegate = {
            type : "undelegate",
            parameters : {
                pos_id : "509a266d46c2f395ff3021f09ddb58d018e60c51ba6dd63f41f8a91a913756d8",
                amount : 50000000000n
            }
        };
        console.log(dataFromObject(data_undelegate));

        let data_transfer = {
            type : "transfer",
            parameters : {
                undelegate_id : "4c35483b12568727faa910b08bdbe2f882cc5f6ad521930343abeb89658c7282"
            }
        };
        console.log(dataFromObject(data_transfer));

        //Claim reward method.
        let data_pos_reward = {
            type : "pos_reward",
            parameters : {
                pos_id : "4c35483b12568727faa910b08bdbe2f882cc5f6ad521930343abeb89658c7282"
            }
        };

        console.log(dataFromObject(data_pos_reward));
        ```
        
        # Tokens
        
        ## mint
        
        Increase token emission. Data field parameters:
        
        ```
        {
             "type": "mint",
             "parameters": {
                 "token_hash": "token hash",
                 "amount": BigInt (10000000000000)
             }
        }
        ```
        
        token_hash - hash of the token whose total_supply will be increased
        
        amount - the number of coins added to the token's total_supply. Available range of values: 0 ... MAX_SUPPLY_LIMIT
        
        The mint contract increases the total_supply of the token by the amount of coins. In this case, coins are credited to the account of the token holder. The contract can only be executed by the owner of the token.
        
        Execution of the mint contract is available only if the reissuable = 1 parameter was specified when creating the token.
        
        ## burn
        
        Reduce token emission. Data field parameters:
        
        ```
        {
            "type": "burn",
            "parameters": {
                "token_hash": "token hash",
                "amount": BigInt (10000000000000)
            }
        }
        ```
        
        token_hash - hash of the token whose total_supply will be reduced
        
        amount - the number of coins by which the total_supply token will be reduced. Available range of values: 0 ... <number of tokens on the owner's balance>
        
        The burn contract reduces the total_supply of the token by the amount of coins. In this case, the coins are debited from the token holder's account. The contract can only be executed by the owner of the token.
        
        Execution of the burn contract is available only if the reissuable = 1 parameter was specified when creating the token.
        
        # Contracts

        Contract is a Enecuum transaction with additional data field that contains encoded contract parameters. Every contract type costs as a standard Enecuum transaction

        ## create_pos

        PoS-contract creation.
        The data field parameters:

        | Data field structure | Types |
        | ---- | ---- |
        | { | |
        |    type : "create_pos",| String, contract type |
        |    parameters : { } | |
        |        fee : 100n,| BigInt (0 - 10000) |
        |        name : “POS validator”| String (1-40 chars) |
        |    } | |
        | } |  |

        fee - hundredths of a percent from 0 to 10000. 14% will be 1400;
        name - POS-contract name

        As a result, a PoS-contract is created. It will be used in other transactions. The hash of this transaction will be used as pos_id in the parameters of other transactions.

        ## delegate

        Delegation of coins, i.e. the act of lending funds to a contract.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        |     type : "delegate",| String, contract type |
        |     parameters : { |  |
        |         pos_id : "...",| String |
        |         amount : 1000000000000n | BigInt (0 - MAX_SUPPLY_LIMIT) |
        |      } |  |
        | } |  |

        The specified amount of coins is withdrawn from the sender’s account and is recorded in the delegates table. You can repeat it many times as long as there is available balance.
        MAX_SUPPLY_LIMIT is a max possible safe integer = 2^64 - 1

        ## undelegate

        “Undelegation” of coins, i.e. the withdrawal of the lent funds.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        | type : "undelegate",| String, contract type |
        | parameters : { |  |
        |        pos_id : "...",| String |
        |        amount : 1000000000000n| BigInt (0 - MAX_SUPPLY_LIMIT) |
        |    } |  |
        | } |  |
        
        Coins are withdrawn, i.e., the specified amount of coins goes to the undelegates table from the delegates table, creating a separate heap identified by the id of the undelegate transaction.

        ## transfer

        Unlocking coins, i.e., getting undelegated funds back to balance.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        |    type : "transfer",| String, contract type |
        |    parameters : { |  |
        |         undelegate_id : "..."| String |
        |   } |  |
        | } |  |


        Coins from undelegates table are forwarded to balance.

        **Example**: delegate transaction of 100 coins was sent; then, another one was sent, of 100 coins. The balance is decreased by 200 coins.

        Then, the undelegate transactions are sent for 150, 40 and 10 coins. The hashes of these transactions are aaa, bbb, ccc.

        Now, in order to return the funds to the balance, for each undelegate transaction the transfer transaction is sent with the corresponding hash (aaa, bbb or ccc)  in the parameters. That means there will be transactions for 150, 40 and 10 coins instead of one transaction for 200 coins.

        **NB**: transfer transactions will be successful only after 10  blocks have been published after the undelegate transaction. In other cases, the transfer transactions will be rejected.

        # POS rewards

        The PoS-mining rewards are distributed among the one hundred PoS contracts that have the largest stakes, i.e., funds delegated to them. The stake sum of all PoS contracts participating in the PoS mining at a particular moment in time is called a total stake. The total reward for PoS mining is unchanged and amounts to 25% of the total emission. The amount of rewards for a particular contract is calculated as a portion of the total rewards in proportion to the contact stake in relation to total stake. The PoS-contracts rewards are calculated at the time of the macroblock publishing.

        The PoS contract reward is divided into two parts in accordance with the fee parameter specified when creating the contract. The indicated percentage of funds is retained by the creator of the contract. The remaining funds are divided between the contract delegators in proportion to the funds contributed by them.

        Rewards are accrued in arbitrary periods of time (from 1 to 3 days). When calculating rewards, the size of the user's delegated funds at the time of calculation is used.

        The accrual of rewards occurs with every block published. The reward for the PoS owner goes directly to his/her main account. The reward for the delegator goes to his/her special reward balance.
        To collect the delegator’s reward, the delegator sends the pos_reward transaction. The sender will be charged a standard system fee. 

        To find out more on reward calculation, refer to ETP-4.

        ## pos_reward

        Transfer of coins from a reward balance to the main balance.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        |    type : "pos_reward",| String, contract type |
        |    parameters : { |  |
        |        pos_id : "..."| String |
        |    } |  |
        | } |  |
        
        As a result of the transaction, the entire accumulated PoS reward of the delegator is transferred to his/her main account.
        </details>

        **Nonce** is a random number from 0 to 2^32. It is involved in a cryptographic communication.

        **Ticker** is a **token hash** which specifies what token needs to be transferred. '0000000000000000000000000000000000000000000000000000000000000000' stands for ENQ. Non-zero values mean that you deal with an asset other than Enecuum. Custom tokens have a random hexadecimal string as a token ID.

        The **signature** needs to be generated using the following JavaScript code:
        
        <details>
        <summary> **click to expand**
        ### Signature generation </summary>
        ```
        const crypto = require('crypto');
        let KeyEncoder = require('key-encoder').default;
        let keyEncoder = new KeyEncoder('secp256k1');

        function ecdsa_sign(skey, msg){
            const sign = crypto.createSign('sha256');
            try {
                let pemPrivateKey = keyEncoder.encodePrivate(skey, 'raw', 'pem');
                sign.write(msg);
                sign.end();
                return sign.sign(pemPrivateKey, 'hex');
            }
            catch(err){
                return null;
            }
        }

        let hash_tx = function(tx){
            if (!tx)
              return undefined;

            let str = ['amount','data','from','nonce','ticker','to'].map(v => crypto.createHash('sha256').update(tx[v].toString().toLowerCase()).digest('hex')).join("");
            return crypto.createHash('sha256').update(str).digest('hex');
          }

        // Note: amount is a String
        let amount = '1000000000000'; 
        let data = '';
        let nonce = 438721986634052;
        let ticker = '0000000000000000000000000000000000000000000000000000000000000000';

        let to_acc = {pubkey:''}; //Recipient's public key.
        let from_acc = {pubkey:'', 
                prvkey:''}; //Sender's public and private keys.

        let from = from_acc.pubkey;
        let to = to_acc.pubkey;    

        let tx = {from, to, amount, nonce, data, ticker};

        console.log(`from public key hash -> ${crypto.createHash('sha256').update(from.toString().toLowerCase()).digest('hex')}`);

        let hash = crypto.createHash('sha256').update(['amount','data','from','nonce','ticker','to'].map(v => crypto.createHash('sha256').update(tx[v].toString().toLowerCase()).digest('hex')).join("")).digest('hex');

        console.log(`all hash -> ${hash}`);

        tx.sign = ecdsa_sign(from_acc.prvkey, hash);

        console.log(tx);
        ``` 
        </details>
        
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  amount:
                    $ref: '#/components/schemas/Amount'
                  data:
                    $ref: '#/components/schemas/Data'
                  from:
                    $ref: '#/components/schemas/From'
                  nonce:
                    $ref: '#/components/schemas/Nonce'
                  ticker:
                    $ref: '#/components/schemas/Token' #TODO: resolve conflict (ticker/token)
                  to:
                    $ref: '#/components/schemas/To'
                  sign:
                    $ref: '#/components/schemas/Sign'
      responses:
        '200':
          description: Successfully performed transaction.
          content:
            application/json:
              schema:
                properties:
                  err:
                    type: integer
                    enum: [0,1]
                    description: 0 means the transaction was successfully processed by the node. 1 means there was a critical error.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        hash:
                          type: string
                          example: 1274fe466eba7af8e012d0d7eb3f3a1d05ce50578529ba4055ece98b96656908
                        status:
                          $ref: '#/components/schemas/Status'
              examples:
                success:
                  value:
                    err: 0
                    result:
                      - hash: 4926f30e12f4d997ae931cb862581b20f06e73dd6badd6e90c53acdf2f4a682b
                        status: 0
                error:
                  value:
                    err: 1
          
    get:
      tags: 
        - Transactions
      summary: 'Returns transaction status.'
      description: |
        Checks the status of the performed transaction. Additionally, returns the related k-block and m-block hashes. K-blocks and m-blocks are a part of the blockchain architecture. 
        
        One of the following transaction **statuses** is possible:

        - 0 means the transaction was accepted by the node and awaits further processing;
        - 1 means the transaction is a duplicate;
        - 2 means the transaction was rejected;
        - 3 means the transaction was successful.
        
        The returned **amount** is multiplied by 10^*d*, where *d* stands for the number of decimal places. For example, if the returned amount is 250050000000, the sender meant to transfer 25.005 ENQ.
      parameters: 
        - name: hash
          in: query
          required: true
          description: 'Transaction hash.'
          schema:
            $ref: '#/components/schemas/Hash'
      responses:
        '200':
            description: Successfully returned transaction status.
            content:
              application/json:
                schema:
                  properties:
                    status:
                      $ref: '#/components/schemas/Status'
                    from:
                      $ref: '#/components/schemas/From'
                    to:
                      $ref: '#/components/schemas/To'
                    amount:
                      $ref: '#/components/schemas/Amount'
                    ticker:
                      $ref: '#/components/schemas/Token' #TODO: resolve conflict (ticker/token hash)
                    data:
                      $ref: '#/components/schemas/Data'
                    hash:
                      $ref: '#/components/schemas/Hash'
                    kblocks_hash:
                      type: string 
                      description: K-block hash. K-blocks contain m-blocks.
                      example: 00f3f70e530a84a0a6943c15da6db15e3d890a582fb945fc3c2cd9aebd7ebd93
                    mblocks_hash:
                      type: string
                      description: M-block hash. M-blocks contain transactions.
                      example: a0477381285cdb1815cb7bb939baf9bd1785c76792be82d7a310818189ff9dbd

  /lasttxs:
    get:
      tags:
        - Transactions
      summary: 'Returns the information on the last 10 transactions.'
      description: 'Returns the information on the last 10 transactions.'
      responses:
        '200':
          description: 'Information about the last 10 transactions.'
          content:
            application/json:
              schema:
                type: array
                description: 'Last 10 transactions as shown on the Explorer start page.'
                items:
                  type: object
                  properties:
                    hash:
                      type: string
                      description: Transaction hash.
                      example: '0aa54540938265144271312188feef5ee2587069ac3ad52e4002fae839347e0a'
                    from:
                      type: string
                      description: Sender's public key.
                      example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
                    to: 
                      type: string
                      description: Recipient's public key.
                      example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
                    amount: 
                      $ref: '#/components/schemas/Amount'
                    mblocks_hash:
                      type: string
                      description: Microblock hash.
                      example: '2992402de0a84a960447db6c4158762494dd756bd16be31317f309ad57c6f5b2'
                    nonce:
                      $ref: '#/components/schemas/Nonce'
                    status:
                      $ref: '#/components/schemas/Status'
                    sign:
                      $ref: '#/components/schemas/Sign'
                    ticker:
                      $ref: '#/components/schemas/Token'
                    data:
                      $ref: '#/components/schemas/Data'

### Account Methods


  /account_transactions:
    get:
      tags: 
        - Accounts
      summary: 'Returns the last 10 transactions of the account with their properties.'
      description: 'Returns the last 10 transactions of the account with their properties.'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account 
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
        - name: page
          in: query
          required: true
          description: 'Page number (0 for the newest one)'
          schema:
            type: integer
            example: 0
      responses:
        '200':
            description: Successfully returned list of the last 10 transactions of the account on the specified page.
            content:
              application/json:
               schema:
                type: object
                properties:
                  balance:
                    type: string
                    description: Available balance of the account 
                    example: '948674304924701184'
                  total_stake:
                    type: string
                    description: Total amount of PoS staked tokens in the network's tokens
                    example: '96497280000000'
                  active_total_stake:
                    type: string
                    description: TO BE CLARIFIED - Active Total Stake?
                    example: '416696980000000000'
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        i:
                          type: integer
                          description: TO BE CLARIFIED - some transaction ID?
                          example: 3752194
                        hash:
                          type: string 
                          description: Transaction hash.
                          example: 'fe26b9ccff94295240c923eef89053655bfd206499b4f400d282868476dfea05'
                        time:
                          type: integer
                          description: Transaction timestamp.
                          example: 1659968280
                        rectype:
                          type: string
                          enum: [iout, iin]
                          description: Transaction direction (iout = outbound, iin = inbound) 
                          example: 'iin'
                        amount: 
                          type: integer
                          description: Amount of a transaction
                          example: 8679532757
                        data: 
                          type: string
                          description: Data field of the transaction (may be empty)
                          example: '200'
                        status:
                          type: integer
                          enum: [0, 1, 2, 3]
                          description: | 
                            Transaction status. One of the following statuses is possible:
                            - 0 - the transaction is accepted by the node, awaiting processing
                            - 1 - the transaction is a duplicate
                            - 2 - the transaction was rejected
                            - 3 - the transaction was confirmed and is successful
                          example: 3
                        token_hash:
                          type: string
                          description: Hash of the transaction's token
                          example: '0000000000000000000000000000000000000000000000000000000000000001'
                        fee_type:
                          type: integer
                          description: Fee type |
                            - 0 - flat fee for owner upon transaction in reward tokens
                            - 1 - percentage fee in reward tokens
                            - 2 - fixed fee, charged in native tokens
                          example: 0
                        fee_value:
                          type: integer
                          description: Transaction fee value in the appropriate tokens
                          example: 1000000000
                        fee_min:
                          type: integer
                          description: Minimum transaction fee (applies for percentage fees if set)
                          example: 0
                  page_count:
                    type: integer
                    description: Total page count for the account's transactions
                    example: 336734
                  id: 
                    type: string
                    description: Account ID (hash)
                    example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
  /account_rewards:
    get:
      tags: 
        - Accounts
      summary: 'Returns a page of the last 10 rewards for the account with their properties.'
      description: 'Returns a page of the last 10 rewards for the account with their properties.'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account b
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
        - name: page
          in: query
          required: true
          description: 'Page number (0 for the newest one)'
          schema:
            type: integer
            example: 0
      responses:
        '200':
            description: Successfully returned list of the last 10 rewards of the account on the specified page.
            content:
              application/json:
               schema:
                type: object
                properties:
                  balance:
                    type: string
                    description: Available balance of the account 
                    example: '948660721281328996'
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        i:
                          type: integer
                          description: TO BE CLARIFIED - some transaction ID?
                          example: 3760304
                        irew:
                          type: integer
                          description: TO BE CLARIFIED - some reward ID?
                          example: 377137
                        hash:
                          type: string 
                          description: Previous macroblock's hash.
                          example: '0000e83c0523511960445ff72cb198ebd49859163b73e2e2ddd34971662e1841'
                        time:
                          type: integer
                          description: Reward timestamp.
                          example: 1659971976
                        rectype:
                          type: string
                          enum: [idust, iref, ifg]
                          description: |
                            Reward type: ?
                            - idust - Dust - ???
                            - iref - Referral
                            - ifg - Genesis TX Fee - ? 
                          example: 'idust'
                        amount: 
                          type: integer
                          description: Amount of the reward
                          example: 205641958
                        ticker: 
                          type: string
                          description: Ticker of the reward token (network's default token if empty)
                          example: 'BIT'
                  page_count:
                    type: integer
                    description: Total page count for the account's reward records
                    example: 37715
                  id: 
                    type: string
                    description: Account ID (hash)
                    example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
  /account_in:
    get:
      tags: 
        - Accounts
      summary: 'Returns a page of 10 INCOMING WHAT? for the account with their properties.'
      description: 'Returns a page of 10 INCOMING WHAT? for the account with their properties.'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account 
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
        - name: page
          in: query
          required: true
          description: 'Page number (0 for the newest one)'
          schema:
            type: integer
            example: 0
      responses:
        '200':
            description: Successfully returned list of the last 10 rewards of the account on the specified page.
            content:
              application/json:
               schema:
                type: object
                properties:
                  balance:
                    type: string
                    description: Balance of **WHAT**?
                    example: '948654598387604223'
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        i:
                          type: integer
                          description: TO BE CLARIFIED - some ID?
                          example: 3768307
                        hash:
                          type: string 
                          description: Previous macroblock's hash (or not?).
                          example: '33b3fa98fb9c1feac77d4ed495176403209630419dbf8b90e07cc655e21f5fd0'
                        time:
                          type: integer
                          description: Timestamp.
                          example: 1659974762
                        kreward:
                          type: integer
                          description: macroblock reward? - PoW macroblock reward, published with them
                          example: null
                        sreward:
                          type: integer
                          description: statblock reward? - TO BE CLARIFIED
                          example: null
                        mreward:
                          type: integer
                          description: microblock reward? - PoA node reward
                          example: null
                        output:
                          type: string
                          description: null for account_in method??? - TO BE CLARIFIED
                          example: ''
                        input:
                          type: string
                          description: something for account_in??? - TO BE CLARIFIED
                          example: '15133177068'
                        status:
                          type: integer
                          enum: [0, 1, 2, 3]
                          description: | 
                            Transaction status - TBC? One of the following statuses is possible:
                            - 0 - the transaction is accepted by the node, awaiting processing
                            - 1 - the transaction is a duplicate
                            - 2 - the transaction was rejected
                            - 3 - the transaction was confirmed and is successful
                          example: 3
                        token_hash:
                          type: string
                          description: Hash of the transaction's token
                          example: '0000000000000000000000000000000000000000000000000000000000000001'
                        fee_type:
                          type: integer
                          description: Fee type |
                            - 0 - flat fee for owner upon transaction in reward tokens
                            - 1 - percentage fee in reward tokens
                            - 2 - fixed fee, charged in native tokens
                          example: 0
                        fee_value:
                          type: integer
                          description: Transaction fee value in the appropriate tokens
                          example: 1000000000
                        fee_min:
                          type: integer
                          description: Minimum transaction fee (applies for percentage fees if set)
                          example: 0
                        fee:
                          type: string
                          description: ??? - Minimum transaction fee (applies for percentage fees if set)
                          example: '1000000000'
                  page_count:
                    type: integer
                    description: Total page count for the account's reward records
                    example: 37715
                  id: 
                    type: string
                    description: Account ID (hash)
                    example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
  /account_out:
    get:
      tags: 
        - Accounts
      summary: 'Returns a page of 10 OUTGOING WHAT? for the account with their properties.'
      description: 'Returns a page of 10 OUTGOING WHAT? for the account with their properties.'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account 
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
        - name: page
          in: query
          required: true
          description: 'Page number (0 for the newest one)'
          schema:
            type: integer
            example: 0
      responses:
        '200':
            description: Successfully returned list of the last 10 rewards of the account on the specified page.
            content:
              application/json:
               schema:
                type: object
                properties:
                  balance:
                    type: string
                    description: Balance of **WHAT**?
                    example: '948650851276771054'
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        i:
                          type: integer
                          description: TO BE CLARIFIED - some ID?
                          example: 3768307
                        hash:
                          type: string 
                          description: Previous macroblock's hash (or not?).
                          example: '33b3fa98fb9c1feac77d4ed495176403209630419dbf8b90e07cc655e21f5fd0'
                        time:
                          type: integer
                          description: Timestamp.
                          example: 1659974762
                        kreward:
                          type: integer
                          description: macroblock reward? - TO BE CLARIFIED
                          example: null
                        sreward:
                          type: integer
                          description: statblock reward? - TO BE CLARIFIED
                          example: null
                        mreward:
                          type: integer
                          description: microblock reward? - TO BE CLARIFIED
                          example: null
                        output:
                          type: string
                          description: null for account_in method??? - TO BE CLARIFIED
                          example: '13118603717'
                        input:
                          type: string
                          description: something for account_in??? - TO BE CLARIFIED
                          example: 'null'
                        status:
                          type: integer
                          enum: [0, 1, 2, 3]
                          description: | 
                            Transaction status - TBC? One of the following statuses is possible:
                            - 0 - the transaction is accepted by the node, awaiting processing
                            - 1 - the transaction is a duplicate
                            - 2 - the transaction was rejected
                            - 3 - the transaction was confirmed and is successful
                          example: 3
                        token_hash:
                          type: string
                          description: Hash of the transaction's token
                          example: '0000000000000000000000000000000000000000000000000000000000000001'
                        fee_type:
                          type: integer
                          description: Fee type |
                            - 0 - flat fee for owner upon transaction in reward tokens
                            - 1 - percentage fee in reward tokens
                            - 2 - fixed fee, charged in native tokens
                          example: 0
                        fee_value:
                          type: integer
                          description: Transaction fee value in the appropriate tokens
                          example: 1000000000
                        fee_min:
                          type: integer
                          description: Minimum transaction fee (applies for percentage fees if set)
                          example: 0
                        fee:
                          type: string
                          description: ??? - Minimum transaction fee (applies for percentage fees if set)
                          example: '1000000000'
                  page_count:
                    type: integer
                    description: Total page count for the account's reward records
                    example: 37715
                  id: 
                    type: string
                    description: Account ID (hash)
                    example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'

  /balance_all:
    get:
      tags:
        - Accounts
      summary: 'Returns the amounts and properties of all tokens the specified account holds'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account 
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
      responses:
        '200':
          description: Properties of tokens held by the specified account.
          content:
            application/json:
              schema:
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        amount:
                          type: string
                          description: Amount of this token held by the account.
                          example: '930050205493810405'
                        token:
                          type: string 
                          description: Token hash.
                          example: '0000000000000000000000000000000000000000000000000000000000000001'
                        ticker:
                          type: string
                          description: Ticker of the token.
                          example: 'BIT'
                        decimals:
                          type: integer
                          description: Number of decimals
                          example: 10
                        minable:
                          type: integer
                          description: |
                            0 - non-mineable token
                            1 - mineable token
                          enum: [0,1]
                          example: 1
                        reissuable:
                          type: integer
                          description: |
                            0 - non-reissuable token
                            1 - reissuable token token
                          enum: [0,1]
                          example: 0
  /balance_mineable:
    get:
      tags:
        - Accounts
      summary: 'Returns the amounts and properties of all mineable tokens the specified account holds'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account 
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
      responses:
        '200':
          description: Properties of mineable tokens held by the specified account.
          content:
            application/json:
              schema:
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        amount:
                          type: string
                          description: Amount of this mineable token held by the account.
                          example: '930050205493810405'
                        token:
                          type: string 
                          description: Token hash.
                          example: '0000000000000000000000000000000000000000000000000000000000000001'
                        ticker:
                          type: string
                          description: Ticker of the token.
                          example: 'BIT'
                        decimals:
                          type: integer
                          description: Number of decimals
                          example: 10

  /balance_reissuable:
    get:
      tags:
        - Accounts
      summary: 'Returns the amounts and properties of all reissuable tokens the specified account holds'
      parameters: 
        - name: id
          in: query
          required: true
          description: Address of the account 
          schema:
            type: string
            example: '029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d'
      responses:
        '200':
          description: Properties of reissuable tokens held by the specified account.
          content:
            application/json:
              schema:
                properties:
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        amount:
                          type: integer
                          description: Amount of this reissuable token held by the account.
                          example: 100000
                        token:
                          type: string 
                          description: Token hash.
                          example: '3e45301d62c77c2bf8e96cdae1500b65ec11caaf99a046729bc12aa0c359a7c7'
                        ticker:
                          type: string
                          description: Ticker of the token.
                          example: 'LP_TKN'
                        decimals:
                          type: integer
                          description: Number of decimals
                          example: 10


### PoA

  /poa_with_stake:
    get:
      tags:
        - PoA
      summary: 'Returns the amount of accounts that have the minimum balance required for PoA'
      responses:
        '200':
          description: Amount of accounts that have the minimum balance required for PoA.
          content:
            application/json:
              schema:
                properties:
                  total:
                    type: integer
                    description: 'Amount of accounts that have the minimum balance required for PoA.'
                    example: 3249


### PoA - all methods missing!
### PoS - some methods available!
# /get_pos_names:
# /get_top_pos:
# /get_min_stake:
# /get_stake_limits: (min, max, default)
# /referrer_stake:

  /get_pos_total_stake:
    get:
        tags: 
          - PoS
        summary: 'Returns total stake of PoS nodes.'
        description: 'Returns total stake of all active PoS nodes.'
        responses:
          '200':
            description: Successfully returned total PoS stake.
            content:
              application/json:
                schema:
                  properties:
                    total_stake:
                      type: integer
                      description: Total PoS nodes stake. The amount is multiplied by 10^*d*, where *d* stands for the number of decimal places.
                      example: 13020000000000
                  
#  /get_pos_active_total_stake:

  /get_pos_list_count:
    get:
      tags: 
        - PoS
      summary: 'Returns the number of PoS contracts.'
      description: 'Returns the total number of PoS contracts.'
      responses:
        '200':
          description: Successfully returned PoS contract number.
          content:
            application/json:
              schema:
                properties:
                  count:
                    type: integer
                    description: The number of PoS contracts.
                    example: 14
                  
  /get_pos_list:
    get:
      tags: 
        - PoS
      summary: 'Returns PoS contracts of the specific node.'
      description: 'Returns a list of PoS contracts of the specified contract owner.'
      parameters: 
        - name: owner
          in: query
          required: true
          description: Contract owner public key. 
          schema:
            $ref: '#/components/schemas/Owner'
      responses:
        '200':
          description: Successfully returned PoS contract list.
          content:
            application/json:
             schema:
              type: array
              items:
                type: object
                properties:
                  rank:
                    type: integer
                    description: PoS contract rating number. The higher stake power gets the higher rank.
                    example: 1
                  pos_id:
                    $ref: '#/components/schemas/PosID'
                  owner:
                    $ref: '#/components/schemas/Owner'
                  fee:
                    $ref: '#/components/schemas/Fee'
                  stake:
                    $ref: '#/components/schemas/Stake'
                  name:
                    type: string
                    description: Contract name.
                    example: Test
  /get_pos_list_all:
    get:
      tags: 
        - PoS
      summary: 'Returns all PoS contracts.'
      description: 'Returns all PoS contracts.'
      responses:
        '200':
          description: Successfully returned PoS contract list.
          content:
            application/json:
               schema:
                type: object
                properties:
                  daily_pos_reward:
                    type: string
                    description: Total daily PoS reward amount
                    example: '96497280000000'
                  total_stake:
                    type: string
                    description: Total amount of PoS staked tokens in the network's tokens
                    example: '96497280000000'
                  active_total_stake:
                    type: string
                    description: TO BE CLARIFIED - Active Total Stake?
                    example: '416696980000000000'
                  effective_total_stake:
                    type: string
                    description: TO BE CLARIFIED - Effective Total Stake?
                    example: '416696980000000000'
                  pos_contracts:
                    type: array
                    items:
                      type: object
                      properties:
                        rank:
                          type: integer
                          description: PoS contract rating number. As stake power increases, so does the rank.
                          example: 1
                        active:
                          type: integer
                          enum: [0,1]
                          description: 0 means node is inactive. 1 means node is active. PoS node is considered active if it has generated at least 1 s-block for the last 100 blocks.
                          example: 1
                        pos_id:
                          $ref: '#/components/schemas/PosID'
                        owner:
                          $ref: '#/components/schemas/Owner'
                        fee:
                          $ref: '#/components/schemas/Fee'
                        stake:
                          $ref: '#/components/schemas/Stake'
                        stake_power:
                          $ref: '#/components/schemas/StakePower'
                        active_stake_power:
                          type: integer
                          description: Contract stake to active PoS stake ratio.
                          example: 1
                        roi:
                          type: integer
                          description: Return on investment. Measures the gain generated on an investment relative to the amount of coins delegated.
                          example: 7519
                        active_stake_share:
                          type: integer
                          description: |
                            Used for inactive nodes. Formula: stake / (active_total_stake + stake)
                          example: 0
                        uptime:
                          type: integer
                          description: Node performance. Measures system reliability, expressed as the percentage of time a node has been working.
                          example: 1
                  
  /get_delegators_list:
    get:
      tags: 
        - PoS
      summary: 'Returns a list of contract delegators.'
      description: 'Returns a list of contract delegators.'
      parameters: 
        - name: pos_id
          in: query
          required: true
          description: Transaction hash of PoS contract creation. 
          schema:
            $ref: '#/components/schemas/PosID'
      responses:
        '200':
          description: Successfully returned contract delegator list.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    pos_id:
                      $ref: '#/components/schemas/PosID'
                    delegator:
                      type: string
                      description: Delegator public key.
                      example: 0242d441a4b35d190d6b75a64e070bec4bc671d20f3ac10259106b93b3766c5593
                    amount:
                      type: integer
                      description: The total number of delegated coins. The amount is multiplied by 10^*d*, where *d* stands for the number of decimal places. 
                      example: 10000000000
                    reward:
                      type: integer
                      description: The number of earned coins. #TODO: elaborate
                      example: 0

                  
  /get_pos_list_page:
    get:
      deprecated: true #OR IS IT DEPRECATED?
      tags: 
        - PoS
      summary: 'Returns a detailed PoS contract list.'
      description: 'Returns a list of 20 PoS contracts with detailed information about them. The increment of the *page* parameter skips to the next list 20 PoS contracts. The contracts are sorted by the stake power, i.e., the contract stake to total stake ratio. The returned *page_count* shows the page number as if it appeared on a web site.'
      parameters: 
        - name: page
          in: query
          required: true
          description: Page number. Starts with 0.
          schema:
            type: integer
            example: 0
      responses:
        '200':
          description: Successfully returned a list of PoS contracts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  pos_contracts:
                    type: array
                    items:
                      type: object
                      properties:
                        rank:
                          type: integer
                          description: PoS contract rating number. The higher stake power gets the higher rank.
                          example: 1
                        pos_id:
                          $ref: '#/components/schemas/PosID'
                        owner:
                          $ref: '#/components/schemas/Owner'
                        fee:
                          $ref: '#/components/schemas/Fee'
                        stake:
                          $ref: '#/components/schemas/Stake'
                        stake_power:
                          $ref: '#/components/schemas/StakePower'
                  page_count:
                    type: integer
                    description: Page number. Starts with 1.
                    example: 1

# BIT Explorer API description starts here

# WARNING!
#
# Node API and Explorer API have a number of endpoints with identical names that invalidate the description.
# Worse still, these "namesake" endpoints sometimes have the same argument but yield quite different output
# These endpoints are: 
# - /macroblock
# - /macroblock_by_height
# - /mblock
# - /sblock
# - /balance
# - /token_info
# - /tx
# - /get_tokens_by_owner (NOTE: described for Explorer but commented out underneath)
# - /get_pos_total_stake
# - /get_pos_list_count
# - /get_pos_list
# - /get_pos_list_all
# - /get_delegators_list
# - /get_transfer_lock

# BIT Explorer "unique" endpoints start here 

  # This is BIT Explorer /get_transfer_lock, invalidates YAML. Swagger allows only one API endpoint is allowed in a single YAML.
  
#  /get_transfer_lock:
#    get:
#      tags: 
#        - BitExplorer
#      summary: 'Returns transfer lock value for the network'
#      responses:
#        '200':
#          description: 'The number of blocks required to be created on the network before the undelegation request can be satisfi.'
#          content:
#            application/json:
#              schema:
#                properties:
#                  transfer_lock:
#                    type: integer
#                    description: 'Transfer lock value.'
#                    example: 5
  # This is BIT Explorer /token_info, invalidates YAML. Only one API endpoint is allowed in a single YAML.
#  /token_info:
#    get:
#      tags: 
#        - BitExplorer
#      summary: 'Returns token info by hash.'
#      parameters:
#        - in: query
#          name: hash
#          required: true
#          description: 'Token hash.'
#          schema:
#            type: string
#      responses:
#        '200':
#          description: Token info.
#          content:
#            application/json:
#              schema:
#                properties: 
#                  hash: 
#                    type: string
#                    description: Token hash
#                    example: 0000000000000000000000000000000000000000000000000000000000000001
#                  owner:
#                    type: string
#                    description: Address of the account that created the token
#                    example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
#                  fee_type:
#                    type: integer
#                    description: Fee type (see comment below, TO BE CLARIFIED - see comment below)
#                    # 0 - flat fee for owner upon transaction in reward tokens, 1 - percent fee in reward tokens, 2 - native fee, fixed, charged in native tokens)
#                   example: 0
#                  fee_value:
#                    type: integer
#                    description: Fee value
#                    example: 1000000000
#                  fee_min:
#                    type: integer
#                    description: Minimal fee
#                    example: 1000000000
#                  ticker:
#                        type: string
#                        description: Token ticker
#                        example: BIT
#                  decimals:
#                    type: integer
#                    description: Number of decimal places
#                    example: 10
#                  total_supply:
#                    type: string
#                    description: Total supply of the token
#                    example: 2455559059822244864
#                  caption:
#                    type: string
#                    description: Long token name
#                    example: Enecuum Testnet BIT
#                  active:
#                    type: integer
#                    description: TO BE EXPLAINED
#                    # has something to do with mining slots?
#                    example: 0
#                  reissuable:
#                    type: integer
#                    description: Indicates whether the token is reissuable (can be minted and burned)
#                    example: 0
#                  minable:
#                    type: integer
#                    description: Indicates whether a token can be mined
#                    example: 1
#                  max_supply:
#                    type: integer
#                    description: Maximum token supply
#                    example: 3500000000000000000
#                  block_reward:
#                    type: integer
#                    description: Reward for the mining of a block
#                    example: 30460000000
#                  min_stake:
#                    type: integer
#                    description: Minimal stake for a PoA node
#                    example: 250000000000
#                  referrer_stake:
#                    type: integer
#                    description: TO BE EXPLAINED
#                    example: 10000000000000
#                  ref_share:
#                    type: integer
#                    description: TO BE EXPLAINED
#                    example: 2574
#                  txs_count:
#                    type: integer
#                    description: (TO BE CLARIFIED) Amount of transactions with this token
#                    example: 6406044
#                  cg_price_usd:
#                    type: integer
#                    description: CoinGecko price of the token in USD (TO BE CLARIFIED)
#                    example: 0.03952753
#                  dex_price_usd:
#                    type: integer
#                    description: Price of the token on pour DEX (ENEX? TO BE CLARIFIED)
#                    example: 0.03952753
#                  price_raw:
#                    type: object
#                    description: another ("raw", without decimal point) representation of cg_price_usd and dex_price_usd
#                    properties:
#                      cg_price:
#                        type: integer
#                        description: CoinGecko price, different representation
#                        example: 395275300
#                      dex_price:
#                        type: integer
#                        description: Our DEX price, different representation
#                        example: 395275300
#                      decimals:
#                        type: integer
#                        description: Number of decimal places
#                        example: 10


# \sblock:
#    get:
#    summary: 'Returns the properties of a sblock'
#    parameters:
#    - in: query
#      name: hash
#      schema:
#        type: string
#      required: true
#      description: 'Sblock hash'
#      example: 'de0942b3b1194cde66ba9bf45bd1bdf406e714d6d514b8c0e6fd58b5ee833693'
#      responses: 
#        '200':
3          description: 'Properties of the sblock'
#          content:
#            application/json:
#              schema:
#                properties:
#                  header:
#                    type: object
#                    description: Sblock header
#                    properties:
#                      kblocks_hash:
#                        type: string
#                        description: Kblock hash
#                        example: '395275300'
#                      publisher:
#                        type: string
#                        description: Publisher wallet hash
#                        example: '395275300'
#                      sblocks_hash:
#                        type: string
#                        description: Sblock hash
#                        example: '8a643dc237d86c948bbed5b9bc6f22366d2be54df7722bbddafbe6597b37db84'
#                      reward: 
#                        type: integer 
#                      description: Reward (TO BE CLARIFIED) 
##                        example: 16753000000        

#  \sblock:
#    get:
#      summary: 'Returns the properties of a sblock'
#      parameters:
#       - in: query
#      name: hash
#      schema: 
#        type: string
#        required: true
#        description: 'Sblock hash'
#        example: 'de0942b3b1194cde66ba9bf45bd1bdf406e714d6d514b8c0e6fd58b5ee833693'
#      responses:
#        '200':
#         description: 'Properties of the sblock'
#          content:
#            application/json:
#              schema:
#                properties:
#                  header:
#                    type: object
#                    description: Sblock header
#                      properties:
#                      kblocks_hash:
#                        type: string
##                        description: Kblock hash
#                        example: '395275300'
#                      publisher:
#                        type: string
#                        description: Publisher wallet hash
#                        example: '395275300'
#                      sblocks_hash:
#                        type: string
#                        description: Sblock hash
#                        example: '8a643dc237d86c948bbed5b9bc6f22366d2be54df7722bbddafbe6597b37db84'
#                      reward: 
#                        type: integer 
#                        description: Reward (TO BE CLARIFIED) 
#                        example: 16753000000
                        
# All Schema definitions below are from the old Enecuum NodeAPI definition. As of now, they are used inconsistently throughout the document.

components:
  schemas:
    Status:
      type: integer
      description: |
        One of the following transaction statuses is possible:
        - 0 means the transaction was accepted by the node and awaits further processing;
        - 1 means the transaction is a duplicate;
        - 2 means the transaction was rejected;
        - 3 means the transaction was successful.
      enum: [0,1,2,3]
      example: 3
      
    Amount:
      type: string
      description: Token amount multiplied by 10^*d*, where *d* stands for the number of decimal places. ENQ token has 10 decimals. 
      example: "3235065616839973400"
        
    To:
      type: string
      description: Recipient's public key.
      example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
      
    From:
      type: string
      description: Sender's public key.
      example: 034b4875bf08ffd5a4f0b06c21f951aa3e2f979d2d9f1bb4a64e0600eac2350beb
      
    Data:
      type: string
      description: |
        Used for storing additional info like smart contract. Can be left empty.
              
        # Data field generation
              
        ## The coding principle of the Data field
        Enecuum basic contracts are called by transferring the contract parameters to the data field in a normal transaction. 
        Example:

        ```00920300000b0e00sum007f0f00000e0d00pos_id004807009261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9000e0d00amount0013090010000000000```

        The data field is a recursive container structure, each chunk is represented as “container length in bytes || data marker || data".

        Container Length is 4 bytes, including container length bytes.
        Data marker is 4 bytes.


        Depending on the data, the appropriate marker should be used:
   
        | data| marker|
        |---|---|
        | "key" | 0d00 |
        | "procedure_name" | 0e00|
        | "parameters" | 0f00 |
        | "string" | 0700 |
        | "int" | 0800 |
        | "bigint" | 0900 |
        | "create_pos" | 1000 |
        | "pos_reward" | 1100 |
        | "transfer" | 1200 |
        | "delegate" | 0300 |
        | "undelegate" | 0400 |
        | "mint" | 1300 |
        | "burn" | 1400 |

        The contents of the data field can be represented as the structure of nested arrays:
        ```
        [
          ["delegate", [
            ["procedure_name", "sum"],
            ["parameters", [
              ["key", "pos_id"],
              ["string", "9261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9"],
              ["key", "amount"],
              ["bigint", "10000000000"]
            ]]
          ]]
        ]
        ```

        Here is the same structure but with the length bytes and type markers:

        00920300
            000b0e00sum
            007f0f00
                000e0d00pos_id
                004807009261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9
                000e0d00amount
                0013090010000000000

        All elements are strings and, in result, are concatenated into one string, which goes to the data field of the transaction.

        ## JavaScript code

        JavaScript code implementation that allows encoding a JSON object of the following form

        ```
        {
            type : "contract_type",
            parameters : {
                key1 : value1,
                key2 : value2,
                key3 : value3
            }
        }
        ```

        It is strongly recommended that you fully use this code, or rewrite it to a preferred programming language.

        ```
        let schema = {
            "delegate" :        "0300",
            "undelegate" :      "0400",
            "string" :          "0700",
            "int" :             "0800",
            "bigint" :          "0900",
            "object" :          "0c00",
            "key" :             "0d00",
            "parameters" :      "0f00",
            "create_pos" :      "1000",
            "pos_reward" :      "1100",
            "transfer" :        "1200"
        };

        function toHex(d) {
            let hex = Number(d).toString(16);
            while ((hex.length % 2) !== 0) {
                hex = "0" + hex;
            }
            return hex;
        }
        function sizeMarker(size) {
            let markerSize = 0xFFFF; // Max chunk size
            if(size > markerSize)
                throw new OutOfRangeError(`Size can't be bigger than ${markerSize}`);
            let marker = toHex(size);
            while (marker.length < 4) {
                marker = "0" + marker;
            }
            return marker;
        }

        function dataFromObject(obj){
            let res = {
                parameters : []
            };
            for(let param in obj.parameters){
                let type = undefined;
                switch (typeof obj.parameters[param]){
                    case "bigint" : {
                        type = "bigint";
                        break;
                    }
                    case "string" : {
                        type = "string";
                        break;
                    }
                    default : type = "int";
                }
                //let type = (typeof obj.parameters[param] === "string") ? "string" : "int";
                res.parameters.push({key : param, [type] : obj.parameters[param]})
            }
            return serialize_object({
                [obj.type] : res
            });
        }
        function serialize_object(obj){
            let binary = "";
            if((!(Array.isArray(obj))) && (typeof obj !== "object"))
                return obj.toString();
            if(Array.isArray(obj)){
                for (let el of obj){
                    let res = serialize_object(el);
                    binary += res;
                }
            }
            else {
                for (let key in obj) {
                    let code = schema[key];
                    let res = serialize_object(obj[key]);
                    binary += sizeMarker(res.length + 8) + code + res;
                }
            }
            return binary;
        }

        //
        //  Usage
        //
        let data_create_pos = {
            type : "create_pos",
            parameters : {
                fee : 100n,
                name : "Greatest POS of all time"
            }
        };
        console.log(dataFromObject(data_create_pos));

        let data_delegate = {
            type : "delegate",
            parameters : {
                pos_id : "509a266d46c2f395ff3021f09ddb58d018e60c51ba6dd63f41f8a91a913756d8",
                amount : 1000000000000n
            }
        };
        console.log(dataFromObject(data_delegate));

        let data_undelegate = {
            type : "undelegate",
            parameters : {
                pos_id : "509a266d46c2f395ff3021f09ddb58d018e60c51ba6dd63f41f8a91a913756d8",
                amount : 50000000000n
            }
        };
        console.log(dataFromObject(data_undelegate));

        let data_transfer = {
            type : "transfer",
            parameters : {
                undelegate_id : "4c35483b12568727faa910b08bdbe2f882cc5f6ad521930343abeb89658c7282"
            }
        };
        console.log(dataFromObject(data_transfer));

        //Claim reward method.
        let data_pos_reward = {
            type : "pos_reward",
            parameters : {
                pos_id : "4c35483b12568727faa910b08bdbe2f882cc5f6ad521930343abeb89658c7282"
            }
        };

        console.log(dataFromObject(data_pos_reward));
        ```
        
        # Tokens
        
        ## mint
        
        Increase token emission. Data field parameters:
        
        ```
        {
             "type": "mint",
             "parameters": {
                 "token_hash": "token hash",
                 "amount": BigInt (10000000000000)
             }
        }
        ```
        
        token_hash - hash of the token whose total_supply will be increased
        
        amount - the number of coins added to the token's total_supply. Available range of values: 0 ... MAX_SUPPLY_LIMIT
        
        The mint contract increases the total_supply of the token by the amount of coins. In this case, coins are credited to the account of the token holder. The contract can only be executed by the owner of the token.
        
        Execution of the mint contract is available only if the reissuable = 1 parameter was specified when creating the token.
        
        ## burn
        
        Reduce token emission. Data field parameters:
        
        ```
        {
            "type": "burn",
            "parameters": {
                "token_hash": "token hash",
                "amount": BigInt (10000000000000)
            }
        }
        ```
        
        token_hash - hash of the token whose total_supply will be reduced
        
        amount - the number of coins by which the total_supply token will be reduced. Available range of values: 0 ... <number of tokens on the owner's balance>
        
        The burn contract reduces the total_supply of the token by the amount of coins. In this case, the coins are debited from the token holder's account. The contract can only be executed by the owner of the token.
        
        Execution of the burn contract is available only if the reissuable = 1 parameter was specified when creating the token.
        
        # Contracts

        Contract is a Enecuum transaction with additional data field that contains encoded contract parameters. Every contract type costs as a standard Enecuum transaction

        ## create_pos

        PoS-contract creation.
        The data field parameters:

        | Data field structure | Types |
        | ---- | ---- |
        | { | |
        |    type : "create_pos",| String, contract type |
        |    parameters : { } | |
        |        fee : 100n,| BigInt (0 - 10000) |
        |        name : “POS validator”| String (1-40 chars) |
        |    } | |
        | } |  |

        fee - hundredths of a percent from 0 to 10000. 14% will be 1400;
        name - POS-contract name

        As a result, a PoS-contract is created. It will be used in other transactions. The hash of this transaction will be used as pos_id in the parameters of other transactions.

        ## delegate

        Delegation of coins, i.e. the act of lending funds to a contract.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        |     type : "delegate",| String, contract type |
        |     parameters : { |  |
        |         pos_id : "...",| String |
        |         amount : 1000000000000n | BigInt (0 - MAX_SUPPLY_LIMIT) |
        |      } |  |
        | } |  |

        The specified amount of coins is withdrawn from the sender’s account and is recorded in the delegates table. You can repeat it many times as long as there is available balance.
        MAX_SUPPLY_LIMIT is a max possible safe integer = 2^64 - 1

        ## undelegate

        “Undelegation” of coins, i.e. the withdrawal of the lent funds.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        | type : "undelegate",| String, contract type |
        | parameters : { |  |
        |        pos_id : "...",| String |
        |        amount : 1000000000000n| BigInt (0 - MAX_SUPPLY_LIMIT) |
        |    } |  |
        | } |  |
        
        Coins are withdrawn, i.e., the specified amount of coins goes to the undelegates table from the delegates table, creating a separate heap identified by the id of the undelegate transaction.

        ## transfer

        Unlocking coins, i.e., getting undelegated funds back to balance.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        |    type : "transfer",| String, contract type |
        |    parameters : { |  |
        |         undelegate_id : "..."| String |
        |   } |  |
        | } |  |


        Coins from undelegates table are forwarded to balance.

        **Example**: delegate transaction of 100 coins was sent; then, another one was sent, of 100 coins. The balance is decreased by 200 coins.

        Then, the undelegate transactions are sent for 150, 40 and 10 coins. The hashes of these transactions are aaa, bbb, ccc.

        Now, in order to return the funds to the balance, for each undelegate transaction the transfer transaction is sent with the corresponding hash (aaa, bbb or ccc)  in the parameters. That means there will be transactions for 150, 40 and 10 coins instead of one transaction for 200 coins.

        **NB**: transfer transactions will be successful only after 10  blocks have been published after the undelegate transaction. In other cases, the transfer transactions will be rejected.

        # POS rewards

        The PoS-mining rewards are distributed among the one hundred PoS contracts that have the largest stakes, i.e., funds delegated to them. The stake sum of all PoS contracts participating in the PoS mining at a particular moment in time is called a total stake. The total reward for PoS mining is unchanged and amounts to 25% of the total emission. The amount of rewards for a particular contract is calculated as a portion of the total rewards in proportion to the contact stake in relation to total stake. The PoS-contracts rewards are calculated at the time of the macroblock publishing.

        The PoS contract reward is divided into two parts in accordance with the fee parameter specified when creating the contract. The indicated percentage of funds is retained by the creator of the contract. The remaining funds are divided between the contract delegators in proportion to the funds contributed by them.

        Rewards are accrued in arbitrary periods of time (from 1 to 3 days). When calculating rewards, the size of the user's delegated funds at the time of calculation is used.

        The accrual of rewards occurs with every block published. The reward for the PoS owner goes directly to his/her main account. The reward for the delegator goes to his/her special reward balance.
        To collect the delegator’s reward, the delegator sends the pos_reward transaction. The sender will be charged a standard system fee. 

        To find out more on reward calculation, refer to ETP-4.

        ## pos_reward

        Transfer of coins from a reward balance to the main balance.
        Parameters of the data field:

        | Data field structure| Types |
        | ---- | ---- |
        | { |  |
        |    type : "pos_reward",| String, contract type |
        |    parameters : { |  |
        |        pos_id : "..."| String |
        |    } |  |
        | } |  |
        
        As a result of the transaction, the entire accumulated PoS reward of the delegator is transferred to his/her main account.

      example: 00920300000b0e00sum007f0f00000e0d00pos_id004807009261818a5c05bf603199e5802f74925ffc0faa8f03742cbd952d403ce5d70cb9000e0d00amount0013090010000000000
      
    Token:
      type: string
      description: Token hash.
      example: "0000000000000000000000000000000000000000000000000000000000000000"
      
    Ticker:
      type: string
      description: An upper-case 1-6 letter token ticker.
      example: TTMNG
      
    Hash:
      type: string
      description: Transaction or block SHA256 hash.
      example: de0942b3b1194cde66ba9bf45bd1bdf406e714d6d514b8c0e6fd58b5ee833693
    
    Decimals:
      type: integer
      description: The number of decimal places.
      example: 10
      
    PosID:
      type: string
      description: Transaction hash of PoS contract creation.
      example: d8dac599c09429abd8f394ee2ef1465677d1e8b52e1f5f2bfd68125c8639e6ad
    Owner:
      type: string
      description: Public key of the PoS contract or token creator.
      example: 029dd222eeddd5c3340e8d46ae0a22e2c8e301bfee4903bcf8c899766c8ceb3a7d
    Fee:
      type: integer
      description: PoS contract fee.
      example: 100
    Stake:
      type: integer
      description: The total number of assets stored on the contract.
      example: 9960000000000
    StakePower:
      type: integer
      description: Contract stake to total stake (all active and inactive PoS nodes stake) ratio. The contracts are sorted by this ratio.
      example: 0.73668639
    Nonce:
      type: integer
      description: Random number from 0 to 2^32.
      example: 6456230090
    Height:
      type: integer
      description: Blockchain height, i.e., total number of blocks.
      example: 105678
    Sign:
      type: string
      description: |
                      The transaction signature.  The signature needs to be generated using the following JavaScript code:
                      
                      ```
                      const crypto = require('crypto');
                      let KeyEncoder = require('key-encoder').default;
                      let keyEncoder = new KeyEncoder('secp256k1');
              
                      function ecdsa_sign(skey, msg){
                          const sign = crypto.createSign('sha256');
                          try {
                              let pemPrivateKey = keyEncoder.encodePrivate(skey, 'raw', 'pem');
                              sign.write(msg);
                              sign.end();
                              return sign.sign(pemPrivateKey, 'hex');
                          }
                          catch(err){
                              return null;
                          }
                      }
              
                      let hash_tx = function(tx){
                          if (!tx)
                            return undefined;
              
                          let str = ['amount','data','from','nonce','ticker','to'].map(v => crypto.createHash('sha256').update(tx[v].toString().toLowerCase()).digest('hex')).join("");
                          return crypto.createHash('sha256').update(str).digest('hex');
                        }
              
                      // Note: amount is a String
                      let amount = '1000000000000'; 
                      let data = '';
                      let nonce = 438721986634052;
                      let ticker = '0000000000000000000000000000000000000000000000000000000000000000';
              
                      let to_acc = {pubkey:''}; //Recipient's public key.
                      let from_acc = {pubkey:'', 
                              prvkey:''}; //Sender's public and private keys.
              
                      let from = from_acc.pubkey;
                      let to = to_acc.pubkey;    
              
                      let tx = {from, to, amount, nonce, data, ticker};
              
                      console.log(`from public key hash -> ${crypto.createHash('sha256').update(from.toString().toLowerCase()).digest('hex')}`);
              
                      let hash = crypto.createHash('sha256').update(['amount','data','from','nonce','ticker','to'].map(v => crypto.createHash('sha256').update(tx[v].toString().toLowerCase()).digest('hex')).join("")).digest('hex');
              
                      console.log(`all hash -> ${hash}`);
              
                      tx.sign = ecdsa_sign(from_acc.prvkey, hash);
              
                      console.log(tx);
                      ``` 
      example: 3046022100e1d8caa60812c23b5f56ce036c5577ac2f8d34c1d20489fd53f62b02fcd65d840221008b0cdb15ebc76035eba9ad679c3b9bcf0c55f8d6e1b786b6ebe35cc8ee69f402
    ReferrerStake:
      type: integer
      description: PoA node stake required to participate in the referral program as an agent (referrer). More in the [documentation](https://guides.enecuum.com/enq/referral.html). The returned value is multiplied by 10^10.
      example: 10000000000000
    MinStake:
      type: integer
      description: Minimum stake required for PoA mining.
      example: 250000000000
    Reissuable:
      type: integer
      description:  1 means the token has flexible supply, i.e., after tokens release, its supply can be changed by issuing or burning of coins. 0 means the token's supply can't be changed. 
      example: 0
      enum: [0,1]
    Minable:
      type: integer
      description: 1 means the token can be mined. Some volume is selected for instant release (pre-mine), and the rest is mined by users. 0 means the token can't be mined.
      example: 1
      enum: [0,1]
      
# SwaggerHub warned the definition was declared but never used, so I commented it away

#    Schema:
#      type: object
#      properties:
#        id:
#          type: integer
#          format: int64
      
tags:
#  - name: General
#  - name: Token
#  - name: PoS
#  - name: BitExplorer
# new token names
  - name: Network
  - name: Token
  - name: Block
  - name: Account
  - name: Balance
  - name: Transactions
  - name: PoA
  - name: PoS
  - name: Delegation
  - name: DEX
  - name: Coindata
#    externalDocs:
#      url: https://guides.enecuum.com/how-to-pos.html


## SOMETHING TO BE CLARIFIED LATER

#  /ext/plain/circ_supply:
#    get:
#      tags:
#        - Network
#      summary: '???'
#      description: '???'
#      responses:
#          '200':
#            description: '???'
##            content:
#              application/json:
#                schema:
#                  properties:
#                    type: number
#                    description: '???'
#                    example: 245770310.8780264448