/** * 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 { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * Account address restriction transaction body that updates the allowed or blocked address list. * @export * @interface AccountAddressRestrictionTransactionBodyDTO */ export interface AccountAddressRestrictionTransactionBodyDTO { /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountAddressRestrictionTransactionBodyDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof AccountAddressRestrictionTransactionBodyDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof AccountAddressRestrictionTransactionBodyDTO */ 'restrictionDeletions': Array; } /** * Transaction to prevent incoming and outgoing transactions for a given a set of addresses. * @export * @interface AccountAddressRestrictionTransactionDTO */ export interface AccountAddressRestrictionTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AccountAddressRestrictionTransactionDTO */ '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 AccountAddressRestrictionTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountAddressRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AccountAddressRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AccountAddressRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AccountAddressRestrictionTransactionDTO */ '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 AccountAddressRestrictionTransactionDTO */ '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 AccountAddressRestrictionTransactionDTO */ 'deadline': string; /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountAddressRestrictionTransactionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof AccountAddressRestrictionTransactionDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof AccountAddressRestrictionTransactionDTO */ 'restrictionDeletions': Array; } /** * Account state on the blockchain. Contains the public key, address, balances, importance score, and supplemental keys used for delegated harvesting and finalization. * @export * @interface AccountDTO */ export interface AccountDTO { /** * 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 AccountDTO */ '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 AccountDTO */ 'address': 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 AccountDTO */ 'addressHeight': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountDTO */ 'publicKey': 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 AccountDTO */ 'publicKeyHeight': string; /** * * @type {AccountTypeEnum} * @memberof AccountDTO */ 'accountType': AccountTypeEnum; /** * * @type {SupplementalPublicKeysDTO} * @memberof AccountDTO */ 'supplementalPublicKeys': SupplementalPublicKeysDTO; /** * Activity buckets used for importance score calculation. * @type {Array} * @memberof AccountDTO */ 'activityBuckets': Array; /** * Mosaic units owned by the account. * @type {Array} * @memberof AccountDTO */ 'mosaics': Array; /** * [Importance score](https://docs.symbol.dev/concepts/consensus-algorithm.html#importance-score) of an account, representing the probability of being selected to harvest the next block under the [PoS+](https://docs.symbol.dev/concepts/consensus-algorithm.html) consensus algorithm. The score is derived from three factors: stake, transaction activity, and node operation. Only accounts holding at least the minimum harvesting balance (`minHarvesterBalance` network property) receive a non-zero score. Decimal value between 0 and 1 (inclusive). Minimum: 0. Maximum: 1. * @type {string} * @memberof AccountDTO */ 'importance': 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 AccountDTO */ 'importanceHeight': string; } /** * Request body for batch account lookup. Provide either `publicKeys` or `addresses`, not both. At least one must be non-empty. * @export * @interface AccountIds */ export interface AccountIds { /** * Array of account public keys. * @type {Array} * @memberof AccountIds */ 'publicKeys'?: Array; /** * Array of account addresses. * @type {Array} * @memberof AccountIds */ 'addresses'?: Array; } /** * Account information including an internal resource identifier and the full account state. * @export * @interface AccountInfoDTO */ export interface AccountInfoDTO { /** * 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 AccountInfoDTO */ 'id': string; /** * * @type {AccountDTO} * @memberof AccountInfoDTO */ 'account': AccountDTO; } /** * * @export * @interface AccountKeyLinkNetworkPropertiesDTO */ export interface AccountKeyLinkNetworkPropertiesDTO { /** * to trigger plugin load * @type {string} * @memberof AccountKeyLinkNetworkPropertiesDTO */ 'dummy'?: string; } /** * Account key link transaction body that links or unlinks a remote account public key. * @export * @interface AccountKeyLinkTransactionBodyDTO */ export interface AccountKeyLinkTransactionBodyDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountKeyLinkTransactionBodyDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof AccountKeyLinkTransactionBodyDTO */ 'linkAction': LinkActionEnum; } /** * Transaction to delegate the account importance score to a proxy account. Required for all accounts willing to activate delegated harvesting. * @export * @interface AccountKeyLinkTransactionDTO */ export interface AccountKeyLinkTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AccountKeyLinkTransactionDTO */ '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 AccountKeyLinkTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountKeyLinkTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AccountKeyLinkTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AccountKeyLinkTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AccountKeyLinkTransactionDTO */ '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 AccountKeyLinkTransactionDTO */ '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 AccountKeyLinkTransactionDTO */ 'deadline': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountKeyLinkTransactionDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof AccountKeyLinkTransactionDTO */ 'linkAction': LinkActionEnum; } /** * Public key linked to the account for a supplemental role (linked, node, or VRF). * @export * @interface AccountLinkPublicKeyDTO */ export interface AccountLinkPublicKeyDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountLinkPublicKeyDTO */ 'publicKey': string; } /** * Voting key linked to the account, valid for a range of finalization epochs. * @export * @interface AccountLinkVotingKeyDTO */ export interface AccountLinkVotingKeyDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountLinkVotingKeyDTO */ 'publicKey': 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 AccountLinkVotingKeyDTO */ '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 AccountLinkVotingKeyDTO */ 'endEpoch': number; } /** * Set of voting keys linked to the account for finalization. * @export * @interface AccountLinkVotingKeysDTO */ export interface AccountLinkVotingKeysDTO { /** * Array of voting key link entries. * @type {Array} * @memberof AccountLinkVotingKeysDTO */ 'publicKeys': Array; } /** * Account metadata transaction body with the target account, metadata key, and metadata value update. * @export * @interface AccountMetadataTransactionBodyDTO */ export interface AccountMetadataTransactionBodyDTO { /** * 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 AccountMetadataTransactionBodyDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof AccountMetadataTransactionBodyDTO */ 'scopedMetadataKey': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof AccountMetadataTransactionBodyDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof AccountMetadataTransactionBodyDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 AccountMetadataTransactionBodyDTO */ 'value': string; } /** * Transaction to create or modify metadata attached to an account. * @export * @interface AccountMetadataTransactionDTO */ export interface AccountMetadataTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AccountMetadataTransactionDTO */ '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 AccountMetadataTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountMetadataTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AccountMetadataTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AccountMetadataTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AccountMetadataTransactionDTO */ '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 AccountMetadataTransactionDTO */ '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 AccountMetadataTransactionDTO */ 'deadline': string; /** * 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 AccountMetadataTransactionDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof AccountMetadataTransactionDTO */ 'scopedMetadataKey': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof AccountMetadataTransactionDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof AccountMetadataTransactionDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 AccountMetadataTransactionDTO */ 'value': string; } /** * Account mosaic restriction transaction body that updates the allowed or blocked mosaic ID list. * @export * @interface AccountMosaicRestrictionTransactionBodyDTO */ export interface AccountMosaicRestrictionTransactionBodyDTO { /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountMosaicRestrictionTransactionBodyDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof AccountMosaicRestrictionTransactionBodyDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof AccountMosaicRestrictionTransactionBodyDTO */ 'restrictionDeletions': Array; } /** * Transaction to prevent incoming transactions containing a given set of mosaics. * @export * @interface AccountMosaicRestrictionTransactionDTO */ export interface AccountMosaicRestrictionTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AccountMosaicRestrictionTransactionDTO */ '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 AccountMosaicRestrictionTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountMosaicRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AccountMosaicRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AccountMosaicRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AccountMosaicRestrictionTransactionDTO */ '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 AccountMosaicRestrictionTransactionDTO */ '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 AccountMosaicRestrictionTransactionDTO */ 'deadline': string; /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountMosaicRestrictionTransactionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof AccountMosaicRestrictionTransactionDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof AccountMosaicRestrictionTransactionDTO */ 'restrictionDeletions': Array; } /** * Resolved namespace names linked to a specific account address. * @export * @interface AccountNamesDTO */ export interface AccountNamesDTO { /** * 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 AccountNamesDTO */ 'address': string; /** * Namespace names currently linked to the account. * @type {Array} * @memberof AccountNamesDTO */ 'names': Array; } /** * Account operation restriction transaction body that updates the allowed or blocked transaction type list. * @export * @interface AccountOperationRestrictionTransactionBodyDTO */ export interface AccountOperationRestrictionTransactionBodyDTO { /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountOperationRestrictionTransactionBodyDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof AccountOperationRestrictionTransactionBodyDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof AccountOperationRestrictionTransactionBodyDTO */ 'restrictionDeletions': Array; } /** * Transaction to prevent outgoing transactions by transaction type. * @export * @interface AccountOperationRestrictionTransactionDTO */ export interface AccountOperationRestrictionTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AccountOperationRestrictionTransactionDTO */ '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 AccountOperationRestrictionTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AccountOperationRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AccountOperationRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AccountOperationRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AccountOperationRestrictionTransactionDTO */ '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 AccountOperationRestrictionTransactionDTO */ '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 AccountOperationRestrictionTransactionDTO */ 'deadline': string; /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountOperationRestrictionTransactionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof AccountOperationRestrictionTransactionDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof AccountOperationRestrictionTransactionDTO */ 'restrictionDeletions': Array; } /** * Account sort field: - `id`: sort by internal identifier. - `balance`: sort by mosaic balance. * @export * @enum {string} */ export declare const AccountOrderByEnum: { readonly Id: "id"; readonly Balance: "balance"; }; export type AccountOrderByEnum = typeof AccountOrderByEnum[keyof typeof AccountOrderByEnum]; /** * Paginated list of account information objects. * @export * @interface AccountPage */ export interface AccountPage { /** * Array of account information objects. * @type {Array} * @memberof AccountPage */ 'data': Array; /** * * @type {Pagination} * @memberof AccountPage */ 'pagination': Pagination; } /** * One account restriction rule consisting of restriction flags and the restricted values. * @export * @interface AccountRestrictionDTO */ export interface AccountRestrictionDTO { /** * * @type {AccountRestrictionFlagsEnum} * @memberof AccountRestrictionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Restricted values matched by this rule. The value type depends on `restrictionFlags` and can be an address, mosaic ID, or transaction type. * @type {Array} * @memberof AccountRestrictionDTO */ 'values': Array; } /** * * @export * @interface AccountRestrictionDTOValuesInner */ export interface AccountRestrictionDTOValuesInner { } /** * The value is a **bitwise OR** of protocol flags (one **restriction type**, then optional modifiers): - **Restriction type** (pick one): **Address** `0x0001`, **MosaicId** `0x0002`, **TransactionType** `0x0004`. - **Outgoing** `0x4000` (optional): restriction applies to transactions **from** this account; omit it for **incoming**. - **Block** `0x8000` (optional): **block** listed values; omit it for **allow** lists. **Example:** block outgoing transactions of a given type = `Block` + `Outgoing` + `TransactionType` -> `0x8000 | 0x4000 | 0x0004` = `0xC004` = **49156**. All values accepted on-chain (other OR combinations are rejected by the node): - `0x0001` (`1`): Allow only incoming transactions from a given address. - `0x0002` (`2`): Allow only incoming transactions containing a given mosaic ID. - `0x4001` (`16385`): Allow only outgoing transactions to a given address. - `0x4004` (`16388`): Allow only outgoing transactions with a given transaction type. - `0x8001` (`32769`): Block incoming transactions from a given address. - `0x8002` (`32770`): Block incoming transactions containing a given mosaic ID. - `0xC001` (`49153`): Block outgoing transactions to a given address. - `0xC004` (`49156`): Block outgoing transactions with a given transaction type. * @export * @enum {number} */ export declare const AccountRestrictionFlagsEnum: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_16385: 16385; readonly NUMBER_16388: 16388; readonly NUMBER_32769: 32769; readonly NUMBER_32770: 32770; readonly NUMBER_49153: 49153; readonly NUMBER_49156: 49156; }; export type AccountRestrictionFlagsEnum = typeof AccountRestrictionFlagsEnum[keyof typeof AccountRestrictionFlagsEnum]; /** * * @export * @interface AccountRestrictionNetworkPropertiesDTO */ export interface AccountRestrictionNetworkPropertiesDTO { /** * Maximum number of account restriction values. * @type {string} * @memberof AccountRestrictionNetworkPropertiesDTO */ 'maxAccountRestrictionValues'?: string; } /** * * @export * @interface AccountRestrictionsDTO */ export interface AccountRestrictionsDTO { /** * 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 AccountRestrictionsDTO */ '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 AccountRestrictionsDTO */ 'address': string; /** * * @type {Array} * @memberof AccountRestrictionsDTO */ 'restrictions': Array; } /** * Wrapper object containing one account restriction entry. * @export * @interface AccountRestrictionsInfoDTO */ export interface AccountRestrictionsInfoDTO { /** * * @type {AccountRestrictionsDTO} * @memberof AccountRestrictionsInfoDTO */ 'accountRestrictions': AccountRestrictionsDTO; } /** * Paginated response containing account restriction entries. * @export * @interface AccountRestrictionsPage */ export interface AccountRestrictionsPage { /** * Account restriction entries matching the requested filters. * @type {Array} * @memberof AccountRestrictionsPage */ 'data': Array; /** * * @type {Pagination} * @memberof AccountRestrictionsPage */ 'pagination': Pagination; } /** * Indicates the [harvesting](https://docs.symbol.dev/concepts/harvesting.html) delegation role of the account. When an account enables [remote](https://docs.symbol.dev/concepts/harvesting.html#remote-harvesting) or [delegated](https://docs.symbol.dev/concepts/harvesting.html#delegated-harvesting) harvesting, it links to a remote proxy account that signs blocks on its behalf. This field reflects which side of that relationship the account is on: - `0`: **Unlinked.** The account has no harvesting delegation relationship. - `1`: **Main.** Balance-holding account (harvester) that is linked to a remote proxy account. Importance score is calculated from this account\'s balance and activity. - `2`: **Remote.** Proxy account that signs blocks on behalf of a linked main account. It holds no funds; its sole purpose is to keep the main account\'s private key off the node. - `3`: **Remote unlinked.** An account that was previously used as a remote proxy but is currently not linked to any main account. * @export * @enum {number} */ export declare const AccountTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type AccountTypeEnum = typeof AccountTypeEnum[keyof typeof AccountTypeEnum]; /** * Collection of namespace name resolution results for account addresses. * @export * @interface AccountsNamesDTO */ export interface AccountsNamesDTO { /** * Array of namespace name entries resolved for the requested account addresses. * @type {Array} * @memberof AccountsNamesDTO */ 'accountNames': Array; } /** * Supplementary data stored for [importance](https://docs.symbol.dev/concepts/consensus-algorithm.html#importance-calculation) recalculation under the PoS+ consensus algorithm. At the end of each importance period (defined by the `importanceGrouping` network property) the working bucket is finalized, existing buckets are shifted, and a new working bucket is created. Each bucket influences at most five importance recalculations. * @export * @interface ActivityBucketDTO */ export interface ActivityBucketDTO { /** * 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 ActivityBucketDTO */ 'startHeight': 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 ActivityBucketDTO */ 'totalFeesPaid': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof ActivityBucketDTO */ 'beneficiaryCount': number; /** * [Importance score](https://docs.symbol.dev/concepts/consensus-algorithm.html#importance-score) of an account, representing the probability of being selected to harvest the next block under the [PoS+](https://docs.symbol.dev/concepts/consensus-algorithm.html) consensus algorithm. The score is derived from three factors: stake, transaction activity, and node operation. Only accounts holding at least the minimum harvesting balance (`minHarvesterBalance` network property) receive a non-zero score. Decimal value between 0 and 1 (inclusive). Minimum: 0. Maximum: 1. * @type {string} * @memberof ActivityBucketDTO */ 'rawScore': string; } /** * Address alias transaction body that links or unlinks a namespace to an address. * @export * @interface AddressAliasTransactionBodyDTO */ export interface AddressAliasTransactionBodyDTO { /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 AddressAliasTransactionBodyDTO */ '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 AddressAliasTransactionBodyDTO */ 'address': string; /** * * @type {AliasActionEnum} * @memberof AddressAliasTransactionBodyDTO */ 'aliasAction': AliasActionEnum; } /** * Transaction to link a namespace to an account. * @export * @interface AddressAliasTransactionDTO */ export interface AddressAliasTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AddressAliasTransactionDTO */ '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 AddressAliasTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AddressAliasTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AddressAliasTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AddressAliasTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AddressAliasTransactionDTO */ '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 AddressAliasTransactionDTO */ '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 AddressAliasTransactionDTO */ 'deadline': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 AddressAliasTransactionDTO */ '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 AddressAliasTransactionDTO */ 'address': string; /** * * @type {AliasActionEnum} * @memberof AddressAliasTransactionDTO */ 'aliasAction': AliasActionEnum; } /** * Array payload used to submit account addresses in Base32 format. * @export * @interface Addresses */ export interface Addresses { /** * Array of addresses. * @type {Array} * @memberof Addresses */ 'addresses'?: Array; } /** * * @export * @interface AggregateNetworkPropertiesDTO */ export interface AggregateNetworkPropertiesDTO { /** * Maximum number of transactions per aggregate. * @type {string} * @memberof AggregateNetworkPropertiesDTO */ 'maxTransactionsPerAggregate'?: string; /** * Maximum number of cosignatures per aggregate. * @type {string} * @memberof AggregateNetworkPropertiesDTO */ 'maxCosignaturesPerAggregate'?: string; /** * Set to true if cosignatures must exactly match component signers. Set to false if cosignatures should be validated externally. * @type {boolean} * @memberof AggregateNetworkPropertiesDTO */ 'enableStrictCosignatureCheck'?: boolean; /** * Set to true if bonded aggregates should be allowed. Set to false if bonded aggregates should be rejected. * @type {boolean} * @memberof AggregateNetworkPropertiesDTO */ 'enableBondedAggregateSupport'?: boolean; /** * Maximum lifetime a bonded transaction can have before it expires. * @type {string} * @memberof AggregateNetworkPropertiesDTO */ 'maxBondedTransactionLifetime'?: string; } /** * Aggregate transaction body with the hash of embedded transactions and the cosignatures attached to the aggregate transaction. * @export * @interface AggregateTransactionBodyDTO */ export interface AggregateTransactionBodyDTO { /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof AggregateTransactionBodyDTO */ 'transactionsHash': string; /** * Array of transaction cosignatures. * @type {Array} * @memberof AggregateTransactionBodyDTO */ 'cosignatures': Array; } /** * Extended aggregate transaction body that, in addition to aggregate-level fields, also includes the embedded transactions contained in the aggregate. * @export * @interface AggregateTransactionBodyExtendedDTO */ export interface AggregateTransactionBodyExtendedDTO { /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof AggregateTransactionBodyExtendedDTO */ 'transactionsHash': string; /** * Array of transaction cosignatures. * @type {Array} * @memberof AggregateTransactionBodyExtendedDTO */ 'cosignatures': Array; /** * Array of transactions initiated by different accounts. * @type {Array} * @memberof AggregateTransactionBodyExtendedDTO */ 'transactions': Array; } /** * Transaction to combine multiple transactions together. * @export * @interface AggregateTransactionDTO */ export interface AggregateTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AggregateTransactionDTO */ '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 AggregateTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AggregateTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AggregateTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AggregateTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AggregateTransactionDTO */ '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 AggregateTransactionDTO */ '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 AggregateTransactionDTO */ 'deadline': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof AggregateTransactionDTO */ 'transactionsHash': string; /** * Array of transaction cosignatures. * @type {Array} * @memberof AggregateTransactionDTO */ 'cosignatures': Array; } /** * Transaction to combine multiple transactions together. * @export * @interface AggregateTransactionExtendedDTO */ export interface AggregateTransactionExtendedDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof AggregateTransactionExtendedDTO */ '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 AggregateTransactionExtendedDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof AggregateTransactionExtendedDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof AggregateTransactionExtendedDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof AggregateTransactionExtendedDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof AggregateTransactionExtendedDTO */ '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 AggregateTransactionExtendedDTO */ '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 AggregateTransactionExtendedDTO */ 'deadline': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof AggregateTransactionExtendedDTO */ 'transactionsHash': string; /** * Array of transaction cosignatures. * @type {Array} * @memberof AggregateTransactionExtendedDTO */ 'cosignatures': Array; /** * Array of transactions initiated by different accounts. * @type {Array} * @memberof AggregateTransactionExtendedDTO */ 'transactions': Array; } /** * Alias link action: - `0`: Unlink the namespace from the current address or mosaic. - `1`: Link the namespace to the specified address or mosaic. * @export * @enum {number} */ export declare const AliasActionEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type AliasActionEnum = typeof AliasActionEnum[keyof typeof AliasActionEnum]; /** * Alias currently linked to the namespace. Depending on `type`, the namespace either has no alias, points to a mosaic ID, or points to an account address. * @export * @interface AliasDTO */ export interface AliasDTO { /** * * @type {AliasTypeEnum} * @memberof AliasDTO */ 'type': AliasTypeEnum; /** * 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 AliasDTO */ 'mosaicId'?: 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 AliasDTO */ 'address'?: string; } /** * Type of alias currently linked to the namespace. A namespace can either have no alias assigned, point to a mosaic ID, or point to an account address. - 0: No alias is linked to the namespace. - 1: The namespace is linked to a mosaic ID and can be used as a mosaic alias. - 2: The namespace is linked to an account address and can be used as an address alias. * @export * @enum {number} */ export declare const AliasTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type AliasTypeEnum = typeof AliasTypeEnum[keyof typeof AliasTypeEnum]; /** * Informational response returned after a transaction announce request is accepted. This object does not contain the announced transaction payload or its final execution result. It only carries the node message associated with the announce request. Acceptance by a node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. In some cases the transaction can be dropped without any failure status being returned. Common causes include using a fee below the minimum accepted by that node or using a generation hash seed that does not match the target network. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @export * @interface AnnounceTransactionInfoDTO */ export interface AnnounceTransactionInfoDTO { /** * Human-readable message returned by the node for the announce request. * @type {string} * @memberof AnnounceTransactionInfoDTO */ 'message': string; } /** * Receipt emitted when transaction execution changes an account mosaic balance. For example, this receipt is emitted when harvesting rewards are credited to the harvester or beneficiary account. * @export * @interface BalanceChangeReceiptDTO */ export interface BalanceChangeReceiptDTO { /** * Version of the receipt format. * @type {number} * @memberof BalanceChangeReceiptDTO */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof BalanceChangeReceiptDTO */ 'type': ReceiptTypeEnum; /** * 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 BalanceChangeReceiptDTO */ '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 BalanceChangeReceiptDTO */ 'amount': 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 BalanceChangeReceiptDTO */ 'targetAddress': string; } /** * Receipt emitted when transaction execution transfers a mosaic balance between accounts. For example, this receipt is emitted when mosaic or namespace rental fees are paid. In that case, the sender address is the account registering the mosaic or namespace, and the recipient address is the configured rental fee sink address. * @export * @interface BalanceTransferReceiptDTO */ export interface BalanceTransferReceiptDTO { /** * Version of the receipt format. * @type {number} * @memberof BalanceTransferReceiptDTO */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof BalanceTransferReceiptDTO */ 'type': ReceiptTypeEnum; /** * 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 BalanceTransferReceiptDTO */ '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 BalanceTransferReceiptDTO */ 'amount': 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 BalanceTransferReceiptDTO */ 'senderAddress': 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 BalanceTransferReceiptDTO */ 'recipientAddress': string; } /** * Block header data. Contains the height, timestamp, difficulty, VRF proof, hashes linking to the previous block, transactions, receipts, and state, plus `feeMultiplier` and optional `beneficiaryAddress` (reward recipient). The harvester is identified by `signerPublicKey`. * @export * @interface BlockDTO */ export interface BlockDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof BlockDTO */ '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 BlockDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof BlockDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof BlockDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof BlockDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof BlockDTO */ 'type': number; /** * 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 BlockDTO */ 'height': 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 BlockDTO */ 'timestamp': string; /** * Block difficulty. Determines how hard it is to harvest a new block, based on previous blocks. The initial difficulty is 100\'000\'000\'000\'000 (1e14) and remains at this level as long as blocks are generated every `blockGenerationTargetTime` seconds (network property). When block generation times deviate from the target, the difficulty is adjusted dynamically in the range of 10\'000\'000\'000\'000 (1e13) to 100\'000\'000\'000\'000\'000 (1e15) to maintain the target block creation rate. See the [Technical Reference](https://symbol.github.io/symbol-technicalref/main.pdf) section 8.1. Represented as a string to preserve precision (unsigned 64-bit integer). * @type {string} * @memberof BlockDTO */ 'difficulty': string; /** * 32-byte (64 hex characters) VRF proof gamma. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof). The gamma value is the first component of the VRF output; it is combined with `proofScalar` and `proofVerificationHash` to form the complete verifiable proof. * @type {string} * @memberof BlockDTO */ 'proofGamma': string; /** * 16-byte (32 hex characters) VRF proof verification hash. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof), together with `proofGamma` and `proofScalar`. The harvester generates this proof using its VRF private key; the verification hash allows anyone with the VRF public key to verify that the proof was correctly computed without revealing the private key. * @type {string} * @memberof BlockDTO */ 'proofVerificationHash': string; /** * 32-byte (64 hex characters) VRF proof scalar. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof). The scalar proves that the gamma value was correctly derived from the VRF input without revealing the harvester\'s private key. * @type {string} * @memberof BlockDTO */ 'proofScalar': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockDTO */ 'previousBlockHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockDTO */ 'transactionsHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockDTO */ 'receiptsHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockDTO */ 'stateHash': 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 BlockDTO */ 'beneficiaryAddress': 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 BlockDTO */ 'feeMultiplier': number; } /** * Block information including an internal resource identifier, block metadata, and the full block header. * @export * @interface BlockInfoDTO */ export interface BlockInfoDTO { /** * 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 BlockInfoDTO */ 'id': string; /** * * @type {BlockMetaDTO} * @memberof BlockInfoDTO */ 'meta': BlockMetaDTO; /** * * @type {BlockInfoDTOBlock} * @memberof BlockInfoDTO */ 'block': BlockInfoDTOBlock; } /** * * @export * @interface BlockInfoDTOBlock */ export interface BlockInfoDTOBlock { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof BlockInfoDTOBlock */ '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 BlockInfoDTOBlock */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof BlockInfoDTOBlock */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof BlockInfoDTOBlock */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof BlockInfoDTOBlock */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof BlockInfoDTOBlock */ 'type': number; /** * 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 BlockInfoDTOBlock */ 'height': 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 BlockInfoDTOBlock */ 'timestamp': string; /** * Block difficulty. Determines how hard it is to harvest a new block, based on previous blocks. The initial difficulty is 100\'000\'000\'000\'000 (1e14) and remains at this level as long as blocks are generated every `blockGenerationTargetTime` seconds (network property). When block generation times deviate from the target, the difficulty is adjusted dynamically in the range of 10\'000\'000\'000\'000 (1e13) to 100\'000\'000\'000\'000\'000 (1e15) to maintain the target block creation rate. See the [Technical Reference](https://symbol.github.io/symbol-technicalref/main.pdf) section 8.1. Represented as a string to preserve precision (unsigned 64-bit integer). * @type {string} * @memberof BlockInfoDTOBlock */ 'difficulty': string; /** * 32-byte (64 hex characters) VRF proof gamma. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof). The gamma value is the first component of the VRF output; it is combined with `proofScalar` and `proofVerificationHash` to form the complete verifiable proof. * @type {string} * @memberof BlockInfoDTOBlock */ 'proofGamma': string; /** * 16-byte (32 hex characters) VRF proof verification hash. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof), together with `proofGamma` and `proofScalar`. The harvester generates this proof using its VRF private key; the verification hash allows anyone with the VRF public key to verify that the proof was correctly computed without revealing the private key. * @type {string} * @memberof BlockInfoDTOBlock */ 'proofVerificationHash': string; /** * 32-byte (64 hex characters) VRF proof scalar. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof). The scalar proves that the gamma value was correctly derived from the VRF input without revealing the harvester\'s private key. * @type {string} * @memberof BlockInfoDTOBlock */ 'proofScalar': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockInfoDTOBlock */ 'previousBlockHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockInfoDTOBlock */ 'transactionsHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockInfoDTOBlock */ 'receiptsHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockInfoDTOBlock */ 'stateHash': 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 BlockInfoDTOBlock */ 'beneficiaryAddress': 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 BlockInfoDTOBlock */ 'feeMultiplier': number; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof BlockInfoDTOBlock */ 'votingEligibleAccountsCount': number; /** * Unsigned 64-bit integer represented as a decimal string. Encoded as a string to preserve precision. * @type {string} * @memberof BlockInfoDTOBlock */ 'harvestingEligibleAccountsCount': 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 BlockInfoDTOBlock */ 'totalVotingBalance': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockInfoDTOBlock */ 'previousImportanceBlockHash': string; } /** * Block metadata including hash, total fee, generation hash, and transaction/statement counts. * @export * @interface BlockMetaDTO */ export interface BlockMetaDTO { /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockMetaDTO */ 'hash': 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 BlockMetaDTO */ 'totalFee': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockMetaDTO */ 'generationHash': string; /** * Merkle roots of each sub-cache at this block height. * @type {Array} * @memberof BlockMetaDTO */ 'stateHashSubCacheMerkleRoots': Array; /** * Total number of [transactions](https://docs.symbol.dev/concepts/transaction.html) confirmed in this block, including *embedded* transactions (i.e. transactions contained within aggregate transactions). * @type {number} * @memberof BlockMetaDTO */ 'totalTransactionsCount': number; /** * Number of [transactions](https://docs.symbol.dev/concepts/transaction.html) confirmed in this block. This does not count *embedded* transactions (i.e. transactions contained within aggregate transactions). * @type {number} * @memberof BlockMetaDTO */ 'transactionsCount': number; /** * Number of statements (of any kind) present in this block. Bear in mind that some of them (like [resolution statements](https://docs.symbol.dev/concepts/receipt.html#resolution-statement)) are triggered by transactions present in the block, but in general, [transaction statements](https://docs.symbol.dev/concepts/receipt.html#transaction-statement) are not. * @type {number} * @memberof BlockMetaDTO */ 'statementsCount': number; } /** * Block sort field: - `id`: sort by internal identifier. - `height`: sort by block height. * @export * @enum {string} */ export declare const BlockOrderByEnum: { readonly Id: "id"; readonly Height: "height"; }; export type BlockOrderByEnum = typeof BlockOrderByEnum[keyof typeof BlockOrderByEnum]; /** * Paginated list of block information objects. * @export * @interface BlockPage */ export interface BlockPage { /** * Array of block information objects. * @type {Array} * @memberof BlockPage */ 'data': Array; /** * * @type {Pagination} * @memberof BlockPage */ 'pagination': Pagination; } /** * Two-level Bellare-Miner (Bm) tree signature structure: root and bottom pairs, each containing a BLS (Boneh, Lynn and Shacham) public key and signature. Used in finalization voting to verify that signers are authentic. * @export * @interface BmTreeSignature */ export interface BmTreeSignature { /** * * @type {ParentPublicKeySignaturePair} * @memberof BmTreeSignature */ 'root': ParentPublicKeySignaturePair; /** * * @type {ParentPublicKeySignaturePair} * @memberof BmTreeSignature */ 'bottom': ParentPublicKeySignaturePair; } /** * 64-bit integer in the BSON Long shape produced by the MongoDB Node.js driver when serialized to JSON. * @export * @interface BsonLongDTO */ export interface BsonLongDTO { /** * Low 32 bits (signed 32-bit integer in the BSON representation). * @type {number} * @memberof BsonLongDTO */ 'low': number; /** * High 32 bits (signed 32-bit integer in the BSON representation). * @type {number} * @memberof BsonLongDTO */ 'high': number; /** * Whether the Long is treated as unsigned in the driver. * @type {boolean} * @memberof BsonLongDTO */ 'unsigned': boolean; } /** * Chain state: block height, chain score, and the latest finalized block (most recent block made permanent; it will never be rolled back). The chain score is the sum of all block scores in the chain; each block contributes `difficulty − time elapsed since previous block`. Higher score = better chain. Used during synchronization to select the canonical chain when forks exist. * @export * @interface ChainInfoDTO */ export interface ChainInfoDTO { /** * 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 ChainInfoDTO */ 'height': string; /** * 64-bit part of the full 128-bit chain score. The full score is `(scoreHigh << 64) + scoreLow`. Each block adds `difficulty − time elapsed since previous block`; the chain score is the sum. During synchronization, nodes select the chain with the highest score. * @type {string} * @memberof ChainInfoDTO */ 'scoreHigh': string; /** * 64-bit part of the full 128-bit chain score. The full score is `(scoreHigh << 64) + scoreLow`. Each block adds `difficulty − time elapsed since previous block`; the chain score is the sum. During synchronization, nodes select the chain with the highest score. * @type {string} * @memberof ChainInfoDTO */ 'scoreLow': string; /** * The most recent block that has been made permanent and will never be rolled back. See [finalization](https://docs.symbol.dev/concepts/block.html#finalization). * @type {FinalizedBlockDTO} * @memberof ChainInfoDTO */ 'latestFinalizedBlock': FinalizedBlockDTO; } /** * Chain related configuration properties. * @export * @interface ChainPropertiesDTO */ export interface ChainPropertiesDTO { /** * Set to true if block chain should calculate state hashes so that state is fully verifiable at each block. * @type {boolean} * @memberof ChainPropertiesDTO */ 'enableVerifiableState'?: boolean; /** * Set to true if block chain should calculate receipts so that state changes are fully verifiable at each block. * @type {boolean} * @memberof ChainPropertiesDTO */ 'enableVerifiableReceipts'?: boolean; /** * Mosaic ID used as primary chain currency. * @type {string} * @memberof ChainPropertiesDTO */ 'currencyMosaicId'?: string; /** * Mosaic ID used to provide harvesting ability. * @type {string} * @memberof ChainPropertiesDTO */ 'harvestingMosaicId'?: string; /** * Targeted time between blocks. * @type {string} * @memberof ChainPropertiesDTO */ 'blockGenerationTargetTime'?: string; /** * A higher value makes the network more biased. * @type {string} * @memberof ChainPropertiesDTO */ 'blockTimeSmoothingFactor'?: string; /** * Number of blocks between successive finalization attempts. * @type {string} * @memberof ChainPropertiesDTO */ 'blockFinalizationInterval'?: string; /** * Number of blocks that should be treated as a group for importance purposes. * @type {string} * @memberof ChainPropertiesDTO */ 'importanceGrouping'?: string; /** * Percentage of importance resulting from fee generation and beneficiary usage. * @type {string} * @memberof ChainPropertiesDTO */ 'importanceActivityPercentage'?: string; /** * Maximum number of blocks that can be rolled back. * @type {string} * @memberof ChainPropertiesDTO */ 'maxRollbackBlocks'?: string; /** * Maximum number of blocks to use in a difficulty calculation. * @type {string} * @memberof ChainPropertiesDTO */ 'maxDifficultyBlocks'?: string; /** * Default multiplier to use for dynamic fees. * @type {string} * @memberof ChainPropertiesDTO */ 'defaultDynamicFeeMultiplier'?: string; /** * Maximum lifetime a transaction can have before it expires. * @type {string} * @memberof ChainPropertiesDTO */ 'maxTransactionLifetime'?: string; /** * Maximum future time of a block that can be accepted. * @type {string} * @memberof ChainPropertiesDTO */ 'maxBlockFutureTime'?: string; /** * Initial currency atomic units available in the network. * @type {string} * @memberof ChainPropertiesDTO */ 'initialCurrencyAtomicUnits'?: string; /** * Maximum atomic units (total-supply * 10 ^ divisibility) of a mosaic allowed in the network. * @type {string} * @memberof ChainPropertiesDTO */ 'maxMosaicAtomicUnits'?: string; /** * Total whole importance units available in the network. * @type {string} * @memberof ChainPropertiesDTO */ 'totalChainImportance'?: string; /** * Minimum number of harvesting mosaic atomic units needed for an account to be eligible for harvesting. * @type {string} * @memberof ChainPropertiesDTO */ 'minHarvesterBalance'?: string; /** * Maximum number of harvesting mosaic atomic units needed for an account to be eligible for harvesting. * @type {string} * @memberof ChainPropertiesDTO */ 'maxHarvesterBalance'?: string; /** * Minimum number of harvesting mosaic atomic units needed for an account to be eligible for voting. * @type {string} * @memberof ChainPropertiesDTO */ 'minVoterBalance'?: string; /** * Number of blocks per finalization epoch (defines epoch duration for voting). * @type {string} * @memberof ChainPropertiesDTO */ 'votingSetGrouping'?: string; /** * Maximum number of voting keys that can be registered at once per account. * @type {string} * @memberof ChainPropertiesDTO */ 'maxVotingKeysPerAccount'?: string; /** * Minimum number of finalization rounds for which voting key can be registered. * @type {string} * @memberof ChainPropertiesDTO */ 'minVotingKeyLifetime'?: string; /** * Maximum number of finalization rounds for which voting key can be registered. * @type {string} * @memberof ChainPropertiesDTO */ 'maxVotingKeyLifetime'?: string; /** * Percentage of the harvested fee that is collected by the beneficiary account. * @type {string} * @memberof ChainPropertiesDTO */ 'harvestBeneficiaryPercentage'?: string; /** * Percentage of the harvested fee that is collected by the network. * @type {string} * @memberof ChainPropertiesDTO */ 'harvestNetworkPercentage'?: string; /** * Represents a unique account address in Base32 format. The first character indicates the network (`T` for testnet, `N` for mainnet). Addresses are 39 characters long, Base32-encoded, and include an embedded 3-byte checksum. The node validates this checksum, so an address with even a single altered character will be rejected. * @type {string} * @memberof ChainPropertiesDTO */ 'harvestNetworkFeeSinkAddressV1'?: string; /** * Represents a unique account address in Base32 format. The first character indicates the network (`T` for testnet, `N` for mainnet). Addresses are 39 characters long, Base32-encoded, and include an embedded 3-byte checksum. The node validates this checksum, so an address with even a single altered character will be rejected. * @type {string} * @memberof ChainPropertiesDTO */ 'harvestNetworkFeeSinkAddress'?: string; /** * Number of blocks between cache pruning. * @type {string} * @memberof ChainPropertiesDTO */ 'blockPruneInterval'?: string; /** * Maximum number of transactions per block. * @type {string} * @memberof ChainPropertiesDTO */ 'maxTransactionsPerBlock'?: string; } /** * Timestamps from the node\'s perspective for round-trip time calculation. Used when computing node time offset and transaction deadlines. The difference between them reflects node processing time and can vary with node load. * @export * @interface CommunicationTimestampsDTO */ export interface CommunicationTimestampsDTO { /** * 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 CommunicationTimestampsDTO */ 'sendTimestamp'?: 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 CommunicationTimestampsDTO */ 'receiveTimestamp'?: string; } /** * * @export * @interface CompositeHashes */ export interface CompositeHashes { /** * Array of composite hashes. * @type {Array} * @memberof CompositeHashes */ 'compositeHashes'?: Array; } /** * Wrapper object containing the detached cosignature fields required to cosign an aggregate bonded transaction. * @export * @interface Cosignature */ export interface Cosignature { /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof Cosignature */ 'parentHash': string; /** * 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 Cosignature */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof Cosignature */ 'signerPublicKey': string; /** * Version of a detached cosignature attached to an aggregate bonded transaction. Returned and submitted as a string because the value is encoded as an unsigned integer. * @type {string} * @memberof Cosignature */ 'version': string; } /** * * @export * @interface CosignatureDTO */ export interface CosignatureDTO { /** * 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 CosignatureDTO */ 'signature': string; /** * Version of a detached cosignature attached to an aggregate bonded transaction. Returned and submitted as a string because the value is encoded as an unsigned integer. * @type {string} * @memberof CosignatureDTO */ 'version': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof CosignatureDTO */ 'signerPublicKey': string; } /** * Deployment tool and version used to create/maintain the node; date of last upgrade. * @export * @interface DeploymentDTO */ export interface DeploymentDTO { /** * The tool used to create, maintain and deploy the node. * @type {string} * @memberof DeploymentDTO */ 'deploymentTool': string; /** * The version of the tool used to create, maintain and deploy the node. * @type {string} * @memberof DeploymentDTO */ 'deploymentToolVersion': string; /** * When was the node last upgraded. * @type {string} * @memberof DeploymentDTO */ 'lastUpdatedDate': string; } /** * Embedded transaction variant of `AccountAddressRestrictionTransactionDTO`. * @export * @interface EmbeddedAccountAddressRestrictionTransactionDTO */ export interface EmbeddedAccountAddressRestrictionTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'type': number; /** * * @type {AccountRestrictionFlagsEnum} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof EmbeddedAccountAddressRestrictionTransactionDTO */ 'restrictionDeletions': Array; } /** * Embedded transaction variant of `AccountKeyLinkTransactionDTO`. * @export * @interface EmbeddedAccountKeyLinkTransactionDTO */ export interface EmbeddedAccountKeyLinkTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAccountKeyLinkTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedAccountKeyLinkTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedAccountKeyLinkTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedAccountKeyLinkTransactionDTO */ 'type': number; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAccountKeyLinkTransactionDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof EmbeddedAccountKeyLinkTransactionDTO */ 'linkAction': LinkActionEnum; } /** * Embedded transaction variant of `AccountMetadataTransactionDTO`. * @export * @interface EmbeddedAccountMetadataTransactionDTO */ export interface EmbeddedAccountMetadataTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'type': number; /** * 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 EmbeddedAccountMetadataTransactionDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'scopedMetadataKey': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof EmbeddedAccountMetadataTransactionDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 EmbeddedAccountMetadataTransactionDTO */ 'value': string; } /** * Embedded transaction variant of `AccountMosaicRestrictionTransactionDTO`. * @export * @interface EmbeddedAccountMosaicRestrictionTransactionDTO */ export interface EmbeddedAccountMosaicRestrictionTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'type': number; /** * * @type {AccountRestrictionFlagsEnum} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof EmbeddedAccountMosaicRestrictionTransactionDTO */ 'restrictionDeletions': Array; } /** * Embedded transaction variant of `AccountOperationRestrictionTransactionDTO`. * @export * @interface EmbeddedAccountOperationRestrictionTransactionDTO */ export interface EmbeddedAccountOperationRestrictionTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'type': number; /** * * @type {AccountRestrictionFlagsEnum} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof EmbeddedAccountOperationRestrictionTransactionDTO */ 'restrictionDeletions': Array; } /** * Embedded transaction variant of `AddressAliasTransactionDTO`. * @export * @interface EmbeddedAddressAliasTransactionDTO */ export interface EmbeddedAddressAliasTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedAddressAliasTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedAddressAliasTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedAddressAliasTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedAddressAliasTransactionDTO */ 'type': number; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedAddressAliasTransactionDTO */ '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 EmbeddedAddressAliasTransactionDTO */ 'address': string; /** * * @type {AliasActionEnum} * @memberof EmbeddedAddressAliasTransactionDTO */ 'aliasAction': AliasActionEnum; } /** * Embedded transaction variant of `HashLockTransactionDTO`. * @export * @interface EmbeddedHashLockTransactionDTO */ export interface EmbeddedHashLockTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedHashLockTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedHashLockTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedHashLockTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedHashLockTransactionDTO */ 'type': number; /** * 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 EmbeddedHashLockTransactionDTO */ '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 EmbeddedHashLockTransactionDTO */ 'amount': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof EmbeddedHashLockTransactionDTO */ 'duration': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof EmbeddedHashLockTransactionDTO */ 'hash': string; } /** * Embedded transaction variant of `MosaicAddressRestrictionTransactionDTO`. * @export * @interface EmbeddedMosaicAddressRestrictionTransactionDTO */ export interface EmbeddedMosaicAddressRestrictionTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicAddressRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicAddressRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicAddressRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicAddressRestrictionTransactionDTO */ 'type': number; /** * 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 EmbeddedMosaicAddressRestrictionTransactionDTO */ 'mosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof EmbeddedMosaicAddressRestrictionTransactionDTO */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 EmbeddedMosaicAddressRestrictionTransactionDTO */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 EmbeddedMosaicAddressRestrictionTransactionDTO */ 'newRestrictionValue': string; /** * 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 EmbeddedMosaicAddressRestrictionTransactionDTO */ 'targetAddress': string; } /** * Embedded transaction variant of `MosaicAliasTransactionDTO`. * @export * @interface EmbeddedMosaicAliasTransactionDTO */ export interface EmbeddedMosaicAliasTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicAliasTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicAliasTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicAliasTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicAliasTransactionDTO */ 'type': number; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedMosaicAliasTransactionDTO */ 'namespaceId': 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 EmbeddedMosaicAliasTransactionDTO */ 'mosaicId': string; /** * * @type {AliasActionEnum} * @memberof EmbeddedMosaicAliasTransactionDTO */ 'aliasAction': AliasActionEnum; } /** * Embedded transaction variant of `MosaicDefinitionTransactionDTO`. * @export * @interface EmbeddedMosaicDefinitionTransactionDTO */ export interface EmbeddedMosaicDefinitionTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'type': number; /** * 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 EmbeddedMosaicDefinitionTransactionDTO */ 'id': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'duration': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'nonce': number; /** * Mosaic flags bitmask. Individual values can be combined. - 0x00 (0 decimal): No flags present. - 0x01 (1 decimal, `supplyMutable`): Mosaic supply can be increased or decreased later. - 0x02 (2 decimal, `transferable`): Mosaic can be transferred between arbitrary accounts. When not set, it can only be transferred to and from the mosaic owner. - 0x04 (4 decimal, `restrictable`): Mosaic supports custom restrictions configured by the mosaic owner. - 0x08 (8 decimal, `revokable`): Mosaic creator can revoke balances from another account. Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`. * @type {number} * @memberof EmbeddedMosaicDefinitionTransactionDTO */ 'flags': number; /** * Determines up to what decimal place a mosaic can be divided. 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 EmbeddedMosaicDefinitionTransactionDTO */ 'divisibility': number; } /** * Embedded transaction variant of `MosaicGlobalRestrictionTransactionDTO`. * @export * @interface EmbeddedMosaicGlobalRestrictionTransactionDTO */ export interface EmbeddedMosaicGlobalRestrictionTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'type': number; /** * 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 EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'mosaicId': 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 EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'referenceMosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'newRestrictionValue': string; /** * * @type {MosaicRestrictionTypeEnum} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'previousRestrictionType': MosaicRestrictionTypeEnum; /** * * @type {MosaicRestrictionTypeEnum} * @memberof EmbeddedMosaicGlobalRestrictionTransactionDTO */ 'newRestrictionType': MosaicRestrictionTypeEnum; } /** * Embedded transaction variant of `MosaicMetadataTransactionDTO`. * @export * @interface EmbeddedMosaicMetadataTransactionDTO */ export interface EmbeddedMosaicMetadataTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'type': number; /** * 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 EmbeddedMosaicMetadataTransactionDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'scopedMetadataKey': 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 EmbeddedMosaicMetadataTransactionDTO */ 'targetMosaicId': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof EmbeddedMosaicMetadataTransactionDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 EmbeddedMosaicMetadataTransactionDTO */ 'value': string; } /** * Embedded transaction variant of `MosaicSupplyChangeTransactionDTO`. * @export * @interface EmbeddedMosaicSupplyChangeTransactionDTO */ export interface EmbeddedMosaicSupplyChangeTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicSupplyChangeTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicSupplyChangeTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicSupplyChangeTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicSupplyChangeTransactionDTO */ 'type': number; /** * 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 EmbeddedMosaicSupplyChangeTransactionDTO */ '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 EmbeddedMosaicSupplyChangeTransactionDTO */ 'delta': string; /** * * @type {MosaicSupplyChangeActionEnum} * @memberof EmbeddedMosaicSupplyChangeTransactionDTO */ 'action': MosaicSupplyChangeActionEnum; } /** * Embedded transaction variant of `MosaicSupplyRevocationTransactionDTO`. * @export * @interface EmbeddedMosaicSupplyRevocationTransactionDTO */ export interface EmbeddedMosaicSupplyRevocationTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMosaicSupplyRevocationTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMosaicSupplyRevocationTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMosaicSupplyRevocationTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMosaicSupplyRevocationTransactionDTO */ 'type': number; /** * 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 EmbeddedMosaicSupplyRevocationTransactionDTO */ 'sourceAddress': 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 EmbeddedMosaicSupplyRevocationTransactionDTO */ '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 EmbeddedMosaicSupplyRevocationTransactionDTO */ 'amount': string; } /** * Embedded transaction variant of `MultisigAccountModificationTransactionDTO`. * @export * @interface EmbeddedMultisigAccountModificationTransactionDTO */ export interface EmbeddedMultisigAccountModificationTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedMultisigAccountModificationTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedMultisigAccountModificationTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedMultisigAccountModificationTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedMultisigAccountModificationTransactionDTO */ 'type': number; /** * Relative change applied to the minimum number of cosignatory approvals required to remove a 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 EmbeddedMultisigAccountModificationTransactionDTO */ 'minRemovalDelta': number; /** * Relative change applied to the minimum number of cosignatory approvals required to approve a 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 EmbeddedMultisigAccountModificationTransactionDTO */ 'minApprovalDelta': number; /** * Cosignatory addresses to add to the multisig account. Newly added cosignatories must opt in by cosigning the aggregate transaction. * @type {Array} * @memberof EmbeddedMultisigAccountModificationTransactionDTO */ 'addressAdditions': Array; /** * Cosignatory addresses to remove from the multisig account. * @type {Array} * @memberof EmbeddedMultisigAccountModificationTransactionDTO */ 'addressDeletions': Array; } /** * Embedded transaction variant of `NamespaceMetadataTransactionDTO`. * @export * @interface EmbeddedNamespaceMetadataTransactionDTO */ export interface EmbeddedNamespaceMetadataTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'type': number; /** * 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 EmbeddedNamespaceMetadataTransactionDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'scopedMetadataKey': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedNamespaceMetadataTransactionDTO */ 'targetNamespaceId': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof EmbeddedNamespaceMetadataTransactionDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 EmbeddedNamespaceMetadataTransactionDTO */ 'value': string; } /** * Embedded transaction variant of `NamespaceRegistrationTransactionDTO`. * @export * @interface EmbeddedNamespaceRegistrationTransactionDTO */ export interface EmbeddedNamespaceRegistrationTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'type': number; /** * Duration expressed in number of blocks. * @type {string} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'duration'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedNamespaceRegistrationTransactionDTO */ 'parentId'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedNamespaceRegistrationTransactionDTO */ 'id': string; /** * * @type {NamespaceRegistrationTypeEnum} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'registrationType': NamespaceRegistrationTypeEnum; /** * Namespace name. * @type {string} * @memberof EmbeddedNamespaceRegistrationTransactionDTO */ 'name': string; } /** * Embedded transaction variant of `NodeKeyLinkTransactionDTO`. * @export * @interface EmbeddedNodeKeyLinkTransactionDTO */ export interface EmbeddedNodeKeyLinkTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedNodeKeyLinkTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedNodeKeyLinkTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedNodeKeyLinkTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedNodeKeyLinkTransactionDTO */ 'type': number; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedNodeKeyLinkTransactionDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof EmbeddedNodeKeyLinkTransactionDTO */ 'linkAction': LinkActionEnum; } /** * Embedded transaction variant of `SecretLockTransactionDTO`. * @export * @interface EmbeddedSecretLockTransactionDTO */ export interface EmbeddedSecretLockTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedSecretLockTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedSecretLockTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedSecretLockTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedSecretLockTransactionDTO */ 'type': number; /** * 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 EmbeddedSecretLockTransactionDTO */ 'recipientAddress': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof EmbeddedSecretLockTransactionDTO */ '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 EmbeddedSecretLockTransactionDTO */ '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 EmbeddedSecretLockTransactionDTO */ 'amount': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof EmbeddedSecretLockTransactionDTO */ 'duration': string; /** * * @type {LockHashAlgorithmEnum} * @memberof EmbeddedSecretLockTransactionDTO */ 'hashAlgorithm': LockHashAlgorithmEnum; } /** * Embedded transaction variant of `SecretProofTransactionDTO`. * @export * @interface EmbeddedSecretProofTransactionDTO */ export interface EmbeddedSecretProofTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedSecretProofTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedSecretProofTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedSecretProofTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedSecretProofTransactionDTO */ 'type': number; /** * 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 EmbeddedSecretProofTransactionDTO */ 'recipientAddress': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof EmbeddedSecretProofTransactionDTO */ 'secret': string; /** * * @type {LockHashAlgorithmEnum} * @memberof EmbeddedSecretProofTransactionDTO */ 'hashAlgorithm': LockHashAlgorithmEnum; /** * Proof data whose hash, using `hashAlgorithm`, must match `secret`. * @type {string} * @memberof EmbeddedSecretProofTransactionDTO */ 'proof': string; } /** * Wrapper for embedded transactions carried inside an aggregate transaction. * @export * @interface EmbeddedTransactionBodyDTO */ export interface EmbeddedTransactionBodyDTO { /** * Array of transactions initiated by different accounts. * @type {Array} * @memberof EmbeddedTransactionBodyDTO */ 'transactions': Array; } /** * Transaction payload embedded inside an aggregate transaction. * @export * @interface EmbeddedTransactionDTO */ export interface EmbeddedTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedTransactionDTO */ 'type': number; } /** * Embedded transaction record returned from aggregate transaction payloads. * @export * @interface EmbeddedTransactionInfoDTO */ export interface EmbeddedTransactionInfoDTO { /** * 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 EmbeddedTransactionInfoDTO */ 'id': string; /** * * @type {EmbeddedTransactionMetaDTO} * @memberof EmbeddedTransactionInfoDTO */ 'meta': EmbeddedTransactionMetaDTO; /** * * @type {EmbeddedTransactionInfoDTOTransaction} * @memberof EmbeddedTransactionInfoDTO */ 'transaction': EmbeddedTransactionInfoDTOTransaction; } /** * Concrete embedded transaction payload represented by one of the listed transaction DTOs. * @export * @interface EmbeddedTransactionInfoDTOTransaction */ export interface EmbeddedTransactionInfoDTOTransaction { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'type': number; /** * 32-byte voting public key used for finalization voting. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'linkAction': LinkActionEnum; /** * [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 EmbeddedTransactionInfoDTOTransaction */ '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 EmbeddedTransactionInfoDTOTransaction */ 'endEpoch': number; /** * 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 EmbeddedTransactionInfoDTOTransaction */ '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 EmbeddedTransactionInfoDTOTransaction */ 'amount': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'duration': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'hash': string; /** * 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 EmbeddedTransactionInfoDTOTransaction */ 'recipientAddress': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'secret': string; /** * * @type {LockHashAlgorithmEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'hashAlgorithm': LockHashAlgorithmEnum; /** * Proof data whose hash, using `hashAlgorithm`, must match `secret`. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'proof': string; /** * 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 EmbeddedTransactionInfoDTOTransaction */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'scopedMetadataKey': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 EmbeddedTransactionInfoDTOTransaction */ 'value': 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 EmbeddedTransactionInfoDTOTransaction */ 'targetMosaicId': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedTransactionInfoDTOTransaction */ 'targetNamespaceId': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedTransactionInfoDTOTransaction */ 'id': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'nonce': number; /** * Mosaic flags bitmask. Individual values can be combined. - 0x00 (0 decimal): No flags present. - 0x01 (1 decimal, `supplyMutable`): Mosaic supply can be increased or decreased later. - 0x02 (2 decimal, `transferable`): Mosaic can be transferred between arbitrary accounts. When not set, it can only be transferred to and from the mosaic owner. - 0x04 (4 decimal, `restrictable`): Mosaic supports custom restrictions configured by the mosaic owner. - 0x08 (8 decimal, `revokable`): Mosaic creator can revoke balances from another account. Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`. * @type {number} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'flags': number; /** * Determines up to what decimal place a mosaic can be divided. 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 EmbeddedTransactionInfoDTOTransaction */ 'divisibility': 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 EmbeddedTransactionInfoDTOTransaction */ 'delta': string; /** * * @type {MosaicSupplyChangeActionEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'action': MosaicSupplyChangeActionEnum; /** * 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 EmbeddedTransactionInfoDTOTransaction */ 'sourceAddress': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedTransactionInfoDTOTransaction */ 'parentId'?: string; /** * * @type {NamespaceRegistrationTypeEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'registrationType': NamespaceRegistrationTypeEnum; /** * Namespace name. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'name': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 EmbeddedTransactionInfoDTOTransaction */ '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 EmbeddedTransactionInfoDTOTransaction */ 'address': string; /** * * @type {AliasActionEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'aliasAction': AliasActionEnum; /** * Relative change applied to the minimum number of cosignatory approvals required to remove a 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 EmbeddedTransactionInfoDTOTransaction */ 'minRemovalDelta': number; /** * Relative change applied to the minimum number of cosignatory approvals required to approve a 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 EmbeddedTransactionInfoDTOTransaction */ 'minApprovalDelta': number; /** * Cosignatory addresses to add to the multisig account. Newly added cosignatories must opt in by cosigning the aggregate transaction. * @type {Array} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'addressAdditions': Array; /** * Cosignatory addresses to remove from the multisig account. * @type {Array} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'addressDeletions': Array; /** * * @type {AccountRestrictionFlagsEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'restrictionDeletions': Array; /** * 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 EmbeddedTransactionInfoDTOTransaction */ 'referenceMosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 EmbeddedTransactionInfoDTOTransaction */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 EmbeddedTransactionInfoDTOTransaction */ 'newRestrictionValue': string; /** * * @type {MosaicRestrictionTypeEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'previousRestrictionType': MosaicRestrictionTypeEnum; /** * * @type {MosaicRestrictionTypeEnum} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'newRestrictionType': MosaicRestrictionTypeEnum; /** * Array of mosaics sent to the recipient. * @type {Array} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'mosaics': Array; /** * Optional transfer message payload, encoded as a hexadecimal string. * @type {string} * @memberof EmbeddedTransactionInfoDTOTransaction */ 'message'?: string; } /** * Metadata for an embedded transaction entry returned by the transaction endpoints. These fields identify the parent aggregate transaction and the embedded transaction\'s position inside it. * @export * @interface EmbeddedTransactionMetaDTO */ export interface EmbeddedTransactionMetaDTO { /** * 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 EmbeddedTransactionMetaDTO */ 'height': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof EmbeddedTransactionMetaDTO */ '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 EmbeddedTransactionMetaDTO */ 'aggregateId': string; /** * Embedded transaction index within the parent aggregate transaction. * @type {number} * @memberof EmbeddedTransactionMetaDTO */ '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. * @type {string} * @memberof EmbeddedTransactionMetaDTO */ '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 EmbeddedTransactionMetaDTO */ 'feeMultiplier'?: number; } /** * Embedded transaction variant of `TransferTransactionDTO`. * @export * @interface EmbeddedTransferTransactionDTO */ export interface EmbeddedTransferTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedTransferTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedTransferTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedTransferTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedTransferTransactionDTO */ 'type': number; /** * 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 EmbeddedTransferTransactionDTO */ 'recipientAddress': string; /** * Array of mosaics sent to the recipient. * @type {Array} * @memberof EmbeddedTransferTransactionDTO */ 'mosaics': Array; /** * Optional transfer message payload, encoded as a hexadecimal string. * @type {string} * @memberof EmbeddedTransferTransactionDTO */ 'message'?: string; } /** * Embedded transaction variant of `VotingKeyLinkTransactionDTO`. * @export * @interface EmbeddedVotingKeyLinkTransactionDTO */ export interface EmbeddedVotingKeyLinkTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedVotingKeyLinkTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedVotingKeyLinkTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedVotingKeyLinkTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedVotingKeyLinkTransactionDTO */ 'type': number; /** * 32-byte voting public key used for finalization voting. * @type {string} * @memberof EmbeddedVotingKeyLinkTransactionDTO */ '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 EmbeddedVotingKeyLinkTransactionDTO */ '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 EmbeddedVotingKeyLinkTransactionDTO */ 'endEpoch': number; /** * * @type {LinkActionEnum} * @memberof EmbeddedVotingKeyLinkTransactionDTO */ 'linkAction': LinkActionEnum; } /** * Embedded transaction variant of `VrfKeyLinkTransactionDTO`. * @export * @interface EmbeddedVrfKeyLinkTransactionDTO */ export interface EmbeddedVrfKeyLinkTransactionDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedVrfKeyLinkTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EmbeddedVrfKeyLinkTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EmbeddedVrfKeyLinkTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EmbeddedVrfKeyLinkTransactionDTO */ 'type': number; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EmbeddedVrfKeyLinkTransactionDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof EmbeddedVrfKeyLinkTransactionDTO */ 'linkAction': LinkActionEnum; } /** * Base entity fields shared by blocks, transactions, and other on-chain entities. Extended by VerifiableEntityDTO (signature) and SizePrefixedEntityDTO (size). Used in BlockDTO, TransactionDTO, and EmbeddedTransactionDTO. * @export * @interface EntityDTO */ export interface EntityDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof EntityDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof EntityDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof EntityDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof EntityDTO */ 'type': number; } /** * Cryptographic proof that a block was finalized. Contains the finalized block identity (epoch, point, height, hash) and message groups (prevote, precommit, count) with BLS signatures. * @export * @interface FinalizationProofDTO */ export interface FinalizationProofDTO { /** * Proof format version. Incremented when the binary structure of the finalization proof changes. * @type {number} * @memberof FinalizationProofDTO */ 'version': 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 FinalizationProofDTO */ 'finalizationEpoch': number; /** * Finalization point within an epoch. Each [epoch](https://docs.symbol.dev/concepts/block.html#finalization) is divided into multiple points; blocks are finalized at specific points. * @type {number} * @memberof FinalizationProofDTO */ 'finalizationPoint': number; /** * 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 FinalizationProofDTO */ 'height': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof FinalizationProofDTO */ 'hash': string; /** * Message groups from the finalization voting process: prevote, precommit, and count stages. Each group contains block hashes and BLS signatures from the finalizers attesting to the vote. * @type {Array} * @memberof FinalizationProofDTO */ 'messageGroups': Array; } /** * A block that has been finalized. It is made permanent and irreversible. Contains the finalization epoch, point, block height, and hash. * @export * @interface FinalizedBlockDTO */ export interface FinalizedBlockDTO { /** * [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 FinalizedBlockDTO */ 'finalizationEpoch': number; /** * Finalization point within an epoch. Each [epoch](https://docs.symbol.dev/concepts/block.html#finalization) is divided into multiple points; blocks are finalized at specific points. * @type {number} * @memberof FinalizedBlockDTO */ 'finalizationPoint': number; /** * 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 FinalizedBlockDTO */ 'height': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof FinalizedBlockDTO */ 'hash': string; } /** * Block heights at which protocol changes (hard forks) took effect. Used during synchronization to apply correct validation rules for each block range. * @export * @interface ForkHeightsDTO */ export interface ForkHeightsDTO { /** * The block height from which Symbol correctly calculates the total voting balance for finalization by including only the stake of accounts with active voting keys registered for the current finalization epoch. More: https://hackmd.io/@syndicate/postmortem-140921. * @type {string} * @memberof ForkHeightsDTO */ 'totalVotingBalanceCalculationFix'?: string; /** * The block height of the Cyprus hard fork that implemented treasury reissuance according to the governance decision. More: https://hackmd.io/@syndicate/governance. * @type {string} * @memberof ForkHeightsDTO */ 'treasuryReissuance'?: string; /** * The block height from which nodes enforce strict validation of aggregate transaction hashes. Hashes must be computed from unpadded embedded transactions using the correct Merkle tree algorithm; legacy/buggy hash formats are rejected. More: https://hackmd.io/@syndicate/postmortem-251022. * @type {string} * @memberof ForkHeightsDTO */ 'strictAggregateTransactionHash'?: string; /** * Comma-separated list of block heights at which secret-lock uniqueness checks must be skipped during synchronization to reproduce historical (incorrect) chain behavior. More: https://thesymbolsyndicate.notion.site/april-2024-secret-locks-e3afb825d2ac4a029f88f74dfe6f02d8?pvs=74. * @type {string} * @memberof ForkHeightsDTO */ 'skipSecretLockUniquenessChecks'?: string; /** * Comma-separated list of block heights at which secret-lock expiration processing must be skipped during synchronization to reproduce historical (incorrect) chain behavior. More: https://thesymbolsyndicate.notion.site/april-2024-secret-locks-e3afb825d2ac4a029f88f74dfe6f02d8?pvs=74. * @type {string} * @memberof ForkHeightsDTO */ 'skipSecretLockExpirations'?: string; /** * Comma-separated list of block heights at which secret-lock expiration processing must be forcibly executed during synchronization to reproduce historical (incorrect) chain behavior. More: https://thesymbolsyndicate.notion.site/april-2024-secret-locks-e3afb825d2ac4a029f88f74dfe6f02d8?pvs=74. * @type {string} * @memberof ForkHeightsDTO */ 'forceSecretLockExpirations'?: string; /** * The block height from which Aggregate V3 transactions become mandatory and payloadSize is included in the aggregate transaction hash calculation, ensuring unique transaction hashes. More: https://thesymbolsyndicate.notion.site/post-mortem-october-25. * @type {string} * @memberof ForkHeightsDTO */ 'uniqueAggregateTransactionHash'?: string; } /** * Locked funds deposited before announcing an aggregate bonded transaction. If the aggregate bonded transaction is not completed before the lock expires, the locked funds are credited to the block harvester. * @export * @interface HashLockEntryDTO */ export interface HashLockEntryDTO { /** * 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 HashLockEntryDTO */ '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 HashLockEntryDTO */ '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 HashLockEntryDTO */ '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 HashLockEntryDTO */ '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 HashLockEntryDTO */ 'endHeight': string; /** * * @type {LockStatus} * @memberof HashLockEntryDTO */ 'status': LockStatus; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof HashLockEntryDTO */ 'hash': string; } /** * Wrapper object containing one hash lock entry and its identifier. * @export * @interface HashLockInfoDTO */ export interface HashLockInfoDTO { /** * 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 HashLockInfoDTO */ 'id': string; /** * * @type {HashLockEntryDTO} * @memberof HashLockInfoDTO */ 'lock': HashLockEntryDTO; } /** * * @export * @interface HashLockNetworkPropertiesDTO */ export interface HashLockNetworkPropertiesDTO { /** * Amount that has to be locked per aggregate in partial cache. * @type {string} * @memberof HashLockNetworkPropertiesDTO */ 'lockedFundsPerAggregate'?: string; /** * Maximum number of blocks for which a hash lock can exist. * @type {string} * @memberof HashLockNetworkPropertiesDTO */ 'maxHashLockDuration'?: string; } /** * Paginated response containing hash lock entries. * @export * @interface HashLockPage */ export interface HashLockPage { /** * Hash lock entries matching the requested filters. * @type {Array} * @memberof HashLockPage */ 'data': Array; /** * * @type {Pagination} * @memberof HashLockPage */ 'pagination': Pagination; } /** * Hash lock transaction body that locks mosaics as a prerequisite for announcing an aggregate bonded transaction. * @export * @interface HashLockTransactionBodyDTO */ export interface HashLockTransactionBodyDTO { /** * 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 HashLockTransactionBodyDTO */ '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 HashLockTransactionBodyDTO */ 'amount': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof HashLockTransactionBodyDTO */ 'duration': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof HashLockTransactionBodyDTO */ 'hash': string; } /** * Transaction to lock funds before sending an aggregate bonded transaction. * @export * @interface HashLockTransactionDTO */ export interface HashLockTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof HashLockTransactionDTO */ '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 HashLockTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof HashLockTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof HashLockTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof HashLockTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof HashLockTransactionDTO */ '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 HashLockTransactionDTO */ '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 HashLockTransactionDTO */ 'deadline': 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 HashLockTransactionDTO */ '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 HashLockTransactionDTO */ 'amount': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof HashLockTransactionDTO */ 'duration': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof HashLockTransactionDTO */ 'hash': string; } /** * Importance block extending the regular block header with additional fields related to importance recalculation and finalization voting eligibility. * @export * @interface ImportanceBlockDTO */ export interface ImportanceBlockDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof ImportanceBlockDTO */ '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 ImportanceBlockDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof ImportanceBlockDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof ImportanceBlockDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof ImportanceBlockDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof ImportanceBlockDTO */ 'type': number; /** * 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 ImportanceBlockDTO */ 'height': 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 ImportanceBlockDTO */ 'timestamp': string; /** * Block difficulty. Determines how hard it is to harvest a new block, based on previous blocks. The initial difficulty is 100\'000\'000\'000\'000 (1e14) and remains at this level as long as blocks are generated every `blockGenerationTargetTime` seconds (network property). When block generation times deviate from the target, the difficulty is adjusted dynamically in the range of 10\'000\'000\'000\'000 (1e13) to 100\'000\'000\'000\'000\'000 (1e15) to maintain the target block creation rate. See the [Technical Reference](https://symbol.github.io/symbol-technicalref/main.pdf) section 8.1. Represented as a string to preserve precision (unsigned 64-bit integer). * @type {string} * @memberof ImportanceBlockDTO */ 'difficulty': string; /** * 32-byte (64 hex characters) VRF proof gamma. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof). The gamma value is the first component of the VRF output; it is combined with `proofScalar` and `proofVerificationHash` to form the complete verifiable proof. * @type {string} * @memberof ImportanceBlockDTO */ 'proofGamma': string; /** * 16-byte (32 hex characters) VRF proof verification hash. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof), together with `proofGamma` and `proofScalar`. The harvester generates this proof using its VRF private key; the verification hash allows anyone with the VRF public key to verify that the proof was correctly computed without revealing the private key. * @type {string} * @memberof ImportanceBlockDTO */ 'proofVerificationHash': string; /** * 32-byte (64 hex characters) VRF proof scalar. Part of the block\'s [generation hash proof](https://docs.symbol.dev/concepts/block.html#header) (VrfProof). The scalar proves that the gamma value was correctly derived from the VRF input without revealing the harvester\'s private key. * @type {string} * @memberof ImportanceBlockDTO */ 'proofScalar': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof ImportanceBlockDTO */ 'previousBlockHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof ImportanceBlockDTO */ 'transactionsHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof ImportanceBlockDTO */ 'receiptsHash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof ImportanceBlockDTO */ 'stateHash': 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 ImportanceBlockDTO */ 'beneficiaryAddress': 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 ImportanceBlockDTO */ 'feeMultiplier': number; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof ImportanceBlockDTO */ 'votingEligibleAccountsCount': number; /** * Unsigned 64-bit integer represented as a decimal string. Encoded as a string to preserve precision. * @type {string} * @memberof ImportanceBlockDTO */ 'harvestingEligibleAccountsCount': 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 ImportanceBlockDTO */ 'totalVotingBalance': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof ImportanceBlockDTO */ 'previousImportanceBlockHash': string; } /** * Receipt emitted when new network currency mosaic units are created by inflation. * @export * @interface InflationReceiptDTO */ export interface InflationReceiptDTO { /** * Version of the receipt format. * @type {number} * @memberof InflationReceiptDTO */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof InflationReceiptDTO */ 'type': ReceiptTypeEnum; /** * 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 InflationReceiptDTO */ '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 InflationReceiptDTO */ 'amount': string; } /** * Link action: - `0`: Unlink key. - `1`: Link key. * @export * @enum {number} */ export declare const LinkActionEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type LinkActionEnum = typeof LinkActionEnum[keyof typeof LinkActionEnum]; /** * Hash algorithm used to derive the secret from the revealed proof in secret lock and secret proof transactions: - `0` (`SHA3_256`): proof hashed once with SHA3-256. - `1` (`HASH_160`): proof hashed with SHA-256 and then with RIPEMD-160, similar to Bitcoin `OP_HASH160`. - `2` (`HASH_256`): proof hashed twice with SHA-256, similar to Bitcoin `OP_HASH256`. * @export * @enum {number} */ export declare const LockHashAlgorithmEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type LockHashAlgorithmEnum = typeof LockHashAlgorithmEnum[keyof typeof LockHashAlgorithmEnum]; /** * Status of a hash lock or secret lock. - `0` (`UNUSED`): the lock is active and has not been consumed yet. - `1` (`USED`): the lock has already been consumed and is no longer active. * @export * @enum {number} */ export declare const LockStatus: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type LockStatus = typeof LockStatus[keyof typeof LockStatus]; /** * A single node in the Merkle proof path. Each item contains a hash and its position (left or right) relative to the proofHash being evaluated. * @export * @interface MerklePathItemDTO */ export interface MerklePathItemDTO { /** * * @type {PositionEnum} * @memberof MerklePathItemDTO */ 'position'?: PositionEnum; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MerklePathItemDTO */ 'hash'?: string; } /** * Merkle proof information containing the path items needed to recalculate the Merkle root. * @export * @interface MerkleProofInfoDTO */ export interface MerkleProofInfoDTO { /** * List of complementary Merkle path items needed to recalculate the Merkle root. * @type {Array} * @memberof MerkleProofInfoDTO */ 'merklePath'?: Array; } /** * The Merkle path information clients can use to prove the state of the given entity. * @export * @interface MerkleStateInfoDTO */ export interface MerkleStateInfoDTO { /** * Serialized Patricia Merkle tree in compact hex format, as returned by the server. Used for [state proofs](https://docs.symbol.dev/concepts/data-validation.html) to verify entity state (account, mosaic, metadata, etc.) without downloading the full ledger. See [Symbol Technical Reference](https://symbol.github.io/symbol-technicalref/main.pdf) chapter 4.3 for the tree structure specification. * @type {string} * @memberof MerkleStateInfoDTO */ 'raw': string; /** * Merkle tree parsed from Merkle tree raw. * @type {Array} * @memberof MerkleStateInfoDTO */ 'tree': Array; } /** * * @export * @interface MerkleStateInfoDTOTreeInner */ export interface MerkleStateInfoDTOTreeInner { /** * Node type (always leaf). * @type {MerkleTreeNodeTypeEnum} * @memberof MerkleStateInfoDTOTreeInner */ 'type': MerkleTreeNodeTypeEnum; /** * Full path (hex) from root to this leaf. * @type {string} * @memberof MerkleStateInfoDTOTreeInner */ 'path': string; /** * Compact-encoded path. * @type {string} * @memberof MerkleStateInfoDTOTreeInner */ 'encodedPath': string; /** * Number of nibbles in the path. * @type {number} * @memberof MerkleStateInfoDTOTreeInner */ 'nibbleCount': number; /** * Bitmask indicating which nibble slots (0 to 15) have child links. * @type {string} * @memberof MerkleStateInfoDTOTreeInner */ 'linkMask': string; /** * Child links (max 16, one per nibble). * @type {Array} * @memberof MerkleStateInfoDTOTreeInner */ 'links': Array; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MerkleStateInfoDTOTreeInner */ 'branchHash': string; /** * Leaf value (SHA3-256 hash of the entity state). * @type {string} * @memberof MerkleStateInfoDTOTreeInner */ 'value': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MerkleStateInfoDTOTreeInner */ 'leafHash': string; } /** * Internal node of a [Patricia Merkle tree](https://docs.symbol.dev/concepts/data-validation.html) used in state proofs. A branch has up to 16 child links (one per nibble 0 to F) and a path prefix. * @export * @interface MerkleTreeBranchDTO */ export interface MerkleTreeBranchDTO { /** * Node type (always branch). * @type {MerkleTreeNodeTypeEnum} * @memberof MerkleTreeBranchDTO */ 'type': MerkleTreeNodeTypeEnum; /** * Path prefix (hex) from root to this branch. * @type {string} * @memberof MerkleTreeBranchDTO */ 'path': string; /** * Compact-encoded path. * @type {string} * @memberof MerkleTreeBranchDTO */ 'encodedPath': string; /** * Number of nibbles in the path. * @type {number} * @memberof MerkleTreeBranchDTO */ 'nibbleCount': number; /** * Bitmask indicating which nibble slots (0 to 15) have child links. * @type {string} * @memberof MerkleTreeBranchDTO */ 'linkMask': string; /** * Child links (max 16, one per nibble). * @type {Array} * @memberof MerkleTreeBranchDTO */ 'links': Array; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MerkleTreeBranchDTO */ 'branchHash': string; } /** * Child link in a [Merkle tree branch](https://docs.symbol.dev/concepts/data-validation.html) node. Each link points to a child node (branch or leaf) via its hash. * @export * @interface MerkleTreeBranchLinkDTO */ export interface MerkleTreeBranchLinkDTO { /** * Nibble index (0 to 15) identifying this child slot (hex). * @type {string} * @memberof MerkleTreeBranchLinkDTO */ 'bit': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MerkleTreeBranchLinkDTO */ 'link': string; } /** * Terminal node of a [Patricia Merkle tree](https://docs.symbol.dev/concepts/data-validation.html) used in state proofs. A leaf stores the final path and the associated value (entity state hash). * @export * @interface MerkleTreeLeafDTO */ export interface MerkleTreeLeafDTO { /** * Node type (always leaf). * @type {MerkleTreeNodeTypeEnum} * @memberof MerkleTreeLeafDTO */ 'type': MerkleTreeNodeTypeEnum; /** * Full path (hex) from root to this leaf. * @type {string} * @memberof MerkleTreeLeafDTO */ 'path': string; /** * Compact-encoded path. * @type {string} * @memberof MerkleTreeLeafDTO */ 'encodedPath': string; /** * Number of nibbles in the path. * @type {number} * @memberof MerkleTreeLeafDTO */ 'nibbleCount': number; /** * Leaf value (SHA3-256 hash of the entity state). * @type {string} * @memberof MerkleTreeLeafDTO */ 'value': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MerkleTreeLeafDTO */ 'leafHash': string; } /** * Type of [Merkle tree](https://docs.symbol.dev/concepts/data-validation.html) node used in state proofs: - `0`: Branch node (internal node with child links). - `255`: Leaf node (terminal node with value). * @export * @enum {number} */ export declare const MerkleTreeNodeTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_255: 255; }; export type MerkleTreeNodeTypeEnum = typeof MerkleTreeNodeTypeEnum[keyof typeof MerkleTreeNodeTypeEnum]; /** * * @export * @interface MessageGroup */ export interface MessageGroup { /** * Finalization stage (prevote, precommit, or count). * @type {StageEnum} * @memberof MessageGroup */ 'stage': StageEnum; /** * 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 MessageGroup */ 'height': string; /** * Block hashes voted for at this stage. Ordered by height; the first hash corresponds to `height`, subsequent hashes to consecutive block heights. * @type {Array} * @memberof MessageGroup */ 'hashes': Array; /** * BLS aggregate signatures from the finalizer set attesting to the votes. Each entry contains `root` and `bottom` of the Bm tree. * @type {Array} * @memberof MessageGroup */ 'signatures': Array; } /** * Full on-chain metadata entry identified by a composite hash. * @export * @interface MetadataEntryDTO */ export interface MetadataEntryDTO { /** * 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 MetadataEntryDTO */ 'version': number; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MetadataEntryDTO */ 'compositeHash': 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 MetadataEntryDTO */ 'sourceAddress': 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 MetadataEntryDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof MetadataEntryDTO */ 'scopedMetadataKey': string; /** * * @type {MetadataEntryDTOTargetId} * @memberof MetadataEntryDTO */ 'targetId'?: MetadataEntryDTOTargetId; /** * * @type {MetadataTypeEnum} * @memberof MetadataEntryDTO */ 'metadataType': MetadataTypeEnum; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof MetadataEntryDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 MetadataEntryDTO */ 'value': string; } /** * Mosaic or namespace identifier for mosaic metadata or namespace metadata. For account metadata, this value is 0. * @export * @interface MetadataEntryDTOTargetId */ export interface MetadataEntryDTOTargetId { } /** * Metadata information including an internal resource identifier and the full metadata entry state. * @export * @interface MetadataInfoDTO */ export interface MetadataInfoDTO { /** * 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 MetadataInfoDTO */ 'id': string; /** * * @type {MetadataEntryDTO} * @memberof MetadataInfoDTO */ 'metadataEntry': MetadataEntryDTO; } /** * * @export * @interface MetadataNetworkPropertiesDTO */ export interface MetadataNetworkPropertiesDTO { /** * Maximum metadata value size. * @type {string} * @memberof MetadataNetworkPropertiesDTO */ 'maxValueSize'?: string; } /** * Paginated response containing metadata entries. * @export * @interface MetadataPage */ export interface MetadataPage { /** * Array of metadata entries. * @type {Array} * @memberof MetadataPage */ 'data': Array; /** * * @type {Pagination} * @memberof MetadataPage */ 'pagination': Pagination; } /** * Type of resource targeted by the metadata entry: - `0`: Account metadata - `1`: Mosaic metadata - `2`: Namespace metadata * @export * @enum {number} */ export declare const MetadataTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type MetadataTypeEnum = typeof MetadataTypeEnum[keyof typeof MetadataTypeEnum]; /** * Error response body returned for 4xx responses. Contains an error code identifier and a human-readable message. * @export * @interface ModelError */ export interface ModelError { /** * Error type identifier. Common values: - `InvalidContent`: malformed request body or unparsable content (HTTP 400). - `ResourceNotFound`: requested resource does not exist (HTTP 404). - `InvalidArgument`: required arguments missing or unacceptable (HTTP 409). * @type {string} * @memberof ModelError */ 'code': string; /** * Human-readable error description. May include the invalid value or resource identifier. * @type {string} * @memberof ModelError */ 'message': string; } /** * An instance of a [mosaic](https://docs.symbol.dev/concepts/mosaic.html) held by an account or transferred in a transaction. The amount is always expressed in the mosaic\'s smallest (atomic) unit. For example, if the mosaic has a divisibility of 6, an amount of `1000000` represents `1.000000` whole units. * @export * @interface Mosaic */ export interface Mosaic { /** * 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 Mosaic */ 'id': 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 Mosaic */ 'amount': string; } /** * * @export * @interface MosaicAddressRestrictionDTO */ export interface MosaicAddressRestrictionDTO { /** * 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 MosaicAddressRestrictionDTO */ 'id': string; /** * * @type {MosaicAddressRestrictionEntryWrapperDTO} * @memberof MosaicAddressRestrictionDTO */ 'mosaicRestrictionEntry': MosaicAddressRestrictionEntryWrapperDTO; } /** * Address-specific mosaic restriction value associated with a restriction key. * @export * @interface MosaicAddressRestrictionEntryDTO */ export interface MosaicAddressRestrictionEntryDTO { /** * Creator-defined 64-bit numeric identifier of a mosaic restriction, scoped to a mosaic. It can be derived from a human-readable name by hashing it, and is represented as a decimal string in stored restriction entries. * @type {string} * @memberof MosaicAddressRestrictionEntryDTO */ 'key': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicAddressRestrictionEntryDTO */ 'value': string; } /** * Wrapper object containing one mosaic address restriction entry. * @export * @interface MosaicAddressRestrictionEntryWrapperDTO */ export interface MosaicAddressRestrictionEntryWrapperDTO { /** * 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 MosaicAddressRestrictionEntryWrapperDTO */ 'version': number; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MosaicAddressRestrictionEntryWrapperDTO */ 'compositeHash': string; /** * * @type {MosaicRestrictionEntryTypeEnum} * @memberof MosaicAddressRestrictionEntryWrapperDTO */ 'entryType': MosaicRestrictionEntryTypeEnum; /** * 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 MosaicAddressRestrictionEntryWrapperDTO */ 'mosaicId': 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 MosaicAddressRestrictionEntryWrapperDTO */ 'targetAddress': string; /** * Address-specific restriction values associated with the mosaic and target address. * @type {Array} * @memberof MosaicAddressRestrictionEntryWrapperDTO */ 'restrictions': Array; } /** * Mosaic address restriction transaction body that sets a restriction value for a target address and key. * @export * @interface MosaicAddressRestrictionTransactionBodyDTO */ export interface MosaicAddressRestrictionTransactionBodyDTO { /** * 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 MosaicAddressRestrictionTransactionBodyDTO */ 'mosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof MosaicAddressRestrictionTransactionBodyDTO */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicAddressRestrictionTransactionBodyDTO */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicAddressRestrictionTransactionBodyDTO */ 'newRestrictionValue': string; /** * 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 MosaicAddressRestrictionTransactionBodyDTO */ 'targetAddress': string; } /** * Transaction to set a restriction rule to an address. * @export * @interface MosaicAddressRestrictionTransactionDTO */ export interface MosaicAddressRestrictionTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicAddressRestrictionTransactionDTO */ '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 MosaicAddressRestrictionTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicAddressRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicAddressRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicAddressRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicAddressRestrictionTransactionDTO */ '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 MosaicAddressRestrictionTransactionDTO */ '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 MosaicAddressRestrictionTransactionDTO */ 'deadline': 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 MosaicAddressRestrictionTransactionDTO */ 'mosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof MosaicAddressRestrictionTransactionDTO */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicAddressRestrictionTransactionDTO */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicAddressRestrictionTransactionDTO */ 'newRestrictionValue': string; /** * 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 MosaicAddressRestrictionTransactionDTO */ 'targetAddress': string; } /** * Mosaic alias transaction body that links or unlinks a namespace to a mosaic. * @export * @interface MosaicAliasTransactionBodyDTO */ export interface MosaicAliasTransactionBodyDTO { /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 MosaicAliasTransactionBodyDTO */ 'namespaceId': 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 MosaicAliasTransactionBodyDTO */ 'mosaicId': string; /** * * @type {AliasActionEnum} * @memberof MosaicAliasTransactionBodyDTO */ 'aliasAction': AliasActionEnum; } /** * Transaction to link a namespace to a mosaic. * @export * @interface MosaicAliasTransactionDTO */ export interface MosaicAliasTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicAliasTransactionDTO */ '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 MosaicAliasTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicAliasTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicAliasTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicAliasTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicAliasTransactionDTO */ '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 MosaicAliasTransactionDTO */ '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 MosaicAliasTransactionDTO */ 'deadline': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 MosaicAliasTransactionDTO */ 'namespaceId': 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 MosaicAliasTransactionDTO */ 'mosaicId': string; /** * * @type {AliasActionEnum} * @memberof MosaicAliasTransactionDTO */ 'aliasAction': AliasActionEnum; } /** * State information describing a mosaic definition. * @export * @interface MosaicDTO */ export interface MosaicDTO { /** * 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 MosaicDTO */ 'version': number; /** * 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 MosaicDTO */ 'id': 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 MosaicDTO */ 'supply': 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 MosaicDTO */ 'startHeight': 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 MosaicDTO */ 'ownerAddress': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicDTO */ 'revision': number; /** * Mosaic flags bitmask. Individual values can be combined. - 0x00 (0 decimal): No flags present. - 0x01 (1 decimal, `supplyMutable`): Mosaic supply can be increased or decreased later. - 0x02 (2 decimal, `transferable`): Mosaic can be transferred between arbitrary accounts. When not set, it can only be transferred to and from the mosaic owner. - 0x04 (4 decimal, `restrictable`): Mosaic supports custom restrictions configured by the mosaic owner. - 0x08 (8 decimal, `revokable`): Mosaic creator can revoke balances from another account. Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`. * @type {number} * @memberof MosaicDTO */ 'flags': number; /** * Determines up to what decimal place a mosaic can be divided. 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 MosaicDTO */ 'divisibility': number; /** * Duration expressed in number of blocks. * @type {string} * @memberof MosaicDTO */ 'duration': string; } /** * Mosaic definition transaction body with the mosaic ID inputs and immutable configuration values. * @export * @interface MosaicDefinitionTransactionBodyDTO */ export interface MosaicDefinitionTransactionBodyDTO { /** * 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 MosaicDefinitionTransactionBodyDTO */ 'id': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof MosaicDefinitionTransactionBodyDTO */ 'duration': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicDefinitionTransactionBodyDTO */ 'nonce': number; /** * Mosaic flags bitmask. Individual values can be combined. - 0x00 (0 decimal): No flags present. - 0x01 (1 decimal, `supplyMutable`): Mosaic supply can be increased or decreased later. - 0x02 (2 decimal, `transferable`): Mosaic can be transferred between arbitrary accounts. When not set, it can only be transferred to and from the mosaic owner. - 0x04 (4 decimal, `restrictable`): Mosaic supports custom restrictions configured by the mosaic owner. - 0x08 (8 decimal, `revokable`): Mosaic creator can revoke balances from another account. Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`. * @type {number} * @memberof MosaicDefinitionTransactionBodyDTO */ 'flags': number; /** * Determines up to what decimal place a mosaic can be divided. 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 MosaicDefinitionTransactionBodyDTO */ 'divisibility': number; } /** * Transaction to create a new mosaic. * @export * @interface MosaicDefinitionTransactionDTO */ export interface MosaicDefinitionTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicDefinitionTransactionDTO */ '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 MosaicDefinitionTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicDefinitionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicDefinitionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicDefinitionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicDefinitionTransactionDTO */ '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 MosaicDefinitionTransactionDTO */ '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 MosaicDefinitionTransactionDTO */ 'deadline': 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 MosaicDefinitionTransactionDTO */ 'id': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof MosaicDefinitionTransactionDTO */ 'duration': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicDefinitionTransactionDTO */ 'nonce': number; /** * Mosaic flags bitmask. Individual values can be combined. - 0x00 (0 decimal): No flags present. - 0x01 (1 decimal, `supplyMutable`): Mosaic supply can be increased or decreased later. - 0x02 (2 decimal, `transferable`): Mosaic can be transferred between arbitrary accounts. When not set, it can only be transferred to and from the mosaic owner. - 0x04 (4 decimal, `restrictable`): Mosaic supports custom restrictions configured by the mosaic owner. - 0x08 (8 decimal, `revokable`): Mosaic creator can revoke balances from another account. Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`. * @type {number} * @memberof MosaicDefinitionTransactionDTO */ 'flags': number; /** * Determines up to what decimal place a mosaic can be divided. 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 MosaicDefinitionTransactionDTO */ 'divisibility': number; } /** * Receipt emitted when a mosaic reaches the end of its lifetime and expires. * @export * @interface MosaicExpiryReceiptDTO */ export interface MosaicExpiryReceiptDTO { /** * Version of the receipt format. * @type {number} * @memberof MosaicExpiryReceiptDTO */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof MosaicExpiryReceiptDTO */ 'type': ReceiptTypeEnum; /** * 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 MosaicExpiryReceiptDTO */ 'artifactId': string; } /** * Wrapper object containing one mosaic global restriction entry and its identifier. * @export * @interface MosaicGlobalRestrictionDTO */ export interface MosaicGlobalRestrictionDTO { /** * 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 MosaicGlobalRestrictionDTO */ 'id': string; /** * * @type {MosaicGlobalRestrictionEntryWrapperDTO} * @memberof MosaicGlobalRestrictionDTO */ 'mosaicRestrictionEntry': MosaicGlobalRestrictionEntryWrapperDTO; } /** * Global mosaic restriction rule associated with a restriction key. * @export * @interface MosaicGlobalRestrictionEntryDTO */ export interface MosaicGlobalRestrictionEntryDTO { /** * Creator-defined 64-bit numeric identifier of a mosaic restriction, scoped to a mosaic. It can be derived from a human-readable name by hashing it, and is represented as a decimal string in stored restriction entries. * @type {string} * @memberof MosaicGlobalRestrictionEntryDTO */ 'key': string; /** * * @type {MosaicGlobalRestrictionEntryRestrictionDTO} * @memberof MosaicGlobalRestrictionEntryDTO */ 'restriction': MosaicGlobalRestrictionEntryRestrictionDTO; } /** * Rule definition for a global mosaic restriction key. * @export * @interface MosaicGlobalRestrictionEntryRestrictionDTO */ export interface MosaicGlobalRestrictionEntryRestrictionDTO { /** * 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 MosaicGlobalRestrictionEntryRestrictionDTO */ 'referenceMosaicId': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicGlobalRestrictionEntryRestrictionDTO */ 'restrictionValue': string; /** * * @type {MosaicRestrictionTypeEnum} * @memberof MosaicGlobalRestrictionEntryRestrictionDTO */ 'restrictionType': MosaicRestrictionTypeEnum; } /** * Wrapper object containing one mosaic global restriction entry. * @export * @interface MosaicGlobalRestrictionEntryWrapperDTO */ export interface MosaicGlobalRestrictionEntryWrapperDTO { /** * 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 MosaicGlobalRestrictionEntryWrapperDTO */ 'version': number; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MosaicGlobalRestrictionEntryWrapperDTO */ 'compositeHash': string; /** * * @type {MosaicRestrictionEntryTypeEnum} * @memberof MosaicGlobalRestrictionEntryWrapperDTO */ 'entryType': MosaicRestrictionEntryTypeEnum; /** * 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 MosaicGlobalRestrictionEntryWrapperDTO */ 'mosaicId': string; /** * Global restriction rules associated with the mosaic. * @type {Array} * @memberof MosaicGlobalRestrictionEntryWrapperDTO */ 'restrictions': Array; } /** * Mosaic global restriction transaction body that defines the rule and reference value for a restriction key. * @export * @interface MosaicGlobalRestrictionTransactionBodyDTO */ export interface MosaicGlobalRestrictionTransactionBodyDTO { /** * 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 MosaicGlobalRestrictionTransactionBodyDTO */ 'mosaicId': 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 MosaicGlobalRestrictionTransactionBodyDTO */ 'referenceMosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof MosaicGlobalRestrictionTransactionBodyDTO */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicGlobalRestrictionTransactionBodyDTO */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicGlobalRestrictionTransactionBodyDTO */ 'newRestrictionValue': string; /** * * @type {MosaicRestrictionTypeEnum} * @memberof MosaicGlobalRestrictionTransactionBodyDTO */ 'previousRestrictionType': MosaicRestrictionTypeEnum; /** * * @type {MosaicRestrictionTypeEnum} * @memberof MosaicGlobalRestrictionTransactionBodyDTO */ 'newRestrictionType': MosaicRestrictionTypeEnum; } /** * Transaction to set a network-wide restriction rule to a mosaic. * @export * @interface MosaicGlobalRestrictionTransactionDTO */ export interface MosaicGlobalRestrictionTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicGlobalRestrictionTransactionDTO */ '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 MosaicGlobalRestrictionTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicGlobalRestrictionTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicGlobalRestrictionTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicGlobalRestrictionTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicGlobalRestrictionTransactionDTO */ '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 MosaicGlobalRestrictionTransactionDTO */ '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 MosaicGlobalRestrictionTransactionDTO */ 'deadline': 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 MosaicGlobalRestrictionTransactionDTO */ 'mosaicId': 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 MosaicGlobalRestrictionTransactionDTO */ 'referenceMosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof MosaicGlobalRestrictionTransactionDTO */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicGlobalRestrictionTransactionDTO */ 'previousRestrictionValue': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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 MosaicGlobalRestrictionTransactionDTO */ 'newRestrictionValue': string; /** * * @type {MosaicRestrictionTypeEnum} * @memberof MosaicGlobalRestrictionTransactionDTO */ 'previousRestrictionType': MosaicRestrictionTypeEnum; /** * * @type {MosaicRestrictionTypeEnum} * @memberof MosaicGlobalRestrictionTransactionDTO */ 'newRestrictionType': MosaicRestrictionTypeEnum; } /** * Array payload used to submit mosaic identifiers. * @export * @interface MosaicIds */ export interface MosaicIds { /** * Array of mosaic identifiers. * @type {Array} * @memberof MosaicIds */ 'mosaicIds'?: Array; } /** * Mosaic information including an internal resource identifier and the full mosaic state. * @export * @interface MosaicInfoDTO */ export interface MosaicInfoDTO { /** * 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 MosaicInfoDTO */ 'id': string; /** * * @type {MosaicDTO} * @memberof MosaicInfoDTO */ 'mosaic': MosaicDTO; } /** * Mosaic metadata transaction body with the target mosaic, metadata key, and metadata value update. * @export * @interface MosaicMetadataTransactionBodyDTO */ export interface MosaicMetadataTransactionBodyDTO { /** * 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 MosaicMetadataTransactionBodyDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof MosaicMetadataTransactionBodyDTO */ 'scopedMetadataKey': 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 MosaicMetadataTransactionBodyDTO */ 'targetMosaicId': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof MosaicMetadataTransactionBodyDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof MosaicMetadataTransactionBodyDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 MosaicMetadataTransactionBodyDTO */ 'value': string; } /** * Transaction to create or modify metadata attached to a mosaic. * @export * @interface MosaicMetadataTransactionDTO */ export interface MosaicMetadataTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicMetadataTransactionDTO */ '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 MosaicMetadataTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicMetadataTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicMetadataTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicMetadataTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicMetadataTransactionDTO */ '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 MosaicMetadataTransactionDTO */ '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 MosaicMetadataTransactionDTO */ 'deadline': string; /** * 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 MosaicMetadataTransactionDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof MosaicMetadataTransactionDTO */ 'scopedMetadataKey': 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 MosaicMetadataTransactionDTO */ 'targetMosaicId': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof MosaicMetadataTransactionDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof MosaicMetadataTransactionDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 MosaicMetadataTransactionDTO */ 'value': string; } /** * Resolved namespace names linked to a specific mosaic identifier. An empty `names` array means no namespace aliases were resolved for that identifier. * @export * @interface MosaicNamesDTO */ export interface MosaicNamesDTO { /** * 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 MosaicNamesDTO */ 'mosaicId': string; /** * Namespace names currently linked to the mosaic identifier. * @type {Array} * @memberof MosaicNamesDTO */ 'names': Array; } /** * Mosaic plugin settings from network configuration (`/network/properties`). Values from Symbol mainnet. * @export * @interface MosaicNetworkPropertiesDTO */ export interface MosaicNetworkPropertiesDTO { /** * Maximum number of mosaics that an account can own. * @type {string} * @memberof MosaicNetworkPropertiesDTO */ 'maxMosaicsPerAccount'?: string; /** * Maximum mosaic duration (BlockSpan format, e.g. `3650d` for 3650 days). * @type {string} * @memberof MosaicNetworkPropertiesDTO */ 'maxMosaicDuration'?: string; /** * Maximum mosaic divisibility. * @type {string} * @memberof MosaicNetworkPropertiesDTO */ 'maxMosaicDivisibility'?: string; /** * Represents a unique account address in Base32 format. The first character indicates the network (`T` for testnet, `N` for mainnet). Addresses are 39 characters long, Base32-encoded, and include an embedded 3-byte checksum. The node validates this checksum, so an address with even a single altered character will be rejected. * @type {string} * @memberof MosaicNetworkPropertiesDTO */ 'mosaicRentalFeeSinkAddressV1'?: string; /** * Represents a unique account address in Base32 format. The first character indicates the network (`T` for testnet, `N` for mainnet). Addresses are 39 characters long, Base32-encoded, and include an embedded 3-byte checksum. The node validates this checksum, so an address with even a single altered character will be rejected. * @type {string} * @memberof MosaicNetworkPropertiesDTO */ 'mosaicRentalFeeSinkAddress'?: 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 MosaicNetworkPropertiesDTO */ 'mosaicRentalFee'?: string; } /** * Paginated list of mosaic information objects. * @export * @interface MosaicPage */ export interface MosaicPage { /** * Array of mosaic information objects. * @type {Array} * @memberof MosaicPage */ 'data': Array; /** * * @type {Pagination} * @memberof MosaicPage */ 'pagination': Pagination; } /** * Wrapper object containing one mosaic restriction entry, either a global restriction or an address restriction. * @export * @interface MosaicRestrictionDTO */ export interface MosaicRestrictionDTO { /** * 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 MosaicRestrictionDTO */ 'id': string; /** * * @type {MosaicGlobalRestrictionEntryWrapperDTO} * @memberof MosaicRestrictionDTO */ 'mosaicRestrictionEntry': MosaicGlobalRestrictionEntryWrapperDTO; } /** * Mosaic restriction entry type: - `0`: address restriction entry for a specific target account - `1`: global restriction entry defining the rule for the mosaic * @export * @enum {number} */ export declare const MosaicRestrictionEntryTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type MosaicRestrictionEntryTypeEnum = typeof MosaicRestrictionEntryTypeEnum[keyof typeof MosaicRestrictionEntryTypeEnum]; /** * * @export * @interface MosaicRestrictionNetworkPropertiesDTO */ export interface MosaicRestrictionNetworkPropertiesDTO { /** * Maximum number of mosaic restriction values. * @type {string} * @memberof MosaicRestrictionNetworkPropertiesDTO */ 'maxMosaicRestrictionValues'?: string; } /** * Comparison operator used to evaluate a mosaic global restriction rule. - `0` (`NONE`) - Uninitialized value indicating no restriction. - `1` (`EQ`) - Allow if the compared value is equal to the restriction value. - `2` (`NE`) - Allow if the compared value is not equal to the restriction value. - `3` (`LT`) - Allow if the compared value is less than the restriction value. - `4` (`LE`) - Allow if the compared value is less than or equal to the restriction value. - `5` (`GT`) - Allow if the compared value is greater than the restriction value. - `6` (`GE`) - Allow if the compared value is greater than or equal to the restriction value. * @export * @enum {number} */ export declare const MosaicRestrictionTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; readonly NUMBER_5: 5; readonly NUMBER_6: 6; }; export type MosaicRestrictionTypeEnum = typeof MosaicRestrictionTypeEnum[keyof typeof MosaicRestrictionTypeEnum]; /** * Paginated list of mosaic restriction entries. * @export * @interface MosaicRestrictionsPage */ export interface MosaicRestrictionsPage { /** * Array of mosaic restrictions. * @type {Array} * @memberof MosaicRestrictionsPage */ 'data': Array; /** * * @type {Pagination} * @memberof MosaicRestrictionsPage */ 'pagination': Pagination; } /** * * @export * @interface MosaicRestrictionsPageDataInner */ export interface MosaicRestrictionsPageDataInner { /** * 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 MosaicRestrictionsPageDataInner */ 'id': string; /** * * @type {MosaicGlobalRestrictionEntryWrapperDTO} * @memberof MosaicRestrictionsPageDataInner */ 'mosaicRestrictionEntry': MosaicGlobalRestrictionEntryWrapperDTO; } /** * Mosaic supply change action: - `0`: Decrease the mosaic supply. - `1`: Increase the mosaic supply. * @export * @enum {number} */ export declare const MosaicSupplyChangeActionEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type MosaicSupplyChangeActionEnum = typeof MosaicSupplyChangeActionEnum[keyof typeof MosaicSupplyChangeActionEnum]; /** * Mosaic supply change transaction body with the target mosaic, supply delta, and direction. * @export * @interface MosaicSupplyChangeTransactionBodyDTO */ export interface MosaicSupplyChangeTransactionBodyDTO { /** * 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 MosaicSupplyChangeTransactionBodyDTO */ '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 MosaicSupplyChangeTransactionBodyDTO */ 'delta': string; /** * * @type {MosaicSupplyChangeActionEnum} * @memberof MosaicSupplyChangeTransactionBodyDTO */ 'action': MosaicSupplyChangeActionEnum; } /** * Transaction to increase or decrease the supply of a mosaic. * @export * @interface MosaicSupplyChangeTransactionDTO */ export interface MosaicSupplyChangeTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicSupplyChangeTransactionDTO */ '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 MosaicSupplyChangeTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicSupplyChangeTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicSupplyChangeTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicSupplyChangeTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicSupplyChangeTransactionDTO */ '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 MosaicSupplyChangeTransactionDTO */ '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 MosaicSupplyChangeTransactionDTO */ 'deadline': 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 MosaicSupplyChangeTransactionDTO */ '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 MosaicSupplyChangeTransactionDTO */ 'delta': string; /** * * @type {MosaicSupplyChangeActionEnum} * @memberof MosaicSupplyChangeTransactionDTO */ 'action': MosaicSupplyChangeActionEnum; } /** * Mosaic supply revocation transaction body with the source account, mosaic, and revoked amount. * @export * @interface MosaicSupplyRevocationTransactionBodyDTO */ export interface MosaicSupplyRevocationTransactionBodyDTO { /** * 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 MosaicSupplyRevocationTransactionBodyDTO */ 'sourceAddress': 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 MosaicSupplyRevocationTransactionBodyDTO */ '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 MosaicSupplyRevocationTransactionBodyDTO */ 'amount': string; } /** * Transaction that allows the mosaic creator to revoke some balance from a user. * @export * @interface MosaicSupplyRevocationTransactionDTO */ export interface MosaicSupplyRevocationTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MosaicSupplyRevocationTransactionDTO */ '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 MosaicSupplyRevocationTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MosaicSupplyRevocationTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MosaicSupplyRevocationTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MosaicSupplyRevocationTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MosaicSupplyRevocationTransactionDTO */ '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 MosaicSupplyRevocationTransactionDTO */ '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 MosaicSupplyRevocationTransactionDTO */ 'deadline': string; /** * 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 MosaicSupplyRevocationTransactionDTO */ 'sourceAddress': 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 MosaicSupplyRevocationTransactionDTO */ '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 MosaicSupplyRevocationTransactionDTO */ 'amount': string; } /** * Collection of namespace name resolution results for mosaic identifiers. The response contains one entry per requested mosaic identifier and preserves the request order. * @export * @interface MosaicsNamesDTO */ export interface MosaicsNamesDTO { /** * Array of namespace name entries resolved for the requested mosaic identifiers in request order. * @type {Array} * @memberof MosaicsNamesDTO */ 'mosaicNames': Array; } /** * Multisig graph entries grouped by distance from the requested account. * @export * @interface MultisigAccountGraphInfoDTO */ export interface MultisigAccountGraphInfoDTO { /** * Relative graph level. `0` is the requested account, negative levels are multisig accounts for which the requested account acts as a cosignatory, and positive levels are multisig relationships reached through cosignatories. * @type {number} * @memberof MultisigAccountGraphInfoDTO */ 'level': number; /** * Multisig state entries discovered at this graph level. * @type {Array} * @memberof MultisigAccountGraphInfoDTO */ 'multisigEntries': Array; } /** * Multisig account information with the full multisig state. * @export * @interface MultisigAccountInfoDTO */ export interface MultisigAccountInfoDTO { /** * Full multisig state for the requested account. * @type {MultisigDTO} * @memberof MultisigAccountInfoDTO */ 'multisig': MultisigDTO; } /** * Multisig account modification transaction body with threshold deltas and cosignatory changes. * @export * @interface MultisigAccountModificationTransactionBodyDTO */ export interface MultisigAccountModificationTransactionBodyDTO { /** * Relative change applied to the minimum number of cosignatory approvals required to remove a 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 MultisigAccountModificationTransactionBodyDTO */ 'minRemovalDelta': number; /** * Relative change applied to the minimum number of cosignatory approvals required to approve a 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 MultisigAccountModificationTransactionBodyDTO */ 'minApprovalDelta': number; /** * Cosignatory addresses to add to the multisig account. Newly added cosignatories must opt in by cosigning the aggregate transaction. * @type {Array} * @memberof MultisigAccountModificationTransactionBodyDTO */ 'addressAdditions': Array; /** * Cosignatory addresses to remove from the multisig account. * @type {Array} * @memberof MultisigAccountModificationTransactionBodyDTO */ 'addressDeletions': Array; } /** * Transaction that converts a regular account into a multisig account or modifies an existing multisig account\'s thresholds and cosignatory set. * @export * @interface MultisigAccountModificationTransactionDTO */ export interface MultisigAccountModificationTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MultisigAccountModificationTransactionDTO */ '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 MultisigAccountModificationTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof MultisigAccountModificationTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof MultisigAccountModificationTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof MultisigAccountModificationTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof MultisigAccountModificationTransactionDTO */ '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 MultisigAccountModificationTransactionDTO */ '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 MultisigAccountModificationTransactionDTO */ 'deadline': string; /** * Relative change applied to the minimum number of cosignatory approvals required to remove a 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 MultisigAccountModificationTransactionDTO */ 'minRemovalDelta': number; /** * Relative change applied to the minimum number of cosignatory approvals required to approve a 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 MultisigAccountModificationTransactionDTO */ 'minApprovalDelta': number; /** * Cosignatory addresses to add to the multisig account. Newly added cosignatories must opt in by cosigning the aggregate transaction. * @type {Array} * @memberof MultisigAccountModificationTransactionDTO */ 'addressAdditions': Array; /** * Cosignatory addresses to remove from the multisig account. * @type {Array} * @memberof MultisigAccountModificationTransactionDTO */ 'addressDeletions': Array; } /** * Current multisig state of an account. * @export * @interface MultisigDTO */ export interface MultisigDTO { /** * 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 MultisigDTO */ '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 MultisigDTO */ 'accountAddress': string; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MultisigDTO */ 'minApproval': number; /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof MultisigDTO */ 'minRemoval': number; /** * Direct cosignatory addresses that manage this multisig account. * @type {Array} * @memberof MultisigDTO */ 'cosignatoryAddresses': Array; /** * Multisig account addresses where this account acts as a cosignatory. * @type {Array} * @memberof MultisigDTO */ 'multisigAddresses': Array; } /** * Network-level limits that constrain multisig account structure. * @export * @interface MultisigNetworkPropertiesDTO */ export interface MultisigNetworkPropertiesDTO { /** * Maximum multisig depth allowed by the network, measured as the longest cosignatory chain. A regular multisig account with only non-multisig cosignatories has depth `1`. If one of its cosignatories is itself a multisig account, the depth becomes `2`; one more nested multisig level makes it `3`. * @type {string} * @memberof MultisigNetworkPropertiesDTO */ 'maxMultisigDepth'?: string; /** * Maximum number of cosignatories that can directly manage a single multisig account. * @type {string} * @memberof MultisigNetworkPropertiesDTO */ 'maxCosignatoriesPerAccount'?: string; /** * Maximum number of multisig accounts that a single account can cosign. * @type {string} * @memberof MultisigNetworkPropertiesDTO */ 'maxCosignedAccountsPerAccount'?: string; } /** * State information describing a namespace and its alias configuration. * @export * @interface NamespaceDTO */ export interface NamespaceDTO { /** * 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 NamespaceDTO */ 'version': number; /** * * @type {NamespaceRegistrationTypeEnum} * @memberof NamespaceDTO */ 'registrationType': NamespaceRegistrationTypeEnum; /** * Number of levels present in the namespace path. This matches how many namespace IDs are defined across `level0`, `level1`, and `level2`. * @type {number} * @memberof NamespaceDTO */ 'depth': number; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceDTO */ 'level0': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceDTO */ 'level1'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceDTO */ 'level2'?: string; /** * * @type {AliasDTO} * @memberof NamespaceDTO */ 'alias': AliasDTO; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceDTO */ 'parentId': 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 NamespaceDTO */ 'ownerAddress': 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 NamespaceDTO */ 'startHeight': 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 NamespaceDTO */ 'endHeight': string; } /** * Receipt emitted when a namespace reaches the end of its lifetime and expires. * @export * @interface NamespaceExpiryReceiptDTO */ export interface NamespaceExpiryReceiptDTO { /** * Version of the receipt format. * @type {number} * @memberof NamespaceExpiryReceiptDTO */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof NamespaceExpiryReceiptDTO */ 'type': ReceiptTypeEnum; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceExpiryReceiptDTO */ 'artifactId': string; } /** * Array payload used to submit namespace identifiers. * @export * @interface NamespaceIds */ export interface NamespaceIds { /** * Array of namespace identifiers. * @type {Array} * @memberof NamespaceIds */ 'namespaceIds'?: Array; } /** * Namespace information including an internal resource identifier, metadata, and the full namespace state. * @export * @interface NamespaceInfoDTO */ export interface NamespaceInfoDTO { /** * 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 NamespaceInfoDTO */ 'id': string; /** * * @type {NamespaceMetaDTO} * @memberof NamespaceInfoDTO */ 'meta': NamespaceMetaDTO; /** * * @type {NamespaceDTO} * @memberof NamespaceInfoDTO */ 'namespace': NamespaceDTO; } /** * Metadata about the namespace entry. Includes whether the namespace is currently active and its internal ordering index. * @export * @interface NamespaceMetaDTO */ export interface NamespaceMetaDTO { /** * Indicates whether the namespace is currently active at the chain height used to serve the request. * @type {boolean} * @memberof NamespaceMetaDTO */ 'active': boolean; /** * Internal namespace index used by the backend and Mongo storage to identify and order historical namespace entries. This value is returned for informational purposes only. API clients should not use it as a pagination cursor; use the standard pagination query parameters (`pageSize`, `pageNumber`, `offset`, `order`) instead. * @type {number} * @memberof NamespaceMetaDTO */ 'index': number; } /** * Namespace metadata transaction body with the target namespace, metadata key, and metadata value update. * @export * @interface NamespaceMetadataTransactionBodyDTO */ export interface NamespaceMetadataTransactionBodyDTO { /** * 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 NamespaceMetadataTransactionBodyDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof NamespaceMetadataTransactionBodyDTO */ 'scopedMetadataKey': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceMetadataTransactionBodyDTO */ 'targetNamespaceId': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof NamespaceMetadataTransactionBodyDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof NamespaceMetadataTransactionBodyDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 NamespaceMetadataTransactionBodyDTO */ 'value': string; } /** * Transaction to create or modify metadata attached to a namespace. * @export * @interface NamespaceMetadataTransactionDTO */ export interface NamespaceMetadataTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof NamespaceMetadataTransactionDTO */ '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 NamespaceMetadataTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NamespaceMetadataTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof NamespaceMetadataTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof NamespaceMetadataTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof NamespaceMetadataTransactionDTO */ '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 NamespaceMetadataTransactionDTO */ '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 NamespaceMetadataTransactionDTO */ 'deadline': string; /** * 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 NamespaceMetadataTransactionDTO */ 'targetAddress': string; /** * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context. * @type {string} * @memberof NamespaceMetadataTransactionDTO */ 'scopedMetadataKey': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceMetadataTransactionDTO */ 'targetNamespaceId': string; /** * Change in metadata value size, in bytes. Positive values increase the stored value size, negative values decrease it. * @type {number} * @memberof NamespaceMetadataTransactionDTO */ 'valueSizeDelta': number; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new value size after applying the update. When the value shrinks, this is the previous stored value size before truncation. * @type {number} * @memberof NamespaceMetadataTransactionDTO */ 'valueSize': number; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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 NamespaceMetadataTransactionDTO */ 'value': string; } /** * Resolved human-readable name for a namespace identifier. * @export * @interface NamespaceNameDTO */ export interface NamespaceNameDTO { /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceNameDTO */ 'parentId'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceNameDTO */ 'id': string; /** * Human-readable namespace name. * @type {string} * @memberof NamespaceNameDTO */ 'name': string; } /** * Namespace plugin configuration. * @export * @interface NamespaceNetworkPropertiesDTO */ export interface NamespaceNetworkPropertiesDTO { /** * Maximum namespace name size. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'maxNameSize'?: string; /** * Maximum number of children for a root namespace. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'maxChildNamespaces'?: string; /** * Maximum namespace depth. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'maxNamespaceDepth'?: string; /** * Minimum namespace duration. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'minNamespaceDuration'?: string; /** * Maximum namespace duration. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'maxNamespaceDuration'?: string; /** * Grace period during which time only the previous owner can renew an expired namespace. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'namespaceGracePeriodDuration'?: string; /** * Comma-separated list of reserved root namespace names that cannot be claimed. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'reservedRootNamespaceNames'?: string; /** * Represents a unique account address in Base32 format. The first character indicates the network (`T` for testnet, `N` for mainnet). Addresses are 39 characters long, Base32-encoded, and include an embedded 3-byte checksum. The node validates this checksum, so an address with even a single altered character will be rejected. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'namespaceRentalFeeSinkAddressV1'?: string; /** * Represents a unique account address in Base32 format. The first character indicates the network (`T` for testnet, `N` for mainnet). Addresses are 39 characters long, Base32-encoded, and include an embedded 3-byte checksum. The node validates this checksum, so an address with even a single altered character will be rejected. * @type {string} * @memberof NamespaceNetworkPropertiesDTO */ 'namespaceRentalFeeSinkAddress'?: 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 NamespaceNetworkPropertiesDTO */ 'rootNamespaceRentalFeePerBlock'?: 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 NamespaceNetworkPropertiesDTO */ 'childNamespaceRentalFee'?: string; } /** * Paginated list of namespace information entries. * @export * @interface NamespacePage */ export interface NamespacePage { /** * Array of namespace information entries. * @type {Array} * @memberof NamespacePage */ 'data': Array; /** * * @type {Pagination} * @memberof NamespacePage */ 'pagination': Pagination; } /** * Namespace registration transaction body for creating a root namespace or a child namespace. * @export * @interface NamespaceRegistrationTransactionBodyDTO */ export interface NamespaceRegistrationTransactionBodyDTO { /** * Duration expressed in number of blocks. * @type {string} * @memberof NamespaceRegistrationTransactionBodyDTO */ 'duration'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceRegistrationTransactionBodyDTO */ 'parentId'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceRegistrationTransactionBodyDTO */ 'id': string; /** * * @type {NamespaceRegistrationTypeEnum} * @memberof NamespaceRegistrationTransactionBodyDTO */ 'registrationType': NamespaceRegistrationTypeEnum; /** * Namespace name. * @type {string} * @memberof NamespaceRegistrationTransactionBodyDTO */ 'name': string; } /** * Transaction to create or renew a namespace. * @export * @interface NamespaceRegistrationTransactionDTO */ export interface NamespaceRegistrationTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof NamespaceRegistrationTransactionDTO */ '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 NamespaceRegistrationTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NamespaceRegistrationTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof NamespaceRegistrationTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof NamespaceRegistrationTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof NamespaceRegistrationTransactionDTO */ '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 NamespaceRegistrationTransactionDTO */ '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 NamespaceRegistrationTransactionDTO */ 'deadline': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof NamespaceRegistrationTransactionDTO */ 'duration'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceRegistrationTransactionDTO */ 'parentId'?: string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 NamespaceRegistrationTransactionDTO */ 'id': string; /** * * @type {NamespaceRegistrationTypeEnum} * @memberof NamespaceRegistrationTransactionDTO */ 'registrationType': NamespaceRegistrationTypeEnum; /** * Namespace name. * @type {string} * @memberof NamespaceRegistrationTransactionDTO */ 'name': string; } /** * Type of namespace registration. A namespace can either be registered as a top-level root namespace or as a subnamespace under an existing parent namespace. - `0`: Root namespace. The namespace has no parent and defines the first level of the namespace path. - `1`: Subnamespace. The namespace is registered under an existing parent namespace and extends the namespace path by one level. * @export * @enum {number} */ export declare const NamespaceRegistrationTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; }; export type NamespaceRegistrationTypeEnum = typeof NamespaceRegistrationTypeEnum[keyof typeof NamespaceRegistrationTypeEnum]; /** * Full network configuration: network identity, chain parameters, plugin settings, and fork heights. Combines data from catapult-server config files (network, chain, plugins). * @export * @interface NetworkConfigurationDTO */ export interface NetworkConfigurationDTO { /** * * @type {NetworkPropertiesDTO} * @memberof NetworkConfigurationDTO */ 'network': NetworkPropertiesDTO; /** * * @type {ChainPropertiesDTO} * @memberof NetworkConfigurationDTO */ 'chain': ChainPropertiesDTO; /** * * @type {PluginsPropertiesDTO} * @memberof NetworkConfigurationDTO */ 'plugins': PluginsPropertiesDTO; /** * * @type {ForkHeightsDTO} * @memberof NetworkConfigurationDTO */ 'forkHeights': ForkHeightsDTO; /** * Multisignature approvals authorizing the network treasury reissuance event for the specified fork height. More: https://hackmd.io/@syndicate/governance. * @type {Array} * @memberof NetworkConfigurationDTO */ 'treasuryReissuanceTransactionSignatures'?: Array; /** * List of aggregate transaction hashes that were known to be invalid due to a bug and must be remapped to corrected hashes. More: https://hackmd.io/@syndicate/postmortem-251022. * @type {Array} * @memberof NetworkConfigurationDTO */ 'corruptAggregateTransactionHashes'?: Array; } /** * One entry in the inflation schedule: block height from which a reward amount applies, and the reward amount. * @export * @interface NetworkInflationDTO */ export interface NetworkInflationDTO { /** * 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 NetworkInflationDTO */ 'startHeight': 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 NetworkInflationDTO */ 'rewardAmount': string; } /** * Network related configuration properties. * @export * @interface NetworkPropertiesDTO */ export interface NetworkPropertiesDTO { /** * Network identifier. * @type {string} * @memberof NetworkPropertiesDTO */ 'identifier'?: string; /** * * @type {NodeIdentityEqualityStrategy} * @memberof NetworkPropertiesDTO */ 'nodeEqualityStrategy'?: NodeIdentityEqualityStrategy; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NetworkPropertiesDTO */ 'nemesisSignerPublicKey'?: string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof NetworkPropertiesDTO */ 'generationHashSeed'?: string; /** * Nemesis epoch time adjustment. * @type {string} * @memberof NetworkPropertiesDTO */ 'epochAdjustment'?: string; } /** * Network type and a short human-readable description. * @export * @interface NetworkTypeDTO */ export interface NetworkTypeDTO { /** * Network name (mainnet or testnet). * @type {string} * @memberof NetworkTypeDTO */ 'name': NetworkTypeDTONameEnum; /** * A short text describing the network. * @type {string} * @memberof NetworkTypeDTO */ 'description': string; } export declare const NetworkTypeDTONameEnum: { readonly Mainnet: "mainnet"; readonly Testnet: "testnet"; }; export type NetworkTypeDTONameEnum = typeof NetworkTypeDTONameEnum[keyof typeof NetworkTypeDTONameEnum]; /** * Network type: - `0x68` (104 decimal): Main network. - `0x98` (152 decimal): Test network. * @export * @enum {number} */ export declare const NetworkTypeEnum: { readonly NUMBER_104: 104; readonly NUMBER_152: 152; }; export type NetworkTypeEnum = typeof NetworkTypeEnum[keyof typeof NetworkTypeEnum]; /** * Status of API node and database services (up/down). * @export * @interface NodeHealthDTO */ export interface NodeHealthDTO { /** * API node service status. * @type {NodeStatusEnum} * @memberof NodeHealthDTO */ 'apiNode': NodeStatusEnum; /** * MongoDB service status. * @type {NodeStatusEnum} * @memberof NodeHealthDTO */ 'db': NodeStatusEnum; } /** * Health status of the node: reachability of the API node and database services from the REST server. * @export * @interface NodeHealthInfoDTO */ export interface NodeHealthInfoDTO { /** * * @type {NodeHealthDTO} * @memberof NodeHealthInfoDTO */ 'status': NodeHealthDTO; } /** * Node equality strategy. Defines if the identifier for the node must be its public key or host. * @export * @enum {string} */ export declare const NodeIdentityEqualityStrategy: { readonly Host: "host"; readonly PublicKey: "public-key"; }; export type NodeIdentityEqualityStrategy = typeof NodeIdentityEqualityStrategy[keyof typeof NodeIdentityEqualityStrategy]; /** * Identity and configuration of the connected node: version, public key, network generation hash, roles (peer/api/voting), host, port, and friendly name. * @export * @interface NodeInfoDTO */ export interface NodeInfoDTO { /** * Version of the application. * @type {number} * @memberof NodeInfoDTO */ 'version': number; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NodeInfoDTO */ 'publicKey': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof NodeInfoDTO */ 'networkGenerationHashSeed': string; /** * Bitmask of roles the node provides. Individual flags: - `0`: No roles. - `1`: Peer node. - `2`: API node. - `4`: Voting node. - `64`: IPv4 compatible node. - `128`: IPv6 compatible node. Flags are combined with bitwise OR. Examples: - `1` = Peer only. - `2` = API only. - `3` = Peer and API. - `7` = Peer, API and Voting. - `65` = IPv4 and Peer. * @type {number} * @memberof NodeInfoDTO */ 'roles': number; /** * Port used for the communication. * @type {number} * @memberof NodeInfoDTO */ 'port': number; /** * * @type {NetworkTypeEnum} * @memberof NodeInfoDTO */ 'networkIdentifier': NetworkTypeEnum; /** * Node friendly name. * @type {string} * @memberof NodeInfoDTO */ 'friendlyName': string; /** * Node IP address. * @type {string} * @memberof NodeInfoDTO */ 'host': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NodeInfoDTO */ 'nodePublicKey'?: string; } /** * Node key link transaction body that links or unlinks a remote node public key. * @export * @interface NodeKeyLinkTransactionBodyDTO */ export interface NodeKeyLinkTransactionBodyDTO { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NodeKeyLinkTransactionBodyDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof NodeKeyLinkTransactionBodyDTO */ 'linkAction': LinkActionEnum; } /** * Transaction to link a public key to an account. TLS uses the linked public key to create sessions. Required for node operators. * @export * @interface NodeKeyLinkTransactionDTO */ export interface NodeKeyLinkTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof NodeKeyLinkTransactionDTO */ '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 NodeKeyLinkTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NodeKeyLinkTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof NodeKeyLinkTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof NodeKeyLinkTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof NodeKeyLinkTransactionDTO */ '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 NodeKeyLinkTransactionDTO */ '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 NodeKeyLinkTransactionDTO */ 'deadline': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof NodeKeyLinkTransactionDTO */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof NodeKeyLinkTransactionDTO */ 'linkAction': LinkActionEnum; } /** * Operational status of a service (e.g. API node or database). * @export * @enum {string} */ export declare const NodeStatusEnum: { readonly Up: "up"; readonly Down: "down"; }; export type NodeStatusEnum = typeof NodeStatusEnum[keyof typeof NodeStatusEnum]; /** * Node time at request/response. Used to calculate transaction deadlines (deadline = node time + desired lifetime). * @export * @interface NodeTimeDTO */ export interface NodeTimeDTO { /** * * @type {CommunicationTimestampsDTO} * @memberof NodeTimeDTO */ 'communicationTimestamps': CommunicationTimestampsDTO; } /** * Indicates how to sort the results: - `asc`: ascending - `desc`: descending * @export * @enum {string} */ export declare const Order: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type Order = typeof Order[keyof typeof Order]; /** * Pagination metadata returned with paginated list responses. Indicates the current page and the number of entries per page. * @export * @interface Pagination */ export interface Pagination { /** * Current page number. * @type {number} * @memberof Pagination */ 'pageNumber': number; /** * Number of entries per page. * @type {number} * @memberof Pagination */ 'pageSize': number; } /** * Public key and BLS signature pair from a voter. * @export * @interface ParentPublicKeySignaturePair */ export interface ParentPublicKeySignaturePair { /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof ParentPublicKeySignaturePair */ 'parentPublicKey': string; /** * 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 ParentPublicKeySignaturePair */ 'signature': string; } /** * Plugin related configuration properties. * @export * @interface PluginsPropertiesDTO */ export interface PluginsPropertiesDTO { /** * * @type {AccountKeyLinkNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'accountlink'?: AccountKeyLinkNetworkPropertiesDTO; /** * * @type {AggregateNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'aggregate'?: AggregateNetworkPropertiesDTO; /** * * @type {HashLockNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'lockhash'?: HashLockNetworkPropertiesDTO; /** * * @type {SecretLockNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'locksecret'?: SecretLockNetworkPropertiesDTO; /** * * @type {MetadataNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'metadata'?: MetadataNetworkPropertiesDTO; /** * * @type {MosaicNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'mosaic'?: MosaicNetworkPropertiesDTO; /** * * @type {MultisigNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'multisig'?: MultisigNetworkPropertiesDTO; /** * * @type {NamespaceNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'namespace'?: NamespaceNetworkPropertiesDTO; /** * * @type {AccountRestrictionNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'restrictionaccount'?: AccountRestrictionNetworkPropertiesDTO; /** * * @type {MosaicRestrictionNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'restrictionmosaic'?: MosaicRestrictionNetworkPropertiesDTO; /** * * @type {TransferNetworkPropertiesDTO} * @memberof PluginsPropertiesDTO */ 'transfer'?: TransferNetworkPropertiesDTO; } /** * Position relative to the proofHash being evaluated: - `left`: the item hash is concatenated before the proofHash. - `right`: the item hash is concatenated after the proofHash. * @export * @enum {string} */ export declare const PositionEnum: { readonly Left: "left"; readonly Right: "right"; }; export type PositionEnum = typeof PositionEnum[keyof typeof PositionEnum]; /** * Base fields shared by all receipt types. * @export * @interface ReceiptDTO */ export interface ReceiptDTO { /** * Version of the receipt format. * @type {number} * @memberof ReceiptDTO */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof ReceiptDTO */ 'type': ReceiptTypeEnum; } /** * Numeric code identifying the receipt type. Supported values: - `0x124D` (`4685`): Mosaic_Rental_Fee. - `0x134E` (`4942`): Namespace_Rental_Fee. - `0x2143` (`8515`): Harvest_Fee. - `0x2248` (`8776`): LockHash_Completed. - `0x2348` (`9032`): LockHash_Expired. - `0x2252` (`8786`): LockSecret_Completed. - `0x2352` (`9042`): LockSecret_Expired. - `0x3148` (`12616`): LockHash_Created. - `0x3152` (`12626`): LockSecret_Created. - `0x414D` (`16717`): Mosaic_Expired. - `0x414E` (`16718`): Namespace_Expired. - `0x424E` (`16974`): Namespace_Deleted. - `0x5143` (`20803`): Inflation. - `0xE143` (`57667`): Transaction_Group. - `0xF143` (`61763`): Address_Alias_Resolution. - `0xF243` (`62019`): Mosaic_Alias_Resolution. * @export * @enum {number} */ export declare const ReceiptTypeEnum: { readonly NUMBER_4685: 4685; readonly NUMBER_4942: 4942; readonly NUMBER_8515: 8515; readonly NUMBER_8776: 8776; readonly NUMBER_9032: 9032; readonly NUMBER_8786: 8786; readonly NUMBER_9042: 9042; readonly NUMBER_12616: 12616; readonly NUMBER_12626: 12626; readonly NUMBER_16717: 16717; readonly NUMBER_16718: 16718; readonly NUMBER_16974: 16974; readonly NUMBER_20803: 20803; readonly NUMBER_57667: 57667; readonly NUMBER_61763: 61763; readonly NUMBER_62019: 62019; }; export type ReceiptTypeEnum = typeof ReceiptTypeEnum[keyof typeof ReceiptTypeEnum]; /** * Estimated effective rental fees for on-chain resources: root namespace (per block), child namespace, and mosaic creation. All amounts are in **network currency** and expressed in **smallest (atomic) units**. * @export * @interface RentalFeesDTO */ export interface RentalFeesDTO { /** * 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 RentalFeesDTO */ 'effectiveRootNamespaceRentalFeePerBlock': 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 RentalFeesDTO */ 'effectiveChildNamespaceRentalFee': 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 RentalFeesDTO */ 'effectiveMosaicRentalFee': string; } /** * One resolved value for an unresolved alias and transaction source. * @export * @interface ResolutionEntryDTO */ export interface ResolutionEntryDTO { /** * Transaction source for which the unresolved alias resolved to this value. * @type {SourceDTO} * @memberof ResolutionEntryDTO */ 'source': SourceDTO; /** * * @type {ResolutionEntryDTOResolved} * @memberof ResolutionEntryDTO */ 'resolved': ResolutionEntryDTOResolved; } /** * Concrete address or mosaic ID resolved from the alias for this source. * @export * @interface ResolutionEntryDTOResolved */ export interface ResolutionEntryDTOResolved { } /** * Resolution statement describing how one unresolved alias was resolved at a given block height. * @export * @interface ResolutionStatementDTO */ export interface ResolutionStatementDTO { /** * 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 ResolutionStatementDTO */ 'height': string; /** * * @type {ResolutionStatementDTOUnresolved} * @memberof ResolutionStatementDTO */ 'unresolved': ResolutionStatementDTOUnresolved; /** * Resolution entries linked to the unresolved alias. Multiple entries can be present because the resolved value can change within the same block. This can happen when alias-related transactions in the same block change which address or mosaic id the alias points to, so different transaction sources observe different resolved values. * @type {Array} * @memberof ResolutionStatementDTO */ 'resolutionEntries': Array; } /** * Unresolved alias value used in the transaction before resolution. * @export * @interface ResolutionStatementDTOUnresolved */ export interface ResolutionStatementDTOUnresolved { } /** * Wrapper object containing one resolution statement and its metadata. * @export * @interface ResolutionStatementInfoDTO */ export interface ResolutionStatementInfoDTO { /** * 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 ResolutionStatementInfoDTO */ 'id': string; /** * * @type {StatementMetaDTO} * @memberof ResolutionStatementInfoDTO */ 'meta': StatementMetaDTO; /** * * @type {ResolutionStatementDTO} * @memberof ResolutionStatementInfoDTO */ 'statement': ResolutionStatementDTO; } /** * Paginated response containing resolution statements. * @export * @interface ResolutionStatementPage */ export interface ResolutionStatementPage { /** * Resolution statements matching the requested filters. * @type {Array} * @memberof ResolutionStatementPage */ 'data': Array; /** * * @type {Pagination} * @memberof ResolutionStatementPage */ 'pagination': Pagination; } /** * 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; } /** * 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; } /** * * @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; } /** * Paginated response containing secret lock entries. * @export * @interface SecretLockPage */ export interface SecretLockPage { /** * Secret lock entries matching the requested filters. * @type {Array} * @memberof SecretLockPage */ 'data': Array; /** * * @type {Pagination} * @memberof SecretLockPage */ 'pagination': Pagination; } /** * 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; } /** * Transaction to sends mosaics to a recipient if the proof used is revealed. If the duration is reached, the locked funds go back to the sender of the transaction. * @export * @interface SecretLockTransactionDTO */ export interface SecretLockTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof SecretLockTransactionDTO */ '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 SecretLockTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof SecretLockTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof SecretLockTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof SecretLockTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof SecretLockTransactionDTO */ '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 SecretLockTransactionDTO */ '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 SecretLockTransactionDTO */ 'deadline': string; /** * 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 SecretLockTransactionDTO */ 'recipientAddress': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof SecretLockTransactionDTO */ '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 SecretLockTransactionDTO */ '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 SecretLockTransactionDTO */ 'amount': string; /** * Duration expressed in number of blocks. * @type {string} * @memberof SecretLockTransactionDTO */ 'duration': string; /** * * @type {LockHashAlgorithmEnum} * @memberof SecretLockTransactionDTO */ 'hashAlgorithm': LockHashAlgorithmEnum; } /** * Secret proof transaction body that reveals the proof needed to complete a secret lock. * @export * @interface SecretProofTransactionBodyDTO */ export interface SecretProofTransactionBodyDTO { /** * 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 SecretProofTransactionBodyDTO */ 'recipientAddress': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof SecretProofTransactionBodyDTO */ 'secret': string; /** * * @type {LockHashAlgorithmEnum} * @memberof SecretProofTransactionBodyDTO */ 'hashAlgorithm': LockHashAlgorithmEnum; /** * Proof data whose hash, using `hashAlgorithm`, must match `secret`. * @type {string} * @memberof SecretProofTransactionBodyDTO */ 'proof': string; } /** * Transaction to reveal a proof. * @export * @interface SecretProofTransactionDTO */ export interface SecretProofTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof SecretProofTransactionDTO */ '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 SecretProofTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof SecretProofTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof SecretProofTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof SecretProofTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof SecretProofTransactionDTO */ '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 SecretProofTransactionDTO */ '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 SecretProofTransactionDTO */ 'deadline': string; /** * 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 SecretProofTransactionDTO */ 'recipientAddress': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof SecretProofTransactionDTO */ 'secret': string; /** * * @type {LockHashAlgorithmEnum} * @memberof SecretProofTransactionDTO */ 'hashAlgorithm': LockHashAlgorithmEnum; /** * Proof data whose hash, using `hashAlgorithm`, must match `secret`. * @type {string} * @memberof SecretProofTransactionDTO */ 'proof': string; } /** * REST component version and deployment metadata. * @export * @interface ServerDTO */ export interface ServerDTO { /** * catapult-rest component version. * @type {string} * @memberof ServerDTO */ 'restVersion': string; /** * * @type {DeploymentDTO} * @memberof ServerDTO */ 'deployment': DeploymentDTO; } /** * Version and deployment information for the catapult-rest component running on this node. * @export * @interface ServerInfoDTO */ export interface ServerInfoDTO { /** * * @type {ServerDTO} * @memberof ServerInfoDTO */ 'serverInfo': ServerDTO; } /** * 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; } /** * 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; } /** * 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 * @enum {number} */ export declare const StageEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type StageEnum = typeof StageEnum[keyof typeof StageEnum]; /** * 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; } /** * 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; } /** * 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; } /** * Supplemental public keys linked to the account for delegated harvesting, node linking, VRF key derivation, and finalization voting. * @export * @interface SupplementalPublicKeysDTO */ export interface SupplementalPublicKeysDTO { /** * * @type {AccountLinkPublicKeyDTO} * @memberof SupplementalPublicKeysDTO */ 'linked'?: AccountLinkPublicKeyDTO; /** * * @type {AccountLinkPublicKeyDTO} * @memberof SupplementalPublicKeysDTO */ 'node'?: AccountLinkPublicKeyDTO; /** * * @type {AccountLinkPublicKeyDTO} * @memberof SupplementalPublicKeysDTO */ 'vrf'?: AccountLinkPublicKeyDTO; /** * * @type {AccountLinkVotingKeysDTO} * @memberof SupplementalPublicKeysDTO */ 'voting'?: AccountLinkVotingKeysDTO; } /** * Common body fields shared by all top-level transactions. * @export * @interface TransactionBodyDTO */ 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 */ '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 TransactionBodyDTO */ 'deadline': string; } /** * * @export * @interface TransactionDTO */ export interface TransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof TransactionDTO */ '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 TransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof TransactionDTO */ '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 */ '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 TransactionDTO */ 'deadline': string; } /** * Fee multiplier statistics over the last `numBlocksTransactionFeeStats` blocks: average, median, highest, lowest, and minimum on the connected node. All values are absolute (smallest units). * @export * @interface TransactionFeesDTO */ 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 */ '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 */ '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 */ '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 */ '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 */ 'minFeeMultiplier': number; } /** * Group that indicates the current processing state of a transaction: - `unconfirmed`: the transaction reached the network but is not yet included in a block. - `confirmed`: the transaction was included in a block. - `partial`: the transaction is waiting for additional cosignatures before it can be confirmed. - `failed`: the transaction was rejected during validation. * @export * @enum {string} */ export declare const TransactionGroupEnum: { readonly Unconfirmed: "unconfirmed"; readonly Confirmed: "confirmed"; readonly Failed: "failed"; readonly Partial: "partial"; }; export type TransactionGroupEnum = typeof TransactionGroupEnum[keyof typeof TransactionGroupEnum]; /** * Array wrapper used to request transaction statuses by transaction hash. * @export * @interface TransactionHashes */ export interface TransactionHashes { /** * Array of transaction hashes. * @type {Array} * @memberof TransactionHashes */ 'hashes': Array; } /** * Wrapper object containing transaction identifiers for batch transaction lookup. * @export * @interface TransactionIds */ export interface TransactionIds { /** * Array of transaction IDs or transaction hashes. * @type {Array} * @memberof TransactionIds */ 'transactionIds': Array; } /** * Transaction record returned by transaction lookup and search endpoints. The same wrapper is used for confirmed, unconfirmed, and partial transaction groups. The exact `meta` shape depends on whether the returned entry is a top-level transaction or an embedded transaction inside an aggregate. When an aggregate transaction is retrieved by ID or hash, REST can also expand its embedded transactions under `transaction.transactions`. * @export * @interface TransactionInfoDTO */ 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; } /** * Metadata for the returned transaction entry. Top-level entries use `TransactionMetaDTO`. Embedded entries use `EmbeddedTransactionMetaDTO`. * @export * @interface TransactionInfoDTOMeta */ 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. * @type {string} * @memberof TransactionInfoDTOMeta */ 'height': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionInfoDTOMeta */ 'hash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionInfoDTOMeta */ '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). **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 */ 'feeMultiplier'?: number; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionInfoDTOMeta */ '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 */ 'aggregateId': string; } /** * Concrete transaction payload represented by one of the listed transaction DTOs. For aggregate transaction lookups, REST can populate `transaction.transactions` with the embedded transaction records linked to that aggregate. * @export * @interface TransactionInfoDTOTransaction */ export interface TransactionInfoDTOTransaction { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof TransactionInfoDTOTransaction */ '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 TransactionInfoDTOTransaction */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof TransactionInfoDTOTransaction */ '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 */ '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 TransactionInfoDTOTransaction */ 'deadline': string; /** * 32-byte voting public key used for finalization voting. * @type {string} * @memberof TransactionInfoDTOTransaction */ 'linkedPublicKey': string; /** * * @type {LinkActionEnum} * @memberof TransactionInfoDTOTransaction */ 'linkAction': LinkActionEnum; /** * [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 TransactionInfoDTOTransaction */ '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 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} * @memberof TransactionInfoDTOTransaction */ 'cosignatures': Array; /** * Array of transactions initiated by different accounts. * @type {Array} * @memberof TransactionInfoDTOTransaction */ 'transactions': Array; /** * 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 TransactionInfoDTOTransaction */ '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 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; /** * 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 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; /** * 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 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; /** * Size of a metadata value or metadata value update payload, in bytes. In metadata transactions, when no previous value exists, or when the value grows, this is the new 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; /** * Metadata value encoded as hex. In metadata transactions, this field carries the metadata value update payload. 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; /** * 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 TransactionInfoDTOTransaction */ 'targetMosaicId': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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 */ 'nonce': number; /** * Mosaic flags bitmask. Individual values can be combined. - 0x00 (0 decimal): No flags present. - 0x01 (1 decimal, `supplyMutable`): Mosaic supply can be increased or decreased later. - 0x02 (2 decimal, `transferable`): Mosaic can be transferred between arbitrary accounts. When not set, it can only be transferred to and from the mosaic owner. - 0x04 (4 decimal, `restrictable`): Mosaic supports custom restrictions configured by the mosaic owner. - 0x08 (8 decimal, `revokable`): Mosaic creator can revoke balances from another account. Example: `3` means `0x01 + 0x02`, so the mosaic is both `supplyMutable` and `transferable`. * @type {number} * @memberof TransactionInfoDTOTransaction */ 'flags': number; /** * Determines up to what decimal place a mosaic can be divided. 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; /** * 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 */ 'delta': string; /** * * @type {MosaicSupplyChangeActionEnum} * @memberof TransactionInfoDTOTransaction */ 'action': MosaicSupplyChangeActionEnum; /** * 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 TransactionInfoDTOTransaction */ 'sourceAddress': string; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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; /** * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier. 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; /** * Relative change applied to the minimum number of cosignatory approvals required to remove a 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; /** * Relative change applied to the minimum number of cosignatory approvals required to approve a 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} * @memberof TransactionInfoDTOTransaction */ 'addressAdditions': Array; /** * Cosignatory addresses to remove from the multisig account. * @type {Array} * @memberof TransactionInfoDTOTransaction */ 'addressDeletions': Array; /** * * @type {AccountRestrictionFlagsEnum} * @memberof TransactionInfoDTOTransaction */ 'restrictionFlags': AccountRestrictionFlagsEnum; /** * Account restriction additions. * @type {Array} * @memberof TransactionInfoDTOTransaction */ 'restrictionAdditions': Array; /** * Account restriction deletions. * @type {Array} * @memberof TransactionInfoDTOTransaction */ 'restrictionDeletions': Array; /** * 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 TransactionInfoDTOTransaction */ 'referenceMosaicId': string; /** * Restriction key represented as a 64-bit hexadecimal value. * @type {string} * @memberof TransactionInfoDTOTransaction */ 'restrictionKey': string; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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; /** * Unsigned 64-bit value associated with a mosaic restriction key, represented as a decimal string. 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} * @memberof TransactionInfoDTOTransaction */ 'mosaics': Array; /** * Optional transfer message payload, encoded as a hexadecimal string. * @type {string} * @memberof TransactionInfoDTOTransaction */ 'message'?: string; } /** * Metadata for a top-level (non-embedded) transaction entry returned by the transaction endpoints. For confirmed transactions, these fields describe the transaction\'s position in the block and the proof-related hashes associated with that block entry. For unconfirmed top-level transactions, REST returns: - `height` = `\"0\"` - `index` = `0` - `hash` = transaction hash - `merkleComponentHash` = transaction hash Block-derived fields such as `timestamp` and `feeMultiplier` are not present until the transaction is included in a block. * @export * @interface TransactionMetaDTO */ 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': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionMetaDTO */ 'hash': string; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionMetaDTO */ '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. * @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). * @type {number} * @memberof TransactionMetaDTO */ 'feeMultiplier'?: number; } /** * Paginated transaction search result. * @export * @interface TransactionPage */ export interface TransactionPage { /** * Array of transactions. * @type {Array} * @memberof TransactionPage */ 'data': Array; /** * * @type {Pagination} * @memberof TransactionPage */ 'pagination': Pagination; } /** * Wrapper object used to announce one signed transaction payload. * @export * @interface TransactionPayload */ 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; } /** * Transaction statement containing receipts emitted by a transaction source at a given block height. * @export * @interface TransactionStatementDTO */ 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': string; /** * * @type {SourceDTO} * @memberof TransactionStatementDTO */ 'source': SourceDTO; /** * Receipts emitted by the transaction source. * @type {Array} * @memberof TransactionStatementDTO */ 'receipts': Array; } /** * * @export * @interface TransactionStatementDTOReceiptsInner */ export interface TransactionStatementDTOReceiptsInner { /** * Version of the receipt format. * @type {number} * @memberof TransactionStatementDTOReceiptsInner */ 'version': number; /** * * @type {ReceiptTypeEnum} * @memberof TransactionStatementDTOReceiptsInner */ 'type': ReceiptTypeEnum; /** * 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 TransactionStatementDTOReceiptsInner */ '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 TransactionStatementDTOReceiptsInner */ 'amount': 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 TransactionStatementDTOReceiptsInner */ 'senderAddress': 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 TransactionStatementDTOReceiptsInner */ 'recipientAddress': 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 TransactionStatementDTOReceiptsInner */ 'targetAddress': 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 TransactionStatementDTOReceiptsInner */ 'artifactId': string; } /** * Wrapper object containing one transaction statement and its metadata. * @export * @interface TransactionStatementInfoDTO */ export interface TransactionStatementInfoDTO { /** * 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 TransactionStatementInfoDTO */ 'id': string; /** * * @type {StatementMetaDTO} * @memberof TransactionStatementInfoDTO */ 'meta': StatementMetaDTO; /** * * @type {TransactionStatementDTO} * @memberof TransactionStatementInfoDTO */ 'statement': TransactionStatementDTO; } /** * Paginated response containing transaction statements. * @export * @interface TransactionStatementPage */ export interface TransactionStatementPage { /** * Transaction statements matching the requested filters. * @type {Array} * @memberof TransactionStatementPage */ 'data': Array; /** * * @type {Pagination} * @memberof TransactionStatementPage */ 'pagination': Pagination; } /** * Current processing status of a transaction identified by its hash. * @export * @interface TransactionStatusDTO */ export interface TransactionStatusDTO { /** * * @type {TransactionGroupEnum} * @memberof TransactionStatusDTO */ 'group': TransactionGroupEnum; /** * * @type {TransactionStatusEnum} * @memberof TransactionStatusDTO */ 'code'?: TransactionStatusEnum; /** * 256-bit hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionStatusDTO */ 'hash': 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 TransactionStatusDTO */ 'deadline': 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 TransactionStatusDTO */ 'height'?: string; } /** * Validation or processing result associated with a transaction status. This enum includes generic results (`Success`, `Neutral`, `Failure`) and detailed validation failure codes that can be returned when a node accepts, tracks, or rejects a transaction: - `Success` - `Neutral` - `Failure` - `Failure_Core_Past_Deadline`: Validation failed because the deadline passed. - `Failure_Core_Future_Deadline`: Validation failed because the deadline is too far in the future. - `Failure_Core_Insufficient_Balance`: Validation failed because the account has an insufficient balance. - `Failure_Core_Too_Many_Transactions`: Validation failed because there are too many transactions in a block. - `Failure_Core_Nemesis_Account_Signed_After_Nemesis_Block`: Validation failed because an entity originated from the nemesis account after the nemesis (first) block. - `Failure_Core_Wrong_Network`: Validation failed because the entity has the wrong network specified. - `Failure_Core_Invalid_Address`: Validation failed because an address is invalid. - `Failure_Core_Invalid_Version`: Validation failed because entity version is invalid. - `Failure_Core_Invalid_Transaction_Fee`: Validation failed because a transaction fee is invalid. - `Failure_Core_Block_Harvester_Ineligible`: Validation failed because a block was harvested by an ineligible harvester. - `Failure_Core_Zero_Address`: Validation failed because an address is zero. - `Failure_Core_Zero_Public_Key`: Validation failed because a public key is zero. - `Failure_Core_Nonzero_Internal_Padding`: Validation failed because internal padding is nonzero. - `Failure_Core_Address_Collision`: Validation failed because an address collision is detected. - `Failure_Core_Importance_Block_Mismatch`: Validation failed because the block does not match the schema of an importance block. - `Failure_Core_Unexpected_Block_Type`: Validation failed because the block type is unexpected. - `Failure_Core_Invalid_Link_Action`: Validation failed because link action is invalid. - `Failure_Core_Link_Already_Exists`: Validation failed because main account is already linked to another account. - `Failure_Core_Inconsistent_Unlink_Data`: Validation failed because unlink data is not consistent with existing account link. - `Failure_Core_Invalid_Link_Range`: Validation failed because link range is invalid. - `Failure_Core_Too_Many_Links`: Validation failed because main account has too many links of the specified type. - `Failure_Core_Link_Start_Epoch_Invalid`: Validation failed because the start epoch is invalid. - `Failure_Hash_Already_Exists` - `Failure_Signature_Not_Verifiable`: Validation failed because the verification of the signature failed. - `Failure_AccountLink_Link_Already_Exists`: Validation failed because main account is already linked to another account. - `Failure_AccountLink_Inconsistent_Unlink_Data`: Validation failed because unlink data is not consistent with existing account link. - `Failure_AccountLink_Unknown_Link`: Validation failed because main account is not linked to another account. - `Failure_AccountLink_Remote_Account_Ineligible`: Validation failed because link is attempting to convert ineligible account to remote. - `Failure_AccountLink_Remote_Account_Signer_Prohibited`: Validation failed because remote is not allowed to sign a transaction. - `Failure_AccountLink_Remote_Account_Participant_Prohibited`: Validation failed because remote is not allowed to participate in the transaction. - `Failure_Aggregate_Too_Many_Transactions`: Validation failed because aggregate has too many transactions. - `Failure_Aggregate_No_Transactions`: Validation failed because aggregate does not have any transactions. - `Failure_Aggregate_Too_Many_Cosignatures`: Validation failed because aggregate has too many cosignatures. - `Failure_Aggregate_Redundant_Cosignatures`: Validation failed because redundant cosignatures are present. - `Failure_Aggregate_Ineligible_Cosignatories`: Validation failed because at least one cosignatory is ineligible. - `Failure_Aggregate_Missing_Cosignatures`: Validation failed because at least one required cosignature is missing. - `Failure_Aggregate_Transactions_Hash_Mismatch`: Validation failed because the aggregate transactions hash does not match the calculated value. - `Failure_Aggregate_V1_Prohibited`: Validation failed because aggregate transaction with version 1 is not allowed. - `Failure_Aggregate_V2_Prohibited`: Validation failed because aggregate transaction with version 2 is not allowed. - `Failure_Aggregate_V3_Prohibited`: Validation failed because aggregate transaction with version 3 is not allowed. - `Failure_LockHash_Invalid_Mosaic_Id`: Validation failed because lock does not allow the specified mosaic. - `Failure_LockHash_Invalid_Mosaic_Amount`: Validation failed because lock does not allow the specified amount. - `Failure_LockHash_Hash_Already_Exists`: Validation failed because hash is already present in cache. - `Failure_LockHash_Unknown_Hash`: Validation failed because hash is not present in cache. - `Failure_LockHash_Inactive_Hash`: Validation failed because hash is inactive. - `Failure_LockHash_Invalid_Duration`: Validation failed because duration is too long. - `Failure_LockSecret_Invalid_Hash_Algorithm`: Validation failed because hash algorithm for lock type secret is invalid. - `Failure_LockSecret_Hash_Already_Exists`: Validation failed because hash is already present in cache. - `Failure_LockSecret_Proof_Size_Out_Of_Bounds`: Validation failed because proof is too small or too large. - `Failure_LockSecret_Secret_Mismatch`: Validation failed because secret does not match proof. - `Failure_LockSecret_Unknown_Composite_Key`: Validation failed because composite key is unknown. - `Failure_LockSecret_Inactive_Secret`: Validation failed because secret is inactive. - `Failure_LockSecret_Hash_Algorithm_Mismatch`: Validation failed because hash algorithm does not match. - `Failure_LockSecret_Invalid_Duration`: Validation failed because duration is too long. - `Failure_Metadata_Value_Too_Small`: Validation failed because the metadata value is too small. - `Failure_Metadata_Value_Too_Large`: Validation failed because the metadata value is too large. - `Failure_Metadata_Value_Size_Delta_Too_Large`: Validation failed because the metadata value size delta is larger in magnitude than the value size. - `Failure_Metadata_Value_Size_Delta_Mismatch`: Validation failed because the metadata value size delta does not match expected value based on the current state. - `Failure_Metadata_Value_Change_Irreversible`: Validation failed because a metadata value change (truncation) is irreversible. - `Failure_Mosaic_Invalid_Duration`: Validation failed because the duration has an invalid value. - `Failure_Mosaic_Invalid_Name`: Validation failed because the name is invalid. - `Failure_Mosaic_Name_Id_Mismatch`: Validation failed because the name and ID don\'t match. - `Failure_Mosaic_Expired`: Validation failed because the parent is expired. - `Failure_Mosaic_Owner_Conflict`: Validation failed because the parent owner conflicts with the child owner. - `Failure_Mosaic_Id_Mismatch`: Validation failed because the ID is not the expected ID generated from signer and nonce. - `Failure_Mosaic_Parent_Id_Conflict`: Validation failed because the existing parent ID does not match the supplied parent ID. - `Failure_Mosaic_Invalid_Property`: Validation failed because a mosaic property is invalid. - `Failure_Mosaic_Invalid_Flags`: Validation failed because the mosaic flags are invalid. - `Failure_Mosaic_Invalid_Divisibility`: Validation failed because the mosaic divisibility is invalid. - `Failure_Mosaic_Invalid_Supply_Change_Action`: Validation failed because the mosaic supply change action is invalid. - `Failure_Mosaic_Invalid_Supply_Change_Amount`: Validation failed because the mosaic supply change amount is invalid. - `Failure_Mosaic_Invalid_Id`: Validation failed because the mosaic ID is invalid. - `Failure_Mosaic_Modification_Disallowed`: Validation failed because mosaic modification is not allowed. - `Failure_Mosaic_Modification_No_Changes`: Validation failed because mosaic modification would not result in any changes. - `Failure_Mosaic_Supply_Immutable`: Validation failed because the mosaic supply is immutable. - `Failure_Mosaic_Supply_Negative`: Validation failed because the resulting mosaic supply is negative. - `Failure_Mosaic_Supply_Exceeded`: Validation failed because the resulting mosaic supply exceeds the maximum allowed value. - `Failure_Mosaic_Non_Transferable`: Validation failed because the mosaic is not transferable. - `Failure_Mosaic_Max_Mosaics_Exceeded`: Validation failed because the credit of the mosaic would exceed the maximum of different mosaics an account is allowed to own. - `Failure_Mosaic_Required_Property_Flag_Unset`: Validation failed because the mosaic has at least one required property flag unset. - `Failure_Multisig_Account_In_Both_Sets`: Validation failed because account is specified to be both added and removed. - `Failure_Multisig_Multiple_Deletes`: Validation failed because multiple removals are present. - `Failure_Multisig_Redundant_Modification`: Validation failed because a modification is redundant. - `Failure_Multisig_Unknown_Multisig_Account`: Validation failed because account is not in multisig cache. - `Failure_Multisig_Not_A_Cosignatory`: Validation failed because account to be removed is not present. - `Failure_Multisig_Already_A_Cosignatory`: Validation failed because account to be added is already a cosignatory. - `Failure_Multisig_Min_Setting_Out_Of_Range`: Validation failed because new minimum settings are out of range. - `Failure_Multisig_Min_Setting_Larger_Than_Num_Cosignatories`: Validation failed because min settings are larger than number of cosignatories. - `Failure_Multisig_Invalid_Modification_Action`: Validation failed because the modification action is invalid. - `Failure_Multisig_Max_Cosigned_Accounts`: Validation failed because the cosignatory already cosigns the maximum number of accounts. - `Failure_Multisig_Max_Cosignatories`: Validation failed because the multisig account already has the maximum number of cosignatories. - `Failure_Multisig_Loop`: Validation failed because a multisig loop is created. - `Failure_Multisig_Max_Multisig_Depth`: Validation failed because the max multisig depth is exceeded. - `Failure_Multisig_Operation_Prohibited_By_Account`: Validation failed because an operation is not permitted by a multisig account. - `Failure_Namespace_Invalid_Duration`: Validation failed because the duration has an invalid value. - `Failure_Namespace_Invalid_Name`: Validation failed because the name is invalid. - `Failure_Namespace_Name_Id_Mismatch`: Validation failed because the name and ID don\'t match. - `Failure_Namespace_Expired`: Validation failed because the parent is expired. - `Failure_Namespace_Owner_Conflict`: Validation failed because the parent owner conflicts with the child owner. - `Failure_Namespace_Id_Mismatch`: Validation failed because the ID is not the expected ID generated from signer and nonce. - `Failure_Namespace_Invalid_Registration_Type`: Validation failed because the namespace registration type is invalid. - `Failure_Namespace_Root_Name_Reserved`: Validation failed because the root namespace has a reserved name. - `Failure_Namespace_Too_Deep`: Validation failed because the resulting namespace would exceed the maximum allowed namespace depth. - `Failure_Namespace_Unknown_Parent`: Validation failed because the namespace parent is unknown. - `Failure_Namespace_Already_Exists`: Validation failed because the namespace already exists. - `Failure_Namespace_Already_Active`: Validation failed because the namespace is already active. - `Failure_Namespace_Eternal_After_Nemesis_Block`: Validation failed because an eternal namespace was received after the nemesis (first) block. - `Failure_Namespace_Max_Children_Exceeded`: Validation failed because the maximum number of children for a root namespace was exceeded. - `Failure_Namespace_Alias_Invalid_Action`: Validation failed because alias action is invalid. - `Failure_Namespace_Unknown`: Validation failed because namespace does not exist. - `Failure_Namespace_Alias_Already_Exists`: Validation failed because namespace is already linked to an alias. - `Failure_Namespace_Unknown_Alias`: Validation failed because namespace is not linked to an alias. - `Failure_Namespace_Alias_Inconsistent_Unlink_Type`: Validation failed because unlink type is not consistent with existing alias. - `Failure_Namespace_Alias_Inconsistent_Unlink_Data`: Validation failed because unlink data is not consistent with existing alias. - `Failure_Namespace_Alias_Invalid_Address`: Validation failed because aliased address is invalid. - `Failure_RestrictionAccount_Invalid_Restriction_Flags`: Validation failed because the account restriction flags are invalid. - `Failure_RestrictionAccount_Invalid_Modification_Action`: Validation failed because a modification action is invalid. - `Failure_RestrictionAccount_Invalid_Modification_Address`: Validation failed because a modification address is invalid. - `Failure_RestrictionAccount_Modification_Operation_Type_Incompatible`: Validation failed because the operation type is incompatible. *Note*: This indicates that the existing restrictions have a different operation type than that specified in the notification. - `Failure_RestrictionAccount_Redundant_Modification`: Validation failed because a modification is redundant. - `Failure_RestrictionAccount_Invalid_Modification`: Validation failed because a value is not in the container. - `Failure_RestrictionAccount_Modification_Count_Exceeded`: Validation failed because the transaction has too many modifications. - `Failure_RestrictionAccount_No_Modifications`: Validation failed because the transaction has no modifications. - `Failure_RestrictionAccount_Values_Count_Exceeded`: Validation failed because the resulting account restriction has too many values. - `Failure_RestrictionAccount_Invalid_Value`: Validation failed because the account restriction value is invalid. - `Failure_RestrictionAccount_Address_Interaction_Prohibited`: Validation failed because the addresses involved in the transaction are not allowed to interact. - `Failure_RestrictionAccount_Mosaic_Transfer_Prohibited`: Validation failed because the mosaic transfer is prohibited by the recipient. - `Failure_RestrictionAccount_Operation_Type_Prohibited`: Validation failed because the operation type is not allowed to be initiated by the signer. - `Failure_RestrictionMosaic_Invalid_Restriction_Type`: Validation failed because the mosaic restriction type is invalid. - `Failure_RestrictionMosaic_Previous_Value_Mismatch`: Validation failed because specified previous value does not match current value. - `Failure_RestrictionMosaic_Previous_Value_Must_Be_Zero`: Validation failed because specified previous value is nonzero. - `Failure_RestrictionMosaic_Max_Restrictions_Exceeded`: Validation failed because the maximum number of restrictions would be exceeded. - `Failure_RestrictionMosaic_Cannot_Delete_Nonexistent_Restriction` - Validation failed because nonexistent restriction cannot be deleted. - `Failure_RestrictionMosaic_Unknown_Global_Restriction`: Validation failed because required global restriction does not exist. - `Failure_RestrictionMosaic_Invalid_Global_Restriction`: Validation failed because mosaic has invalid global restriction. - `Failure_RestrictionMosaic_Account_Unauthorized`: Validation failed because account lacks proper permissions to move mosaic. - `Failure_Transfer_Message_Too_Large`: Validation failed because the message is too large. - `Failure_Transfer_Out_Of_Order_Mosaics`: Validation failed because mosaics are out of order. - `Failure_Chain_Unlinked`: Validation failed because a block was received that did not link with the existing chain. - `Failure_Chain_Block_Not_Hit`: Validation failed because a block was received that is not a hit. - `Failure_Chain_Block_Inconsistent_State_Hash`: Validation failed because a block was received that has an inconsistent state hash. - `Failure_Chain_Block_Inconsistent_Receipts_Hash`: Validation failed because a block was received that has an inconsistent receipts hash. - `Failure_Chain_Block_Invalid_Vrf_Proof`: Validation failed because the Vrf proof is invalid. - `Failure_Chain_Block_Unknown_Signer`: Validation failed because the block signer is unknown. - `Failure_Chain_Unconfirmed_Cache_Too_Full`: Validation failed because the unconfirmed cache is too full. - `Failure_Consumer_Empty_Input`: Validation failed because the consumer input is empty. - `Failure_Consumer_Block_Transactions_Hash_Mismatch`: Validation failed because the block transactions hash does not match the calculated value. - `Neutral_Consumer_Hash_In_Recency_Cache`: Validation failed because an entity hash is present in the recency cache. - `Failure_Consumer_Remote_Chain_Improper_Link`: Validation failed because the chain is internally improperly linked. - `Failure_Consumer_Remote_Chain_Duplicate_Transactions`: Validation failed because the chain part contains duplicate transactions. - `Failure_Consumer_Remote_Chain_Unlinked`: Validation failed because the chain part does not link to the current chain. - `Failure_Consumer_Remote_Chain_Difficulties_Mismatch`: Validation failed because the remote chain difficulties do not match the calculated difficulties. - `Failure_Consumer_Remote_Chain_Score_Not_Better`: Validation failed because the remote chain score is not better. - `Failure_Consumer_Remote_Chain_Too_Far_Behind`: Validation failed because the remote chain is too far behind. - `Failure_Consumer_Remote_Chain_Too_Far_In_Future`: Validation failed because the remote chain timestamp is too far in the future. - `Failure_Consumer_Batch_Signature_Not_Verifiable`: Validation failed because the verification of the signature failed during a batch operation. - `Failure_Consumer_Remote_Chain_Improper_Importance_Link`: Validation failed because the remote chain has an improper importance link. - `Failure_Extension_Partial_Transaction_Cache_Prune`: Validation failed because the partial transaction was pruned from the temporal cache. - `Failure_Extension_Partial_Transaction_Dependency_Removed`: Validation failed because the partial transaction was pruned from the temporal cache due to its dependency being removed. - `Failure_Extension_Read_Rate_Limit_Exceeded`: Validation failed because socket read rate limit was exceeded. * @export * @enum {string} */ export declare const TransactionStatusEnum: { readonly Success: "Success"; readonly Neutral: "Neutral"; readonly Failure: "Failure"; readonly FailureCorePastDeadline: "Failure_Core_Past_Deadline"; readonly FailureCoreFutureDeadline: "Failure_Core_Future_Deadline"; readonly FailureCoreInsufficientBalance: "Failure_Core_Insufficient_Balance"; readonly FailureCoreTooManyTransactions: "Failure_Core_Too_Many_Transactions"; readonly FailureCoreNemesisAccountSignedAfterNemesisBlock: "Failure_Core_Nemesis_Account_Signed_After_Nemesis_Block"; readonly FailureCoreWrongNetwork: "Failure_Core_Wrong_Network"; readonly FailureCoreInvalidAddress: "Failure_Core_Invalid_Address"; readonly FailureCoreInvalidVersion: "Failure_Core_Invalid_Version"; readonly FailureCoreInvalidTransactionFee: "Failure_Core_Invalid_Transaction_Fee"; readonly FailureCoreBlockHarvesterIneligible: "Failure_Core_Block_Harvester_Ineligible"; readonly FailureCoreZeroAddress: "Failure_Core_Zero_Address"; readonly FailureCoreZeroPublicKey: "Failure_Core_Zero_Public_Key"; readonly FailureCoreNonzeroInternalPadding: "Failure_Core_Nonzero_Internal_Padding"; readonly FailureCoreAddressCollision: "Failure_Core_Address_Collision"; readonly FailureCoreImportanceBlockMismatch: "Failure_Core_Importance_Block_Mismatch"; readonly FailureCoreUnexpectedBlockType: "Failure_Core_Unexpected_Block_Type"; readonly FailureCoreInvalidLinkAction: "Failure_Core_Invalid_Link_Action"; readonly FailureCoreLinkAlreadyExists: "Failure_Core_Link_Already_Exists"; readonly FailureCoreInconsistentUnlinkData: "Failure_Core_Inconsistent_Unlink_Data"; readonly FailureCoreInvalidLinkRange: "Failure_Core_Invalid_Link_Range"; readonly FailureCoreTooManyLinks: "Failure_Core_Too_Many_Links"; readonly FailureCoreLinkStartEpochInvalid: "Failure_Core_Link_Start_Epoch_Invalid"; readonly FailureHashAlreadyExists: "Failure_Hash_Already_Exists"; readonly FailureSignatureNotVerifiable: "Failure_Signature_Not_Verifiable"; readonly FailureAccountLinkLinkAlreadyExists: "Failure_AccountLink_Link_Already_Exists"; readonly FailureAccountLinkInconsistentUnlinkData: "Failure_AccountLink_Inconsistent_Unlink_Data"; readonly FailureAccountLinkUnknownLink: "Failure_AccountLink_Unknown_Link"; readonly FailureAccountLinkRemoteAccountIneligible: "Failure_AccountLink_Remote_Account_Ineligible"; readonly FailureAccountLinkRemoteAccountSignerProhibited: "Failure_AccountLink_Remote_Account_Signer_Prohibited"; readonly FailureAccountLinkRemoteAccountParticipantProhibited: "Failure_AccountLink_Remote_Account_Participant_Prohibited"; readonly FailureAggregateTooManyTransactions: "Failure_Aggregate_Too_Many_Transactions"; readonly FailureAggregateNoTransactions: "Failure_Aggregate_No_Transactions"; readonly FailureAggregateTooManyCosignatures: "Failure_Aggregate_Too_Many_Cosignatures"; readonly FailureAggregateRedundantCosignatures: "Failure_Aggregate_Redundant_Cosignatures"; readonly FailureAggregateIneligibleCosignatories: "Failure_Aggregate_Ineligible_Cosignatories"; readonly FailureAggregateMissingCosignatures: "Failure_Aggregate_Missing_Cosignatures"; readonly FailureAggregateTransactionsHashMismatch: "Failure_Aggregate_Transactions_Hash_Mismatch"; readonly FailureAggregateV1Prohibited: "Failure_Aggregate_V1_Prohibited"; readonly FailureAggregateV2Prohibited: "Failure_Aggregate_V2_Prohibited"; readonly FailureAggregateV3Prohibited: "Failure_Aggregate_V3_Prohibited"; readonly FailureLockHashInvalidMosaicId: "Failure_LockHash_Invalid_Mosaic_Id"; readonly FailureLockHashInvalidMosaicAmount: "Failure_LockHash_Invalid_Mosaic_Amount"; readonly FailureLockHashHashAlreadyExists: "Failure_LockHash_Hash_Already_Exists"; readonly FailureLockHashUnknownHash: "Failure_LockHash_Unknown_Hash"; readonly FailureLockHashInactiveHash: "Failure_LockHash_Inactive_Hash"; readonly FailureLockHashInvalidDuration: "Failure_LockHash_Invalid_Duration"; readonly FailureLockSecretInvalidHashAlgorithm: "Failure_LockSecret_Invalid_Hash_Algorithm"; readonly FailureLockSecretHashAlreadyExists: "Failure_LockSecret_Hash_Already_Exists"; readonly FailureLockSecretProofSizeOutOfBounds: "Failure_LockSecret_Proof_Size_Out_Of_Bounds"; readonly FailureLockSecretSecretMismatch: "Failure_LockSecret_Secret_Mismatch"; readonly FailureLockSecretUnknownCompositeKey: "Failure_LockSecret_Unknown_Composite_Key"; readonly FailureLockSecretInactiveSecret: "Failure_LockSecret_Inactive_Secret"; readonly FailureLockSecretHashAlgorithmMismatch: "Failure_LockSecret_Hash_Algorithm_Mismatch"; readonly FailureLockSecretInvalidDuration: "Failure_LockSecret_Invalid_Duration"; readonly FailureMetadataValueTooSmall: "Failure_Metadata_Value_Too_Small"; readonly FailureMetadataValueTooLarge: "Failure_Metadata_Value_Too_Large"; readonly FailureMetadataValueSizeDeltaTooLarge: "Failure_Metadata_Value_Size_Delta_Too_Large"; readonly FailureMetadataValueSizeDeltaMismatch: "Failure_Metadata_Value_Size_Delta_Mismatch"; readonly FailureMetadataValueChangeIrreversible: "Failure_Metadata_Value_Change_Irreversible"; readonly FailureMosaicInvalidDuration: "Failure_Mosaic_Invalid_Duration"; readonly FailureMosaicInvalidName: "Failure_Mosaic_Invalid_Name"; readonly FailureMosaicNameIdMismatch: "Failure_Mosaic_Name_Id_Mismatch"; readonly FailureMosaicExpired: "Failure_Mosaic_Expired"; readonly FailureMosaicOwnerConflict: "Failure_Mosaic_Owner_Conflict"; readonly FailureMosaicIdMismatch: "Failure_Mosaic_Id_Mismatch"; readonly FailureMosaicParentIdConflict: "Failure_Mosaic_Parent_Id_Conflict"; readonly FailureMosaicInvalidProperty: "Failure_Mosaic_Invalid_Property"; readonly FailureMosaicInvalidFlags: "Failure_Mosaic_Invalid_Flags"; readonly FailureMosaicInvalidDivisibility: "Failure_Mosaic_Invalid_Divisibility"; readonly FailureMosaicInvalidSupplyChangeAction: "Failure_Mosaic_Invalid_Supply_Change_Action"; readonly FailureMosaicInvalidSupplyChangeAmount: "Failure_Mosaic_Invalid_Supply_Change_Amount"; readonly FailureMosaicInvalidId: "Failure_Mosaic_Invalid_Id"; readonly FailureMosaicModificationDisallowed: "Failure_Mosaic_Modification_Disallowed"; readonly FailureMosaicModificationNoChanges: "Failure_Mosaic_Modification_No_Changes"; readonly FailureMosaicSupplyImmutable: "Failure_Mosaic_Supply_Immutable"; readonly FailureMosaicSupplyNegative: "Failure_Mosaic_Supply_Negative"; readonly FailureMosaicSupplyExceeded: "Failure_Mosaic_Supply_Exceeded"; readonly FailureMosaicNonTransferable: "Failure_Mosaic_Non_Transferable"; readonly FailureMosaicMaxMosaicsExceeded: "Failure_Mosaic_Max_Mosaics_Exceeded"; readonly FailureMosaicRequiredPropertyFlagUnset: "Failure_Mosaic_Required_Property_Flag_Unset"; readonly FailureMultisigAccountInBothSets: "Failure_Multisig_Account_In_Both_Sets"; readonly FailureMultisigMultipleDeletes: "Failure_Multisig_Multiple_Deletes"; readonly FailureMultisigRedundantModification: "Failure_Multisig_Redundant_Modification"; readonly FailureMultisigUnknownMultisigAccount: "Failure_Multisig_Unknown_Multisig_Account"; readonly FailureMultisigNotACosignatory: "Failure_Multisig_Not_A_Cosignatory"; readonly FailureMultisigAlreadyACosignatory: "Failure_Multisig_Already_A_Cosignatory"; readonly FailureMultisigMinSettingOutOfRange: "Failure_Multisig_Min_Setting_Out_Of_Range"; readonly FailureMultisigMinSettingLargerThanNumCosignatories: "Failure_Multisig_Min_Setting_Larger_Than_Num_Cosignatories"; readonly FailureMultisigInvalidModificationAction: "Failure_Multisig_Invalid_Modification_Action"; readonly FailureMultisigMaxCosignedAccounts: "Failure_Multisig_Max_Cosigned_Accounts"; readonly FailureMultisigMaxCosignatories: "Failure_Multisig_Max_Cosignatories"; readonly FailureMultisigLoop: "Failure_Multisig_Loop"; readonly FailureMultisigMaxMultisigDepth: "Failure_Multisig_Max_Multisig_Depth"; readonly FailureMultisigOperationProhibitedByAccount: "Failure_Multisig_Operation_Prohibited_By_Account"; readonly FailureNamespaceInvalidDuration: "Failure_Namespace_Invalid_Duration"; readonly FailureNamespaceInvalidName: "Failure_Namespace_Invalid_Name"; readonly FailureNamespaceNameIdMismatch: "Failure_Namespace_Name_Id_Mismatch"; readonly FailureNamespaceExpired: "Failure_Namespace_Expired"; readonly FailureNamespaceOwnerConflict: "Failure_Namespace_Owner_Conflict"; readonly FailureNamespaceIdMismatch: "Failure_Namespace_Id_Mismatch"; readonly FailureNamespaceInvalidRegistrationType: "Failure_Namespace_Invalid_Registration_Type"; readonly FailureNamespaceRootNameReserved: "Failure_Namespace_Root_Name_Reserved"; readonly FailureNamespaceTooDeep: "Failure_Namespace_Too_Deep"; readonly FailureNamespaceUnknownParent: "Failure_Namespace_Unknown_Parent"; readonly FailureNamespaceAlreadyExists: "Failure_Namespace_Already_Exists"; readonly FailureNamespaceAlreadyActive: "Failure_Namespace_Already_Active"; readonly FailureNamespaceEternalAfterNemesisBlock: "Failure_Namespace_Eternal_After_Nemesis_Block"; readonly FailureNamespaceMaxChildrenExceeded: "Failure_Namespace_Max_Children_Exceeded"; readonly FailureNamespaceAliasInvalidAction: "Failure_Namespace_Alias_Invalid_Action"; readonly FailureNamespaceUnknown: "Failure_Namespace_Unknown"; readonly FailureNamespaceAliasAlreadyExists: "Failure_Namespace_Alias_Already_Exists"; readonly FailureNamespaceUnknownAlias: "Failure_Namespace_Unknown_Alias"; readonly FailureNamespaceAliasInconsistentUnlinkType: "Failure_Namespace_Alias_Inconsistent_Unlink_Type"; readonly FailureNamespaceAliasInconsistentUnlinkData: "Failure_Namespace_Alias_Inconsistent_Unlink_Data"; readonly FailureNamespaceAliasInvalidAddress: "Failure_Namespace_Alias_Invalid_Address"; readonly FailureRestrictionAccountInvalidRestrictionFlags: "Failure_RestrictionAccount_Invalid_Restriction_Flags"; readonly FailureRestrictionAccountInvalidModificationAction: "Failure_RestrictionAccount_Invalid_Modification_Action"; readonly FailureRestrictionAccountInvalidModificationAddress: "Failure_RestrictionAccount_Invalid_Modification_Address"; readonly FailureRestrictionAccountModificationOperationTypeIncompatible: "Failure_RestrictionAccount_Modification_Operation_Type_Incompatible"; readonly FailureRestrictionAccountRedundantModification: "Failure_RestrictionAccount_Redundant_Modification"; readonly FailureRestrictionAccountInvalidModification: "Failure_RestrictionAccount_Invalid_Modification"; readonly FailureRestrictionAccountModificationCountExceeded: "Failure_RestrictionAccount_Modification_Count_Exceeded"; readonly FailureRestrictionAccountNoModifications: "Failure_RestrictionAccount_No_Modifications"; readonly FailureRestrictionAccountValuesCountExceeded: "Failure_RestrictionAccount_Values_Count_Exceeded"; readonly FailureRestrictionAccountInvalidValue: "Failure_RestrictionAccount_Invalid_Value"; readonly FailureRestrictionAccountAddressInteractionProhibited: "Failure_RestrictionAccount_Address_Interaction_Prohibited"; readonly FailureRestrictionAccountMosaicTransferProhibited: "Failure_RestrictionAccount_Mosaic_Transfer_Prohibited"; readonly FailureRestrictionAccountOperationTypeProhibited: "Failure_RestrictionAccount_Operation_Type_Prohibited"; readonly FailureRestrictionMosaicInvalidRestrictionType: "Failure_RestrictionMosaic_Invalid_Restriction_Type"; readonly FailureRestrictionMosaicPreviousValueMismatch: "Failure_RestrictionMosaic_Previous_Value_Mismatch"; readonly FailureRestrictionMosaicPreviousValueMustBeZero: "Failure_RestrictionMosaic_Previous_Value_Must_Be_Zero"; readonly FailureRestrictionMosaicMaxRestrictionsExceeded: "Failure_RestrictionMosaic_Max_Restrictions_Exceeded"; readonly FailureRestrictionMosaicCannotDeleteNonexistentRestriction: "Failure_RestrictionMosaic_Cannot_Delete_Nonexistent_Restriction"; readonly FailureRestrictionMosaicUnknownGlobalRestriction: "Failure_RestrictionMosaic_Unknown_Global_Restriction"; readonly FailureRestrictionMosaicInvalidGlobalRestriction: "Failure_RestrictionMosaic_Invalid_Global_Restriction"; readonly FailureRestrictionMosaicAccountUnauthorized: "Failure_RestrictionMosaic_Account_Unauthorized"; readonly FailureTransferMessageTooLarge: "Failure_Transfer_Message_Too_Large"; readonly FailureTransferOutOfOrderMosaics: "Failure_Transfer_Out_Of_Order_Mosaics"; readonly FailureChainUnlinked: "Failure_Chain_Unlinked"; readonly FailureChainBlockNotHit: "Failure_Chain_Block_Not_Hit"; readonly FailureChainBlockInconsistentStateHash: "Failure_Chain_Block_Inconsistent_State_Hash"; readonly FailureChainBlockInconsistentReceiptsHash: "Failure_Chain_Block_Inconsistent_Receipts_Hash"; readonly FailureChainBlockInvalidVrfProof: "Failure_Chain_Block_Invalid_Vrf_Proof"; readonly FailureChainBlockUnknownSigner: "Failure_Chain_Block_Unknown_Signer"; readonly FailureChainUnconfirmedCacheTooFull: "Failure_Chain_Unconfirmed_Cache_Too_Full"; readonly FailureConsumerEmptyInput: "Failure_Consumer_Empty_Input"; readonly FailureConsumerBlockTransactionsHashMismatch: "Failure_Consumer_Block_Transactions_Hash_Mismatch"; readonly NeutralConsumerHashInRecencyCache: "Neutral_Consumer_Hash_In_Recency_Cache"; readonly FailureConsumerRemoteChainImproperLink: "Failure_Consumer_Remote_Chain_Improper_Link"; readonly FailureConsumerRemoteChainDuplicateTransactions: "Failure_Consumer_Remote_Chain_Duplicate_Transactions"; readonly FailureConsumerRemoteChainUnlinked: "Failure_Consumer_Remote_Chain_Unlinked"; readonly FailureConsumerRemoteChainDifficultiesMismatch: "Failure_Consumer_Remote_Chain_Difficulties_Mismatch"; readonly FailureConsumerRemoteChainScoreNotBetter: "Failure_Consumer_Remote_Chain_Score_Not_Better"; readonly FailureConsumerRemoteChainTooFarBehind: "Failure_Consumer_Remote_Chain_Too_Far_Behind"; readonly FailureConsumerRemoteChainTooFarInFuture: "Failure_Consumer_Remote_Chain_Too_Far_In_Future"; readonly FailureConsumerBatchSignatureNotVerifiable: "Failure_Consumer_Batch_Signature_Not_Verifiable"; readonly FailureConsumerRemoteChainImproperImportanceLink: "Failure_Consumer_Remote_Chain_Improper_Importance_Link"; readonly FailureExtensionPartialTransactionCachePrune: "Failure_Extension_Partial_Transaction_Cache_Prune"; readonly FailureExtensionPartialTransactionDependencyRemoved: "Failure_Extension_Partial_Transaction_Dependency_Removed"; readonly FailureExtensionReadRateLimitExceeded: "Failure_Extension_Read_Rate_Limit_Exceeded"; }; export type TransactionStatusEnum = typeof TransactionStatusEnum[keyof typeof TransactionStatusEnum]; /** * Numeric transaction type identifiers used on transaction payloads and search filters: - `0x414C` (`16716`): `AccountKeyLinkTransaction` - `0x4243` (`16963`): `VrfKeyLinkTransaction` - `0x4143` (`16707`): `VotingKeyLinkTransaction` - `0x424C` (`16972`): `NodeKeyLinkTransaction` - `0x4141` (`16705`): `AggregateCompleteTransaction` - `0x4241` (`16961`): `AggregateBondedTransaction` - `0x414D` (`16717`): `MosaicDefinitionTransaction` - `0x424D` (`16973`): `MosaicSupplyChangeTransaction` - `0x434D` (`17229`): `MosaicSupplyRevocationTransaction` - `0x414E` (`16718`): `NamespaceRegistrationTransaction` - `0x424E` (`16974`): `AddressAliasTransaction` - `0x434E` (`17230`): `MosaicAliasTransaction` - `0x4144` (`16708`): `AccountMetadataTransaction` - `0x4244` (`16964`): `MosaicMetadataTransaction` - `0x4344` (`17220`): `NamespaceMetadataTransaction` - `0x4155` (`16725`): `MultisigAccountModificationTransaction` - `0x4148` (`16712`): `HashLockTransaction` - `0x4152` (`16722`): `SecretLockTransaction` - `0x4252` (`16978`): `SecretProofTransaction` - `0x4150` (`16720`): `AccountAddressRestrictionTransaction` - `0x4250` (`16976`): `AccountMosaicRestrictionTransaction` - `0x4350` (`17232`): `AccountOperationRestrictionTransaction` - `0x4151` (`16721`): `MosaicGlobalRestrictionTransaction` - `0x4251` (`16977`): `MosaicAddressRestrictionTransaction` - `0x4154` (`16724`): `TransferTransaction` * @export * @enum {number} */ export declare const TransactionTypeEnum: { readonly NUMBER_16716: 16716; readonly NUMBER_16963: 16963; readonly NUMBER_16707: 16707; readonly NUMBER_16972: 16972; readonly NUMBER_16705: 16705; readonly NUMBER_16961: 16961; readonly NUMBER_16717: 16717; readonly NUMBER_16973: 16973; readonly NUMBER_17229: 17229; readonly NUMBER_16718: 16718; readonly NUMBER_16974: 16974; readonly NUMBER_17230: 17230; readonly NUMBER_16708: 16708; readonly NUMBER_16964: 16964; readonly NUMBER_17220: 17220; readonly NUMBER_16725: 16725; readonly NUMBER_16712: 16712; readonly NUMBER_16722: 16722; readonly NUMBER_16978: 16978; readonly NUMBER_16720: 16720; readonly NUMBER_16976: 16976; readonly NUMBER_17232: 17232; readonly NUMBER_16721: 16721; readonly NUMBER_16977: 16977; readonly NUMBER_16724: 16724; }; export type TransactionTypeEnum = typeof TransactionTypeEnum[keyof typeof TransactionTypeEnum]; /** * * @export * @interface TransferNetworkPropertiesDTO */ export interface TransferNetworkPropertiesDTO { /** * Maximum transaction message size. * @type {string} * @memberof TransferNetworkPropertiesDTO */ 'maxMessageSize'?: string; } /** * Transfer transaction body with the recipient, transferred mosaics, and optional message. * @export * @interface TransferTransactionBodyDTO */ export interface TransferTransactionBodyDTO { /** * 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 TransferTransactionBodyDTO */ 'recipientAddress': string; /** * Array of mosaics sent to the recipient. * @type {Array} * @memberof TransferTransactionBodyDTO */ 'mosaics': Array; /** * Optional transfer message payload, encoded as a hexadecimal string. * @type {string} * @memberof TransferTransactionBodyDTO */ 'message'?: string; } /** * Transaction to transfer mosaics and a message to another account. * @export * @interface TransferTransactionDTO */ export interface TransferTransactionDTO { /** * Unsigned 32-bit integer. Represented as integer since it fits in JSON number precision. * @type {number} * @memberof TransferTransactionDTO */ '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 TransferTransactionDTO */ 'signature': string; /** * 256-bit public key encoded as a hexadecimal string (64 hex characters). * @type {string} * @memberof TransferTransactionDTO */ 'signerPublicKey': string; /** * Entity version. Indicates the schema variant for serialization and validation. * @type {number} * @memberof TransferTransactionDTO */ 'version': number; /** * Network type (mainnet or testnet). Ensures the entity targets the correct network. * @type {NetworkTypeEnum} * @memberof TransferTransactionDTO */ 'network': NetworkTypeEnum; /** * Entity type identifier (e.g. transaction type code, block type). Determines the entity schema. * @type {number} * @memberof TransferTransactionDTO */ '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 TransferTransactionDTO */ '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 TransferTransactionDTO */ 'deadline': string; /** * 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 TransferTransactionDTO */ 'recipientAddress': string; /** * Array of mosaics sent to the recipient. * @type {Array} * @memberof TransferTransactionDTO */ 'mosaics': Array; /** * Optional transfer message payload, encoded as a hexadecimal string. * @type {string} * @memberof TransferTransactionDTO */ 'message'?: string; } /** * Public keys of accounts with [harvesting](https://docs.symbol.dev/concepts/harvesting.html) unlocked. **Only accounts harvesting on the node you are querying** are returned. The scope is limited to this node, not the entire network. * @export * @interface UnlockedAccountDTO */ export interface UnlockedAccountDTO { /** * Public keys of accounts harvesting on this node. * @type {Array} * @memberof UnlockedAccountDTO */ 'unlockedAccount': Array; } /** * * @export * @interface UnresolvedMosaic */ export interface UnresolvedMosaic { /** * 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 UnresolvedMosaic */ 'id': 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 UnresolvedMosaic */ 'amount': string; } /** * Verifiable entity base. Adds the `signature` field proving the entity was signed by the account identified in `signerPublicKey` (EntityDTO). Used by BlockDTO and TransactionDTO. The signature covers the serialized entity payload and can be verified using the signer\'s public key. * @export * @interface VerifiableEntityDTO */ export interface VerifiableEntityDTO { /** * 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 VerifiableEntityDTO */ 'signature': string; } /** * Voting key link transaction body that links or unlinks a voting key for a finalization epoch range. * @export * @interface VotingKeyLinkTransactionBodyDTO */ export interface VotingKeyLinkTransactionBodyDTO { /** * 32-byte voting public key used for finalization voting. * @type {string} * @memberof VotingKeyLinkTransactionBodyDTO */ '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 VotingKeyLinkTransactionBodyDTO */ '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 VotingKeyLinkTransactionBodyDTO */ 'endEpoch': number; /** * * @type {LinkActionEnum} * @memberof VotingKeyLinkTransactionBodyDTO */ 'linkAction': 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; } /** * 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; } /** * 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; } /** * AccountRoutesApi - axios parameter creator * @export */ export declare const AccountRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves account data for a given account identifier. The response contains the account state including balance, importance, public key, linked keys, and activity buckets. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account information * @param {string} accountId Account public key as 64 hexadecimal characters, or account address as 39 Base32 (network prefix `T` for testnet, `N` for mainnet). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountInfo: (accountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the Merkle proof data for a given account. The Merkle path can be used to independently verify that the account state is included in the block state hash. If no account state entry exists for the supplied account ID, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account state entry exists for the requested account. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account Merkle information * @param {string} accountId Account public key as 64 hexadecimal characters, or account address as 39 Base32 (network prefix `T` for testnet, `N` for mainnet). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountInfoMerkle: (accountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves account data for multiple accounts in a single request. This is the batch equivalent of the single-account endpoint. The request body accepts either an array of public keys or an array of addresses (not both). If both `publicKeys` and `addresses` are provided, the request is invalid and the server returns `409` error. * @summary Get accounts information * @param {AccountIds} [accountIds] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountsInfo: (accountIds?: AccountIds, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of accounts matching the given criteria. Results can be filtered by `address` and `mosaicId` (mosaic ownership), and ordered by `id` or `balance`. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `balance`; when using `orderBy=balance`, the `mosaicId` filter is required. The `offset` value must match the `orderBy` field. * @summary Search accounts * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {AccountOrderByEnum} [orderBy] Sort responses by the property set. If `balance` option is selected, the request must define the `mosaicId` filter. * @param {string} [mosaicId] Filter by mosaic identifier (include). * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccounts: (address?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, orderBy?: AccountOrderByEnum, mosaicId?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * AccountRoutesApi - functional programming interface * @export */ export declare const AccountRoutesApiFp: (configuration?: Configuration) => { /** * Retrieves account data for a given account identifier. The response contains the account state including balance, importance, public key, linked keys, and activity buckets. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account information * @param {string} accountId Account public key as 64 hexadecimal characters, or account address as 39 Base32 (network prefix `T` for testnet, `N` for mainnet). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountInfo(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the Merkle proof data for a given account. The Merkle path can be used to independently verify that the account state is included in the block state hash. If no account state entry exists for the supplied account ID, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account state entry exists for the requested account. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account Merkle information * @param {string} accountId Account public key as 64 hexadecimal characters, or account address as 39 Base32 (network prefix `T` for testnet, `N` for mainnet). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountInfoMerkle(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves account data for multiple accounts in a single request. This is the batch equivalent of the single-account endpoint. The request body accepts either an array of public keys or an array of addresses (not both). If both `publicKeys` and `addresses` are provided, the request is invalid and the server returns `409` error. * @summary Get accounts information * @param {AccountIds} [accountIds] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountsInfo(accountIds?: AccountIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a paginated list of accounts matching the given criteria. Results can be filtered by `address` and `mosaicId` (mosaic ownership), and ordered by `id` or `balance`. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `balance`; when using `orderBy=balance`, the `mosaicId` filter is required. The `offset` value must match the `orderBy` field. * @summary Search accounts * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {AccountOrderByEnum} [orderBy] Sort responses by the property set. If `balance` option is selected, the request must define the `mosaicId` filter. * @param {string} [mosaicId] Filter by mosaic identifier (include). * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccounts(address?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, orderBy?: AccountOrderByEnum, mosaicId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountRoutesApi - factory interface * @export */ export declare const AccountRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves account data for a given account identifier. The response contains the account state including balance, importance, public key, linked keys, and activity buckets. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account information * @param {AccountRoutesApiGetAccountInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountInfo(requestParameters: AccountRoutesApiGetAccountInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the Merkle proof data for a given account. The Merkle path can be used to independently verify that the account state is included in the block state hash. If no account state entry exists for the supplied account ID, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account state entry exists for the requested account. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account Merkle information * @param {AccountRoutesApiGetAccountInfoMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountInfoMerkle(requestParameters: AccountRoutesApiGetAccountInfoMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves account data for multiple accounts in a single request. This is the batch equivalent of the single-account endpoint. The request body accepts either an array of public keys or an array of addresses (not both). If both `publicKeys` and `addresses` are provided, the request is invalid and the server returns `409` error. * @summary Get accounts information * @param {AccountRoutesApiGetAccountsInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountsInfo(requestParameters?: AccountRoutesApiGetAccountsInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a paginated list of accounts matching the given criteria. Results can be filtered by `address` and `mosaicId` (mosaic ownership), and ordered by `id` or `balance`. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `balance`; when using `orderBy=balance`, the `mosaicId` filter is required. The `offset` value must match the `orderBy` field. * @summary Search accounts * @param {AccountRoutesApiSearchAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccounts(requestParameters?: AccountRoutesApiSearchAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getAccountInfo operation in AccountRoutesApi. * @export * @interface AccountRoutesApiGetAccountInfoRequest */ export interface AccountRoutesApiGetAccountInfoRequest { /** * Account public key as 64 hexadecimal characters, or account address as 39 Base32 (network prefix `T` for testnet, `N` for mainnet). * @type {string} * @memberof AccountRoutesApiGetAccountInfo */ readonly accountId: string; } /** * Request parameters for getAccountInfoMerkle operation in AccountRoutesApi. * @export * @interface AccountRoutesApiGetAccountInfoMerkleRequest */ export interface AccountRoutesApiGetAccountInfoMerkleRequest { /** * Account public key as 64 hexadecimal characters, or account address as 39 Base32 (network prefix `T` for testnet, `N` for mainnet). * @type {string} * @memberof AccountRoutesApiGetAccountInfoMerkle */ readonly accountId: string; } /** * Request parameters for getAccountsInfo operation in AccountRoutesApi. * @export * @interface AccountRoutesApiGetAccountsInfoRequest */ export interface AccountRoutesApiGetAccountsInfoRequest { /** * * @type {AccountIds} * @memberof AccountRoutesApiGetAccountsInfo */ readonly accountIds?: AccountIds; } /** * Request parameters for searchAccounts operation in AccountRoutesApi. * @export * @interface AccountRoutesApiSearchAccountsRequest */ export interface AccountRoutesApiSearchAccountsRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof AccountRoutesApiSearchAccounts */ readonly address?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof AccountRoutesApiSearchAccounts */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof AccountRoutesApiSearchAccounts */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof AccountRoutesApiSearchAccounts */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof AccountRoutesApiSearchAccounts */ readonly order?: Order; /** * Sort responses by the property set. If `balance` option is selected, the request must define the `mosaicId` filter. * @type {AccountOrderByEnum} * @memberof AccountRoutesApiSearchAccounts */ readonly orderBy?: AccountOrderByEnum; /** * Filter by mosaic identifier (include). * @type {string} * @memberof AccountRoutesApiSearchAccounts */ readonly mosaicId?: string; } /** * AccountRoutesApi - object-oriented interface * @export * @class AccountRoutesApi * @extends {BaseAPI} */ export declare class AccountRoutesApi extends BaseAPI { /** * Retrieves account data for a given account identifier. The response contains the account state including balance, importance, public key, linked keys, and activity buckets. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account information * @param {AccountRoutesApiGetAccountInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountRoutesApi */ getAccountInfo(requestParameters: AccountRoutesApiGetAccountInfoRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the Merkle proof data for a given account. The Merkle path can be used to independently verify that the account state is included in the block state hash. If no account state entry exists for the supplied account ID, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account state entry exists for the requested account. The `accountId` path parameter accepts either a public key or a Base32-encoded address. * @summary Get account Merkle information * @param {AccountRoutesApiGetAccountInfoMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountRoutesApi */ getAccountInfoMerkle(requestParameters: AccountRoutesApiGetAccountInfoMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves account data for multiple accounts in a single request. This is the batch equivalent of the single-account endpoint. The request body accepts either an array of public keys or an array of addresses (not both). If both `publicKeys` and `addresses` are provided, the request is invalid and the server returns `409` error. * @summary Get accounts information * @param {AccountRoutesApiGetAccountsInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountRoutesApi */ getAccountsInfo(requestParameters?: AccountRoutesApiGetAccountsInfoRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of accounts matching the given criteria. Results can be filtered by `address` and `mosaicId` (mosaic ownership), and ordered by `id` or `balance`. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `balance`; when using `orderBy=balance`, the `mosaicId` filter is required. The `offset` value must match the `orderBy` field. * @summary Search accounts * @param {AccountRoutesApiSearchAccountsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountRoutesApi */ searchAccounts(requestParameters?: AccountRoutesApiSearchAccountsRequest, options?: RawAxiosRequestConfig): Promise>; } /** * BlockRoutesApi - axios parameter creator * @export */ export declare const BlockRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the block at the given height. The response includes the block header, harvester signature, and block metadata (hash, total fee, generation hash, transaction and statement counts). If the block is an importance block, the response additionally contains voting-eligible and harvesting-eligible account counts, total voting balance, and the previous importance block hash. * @summary Get block information * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBlockByHeight: (height: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [receipt statement or resolution](https://docs.symbol.dev/concepts/receipt.html) linked to a block. The `hash` parameter is the receipt statement hash, not the transaction hash. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.receiptsHash`) to verify if the statement was linked with the block. * @summary Get the Merkle path for a given receipt statement hash and block * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {string} hash Receipt statement hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMerkleReceipts: (height: string, hash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [transaction](https://docs.symbol.dev/concepts/transaction.html) included in a block. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.transactionsHash`) to verify if the transaction was included in the block. * @summary Get the Merkle path for a given transaction and block * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {string} hash Transaction hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMerkleTransaction: (height: string, hash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of blocks matching the given criteria. Results can be filtered by harvester (`signerPublicKey`), `beneficiaryAddress`, and timestamp range. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `height`. The `offset` value must match the `orderBy` field. * @summary Search blocks * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [beneficiaryAddress] Filter by beneficiary address (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {BlockOrderByEnum} [orderBy] Sort responses by the property set. Defaults to `id` when not specified. * @param {string} [fromTimestamp] Only blocks with timestamp greater or equal than this one are returned. The timestamp is expressed in milliseconds since the nemesis block. * @param {string} [toTimestamp] Only blocks with timestamp smaller or equal than this one are returned. The timestamp is expressed in milliseconds since the nemesis block. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchBlocks: (signerPublicKey?: string, beneficiaryAddress?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, orderBy?: BlockOrderByEnum, fromTimestamp?: string, toTimestamp?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * BlockRoutesApi - functional programming interface * @export */ export declare const BlockRoutesApiFp: (configuration?: Configuration) => { /** * Returns the block at the given height. The response includes the block header, harvester signature, and block metadata (hash, total fee, generation hash, transaction and statement counts). If the block is an importance block, the response additionally contains voting-eligible and harvesting-eligible account counts, total voting balance, and the previous importance block hash. * @summary Get block information * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBlockByHeight(height: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [receipt statement or resolution](https://docs.symbol.dev/concepts/receipt.html) linked to a block. The `hash` parameter is the receipt statement hash, not the transaction hash. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.receiptsHash`) to verify if the statement was linked with the block. * @summary Get the Merkle path for a given receipt statement hash and block * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {string} hash Receipt statement hash. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMerkleReceipts(height: string, hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [transaction](https://docs.symbol.dev/concepts/transaction.html) included in a block. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.transactionsHash`) to verify if the transaction was included in the block. * @summary Get the Merkle path for a given transaction and block * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {string} hash Transaction hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMerkleTransaction(height: string, hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of blocks matching the given criteria. Results can be filtered by harvester (`signerPublicKey`), `beneficiaryAddress`, and timestamp range. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `height`. The `offset` value must match the `orderBy` field. * @summary Search blocks * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [beneficiaryAddress] Filter by beneficiary address (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {BlockOrderByEnum} [orderBy] Sort responses by the property set. Defaults to `id` when not specified. * @param {string} [fromTimestamp] Only blocks with timestamp greater or equal than this one are returned. The timestamp is expressed in milliseconds since the nemesis block. * @param {string} [toTimestamp] Only blocks with timestamp smaller or equal than this one are returned. The timestamp is expressed in milliseconds since the nemesis block. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchBlocks(signerPublicKey?: string, beneficiaryAddress?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, orderBy?: BlockOrderByEnum, fromTimestamp?: string, toTimestamp?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * BlockRoutesApi - factory interface * @export */ export declare const BlockRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the block at the given height. The response includes the block header, harvester signature, and block metadata (hash, total fee, generation hash, transaction and statement counts). If the block is an importance block, the response additionally contains voting-eligible and harvesting-eligible account counts, total voting balance, and the previous importance block hash. * @summary Get block information * @param {BlockRoutesApiGetBlockByHeightRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBlockByHeight(requestParameters: BlockRoutesApiGetBlockByHeightRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [receipt statement or resolution](https://docs.symbol.dev/concepts/receipt.html) linked to a block. The `hash` parameter is the receipt statement hash, not the transaction hash. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.receiptsHash`) to verify if the statement was linked with the block. * @summary Get the Merkle path for a given receipt statement hash and block * @param {BlockRoutesApiGetMerkleReceiptsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMerkleReceipts(requestParameters: BlockRoutesApiGetMerkleReceiptsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [transaction](https://docs.symbol.dev/concepts/transaction.html) included in a block. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.transactionsHash`) to verify if the transaction was included in the block. * @summary Get the Merkle path for a given transaction and block * @param {BlockRoutesApiGetMerkleTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMerkleTransaction(requestParameters: BlockRoutesApiGetMerkleTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of blocks matching the given criteria. Results can be filtered by harvester (`signerPublicKey`), `beneficiaryAddress`, and timestamp range. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `height`. The `offset` value must match the `orderBy` field. * @summary Search blocks * @param {BlockRoutesApiSearchBlocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchBlocks(requestParameters?: BlockRoutesApiSearchBlocksRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getBlockByHeight operation in BlockRoutesApi. * @export * @interface BlockRoutesApiGetBlockByHeightRequest */ export interface BlockRoutesApiGetBlockByHeightRequest { /** * Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @type {string} * @memberof BlockRoutesApiGetBlockByHeight */ readonly height: string; } /** * Request parameters for getMerkleReceipts operation in BlockRoutesApi. * @export * @interface BlockRoutesApiGetMerkleReceiptsRequest */ export interface BlockRoutesApiGetMerkleReceiptsRequest { /** * Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @type {string} * @memberof BlockRoutesApiGetMerkleReceipts */ readonly height: string; /** * Receipt statement hash. * @type {string} * @memberof BlockRoutesApiGetMerkleReceipts */ readonly hash: string; } /** * Request parameters for getMerkleTransaction operation in BlockRoutesApi. * @export * @interface BlockRoutesApiGetMerkleTransactionRequest */ export interface BlockRoutesApiGetMerkleTransactionRequest { /** * Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @type {string} * @memberof BlockRoutesApiGetMerkleTransaction */ readonly height: string; /** * Transaction hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof BlockRoutesApiGetMerkleTransaction */ readonly hash: string; } /** * Request parameters for searchBlocks operation in BlockRoutesApi. * @export * @interface BlockRoutesApiSearchBlocksRequest */ export interface BlockRoutesApiSearchBlocksRequest { /** * Filter transactions by the public key of the signing account (include). * @type {string} * @memberof BlockRoutesApiSearchBlocks */ readonly signerPublicKey?: string; /** * Filter by beneficiary address (include). * @type {string} * @memberof BlockRoutesApiSearchBlocks */ readonly beneficiaryAddress?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof BlockRoutesApiSearchBlocks */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof BlockRoutesApiSearchBlocks */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof BlockRoutesApiSearchBlocks */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof BlockRoutesApiSearchBlocks */ readonly order?: Order; /** * Sort responses by the property set. Defaults to `id` when not specified. * @type {BlockOrderByEnum} * @memberof BlockRoutesApiSearchBlocks */ readonly orderBy?: BlockOrderByEnum; /** * Only blocks with timestamp greater or equal than this one are returned. The timestamp is expressed in milliseconds since the nemesis block. * @type {string} * @memberof BlockRoutesApiSearchBlocks */ readonly fromTimestamp?: string; /** * Only blocks with timestamp smaller or equal than this one are returned. The timestamp is expressed in milliseconds since the nemesis block. * @type {string} * @memberof BlockRoutesApiSearchBlocks */ readonly toTimestamp?: string; } /** * BlockRoutesApi - object-oriented interface * @export * @class BlockRoutesApi * @extends {BaseAPI} */ export declare class BlockRoutesApi extends BaseAPI { /** * Returns the block at the given height. The response includes the block header, harvester signature, and block metadata (hash, total fee, generation hash, transaction and statement counts). If the block is an importance block, the response additionally contains voting-eligible and harvesting-eligible account counts, total voting balance, and the previous importance block hash. * @summary Get block information * @param {BlockRoutesApiGetBlockByHeightRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BlockRoutesApi */ getBlockByHeight(requestParameters: BlockRoutesApiGetBlockByHeightRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [receipt statement or resolution](https://docs.symbol.dev/concepts/receipt.html) linked to a block. The `hash` parameter is the receipt statement hash, not the transaction hash. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.receiptsHash`) to verify if the statement was linked with the block. * @summary Get the Merkle path for a given receipt statement hash and block * @param {BlockRoutesApiGetMerkleReceiptsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BlockRoutesApi */ getMerkleReceipts(requestParameters: BlockRoutesApiGetMerkleReceiptsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the [Merkle path](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a [transaction](https://docs.symbol.dev/concepts/transaction.html) included in a block. The Merkle path is the minimum number of nodes needed to calculate the Merkle root. Steps to calculate the Merkle root: 1. proofHash = hash (leaf). 2. Concatenate proofHash with the first unprocessed item from the merklePath list as follows: - `left`: the item hash is concatenated before the proofHash (proofHash = sha_256(item.hash + proofHash)). - `right`: the item hash is concatenated after the proofHash (proofHash = sha_256(proofHash + item.hash)). 3. Repeat 2. for every item in the merklePath list. 4. Compare if the calculated proofHash equals the one recorded in the [block header](https://docs.symbol.dev/concepts/block.html) (`block.transactionsHash`) to verify if the transaction was included in the block. * @summary Get the Merkle path for a given transaction and block * @param {BlockRoutesApiGetMerkleTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BlockRoutesApi */ getMerkleTransaction(requestParameters: BlockRoutesApiGetMerkleTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of blocks matching the given criteria. Results can be filtered by harvester (`signerPublicKey`), `beneficiaryAddress`, and timestamp range. Standard pagination parameters (`pageSize`, `pageNumber`, `offset`, `order`) apply. The `orderBy` parameter supports `id` and `height`. The `offset` value must match the `orderBy` field. * @summary Search blocks * @param {BlockRoutesApiSearchBlocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BlockRoutesApi */ searchBlocks(requestParameters?: BlockRoutesApiSearchBlocksRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ChainRoutesApi - axios parameter creator * @export */ export declare const ChainRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the current state of the blockchain: chain height, chain score, and the latest finalized block. * @summary Get chain information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChainInfo: (options?: RawAxiosRequestConfig) => Promise; }; /** * ChainRoutesApi - functional programming interface * @export */ export declare const ChainRoutesApiFp: (configuration?: Configuration) => { /** * Returns the current state of the blockchain: chain height, chain score, and the latest finalized block. * @summary Get chain information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChainInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ChainRoutesApi - factory interface * @export */ export declare const ChainRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the current state of the blockchain: chain height, chain score, and the latest finalized block. * @summary Get chain information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChainInfo(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ChainRoutesApi - object-oriented interface * @export * @class ChainRoutesApi * @extends {BaseAPI} */ export declare class ChainRoutesApi extends BaseAPI { /** * Returns the current state of the blockchain: chain height, chain score, and the latest finalized block. * @summary Get chain information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChainRoutesApi */ getChainInfo(options?: RawAxiosRequestConfig): Promise>; } /** * FinalizationRoutesApi - axios parameter creator * @export */ export declare const FinalizationRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the finalization proof for the greatest block height associated with the given finalization epoch. * @summary Get finalization proof at epoch * @param {number} epoch The finalization epoch is a sequential integer. Each epoch groups a set of blocks for finalization voting (interval defined by network config, e.g. 1440 blocks for mainnet). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFinalizationProofAtEpoch: (epoch: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns the finalization proof for the block at the given height. * @summary Get finalization proof at height * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFinalizationProofAtHeight: (height: string, options?: RawAxiosRequestConfig) => Promise; }; /** * FinalizationRoutesApi - functional programming interface * @export */ export declare const FinalizationRoutesApiFp: (configuration?: Configuration) => { /** * Returns the finalization proof for the greatest block height associated with the given finalization epoch. * @summary Get finalization proof at epoch * @param {number} epoch The finalization epoch is a sequential integer. Each epoch groups a set of blocks for finalization voting (interval defined by network config, e.g. 1440 blocks for mainnet). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFinalizationProofAtEpoch(epoch: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the finalization proof for the block at the given height. * @summary Get finalization proof at height * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFinalizationProofAtHeight(height: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FinalizationRoutesApi - factory interface * @export */ export declare const FinalizationRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the finalization proof for the greatest block height associated with the given finalization epoch. * @summary Get finalization proof at epoch * @param {FinalizationRoutesApiGetFinalizationProofAtEpochRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFinalizationProofAtEpoch(requestParameters: FinalizationRoutesApiGetFinalizationProofAtEpochRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the finalization proof for the block at the given height. * @summary Get finalization proof at height * @param {FinalizationRoutesApiGetFinalizationProofAtHeightRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFinalizationProofAtHeight(requestParameters: FinalizationRoutesApiGetFinalizationProofAtHeightRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getFinalizationProofAtEpoch operation in FinalizationRoutesApi. * @export * @interface FinalizationRoutesApiGetFinalizationProofAtEpochRequest */ export interface FinalizationRoutesApiGetFinalizationProofAtEpochRequest { /** * The finalization epoch is a sequential integer. Each epoch groups a set of blocks for finalization voting (interval defined by network config, e.g. 1440 blocks for mainnet). * @type {number} * @memberof FinalizationRoutesApiGetFinalizationProofAtEpoch */ readonly epoch: number; } /** * Request parameters for getFinalizationProofAtHeight operation in FinalizationRoutesApi. * @export * @interface FinalizationRoutesApiGetFinalizationProofAtHeightRequest */ export interface FinalizationRoutesApiGetFinalizationProofAtHeightRequest { /** * Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @type {string} * @memberof FinalizationRoutesApiGetFinalizationProofAtHeight */ readonly height: string; } /** * FinalizationRoutesApi - object-oriented interface * @export * @class FinalizationRoutesApi * @extends {BaseAPI} */ export declare class FinalizationRoutesApi extends BaseAPI { /** * Returns the finalization proof for the greatest block height associated with the given finalization epoch. * @summary Get finalization proof at epoch * @param {FinalizationRoutesApiGetFinalizationProofAtEpochRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FinalizationRoutesApi */ getFinalizationProofAtEpoch(requestParameters: FinalizationRoutesApiGetFinalizationProofAtEpochRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the finalization proof for the block at the given height. * @summary Get finalization proof at height * @param {FinalizationRoutesApiGetFinalizationProofAtHeightRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FinalizationRoutesApi */ getFinalizationProofAtHeight(requestParameters: FinalizationRoutesApiGetFinalizationProofAtHeightRequest, options?: RawAxiosRequestConfig): Promise>; } /** * HashLockRoutesApi - axios parameter creator * @export */ export declare const HashLockRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock information * @param {string} hash Filter by hash (include). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLock: (hash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the state Merkle proof for the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock Merkle information * @param {string} hash Filter by hash (include). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLockMerkle: (hash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns hash lock entries for the given array of aggregate bonded transaction hashes. * @summary Get hash lock information for an array of hashes * @param {TransactionHashes} transactionHashes Request body containing an array of transaction hashes to look up. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLocks: (transactionHashes: TransactionHashes, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of hash lock entries created by the given account address. * @summary Search hash lock entries by account * @param {string} address Account address in Base32-encoded format. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountHashLocks: (address: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of hash lock entries, optionally filtered by owner address. * @summary Search hash lock entries * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchHashLock: (address?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * HashLockRoutesApi - functional programming interface * @export */ export declare const HashLockRoutesApiFp: (configuration?: Configuration) => { /** * Returns the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock information * @param {string} hash Filter by hash (include). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLock(hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the state Merkle proof for the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock Merkle information * @param {string} hash Filter by hash (include). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLockMerkle(hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns hash lock entries for the given array of aggregate bonded transaction hashes. * @summary Get hash lock information for an array of hashes * @param {TransactionHashes} transactionHashes Request body containing an array of transaction hashes to look up. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLocks(transactionHashes: TransactionHashes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a paginated list of hash lock entries created by the given account address. * @summary Search hash lock entries by account * @param {string} address Account address in Base32-encoded format. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountHashLocks(address: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of hash lock entries, optionally filtered by owner address. * @summary Search hash lock entries * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchHashLock(address?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * HashLockRoutesApi - factory interface * @export */ export declare const HashLockRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock information * @param {HashLockRoutesApiGetHashLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLock(requestParameters: HashLockRoutesApiGetHashLockRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the state Merkle proof for the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock Merkle information * @param {HashLockRoutesApiGetHashLockMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLockMerkle(requestParameters: HashLockRoutesApiGetHashLockMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns hash lock entries for the given array of aggregate bonded transaction hashes. * @summary Get hash lock information for an array of hashes * @param {HashLockRoutesApiGetHashLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHashLocks(requestParameters: HashLockRoutesApiGetHashLocksRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a paginated list of hash lock entries created by the given account address. * @summary Search hash lock entries by account * @param {HashLockRoutesApiSearchAccountHashLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountHashLocks(requestParameters: HashLockRoutesApiSearchAccountHashLocksRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of hash lock entries, optionally filtered by owner address. * @summary Search hash lock entries * @param {HashLockRoutesApiSearchHashLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchHashLock(requestParameters?: HashLockRoutesApiSearchHashLockRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getHashLock operation in HashLockRoutesApi. * @export * @interface HashLockRoutesApiGetHashLockRequest */ export interface HashLockRoutesApiGetHashLockRequest { /** * Filter by hash (include). * @type {string} * @memberof HashLockRoutesApiGetHashLock */ readonly hash: string; } /** * Request parameters for getHashLockMerkle operation in HashLockRoutesApi. * @export * @interface HashLockRoutesApiGetHashLockMerkleRequest */ export interface HashLockRoutesApiGetHashLockMerkleRequest { /** * Filter by hash (include). * @type {string} * @memberof HashLockRoutesApiGetHashLockMerkle */ readonly hash: string; } /** * Request parameters for getHashLocks operation in HashLockRoutesApi. * @export * @interface HashLockRoutesApiGetHashLocksRequest */ export interface HashLockRoutesApiGetHashLocksRequest { /** * Request body containing an array of transaction hashes to look up. * @type {TransactionHashes} * @memberof HashLockRoutesApiGetHashLocks */ readonly transactionHashes: TransactionHashes; } /** * Request parameters for searchAccountHashLocks operation in HashLockRoutesApi. * @export * @interface HashLockRoutesApiSearchAccountHashLocksRequest */ export interface HashLockRoutesApiSearchAccountHashLocksRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof HashLockRoutesApiSearchAccountHashLocks */ readonly address: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof HashLockRoutesApiSearchAccountHashLocks */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof HashLockRoutesApiSearchAccountHashLocks */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof HashLockRoutesApiSearchAccountHashLocks */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof HashLockRoutesApiSearchAccountHashLocks */ readonly order?: Order; } /** * Request parameters for searchHashLock operation in HashLockRoutesApi. * @export * @interface HashLockRoutesApiSearchHashLockRequest */ export interface HashLockRoutesApiSearchHashLockRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof HashLockRoutesApiSearchHashLock */ readonly address?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof HashLockRoutesApiSearchHashLock */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof HashLockRoutesApiSearchHashLock */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof HashLockRoutesApiSearchHashLock */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof HashLockRoutesApiSearchHashLock */ readonly order?: Order; } /** * HashLockRoutesApi - object-oriented interface * @export * @class HashLockRoutesApi * @extends {BaseAPI} */ export declare class HashLockRoutesApi extends BaseAPI { /** * Returns the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock information * @param {HashLockRoutesApiGetHashLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HashLockRoutesApi */ getHashLock(requestParameters: HashLockRoutesApiGetHashLockRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the state Merkle proof for the hash lock entry associated with the given aggregate bonded transaction hash. * @summary Get hash lock Merkle information * @param {HashLockRoutesApiGetHashLockMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HashLockRoutesApi */ getHashLockMerkle(requestParameters: HashLockRoutesApiGetHashLockMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns hash lock entries for the given array of aggregate bonded transaction hashes. * @summary Get hash lock information for an array of hashes * @param {HashLockRoutesApiGetHashLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HashLockRoutesApi */ getHashLocks(requestParameters: HashLockRoutesApiGetHashLocksRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of hash lock entries created by the given account address. * @summary Search hash lock entries by account * @param {HashLockRoutesApiSearchAccountHashLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HashLockRoutesApi */ searchAccountHashLocks(requestParameters: HashLockRoutesApiSearchAccountHashLocksRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of hash lock entries, optionally filtered by owner address. * @summary Search hash lock entries * @param {HashLockRoutesApiSearchHashLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof HashLockRoutesApi */ searchHashLock(requestParameters?: HashLockRoutesApiSearchHashLockRequest, options?: RawAxiosRequestConfig): Promise>; } /** * MetadataRoutesApi - axios parameter creator * @export */ export declare const MetadataRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the metadata entry associated with the given composite hash. * @summary Get metadata information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadata: (compositeHash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the metadata entries associated with the given composite hashes. * @summary Get metadata information for an array of composite hashes * @param {CompositeHashes} compositeHashes * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataEntries: (compositeHashes: CompositeHashes, options?: RawAxiosRequestConfig) => Promise; /** * Returns the Merkle proof for the metadata state entry associated with the given composite hash. * @summary Get metadata Merkle information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataMerkle: (compositeHash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the decoded binary payload stored in Metal metadata entries identified by the given metal id. Metal is a convention for storing chunked binary payloads in metadata entries. See the [metal-on-symbol repository](https://github.com/OPENSPHERE-Inc/metal-on-symbol). The response content type is derived from the stored Metal seal when available, or defaults to `application/octet-stream`. Optional query parameters can override the response headers for content type and filename. * @summary Get Metal metadata binary data * @param {string} metalId Metal identifier: Base58-encoded composite hash of the first metadata chunk. * @param {string} [mimeType] Override the MIME type of the response. * @param {string} [fileName] Override the filename in the Content-Disposition header. * @param {boolean} [download] When true, sets Content-Disposition to attachment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataMetal: (metalId: string, mimeType?: string, fileName?: string, download?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of metadata entries. Results can be filtered by source address, target address, scoped metadata key, target ID, and metadata type. * @summary Search metadata entries * @param {string} [sourceAddress] Filter by address sending the metadata entry (include). * @param {string} [targetAddress] Filter by target address in Base32 (include). * @param {string} [scopedMetadataKey] Filter by metadata key (include). * @param {string} [targetId] Filter by namespace or mosaic ID (include). * @param {MetadataTypeEnum} [metadataType] Filter by metadata type (include): - `0`: Account metadata - `1`: Mosaic metadata - `2`: Namespace metadata * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMetadataEntries: (sourceAddress?: string, targetAddress?: string, scopedMetadataKey?: string, targetId?: string, metadataType?: MetadataTypeEnum, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * MetadataRoutesApi - functional programming interface * @export */ export declare const MetadataRoutesApiFp: (configuration?: Configuration) => { /** * Returns the metadata entry associated with the given composite hash. * @summary Get metadata information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadata(compositeHash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the metadata entries associated with the given composite hashes. * @summary Get metadata information for an array of composite hashes * @param {CompositeHashes} compositeHashes * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataEntries(compositeHashes: CompositeHashes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the Merkle proof for the metadata state entry associated with the given composite hash. * @summary Get metadata Merkle information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataMerkle(compositeHash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the decoded binary payload stored in Metal metadata entries identified by the given metal id. Metal is a convention for storing chunked binary payloads in metadata entries. See the [metal-on-symbol repository](https://github.com/OPENSPHERE-Inc/metal-on-symbol). The response content type is derived from the stored Metal seal when available, or defaults to `application/octet-stream`. Optional query parameters can override the response headers for content type and filename. * @summary Get Metal metadata binary data * @param {string} metalId Metal identifier: Base58-encoded composite hash of the first metadata chunk. * @param {string} [mimeType] Override the MIME type of the response. * @param {string} [fileName] Override the filename in the Content-Disposition header. * @param {boolean} [download] When true, sets Content-Disposition to attachment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataMetal(metalId: string, mimeType?: string, fileName?: string, download?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of metadata entries. Results can be filtered by source address, target address, scoped metadata key, target ID, and metadata type. * @summary Search metadata entries * @param {string} [sourceAddress] Filter by address sending the metadata entry (include). * @param {string} [targetAddress] Filter by target address in Base32 (include). * @param {string} [scopedMetadataKey] Filter by metadata key (include). * @param {string} [targetId] Filter by namespace or mosaic ID (include). * @param {MetadataTypeEnum} [metadataType] Filter by metadata type (include): - `0`: Account metadata - `1`: Mosaic metadata - `2`: Namespace metadata * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMetadataEntries(sourceAddress?: string, targetAddress?: string, scopedMetadataKey?: string, targetId?: string, metadataType?: MetadataTypeEnum, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MetadataRoutesApi - factory interface * @export */ export declare const MetadataRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the metadata entry associated with the given composite hash. * @summary Get metadata information * @param {MetadataRoutesApiGetMetadataRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadata(requestParameters: MetadataRoutesApiGetMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the metadata entries associated with the given composite hashes. * @summary Get metadata information for an array of composite hashes * @param {MetadataRoutesApiGetMetadataEntriesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataEntries(requestParameters: MetadataRoutesApiGetMetadataEntriesRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the Merkle proof for the metadata state entry associated with the given composite hash. * @summary Get metadata Merkle information * @param {MetadataRoutesApiGetMetadataMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataMerkle(requestParameters: MetadataRoutesApiGetMetadataMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the decoded binary payload stored in Metal metadata entries identified by the given metal id. Metal is a convention for storing chunked binary payloads in metadata entries. See the [metal-on-symbol repository](https://github.com/OPENSPHERE-Inc/metal-on-symbol). The response content type is derived from the stored Metal seal when available, or defaults to `application/octet-stream`. Optional query parameters can override the response headers for content type and filename. * @summary Get Metal metadata binary data * @param {MetadataRoutesApiGetMetadataMetalRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMetadataMetal(requestParameters: MetadataRoutesApiGetMetadataMetalRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of metadata entries. Results can be filtered by source address, target address, scoped metadata key, target ID, and metadata type. * @summary Search metadata entries * @param {MetadataRoutesApiSearchMetadataEntriesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMetadataEntries(requestParameters?: MetadataRoutesApiSearchMetadataEntriesRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getMetadata operation in MetadataRoutesApi. * @export * @interface MetadataRoutesApiGetMetadataRequest */ export interface MetadataRoutesApiGetMetadataRequest { /** * Composite hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MetadataRoutesApiGetMetadata */ readonly compositeHash: string; } /** * Request parameters for getMetadataEntries operation in MetadataRoutesApi. * @export * @interface MetadataRoutesApiGetMetadataEntriesRequest */ export interface MetadataRoutesApiGetMetadataEntriesRequest { /** * * @type {CompositeHashes} * @memberof MetadataRoutesApiGetMetadataEntries */ readonly compositeHashes: CompositeHashes; } /** * Request parameters for getMetadataMerkle operation in MetadataRoutesApi. * @export * @interface MetadataRoutesApiGetMetadataMerkleRequest */ export interface MetadataRoutesApiGetMetadataMerkleRequest { /** * Composite hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof MetadataRoutesApiGetMetadataMerkle */ readonly compositeHash: string; } /** * Request parameters for getMetadataMetal operation in MetadataRoutesApi. * @export * @interface MetadataRoutesApiGetMetadataMetalRequest */ export interface MetadataRoutesApiGetMetadataMetalRequest { /** * Metal identifier: Base58-encoded composite hash of the first metadata chunk. * @type {string} * @memberof MetadataRoutesApiGetMetadataMetal */ readonly metalId: string; /** * Override the MIME type of the response. * @type {string} * @memberof MetadataRoutesApiGetMetadataMetal */ readonly mimeType?: string; /** * Override the filename in the Content-Disposition header. * @type {string} * @memberof MetadataRoutesApiGetMetadataMetal */ readonly fileName?: string; /** * When true, sets Content-Disposition to attachment. * @type {boolean} * @memberof MetadataRoutesApiGetMetadataMetal */ readonly download?: boolean; } /** * Request parameters for searchMetadataEntries operation in MetadataRoutesApi. * @export * @interface MetadataRoutesApiSearchMetadataEntriesRequest */ export interface MetadataRoutesApiSearchMetadataEntriesRequest { /** * Filter by address sending the metadata entry (include). * @type {string} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly sourceAddress?: string; /** * Filter by target address in Base32 (include). * @type {string} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly targetAddress?: string; /** * Filter by metadata key (include). * @type {string} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly scopedMetadataKey?: string; /** * Filter by namespace or mosaic ID (include). * @type {string} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly targetId?: string; /** * Filter by metadata type (include): - `0`: Account metadata - `1`: Mosaic metadata - `2`: Namespace metadata * @type {MetadataTypeEnum} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly metadataType?: MetadataTypeEnum; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof MetadataRoutesApiSearchMetadataEntries */ readonly order?: Order; } /** * MetadataRoutesApi - object-oriented interface * @export * @class MetadataRoutesApi * @extends {BaseAPI} */ export declare class MetadataRoutesApi extends BaseAPI { /** * Returns the metadata entry associated with the given composite hash. * @summary Get metadata information * @param {MetadataRoutesApiGetMetadataRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataRoutesApi */ getMetadata(requestParameters: MetadataRoutesApiGetMetadataRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the metadata entries associated with the given composite hashes. * @summary Get metadata information for an array of composite hashes * @param {MetadataRoutesApiGetMetadataEntriesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataRoutesApi */ getMetadataEntries(requestParameters: MetadataRoutesApiGetMetadataEntriesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the Merkle proof for the metadata state entry associated with the given composite hash. * @summary Get metadata Merkle information * @param {MetadataRoutesApiGetMetadataMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataRoutesApi */ getMetadataMerkle(requestParameters: MetadataRoutesApiGetMetadataMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the decoded binary payload stored in Metal metadata entries identified by the given metal id. Metal is a convention for storing chunked binary payloads in metadata entries. See the [metal-on-symbol repository](https://github.com/OPENSPHERE-Inc/metal-on-symbol). The response content type is derived from the stored Metal seal when available, or defaults to `application/octet-stream`. Optional query parameters can override the response headers for content type and filename. * @summary Get Metal metadata binary data * @param {MetadataRoutesApiGetMetadataMetalRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataRoutesApi */ getMetadataMetal(requestParameters: MetadataRoutesApiGetMetadataMetalRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of metadata entries. Results can be filtered by source address, target address, scoped metadata key, target ID, and metadata type. * @summary Search metadata entries * @param {MetadataRoutesApiSearchMetadataEntriesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MetadataRoutesApi */ searchMetadataEntries(requestParameters?: MetadataRoutesApiSearchMetadataEntriesRequest, options?: RawAxiosRequestConfig): Promise>; } /** * MosaicRoutesApi - axios parameter creator * @export */ export declare const MosaicRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves the current on-chain state for a mosaic. The response includes the mosaic definition, such as supply, divisibility, owner address, duration, and behavior flags. * @summary Get mosaic information * @param {string} mosaicId Mosaic identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaic: (mosaicId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a mosaic. Clients can use this information to verify that the mosaic state is included in the node\'s state Merkle tree. If the supplied mosaic ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic state entry exists for the requested mosaic ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get mosaic Merkle information * @param {string} mosaicId Mosaic identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicMerkle: (mosaicId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the current on-chain state for multiple mosaics. The response includes only mosaics that were found, so its length can be smaller than the number of requested identifiers. Response entries are not guaranteed to preserve the order of the requested identifiers. * @summary Get mosaics information for an array of mosaics * @param {MosaicIds} mosaicIds Request body containing mosaic identifiers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaics: (mosaicIds: MosaicIds, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of mosaics matching the given criteria. Results can be filtered by mosaic owner address. Standard pagination parameters apply. * @summary Search mosaics * @param {string} [ownerAddress] Filter by owner address in Base32 format (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaics: (ownerAddress?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * MosaicRoutesApi - functional programming interface * @export */ export declare const MosaicRoutesApiFp: (configuration?: Configuration) => { /** * Retrieves the current on-chain state for a mosaic. The response includes the mosaic definition, such as supply, divisibility, owner address, duration, and behavior flags. * @summary Get mosaic information * @param {string} mosaicId Mosaic identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaic(mosaicId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a mosaic. Clients can use this information to verify that the mosaic state is included in the node\'s state Merkle tree. If the supplied mosaic ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic state entry exists for the requested mosaic ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get mosaic Merkle information * @param {string} mosaicId Mosaic identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicMerkle(mosaicId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the current on-chain state for multiple mosaics. The response includes only mosaics that were found, so its length can be smaller than the number of requested identifiers. Response entries are not guaranteed to preserve the order of the requested identifiers. * @summary Get mosaics information for an array of mosaics * @param {MosaicIds} mosaicIds Request body containing mosaic identifiers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaics(mosaicIds: MosaicIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a paginated list of mosaics matching the given criteria. Results can be filtered by mosaic owner address. Standard pagination parameters apply. * @summary Search mosaics * @param {string} [ownerAddress] Filter by owner address in Base32 format (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaics(ownerAddress?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MosaicRoutesApi - factory interface * @export */ export declare const MosaicRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves the current on-chain state for a mosaic. The response includes the mosaic definition, such as supply, divisibility, owner address, duration, and behavior flags. * @summary Get mosaic information * @param {MosaicRoutesApiGetMosaicRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaic(requestParameters: MosaicRoutesApiGetMosaicRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a mosaic. Clients can use this information to verify that the mosaic state is included in the node\'s state Merkle tree. If the supplied mosaic ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic state entry exists for the requested mosaic ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get mosaic Merkle information * @param {MosaicRoutesApiGetMosaicMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicMerkle(requestParameters: MosaicRoutesApiGetMosaicMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the current on-chain state for multiple mosaics. The response includes only mosaics that were found, so its length can be smaller than the number of requested identifiers. Response entries are not guaranteed to preserve the order of the requested identifiers. * @summary Get mosaics information for an array of mosaics * @param {MosaicRoutesApiGetMosaicsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaics(requestParameters: MosaicRoutesApiGetMosaicsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a paginated list of mosaics matching the given criteria. Results can be filtered by mosaic owner address. Standard pagination parameters apply. * @summary Search mosaics * @param {MosaicRoutesApiSearchMosaicsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaics(requestParameters?: MosaicRoutesApiSearchMosaicsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getMosaic operation in MosaicRoutesApi. * @export * @interface MosaicRoutesApiGetMosaicRequest */ export interface MosaicRoutesApiGetMosaicRequest { /** * Mosaic identifier encoded as a 16-character hexadecimal string. * @type {string} * @memberof MosaicRoutesApiGetMosaic */ readonly mosaicId: string; } /** * Request parameters for getMosaicMerkle operation in MosaicRoutesApi. * @export * @interface MosaicRoutesApiGetMosaicMerkleRequest */ export interface MosaicRoutesApiGetMosaicMerkleRequest { /** * Mosaic identifier encoded as a 16-character hexadecimal string. * @type {string} * @memberof MosaicRoutesApiGetMosaicMerkle */ readonly mosaicId: string; } /** * Request parameters for getMosaics operation in MosaicRoutesApi. * @export * @interface MosaicRoutesApiGetMosaicsRequest */ export interface MosaicRoutesApiGetMosaicsRequest { /** * Request body containing mosaic identifiers. * @type {MosaicIds} * @memberof MosaicRoutesApiGetMosaics */ readonly mosaicIds: MosaicIds; } /** * Request parameters for searchMosaics operation in MosaicRoutesApi. * @export * @interface MosaicRoutesApiSearchMosaicsRequest */ export interface MosaicRoutesApiSearchMosaicsRequest { /** * Filter by owner address in Base32 format (include). * @type {string} * @memberof MosaicRoutesApiSearchMosaics */ readonly ownerAddress?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof MosaicRoutesApiSearchMosaics */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof MosaicRoutesApiSearchMosaics */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof MosaicRoutesApiSearchMosaics */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof MosaicRoutesApiSearchMosaics */ readonly order?: Order; } /** * MosaicRoutesApi - object-oriented interface * @export * @class MosaicRoutesApi * @extends {BaseAPI} */ export declare class MosaicRoutesApi extends BaseAPI { /** * Retrieves the current on-chain state for a mosaic. The response includes the mosaic definition, such as supply, divisibility, owner address, duration, and behavior flags. * @summary Get mosaic information * @param {MosaicRoutesApiGetMosaicRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MosaicRoutesApi */ getMosaic(requestParameters: MosaicRoutesApiGetMosaicRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a mosaic. Clients can use this information to verify that the mosaic state is included in the node\'s state Merkle tree. If the supplied mosaic ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic state entry exists for the requested mosaic ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get mosaic Merkle information * @param {MosaicRoutesApiGetMosaicMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MosaicRoutesApi */ getMosaicMerkle(requestParameters: MosaicRoutesApiGetMosaicMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the current on-chain state for multiple mosaics. The response includes only mosaics that were found, so its length can be smaller than the number of requested identifiers. Response entries are not guaranteed to preserve the order of the requested identifiers. * @summary Get mosaics information for an array of mosaics * @param {MosaicRoutesApiGetMosaicsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MosaicRoutesApi */ getMosaics(requestParameters: MosaicRoutesApiGetMosaicsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of mosaics matching the given criteria. Results can be filtered by mosaic owner address. Standard pagination parameters apply. * @summary Search mosaics * @param {MosaicRoutesApiSearchMosaicsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MosaicRoutesApi */ searchMosaics(requestParameters?: MosaicRoutesApiSearchMosaicsRequest, options?: RawAxiosRequestConfig): Promise>; } /** * MultisigRoutesApi - axios parameter creator * @export */ export declare const MultisigRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the current multisig state for an account. The response includes the approval thresholds for the multisig account, its direct cosignatories, and the multisig accounts where the queried account is itself acting as a cosignatory. If the queried account is only a cosignatory, the endpoint still returns `200`, with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and the related multisig accounts listed in `multisigAddresses`. If the account is neither a multisig account nor a cosignatory of any multisig account, the endpoint returns `404`. * @summary Get multisig account information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisig: (address: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the multisig graph centered on the requested account. Level `0` contains the requested account. Negative levels contain multisig accounts for which the queried account acts as a cosignatory. Positive levels contain multisig relationships discovered through the queried account\'s cosignatories. If the requested account is a cosignatory but is not itself managed as a multisig account, the response still includes level `0` for that account. In this case, the level `0` entry has `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts it can cosign. If the requested account is neither a multisig account nor a cosignatory of any multisig account, no multisig state entry exists for it and the endpoint returns `404`. If the requested account is itself a multisig account, the response includes its multisig state at level `0` together with any reachable negative and positive graph levels. * @summary Get multisig account graph information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisigGraph: (address: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for the multisig state entry associated with the requested account. If the requested account is a cosignatory, the endpoint returns the Merkle proof for that account\'s multisig state entry. Cosignatory-only accounts still have a multisig state entry with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts they can cosign. If the requested account is itself a multisig account, the endpoint returns the Merkle proof for that multisig account state entry. If the requested account is neither a multisig account nor a cosignatory, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no multisig state entry exists for the supplied address. * @summary Get multisig account Merkle information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisigMerkle: (address: string, options?: RawAxiosRequestConfig) => Promise; }; /** * MultisigRoutesApi - functional programming interface * @export */ export declare const MultisigRoutesApiFp: (configuration?: Configuration) => { /** * Returns the current multisig state for an account. The response includes the approval thresholds for the multisig account, its direct cosignatories, and the multisig accounts where the queried account is itself acting as a cosignatory. If the queried account is only a cosignatory, the endpoint still returns `200`, with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and the related multisig accounts listed in `multisigAddresses`. If the account is neither a multisig account nor a cosignatory of any multisig account, the endpoint returns `404`. * @summary Get multisig account information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisig(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the multisig graph centered on the requested account. Level `0` contains the requested account. Negative levels contain multisig accounts for which the queried account acts as a cosignatory. Positive levels contain multisig relationships discovered through the queried account\'s cosignatories. If the requested account is a cosignatory but is not itself managed as a multisig account, the response still includes level `0` for that account. In this case, the level `0` entry has `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts it can cosign. If the requested account is neither a multisig account nor a cosignatory of any multisig account, no multisig state entry exists for it and the endpoint returns `404`. If the requested account is itself a multisig account, the response includes its multisig state at level `0` together with any reachable negative and positive graph levels. * @summary Get multisig account graph information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisigGraph(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for the multisig state entry associated with the requested account. If the requested account is a cosignatory, the endpoint returns the Merkle proof for that account\'s multisig state entry. Cosignatory-only accounts still have a multisig state entry with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts they can cosign. If the requested account is itself a multisig account, the endpoint returns the Merkle proof for that multisig account state entry. If the requested account is neither a multisig account nor a cosignatory, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no multisig state entry exists for the supplied address. * @summary Get multisig account Merkle information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisigMerkle(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MultisigRoutesApi - factory interface * @export */ export declare const MultisigRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the current multisig state for an account. The response includes the approval thresholds for the multisig account, its direct cosignatories, and the multisig accounts where the queried account is itself acting as a cosignatory. If the queried account is only a cosignatory, the endpoint still returns `200`, with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and the related multisig accounts listed in `multisigAddresses`. If the account is neither a multisig account nor a cosignatory of any multisig account, the endpoint returns `404`. * @summary Get multisig account information * @param {MultisigRoutesApiGetAccountMultisigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisig(requestParameters: MultisigRoutesApiGetAccountMultisigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the multisig graph centered on the requested account. Level `0` contains the requested account. Negative levels contain multisig accounts for which the queried account acts as a cosignatory. Positive levels contain multisig relationships discovered through the queried account\'s cosignatories. If the requested account is a cosignatory but is not itself managed as a multisig account, the response still includes level `0` for that account. In this case, the level `0` entry has `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts it can cosign. If the requested account is neither a multisig account nor a cosignatory of any multisig account, no multisig state entry exists for it and the endpoint returns `404`. If the requested account is itself a multisig account, the response includes its multisig state at level `0` together with any reachable negative and positive graph levels. * @summary Get multisig account graph information * @param {MultisigRoutesApiGetAccountMultisigGraphRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisigGraph(requestParameters: MultisigRoutesApiGetAccountMultisigGraphRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for the multisig state entry associated with the requested account. If the requested account is a cosignatory, the endpoint returns the Merkle proof for that account\'s multisig state entry. Cosignatory-only accounts still have a multisig state entry with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts they can cosign. If the requested account is itself a multisig account, the endpoint returns the Merkle proof for that multisig account state entry. If the requested account is neither a multisig account nor a cosignatory, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no multisig state entry exists for the supplied address. * @summary Get multisig account Merkle information * @param {MultisigRoutesApiGetAccountMultisigMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountMultisigMerkle(requestParameters: MultisigRoutesApiGetAccountMultisigMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getAccountMultisig operation in MultisigRoutesApi. * @export * @interface MultisigRoutesApiGetAccountMultisigRequest */ export interface MultisigRoutesApiGetAccountMultisigRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof MultisigRoutesApiGetAccountMultisig */ readonly address: string; } /** * Request parameters for getAccountMultisigGraph operation in MultisigRoutesApi. * @export * @interface MultisigRoutesApiGetAccountMultisigGraphRequest */ export interface MultisigRoutesApiGetAccountMultisigGraphRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof MultisigRoutesApiGetAccountMultisigGraph */ readonly address: string; } /** * Request parameters for getAccountMultisigMerkle operation in MultisigRoutesApi. * @export * @interface MultisigRoutesApiGetAccountMultisigMerkleRequest */ export interface MultisigRoutesApiGetAccountMultisigMerkleRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof MultisigRoutesApiGetAccountMultisigMerkle */ readonly address: string; } /** * MultisigRoutesApi - object-oriented interface * @export * @class MultisigRoutesApi * @extends {BaseAPI} */ export declare class MultisigRoutesApi extends BaseAPI { /** * Returns the current multisig state for an account. The response includes the approval thresholds for the multisig account, its direct cosignatories, and the multisig accounts where the queried account is itself acting as a cosignatory. If the queried account is only a cosignatory, the endpoint still returns `200`, with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and the related multisig accounts listed in `multisigAddresses`. If the account is neither a multisig account nor a cosignatory of any multisig account, the endpoint returns `404`. * @summary Get multisig account information * @param {MultisigRoutesApiGetAccountMultisigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MultisigRoutesApi */ getAccountMultisig(requestParameters: MultisigRoutesApiGetAccountMultisigRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the multisig graph centered on the requested account. Level `0` contains the requested account. Negative levels contain multisig accounts for which the queried account acts as a cosignatory. Positive levels contain multisig relationships discovered through the queried account\'s cosignatories. If the requested account is a cosignatory but is not itself managed as a multisig account, the response still includes level `0` for that account. In this case, the level `0` entry has `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts it can cosign. If the requested account is neither a multisig account nor a cosignatory of any multisig account, no multisig state entry exists for it and the endpoint returns `404`. If the requested account is itself a multisig account, the response includes its multisig state at level `0` together with any reachable negative and positive graph levels. * @summary Get multisig account graph information * @param {MultisigRoutesApiGetAccountMultisigGraphRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MultisigRoutesApi */ getAccountMultisigGraph(requestParameters: MultisigRoutesApiGetAccountMultisigGraphRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for the multisig state entry associated with the requested account. If the requested account is a cosignatory, the endpoint returns the Merkle proof for that account\'s multisig state entry. Cosignatory-only accounts still have a multisig state entry with `minApproval = 0`, `minRemoval = 0`, an empty `cosignatoryAddresses` array, and `multisigAddresses` listing the multisig accounts they can cosign. If the requested account is itself a multisig account, the endpoint returns the Merkle proof for that multisig account state entry. If the requested account is neither a multisig account nor a cosignatory, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no multisig state entry exists for the supplied address. * @summary Get multisig account Merkle information * @param {MultisigRoutesApiGetAccountMultisigMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MultisigRoutesApi */ getAccountMultisigMerkle(requestParameters: MultisigRoutesApiGetAccountMultisigMerkleRequest, options?: RawAxiosRequestConfig): Promise>; } /** * NamespaceRoutesApi - axios parameter creator * @export */ export declare const NamespaceRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Resolves namespace names linked to account addresses. Submit an array of addresses in the request body. For each address, the response returns the namespace names currently linked to that account. * @summary Get readable names for a set of accounts * @param {Addresses} addresses Request body containing account addresses in Base32 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountsNames: (addresses: Addresses, options?: RawAxiosRequestConfig) => Promise; /** * Resolves namespace names linked to mosaic identifiers. Submit an array of mosaic identifiers in the request body. For each requested mosaic identifier, the response returns one entry in the same order as the request. Each entry contains the namespace names currently linked to that identifier. An empty `names` array means no namespace aliases were resolved for that identifier. * @summary Get readable names for a set of mosaics * @param {MosaicIds} mosaicIds Request body containing mosaic identifiers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicsNames: (mosaicIds: MosaicIds, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the current on-chain state for a namespace. * @summary Get namespace information * @param {string} namespaceId Namespace identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespace: (namespaceId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a namespace. Clients can use this information to verify that the namespace state is included in the node\'s state Merkle tree. If the supplied namespace ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no namespace state entry exists for the requested namespace ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get namespace Merkle information * @param {string} namespaceId Namespace identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespaceMerkle: (namespaceId: string, options?: RawAxiosRequestConfig) => Promise; /** * Resolves human-readable namespace names for namespace identifiers. Submit an array of namespace identifiers in the request body. For each matching identifier, the response returns the namespace name. When a matching identifier is a subnamespace, the response will also include its parent namespace entry and parent namespace identifier. Identifiers that cannot be resolved are omitted from the response. * @summary Get readable names for a set of namespaces * @param {NamespaceIds} namespaceIds Request body containing namespace identifiers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespacesNames: (namespaceIds: NamespaceIds, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of namespaces matching the given criteria. * @summary Search namespaces * @param {string} [ownerAddress] Filter by owner address in Base32 format (include). * @param {NamespaceRegistrationTypeEnum} [registrationType] Filter by namespace registration type (include). - 0: Root namespace. - 1: Subnamespace. * @param {string} [level0] Filter by the root namespace identifier (include). * @param {AliasTypeEnum} [aliasType] Filter by alias type (include). - 0: Namespace has no alias. - 1: Namespace is linked to a mosaic ID. - 2: Namespace is linked to an address. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchNamespaces: (ownerAddress?: string, registrationType?: NamespaceRegistrationTypeEnum, level0?: string, aliasType?: AliasTypeEnum, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * NamespaceRoutesApi - functional programming interface * @export */ export declare const NamespaceRoutesApiFp: (configuration?: Configuration) => { /** * Resolves namespace names linked to account addresses. Submit an array of addresses in the request body. For each address, the response returns the namespace names currently linked to that account. * @summary Get readable names for a set of accounts * @param {Addresses} addresses Request body containing account addresses in Base32 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountsNames(addresses: Addresses, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resolves namespace names linked to mosaic identifiers. Submit an array of mosaic identifiers in the request body. For each requested mosaic identifier, the response returns one entry in the same order as the request. Each entry contains the namespace names currently linked to that identifier. An empty `names` array means no namespace aliases were resolved for that identifier. * @summary Get readable names for a set of mosaics * @param {MosaicIds} mosaicIds Request body containing mosaic identifiers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicsNames(mosaicIds: MosaicIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the current on-chain state for a namespace. * @summary Get namespace information * @param {string} namespaceId Namespace identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespace(namespaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a namespace. Clients can use this information to verify that the namespace state is included in the node\'s state Merkle tree. If the supplied namespace ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no namespace state entry exists for the requested namespace ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get namespace Merkle information * @param {string} namespaceId Namespace identifier encoded as a 16-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespaceMerkle(namespaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resolves human-readable namespace names for namespace identifiers. Submit an array of namespace identifiers in the request body. For each matching identifier, the response returns the namespace name. When a matching identifier is a subnamespace, the response will also include its parent namespace entry and parent namespace identifier. Identifiers that cannot be resolved are omitted from the response. * @summary Get readable names for a set of namespaces * @param {NamespaceIds} namespaceIds Request body containing namespace identifiers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespacesNames(namespaceIds: NamespaceIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a paginated list of namespaces matching the given criteria. * @summary Search namespaces * @param {string} [ownerAddress] Filter by owner address in Base32 format (include). * @param {NamespaceRegistrationTypeEnum} [registrationType] Filter by namespace registration type (include). - 0: Root namespace. - 1: Subnamespace. * @param {string} [level0] Filter by the root namespace identifier (include). * @param {AliasTypeEnum} [aliasType] Filter by alias type (include). - 0: Namespace has no alias. - 1: Namespace is linked to a mosaic ID. - 2: Namespace is linked to an address. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchNamespaces(ownerAddress?: string, registrationType?: NamespaceRegistrationTypeEnum, level0?: string, aliasType?: AliasTypeEnum, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NamespaceRoutesApi - factory interface * @export */ export declare const NamespaceRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Resolves namespace names linked to account addresses. Submit an array of addresses in the request body. For each address, the response returns the namespace names currently linked to that account. * @summary Get readable names for a set of accounts * @param {NamespaceRoutesApiGetAccountsNamesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountsNames(requestParameters: NamespaceRoutesApiGetAccountsNamesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resolves namespace names linked to mosaic identifiers. Submit an array of mosaic identifiers in the request body. For each requested mosaic identifier, the response returns one entry in the same order as the request. Each entry contains the namespace names currently linked to that identifier. An empty `names` array means no namespace aliases were resolved for that identifier. * @summary Get readable names for a set of mosaics * @param {NamespaceRoutesApiGetMosaicsNamesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicsNames(requestParameters: NamespaceRoutesApiGetMosaicsNamesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the current on-chain state for a namespace. * @summary Get namespace information * @param {NamespaceRoutesApiGetNamespaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespace(requestParameters: NamespaceRoutesApiGetNamespaceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a namespace. Clients can use this information to verify that the namespace state is included in the node\'s state Merkle tree. If the supplied namespace ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no namespace state entry exists for the requested namespace ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get namespace Merkle information * @param {NamespaceRoutesApiGetNamespaceMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespaceMerkle(requestParameters: NamespaceRoutesApiGetNamespaceMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resolves human-readable namespace names for namespace identifiers. Submit an array of namespace identifiers in the request body. For each matching identifier, the response returns the namespace name. When a matching identifier is a subnamespace, the response will also include its parent namespace entry and parent namespace identifier. Identifiers that cannot be resolved are omitted from the response. * @summary Get readable names for a set of namespaces * @param {NamespaceRoutesApiGetNamespacesNamesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNamespacesNames(requestParameters: NamespaceRoutesApiGetNamespacesNamesRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a paginated list of namespaces matching the given criteria. * @summary Search namespaces * @param {NamespaceRoutesApiSearchNamespacesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchNamespaces(requestParameters?: NamespaceRoutesApiSearchNamespacesRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getAccountsNames operation in NamespaceRoutesApi. * @export * @interface NamespaceRoutesApiGetAccountsNamesRequest */ export interface NamespaceRoutesApiGetAccountsNamesRequest { /** * Request body containing account addresses in Base32 format. * @type {Addresses} * @memberof NamespaceRoutesApiGetAccountsNames */ readonly addresses: Addresses; } /** * Request parameters for getMosaicsNames operation in NamespaceRoutesApi. * @export * @interface NamespaceRoutesApiGetMosaicsNamesRequest */ export interface NamespaceRoutesApiGetMosaicsNamesRequest { /** * Request body containing mosaic identifiers. * @type {MosaicIds} * @memberof NamespaceRoutesApiGetMosaicsNames */ readonly mosaicIds: MosaicIds; } /** * Request parameters for getNamespace operation in NamespaceRoutesApi. * @export * @interface NamespaceRoutesApiGetNamespaceRequest */ export interface NamespaceRoutesApiGetNamespaceRequest { /** * Namespace identifier encoded as a 16-character hexadecimal string. * @type {string} * @memberof NamespaceRoutesApiGetNamespace */ readonly namespaceId: string; } /** * Request parameters for getNamespaceMerkle operation in NamespaceRoutesApi. * @export * @interface NamespaceRoutesApiGetNamespaceMerkleRequest */ export interface NamespaceRoutesApiGetNamespaceMerkleRequest { /** * Namespace identifier encoded as a 16-character hexadecimal string. * @type {string} * @memberof NamespaceRoutesApiGetNamespaceMerkle */ readonly namespaceId: string; } /** * Request parameters for getNamespacesNames operation in NamespaceRoutesApi. * @export * @interface NamespaceRoutesApiGetNamespacesNamesRequest */ export interface NamespaceRoutesApiGetNamespacesNamesRequest { /** * Request body containing namespace identifiers. * @type {NamespaceIds} * @memberof NamespaceRoutesApiGetNamespacesNames */ readonly namespaceIds: NamespaceIds; } /** * Request parameters for searchNamespaces operation in NamespaceRoutesApi. * @export * @interface NamespaceRoutesApiSearchNamespacesRequest */ export interface NamespaceRoutesApiSearchNamespacesRequest { /** * Filter by owner address in Base32 format (include). * @type {string} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly ownerAddress?: string; /** * Filter by namespace registration type (include). - 0: Root namespace. - 1: Subnamespace. * @type {NamespaceRegistrationTypeEnum} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly registrationType?: NamespaceRegistrationTypeEnum; /** * Filter by the root namespace identifier (include). * @type {string} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly level0?: string; /** * Filter by alias type (include). - 0: Namespace has no alias. - 1: Namespace is linked to a mosaic ID. - 2: Namespace is linked to an address. * @type {AliasTypeEnum} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly aliasType?: AliasTypeEnum; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof NamespaceRoutesApiSearchNamespaces */ readonly order?: Order; } /** * NamespaceRoutesApi - object-oriented interface * @export * @class NamespaceRoutesApi * @extends {BaseAPI} */ export declare class NamespaceRoutesApi extends BaseAPI { /** * Resolves namespace names linked to account addresses. Submit an array of addresses in the request body. For each address, the response returns the namespace names currently linked to that account. * @summary Get readable names for a set of accounts * @param {NamespaceRoutesApiGetAccountsNamesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamespaceRoutesApi */ getAccountsNames(requestParameters: NamespaceRoutesApiGetAccountsNamesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Resolves namespace names linked to mosaic identifiers. Submit an array of mosaic identifiers in the request body. For each requested mosaic identifier, the response returns one entry in the same order as the request. Each entry contains the namespace names currently linked to that identifier. An empty `names` array means no namespace aliases were resolved for that identifier. * @summary Get readable names for a set of mosaics * @param {NamespaceRoutesApiGetMosaicsNamesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamespaceRoutesApi */ getMosaicsNames(requestParameters: NamespaceRoutesApiGetMosaicsNamesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the current on-chain state for a namespace. * @summary Get namespace information * @param {NamespaceRoutesApiGetNamespaceRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamespaceRoutesApi */ getNamespace(requestParameters: NamespaceRoutesApiGetNamespaceRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a namespace. Clients can use this information to verify that the namespace state is included in the node\'s state Merkle tree. If the supplied namespace ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no namespace state entry exists for the requested namespace ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol. * @summary Get namespace Merkle information * @param {NamespaceRoutesApiGetNamespaceMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamespaceRoutesApi */ getNamespaceMerkle(requestParameters: NamespaceRoutesApiGetNamespaceMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Resolves human-readable namespace names for namespace identifiers. Submit an array of namespace identifiers in the request body. For each matching identifier, the response returns the namespace name. When a matching identifier is a subnamespace, the response will also include its parent namespace entry and parent namespace identifier. Identifiers that cannot be resolved are omitted from the response. * @summary Get readable names for a set of namespaces * @param {NamespaceRoutesApiGetNamespacesNamesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamespaceRoutesApi */ getNamespacesNames(requestParameters: NamespaceRoutesApiGetNamespacesNamesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of namespaces matching the given criteria. * @summary Search namespaces * @param {NamespaceRoutesApiSearchNamespacesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamespaceRoutesApi */ searchNamespaces(requestParameters?: NamespaceRoutesApiSearchNamespacesRequest, options?: RawAxiosRequestConfig): Promise>; } /** * NetworkRoutesApi - axios parameter creator * @export */ export declare const NetworkRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the current circulating supply of the network currency mosaic. Circulating supply represents the portion of total on-chain supply that is not held in designated uncirculating or reserved accounts (e.g. nemesis or treasury accounts). Data sources: - Mosaic supply and divisibility from blockchain state - Nemesis signer public key from network properties file - Uncirculating account public keys defined in rest.json (`uncirculatingAccountPublicKeys`) * @summary Returns circulating currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCirculatingCurrencySupply: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the maximum possible supply of the network currency mosaic. Data sources: - Maximum supply (`chain.maxMosaicAtomicUnits`) defined in the network properties file - Network currency divisibility from blockchain state This represents the protocol-level supply cap configured for the network currency. * @summary Returns max currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxCurrencySupply: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the network inflation table, where each entry specifies a starting block height and the reward amount applied from that height onward. * @summary Returns the inflation distribution schedule * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkInflation: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves network inflation parameters at a given block height. * @summary Returns the inflation distribution data at a specific height * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkInflationAtHeight: (height: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the content from a catapult-server network configuration file (e.g. `config-network.properties`). To enable this feature, the REST setting `apiNode.networkPropertyFilePath` in the config file (e.g. `rest.json`) must define where the file is located. * @summary Get the network properties * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkProperties: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the current network type. * @summary Get the current network type of the chain * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkType: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server `resources/config-network.properties` file. To activate this feature, add the setting `network.propertiesFilePath` in the configuration file (`rest/resources/rest.json`). * @summary Get rental fees information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRentalFees: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the total current on-chain supply of the network currency mosaic. Data sources: - Mosaic supply and divisibility from blockchain state This value includes both circulating and uncirculating balances and represents the full issued supply currently recorded on-chain. * @summary Returns total currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTotalCurrencySupply: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the average, median, highest, and lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks. The setting `numBlocksTransactionFeeStats` is adjustable in the REST configuration file (`rest.json`) per REST instance. * @summary Get transaction fees information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionFees: (options?: RawAxiosRequestConfig) => Promise; }; /** * NetworkRoutesApi - functional programming interface * @export */ export declare const NetworkRoutesApiFp: (configuration?: Configuration) => { /** * Returns the current circulating supply of the network currency mosaic. Circulating supply represents the portion of total on-chain supply that is not held in designated uncirculating or reserved accounts (e.g. nemesis or treasury accounts). Data sources: - Mosaic supply and divisibility from blockchain state - Nemesis signer public key from network properties file - Uncirculating account public keys defined in rest.json (`uncirculatingAccountPublicKeys`) * @summary Returns circulating currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCirculatingCurrencySupply(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the maximum possible supply of the network currency mosaic. Data sources: - Maximum supply (`chain.maxMosaicAtomicUnits`) defined in the network properties file - Network currency divisibility from blockchain state This represents the protocol-level supply cap configured for the network currency. * @summary Returns max currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxCurrencySupply(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the network inflation table, where each entry specifies a starting block height and the reward amount applied from that height onward. * @summary Returns the inflation distribution schedule * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkInflation(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves network inflation parameters at a given block height. * @summary Returns the inflation distribution data at a specific height * @param {string} height Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkInflationAtHeight(height: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the content from a catapult-server network configuration file (e.g. `config-network.properties`). To enable this feature, the REST setting `apiNode.networkPropertyFilePath` in the config file (e.g. `rest.json`) must define where the file is located. * @summary Get the network properties * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkProperties(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current network type. * @summary Get the current network type of the chain * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkType(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server `resources/config-network.properties` file. To activate this feature, add the setting `network.propertiesFilePath` in the configuration file (`rest/resources/rest.json`). * @summary Get rental fees information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRentalFees(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the total current on-chain supply of the network currency mosaic. Data sources: - Mosaic supply and divisibility from blockchain state This value includes both circulating and uncirculating balances and represents the full issued supply currently recorded on-chain. * @summary Returns total currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTotalCurrencySupply(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the average, median, highest, and lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks. The setting `numBlocksTransactionFeeStats` is adjustable in the REST configuration file (`rest.json`) per REST instance. * @summary Get transaction fees information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionFees(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NetworkRoutesApi - factory interface * @export */ export declare const NetworkRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the current circulating supply of the network currency mosaic. Circulating supply represents the portion of total on-chain supply that is not held in designated uncirculating or reserved accounts (e.g. nemesis or treasury accounts). Data sources: - Mosaic supply and divisibility from blockchain state - Nemesis signer public key from network properties file - Uncirculating account public keys defined in rest.json (`uncirculatingAccountPublicKeys`) * @summary Returns circulating currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCirculatingCurrencySupply(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the maximum possible supply of the network currency mosaic. Data sources: - Maximum supply (`chain.maxMosaicAtomicUnits`) defined in the network properties file - Network currency divisibility from blockchain state This represents the protocol-level supply cap configured for the network currency. * @summary Returns max currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMaxCurrencySupply(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the network inflation table, where each entry specifies a starting block height and the reward amount applied from that height onward. * @summary Returns the inflation distribution schedule * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkInflation(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves network inflation parameters at a given block height. * @summary Returns the inflation distribution data at a specific height * @param {NetworkRoutesApiGetNetworkInflationAtHeightRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkInflationAtHeight(requestParameters: NetworkRoutesApiGetNetworkInflationAtHeightRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the content from a catapult-server network configuration file (e.g. `config-network.properties`). To enable this feature, the REST setting `apiNode.networkPropertyFilePath` in the config file (e.g. `rest.json`) must define where the file is located. * @summary Get the network properties * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkProperties(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current network type. * @summary Get the current network type of the chain * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNetworkType(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server `resources/config-network.properties` file. To activate this feature, add the setting `network.propertiesFilePath` in the configuration file (`rest/resources/rest.json`). * @summary Get rental fees information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRentalFees(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the total current on-chain supply of the network currency mosaic. Data sources: - Mosaic supply and divisibility from blockchain state This value includes both circulating and uncirculating balances and represents the full issued supply currently recorded on-chain. * @summary Returns total currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTotalCurrencySupply(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the average, median, highest, and lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks. The setting `numBlocksTransactionFeeStats` is adjustable in the REST configuration file (`rest.json`) per REST instance. * @summary Get transaction fees information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionFees(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getNetworkInflationAtHeight operation in NetworkRoutesApi. * @export * @interface NetworkRoutesApiGetNetworkInflationAtHeightRequest */ export interface NetworkRoutesApiGetNetworkInflationAtHeightRequest { /** * Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one. * @type {string} * @memberof NetworkRoutesApiGetNetworkInflationAtHeight */ readonly height: string; } /** * NetworkRoutesApi - object-oriented interface * @export * @class NetworkRoutesApi * @extends {BaseAPI} */ export declare class NetworkRoutesApi extends BaseAPI { /** * Returns the current circulating supply of the network currency mosaic. Circulating supply represents the portion of total on-chain supply that is not held in designated uncirculating or reserved accounts (e.g. nemesis or treasury accounts). Data sources: - Mosaic supply and divisibility from blockchain state - Nemesis signer public key from network properties file - Uncirculating account public keys defined in rest.json (`uncirculatingAccountPublicKeys`) * @summary Returns circulating currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getCirculatingCurrencySupply(options?: RawAxiosRequestConfig): Promise>; /** * Returns the maximum possible supply of the network currency mosaic. Data sources: - Maximum supply (`chain.maxMosaicAtomicUnits`) defined in the network properties file - Network currency divisibility from blockchain state This represents the protocol-level supply cap configured for the network currency. * @summary Returns max currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getMaxCurrencySupply(options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the network inflation table, where each entry specifies a starting block height and the reward amount applied from that height onward. * @summary Returns the inflation distribution schedule * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getNetworkInflation(options?: RawAxiosRequestConfig): Promise>; /** * Retrieves network inflation parameters at a given block height. * @summary Returns the inflation distribution data at a specific height * @param {NetworkRoutesApiGetNetworkInflationAtHeightRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getNetworkInflationAtHeight(requestParameters: NetworkRoutesApiGetNetworkInflationAtHeightRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the content from a catapult-server network configuration file (e.g. `config-network.properties`). To enable this feature, the REST setting `apiNode.networkPropertyFilePath` in the config file (e.g. `rest.json`) must define where the file is located. * @summary Get the network properties * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getNetworkProperties(options?: RawAxiosRequestConfig): Promise>; /** * Returns the current network type. * @summary Get the current network type of the chain * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getNetworkType(options?: RawAxiosRequestConfig): Promise>; /** * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server `resources/config-network.properties` file. To activate this feature, add the setting `network.propertiesFilePath` in the configuration file (`rest/resources/rest.json`). * @summary Get rental fees information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getRentalFees(options?: RawAxiosRequestConfig): Promise>; /** * Returns the total current on-chain supply of the network currency mosaic. Data sources: - Mosaic supply and divisibility from blockchain state This value includes both circulating and uncirculating balances and represents the full issued supply currently recorded on-chain. * @summary Returns total currency supply * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getTotalCurrencySupply(options?: RawAxiosRequestConfig): Promise>; /** * Returns the average, median, highest, and lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks. The setting `numBlocksTransactionFeeStats` is adjustable in the REST configuration file (`rest.json`) per REST instance. * @summary Get transaction fees information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NetworkRoutesApi */ getTransactionFees(options?: RawAxiosRequestConfig): Promise>; } /** * NodeRoutesApi - axios parameter creator * @export */ export declare const NodeRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Supplies information regarding the connection and services status. * @summary Get the node health information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeHealth: (options?: RawAxiosRequestConfig) => Promise; /** * Supplies additional information about the application running on a node. * @summary Get the node information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeInfo: (options?: RawAxiosRequestConfig) => Promise; /** * Gets the node metadata information that has been set by the node operator. **How to set:** Add a top-level `nodeMetadata` object in the REST server JSON configuration file. Example: ```json { \"nodeMetadata\": { \"deploymentTool\": \"symbol-shoestring\", \"version\": \"1.0.0\", \"customLabel\": \"my-node\" } } ``` The entire `nodeMetadata` object is served as-is; add any key-value pairs to personalize your node. * @summary Retrieve node metadata * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeMetadata: (options?: RawAxiosRequestConfig) => Promise; /** * Gets the list of peers visible by the node. * @summary Get peers information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodePeers: (options?: RawAxiosRequestConfig) => Promise; /** * Returns estimated counts of blocks, transactions, and accounts in the REST server\'s MongoDB database, along with database size statistics (`db.stats()`). * @summary Get the storage information of the node * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeStorage: (options?: RawAxiosRequestConfig) => Promise; /** * Gets the node time at the moment the reply was sent and received. * @summary Get the node time * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeTime: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the version of the running catapult-rest component. * @summary Get the version of the running REST component * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServerInfo: (options?: RawAxiosRequestConfig) => Promise; /** * Returns array of unlocked account public keys. * @summary Get the unlocked harvesting account public keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnlockedAccount: (options?: RawAxiosRequestConfig) => Promise; }; /** * NodeRoutesApi - functional programming interface * @export */ export declare const NodeRoutesApiFp: (configuration?: Configuration) => { /** * Supplies information regarding the connection and services status. * @summary Get the node health information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Supplies additional information about the application running on a node. * @summary Get the node information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the node metadata information that has been set by the node operator. **How to set:** Add a top-level `nodeMetadata` object in the REST server JSON configuration file. Example: ```json { \"nodeMetadata\": { \"deploymentTool\": \"symbol-shoestring\", \"version\": \"1.0.0\", \"customLabel\": \"my-node\" } } ``` The entire `nodeMetadata` object is served as-is; add any key-value pairs to personalize your node. * @summary Retrieve node metadata * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeMetadata(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: string; }>>; /** * Gets the list of peers visible by the node. * @summary Get peers information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodePeers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns estimated counts of blocks, transactions, and accounts in the REST server\'s MongoDB database, along with database size statistics (`db.stats()`). * @summary Get the storage information of the node * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeStorage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the node time at the moment the reply was sent and received. * @summary Get the node time * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeTime(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the version of the running catapult-rest component. * @summary Get the version of the running REST component * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServerInfo(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns array of unlocked account public keys. * @summary Get the unlocked harvesting account public keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnlockedAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NodeRoutesApi - factory interface * @export */ export declare const NodeRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Supplies information regarding the connection and services status. * @summary Get the node health information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeHealth(options?: RawAxiosRequestConfig): AxiosPromise; /** * Supplies additional information about the application running on a node. * @summary Get the node information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeInfo(options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets the node metadata information that has been set by the node operator. **How to set:** Add a top-level `nodeMetadata` object in the REST server JSON configuration file. Example: ```json { \"nodeMetadata\": { \"deploymentTool\": \"symbol-shoestring\", \"version\": \"1.0.0\", \"customLabel\": \"my-node\" } } ``` The entire `nodeMetadata` object is served as-is; add any key-value pairs to personalize your node. * @summary Retrieve node metadata * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeMetadata(options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: string; }>; /** * Gets the list of peers visible by the node. * @summary Get peers information * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodePeers(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns estimated counts of blocks, transactions, and accounts in the REST server\'s MongoDB database, along with database size statistics (`db.stats()`). * @summary Get the storage information of the node * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeStorage(options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets the node time at the moment the reply was sent and received. * @summary Get the node time * @param {*} [options] Override http request option. * @throws {RequiredError} */ getNodeTime(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the version of the running catapult-rest component. * @summary Get the version of the running REST component * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServerInfo(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns array of unlocked account public keys. * @summary Get the unlocked harvesting account public keys * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnlockedAccount(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * NodeRoutesApi - object-oriented interface * @export * @class NodeRoutesApi * @extends {BaseAPI} */ export declare class NodeRoutesApi extends BaseAPI { /** * Supplies information regarding the connection and services status. * @summary Get the node health information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getNodeHealth(options?: RawAxiosRequestConfig): Promise>; /** * Supplies additional information about the application running on a node. * @summary Get the node information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getNodeInfo(options?: RawAxiosRequestConfig): Promise>; /** * Gets the node metadata information that has been set by the node operator. **How to set:** Add a top-level `nodeMetadata` object in the REST server JSON configuration file. Example: ```json { \"nodeMetadata\": { \"deploymentTool\": \"symbol-shoestring\", \"version\": \"1.0.0\", \"customLabel\": \"my-node\" } } ``` The entire `nodeMetadata` object is served as-is; add any key-value pairs to personalize your node. * @summary Retrieve node metadata * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getNodeMetadata(options?: RawAxiosRequestConfig): Promise>; /** * Gets the list of peers visible by the node. * @summary Get peers information * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getNodePeers(options?: RawAxiosRequestConfig): Promise>; /** * Returns estimated counts of blocks, transactions, and accounts in the REST server\'s MongoDB database, along with database size statistics (`db.stats()`). * @summary Get the storage information of the node * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getNodeStorage(options?: RawAxiosRequestConfig): Promise>; /** * Gets the node time at the moment the reply was sent and received. * @summary Get the node time * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getNodeTime(options?: RawAxiosRequestConfig): Promise>; /** * Returns the version of the running catapult-rest component. * @summary Get the version of the running REST component * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getServerInfo(options?: RawAxiosRequestConfig): Promise>; /** * Returns array of unlocked account public keys. * @summary Get the unlocked harvesting account public keys * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NodeRoutesApi */ getUnlockedAccount(options?: RawAxiosRequestConfig): Promise>; } /** * ReceiptRoutesApi - axios parameter creator * @export */ export declare const ReceiptRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a paginated list of address resolution statements. These statements record how an unresolved address alias used in a transaction was resolved to a concrete address at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search address resolution statements * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAddressResolutionStatements: (height?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of mosaic resolution statements. These statements record how an unresolved mosaic alias used in a transaction was resolved to a concrete mosaic ID at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search mosaic resolution statements * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaicResolutionStatements: (height?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of transaction statements generated while confirmed transactions change on-chain state. Each statement is grouped by block height and source and contains the receipts produced by transaction execution, including balance transfers, balance changes, expirations, and inflation. Results can be filtered by block height, receipt type, related addresses, and artifact IDs. * @summary Search transaction statements * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {Array} [receiptType] Filter by receipt type code (include). To match multiple receipt types, repeat the query parameter, for example: `receiptType=8515&receiptType=20803`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [senderAddress] Filter by sender address in Base32 (include). * @param {string} [targetAddress] Filter by target address in Base32 (include). * @param {string} [artifactId] Filter by artifact (mosaic or namespace) identifier (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchTransactionStatements: (height?: string, fromHeight?: string, toHeight?: string, receiptType?: Array, recipientAddress?: string, senderAddress?: string, targetAddress?: string, artifactId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * ReceiptRoutesApi - functional programming interface * @export */ export declare const ReceiptRoutesApiFp: (configuration?: Configuration) => { /** * Returns a paginated list of address resolution statements. These statements record how an unresolved address alias used in a transaction was resolved to a concrete address at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search address resolution statements * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAddressResolutionStatements(height?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of mosaic resolution statements. These statements record how an unresolved mosaic alias used in a transaction was resolved to a concrete mosaic ID at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search mosaic resolution statements * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaicResolutionStatements(height?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of transaction statements generated while confirmed transactions change on-chain state. Each statement is grouped by block height and source and contains the receipts produced by transaction execution, including balance transfers, balance changes, expirations, and inflation. Results can be filtered by block height, receipt type, related addresses, and artifact IDs. * @summary Search transaction statements * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {Array} [receiptType] Filter by receipt type code (include). To match multiple receipt types, repeat the query parameter, for example: `receiptType=8515&receiptType=20803`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [senderAddress] Filter by sender address in Base32 (include). * @param {string} [targetAddress] Filter by target address in Base32 (include). * @param {string} [artifactId] Filter by artifact (mosaic or namespace) identifier (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchTransactionStatements(height?: string, fromHeight?: string, toHeight?: string, receiptType?: Array, recipientAddress?: string, senderAddress?: string, targetAddress?: string, artifactId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReceiptRoutesApi - factory interface * @export */ export declare const ReceiptRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a paginated list of address resolution statements. These statements record how an unresolved address alias used in a transaction was resolved to a concrete address at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search address resolution statements * @param {ReceiptRoutesApiSearchAddressResolutionStatementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAddressResolutionStatements(requestParameters?: ReceiptRoutesApiSearchAddressResolutionStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of mosaic resolution statements. These statements record how an unresolved mosaic alias used in a transaction was resolved to a concrete mosaic ID at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search mosaic resolution statements * @param {ReceiptRoutesApiSearchMosaicResolutionStatementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaicResolutionStatements(requestParameters?: ReceiptRoutesApiSearchMosaicResolutionStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of transaction statements generated while confirmed transactions change on-chain state. Each statement is grouped by block height and source and contains the receipts produced by transaction execution, including balance transfers, balance changes, expirations, and inflation. Results can be filtered by block height, receipt type, related addresses, and artifact IDs. * @summary Search transaction statements * @param {ReceiptRoutesApiSearchTransactionStatementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchTransactionStatements(requestParameters?: ReceiptRoutesApiSearchTransactionStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for searchAddressResolutionStatements operation in ReceiptRoutesApi. * @export * @interface ReceiptRoutesApiSearchAddressResolutionStatementsRequest */ export interface ReceiptRoutesApiSearchAddressResolutionStatementsRequest { /** * Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @type {string} * @memberof ReceiptRoutesApiSearchAddressResolutionStatements */ readonly height?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof ReceiptRoutesApiSearchAddressResolutionStatements */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof ReceiptRoutesApiSearchAddressResolutionStatements */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof ReceiptRoutesApiSearchAddressResolutionStatements */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof ReceiptRoutesApiSearchAddressResolutionStatements */ readonly order?: Order; } /** * Request parameters for searchMosaicResolutionStatements operation in ReceiptRoutesApi. * @export * @interface ReceiptRoutesApiSearchMosaicResolutionStatementsRequest */ export interface ReceiptRoutesApiSearchMosaicResolutionStatementsRequest { /** * Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @type {string} * @memberof ReceiptRoutesApiSearchMosaicResolutionStatements */ readonly height?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof ReceiptRoutesApiSearchMosaicResolutionStatements */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof ReceiptRoutesApiSearchMosaicResolutionStatements */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof ReceiptRoutesApiSearchMosaicResolutionStatements */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof ReceiptRoutesApiSearchMosaicResolutionStatements */ readonly order?: Order; } /** * Request parameters for searchTransactionStatements operation in ReceiptRoutesApi. * @export * @interface ReceiptRoutesApiSearchTransactionStatementsRequest */ export interface ReceiptRoutesApiSearchTransactionStatementsRequest { /** * Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly height?: string; /** * Only transactions at or above this block height are returned. * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly fromHeight?: string; /** * Only transactions at or below this block height are returned. * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly toHeight?: string; /** * Filter by receipt type code (include). To match multiple receipt types, repeat the query parameter, for example: `receiptType=8515&receiptType=20803`. * @type {Array} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly receiptType?: Array; /** * Filter transactions by recipient address in Base32 format (include). * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly recipientAddress?: string; /** * Filter by sender address in Base32 (include). * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly senderAddress?: string; /** * Filter by target address in Base32 (include). * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly targetAddress?: string; /** * Filter by artifact (mosaic or namespace) identifier (include). * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly artifactId?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof ReceiptRoutesApiSearchTransactionStatements */ readonly order?: Order; } /** * ReceiptRoutesApi - object-oriented interface * @export * @class ReceiptRoutesApi * @extends {BaseAPI} */ export declare class ReceiptRoutesApi extends BaseAPI { /** * Returns a paginated list of address resolution statements. These statements record how an unresolved address alias used in a transaction was resolved to a concrete address at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search address resolution statements * @param {ReceiptRoutesApiSearchAddressResolutionStatementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReceiptRoutesApi */ searchAddressResolutionStatements(requestParameters?: ReceiptRoutesApiSearchAddressResolutionStatementsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of mosaic resolution statements. These statements record how an unresolved mosaic alias used in a transaction was resolved to a concrete mosaic ID at a given block height. A statement can contain multiple resolution entries because alias resolution may differ by transaction source within the same block. * @summary Search mosaic resolution statements * @param {ReceiptRoutesApiSearchMosaicResolutionStatementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReceiptRoutesApi */ searchMosaicResolutionStatements(requestParameters?: ReceiptRoutesApiSearchMosaicResolutionStatementsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of transaction statements generated while confirmed transactions change on-chain state. Each statement is grouped by block height and source and contains the receipts produced by transaction execution, including balance transfers, balance changes, expirations, and inflation. Results can be filtered by block height, receipt type, related addresses, and artifact IDs. * @summary Search transaction statements * @param {ReceiptRoutesApiSearchTransactionStatementsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReceiptRoutesApi */ searchTransactionStatements(requestParameters?: ReceiptRoutesApiSearchTransactionStatementsRequest, options?: RawAxiosRequestConfig): Promise>; } /** * RestrictionAccountRoutesApi - axios parameter creator * @export */ export declare const RestrictionAccountRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the account restriction entry associated with the given account address. * @summary Get account restrictions * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictions: (address: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns account restriction entries for the given account addresses. * @summary Get account restrictions for an array of addresses * @param {Addresses} addresses Request body containing account addresses in Base32 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictionsBatch: (addresses: Addresses, options?: RawAxiosRequestConfig) => Promise; /** * Returns the Merkle state proof for the account restriction entry associated with the given account address. If no account restriction entry exists for the supplied address, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account restriction state entry exists for the requested address. * @summary Get account restrictions Merkle information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictionsMerkle: (address: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of account restriction entries, optionally filtered by account address. * @summary Search account restrictions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountRestrictions: (address?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * RestrictionAccountRoutesApi - functional programming interface * @export */ export declare const RestrictionAccountRoutesApiFp: (configuration?: Configuration) => { /** * Returns the account restriction entry associated with the given account address. * @summary Get account restrictions * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictions(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns account restriction entries for the given account addresses. * @summary Get account restrictions for an array of addresses * @param {Addresses} addresses Request body containing account addresses in Base32 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictionsBatch(addresses: Addresses, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the Merkle state proof for the account restriction entry associated with the given account address. If no account restriction entry exists for the supplied address, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account restriction state entry exists for the requested address. * @summary Get account restrictions Merkle information * @param {string} address Account address in Base32-encoded format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictionsMerkle(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of account restriction entries, optionally filtered by account address. * @summary Search account restrictions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountRestrictions(address?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RestrictionAccountRoutesApi - factory interface * @export */ export declare const RestrictionAccountRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the account restriction entry associated with the given account address. * @summary Get account restrictions * @param {RestrictionAccountRoutesApiGetAccountRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictions(requestParameters: RestrictionAccountRoutesApiGetAccountRestrictionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns account restriction entries for the given account addresses. * @summary Get account restrictions for an array of addresses * @param {RestrictionAccountRoutesApiGetAccountRestrictionsBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictionsBatch(requestParameters: RestrictionAccountRoutesApiGetAccountRestrictionsBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the Merkle state proof for the account restriction entry associated with the given account address. If no account restriction entry exists for the supplied address, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account restriction state entry exists for the requested address. * @summary Get account restrictions Merkle information * @param {RestrictionAccountRoutesApiGetAccountRestrictionsMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountRestrictionsMerkle(requestParameters: RestrictionAccountRoutesApiGetAccountRestrictionsMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of account restriction entries, optionally filtered by account address. * @summary Search account restrictions * @param {RestrictionAccountRoutesApiSearchAccountRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountRestrictions(requestParameters?: RestrictionAccountRoutesApiSearchAccountRestrictionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getAccountRestrictions operation in RestrictionAccountRoutesApi. * @export * @interface RestrictionAccountRoutesApiGetAccountRestrictionsRequest */ export interface RestrictionAccountRoutesApiGetAccountRestrictionsRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof RestrictionAccountRoutesApiGetAccountRestrictions */ readonly address: string; } /** * Request parameters for getAccountRestrictionsBatch operation in RestrictionAccountRoutesApi. * @export * @interface RestrictionAccountRoutesApiGetAccountRestrictionsBatchRequest */ export interface RestrictionAccountRoutesApiGetAccountRestrictionsBatchRequest { /** * Request body containing account addresses in Base32 format. * @type {Addresses} * @memberof RestrictionAccountRoutesApiGetAccountRestrictionsBatch */ readonly addresses: Addresses; } /** * Request parameters for getAccountRestrictionsMerkle operation in RestrictionAccountRoutesApi. * @export * @interface RestrictionAccountRoutesApiGetAccountRestrictionsMerkleRequest */ export interface RestrictionAccountRoutesApiGetAccountRestrictionsMerkleRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof RestrictionAccountRoutesApiGetAccountRestrictionsMerkle */ readonly address: string; } /** * Request parameters for searchAccountRestrictions operation in RestrictionAccountRoutesApi. * @export * @interface RestrictionAccountRoutesApiSearchAccountRestrictionsRequest */ export interface RestrictionAccountRoutesApiSearchAccountRestrictionsRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof RestrictionAccountRoutesApiSearchAccountRestrictions */ readonly address?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof RestrictionAccountRoutesApiSearchAccountRestrictions */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof RestrictionAccountRoutesApiSearchAccountRestrictions */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof RestrictionAccountRoutesApiSearchAccountRestrictions */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof RestrictionAccountRoutesApiSearchAccountRestrictions */ readonly order?: Order; } /** * RestrictionAccountRoutesApi - object-oriented interface * @export * @class RestrictionAccountRoutesApi * @extends {BaseAPI} */ export declare class RestrictionAccountRoutesApi extends BaseAPI { /** * Returns the account restriction entry associated with the given account address. * @summary Get account restrictions * @param {RestrictionAccountRoutesApiGetAccountRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionAccountRoutesApi */ getAccountRestrictions(requestParameters: RestrictionAccountRoutesApiGetAccountRestrictionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns account restriction entries for the given account addresses. * @summary Get account restrictions for an array of addresses * @param {RestrictionAccountRoutesApiGetAccountRestrictionsBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionAccountRoutesApi */ getAccountRestrictionsBatch(requestParameters: RestrictionAccountRoutesApiGetAccountRestrictionsBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the Merkle state proof for the account restriction entry associated with the given account address. If no account restriction entry exists for the supplied address, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no account restriction state entry exists for the requested address. * @summary Get account restrictions Merkle information * @param {RestrictionAccountRoutesApiGetAccountRestrictionsMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionAccountRoutesApi */ getAccountRestrictionsMerkle(requestParameters: RestrictionAccountRoutesApiGetAccountRestrictionsMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of account restriction entries, optionally filtered by account address. * @summary Search account restrictions * @param {RestrictionAccountRoutesApiSearchAccountRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionAccountRoutesApi */ searchAccountRestrictions(requestParameters?: RestrictionAccountRoutesApiSearchAccountRestrictionsRequest, options?: RawAxiosRequestConfig): Promise>; } /** * RestrictionMosaicRoutesApi - axios parameter creator * @export */ export declare const RestrictionMosaicRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the mosaic restriction entry associated with the given composite hash. * @summary Get mosaic restrictions * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictions: (compositeHash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns mosaic restriction entries for the given composite hashes. * @summary Get mosaic restrictions for an array of composite hashes * @param {CompositeHashes} compositeHashes * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictionsBatch: (compositeHashes: CompositeHashes, options?: RawAxiosRequestConfig) => Promise; /** * Returns the Merkle state proof for the mosaic restriction entry associated with the given composite hash. If no mosaic restriction entry exists for the supplied composite hash, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic restriction state entry exists for the requested composite hash. * @summary Get mosaic restrictions Merkle information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictionsMerkle: (compositeHash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of mosaic restriction entries, optionally filtered by mosaic ID, entry type, and target address. * @summary Search mosaic restrictions * @param {string} [mosaicId] Filter by mosaic identifier (include). * @param {MosaicRestrictionEntryTypeEnum} [entryType] Filter by entry type (include). * @param {string} [targetAddress] Filter by target address in Base32 (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaicRestrictions: (mosaicId?: string, entryType?: MosaicRestrictionEntryTypeEnum, targetAddress?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * RestrictionMosaicRoutesApi - functional programming interface * @export */ export declare const RestrictionMosaicRoutesApiFp: (configuration?: Configuration) => { /** * Returns the mosaic restriction entry associated with the given composite hash. * @summary Get mosaic restrictions * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictions(compositeHash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns mosaic restriction entries for the given composite hashes. * @summary Get mosaic restrictions for an array of composite hashes * @param {CompositeHashes} compositeHashes * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictionsBatch(compositeHashes: CompositeHashes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns the Merkle state proof for the mosaic restriction entry associated with the given composite hash. If no mosaic restriction entry exists for the supplied composite hash, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic restriction state entry exists for the requested composite hash. * @summary Get mosaic restrictions Merkle information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictionsMerkle(compositeHash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of mosaic restriction entries, optionally filtered by mosaic ID, entry type, and target address. * @summary Search mosaic restrictions * @param {string} [mosaicId] Filter by mosaic identifier (include). * @param {MosaicRestrictionEntryTypeEnum} [entryType] Filter by entry type (include). * @param {string} [targetAddress] Filter by target address in Base32 (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaicRestrictions(mosaicId?: string, entryType?: MosaicRestrictionEntryTypeEnum, targetAddress?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RestrictionMosaicRoutesApi - factory interface * @export */ export declare const RestrictionMosaicRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the mosaic restriction entry associated with the given composite hash. * @summary Get mosaic restrictions * @param {RestrictionMosaicRoutesApiGetMosaicRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictions(requestParameters: RestrictionMosaicRoutesApiGetMosaicRestrictionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns mosaic restriction entries for the given composite hashes. * @summary Get mosaic restrictions for an array of composite hashes * @param {RestrictionMosaicRoutesApiGetMosaicRestrictionsBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictionsBatch(requestParameters: RestrictionMosaicRoutesApiGetMosaicRestrictionsBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns the Merkle state proof for the mosaic restriction entry associated with the given composite hash. If no mosaic restriction entry exists for the supplied composite hash, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic restriction state entry exists for the requested composite hash. * @summary Get mosaic restrictions Merkle information * @param {RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMosaicRestrictionsMerkle(requestParameters: RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of mosaic restriction entries, optionally filtered by mosaic ID, entry type, and target address. * @summary Search mosaic restrictions * @param {RestrictionMosaicRoutesApiSearchMosaicRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMosaicRestrictions(requestParameters?: RestrictionMosaicRoutesApiSearchMosaicRestrictionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getMosaicRestrictions operation in RestrictionMosaicRoutesApi. * @export * @interface RestrictionMosaicRoutesApiGetMosaicRestrictionsRequest */ export interface RestrictionMosaicRoutesApiGetMosaicRestrictionsRequest { /** * Composite hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof RestrictionMosaicRoutesApiGetMosaicRestrictions */ readonly compositeHash: string; } /** * Request parameters for getMosaicRestrictionsBatch operation in RestrictionMosaicRoutesApi. * @export * @interface RestrictionMosaicRoutesApiGetMosaicRestrictionsBatchRequest */ export interface RestrictionMosaicRoutesApiGetMosaicRestrictionsBatchRequest { /** * * @type {CompositeHashes} * @memberof RestrictionMosaicRoutesApiGetMosaicRestrictionsBatch */ readonly compositeHashes: CompositeHashes; } /** * Request parameters for getMosaicRestrictionsMerkle operation in RestrictionMosaicRoutesApi. * @export * @interface RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkleRequest */ export interface RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkleRequest { /** * Composite hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkle */ readonly compositeHash: string; } /** * Request parameters for searchMosaicRestrictions operation in RestrictionMosaicRoutesApi. * @export * @interface RestrictionMosaicRoutesApiSearchMosaicRestrictionsRequest */ export interface RestrictionMosaicRoutesApiSearchMosaicRestrictionsRequest { /** * Filter by mosaic identifier (include). * @type {string} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly mosaicId?: string; /** * Filter by entry type (include). * @type {MosaicRestrictionEntryTypeEnum} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly entryType?: MosaicRestrictionEntryTypeEnum; /** * Filter by target address in Base32 (include). * @type {string} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly targetAddress?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof RestrictionMosaicRoutesApiSearchMosaicRestrictions */ readonly order?: Order; } /** * RestrictionMosaicRoutesApi - object-oriented interface * @export * @class RestrictionMosaicRoutesApi * @extends {BaseAPI} */ export declare class RestrictionMosaicRoutesApi extends BaseAPI { /** * Returns the mosaic restriction entry associated with the given composite hash. * @summary Get mosaic restrictions * @param {RestrictionMosaicRoutesApiGetMosaicRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionMosaicRoutesApi */ getMosaicRestrictions(requestParameters: RestrictionMosaicRoutesApiGetMosaicRestrictionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns mosaic restriction entries for the given composite hashes. * @summary Get mosaic restrictions for an array of composite hashes * @param {RestrictionMosaicRoutesApiGetMosaicRestrictionsBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionMosaicRoutesApi */ getMosaicRestrictionsBatch(requestParameters: RestrictionMosaicRoutesApiGetMosaicRestrictionsBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the Merkle state proof for the mosaic restriction entry associated with the given composite hash. If no mosaic restriction entry exists for the supplied composite hash, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no mosaic restriction state entry exists for the requested composite hash. * @summary Get mosaic restrictions Merkle information * @param {RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionMosaicRoutesApi */ getMosaicRestrictionsMerkle(requestParameters: RestrictionMosaicRoutesApiGetMosaicRestrictionsMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of mosaic restriction entries, optionally filtered by mosaic ID, entry type, and target address. * @summary Search mosaic restrictions * @param {RestrictionMosaicRoutesApiSearchMosaicRestrictionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RestrictionMosaicRoutesApi */ searchMosaicRestrictions(requestParameters?: RestrictionMosaicRoutesApiSearchMosaicRestrictionsRequest, options?: RawAxiosRequestConfig): Promise>; } /** * SecretLockRoutesApi - axios parameter creator * @export */ export declare const SecretLockRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the secret lock entry associated with the given composite hash. * @summary Get secret lock information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLock: (compositeHash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the state Merkle proof for the secret lock entry associated with the given composite hash. * @summary Get secret lock Merkle information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLockMerkle: (compositeHash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns secret lock entries associated with the given composite hashes. * @summary Get secret lock information for an array of composite hashes * @param {CompositeHashes} compositeHashes * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLocks: (compositeHashes: CompositeHashes, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret. * @summary Search secret lock entries by account * @param {string} address Account address in Base32-encoded format. * @param {string} [secret] Filter by the 256-bit hashed secret associated with the secret lock (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountSecretLocks: (address: string, secret?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret. * @summary Search secret lock entries * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [secret] Filter by the 256-bit hashed secret associated with the secret lock (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchSecretLock: (address?: string, secret?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * SecretLockRoutesApi - functional programming interface * @export */ export declare const SecretLockRoutesApiFp: (configuration?: Configuration) => { /** * Returns the secret lock entry associated with the given composite hash. * @summary Get secret lock information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLock(compositeHash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the state Merkle proof for the secret lock entry associated with the given composite hash. * @summary Get secret lock Merkle information * @param {string} compositeHash Composite hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLockMerkle(compositeHash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns secret lock entries associated with the given composite hashes. * @summary Get secret lock information for an array of composite hashes * @param {CompositeHashes} compositeHashes * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLocks(compositeHashes: CompositeHashes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret. * @summary Search secret lock entries by account * @param {string} address Account address in Base32-encoded format. * @param {string} [secret] Filter by the 256-bit hashed secret associated with the secret lock (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountSecretLocks(address: string, secret?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret. * @summary Search secret lock entries * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [secret] Filter by the 256-bit hashed secret associated with the secret lock (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchSecretLock(address?: string, secret?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SecretLockRoutesApi - factory interface * @export */ export declare const SecretLockRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the secret lock entry associated with the given composite hash. * @summary Get secret lock information * @param {SecretLockRoutesApiGetSecretLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLock(requestParameters: SecretLockRoutesApiGetSecretLockRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the state Merkle proof for the secret lock entry associated with the given composite hash. * @summary Get secret lock Merkle information * @param {SecretLockRoutesApiGetSecretLockMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLockMerkle(requestParameters: SecretLockRoutesApiGetSecretLockMerkleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns secret lock entries associated with the given composite hashes. * @summary Get secret lock information for an array of composite hashes * @param {SecretLockRoutesApiGetSecretLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecretLocks(requestParameters: SecretLockRoutesApiGetSecretLocksRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret. * @summary Search secret lock entries by account * @param {SecretLockRoutesApiSearchAccountSecretLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchAccountSecretLocks(requestParameters: SecretLockRoutesApiSearchAccountSecretLocksRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret. * @summary Search secret lock entries * @param {SecretLockRoutesApiSearchSecretLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchSecretLock(requestParameters?: SecretLockRoutesApiSearchSecretLockRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getSecretLock operation in SecretLockRoutesApi. * @export * @interface SecretLockRoutesApiGetSecretLockRequest */ export interface SecretLockRoutesApiGetSecretLockRequest { /** * Composite hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof SecretLockRoutesApiGetSecretLock */ readonly compositeHash: string; } /** * Request parameters for getSecretLockMerkle operation in SecretLockRoutesApi. * @export * @interface SecretLockRoutesApiGetSecretLockMerkleRequest */ export interface SecretLockRoutesApiGetSecretLockMerkleRequest { /** * Composite hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof SecretLockRoutesApiGetSecretLockMerkle */ readonly compositeHash: string; } /** * Request parameters for getSecretLocks operation in SecretLockRoutesApi. * @export * @interface SecretLockRoutesApiGetSecretLocksRequest */ export interface SecretLockRoutesApiGetSecretLocksRequest { /** * * @type {CompositeHashes} * @memberof SecretLockRoutesApiGetSecretLocks */ readonly compositeHashes: CompositeHashes; } /** * Request parameters for searchAccountSecretLocks operation in SecretLockRoutesApi. * @export * @interface SecretLockRoutesApiSearchAccountSecretLocksRequest */ export interface SecretLockRoutesApiSearchAccountSecretLocksRequest { /** * Account address in Base32-encoded format. * @type {string} * @memberof SecretLockRoutesApiSearchAccountSecretLocks */ readonly address: string; /** * Filter by the 256-bit hashed secret associated with the secret lock (include). * @type {string} * @memberof SecretLockRoutesApiSearchAccountSecretLocks */ readonly secret?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof SecretLockRoutesApiSearchAccountSecretLocks */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof SecretLockRoutesApiSearchAccountSecretLocks */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof SecretLockRoutesApiSearchAccountSecretLocks */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof SecretLockRoutesApiSearchAccountSecretLocks */ readonly order?: Order; } /** * Request parameters for searchSecretLock operation in SecretLockRoutesApi. * @export * @interface SecretLockRoutesApiSearchSecretLockRequest */ export interface SecretLockRoutesApiSearchSecretLockRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof SecretLockRoutesApiSearchSecretLock */ readonly address?: string; /** * Filter by the 256-bit hashed secret associated with the secret lock (include). * @type {string} * @memberof SecretLockRoutesApiSearchSecretLock */ readonly secret?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof SecretLockRoutesApiSearchSecretLock */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof SecretLockRoutesApiSearchSecretLock */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof SecretLockRoutesApiSearchSecretLock */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof SecretLockRoutesApiSearchSecretLock */ readonly order?: Order; } /** * SecretLockRoutesApi - object-oriented interface * @export * @class SecretLockRoutesApi * @extends {BaseAPI} */ export declare class SecretLockRoutesApi extends BaseAPI { /** * Returns the secret lock entry associated with the given composite hash. * @summary Get secret lock information * @param {SecretLockRoutesApiGetSecretLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecretLockRoutesApi */ getSecretLock(requestParameters: SecretLockRoutesApiGetSecretLockRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the state Merkle proof for the secret lock entry associated with the given composite hash. * @summary Get secret lock Merkle information * @param {SecretLockRoutesApiGetSecretLockMerkleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecretLockRoutesApi */ getSecretLockMerkle(requestParameters: SecretLockRoutesApiGetSecretLockMerkleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns secret lock entries associated with the given composite hashes. * @summary Get secret lock information for an array of composite hashes * @param {SecretLockRoutesApiGetSecretLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecretLockRoutesApi */ getSecretLocks(requestParameters: SecretLockRoutesApiGetSecretLocksRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret. * @summary Search secret lock entries by account * @param {SecretLockRoutesApiSearchAccountSecretLocksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecretLockRoutesApi */ searchAccountSecretLocks(requestParameters: SecretLockRoutesApiSearchAccountSecretLocksRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret. * @summary Search secret lock entries * @param {SecretLockRoutesApiSearchSecretLockRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecretLockRoutesApi */ searchSecretLock(requestParameters?: SecretLockRoutesApiSearchSecretLockRequest, options?: RawAxiosRequestConfig): Promise>; } /** * TransactionRoutesApi - axios parameter creator * @export */ export declare const TransactionRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Broadcasts a detached cosignature for an aggregate bonded transaction to the network through this node. The request must contain the detached cosignature fields: cosignature version, signer public key, cosignature signature, and the parent aggregate transaction hash. Detached cosignatures are normally created client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the parent aggregate bonded transaction is already confirmed on-chain. The cosignature still needs to be propagated and processed by the network. To verify the effect of the cosignature, query the **parent aggregate bonded transaction**, for example with [`GET /transactionStatus/{hash}`](/transactionStatus/{hash}) using the parent aggregate transaction hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a cosignature transaction * @param {Cosignature} cosignature Request body for announcing one detached cosignature for an aggregate bonded transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announceCosignatureTransaction: (cosignature: Cosignature, options?: RawAxiosRequestConfig) => Promise; /** * Broadcasts a signed aggregate bonded transaction to the network through this node. The request must contain the serialized aggregate bonded transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce an aggregate bonded transaction * @param {TransactionPayload} transactionPayload Request body for transaction announcement. Contains one signed transaction payload serialized in hexadecimal form. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcePartialTransaction: (transactionPayload: TransactionPayload, options?: RawAxiosRequestConfig) => Promise; /** * Broadcasts a signed transaction to the network through this node. The request must contain the serialized transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. The [catbuffer library](https://github.com/symbol/symbol/tree/main/catbuffer) defines the binary serialization format used by Symbol entities. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a new transaction * @param {TransactionPayload} transactionPayload Request body for transaction announcement. Contains one signed transaction payload serialized in hexadecimal form. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announceTransaction: (transactionPayload: TransactionPayload, options?: RawAxiosRequestConfig) => Promise; /** * Returns confirmed transaction information given a transaction ID assigned by the node or transaction hash. Use this endpoint when you need on-chain transaction data (the transaction is already included in a block). Use `getUnconfirmedTransaction` while the transaction is still in a node\'s unconfirmed pool, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transaction information * @param {string} transactionId Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfirmedTransaction: (transactionId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns confirmed transactions for the list of identifiers in the request body. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/confirmed` and `GET /transactions/confirmed/{transactionId}`. Use this endpoint when you need on-chain data for multiple transactions in one call. Use `getUnconfirmedTransactions` for transactions still pending in a node pool, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transactions information * @param {TransactionIds} transactionIds Request body containing transaction IDs or hashes to retrieve in batch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfirmedTransactions: (transactionIds: TransactionIds, options?: RawAxiosRequestConfig) => Promise; /** * Returns one partial transaction identified by the path value. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions before they are fully cosigned. Use `getUnconfirmedTransaction` for non-partial transactions that are in a node\'s unconfirmed pool, and use `getConfirmedTransaction` once the transaction is confirmed on-chain. * @summary Get partial transaction information * @param {string} transactionId Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPartialTransaction: (transactionId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns partial transactions for the list of identifiers in the request body. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `getUnconfirmedTransactions` for non-partial pending transactions accepted by a node but not yet included in a block, and use `getConfirmedTransactions` once transactions are confirmed on-chain. * @summary Get information about partial transactions * @param {TransactionIds} transactionIds Request body containing transaction IDs or hashes to retrieve in batch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPartialTransactions: (transactionIds: TransactionIds, options?: RawAxiosRequestConfig) => Promise; /** * Returns one unconfirmed transaction identified by the path value. An unconfirmed transaction is accepted by a node and pending inclusion in a block. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint while a transaction is accepted by a node but not yet included in a block. Use `getConfirmedTransaction` once it is confirmed on-chain, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get unconfirmed transaction information * @param {string} transactionId Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnconfirmedTransaction: (transactionId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns unconfirmed transactions for the list of identifiers in the request body. Unconfirmed transactions are accepted by a node and pending inclusion in a block. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint when checking multiple transactions that are accepted by a node but not yet included in a block. Use `getConfirmedTransactions` for on-chain transactions, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get information about unconfirmed transactions * @param {TransactionIds} transactionIds Request body containing transaction IDs or hashes to retrieve in batch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnconfirmedTransactions: (transactionIds: TransactionIds, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of confirmed transactions matching the supplied filters. Use this endpoint when you need on-chain transactions only (already included in blocks). Use `searchUnconfirmedTransactions` for transactions that are still pending in a node pool, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. If a transaction was announced with an alias rather than an address, the address considered during filtering is the one resolved from that alias at confirmation time. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search confirmed transactions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {string} [fromTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @param {string} [toTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @param {Array} [type] Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @param {boolean} [embedded] When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @param {string} [transferMosaicId] Filter transfer transactions by the mosaic ID in the transfer payload (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchConfirmedTransactions: (address?: string, recipientAddress?: string, signerPublicKey?: string, height?: string, fromHeight?: string, toHeight?: string, fromTransferAmount?: string, toTransferAmount?: string, type?: Array, embedded?: boolean, transferMosaicId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of partial transactions matching the supplied filters. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `searchUnconfirmedTransactions` for non-partial pending transactions, and use `searchConfirmedTransactions` once transactions are confirmed on-chain. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search partial transactions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {string} [fromTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @param {string} [toTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @param {Array} [type] Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @param {boolean} [embedded] When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @param {string} [transferMosaicId] Filter transfer transactions by the mosaic ID in the transfer payload (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchPartialTransactions: (address?: string, recipientAddress?: string, signerPublicKey?: string, height?: string, fromHeight?: string, toHeight?: string, fromTransferAmount?: string, toTransferAmount?: string, type?: Array, embedded?: boolean, transferMosaicId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of unconfirmed transactions matching the supplied filters. Use this endpoint for transactions accepted by a node but not yet included in a block. Use `searchConfirmedTransactions` for on-chain transactions, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search unconfirmed transactions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {string} [fromTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @param {string} [toTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @param {Array} [type] Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @param {boolean} [embedded] When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @param {string} [transferMosaicId] Filter transfer transactions by the mosaic ID in the transfer payload (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUnconfirmedTransactions: (address?: string, recipientAddress?: string, signerPublicKey?: string, height?: string, fromHeight?: string, toHeight?: string, fromTransferAmount?: string, toTransferAmount?: string, type?: Array, embedded?: boolean, transferMosaicId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig) => Promise; }; /** * TransactionRoutesApi - functional programming interface * @export */ export declare const TransactionRoutesApiFp: (configuration?: Configuration) => { /** * Broadcasts a detached cosignature for an aggregate bonded transaction to the network through this node. The request must contain the detached cosignature fields: cosignature version, signer public key, cosignature signature, and the parent aggregate transaction hash. Detached cosignatures are normally created client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the parent aggregate bonded transaction is already confirmed on-chain. The cosignature still needs to be propagated and processed by the network. To verify the effect of the cosignature, query the **parent aggregate bonded transaction**, for example with [`GET /transactionStatus/{hash}`](/transactionStatus/{hash}) using the parent aggregate transaction hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a cosignature transaction * @param {Cosignature} cosignature Request body for announcing one detached cosignature for an aggregate bonded transaction. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announceCosignatureTransaction(cosignature: Cosignature, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Broadcasts a signed aggregate bonded transaction to the network through this node. The request must contain the serialized aggregate bonded transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce an aggregate bonded transaction * @param {TransactionPayload} transactionPayload Request body for transaction announcement. Contains one signed transaction payload serialized in hexadecimal form. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcePartialTransaction(transactionPayload: TransactionPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Broadcasts a signed transaction to the network through this node. The request must contain the serialized transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. The [catbuffer library](https://github.com/symbol/symbol/tree/main/catbuffer) defines the binary serialization format used by Symbol entities. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a new transaction * @param {TransactionPayload} transactionPayload Request body for transaction announcement. Contains one signed transaction payload serialized in hexadecimal form. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announceTransaction(transactionPayload: TransactionPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns confirmed transaction information given a transaction ID assigned by the node or transaction hash. Use this endpoint when you need on-chain transaction data (the transaction is already included in a block). Use `getUnconfirmedTransaction` while the transaction is still in a node\'s unconfirmed pool, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transaction information * @param {string} transactionId Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfirmedTransaction(transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns confirmed transactions for the list of identifiers in the request body. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/confirmed` and `GET /transactions/confirmed/{transactionId}`. Use this endpoint when you need on-chain data for multiple transactions in one call. Use `getUnconfirmedTransactions` for transactions still pending in a node pool, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transactions information * @param {TransactionIds} transactionIds Request body containing transaction IDs or hashes to retrieve in batch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfirmedTransactions(transactionIds: TransactionIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns one partial transaction identified by the path value. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions before they are fully cosigned. Use `getUnconfirmedTransaction` for non-partial transactions that are in a node\'s unconfirmed pool, and use `getConfirmedTransaction` once the transaction is confirmed on-chain. * @summary Get partial transaction information * @param {string} transactionId Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPartialTransaction(transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns partial transactions for the list of identifiers in the request body. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `getUnconfirmedTransactions` for non-partial pending transactions accepted by a node but not yet included in a block, and use `getConfirmedTransactions` once transactions are confirmed on-chain. * @summary Get information about partial transactions * @param {TransactionIds} transactionIds Request body containing transaction IDs or hashes to retrieve in batch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPartialTransactions(transactionIds: TransactionIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns one unconfirmed transaction identified by the path value. An unconfirmed transaction is accepted by a node and pending inclusion in a block. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint while a transaction is accepted by a node but not yet included in a block. Use `getConfirmedTransaction` once it is confirmed on-chain, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get unconfirmed transaction information * @param {string} transactionId Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnconfirmedTransaction(transactionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns unconfirmed transactions for the list of identifiers in the request body. Unconfirmed transactions are accepted by a node and pending inclusion in a block. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint when checking multiple transactions that are accepted by a node but not yet included in a block. Use `getConfirmedTransactions` for on-chain transactions, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get information about unconfirmed transactions * @param {TransactionIds} transactionIds Request body containing transaction IDs or hashes to retrieve in batch. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnconfirmedTransactions(transactionIds: TransactionIds, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Returns a paginated list of confirmed transactions matching the supplied filters. Use this endpoint when you need on-chain transactions only (already included in blocks). Use `searchUnconfirmedTransactions` for transactions that are still pending in a node pool, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. If a transaction was announced with an alias rather than an address, the address considered during filtering is the one resolved from that alias at confirmation time. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search confirmed transactions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {string} [fromTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @param {string} [toTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @param {Array} [type] Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @param {boolean} [embedded] When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @param {string} [transferMosaicId] Filter transfer transactions by the mosaic ID in the transfer payload (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchConfirmedTransactions(address?: string, recipientAddress?: string, signerPublicKey?: string, height?: string, fromHeight?: string, toHeight?: string, fromTransferAmount?: string, toTransferAmount?: string, type?: Array, embedded?: boolean, transferMosaicId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of partial transactions matching the supplied filters. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `searchUnconfirmedTransactions` for non-partial pending transactions, and use `searchConfirmedTransactions` once transactions are confirmed on-chain. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search partial transactions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {string} [fromTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @param {string} [toTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @param {Array} [type] Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @param {boolean} [embedded] When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @param {string} [transferMosaicId] Filter transfer transactions by the mosaic ID in the transfer payload (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchPartialTransactions(address?: string, recipientAddress?: string, signerPublicKey?: string, height?: string, fromHeight?: string, toHeight?: string, fromTransferAmount?: string, toTransferAmount?: string, type?: Array, embedded?: boolean, transferMosaicId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of unconfirmed transactions matching the supplied filters. Use this endpoint for transactions accepted by a node but not yet included in a block. Use `searchConfirmedTransactions` for on-chain transactions, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search unconfirmed transactions * @param {string} [address] Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @param {string} [recipientAddress] Filter transactions by recipient address in Base32 format (include). * @param {string} [signerPublicKey] Filter transactions by the public key of the signing account (include). * @param {string} [height] Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @param {string} [fromHeight] Only transactions at or above this block height are returned. * @param {string} [toHeight] Only transactions at or below this block height are returned. * @param {string} [fromTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @param {string} [toTransferAmount] Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @param {Array} [type] Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @param {boolean} [embedded] When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @param {string} [transferMosaicId] Filter transfer transactions by the mosaic ID in the transfer payload (include). * @param {number} [pageSize] Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @param {number} [pageNumber] Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {string} [offset] Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @param {Order} [order] Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUnconfirmedTransactions(address?: string, recipientAddress?: string, signerPublicKey?: string, height?: string, fromHeight?: string, toHeight?: string, fromTransferAmount?: string, toTransferAmount?: string, type?: Array, embedded?: boolean, transferMosaicId?: string, pageSize?: number, pageNumber?: number, offset?: string, order?: Order, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TransactionRoutesApi - factory interface * @export */ export declare const TransactionRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Broadcasts a detached cosignature for an aggregate bonded transaction to the network through this node. The request must contain the detached cosignature fields: cosignature version, signer public key, cosignature signature, and the parent aggregate transaction hash. Detached cosignatures are normally created client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the parent aggregate bonded transaction is already confirmed on-chain. The cosignature still needs to be propagated and processed by the network. To verify the effect of the cosignature, query the **parent aggregate bonded transaction**, for example with [`GET /transactionStatus/{hash}`](/transactionStatus/{hash}) using the parent aggregate transaction hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a cosignature transaction * @param {TransactionRoutesApiAnnounceCosignatureTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announceCosignatureTransaction(requestParameters: TransactionRoutesApiAnnounceCosignatureTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Broadcasts a signed aggregate bonded transaction to the network through this node. The request must contain the serialized aggregate bonded transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce an aggregate bonded transaction * @param {TransactionRoutesApiAnnouncePartialTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announcePartialTransaction(requestParameters: TransactionRoutesApiAnnouncePartialTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Broadcasts a signed transaction to the network through this node. The request must contain the serialized transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. The [catbuffer library](https://github.com/symbol/symbol/tree/main/catbuffer) defines the binary serialization format used by Symbol entities. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a new transaction * @param {TransactionRoutesApiAnnounceTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ announceTransaction(requestParameters: TransactionRoutesApiAnnounceTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns confirmed transaction information given a transaction ID assigned by the node or transaction hash. Use this endpoint when you need on-chain transaction data (the transaction is already included in a block). Use `getUnconfirmedTransaction` while the transaction is still in a node\'s unconfirmed pool, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transaction information * @param {TransactionRoutesApiGetConfirmedTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfirmedTransaction(requestParameters: TransactionRoutesApiGetConfirmedTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns confirmed transactions for the list of identifiers in the request body. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/confirmed` and `GET /transactions/confirmed/{transactionId}`. Use this endpoint when you need on-chain data for multiple transactions in one call. Use `getUnconfirmedTransactions` for transactions still pending in a node pool, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transactions information * @param {TransactionRoutesApiGetConfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfirmedTransactions(requestParameters: TransactionRoutesApiGetConfirmedTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns one partial transaction identified by the path value. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions before they are fully cosigned. Use `getUnconfirmedTransaction` for non-partial transactions that are in a node\'s unconfirmed pool, and use `getConfirmedTransaction` once the transaction is confirmed on-chain. * @summary Get partial transaction information * @param {TransactionRoutesApiGetPartialTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPartialTransaction(requestParameters: TransactionRoutesApiGetPartialTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns partial transactions for the list of identifiers in the request body. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `getUnconfirmedTransactions` for non-partial pending transactions accepted by a node but not yet included in a block, and use `getConfirmedTransactions` once transactions are confirmed on-chain. * @summary Get information about partial transactions * @param {TransactionRoutesApiGetPartialTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPartialTransactions(requestParameters: TransactionRoutesApiGetPartialTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns one unconfirmed transaction identified by the path value. An unconfirmed transaction is accepted by a node and pending inclusion in a block. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint while a transaction is accepted by a node but not yet included in a block. Use `getConfirmedTransaction` once it is confirmed on-chain, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get unconfirmed transaction information * @param {TransactionRoutesApiGetUnconfirmedTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnconfirmedTransaction(requestParameters: TransactionRoutesApiGetUnconfirmedTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns unconfirmed transactions for the list of identifiers in the request body. Unconfirmed transactions are accepted by a node and pending inclusion in a block. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint when checking multiple transactions that are accepted by a node but not yet included in a block. Use `getConfirmedTransactions` for on-chain transactions, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get information about unconfirmed transactions * @param {TransactionRoutesApiGetUnconfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnconfirmedTransactions(requestParameters: TransactionRoutesApiGetUnconfirmedTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Returns a paginated list of confirmed transactions matching the supplied filters. Use this endpoint when you need on-chain transactions only (already included in blocks). Use `searchUnconfirmedTransactions` for transactions that are still pending in a node pool, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. If a transaction was announced with an alias rather than an address, the address considered during filtering is the one resolved from that alias at confirmation time. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search confirmed transactions * @param {TransactionRoutesApiSearchConfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchConfirmedTransactions(requestParameters?: TransactionRoutesApiSearchConfirmedTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of partial transactions matching the supplied filters. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `searchUnconfirmedTransactions` for non-partial pending transactions, and use `searchConfirmedTransactions` once transactions are confirmed on-chain. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search partial transactions * @param {TransactionRoutesApiSearchPartialTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchPartialTransactions(requestParameters?: TransactionRoutesApiSearchPartialTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of unconfirmed transactions matching the supplied filters. Use this endpoint for transactions accepted by a node but not yet included in a block. Use `searchConfirmedTransactions` for on-chain transactions, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search unconfirmed transactions * @param {TransactionRoutesApiSearchUnconfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUnconfirmedTransactions(requestParameters?: TransactionRoutesApiSearchUnconfirmedTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for announceCosignatureTransaction operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiAnnounceCosignatureTransactionRequest */ export interface TransactionRoutesApiAnnounceCosignatureTransactionRequest { /** * Request body for announcing one detached cosignature for an aggregate bonded transaction. * @type {Cosignature} * @memberof TransactionRoutesApiAnnounceCosignatureTransaction */ readonly cosignature: Cosignature; } /** * Request parameters for announcePartialTransaction operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiAnnouncePartialTransactionRequest */ export interface TransactionRoutesApiAnnouncePartialTransactionRequest { /** * Request body for transaction announcement. Contains one signed transaction payload serialized in hexadecimal form. * @type {TransactionPayload} * @memberof TransactionRoutesApiAnnouncePartialTransaction */ readonly transactionPayload: TransactionPayload; } /** * Request parameters for announceTransaction operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiAnnounceTransactionRequest */ export interface TransactionRoutesApiAnnounceTransactionRequest { /** * Request body for transaction announcement. Contains one signed transaction payload serialized in hexadecimal form. * @type {TransactionPayload} * @memberof TransactionRoutesApiAnnounceTransaction */ readonly transactionPayload: TransactionPayload; } /** * Request parameters for getConfirmedTransaction operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiGetConfirmedTransactionRequest */ export interface TransactionRoutesApiGetConfirmedTransactionRequest { /** * Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @type {string} * @memberof TransactionRoutesApiGetConfirmedTransaction */ readonly transactionId: string; } /** * Request parameters for getConfirmedTransactions operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiGetConfirmedTransactionsRequest */ export interface TransactionRoutesApiGetConfirmedTransactionsRequest { /** * Request body containing transaction IDs or hashes to retrieve in batch. * @type {TransactionIds} * @memberof TransactionRoutesApiGetConfirmedTransactions */ readonly transactionIds: TransactionIds; } /** * Request parameters for getPartialTransaction operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiGetPartialTransactionRequest */ export interface TransactionRoutesApiGetPartialTransactionRequest { /** * Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @type {string} * @memberof TransactionRoutesApiGetPartialTransaction */ readonly transactionId: string; } /** * Request parameters for getPartialTransactions operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiGetPartialTransactionsRequest */ export interface TransactionRoutesApiGetPartialTransactionsRequest { /** * Request body containing transaction IDs or hashes to retrieve in batch. * @type {TransactionIds} * @memberof TransactionRoutesApiGetPartialTransactions */ readonly transactionIds: TransactionIds; } /** * Request parameters for getUnconfirmedTransaction operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiGetUnconfirmedTransactionRequest */ export interface TransactionRoutesApiGetUnconfirmedTransactionRequest { /** * Transaction hash (64 hexadecimal characters) or node-assigned transaction ID (16 hexadecimal characters). * @type {string} * @memberof TransactionRoutesApiGetUnconfirmedTransaction */ readonly transactionId: string; } /** * Request parameters for getUnconfirmedTransactions operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiGetUnconfirmedTransactionsRequest */ export interface TransactionRoutesApiGetUnconfirmedTransactionsRequest { /** * Request body containing transaction IDs or hashes to retrieve in batch. * @type {TransactionIds} * @memberof TransactionRoutesApiGetUnconfirmedTransactions */ readonly transactionIds: TransactionIds; } /** * Request parameters for searchConfirmedTransactions operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiSearchConfirmedTransactionsRequest */ export interface TransactionRoutesApiSearchConfirmedTransactionsRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly address?: string; /** * Filter transactions by recipient address in Base32 format (include). * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly recipientAddress?: string; /** * Filter transactions by the public key of the signing account (include). * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly signerPublicKey?: string; /** * Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly height?: string; /** * Only transactions at or above this block height are returned. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly fromHeight?: string; /** * Only transactions at or below this block height are returned. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly toHeight?: string; /** * Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly fromTransferAmount?: string; /** * Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly toTransferAmount?: string; /** * Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @type {Array} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly type?: Array; /** * When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @type {boolean} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly embedded?: boolean; /** * Filter transfer transactions by the mosaic ID in the transfer payload (include). * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly transferMosaicId?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof TransactionRoutesApiSearchConfirmedTransactions */ readonly order?: Order; } /** * Request parameters for searchPartialTransactions operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiSearchPartialTransactionsRequest */ export interface TransactionRoutesApiSearchPartialTransactionsRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly address?: string; /** * Filter transactions by recipient address in Base32 format (include). * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly recipientAddress?: string; /** * Filter transactions by the public key of the signing account (include). * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly signerPublicKey?: string; /** * Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly height?: string; /** * Only transactions at or above this block height are returned. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly fromHeight?: string; /** * Only transactions at or below this block height are returned. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly toHeight?: string; /** * Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly fromTransferAmount?: string; /** * Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly toTransferAmount?: string; /** * Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @type {Array} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly type?: Array; /** * When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @type {boolean} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly embedded?: boolean; /** * Filter transfer transactions by the mosaic ID in the transfer payload (include). * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly transferMosaicId?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof TransactionRoutesApiSearchPartialTransactions */ readonly order?: Order; } /** * Request parameters for searchUnconfirmedTransactions operation in TransactionRoutesApi. * @export * @interface TransactionRoutesApiSearchUnconfirmedTransactionsRequest */ export interface TransactionRoutesApiSearchUnconfirmedTransactionsRequest { /** * Filter by address (include), in Base32 format. The exact meaning depends on the endpoint: - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner - account search: matches the account address - account restriction search: matches the restricted account address - hash lock and secret lock search: matches the lock owner address On transaction search endpoints, this filter cannot be combined with `recipientAddress` and `signerPublicKey`. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly address?: string; /** * Filter transactions by recipient address in Base32 format (include). * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly recipientAddress?: string; /** * Filter transactions by the public key of the signing account (include). * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly signerPublicKey?: string; /** * Filter by height (include). The exact meaning depends on the endpoint, for example block height for blocks or inclusion height for confirmed transactions. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly height?: string; /** * Only transactions at or above this block height are returned. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly fromHeight?: string; /** * Only transactions at or below this block height are returned. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly toHeight?: string; /** * Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount greater than or equal to this value for the specified mosaic ID are returned. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly fromTransferAmount?: string; /** * Requires providing the `transferMosaicId` filter. Only transfer transactions with an amount less than or equal to this value for the specified mosaic ID are returned. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly toTransferAmount?: string; /** * Filter by transaction type (include). To match multiple transaction types, add more query parameters like: `type=16974&type=16718`. * @type {Array} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly type?: Array; /** * When `true`, the search also includes transactions embedded inside aggregate transactions. Otherwise, only top-level transactions are returned. Results are **flattened**. Embedded transactions are returned as separate entries in the same `data` array as top-level transactions, not nested under their parent aggregate transaction. Sorting, filtering, and pagination are therefore applied to one combined result set containing both top-level and embedded transaction records. In the database, embedded transactions are stored as separate documents linked to their parent aggregate by `meta.aggregateId` and `meta.aggregateHash`. When `embedded=false`, the search excludes documents with `meta.aggregateId`. When `embedded=true`, those documents are included in the page result alongside regular transactions. In REST responses, embedded entries are identified by `meta.aggregateId`, `meta.aggregateHash`, and their inner `meta.index`; unlike top-level transactions, they do not carry their own `meta.hash`. **Note:** This field does not work as expected with the `address` filter. That filter matches the internal `meta.addresses` field used on top-level transaction documents, while embedded transaction documents do not carry that field. As a result, embedded transactions involving the specified address will not be returned even when `embedded=true`. Filters such as `recipientAddress` and `signerPublicKey` do not have this limitation. * @type {boolean} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly embedded?: boolean; /** * Filter transfer transactions by the mosaic ID in the transfer payload (include). * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly transferMosaicId?: string; /** * Select the number of entries to return per page. Values outside the allowed range are clamped to the schema minimum or maximum. * @type {number} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly pageSize?: number; /** * Page number for numbered pagination (1-based). Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {number} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly pageNumber?: number; /** * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the last entry of the previous page. **The offset type must match `orderBy`:** - `orderBy=id`: use the entry\'s `id` (ObjectId, 24-char hex). - `orderBy=height`: use the block height (string, e.g. `\"17592\"`). - `orderBy=balance`: use the mosaic balance amount (string, e.g. `\"1000000\"`). Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default. Set `offset` to the sort-field value of the last entry from the previous page. Across pages, this value decreases with `order=desc` and increases with `order=asc`. Numbered and cursor pagination can be combined, but this is not recommended because the semantics are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by incrementing `pageNumber`. * @type {string} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly offset?: string; /** * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`. If the request does not specify `orderBy`, REST returns the collection ordered by id. The default sort direction depends on the endpoint implementation. * @type {Order} * @memberof TransactionRoutesApiSearchUnconfirmedTransactions */ readonly order?: Order; } /** * TransactionRoutesApi - object-oriented interface * @export * @class TransactionRoutesApi * @extends {BaseAPI} */ export declare class TransactionRoutesApi extends BaseAPI { /** * Broadcasts a detached cosignature for an aggregate bonded transaction to the network through this node. The request must contain the detached cosignature fields: cosignature version, signer public key, cosignature signature, and the parent aggregate transaction hash. Detached cosignatures are normally created client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the parent aggregate bonded transaction is already confirmed on-chain. The cosignature still needs to be propagated and processed by the network. To verify the effect of the cosignature, query the **parent aggregate bonded transaction**, for example with [`GET /transactionStatus/{hash}`](/transactionStatus/{hash}) using the parent aggregate transaction hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a cosignature transaction * @param {TransactionRoutesApiAnnounceCosignatureTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ announceCosignatureTransaction(requestParameters: TransactionRoutesApiAnnounceCosignatureTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Broadcasts a signed aggregate bonded transaction to the network through this node. The request must contain the serialized aggregate bonded transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce an aggregate bonded transaction * @param {TransactionRoutesApiAnnouncePartialTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ announcePartialTransaction(requestParameters: TransactionRoutesApiAnnouncePartialTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Broadcasts a signed transaction to the network through this node. The request must contain the serialized transaction payload in hexadecimal form. Transactions are normally created and signed client-side with a [Symbol SDK](https://docs.symbol.dev/sdk.html) and then announced with this endpoint. The [catbuffer library](https://github.com/symbol/symbol/tree/main/catbuffer) defines the binary serialization format used by Symbol entities. Acceptance by this node does not mean the transaction is already part of the blockchain. The transaction still needs to be validated and confirmed by the network. To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received the announce request. If that node drops the transaction before propagation, other nodes may not know the transaction at all and can return `404` for the same hash. Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection and may be evicted as new entries arrive. * @summary Announce a new transaction * @param {TransactionRoutesApiAnnounceTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ announceTransaction(requestParameters: TransactionRoutesApiAnnounceTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns confirmed transaction information given a transaction ID assigned by the node or transaction hash. Use this endpoint when you need on-chain transaction data (the transaction is already included in a block). Use `getUnconfirmedTransaction` while the transaction is still in a node\'s unconfirmed pool, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transaction information * @param {TransactionRoutesApiGetConfirmedTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ getConfirmedTransaction(requestParameters: TransactionRoutesApiGetConfirmedTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns confirmed transactions for the list of identifiers in the request body. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/confirmed` and `GET /transactions/confirmed/{transactionId}`. Use this endpoint when you need on-chain data for multiple transactions in one call. Use `getUnconfirmedTransactions` for transactions still pending in a node pool, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get confirmed transactions information * @param {TransactionRoutesApiGetConfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ getConfirmedTransactions(requestParameters: TransactionRoutesApiGetConfirmedTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns one partial transaction identified by the path value. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions before they are fully cosigned. Use `getUnconfirmedTransaction` for non-partial transactions that are in a node\'s unconfirmed pool, and use `getConfirmedTransaction` once the transaction is confirmed on-chain. * @summary Get partial transaction information * @param {TransactionRoutesApiGetPartialTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ getPartialTransaction(requestParameters: TransactionRoutesApiGetPartialTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns partial transactions for the list of identifiers in the request body. Partial transactions are aggregate bonded transactions waiting for the remaining cosignatures. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/partial` and `GET /transactions/partial/{transactionId}`. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `getUnconfirmedTransactions` for non-partial pending transactions accepted by a node but not yet included in a block, and use `getConfirmedTransactions` once transactions are confirmed on-chain. * @summary Get information about partial transactions * @param {TransactionRoutesApiGetPartialTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ getPartialTransactions(requestParameters: TransactionRoutesApiGetPartialTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns one unconfirmed transaction identified by the path value. An unconfirmed transaction is accepted by a node and pending inclusion in a block. The path accepts either the transaction ID assigned by the node or the transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint while a transaction is accepted by a node but not yet included in a block. Use `getConfirmedTransaction` once it is confirmed on-chain, and use `getPartialTransaction` for aggregate bonded transactions waiting for cosignatures. * @summary Get unconfirmed transaction information * @param {TransactionRoutesApiGetUnconfirmedTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ getUnconfirmedTransaction(requestParameters: TransactionRoutesApiGetUnconfirmedTransactionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns unconfirmed transactions for the list of identifiers in the request body. Unconfirmed transactions are accepted by a node and pending inclusion in a block. Each request item can be either a transaction ID assigned by the node or a transaction hash. Both values are returned by transaction retrieval and search endpoints, for example `GET /transactions/unconfirmed` and `GET /transactions/unconfirmed/{transactionId}`. Use this endpoint when checking multiple transactions that are accepted by a node but not yet included in a block. Use `getConfirmedTransactions` for on-chain transactions, and use `getPartialTransactions` for aggregate bonded transactions waiting for cosignatures. * @summary Get information about unconfirmed transactions * @param {TransactionRoutesApiGetUnconfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ getUnconfirmedTransactions(requestParameters: TransactionRoutesApiGetUnconfirmedTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of confirmed transactions matching the supplied filters. Use this endpoint when you need on-chain transactions only (already included in blocks). Use `searchUnconfirmedTransactions` for transactions that are still pending in a node pool, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. If a transaction was announced with an alias rather than an address, the address considered during filtering is the one resolved from that alias at confirmation time. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search confirmed transactions * @param {TransactionRoutesApiSearchConfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ searchConfirmedTransactions(requestParameters?: TransactionRoutesApiSearchConfirmedTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of partial transactions matching the supplied filters. Use this endpoint for aggregate bonded transactions that still wait for required cosignatures. Use `searchUnconfirmedTransactions` for non-partial pending transactions, and use `searchConfirmedTransactions` once transactions are confirmed on-chain. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search partial transactions * @param {TransactionRoutesApiSearchPartialTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ searchPartialTransactions(requestParameters?: TransactionRoutesApiSearchPartialTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a paginated list of unconfirmed transactions matching the supplied filters. Use this endpoint for transactions accepted by a node but not yet included in a block. Use `searchConfirmedTransactions` for on-chain transactions, and use `searchPartialTransactions` for aggregate bonded transactions waiting for cosignatures. For cursor-style pagination on this endpoint, set `offset` to the `id` of the last transaction from the previous page. For general pagination strategy guidance, see the `offset` and `pageNumber` query parameter descriptions. * @summary Search unconfirmed transactions * @param {TransactionRoutesApiSearchUnconfirmedTransactionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionRoutesApi */ searchUnconfirmedTransactions(requestParameters?: TransactionRoutesApiSearchUnconfirmedTransactionsRequest, options?: RawAxiosRequestConfig): Promise>; } /** * TransactionStatusRoutesApi - axios parameter creator * @export */ export declare const TransactionStatusRoutesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the current status of the transaction identified by the given transaction hash. When checking status after announcing a transaction, it is best to query the same node that received the announce request. If that node rejects the transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction status * @param {string} hash Transaction hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionStatus: (hash: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the current statuses of the transactions identified by the given array of transaction hashes. When checking status after announcing transactions, it is best to query the same node that received the announce request. If that node rejects a transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction statuses * @param {TransactionHashes} transactionHashes Request body containing an array of transaction hashes to look up. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionStatuses: (transactionHashes: TransactionHashes, options?: RawAxiosRequestConfig) => Promise; }; /** * TransactionStatusRoutesApi - functional programming interface * @export */ export declare const TransactionStatusRoutesApiFp: (configuration?: Configuration) => { /** * Returns the current status of the transaction identified by the given transaction hash. When checking status after announcing a transaction, it is best to query the same node that received the announce request. If that node rejects the transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction status * @param {string} hash Transaction hash encoded as a 64-character hexadecimal string. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionStatus(hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current statuses of the transactions identified by the given array of transaction hashes. When checking status after announcing transactions, it is best to query the same node that received the announce request. If that node rejects a transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction statuses * @param {TransactionHashes} transactionHashes Request body containing an array of transaction hashes to look up. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionStatuses(transactionHashes: TransactionHashes, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * TransactionStatusRoutesApi - factory interface * @export */ export declare const TransactionStatusRoutesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the current status of the transaction identified by the given transaction hash. When checking status after announcing a transaction, it is best to query the same node that received the announce request. If that node rejects the transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction status * @param {TransactionStatusRoutesApiGetTransactionStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionStatus(requestParameters: TransactionStatusRoutesApiGetTransactionStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current statuses of the transactions identified by the given array of transaction hashes. When checking status after announcing transactions, it is best to query the same node that received the announce request. If that node rejects a transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction statuses * @param {TransactionStatusRoutesApiGetTransactionStatusesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionStatuses(requestParameters: TransactionStatusRoutesApiGetTransactionStatusesRequest, options?: RawAxiosRequestConfig): AxiosPromise>; }; /** * Request parameters for getTransactionStatus operation in TransactionStatusRoutesApi. * @export * @interface TransactionStatusRoutesApiGetTransactionStatusRequest */ export interface TransactionStatusRoutesApiGetTransactionStatusRequest { /** * Transaction hash encoded as a 64-character hexadecimal string. * @type {string} * @memberof TransactionStatusRoutesApiGetTransactionStatus */ readonly hash: string; } /** * Request parameters for getTransactionStatuses operation in TransactionStatusRoutesApi. * @export * @interface TransactionStatusRoutesApiGetTransactionStatusesRequest */ export interface TransactionStatusRoutesApiGetTransactionStatusesRequest { /** * Request body containing an array of transaction hashes to look up. * @type {TransactionHashes} * @memberof TransactionStatusRoutesApiGetTransactionStatuses */ readonly transactionHashes: TransactionHashes; } /** * TransactionStatusRoutesApi - object-oriented interface * @export * @class TransactionStatusRoutesApi * @extends {BaseAPI} */ export declare class TransactionStatusRoutesApi extends BaseAPI { /** * Returns the current status of the transaction identified by the given transaction hash. When checking status after announcing a transaction, it is best to query the same node that received the announce request. If that node rejects the transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction status * @param {TransactionStatusRoutesApiGetTransactionStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionStatusRoutesApi */ getTransactionStatus(requestParameters: TransactionStatusRoutesApiGetTransactionStatusRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the current statuses of the transactions identified by the given array of transaction hashes. When checking status after announcing transactions, it is best to query the same node that received the announce request. If that node rejects a transaction before propagation, only that node may know the detailed rejection reason. Other nodes may not know the transaction at all because it was never propagated. * @summary Get transaction statuses * @param {TransactionStatusRoutesApiGetTransactionStatusesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransactionStatusRoutesApi */ getTransactionStatuses(requestParameters: TransactionStatusRoutesApiGetTransactionStatusesRequest, options?: RawAxiosRequestConfig): Promise>; }