Variable $IndexResponseConst

$IndexResponse: {
    description: "The struct holding all data returned to the client by the\n index endpoint (i.e., GET \"/\"). Only for responding in JSON";
    properties: {
        block_height: {
            isRequired: true;
            type: "U64";
        };
        chain_id: {
            description: "Chain ID of the current chain";
            format: "uint8";
            isRequired: true;
            type: "number";
        };
        epoch: {
            isRequired: true;
            type: "U64";
        };
        git_hash: {
            description: "Git hash of the build of the API endpoint. Can be used to determine the exact\n software version used by the API endpoint.";
            type: "string";
        };
        ledger_timestamp: {
            isRequired: true;
            type: "U64";
        };
        ledger_version: {
            isRequired: true;
            type: "U64";
        };
        node_role: {
            isRequired: true;
            type: "RoleType";
        };
        oldest_block_height: {
            isRequired: true;
            type: "U64";
        };
        oldest_ledger_version: {
            isRequired: true;
            type: "U64";
        };
    };
} = ...

Type declaration

  • description: "The struct holding all data returned to the client by the\n index endpoint (i.e., GET \"/\"). Only for responding in JSON"
  • properties: {
        block_height: {
            isRequired: true;
            type: "U64";
        };
        chain_id: {
            description: "Chain ID of the current chain";
            format: "uint8";
            isRequired: true;
            type: "number";
        };
        epoch: {
            isRequired: true;
            type: "U64";
        };
        git_hash: {
            description: "Git hash of the build of the API endpoint. Can be used to determine the exact\n software version used by the API endpoint.";
            type: "string";
        };
        ledger_timestamp: {
            isRequired: true;
            type: "U64";
        };
        ledger_version: {
            isRequired: true;
            type: "U64";
        };
        node_role: {
            isRequired: true;
            type: "RoleType";
        };
        oldest_block_height: {
            isRequired: true;
            type: "U64";
        };
        oldest_ledger_version: {
            isRequired: true;
            type: "U64";
        };
    }
    • block_height: {
          isRequired: true;
          type: "U64";
      }
      • isRequired: true
      • type: "U64"
    • chain_id: {
          description: "Chain ID of the current chain";
          format: "uint8";
          isRequired: true;
          type: "number";
      }
      • description: "Chain ID of the current chain"
      • format: "uint8"
      • isRequired: true
      • type: "number"
    • epoch: {
          isRequired: true;
          type: "U64";
      }
      • isRequired: true
      • type: "U64"
    • git_hash: {
          description: "Git hash of the build of the API endpoint. Can be used to determine the exact\n software version used by the API endpoint.";
          type: "string";
      }
      • description: "Git hash of the build of the API endpoint. Can be used to determine the exact\n software version used by the API endpoint."
      • type: "string"
    • ledger_timestamp: {
          isRequired: true;
          type: "U64";
      }
      • isRequired: true
      • type: "U64"
    • ledger_version: {
          isRequired: true;
          type: "U64";
      }
      • isRequired: true
      • type: "U64"
    • node_role: {
          isRequired: true;
          type: "RoleType";
      }
      • isRequired: true
      • type: "RoleType"
    • oldest_block_height: {
          isRequired: true;
          type: "U64";
      }
      • isRequired: true
      • type: "U64"
    • oldest_ledger_version: {
          isRequired: true;
          type: "U64";
      }
      • isRequired: true
      • type: "U64"

Generated using TypeDoc