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

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

@@ -31,11 +31,9 @@ import type { NamespaceRegistrationTypeEnum } from './NamespaceRegistrationTypeE
  */
 export interface TransactionInfoDTOTransaction {
     /**
-     * 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 TransactionInfoDTOTransaction
      */
     size: number;
     /**
@@ -43,70 +41,40 @@ export interface TransactionInfoDTOTransaction {
      * over the serialized entity payload. Can be verified with the signer's public key (`signerPublicKey`).
      * Used for blocks, transactions, and cosignatures.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     signature: string;
     /**
-     * 256-bit public key encoded as a hexadecimal string (64 hex characters).
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
+     * 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 TransactionInfoDTOTransaction
      */
     version: number;
     /**
      * Network type (mainnet or testnet). Ensures the entity targets the correct network.
-     * @type {NetworkTypeEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     network: NetworkTypeEnum;
     /**
      * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema.
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     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 TransactionInfoDTOTransaction
+     * 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).
+     * 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.
      *
-     * **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 TransactionInfoDTOTransaction
      */
     deadline: string;
     /**
      * 32-byte voting public key used for finalization voting.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     linkedPublicKey: string;
     /**
      *
-     * @type {LinkActionEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     linkAction: LinkActionEnum;
     /**
@@ -114,8 +82,6 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     startEpoch: number;
     /**
@@ -123,26 +89,18 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     endEpoch: number;
     /**
      * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     transactionsHash: string;
     /**
      * Array of transaction cosignatures.
-     * @type {Array<CosignatureDTO>}
-     * @memberof TransactionInfoDTOTransaction
      */
     cosignatures: Array<CosignatureDTO>;
     /**
      * Array of transactions initiated by different accounts.
-     * @type {Array<EmbeddedTransactionInfoDTO>}
-     * @memberof TransactionInfoDTOTransaction
      */
     transactions: Array<EmbeddedTransactionInfoDTO>;
     /**
@@ -150,8 +108,6 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     mosaicId: string;
     /**
@@ -160,20 +116,14 @@ export interface TransactionInfoDTOTransaction {
      * `123.456789` whole units. Encoded as a string to preserve precision, since the value
      * is an unsigned 64-bit integer.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     amount: string;
     /**
      * Duration expressed in number of blocks.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     duration: string;
     /**
      * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     hash: string;
     /**
@@ -181,26 +131,18 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     recipientAddress: string;
     /**
      * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     secret: string;
     /**
      *
-     * @type {LockHashAlgorithmEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     hashAlgorithm: LockHashAlgorithmEnum;
     /**
      * Proof data whose hash, using `hashAlgorithm`, must match `secret`.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     proof: string;
     /**
@@ -208,22 +150,16 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     targetAddress: string;
     /**
      * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     scopedMetadataKey: string;
     /**
      * Change in metadata value size, in bytes.
      * Positive values increase the stored value size, negative values decrease it.
      *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     valueSizeDelta: number;
     /**
@@ -232,8 +168,6 @@ export interface TransactionInfoDTOTransaction {
      * value size after applying the update. When the value shrinks, this is the previous stored value size
      * before truncation.
      *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     valueSize: number;
     /**
@@ -242,8 +176,6 @@ export interface TransactionInfoDTOTransaction {
      * When no previous value exists, it contains the new value.
      * When updating existing metadata, it contains the byte-wise XOR of the previous value and the new value.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     value: string;
     /**
@@ -251,8 +183,6 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     targetMosaicId: string;
     /**
@@ -260,8 +190,6 @@ export interface TransactionInfoDTOTransaction {
      * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
      * encoded as a 16-character hexadecimal string.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     targetNamespaceId: string;
     /**
@@ -269,16 +197,10 @@ export interface TransactionInfoDTOTransaction {
      * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
      * encoded as a 16-character hexadecimal string.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     id: string;
     /**
-     * Unsigned 32-bit integer.
-     * Represented as integer since it fits in JSON number precision.
-     *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
+     * Random nonce used to generate the mosaic ID.
      */
     nonce: number;
     /**
@@ -292,8 +214,6 @@ export interface TransactionInfoDTOTransaction {
      *
      * Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`.
      *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     flags: number;
     /**
@@ -301,8 +221,6 @@ export interface TransactionInfoDTOTransaction {
      * Divisibility of 3 means that a mosaic can be divided into smallest parts of 0.001 mosaics.
      * The divisibility must be in the range of 0 and 6.
      *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     divisibility: number;
     /**
@@ -311,14 +229,10 @@ export interface TransactionInfoDTOTransaction {
      * `123.456789` whole units. Encoded as a string to preserve precision, since the value
      * is an unsigned 64-bit integer.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     delta: string;
     /**
      *
-     * @type {MosaicSupplyChangeActionEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     action: MosaicSupplyChangeActionEnum;
     /**
@@ -326,8 +240,6 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     sourceAddress: string;
     /**
@@ -335,20 +247,14 @@ export interface TransactionInfoDTOTransaction {
      * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
      * encoded as a 16-character hexadecimal string.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     parentId?: string;
     /**
      *
-     * @type {NamespaceRegistrationTypeEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     registrationType: NamespaceRegistrationTypeEnum;
     /**
      * Namespace name.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     name: string;
     /**
@@ -356,22 +262,16 @@ export interface TransactionInfoDTOTransaction {
      * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
      * encoded as a 16-character hexadecimal string.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     namespaceId: 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 TransactionInfoDTOTransaction
      */
     address: string;
     /**
      *
-     * @type {AliasActionEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     aliasAction: AliasActionEnum;
     /**
@@ -379,8 +279,6 @@ export interface TransactionInfoDTOTransaction {
      * cosignatory. When converting a regular account into a multisig account, the initial value is
      * derived from this delta because the previous threshold is zero.
      *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     minRemovalDelta: number;
     /**
@@ -388,40 +286,28 @@ export interface TransactionInfoDTOTransaction {
      * transaction. When converting a regular account into a multisig account, the initial value is
      * derived from this delta because the previous threshold is zero.
      *
-     * @type {number}
-     * @memberof TransactionInfoDTOTransaction
      */
     minApprovalDelta: number;
     /**
      * Cosignatory addresses to add to the multisig account.
      * Newly added cosignatories must opt in by cosigning the aggregate transaction.
      *
-     * @type {Array<string>}
-     * @memberof TransactionInfoDTOTransaction
      */
     addressAdditions: Array<string>;
     /**
      * Cosignatory addresses to remove from the multisig account.
-     * @type {Array<string>}
-     * @memberof TransactionInfoDTOTransaction
      */
     addressDeletions: Array<string>;
     /**
      *
-     * @type {AccountRestrictionFlagsEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     restrictionFlags: AccountRestrictionFlagsEnum;
     /**
      * Account restriction additions.
-     * @type {Array<TransactionTypeEnum>}
-     * @memberof TransactionInfoDTOTransaction
      */
     restrictionAdditions: Array<TransactionTypeEnum>;
     /**
      * Account restriction deletions.
-     * @type {Array<TransactionTypeEnum>}
-     * @memberof TransactionInfoDTOTransaction
      */
     restrictionDeletions: Array<TransactionTypeEnum>;
     /**
@@ -429,14 +315,10 @@ export interface TransactionInfoDTOTransaction {
      * 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 TransactionInfoDTOTransaction
      */
     referenceMosaicId: string;
     /**
      * Restriction key represented as a 64-bit hexadecimal value.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     restrictionKey: string;
     /**
@@ -444,8 +326,6 @@ export interface TransactionInfoDTOTransaction {
      * For address restrictions, it is the value assigned to the target address;
      * for global restrictions, it is the threshold evaluated with the restriction type.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     previousRestrictionValue: string;
     /**
@@ -453,40 +333,30 @@ export interface TransactionInfoDTOTransaction {
      * For address restrictions, it is the value assigned to the target address;
      * for global restrictions, it is the threshold evaluated with the restriction type.
      *
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     newRestrictionValue: string;
     /**
      *
-     * @type {MosaicRestrictionTypeEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     previousRestrictionType: MosaicRestrictionTypeEnum;
     /**
      *
-     * @type {MosaicRestrictionTypeEnum}
-     * @memberof TransactionInfoDTOTransaction
      */
     newRestrictionType: MosaicRestrictionTypeEnum;
     /**
      * Array of mosaics sent to the recipient.
      *
-     * @type {Array<UnresolvedMosaic>}
-     * @memberof TransactionInfoDTOTransaction
      */
     mosaics: Array<UnresolvedMosaic>;
     /**
      * Optional transfer message payload, encoded as a hexadecimal string.
-     * @type {string}
-     * @memberof TransactionInfoDTOTransaction
      */
     message?: string;
 }
 /**
  * Check if a given object implements the TransactionInfoDTOTransaction interface.
  */
-export declare function instanceOfTransactionInfoDTOTransaction(value: Record<string, any>): value is TransactionInfoDTOTransaction;
+export declare function instanceOfTransactionInfoDTOTransaction(value: object): value is TransactionInfoDTOTransaction;
 export declare function TransactionInfoDTOTransactionFromJSON(json: any): TransactionInfoDTOTransaction;
 export declare function TransactionInfoDTOTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionInfoDTOTransaction;
 export declare function TransactionInfoDTOTransactionToJSON(json: any): TransactionInfoDTOTransaction;

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

@@ -28,72 +28,41 @@
  */
 export interface TransactionMetaDTO {
     /**
-     * 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.
-     *
-     * @type {string}
-     * @memberof TransactionMetaDTO
+     * Height of the block that contains the transaction. For unconfirmed top-level transactions, this value is `"0"`.
      */
     height: string;
     /**
-     * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionMetaDTO
+     * Hash of the top-level transaction.
      */
     hash: string;
     /**
-     * 256-bit hash encoded as a 64-character hexadecimal string.
-     * @type {string}
-     * @memberof TransactionMetaDTO
+     * Merkle component hash of the top-level transaction used in block transaction proofs.
+     * For unconfirmed top-level transactions, this value matches `hash`.
+     *
      */
     merkleComponentHash: string;
     /**
      * Transaction index within the block. For unconfirmed top-level transactions, this value is `0`.
      *
-     * @type {number}
-     * @memberof TransactionMetaDTO
      */
     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).
-     *
-     * **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.
+     * Timestamp of the block that contains the transaction, in milliseconds since the creation of the
+     * nemesis (first) block. This field is absent for unconfirmed top-level transactions.
      *
-     * @type {string}
-     * @memberof TransactionMetaDTO
      */
     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).
+     * Fee multiplier of the block that contains the transaction.
+     * This field is absent for unconfirmed top-level transactions.
      *
-     * @type {number}
-     * @memberof TransactionMetaDTO
      */
     feeMultiplier?: number;
 }
 /**
  * Check if a given object implements the TransactionMetaDTO interface.
  */
-export declare function instanceOfTransactionMetaDTO(value: Record<string, any>): value is TransactionMetaDTO;
+export declare function instanceOfTransactionMetaDTO(value: object): value is TransactionMetaDTO;
 export declare function TransactionMetaDTOFromJSON(json: any): TransactionMetaDTO;
 export declare function TransactionMetaDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionMetaDTO;
 export declare function TransactionMetaDTOToJSON(json: any): TransactionMetaDTO;

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

@@ -19,21 +19,17 @@ import type { TransactionInfoDTO } from './TransactionInfoDTO';
 export interface TransactionPage {
     /**
      * Array of transactions.
-     * @type {Array<TransactionInfoDTO>}
-     * @memberof TransactionPage
      */
     data: Array<TransactionInfoDTO>;
     /**
      *
-     * @type {Pagination}
-     * @memberof TransactionPage
      */
     pagination: Pagination;
 }
 /**
  * Check if a given object implements the TransactionPage interface.
  */
-export declare function instanceOfTransactionPage(value: Record<string, any>): value is TransactionPage;
+export declare function instanceOfTransactionPage(value: object): value is TransactionPage;
 export declare function TransactionPageFromJSON(json: any): TransactionPage;
 export declare function TransactionPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionPage;
 export declare function TransactionPageToJSON(json: any): TransactionPage;

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

@@ -20,15 +20,13 @@ export interface TransactionPayload {
      * Signed transaction payload encoded as a hexadecimal string.
      * To obtain this value, use your SDK's transaction serialization. See the announce endpoint description for more SDK links.
      *
-     * @type {string}
-     * @memberof TransactionPayload
      */
     payload: string;
 }
 /**
  * Check if a given object implements the TransactionPayload interface.
  */
-export declare function instanceOfTransactionPayload(value: Record<string, any>): value is TransactionPayload;
+export declare function instanceOfTransactionPayload(value: object): value is TransactionPayload;
 export declare function TransactionPayloadFromJSON(json: any): TransactionPayload;
 export declare function TransactionPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionPayload;
 export declare function TransactionPayloadToJSON(json: any): TransactionPayload;

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

@@ -18,30 +18,22 @@ import type { TransactionStatementDTOReceiptsInner } from './TransactionStatemen
  */
 export interface TransactionStatementDTO {
     /**
-     * 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 TransactionStatementDTO
+     * Height of the block that contains the statement.
      */
     height: string;
     /**
      *
-     * @type {SourceDTO}
-     * @memberof TransactionStatementDTO
      */
     source: SourceDTO;
     /**
      * Receipts emitted by the transaction source.
-     * @type {Array<TransactionStatementDTOReceiptsInner>}
-     * @memberof TransactionStatementDTO
      */
     receipts: Array<TransactionStatementDTOReceiptsInner>;
 }
 /**
  * Check if a given object implements the TransactionStatementDTO interface.
  */
-export declare function instanceOfTransactionStatementDTO(value: Record<string, any>): value is TransactionStatementDTO;
+export declare function instanceOfTransactionStatementDTO(value: object): value is TransactionStatementDTO;
 export declare function TransactionStatementDTOFromJSON(json: any): TransactionStatementDTO;
 export declare function TransactionStatementDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionStatementDTO;
 export declare function TransactionStatementDTOToJSON(json: any): TransactionStatementDTO;