MosaicAddressRestrictionTransaction

Hierarchy

Transaction
- MosaicAddressRestrictionTransaction

Constructors

constructor

new MosaicAddressRestrictionTransaction(networkType: NetworkType, version: number, deadline: Deadline, maxFee: UInt64, mosaicId: UnresolvedMosaicId, restrictionKey: UInt64, targetAddress: UnresolvedAddress, previousRestrictionValue: UInt64, newRestrictionValue: UInt64, signature?: string, signer?: PublicAccount, transactionInfo?: TransactionInfo): MosaicAddressRestrictionTransaction

Overrides Transaction.constructor
- Defined in model/transaction/MosaicAddressRestrictionTransaction.ts:111
Parameters
- networkType: NetworkType
- version: number
- deadline: Deadline
- maxFee: UInt64
- mosaicId: UnresolvedMosaicId
- restrictionKey: UInt64
- targetAddress: UnresolvedAddress
- previousRestrictionValue: UInt64
- newRestrictionValue: UInt64
- Optional signature: string
- Optional signer: PublicAccount
- Optional transactionInfo: TransactionInfo
Returns MosaicAddressRestrictionTransaction

Properties

Readonly deadline

deadline: Deadline

Readonly maxFee

maxFee: UInt64

Readonly mosaicId

mosaicId: UnresolvedMosaicId

Readonly networkType

networkType: NetworkType

Readonly newRestrictionValue

newRestrictionValue: UInt64

Readonly previousRestrictionValue

previousRestrictionValue: UInt64

Readonly restrictionKey

restrictionKey: UInt64

Optional Readonly signature

signature?: string

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

Inherited from Transaction.size
- Defined in model/transaction/Transaction.ts:388
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:281
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:268
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:337
Returns if a transaction has missing signatures.

Returns boolean

isConfirmed

isConfirmed(): boolean

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

Returns boolean

isUnannounced

isUnannounced(): boolean

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

Returns boolean

isUnconfirmed

isUnconfirmed(): boolean

Inherited from Transaction.isUnconfirmed
- Defined in model/transaction/Transaction.ts:315
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:375
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:421
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:304
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:430
description
Create JSON object

memberof
Transaction

Returns any

Static create

create(deadline: Deadline, mosaicId: UnresolvedMosaicId, restrictionKey: UInt64, targetAddress: UnresolvedAddress, newRestrictionValue: UInt64, networkType: NetworkType, previousRestrictionValue?: UInt64, maxFee?: UInt64, signature?: string, signer?: PublicAccount): MosaicAddressRestrictionTransaction

- Defined in model/transaction/MosaicAddressRestrictionTransaction.ts:69
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

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

- Defined in model/transaction/MosaicAddressRestrictionTransaction.ts:149
Create a transaction object from payload

Parameters
- payload: string
  
  Binary payload
- 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

Static preparePayload

preparePayload(serializedTransaction: Uint8Array, signature: Uint8Array, publicKey: string): string

Inherited from Transaction.preparePayload
- Defined in model/transaction/Transaction.ts:250
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

Inherited from Transaction.signRawTransaction
- Defined in model/transaction/Transaction.ts:238
Signs raw transaction with the given private key

Parameters
- privateKey: string
  
  Private key of the signer account
- rawTransactionSigningBytes: Uint8Array
  
  Raw transaction siging bytes
Returns Uint8Array
Signature byte array

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

networkType: NetworkType

version: number

deadline: Deadline

maxFee: UInt64

mosaicId: UnresolvedMosaicId

restrictionKey: UInt64

targetAddress: UnresolvedAddress

previousRestrictionValue: UInt64

newRestrictionValue: UInt64

Optional signature: string

Optional signer: PublicAccount

Optional transactionInfo: TransactionInfo

Returns MosaicAddressRestrictionTransaction

Properties

Readonly deadline

Readonly maxFee

Readonly mosaicId

Readonly networkType

Readonly newRestrictionValue

Readonly previousRestrictionValue

Readonly restrictionKey

Optional Readonly signature

Optional Readonly signer

Readonly targetAddress

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

deadline: Deadline

mosaicId: UnresolvedMosaicId

restrictionKey: UInt64

targetAddress: UnresolvedAddress