/** * 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 { TransactionTypeEnum } from './TransactionTypeEnum'; import type { AliasActionEnum } from './AliasActionEnum'; import type { CosignatureDTO } from './CosignatureDTO'; import type { AccountRestrictionFlagsEnum } from './AccountRestrictionFlagsEnum'; import type { LinkActionEnum } from './LinkActionEnum'; import type { MosaicSupplyChangeActionEnum } from './MosaicSupplyChangeActionEnum'; import type { UnresolvedMosaic } from './UnresolvedMosaic'; import type { NetworkTypeEnum } from './NetworkTypeEnum'; import type { EmbeddedTransactionInfoDTO } from './EmbeddedTransactionInfoDTO'; import type { MosaicRestrictionTypeEnum } from './MosaicRestrictionTypeEnum'; import type { LockHashAlgorithmEnum } from './LockHashAlgorithmEnum'; import type { NamespaceRegistrationTypeEnum } from './NamespaceRegistrationTypeEnum'; /** * 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; } /** * Check if a given object implements the TransactionInfoDTOTransaction interface. */ export declare function instanceOfTransactionInfoDTOTransaction(value: Record): value is TransactionInfoDTOTransaction; export declare function TransactionInfoDTOTransactionFromJSON(json: any): TransactionInfoDTOTransaction; export declare function TransactionInfoDTOTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionInfoDTOTransaction; export declare function TransactionInfoDTOTransactionToJSON(json: any): TransactionInfoDTOTransaction; export declare function TransactionInfoDTOTransactionToJSONTyped(value?: TransactionInfoDTOTransaction | null, ignoreDiscriminator?: boolean): any;