@nemtus/symbol-rest-api-client-fetch 1.0.0

package/esm/api/models/ServerInfoDTO.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ServerDTOFromJSON, ServerDTOToJSON, } from './ServerDTO';
+/**
+ * Check if a given object implements the ServerInfoDTO interface.
+ */
+export function instanceOfServerInfoDTO(value) {
+    if (!('serverInfo' in value) || value['serverInfo'] === undefined)
+        return false;
+    return true;
+}
+export function ServerInfoDTOFromJSON(json) {
+    return ServerInfoDTOFromJSONTyped(json, false);
+}
+export function ServerInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'serverInfo': ServerDTOFromJSON(json['serverInfo']),
+    };
+}
+export function ServerInfoDTOToJSON(json) {
+    return ServerInfoDTOToJSONTyped(json, false);
+}
+export function ServerInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'serverInfo': ServerDTOToJSON(value['serverInfo']),
+    };
+}

package/esm/api/models/SizePrefixedEntityDTO.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Size-prefixed entity base. Adds the `size` field indicating the total byte length
+ * of the serialized entity. Used by BlockDTO and TransactionDTO.
+ * In Symbol's binary format, entities are prefixed with their size for efficient parsing.
+ *
+ * @export
+ * @interface SizePrefixedEntityDTO
+ */
+export interface SizePrefixedEntityDTO {
+    /**
+     * Unsigned 32-bit integer.
+     * Represented as integer since it fits in JSON number precision.
+     *
+     * @type {number}
+     * @memberof SizePrefixedEntityDTO
+     */
+    size: number;
+}
+/**
+ * Check if a given object implements the SizePrefixedEntityDTO interface.
+ */
+export declare function instanceOfSizePrefixedEntityDTO(value: Record<string, any>): value is SizePrefixedEntityDTO;
+export declare function SizePrefixedEntityDTOFromJSON(json: any): SizePrefixedEntityDTO;
+export declare function SizePrefixedEntityDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): SizePrefixedEntityDTO;
+export declare function SizePrefixedEntityDTOToJSON(json: any): SizePrefixedEntityDTO;
+export declare function SizePrefixedEntityDTOToJSONTyped(value?: SizePrefixedEntityDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SizePrefixedEntityDTO.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SizePrefixedEntityDTO interface.
+ */
+export function instanceOfSizePrefixedEntityDTO(value) {
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    return true;
+}
+export function SizePrefixedEntityDTOFromJSON(json) {
+    return SizePrefixedEntityDTOFromJSONTyped(json, false);
+}
+export function SizePrefixedEntityDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'size': json['size'],
+    };
+}
+export function SizePrefixedEntityDTOToJSON(json) {
+    return SizePrefixedEntityDTOToJSONTyped(json, false);
+}
+export function SizePrefixedEntityDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'size': value['size'],
+    };
+}

package/esm/api/models/SourceDTO.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Identifies the transaction source that produced the receipt or resolution entry.
+ * @export
+ * @interface SourceDTO
+ */
+export interface SourceDTO {
+    /**
+     * Unsigned 32-bit integer.
+     * Represented as integer since it fits in JSON number precision.
+     *
+     * @type {number}
+     * @memberof SourceDTO
+     */
+    primaryId: number;
+    /**
+     * Unsigned 32-bit integer.
+     * Represented as integer since it fits in JSON number precision.
+     *
+     * @type {number}
+     * @memberof SourceDTO
+     */
+    secondaryId: number;
+}
+/**
+ * Check if a given object implements the SourceDTO interface.
+ */
+export declare function instanceOfSourceDTO(value: Record<string, any>): value is SourceDTO;
+export declare function SourceDTOFromJSON(json: any): SourceDTO;
+export declare function SourceDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): SourceDTO;
+export declare function SourceDTOToJSON(json: any): SourceDTO;
+export declare function SourceDTOToJSONTyped(value?: SourceDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SourceDTO.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SourceDTO interface.
+ */
+export function instanceOfSourceDTO(value) {
+    if (!('primaryId' in value) || value['primaryId'] === undefined)
+        return false;
+    if (!('secondaryId' in value) || value['secondaryId'] === undefined)
+        return false;
+    return true;
+}
+export function SourceDTOFromJSON(json) {
+    return SourceDTOFromJSONTyped(json, false);
+}
+export function SourceDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'primaryId': json['primaryId'],
+        'secondaryId': json['secondaryId'],
+    };
+}
+export function SourceDTOToJSON(json) {
+    return SourceDTOToJSONTyped(json, false);
+}
+export function SourceDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'primaryId': value['primaryId'],
+        'secondaryId': value['secondaryId'],
+    };
+}

package/esm/api/models/StageEnum.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Finalization message stage
+ * ([docs](https://docs.symbol.dev/concepts/block.html#finalization)):
+ * - `0`: Prevote: voters indicate which block hash they support.
+ * - `1`: Precommit: voters commit to the block after supermajority prevote.
+ * - `2`: Count: tally of votes (internal use).
+ *
+ * @export
+ */
+export declare const StageEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type StageEnum = typeof StageEnum[keyof typeof StageEnum];
+export declare function instanceOfStageEnum(value: any): boolean;
+export declare function StageEnumFromJSON(json: any): StageEnum;
+export declare function StageEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): StageEnum;
+export declare function StageEnumToJSON(value?: StageEnum | null): any;
+export declare function StageEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): StageEnum;

package/esm/api/models/StageEnum.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Finalization message stage
+ * ([docs](https://docs.symbol.dev/concepts/block.html#finalization)):
+ * - `0`: Prevote: voters indicate which block hash they support.
+ * - `1`: Precommit: voters commit to the block after supermajority prevote.
+ * - `2`: Count: tally of votes (internal use).
+ *
+ * @export
+ */
+export const StageEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+export function instanceOfStageEnum(value) {
+    for (const key in StageEnum) {
+        if (Object.prototype.hasOwnProperty.call(StageEnum, key)) {
+            if (StageEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function StageEnumFromJSON(json) {
+    return StageEnumFromJSONTyped(json, false);
+}
+export function StageEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function StageEnumToJSON(value) {
+    return value;
+}
+export function StageEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/esm/api/models/StatementMetaDTO.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Metadata for a statement containing the block timestamp when it was recorded.
+ * @export
+ * @interface StatementMetaDTO
+ */
+export interface StatementMetaDTO {
+    /**
+     * Network timestamp in **milliseconds** since the creation of the nemesis (first) block.
+     * Used for block timestamps, transaction deadlines, and time synchronization.
+     *
+     * **Finding the nemesis block time:** The `epochAdjustment` field returned by the
+     * [`/network/properties`] endpoint gives the nemesis block creation time in seconds since the
+     * [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). For Symbol MAINNET this is
+     * always `1615853185` (15 March 2021, 00:06:25 UTC).
+     *
+     * **Converting to real time:** Add this timestamp (ms) to `epochAdjustment × 1000` (ms), then use standard date functions.
+     * Note: `epochAdjustment` may be returned as a string like `"1615853185s"`; use the numeric part.
+     *
+     * @type {string}
+     * @memberof StatementMetaDTO
+     */
+    timestamp: string;
+}
+/**
+ * Check if a given object implements the StatementMetaDTO interface.
+ */
+export declare function instanceOfStatementMetaDTO(value: Record<string, any>): value is StatementMetaDTO;
+export declare function StatementMetaDTOFromJSON(json: any): StatementMetaDTO;
+export declare function StatementMetaDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): StatementMetaDTO;
+export declare function StatementMetaDTOToJSON(json: any): StatementMetaDTO;
+export declare function StatementMetaDTOToJSONTyped(value?: StatementMetaDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/StatementMetaDTO.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the StatementMetaDTO interface.
+ */
+export function instanceOfStatementMetaDTO(value) {
+    if (!('timestamp' in value) || value['timestamp'] === undefined)
+        return false;
+    return true;
+}
+export function StatementMetaDTOFromJSON(json) {
+    return StatementMetaDTOFromJSONTyped(json, false);
+}
+export function StatementMetaDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'timestamp': json['timestamp'],
+    };
+}
+export function StatementMetaDTOToJSON(json) {
+    return StatementMetaDTOToJSONTyped(json, false);
+}
+export function StatementMetaDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'timestamp': value['timestamp'],
+    };
+}

package/esm/api/models/StorageInfoDTO.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { StorageInfoDatabaseDTO } from './StorageInfoDatabaseDTO';
+/**
+ * Storage statistics for the node: estimated document counts in the REST server's
+ * MongoDB collections (blocks, transactions, accounts) plus database allocation
+ * stats from `db.stats()`. Counts use estimated collection sizes and may differ
+ * slightly from exact figures under load.
+ *
+ * @export
+ * @interface StorageInfoDTO
+ */
+export interface StorageInfoDTO {
+    /**
+     * Estimated number of block documents in the `blocks` collection. Under normal
+     * operation this tracks chain height; when synchronizing, it lags the network.
+     *
+     * @type {number}
+     * @memberof StorageInfoDTO
+     */
+    numBlocks: number;
+    /**
+     * Estimated number of confirmed transaction documents in the `transactions`
+     * collection. Excludes unconfirmed transactions. For aggregate transactions,
+     * each inner transaction is stored as a separate document.
+     *
+     * @type {number}
+     * @memberof StorageInfoDTO
+     */
+    numTransactions: number;
+    /**
+     * Estimated number of account documents in the `accounts` collection (addresses
+     * with persisted on-chain state).
+     *
+     * @type {number}
+     * @memberof StorageInfoDTO
+     */
+    numAccounts: number;
+    /**
+     *
+     * @type {StorageInfoDatabaseDTO}
+     * @memberof StorageInfoDTO
+     */
+    database: StorageInfoDatabaseDTO;
+}
+/**
+ * Check if a given object implements the StorageInfoDTO interface.
+ */
+export declare function instanceOfStorageInfoDTO(value: Record<string, any>): value is StorageInfoDTO;
+export declare function StorageInfoDTOFromJSON(json: any): StorageInfoDTO;
+export declare function StorageInfoDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): StorageInfoDTO;
+export declare function StorageInfoDTOToJSON(json: any): StorageInfoDTO;
+export declare function StorageInfoDTOToJSONTyped(value?: StorageInfoDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/StorageInfoDTO.js

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { StorageInfoDatabaseDTOFromJSON, StorageInfoDatabaseDTOToJSON, } from './StorageInfoDatabaseDTO';
+/**
+ * Check if a given object implements the StorageInfoDTO interface.
+ */
+export function instanceOfStorageInfoDTO(value) {
+    if (!('numBlocks' in value) || value['numBlocks'] === undefined)
+        return false;
+    if (!('numTransactions' in value) || value['numTransactions'] === undefined)
+        return false;
+    if (!('numAccounts' in value) || value['numAccounts'] === undefined)
+        return false;
+    if (!('database' in value) || value['database'] === undefined)
+        return false;
+    return true;
+}
+export function StorageInfoDTOFromJSON(json) {
+    return StorageInfoDTOFromJSONTyped(json, false);
+}
+export function StorageInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'numBlocks': json['numBlocks'],
+        'numTransactions': json['numTransactions'],
+        'numAccounts': json['numAccounts'],
+        'database': StorageInfoDatabaseDTOFromJSON(json['database']),
+    };
+}
+export function StorageInfoDTOToJSON(json) {
+    return StorageInfoDTOToJSONTyped(json, false);
+}
+export function StorageInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'numBlocks': value['numBlocks'],
+        'numTransactions': value['numTransactions'],
+        'numAccounts': value['numAccounts'],
+        'database': StorageInfoDatabaseDTOToJSON(value['database']),
+    };
+}

package/esm/api/models/StorageInfoDatabaseDTO.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { BsonLongDTO } from './BsonLongDTO';
+/**
+ * MongoDB database statistics for the node's data store, as returned by
+ * [`db.stats()`](https://www.mongodb.com/docs/manual/reference/command/dbStats/).
+ *
+ * @export
+ * @interface StorageInfoDatabaseDTO
+ */
+export interface StorageInfoDatabaseDTO {
+    /**
+     * Total number of indexes across all collections in the database.
+     * Represented as BSON Long with `low` / `high` / `unsigned` fields.
+     *
+     * @type {BsonLongDTO}
+     * @memberof StorageInfoDatabaseDTO
+     */
+    numIndexes: BsonLongDTO;
+    /**
+     * Approximate number of documents (objects) stored in the database.
+     * Represented as BSON Long with `low` / `high` / `unsigned` fields.
+     *
+     * @type {BsonLongDTO}
+     * @memberof StorageInfoDatabaseDTO
+     */
+    numObjects: BsonLongDTO;
+    /**
+     * Total logical size of collection data (uncompressed), in bytes.
+     * This reflects document payload size and excludes index allocation.
+     * Useful as an estimate of raw data footprint, not on-disk usage.
+     *
+     * @type {number}
+     * @memberof StorageInfoDatabaseDTO
+     */
+    dataSize: number;
+    /**
+     * Total logical size of all indexes, in bytes.
+     * This includes index structures across collections and grows with
+     * both document count and the number of distinct indexed values.
+     *
+     * @type {number}
+     * @memberof StorageInfoDatabaseDTO
+     */
+    indexSize: number;
+    /**
+     * Total physical storage allocated by the database engine for collection
+     * data, in bytes. This is an allocation metric and can differ from
+     * `dataSize` because it includes engine overhead and internal padding.
+     *
+     * @type {number}
+     * @memberof StorageInfoDatabaseDTO
+     */
+    storageSize: number;
+}
+/**
+ * Check if a given object implements the StorageInfoDatabaseDTO interface.
+ */
+export declare function instanceOfStorageInfoDatabaseDTO(value: Record<string, any>): value is StorageInfoDatabaseDTO;
+export declare function StorageInfoDatabaseDTOFromJSON(json: any): StorageInfoDatabaseDTO;
+export declare function StorageInfoDatabaseDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): StorageInfoDatabaseDTO;
+export declare function StorageInfoDatabaseDTOToJSON(json: any): StorageInfoDatabaseDTO;
+export declare function StorageInfoDatabaseDTOToJSONTyped(value?: StorageInfoDatabaseDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/StorageInfoDatabaseDTO.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BsonLongDTOFromJSON, BsonLongDTOToJSON, } from './BsonLongDTO';
+/**
+ * Check if a given object implements the StorageInfoDatabaseDTO interface.
+ */
+export function instanceOfStorageInfoDatabaseDTO(value) {
+    if (!('numIndexes' in value) || value['numIndexes'] === undefined)
+        return false;
+    if (!('numObjects' in value) || value['numObjects'] === undefined)
+        return false;
+    if (!('dataSize' in value) || value['dataSize'] === undefined)
+        return false;
+    if (!('indexSize' in value) || value['indexSize'] === undefined)
+        return false;
+    if (!('storageSize' in value) || value['storageSize'] === undefined)
+        return false;
+    return true;
+}
+export function StorageInfoDatabaseDTOFromJSON(json) {
+    return StorageInfoDatabaseDTOFromJSONTyped(json, false);
+}
+export function StorageInfoDatabaseDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'numIndexes': BsonLongDTOFromJSON(json['numIndexes']),
+        'numObjects': BsonLongDTOFromJSON(json['numObjects']),
+        'dataSize': json['dataSize'],
+        'indexSize': json['indexSize'],
+        'storageSize': json['storageSize'],
+    };
+}
+export function StorageInfoDatabaseDTOToJSON(json) {
+    return StorageInfoDatabaseDTOToJSONTyped(json, false);
+}
+export function StorageInfoDatabaseDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'numIndexes': BsonLongDTOToJSON(value['numIndexes']),
+        'numObjects': BsonLongDTOToJSON(value['numObjects']),
+        'dataSize': value['dataSize'],
+        'indexSize': value['indexSize'],
+        'storageSize': value['storageSize'],
+    };
+}