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 newRestrictionValue

newRestrictionValue: UInt64

Readonly previousRestrictionValue

previousRestrictionValue: UInt64

Readonly restrictionKey

restrictionKey: UInt64

Optional Readonly signature

signature: string

Optional Readonly signer

Readonly targetAddress

targetAddress: UnresolvedAddress

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

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

      The unresolved mosaic identifier.

    • restrictionKey: UInt64

      The restriction key.

    • targetAddress: UnresolvedAddress

      The affected unresolved address.

    • newRestrictionValue: UInt64

      The new restriction value.

    • networkType: NetworkType

      The network type.

    • previousRestrictionValue: UInt64 = ...

      (Optional) The previous restriction value.

    • maxFee: UInt64 = ...

      (Optional) Max fee defined by the sender

    • Optional signature: string

      (Optional) Transaction signature

    • Optional signer: PublicAccount

      (Optional) Signer public account

    Returns MosaicAddressRestrictionTransaction

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