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

package/cjs/api/models/TransactionBodyDTO.d.ts

@@ -16,36 +16,20 @@
  */
 export interface TransactionBodyDTO {
     /**
-     * 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 TransactionBodyDTO
+     * Maximum fee the signer is willing to pay for this transaction, in smallest (atomic) units.
      */
     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.
+     * Latest network time at which the transaction can still be included in a block, expressed in milliseconds
+     * since the creation of the nemesis (first) block.
      *
-     * @type {string}
-     * @memberof TransactionBodyDTO
      */
     deadline: string;
 }
 /**
  * Check if a given object implements the TransactionBodyDTO interface.
  */
-export declare function instanceOfTransactionBodyDTO(value: Record<string, any>): value is TransactionBodyDTO;
+export declare function instanceOfTransactionBodyDTO(value: object): value is TransactionBodyDTO;
 export declare function TransactionBodyDTOFromJSON(json: any): TransactionBodyDTO;
 export declare function TransactionBodyDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionBodyDTO;
 export declare function TransactionBodyDTOToJSON(json: any): TransactionBodyDTO;

package/cjs/api/models/TransactionDTO.d.ts

@@ -17,11 +17,9 @@ import type { NetworkTypeEnum } from './NetworkTypeEnum';
  */
 export interface TransactionDTO {
     /**
-     * Unsigned 32-bit integer.
-     * Represented as integer since it fits in JSON number precision.
+     * Total size of the serialized entity in bytes. Includes the full binary payload,
+     * including the 4-byte size field itself.
      *
-     * @type {number}
-     * @memberof TransactionDTO
      */
     size: number;
     /**
@@ -29,65 +27,39 @@ export interface TransactionDTO {
      * over the serialized entity payload. Can be verified with the signer's public key (`signerPublicKey`).
      * Used for blocks, transactions, and cosignatures.
      *
-     * @type {string}
-     * @memberof TransactionDTO
      */
     signature: string;
     /**
-     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
-     * @type {string}
-     * @memberof TransactionDTO
+     * Public key of the account that signed the entity (e.g. block harvester, transaction signer).
      */
     signerPublicKey: string;
     /**
      * Entity version. Indicates the schema variant for serialization and validation.
-     * @type {number}
-     * @memberof TransactionDTO
      */
     version: number;
     /**
      * Network type (mainnet or testnet). Ensures the entity targets the correct network.
-     * @type {NetworkTypeEnum}
-     * @memberof TransactionDTO
      */
     network: NetworkTypeEnum;
     /**
      * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema.
-     * @type {number}
-     * @memberof TransactionDTO
      */
     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 TransactionDTO
+     * Maximum fee the signer is willing to pay for this transaction, in smallest (atomic) units.
      */
     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.
+     * Latest network time at which the transaction can still be included in a block, expressed in milliseconds
+     * since the creation of the nemesis (first) block.
      *
-     * @type {string}
-     * @memberof TransactionDTO
      */
     deadline: string;
 }
 /**
  * Check if a given object implements the TransactionDTO interface.
  */
-export declare function instanceOfTransactionDTO(value: Record<string, any>): value is TransactionDTO;
+export declare function instanceOfTransactionDTO(value: object): value is TransactionDTO;
 export declare function TransactionDTOFromJSON(json: any): TransactionDTO;
 export declare function TransactionDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionDTO;
 export declare function TransactionDTOToJSON(json: any): TransactionDTO;

package/cjs/api/models/TransactionFeesDTO.d.ts

@@ -19,100 +19,30 @@
  */
 export interface TransactionFeesDTO {
     /**
-     * Fee multiplier applied to the size of a transaction to obtain its fee, in
-     * [absolute units](https://docs.symbol.dev/concepts/mosaic.html#divisibility).
-     * Set by the harvester when creating a block; stored in the block header.
-     *
-     * The effective fee for a transaction is:
-     *
-     * `effectiveFee = transaction.size × block.feeMultiplier`
-     *
-     * Node owners can configure the fee multiplier to any non-negative value (including zero).
-     * For transaction senders, the median fee multiplier over recent blocks is available
-     * via `/network/fees/transaction`; using `medianFeeMultiplier` or higher
-     * improves chances of inclusion. See the [fees documentation](https://docs.symbol.dev/concepts/fees.html).
-     *
-     * @type {number}
-     * @memberof TransactionFeesDTO
+     * Average fee multiplier over the last `numBlocksTransactionFeeStats` blocks on the current network.
      */
     averageFeeMultiplier: number;
     /**
-     * Fee multiplier applied to the size of a transaction to obtain its fee, in
-     * [absolute units](https://docs.symbol.dev/concepts/mosaic.html#divisibility).
-     * Set by the harvester when creating a block; stored in the block header.
-     *
-     * The effective fee for a transaction is:
-     *
-     * `effectiveFee = transaction.size × block.feeMultiplier`
-     *
-     * Node owners can configure the fee multiplier to any non-negative value (including zero).
-     * For transaction senders, the median fee multiplier over recent blocks is available
-     * via `/network/fees/transaction`; using `medianFeeMultiplier` or higher
-     * improves chances of inclusion. See the [fees documentation](https://docs.symbol.dev/concepts/fees.html).
-     *
-     * @type {number}
-     * @memberof TransactionFeesDTO
+     * Median fee multiplier over the last `numBlocksTransactionFeeStats` blocks on the current network.
      */
     medianFeeMultiplier: number;
     /**
-     * Fee multiplier applied to the size of a transaction to obtain its fee, in
-     * [absolute units](https://docs.symbol.dev/concepts/mosaic.html#divisibility).
-     * Set by the harvester when creating a block; stored in the block header.
-     *
-     * The effective fee for a transaction is:
-     *
-     * `effectiveFee = transaction.size × block.feeMultiplier`
-     *
-     * Node owners can configure the fee multiplier to any non-negative value (including zero).
-     * For transaction senders, the median fee multiplier over recent blocks is available
-     * via `/network/fees/transaction`; using `medianFeeMultiplier` or higher
-     * improves chances of inclusion. See the [fees documentation](https://docs.symbol.dev/concepts/fees.html).
-     *
-     * @type {number}
-     * @memberof TransactionFeesDTO
+     * Highest fee multiplier over the last `numBlocksTransactionFeeStats` blocks on the current network.
      */
     highestFeeMultiplier: number;
     /**
-     * Fee multiplier applied to the size of a transaction to obtain its fee, in
-     * [absolute units](https://docs.symbol.dev/concepts/mosaic.html#divisibility).
-     * Set by the harvester when creating a block; stored in the block header.
-     *
-     * The effective fee for a transaction is:
-     *
-     * `effectiveFee = transaction.size × block.feeMultiplier`
-     *
-     * Node owners can configure the fee multiplier to any non-negative value (including zero).
-     * For transaction senders, the median fee multiplier over recent blocks is available
-     * via `/network/fees/transaction`; using `medianFeeMultiplier` or higher
-     * improves chances of inclusion. See the [fees documentation](https://docs.symbol.dev/concepts/fees.html).
-     *
-     * @type {number}
-     * @memberof TransactionFeesDTO
+     * Lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks on the current network.
      */
     lowestFeeMultiplier: number;
     /**
-     * Fee multiplier applied to the size of a transaction to obtain its fee, in
-     * [absolute units](https://docs.symbol.dev/concepts/mosaic.html#divisibility).
-     * Set by the harvester when creating a block; stored in the block header.
-     *
-     * The effective fee for a transaction is:
-     *
-     * `effectiveFee = transaction.size × block.feeMultiplier`
-     *
-     * Node owners can configure the fee multiplier to any non-negative value (including zero).
-     * For transaction senders, the median fee multiplier over recent blocks is available
-     * via `/network/fees/transaction`; using `medianFeeMultiplier` or higher
-     * improves chances of inclusion. See the [fees documentation](https://docs.symbol.dev/concepts/fees.html).
-     *
-     * @type {number}
-     * @memberof TransactionFeesDTO
+     * Minimal fee multiplier on the current connected node.
      */
     minFeeMultiplier: number;
 }
 /**
  * Check if a given object implements the TransactionFeesDTO interface.
  */
-export declare function instanceOfTransactionFeesDTO(value: Record<string, any>): value is TransactionFeesDTO;
+export declare function instanceOfTransactionFeesDTO(value: object): value is TransactionFeesDTO;
 export declare function TransactionFeesDTOFromJSON(json: any): TransactionFeesDTO;
 export declare function TransactionFeesDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionFeesDTO;
 export declare function TransactionFeesDTOToJSON(json: any): TransactionFeesDTO;

package/cjs/api/models/TransactionGroupEnum.js

@@ -32,7 +32,7 @@ exports.TransactionGroupEnum = {
     Unconfirmed: 'unconfirmed',
     Confirmed: 'confirmed',
     Failed: 'failed',
-    Partial: 'partial'
+    Partial: 'partial',
 };
 function instanceOfTransactionGroupEnum(value) {
     for (const key in exports.TransactionGroupEnum) {

package/cjs/api/models/TransactionHashes.d.ts

@@ -17,15 +17,13 @@
 export interface TransactionHashes {
     /**
      * Array of transaction hashes.
-     * @type {Array<string>}
-     * @memberof TransactionHashes
      */
     hashes: Array<string>;
 }
 /**
  * Check if a given object implements the TransactionHashes interface.
  */
-export declare function instanceOfTransactionHashes(value: Record<string, any>): value is TransactionHashes;
+export declare function instanceOfTransactionHashes(value: object): value is TransactionHashes;
 export declare function TransactionHashesFromJSON(json: any): TransactionHashes;
 export declare function TransactionHashesFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionHashes;
 export declare function TransactionHashesToJSON(json: any): TransactionHashes;

package/cjs/api/models/TransactionIds.d.ts

@@ -17,15 +17,13 @@
 export interface TransactionIds {
     /**
      * Array of transaction IDs or transaction hashes.
-     * @type {Array<string>}
-     * @memberof TransactionIds
      */
     transactionIds: Array<string>;
 }
 /**
  * Check if a given object implements the TransactionIds interface.
  */
-export declare function instanceOfTransactionIds(value: Record<string, any>): value is TransactionIds;
+export declare function instanceOfTransactionIds(value: object): value is TransactionIds;
 export declare function TransactionIdsFromJSON(json: any): TransactionIds;
 export declare function TransactionIdsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionIds;
 export declare function TransactionIdsToJSON(json: any): TransactionIds;

package/cjs/api/models/TransactionInfoDTO.d.ts

@@ -27,27 +27,21 @@ export interface TransactionInfoDTO {
      * 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 TransactionInfoDTO
      */
     id: string;
     /**
      *
-     * @type {TransactionInfoDTOMeta}
-     * @memberof TransactionInfoDTO
      */
     meta: TransactionInfoDTOMeta;
     /**
      *
-     * @type {TransactionInfoDTOTransaction}
-     * @memberof TransactionInfoDTO
      */
     transaction: TransactionInfoDTOTransaction;
 }
 /**
  * Check if a given object implements the TransactionInfoDTO interface.
  */
-export declare function instanceOfTransactionInfoDTO(value: Record<string, any>): value is TransactionInfoDTO;
+export declare function instanceOfTransactionInfoDTO(value: object): value is TransactionInfoDTO;
 export declare function TransactionInfoDTOFromJSON(json: any): TransactionInfoDTO;
 export declare function TransactionInfoDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionInfoDTO;
 export declare function TransactionInfoDTOToJSON(json: any): TransactionInfoDTO;

package/cjs/api/models/TransactionInfoDTOMeta.d.ts

@@ -18,85 +18,48 @@
  */
 export interface TransactionInfoDTOMeta {
     /**
-     * Height of the block containing the referenced transaction or parent aggregate transaction.
-     * Returned as a decimal string. The value is `"0"` when the transaction is not included in a
-     * block yet, for example for unconfirmed transactions and partial aggregate transactions.
+     * Height of the block that contains the parent aggregate transaction.
+     * For embedded transactions returned from partial aggregate transactions, this value is `"0"`.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOMeta
      */
     height: string;
     /**
-     * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOMeta
+     * Hash of the top-level transaction.
      */
     hash: string;
     /**
-     * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOMeta
+     * Merkle component hash of the top-level transaction used in block transaction proofs.
+     * For unconfirmed top-level transactions, this value matches `hash`.
+     *
      */
     merkleComponentHash: string;
     /**
      * Embedded transaction index within the parent aggregate transaction.
-     * @type {number}
-     * @memberof TransactionInfoDTOMeta
      */
     index: number;
     /**
-     * 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).
+     * Timestamp of the block that contains the parent aggregate transaction,
+     * in milliseconds since the creation of the nemesis (first) block.
      *
-     * **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 TransactionInfoDTOMeta
      */
     timestamp?: string;
     /**
-     * Fee multiplier applied to the size of a transaction to obtain its fee, in
-     * [absolute units](https://docs.symbol.dev/concepts/mosaic.html#divisibility).
-     * Set by the harvester when creating a block; stored in the block header.
-     *
-     * The effective fee for a transaction is:
-     *
-     * `effectiveFee = transaction.size × block.feeMultiplier`
-     *
-     * Node owners can configure the fee multiplier to any non-negative value (including zero).
-     * For transaction senders, the median fee multiplier over recent blocks is available
-     * via `/network/fees/transaction`; using `medianFeeMultiplier` or higher
-     * improves chances of inclusion. See the [fees documentation](https://docs.symbol.dev/concepts/fees.html).
-     *
-     * @type {number}
-     * @memberof TransactionInfoDTOMeta
+     * Fee multiplier of the block that contains the parent aggregate transaction.
      */
     feeMultiplier?: number;
     /**
-     * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOMeta
+     * Hash of the parent aggregate transaction.
      */
     aggregateHash: string;
     /**
-     * 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 TransactionInfoDTOMeta
+     * Database record ID of the parent aggregate transaction.
      */
     aggregateId: string;
 }
 /**
  * Check if a given object implements the TransactionInfoDTOMeta interface.
  */
-export declare function instanceOfTransactionInfoDTOMeta(value: Record<string, any>): value is TransactionInfoDTOMeta;
+export declare function instanceOfTransactionInfoDTOMeta(value: object): value is TransactionInfoDTOMeta;
 export declare function TransactionInfoDTOMetaFromJSON(json: any): TransactionInfoDTOMeta;
 export declare function TransactionInfoDTOMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionInfoDTOMeta;
 export declare function TransactionInfoDTOMetaToJSON(json: any): TransactionInfoDTOMeta;