Options
All
  • Public
  • Public/Protected
  • All
Menu

Announce an namespace metadata transaction to associate a key-value state to an account.

Hierarchy

Index

Constructors

constructor

Properties

deadline

deadline: Deadline

The deadline to include the transaction.

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.

networkType

networkType: NetworkType

The network type.

scopedMetadataKey

scopedMetadataKey: UInt64

Metadata key scoped to source, target and type.

Optional signature

signature: undefined | string

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

Optional signer

The account of the transaction creator.

targetNamespaceId

targetNamespaceId: NamespaceId

Target namespace identifier.

targetPublicKey

targetPublicKey: string

Public key of the target account.

Optional transactionInfo

type

type: number

The transaction type.

value

value: string

String value with UTF-8 encoding. Difference between the previous value and new value.

valueSizeDelta

valueSizeDelta: number

Change in value size in bytes.

version

version: number

The transaction version number.

Static 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 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 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 meta data transaction object

    Parameters

    • deadline: Deadline

      transaction deadline

    • targetPublicKey: string

      Public key of the target account.

    • scopedMetadataKey: UInt64

      Metadata key scoped to source, target and type.

    • targetNamespaceId: NamespaceId

      Target namespace identifier.

    • valueSizeDelta: number

      Change in value size in bytes.

    • value: string

      String value with UTF-8 encoding Difference between the previous value and new value. You can calculate value as xor(previous-value, new-value). If there is no previous value, use directly the new value.

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

      (Optional) Max fee defined by the sender

    Returns NamespaceMetadataTransaction

Static createFromPayload

Static createTransactionHash

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

Generated using TypeDoc