Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Readonly deadline

deadline: Deadline

The deadline to include the transaction.

Readonly maxFee

maxFee: UInt64

A sender of a transaction must specify during the transaction definition a max_fee, meaning the maximum fee the account allows to spend for this transaction.

Readonly mosaicId

mosaicId: MosaicId | NamespaceId

The mosaic id.

Readonly networkType

networkType: NetworkType

The network type.

Readonly newRestrictionValue

newRestrictionValue: UInt64

The new restriction value.

Readonly previousRestrictionValue

previousRestrictionValue: UInt64

The previous restriction value.

Readonly restrictionKey

restrictionKey: UInt64

The restriction key.

Optional Readonly signature

signature: undefined | string

The transaction signature (missing if part of an aggregate transaction).

Optional Readonly signer

The account of the transaction creator.

Readonly targetAddress

targetAddress: Address | NamespaceId

The affected unresolved address.

Optional Readonly transactionInfo

Readonly type

type: number

The transaction type.

Readonly version

version: number

The transaction version number.

Static Readonly Body_Index

Body_Index: number = Transaction.Header_Size + 1 + 1 + 2 + 8 + 8

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 = 8 + 64 + 32 + 4

Transaction header size

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

var

{number}

Static Readonly Type_Index

Type_Index: number = Transaction.Header_Size + 2

Index of the transaction type

Included fields are the transaction header, version and network

var

{number}

Accessors

size

  • get size(): number

Methods

aggregateTransaction

  • aggregateTransaction(): number[]

getSigningBytes

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

hasMissingSignatures

  • hasMissingSignatures(): boolean

isConfirmed

  • isConfirmed(): boolean

isUnannounced

  • isUnannounced(): boolean

isUnconfirmed

  • isUnconfirmed(): boolean

reapplyGiven

serialize

  • serialize(): string

setMaxFee

toAggregate

toAggregateTransactionBytes

  • toAggregateTransactionBytes(): Uint8Array

toJSON

  • toJSON(): any

Static create

  • Create a mosaic address restriction transaction object

    Enabling accounts to transact with the token is similar to the process of adding elevated permissions to a user in a company computer network.

    The mosaic creator can modify the permissions of an account by sending a mosaic restriction transaction targeting the account address.

    **MosaicAddressRestrictionTransaction can only be announced in with Aggregate Transaction

    Parameters

    • deadline: Deadline

      The deadline to include the transaction.

    • mosaicId: MosaicId | NamespaceId

      The unresolved mosaic identifier.

    • restrictionKey: UInt64

      The restriction key.

    • targetAddress: Address | NamespaceId

      The affected unresolved address.

    • newRestrictionValue: UInt64

      The new restriction value.

    • networkType: NetworkType

      The network type.

    • Default value previousRestrictionValue: UInt64 = UInt64.fromHex('FFFFFFFFFFFFFFFF')

      (Optional) The previous restriction value.

    • Default value maxFee: UInt64 = new UInt64([0, 0])

      (Optional) Max fee defined by the sender

    Returns MosaicAddressRestrictionTransaction

Static createFromPayload

Static createTransactionHash

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

Generated using TypeDoc