Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Readonly deadline

deadline: Deadline

Readonly maxFee

maxFee: UInt64

Readonly mosaicId

Readonly networkType

networkType: NetworkType

Readonly newRestrictionType

newRestrictionType: MosaicRestrictionType

Readonly newRestrictionValue

newRestrictionValue: UInt64

Readonly previousRestrictionType

previousRestrictionType: MosaicRestrictionType

Readonly previousRestrictionValue

previousRestrictionValue: UInt64

Readonly referenceMosaicId

referenceMosaicId: UnresolvedMosaicId

Readonly restrictionKey

restrictionKey: UInt64

Optional Readonly signature

signature: string

Optional Readonly signer

Optional Readonly transactionInfo

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[]

hasMissingSignatures

  • hasMissingSignatures(): boolean

isConfirmed

  • isConfirmed(): boolean

isUnannounced

  • isUnannounced(): boolean

isUnconfirmed

  • isUnconfirmed(): boolean

reapplyGiven

serialize

  • serialize(): string

setMaxFee

toAggregate

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: UnresolvedMosaicId

      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.

    • referenceMosaicId: UnresolvedMosaicId = ...

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

    • maxFee: UInt64 = ...

      (Optional) Max fee defined by the sender

    • Optional signature: string

      (Optional) Transaction signature

    • Optional signer: PublicAccount

      (Optional) Signer public account

    Returns MosaicGlobalRestrictionTransaction

Static createFromPayload

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

Generated using TypeDoc