Class TransactionFactory

Factory for creating NEM transactions.

Index

Constructors

Accessors

ruleNames static

Methods

create attachSignature deserialize lookupTransactionName toNonVerifiableTransaction

Constructors

constructor

new TransactionFactory(network, typeRuleOverrides?): TransactionFactory
Creates a factory for the specified network.
Parameters
- network: Network
  NEM network.
- Optional typeRuleOverrides: Map<string, Function>
  Type rule overrides.
Returns TransactionFactory
- Defined in nem/TransactionFactory.d.ts:50

Accessors

ruleNames

get ruleNames(): string[]
Gets rule names with registered hints.

Returns string[]
Rule names with registered hints.
- Defined in nem/TransactionFactory.d.ts:68

static

get static(): typeof TransactionFactory
Gets class type.

Returns typeof TransactionFactory
Class type.
- Defined in nem/TransactionFactory.d.ts:63

Methods

create

create(transactionDescriptor, autosort?): models.Transaction
Creates a transaction from a transaction descriptor.
Parameters
- transactionDescriptor: object
  Transaction descriptor.
- Optional autosort: boolean
  When set (default), descriptor arrays requiring ordering will be automatically sorted. When unset, descriptor arrays will be presumed to be already sorted.
Returns models.Transaction
Newly created transaction.
- Defined in nem/TransactionFactory.d.ts:76

`Static` attachSignature

attachSignature(transaction, signature): string
Attaches a signature to a transaction.
Parameters
- transaction: models.Transaction
  Transaction object.
- signature: Signature
  Signature to attach.
Returns string
JSON transaction payload.
- Defined in nem/TransactionFactory.d.ts:30

`Static` deserialize

deserialize(payload): models.Transaction
Deserializes a transaction from a binary payload.
Parameters
- payload: Uint8Array
  Binary payload.
Returns models.Transaction
Deserialized transaction.
- Defined in nem/TransactionFactory.d.ts:17

`Static` lookupTransactionName

lookupTransactionName(transactionType, transactionVersion): string
Looks up the friendly name for the specified transaction.
Parameters
- transactionType: models.TransactionType
  Transaction type.
- transactionVersion: number
  Transaction version.
Returns string
Transaction friendly name.
- Defined in nem/TransactionFactory.d.ts:11

`Static` toNonVerifiableTransaction

toNonVerifiableTransaction(transaction): NonVerifiableTransaction
Converts a transaction to a non-verifiable transaction.
Parameters
- transaction: models.Transaction | NonVerifiableTransaction
  Transaction object.
Returns NonVerifiableTransaction
Non-verifiable transaction object.
- Defined in nem/TransactionFactory.d.ts:23