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

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

@@ -0,0 +1,127 @@
+/**
+ * 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 { NetworkTypeEnum } from './NetworkTypeEnum';
+import type { LinkActionEnum } from './LinkActionEnum';
+/**
+ * Transaction to associate a BLS public key with an account.
+ * Required for node operators willing to vote finalized blocks.
+ *
+ * @export
+ * @interface VotingKeyLinkTransactionDTO
+ */
+export interface VotingKeyLinkTransactionDTO {
+    /**
+     * Unsigned 32-bit integer.
+     * Represented as integer since it fits in JSON number precision.
+     *
+     * @type {number}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    size: number;
+    /**
+     * 64-byte Ed25519 signature (128 hex characters). Generated by the signer using their private key
+     * over the serialized entity payload. Can be verified with the signer's public key (`signerPublicKey`).
+     * Used for blocks, transactions, and cosignatures.
+     *
+     * @type {string}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    signature: string;
+    /**
+     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
+     * @type {string}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    signerPublicKey: string;
+    /**
+     * Entity version. Indicates the schema variant for serialization and validation.
+     * @type {number}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    version: number;
+    /**
+     * Network type (mainnet or testnet). Ensures the entity targets the correct network.
+     * @type {NetworkTypeEnum}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    network: NetworkTypeEnum;
+    /**
+     * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema.
+     * @type {number}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    type: number;
+    /**
+     * 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 VotingKeyLinkTransactionDTO
+     */
+    maxFee: string;
+    /**
+     * 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 VotingKeyLinkTransactionDTO
+     */
+    deadline: string;
+    /**
+     * 32-byte voting public key used for finalization voting.
+     * @type {string}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    linkedPublicKey: string;
+    /**
+     * [Finalization epoch](https://docs.symbol.dev/concepts/block.html#finalization) is a sequential
+     * integer. Each epoch groups a set of blocks for finalization voting; the interval is defined
+     * by the `votingSetGrouping` network property (e.g. 1440 blocks, ~12h on mainnet).
+     *
+     * @type {number}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    startEpoch: number;
+    /**
+     * [Finalization epoch](https://docs.symbol.dev/concepts/block.html#finalization) is a sequential
+     * integer. Each epoch groups a set of blocks for finalization voting; the interval is defined
+     * by the `votingSetGrouping` network property (e.g. 1440 blocks, ~12h on mainnet).
+     *
+     * @type {number}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    endEpoch: number;
+    /**
+     *
+     * @type {LinkActionEnum}
+     * @memberof VotingKeyLinkTransactionDTO
+     */
+    linkAction: LinkActionEnum;
+}
+/**
+ * Check if a given object implements the VotingKeyLinkTransactionDTO interface.
+ */
+export declare function instanceOfVotingKeyLinkTransactionDTO(value: Record<string, any>): value is VotingKeyLinkTransactionDTO;
+export declare function VotingKeyLinkTransactionDTOFromJSON(json: any): VotingKeyLinkTransactionDTO;
+export declare function VotingKeyLinkTransactionDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): VotingKeyLinkTransactionDTO;
+export declare function VotingKeyLinkTransactionDTOToJSON(json: any): VotingKeyLinkTransactionDTO;
+export declare function VotingKeyLinkTransactionDTOToJSONTyped(value?: VotingKeyLinkTransactionDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/VotingKeyLinkTransactionDTO.js

@@ -0,0 +1,89 @@
+/* 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 { NetworkTypeEnumFromJSON, NetworkTypeEnumToJSON, } from './NetworkTypeEnum';
+import { LinkActionEnumFromJSON, LinkActionEnumToJSON, } from './LinkActionEnum';
+/**
+ * Check if a given object implements the VotingKeyLinkTransactionDTO interface.
+ */
+export function instanceOfVotingKeyLinkTransactionDTO(value) {
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    if (!('signature' in value) || value['signature'] === undefined)
+        return false;
+    if (!('signerPublicKey' in value) || value['signerPublicKey'] === undefined)
+        return false;
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('network' in value) || value['network'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('maxFee' in value) || value['maxFee'] === undefined)
+        return false;
+    if (!('deadline' in value) || value['deadline'] === undefined)
+        return false;
+    if (!('linkedPublicKey' in value) || value['linkedPublicKey'] === undefined)
+        return false;
+    if (!('startEpoch' in value) || value['startEpoch'] === undefined)
+        return false;
+    if (!('endEpoch' in value) || value['endEpoch'] === undefined)
+        return false;
+    if (!('linkAction' in value) || value['linkAction'] === undefined)
+        return false;
+    return true;
+}
+export function VotingKeyLinkTransactionDTOFromJSON(json) {
+    return VotingKeyLinkTransactionDTOFromJSONTyped(json, false);
+}
+export function VotingKeyLinkTransactionDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'size': json['size'],
+        'signature': json['signature'],
+        'signerPublicKey': json['signerPublicKey'],
+        'version': json['version'],
+        'network': NetworkTypeEnumFromJSON(json['network']),
+        'type': json['type'],
+        'maxFee': json['maxFee'],
+        'deadline': json['deadline'],
+        'linkedPublicKey': json['linkedPublicKey'],
+        'startEpoch': json['startEpoch'],
+        'endEpoch': json['endEpoch'],
+        'linkAction': LinkActionEnumFromJSON(json['linkAction']),
+    };
+}
+export function VotingKeyLinkTransactionDTOToJSON(json) {
+    return VotingKeyLinkTransactionDTOToJSONTyped(json, false);
+}
+export function VotingKeyLinkTransactionDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'size': value['size'],
+        'signature': value['signature'],
+        'signerPublicKey': value['signerPublicKey'],
+        'version': value['version'],
+        'network': NetworkTypeEnumToJSON(value['network']),
+        'type': value['type'],
+        'maxFee': value['maxFee'],
+        'deadline': value['deadline'],
+        'linkedPublicKey': value['linkedPublicKey'],
+        'startEpoch': value['startEpoch'],
+        'endEpoch': value['endEpoch'],
+        'linkAction': LinkActionEnumToJSON(value['linkAction']),
+    };
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { LinkActionEnum } from './LinkActionEnum';
+/**
+ * VRF key link transaction body that links or unlinks a VRF public key.
+ * @export
+ * @interface VrfKeyLinkTransactionBodyDTO
+ */
+export interface VrfKeyLinkTransactionBodyDTO {
+    /**
+     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
+     * @type {string}
+     * @memberof VrfKeyLinkTransactionBodyDTO
+     */
+    linkedPublicKey: string;
+    /**
+     *
+     * @type {LinkActionEnum}
+     * @memberof VrfKeyLinkTransactionBodyDTO
+     */
+    linkAction: LinkActionEnum;
+}
+/**
+ * Check if a given object implements the VrfKeyLinkTransactionBodyDTO interface.
+ */
+export declare function instanceOfVrfKeyLinkTransactionBodyDTO(value: Record<string, any>): value is VrfKeyLinkTransactionBodyDTO;
+export declare function VrfKeyLinkTransactionBodyDTOFromJSON(json: any): VrfKeyLinkTransactionBodyDTO;
+export declare function VrfKeyLinkTransactionBodyDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): VrfKeyLinkTransactionBodyDTO;
+export declare function VrfKeyLinkTransactionBodyDTOToJSON(json: any): VrfKeyLinkTransactionBodyDTO;
+export declare function VrfKeyLinkTransactionBodyDTOToJSONTyped(value?: VrfKeyLinkTransactionBodyDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/VrfKeyLinkTransactionBodyDTO.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 { LinkActionEnumFromJSON, LinkActionEnumToJSON, } from './LinkActionEnum';
+/**
+ * Check if a given object implements the VrfKeyLinkTransactionBodyDTO interface.
+ */
+export function instanceOfVrfKeyLinkTransactionBodyDTO(value) {
+    if (!('linkedPublicKey' in value) || value['linkedPublicKey'] === undefined)
+        return false;
+    if (!('linkAction' in value) || value['linkAction'] === undefined)
+        return false;
+    return true;
+}
+export function VrfKeyLinkTransactionBodyDTOFromJSON(json) {
+    return VrfKeyLinkTransactionBodyDTOFromJSONTyped(json, false);
+}
+export function VrfKeyLinkTransactionBodyDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'linkedPublicKey': json['linkedPublicKey'],
+        'linkAction': LinkActionEnumFromJSON(json['linkAction']),
+    };
+}
+export function VrfKeyLinkTransactionBodyDTOToJSON(json) {
+    return VrfKeyLinkTransactionBodyDTOToJSONTyped(json, false);
+}
+export function VrfKeyLinkTransactionBodyDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'linkedPublicKey': value['linkedPublicKey'],
+        'linkAction': LinkActionEnumToJSON(value['linkAction']),
+    };
+}

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

@@ -0,0 +1,110 @@
+/**
+ * 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 { NetworkTypeEnum } from './NetworkTypeEnum';
+import type { LinkActionEnum } from './LinkActionEnum';
+/**
+ * Transaction to link an account with a VRF public key.
+ * The key is used to randomize block production and leader/participant selection.
+ * Required for all harvesting eligible accounts.
+ *
+ * @export
+ * @interface VrfKeyLinkTransactionDTO
+ */
+export interface VrfKeyLinkTransactionDTO {
+    /**
+     * Unsigned 32-bit integer.
+     * Represented as integer since it fits in JSON number precision.
+     *
+     * @type {number}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    size: number;
+    /**
+     * 64-byte Ed25519 signature (128 hex characters). Generated by the signer using their private key
+     * over the serialized entity payload. Can be verified with the signer's public key (`signerPublicKey`).
+     * Used for blocks, transactions, and cosignatures.
+     *
+     * @type {string}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    signature: string;
+    /**
+     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
+     * @type {string}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    signerPublicKey: string;
+    /**
+     * Entity version. Indicates the schema variant for serialization and validation.
+     * @type {number}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    version: number;
+    /**
+     * Network type (mainnet or testnet). Ensures the entity targets the correct network.
+     * @type {NetworkTypeEnum}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    network: NetworkTypeEnum;
+    /**
+     * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema.
+     * @type {number}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    type: number;
+    /**
+     * 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 VrfKeyLinkTransactionDTO
+     */
+    maxFee: string;
+    /**
+     * 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 VrfKeyLinkTransactionDTO
+     */
+    deadline: string;
+    /**
+     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
+     * @type {string}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    linkedPublicKey: string;
+    /**
+     *
+     * @type {LinkActionEnum}
+     * @memberof VrfKeyLinkTransactionDTO
+     */
+    linkAction: LinkActionEnum;
+}
+/**
+ * Check if a given object implements the VrfKeyLinkTransactionDTO interface.
+ */
+export declare function instanceOfVrfKeyLinkTransactionDTO(value: Record<string, any>): value is VrfKeyLinkTransactionDTO;
+export declare function VrfKeyLinkTransactionDTOFromJSON(json: any): VrfKeyLinkTransactionDTO;
+export declare function VrfKeyLinkTransactionDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): VrfKeyLinkTransactionDTO;
+export declare function VrfKeyLinkTransactionDTOToJSON(json: any): VrfKeyLinkTransactionDTO;
+export declare function VrfKeyLinkTransactionDTOToJSONTyped(value?: VrfKeyLinkTransactionDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/VrfKeyLinkTransactionDTO.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 { NetworkTypeEnumFromJSON, NetworkTypeEnumToJSON, } from './NetworkTypeEnum';
+import { LinkActionEnumFromJSON, LinkActionEnumToJSON, } from './LinkActionEnum';
+/**
+ * Check if a given object implements the VrfKeyLinkTransactionDTO interface.
+ */
+export function instanceOfVrfKeyLinkTransactionDTO(value) {
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    if (!('signature' in value) || value['signature'] === undefined)
+        return false;
+    if (!('signerPublicKey' in value) || value['signerPublicKey'] === undefined)
+        return false;
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('network' in value) || value['network'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('maxFee' in value) || value['maxFee'] === undefined)
+        return false;
+    if (!('deadline' in value) || value['deadline'] === undefined)
+        return false;
+    if (!('linkedPublicKey' in value) || value['linkedPublicKey'] === undefined)
+        return false;
+    if (!('linkAction' in value) || value['linkAction'] === undefined)
+        return false;
+    return true;
+}
+export function VrfKeyLinkTransactionDTOFromJSON(json) {
+    return VrfKeyLinkTransactionDTOFromJSONTyped(json, false);
+}
+export function VrfKeyLinkTransactionDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'size': json['size'],
+        'signature': json['signature'],
+        'signerPublicKey': json['signerPublicKey'],
+        'version': json['version'],
+        'network': NetworkTypeEnumFromJSON(json['network']),
+        'type': json['type'],
+        'maxFee': json['maxFee'],
+        'deadline': json['deadline'],
+        'linkedPublicKey': json['linkedPublicKey'],
+        'linkAction': LinkActionEnumFromJSON(json['linkAction']),
+    };
+}
+export function VrfKeyLinkTransactionDTOToJSON(json) {
+    return VrfKeyLinkTransactionDTOToJSONTyped(json, false);
+}
+export function VrfKeyLinkTransactionDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'size': value['size'],
+        'signature': value['signature'],
+        'signerPublicKey': value['signerPublicKey'],
+        'version': value['version'],
+        'network': NetworkTypeEnumToJSON(value['network']),
+        'type': value['type'],
+        'maxFee': value['maxFee'],
+        'deadline': value['deadline'],
+        'linkedPublicKey': value['linkedPublicKey'],
+        'linkAction': LinkActionEnumToJSON(value['linkAction']),
+    };
+}