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

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

@@ -0,0 +1,108 @@
+/**
+ * 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 { LockStatus } from './LockStatus';
+import type { LockHashAlgorithmEnum } from './LockHashAlgorithmEnum';
+/**
+ * Locked mosaic funds that can be claimed by the recipient only after revealing a valid proof.
+ * If the proof is not revealed before the lock expires, the locked funds are returned to the sender.
+ *
+ * @export
+ * @interface SecretLockEntryDTO
+ */
+export interface SecretLockEntryDTO {
+    /**
+     * Version of the on-chain state serialization format. Incremented when the storage
+     * schema of the entity changes (e.g. new fields are added), allowing the node to
+     * deserialize entries written under earlier formats.
+     *
+     * @type {number}
+     * @memberof SecretLockEntryDTO
+     */
+    version: number;
+    /**
+     * Address encoded as a 48-character hexadecimal string (24 bytes).
+     * The REST API returns addresses in this format. For Base32-encoded addresses (39 chars) see `Address`.
+     *
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    ownerAddress: string;
+    /**
+     * Unique [mosaic](https://docs.symbol.dev/concepts/mosaic.html) identifier.
+     * A 64-bit unsigned integer derived from the creator's address and a registration nonce,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    mosaicId: string;
+    /**
+     * Absolute amount expressed in the mosaic's smallest (atomic) unit, with no decimal point.
+     * For example, an amount of `123456789` for a mosaic with divisibility 6 represents
+     * `123.456789` whole units. Encoded as a string to preserve precision, since the value
+     * is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    amount: string;
+    /**
+     * Height of a block in the blockchain. Starts at 1 and increments by one per block.
+     * Represented as a string to preserve precision, since the value is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    endHeight: string;
+    /**
+     *
+     * @type {LockStatus}
+     * @memberof SecretLockEntryDTO
+     */
+    status: LockStatus;
+    /**
+     *
+     * @type {LockHashAlgorithmEnum}
+     * @memberof SecretLockEntryDTO
+     */
+    hashAlgorithm: LockHashAlgorithmEnum;
+    /**
+     * 256-bit hashed secret derived from the proof using the selected `LockHashAlgorithm`.
+     * In secret lock and secret proof transactions, the revealed proof must hash to this value.
+     *
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    secret: string;
+    /**
+     * Address encoded as a 48-character hexadecimal string (24 bytes).
+     * The REST API returns addresses in this format. For Base32-encoded addresses (39 chars) see `Address`.
+     *
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    recipientAddress: string;
+    /**
+     * 256-bit hash encoded as a 64-character hexadecimal string.
+     * @type {string}
+     * @memberof SecretLockEntryDTO
+     */
+    compositeHash: string;
+}
+/**
+ * Check if a given object implements the SecretLockEntryDTO interface.
+ */
+export declare function instanceOfSecretLockEntryDTO(value: Record<string, any>): value is SecretLockEntryDTO;
+export declare function SecretLockEntryDTOFromJSON(json: any): SecretLockEntryDTO;
+export declare function SecretLockEntryDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretLockEntryDTO;
+export declare function SecretLockEntryDTOToJSON(json: any): SecretLockEntryDTO;
+export declare function SecretLockEntryDTOToJSONTyped(value?: SecretLockEntryDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SecretLockEntryDTO.js

@@ -0,0 +1,81 @@
+/* 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 { LockStatusFromJSON, LockStatusToJSON, } from './LockStatus';
+import { LockHashAlgorithmEnumFromJSON, LockHashAlgorithmEnumToJSON, } from './LockHashAlgorithmEnum';
+/**
+ * Check if a given object implements the SecretLockEntryDTO interface.
+ */
+export function instanceOfSecretLockEntryDTO(value) {
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('ownerAddress' in value) || value['ownerAddress'] === undefined)
+        return false;
+    if (!('mosaicId' in value) || value['mosaicId'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('endHeight' in value) || value['endHeight'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('hashAlgorithm' in value) || value['hashAlgorithm'] === undefined)
+        return false;
+    if (!('secret' in value) || value['secret'] === undefined)
+        return false;
+    if (!('recipientAddress' in value) || value['recipientAddress'] === undefined)
+        return false;
+    if (!('compositeHash' in value) || value['compositeHash'] === undefined)
+        return false;
+    return true;
+}
+export function SecretLockEntryDTOFromJSON(json) {
+    return SecretLockEntryDTOFromJSONTyped(json, false);
+}
+export function SecretLockEntryDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'version': json['version'],
+        'ownerAddress': json['ownerAddress'],
+        'mosaicId': json['mosaicId'],
+        'amount': json['amount'],
+        'endHeight': json['endHeight'],
+        'status': LockStatusFromJSON(json['status']),
+        'hashAlgorithm': LockHashAlgorithmEnumFromJSON(json['hashAlgorithm']),
+        'secret': json['secret'],
+        'recipientAddress': json['recipientAddress'],
+        'compositeHash': json['compositeHash'],
+    };
+}
+export function SecretLockEntryDTOToJSON(json) {
+    return SecretLockEntryDTOToJSONTyped(json, false);
+}
+export function SecretLockEntryDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version': value['version'],
+        'ownerAddress': value['ownerAddress'],
+        'mosaicId': value['mosaicId'],
+        'amount': value['amount'],
+        'endHeight': value['endHeight'],
+        'status': LockStatusToJSON(value['status']),
+        'hashAlgorithm': LockHashAlgorithmEnumToJSON(value['hashAlgorithm']),
+        'secret': value['secret'],
+        'recipientAddress': value['recipientAddress'],
+        'compositeHash': value['compositeHash'],
+    };
+}

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

@@ -0,0 +1,41 @@
+/**
+ * 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 { SecretLockEntryDTO } from './SecretLockEntryDTO';
+/**
+ * Wrapper object containing one secret lock entry and its identifier.
+ * @export
+ * @interface SecretLockInfoDTO
+ */
+export interface SecretLockInfoDTO {
+    /**
+     * Unique identifier of the object in the node's database (MongoDB ObjectId).
+     * Used as the `offset` parameter value for cursor-based pagination.
+     *
+     * @type {string}
+     * @memberof SecretLockInfoDTO
+     */
+    id: string;
+    /**
+     *
+     * @type {SecretLockEntryDTO}
+     * @memberof SecretLockInfoDTO
+     */
+    lock: SecretLockEntryDTO;
+}
+/**
+ * Check if a given object implements the SecretLockInfoDTO interface.
+ */
+export declare function instanceOfSecretLockInfoDTO(value: Record<string, any>): value is SecretLockInfoDTO;
+export declare function SecretLockInfoDTOFromJSON(json: any): SecretLockInfoDTO;
+export declare function SecretLockInfoDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretLockInfoDTO;
+export declare function SecretLockInfoDTOToJSON(json: any): SecretLockInfoDTO;
+export declare function SecretLockInfoDTOToJSONTyped(value?: SecretLockInfoDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SecretLockInfoDTO.js

@@ -0,0 +1,48 @@
+/* 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 { SecretLockEntryDTOFromJSON, SecretLockEntryDTOToJSON, } from './SecretLockEntryDTO';
+/**
+ * Check if a given object implements the SecretLockInfoDTO interface.
+ */
+export function instanceOfSecretLockInfoDTO(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('lock' in value) || value['lock'] === undefined)
+        return false;
+    return true;
+}
+export function SecretLockInfoDTOFromJSON(json) {
+    return SecretLockInfoDTOFromJSONTyped(json, false);
+}
+export function SecretLockInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'lock': SecretLockEntryDTOFromJSON(json['lock']),
+    };
+}
+export function SecretLockInfoDTOToJSON(json) {
+    return SecretLockInfoDTOToJSONTyped(json, false);
+}
+export function SecretLockInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'lock': SecretLockEntryDTOToJSON(value['lock']),
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface SecretLockNetworkPropertiesDTO
+ */
+export interface SecretLockNetworkPropertiesDTO {
+    /**
+     * Maximum number of blocks for which a secret lock can exist.
+     * @type {string}
+     * @memberof SecretLockNetworkPropertiesDTO
+     */
+    maxSecretLockDuration?: string;
+    /**
+     * Minimum size of a proof in bytes.
+     * @type {string}
+     * @memberof SecretLockNetworkPropertiesDTO
+     */
+    minProofSize?: string;
+    /**
+     * Maximum size of a proof in bytes.
+     * @type {string}
+     * @memberof SecretLockNetworkPropertiesDTO
+     */
+    maxProofSize?: string;
+}
+/**
+ * Check if a given object implements the SecretLockNetworkPropertiesDTO interface.
+ */
+export declare function instanceOfSecretLockNetworkPropertiesDTO(value: Record<string, any>): value is SecretLockNetworkPropertiesDTO;
+export declare function SecretLockNetworkPropertiesDTOFromJSON(json: any): SecretLockNetworkPropertiesDTO;
+export declare function SecretLockNetworkPropertiesDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretLockNetworkPropertiesDTO;
+export declare function SecretLockNetworkPropertiesDTOToJSON(json: any): SecretLockNetworkPropertiesDTO;
+export declare function SecretLockNetworkPropertiesDTOToJSONTyped(value?: SecretLockNetworkPropertiesDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SecretLockNetworkPropertiesDTO.js

@@ -0,0 +1,45 @@
+/* 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 SecretLockNetworkPropertiesDTO interface.
+ */
+export function instanceOfSecretLockNetworkPropertiesDTO(value) {
+    return true;
+}
+export function SecretLockNetworkPropertiesDTOFromJSON(json) {
+    return SecretLockNetworkPropertiesDTOFromJSONTyped(json, false);
+}
+export function SecretLockNetworkPropertiesDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'maxSecretLockDuration': json['maxSecretLockDuration'] == null ? undefined : json['maxSecretLockDuration'],
+        'minProofSize': json['minProofSize'] == null ? undefined : json['minProofSize'],
+        'maxProofSize': json['maxProofSize'] == null ? undefined : json['maxProofSize'],
+    };
+}
+export function SecretLockNetworkPropertiesDTOToJSON(json) {
+    return SecretLockNetworkPropertiesDTOToJSONTyped(json, false);
+}
+export function SecretLockNetworkPropertiesDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'maxSecretLockDuration': value['maxSecretLockDuration'],
+        'minProofSize': value['minProofSize'],
+        'maxProofSize': value['maxProofSize'],
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 { Pagination } from './Pagination';
+import type { SecretLockInfoDTO } from './SecretLockInfoDTO';
+/**
+ * Paginated response containing secret lock entries.
+ * @export
+ * @interface SecretLockPage
+ */
+export interface SecretLockPage {
+    /**
+     * Secret lock entries matching the requested filters.
+     * @type {Array<SecretLockInfoDTO>}
+     * @memberof SecretLockPage
+     */
+    data: Array<SecretLockInfoDTO>;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof SecretLockPage
+     */
+    pagination: Pagination;
+}
+/**
+ * Check if a given object implements the SecretLockPage interface.
+ */
+export declare function instanceOfSecretLockPage(value: Record<string, any>): value is SecretLockPage;
+export declare function SecretLockPageFromJSON(json: any): SecretLockPage;
+export declare function SecretLockPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretLockPage;
+export declare function SecretLockPageToJSON(json: any): SecretLockPage;
+export declare function SecretLockPageToJSONTyped(value?: SecretLockPage | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SecretLockPage.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.
+ */
+import { PaginationFromJSON, PaginationToJSON, } from './Pagination';
+import { SecretLockInfoDTOFromJSON, SecretLockInfoDTOToJSON, } from './SecretLockInfoDTO';
+/**
+ * Check if a given object implements the SecretLockPage interface.
+ */
+export function instanceOfSecretLockPage(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('pagination' in value) || value['pagination'] === undefined)
+        return false;
+    return true;
+}
+export function SecretLockPageFromJSON(json) {
+    return SecretLockPageFromJSONTyped(json, false);
+}
+export function SecretLockPageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(SecretLockInfoDTOFromJSON)),
+        'pagination': PaginationFromJSON(json['pagination']),
+    };
+}
+export function SecretLockPageToJSON(json) {
+    return SecretLockPageToJSONTyped(json, false);
+}
+export function SecretLockPageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(SecretLockInfoDTOToJSON)),
+        'pagination': PaginationToJSON(value['pagination']),
+    };
+}

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

@@ -0,0 +1,73 @@
+/**
+ * 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 { LockHashAlgorithmEnum } from './LockHashAlgorithmEnum';
+/**
+ * Secret lock transaction body that locks a mosaic for a recipient until the secret proof is revealed.
+ * @export
+ * @interface SecretLockTransactionBodyDTO
+ */
+export interface SecretLockTransactionBodyDTO {
+    /**
+     * Unresolved address encoded as a 48-character hexadecimal string (24 bytes).
+     * If bit 0 of byte 0 is not set, the value represents a regular address.
+     * Otherwise, it represents a namespace ID alias encoded as an unresolved address.
+     *
+     * @type {string}
+     * @memberof SecretLockTransactionBodyDTO
+     */
+    recipientAddress: string;
+    /**
+     * 256-bit hash encoded as a 64-character hexadecimal string.
+     * @type {string}
+     * @memberof SecretLockTransactionBodyDTO
+     */
+    secret: string;
+    /**
+     * Unresolved mosaic identifier.
+     * If the most significant bit of byte 0 is set, the value contains a namespace ID alias
+     * instead of a concrete mosaic ID.
+     *
+     * @type {string}
+     * @memberof SecretLockTransactionBodyDTO
+     */
+    mosaicId: string;
+    /**
+     * Absolute amount expressed in the mosaic's smallest (atomic) unit, with no decimal point.
+     * For example, an amount of `123456789` for a mosaic with divisibility 6 represents
+     * `123.456789` whole units. Encoded as a string to preserve precision, since the value
+     * is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof SecretLockTransactionBodyDTO
+     */
+    amount: string;
+    /**
+     * Duration expressed in number of blocks.
+     * @type {string}
+     * @memberof SecretLockTransactionBodyDTO
+     */
+    duration: string;
+    /**
+     *
+     * @type {LockHashAlgorithmEnum}
+     * @memberof SecretLockTransactionBodyDTO
+     */
+    hashAlgorithm: LockHashAlgorithmEnum;
+}
+/**
+ * Check if a given object implements the SecretLockTransactionBodyDTO interface.
+ */
+export declare function instanceOfSecretLockTransactionBodyDTO(value: Record<string, any>): value is SecretLockTransactionBodyDTO;
+export declare function SecretLockTransactionBodyDTOFromJSON(json: any): SecretLockTransactionBodyDTO;
+export declare function SecretLockTransactionBodyDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecretLockTransactionBodyDTO;
+export declare function SecretLockTransactionBodyDTOToJSON(json: any): SecretLockTransactionBodyDTO;
+export declare function SecretLockTransactionBodyDTOToJSONTyped(value?: SecretLockTransactionBodyDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/SecretLockTransactionBodyDTO.js

@@ -0,0 +1,64 @@
+/* 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 { LockHashAlgorithmEnumFromJSON, LockHashAlgorithmEnumToJSON, } from './LockHashAlgorithmEnum';
+/**
+ * Check if a given object implements the SecretLockTransactionBodyDTO interface.
+ */
+export function instanceOfSecretLockTransactionBodyDTO(value) {
+    if (!('recipientAddress' in value) || value['recipientAddress'] === undefined)
+        return false;
+    if (!('secret' in value) || value['secret'] === undefined)
+        return false;
+    if (!('mosaicId' in value) || value['mosaicId'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('duration' in value) || value['duration'] === undefined)
+        return false;
+    if (!('hashAlgorithm' in value) || value['hashAlgorithm'] === undefined)
+        return false;
+    return true;
+}
+export function SecretLockTransactionBodyDTOFromJSON(json) {
+    return SecretLockTransactionBodyDTOFromJSONTyped(json, false);
+}
+export function SecretLockTransactionBodyDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'recipientAddress': json['recipientAddress'],
+        'secret': json['secret'],
+        'mosaicId': json['mosaicId'],
+        'amount': json['amount'],
+        'duration': json['duration'],
+        'hashAlgorithm': LockHashAlgorithmEnumFromJSON(json['hashAlgorithm']),
+    };
+}
+export function SecretLockTransactionBodyDTOToJSON(json) {
+    return SecretLockTransactionBodyDTOToJSONTyped(json, false);
+}
+export function SecretLockTransactionBodyDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'recipientAddress': value['recipientAddress'],
+        'secret': value['secret'],
+        'mosaicId': value['mosaicId'],
+        'amount': value['amount'],
+        'duration': value['duration'],
+        'hashAlgorithm': LockHashAlgorithmEnumToJSON(value['hashAlgorithm']),
+    };
+}