Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transaction

An abstract transaction class that serves as the base class of all NEM transactions.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly deadline

deadline: Deadline

Readonly maxFee

maxFee: UInt64

Readonly networkType

networkType: NetworkType

Private Optional payloadSize

payloadSize: number

Transaction payload size

Optional Readonly signature

signature: string

Optional Readonly signer

signer: PublicAccount

Optional Readonly transactionInfo

transactionInfo: TransactionInfo | AggregateTransactionInfo

Readonly type

type: number

Readonly version

version: number

Static Readonly Body_Index

Body_Index: number = ...

Index of the transaction body

Included fields are the transaction header, version, network, type, maxFee and deadline

var

{number}

Static Readonly Header_Size

Header_Size: number = ...

Transaction header size

Included fields are size, verifiableEntityHeader_Reserved1, signature, signerPublicKey and entityBody_Reserved1.

var

{number}

Static Readonly Type_Index

Type_Index: number = ...

Index of the transaction type

Included fields are the transaction header, version and network

var

{number}

Accessors

size

  • get size(): number
  • override

    Transaction.size()

    description

    get the byte size of a transaction using the builder

    memberof

    TransferTransaction

    Returns number

Methods

aggregateTransaction

  • aggregateTransaction(): number[]

getSigningBytes

  • getSigningBytes(payloadBytes: number[], generationHashBytes: number[]): number[]

  • Generate signing bytes

    Parameters

    • payloadBytes: number[]

      Payload buffer

    • generationHashBytes: number[]

      GenerationHash buffer

    Returns number[]

hasMissingSignatures

  • hasMissingSignatures(): boolean

isConfirmed

  • isConfirmed(): boolean

isUnannounced

  • isUnannounced(): boolean

isUnconfirmed

  • isUnconfirmed(): boolean

reapplyGiven

serialize

  • serialize(): string

setMaxFee

toAggregate

  • Convert an aggregate transaction to an inner transaction including transaction signer. Signer is optional for AggregateComplete transaction ONLY. If no signer provided, aggregate transaction signer will be delegated on signing

    Parameters

    Returns InnerTransaction

    InnerTransaction

toJSON

  • toJSON(): any

Static createTransactionHash

  • createTransactionHash(transactionPayload: string, generationHashBuffer: number[]): string

Static preparePayload

  • preparePayload(serializedTransaction: Uint8Array, signature: Uint8Array, publicKey: string): string

  • Prepares and return signed payload

    Parameters

    • serializedTransaction: Uint8Array

      Serialized transaction

    • signature: Uint8Array

      Signature of the transaction

    • publicKey: string

      Public key of the signing account

    Returns string

    Payload (ready to be announced)

Static signRawTransaction

  • signRawTransaction(privateKey: string, rawTransactionSigningBytes: Uint8Array): Uint8Array

  • Signs raw transaction with the given private key

    Parameters

    • privateKey: string

      Private key of the signer account

    • rawTransactionSigningBytes: Uint8Array

      Raw transaction siging bytes

    Returns Uint8Array

    Signature byte array

Generated using TypeDoc