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 unresolved mosaic identifier.

Readonly networkType

networkType: NetworkType

The network type.

Readonly newRestrictionType

newRestrictionType: MosaicRestrictionType

The new restriction type.

Readonly newRestrictionValue

newRestrictionValue: UInt64

The new restriction value.

Readonly previousRestrictionType

previousRestrictionType: MosaicRestrictionType

The previous restriction type.

Readonly previousRestrictionValue

previousRestrictionValue: UInt64

The previous restriction value.

Readonly referenceMosaicId

referenceMosaicId: MosaicId | NamespaceId

The mosaic id providing the restriction key.

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.

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

    The mosaic global restrictions are the network-wide rules that will determine whether an account will be able to transact a given mosaic.

    Only accounts tagged with the key identifiers and values that meet the conditions will be able to execute transactions involving the mosaic.

    Additionally, the mosaic creator can define restrictions that depend directly on global restrictions set on another mosaic - known as reference mosaic. The referenced mosaic and the restricted mosaic do not necessarily have to be created by the same account, enabling the delegation of mosaic permissions to a third party.

    Parameters

    • deadline: Deadline

      The deadline to include the transaction.

    • mosaicId: MosaicId | NamespaceId

      The mosaic id ex: new MosaicId([481110499, 231112638]).

    • restrictionKey: UInt64

      The restriction key.

    • previousRestrictionValue: UInt64

      The previous restriction value.

    • previousRestrictionType: MosaicRestrictionType

      The previous restriction type.

    • newRestrictionValue: UInt64

      The new restriction value.

    • newRestrictionType: MosaicRestrictionType

      The new restriction tpye.

    • networkType: NetworkType

      The network type.

    • Default value referenceMosaicId: MosaicId | NamespaceId = UnresolvedMapping.toUnresolvedMosaic(UInt64.fromUint(0).toHex())

      (Optional) The unresolved mosaic identifier providing the restriction key.

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

      (Optional) Max fee defined by the sender

    • Optional signature: undefined | string

      (Optional) Transaction signature

    • Optional signer: PublicAccount

      (Optional) Signer public account

    Returns MosaicGlobalRestrictionTransaction

Static createFromPayload

Static createTransactionHash

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

Generated using TypeDoc