MosaicGlobalRestrictionTransaction

Hierarchy

Transaction
- MosaicGlobalRestrictionTransaction

Index

Constructors

constructor

Properties

Accessors

size

Methods

Constructors

constructor

new MosaicGlobalRestrictionTransaction(networkType: NetworkType, version: number, deadline: Deadline, maxFee: UInt64, mosaicId: UnresolvedMosaicId, referenceMosaicId: UnresolvedMosaicId, restrictionKey: UInt64, previousRestrictionValue: UInt64, previousRestrictionType: MosaicRestrictionType, newRestrictionValue: UInt64, newRestrictionType: MosaicRestrictionType, signature?: undefined | string, signer?: PublicAccount, transactionInfo?: TransactionInfo): MosaicGlobalRestrictionTransaction

Overrides Transaction.constructor
- Defined in model/transaction/MosaicGlobalRestrictionTransaction.ts:101
Parameters
- networkType: NetworkType
  
  The network type
- version: number
  
  The transaction version
- deadline: Deadline
  
  The deadline to include the transaction.
- maxFee: UInt64
  
  (Optional) Max fee defined by the sender
- mosaicId: UnresolvedMosaicId
  
  The unresolved mosaic identifier.
- referenceMosaicId: UnresolvedMosaicId
  
  The mosaic id providing the restriction key.
- restrictionKey: UInt64
  
  The restriction key.
- previousRestrictionValue: UInt64
  
  The previous restriction value.
- previousRestrictionType: MosaicRestrictionType
  
  The previous restriction tpye.
- newRestrictionValue: UInt64
  
  The new restriction value.
- newRestrictionType: MosaicRestrictionType
- Optional signature: undefined | string
  
  The transaction signature
- Optional signer: PublicAccount
  
  The signer
- Optional transactionInfo: TransactionInfo
  
  The transaction info
Returns MosaicGlobalRestrictionTransaction

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

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

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

signer: PublicAccount

The account of the transaction creator.

Optional Readonly transactionInfo

transactionInfo: TransactionInfo | AggregateTransactionInfo

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

Inherited from Transaction.size
- Defined in model/transaction/Transaction.ts:362
override

Transaction.size()

description

get the byte size of a transaction using the builder

memberof

TransferTransaction

Returns number

Methods

aggregateTransaction

aggregateTransaction(): number[]

Inherited from Transaction.aggregateTransaction
- Defined in model/transaction/Transaction.ts:255
Converts the transaction into AggregateTransaction compatible

Returns number[]

AggregateTransaction bytes

getSigningBytes

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

Inherited from Transaction.getSigningBytes
- Defined in model/transaction/Transaction.ts:242
Generate signing bytes

Parameters
- payloadBytes: number[]
  
  Payload buffer
- generationHashBytes: number[]
  
  GenerationHash buffer
Returns number[]

hasMissingSignatures

hasMissingSignatures(): boolean

Inherited from Transaction.hasMissingSignatures
- Defined in model/transaction/Transaction.ts:311
Returns if a transaction has missing signatures.

Returns boolean

isConfirmed

isConfirmed(): boolean

Inherited from Transaction.isConfirmed
- Defined in model/transaction/Transaction.ts:303
Transaction included in a block

Returns boolean

isUnannounced

isUnannounced(): boolean

Inherited from Transaction.isUnannounced
- Defined in model/transaction/Transaction.ts:325
Transaction is not known by the network

Returns boolean

isUnconfirmed

isUnconfirmed(): boolean

Inherited from Transaction.isUnconfirmed
- Defined in model/transaction/Transaction.ts:289
Transaction pending to be included in a block

Returns boolean

reapplyGiven

reapplyGiven(deadline: Deadline): Transaction

Inherited from Transaction.reapplyGiven
- Defined in model/transaction/Transaction.ts:349
description

reapply a given value to the transaction in an immutable way

memberof

Transaction

Parameters
- deadline: Deadline
Returns Transaction

serialize

serialize(): string

Inherited from Transaction.serialize
- Defined in model/transaction/Transaction.ts:395
description

Serialize a transaction object

memberof

Transaction

Returns string

setMaxFee

setMaxFee(feeMultiplier: number): Transaction

Inherited from Transaction.setMaxFee
- Defined in model/transaction/Transaction.ts:198
Set transaction maxFee using fee multiplier for ONLY NONE AGGREGATE TRANSACTIONS

Parameters
- feeMultiplier: number
  
  The fee multiplier
Returns Transaction

toAggregate

toAggregate(signer: PublicAccount): InnerTransaction

Inherited from Transaction.toAggregate
- Defined in model/transaction/Transaction.ts:278
Convert an aggregate transaction to an inner transaction including transaction signer. Signer is optional for AggregateComplete transaction ONLY. If no signer provided, aggregate transaction signer will be delegated on signing

Parameters
- signer: PublicAccount
  
  Innre transaction signer.
Returns InnerTransaction

InnerTransaction

toJSON

toJSON(): any

Inherited from Transaction.toJSON
- Defined in model/transaction/Transaction.ts:404
description

Create JSON object

memberof

Transaction

Returns any

Static create

create(deadline: Deadline, mosaicId: UnresolvedMosaicId, restrictionKey: UInt64, previousRestrictionValue: UInt64, previousRestrictionType: MosaicRestrictionType, newRestrictionValue: UInt64, newRestrictionType: MosaicRestrictionType, networkType: NetworkType, referenceMosaicId?: UnresolvedMosaicId, maxFee?: UInt64, signature?: undefined | string, signer?: PublicAccount): MosaicGlobalRestrictionTransaction

- Defined in model/transaction/MosaicGlobalRestrictionTransaction.ts:72
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.
- Default value referenceMosaicId: UnresolvedMosaicId = 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

createFromPayload(payload: string, isEmbedded?: boolean): Transaction | InnerTransaction

- Defined in model/transaction/MosaicGlobalRestrictionTransaction.ts:165
Create a transaction object from payload

Parameters
- payload: string
  
  Binary payload
- Default value isEmbedded: boolean = false
  
  Is embedded transaction (Default: false)
Returns Transaction | InnerTransaction

Static createTransactionHash

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

Inherited from Transaction.createTransactionHash
- Defined in model/transaction/Transaction.ts:130
Generate transaction hash hex

see

https://github.com/nemtech/catapult-server/blob/main/src/catapult/model/EntityHasher.cpp#L32

see

https://github.com/nemtech/catapult-server/blob/main/src/catapult/model/EntityHasher.cpp#L35

see

https://github.com/nemtech/catapult-server/blob/main/sdk/src/extensions/TransactionExtensions.cpp#L46

Parameters
- transactionPayload: string
  
  HexString Payload
- generationHashBuffer: number[]
  
  Network generation hash byte
Returns string

Returns Transaction Payload hash

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

networkType: NetworkType

version: number

deadline: Deadline

maxFee: UInt64

mosaicId: UnresolvedMosaicId

referenceMosaicId: UnresolvedMosaicId

restrictionKey: UInt64

previousRestrictionValue: UInt64

previousRestrictionType: MosaicRestrictionType

newRestrictionValue: UInt64

newRestrictionType: MosaicRestrictionType

Optional signature: undefined | string

Optional signer: PublicAccount

Optional transactionInfo: TransactionInfo

Returns MosaicGlobalRestrictionTransaction

Properties

Readonly deadline

Readonly maxFee

Readonly mosaicId

Readonly networkType

Readonly newRestrictionType

Readonly newRestrictionValue

Readonly previousRestrictionType

Readonly previousRestrictionValue

Readonly referenceMosaicId

Readonly restrictionKey

Optional Readonly signature

Optional Readonly signer

Optional Readonly transactionInfo

Readonly type

Readonly version

Static Readonly Body_Index

Static Readonly Header_Size

Static Readonly Type_Index

Accessors

size

Returns number

Methods

aggregateTransaction

Returns number[]

getSigningBytes

Parameters

payloadBytes: number[]

generationHashBytes: number[]

Returns number[]

hasMissingSignatures

Returns boolean

isConfirmed

Returns boolean

isUnannounced

Returns boolean

isUnconfirmed

Returns boolean

reapplyGiven

Parameters

deadline: Deadline

Returns Transaction

serialize

Returns string

setMaxFee

Parameters

feeMultiplier: number

Returns Transaction

toAggregate

Parameters

signer: PublicAccount

Returns InnerTransaction

toJSON

Returns any

Static create

Parameters