SecretLockTransaction

Hierarchy

Transaction
- SecretLockTransaction

Index

Constructors

constructor

Properties

Accessors

size

Methods

Constructors

constructor

new SecretLockTransaction(networkType: NetworkType, version: number, deadline: Deadline, maxFee: UInt64, mosaic: Mosaic, duration: UInt64, hashAlgorithm: LockHashAlgorithm, secret: string, recipientAddress: UnresolvedAddress, signature?: undefined | string, signer?: PublicAccount, transactionInfo?: TransactionInfo): SecretLockTransaction

Overrides Transaction.constructor
- Defined in model/transaction/SecretLockTransaction.ts:87
Parameters
- networkType: NetworkType
- version: number
- deadline: Deadline
- maxFee: UInt64
- mosaic: Mosaic
- duration: UInt64
- hashAlgorithm: LockHashAlgorithm
- secret: string
- recipientAddress: UnresolvedAddress
- Optional signature: undefined | string
- Optional signer: PublicAccount
- Optional transactionInfo: TransactionInfo
Returns SecretLockTransaction

Properties

Readonly deadline

deadline: Deadline

The deadline to include the transaction.

Readonly duration

duration: UInt64

The duration for the funds to be released or returned.

Readonly hashAlgorithm

hashAlgorithm: LockHashAlgorithm

The hash algorithm, secret is generated with.

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 mosaic

mosaic: Mosaic

The locked mosaic.

Readonly networkType

networkType: NetworkType

The network type.

Readonly recipientAddress

recipientAddress: UnresolvedAddress

The unresolved recipientAddress of the funds.

Readonly secret

secret: string

The proof hashed.

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

getSecretByte

getSecretByte(): Uint8Array

- Defined in model/transaction/SecretLockTransaction.ts:174
description

Get secret bytes

memberof

SecretLockTransaction

Returns Uint8Array

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, mosaic: Mosaic, duration: UInt64, hashAlgorithm: LockHashAlgorithm, secret: string, recipientAddress: UnresolvedAddress, networkType: NetworkType, maxFee?: UInt64, signature?: undefined | string, signer?: PublicAccount): SecretLockTransaction

- Defined in model/transaction/SecretLockTransaction.ts:62
Create a secret lock transaction object.

Parameters
- deadline: Deadline
  
  The deadline to include the transaction.
- mosaic: Mosaic
  
  The locked mosaic.
- duration: UInt64
  
  The funds lock duration.
- hashAlgorithm: LockHashAlgorithm
  
  The hash algorithm secret is generated with.
- secret: string
  
  The proof hashed.
- recipientAddress: UnresolvedAddress
  
  The unresolved recipient address of the funds.
- networkType: NetworkType
  
  The network type.
- 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 SecretLockTransaction

a SecretLockTransaction instance

Static createFromPayload

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

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

mosaic: Mosaic

duration: UInt64

hashAlgorithm: LockHashAlgorithm

secret: string

recipientAddress: UnresolvedAddress

Optional signature: undefined | string

Optional signer: PublicAccount

Optional transactionInfo: TransactionInfo

Returns SecretLockTransaction

Properties

Readonly deadline

Readonly duration

Readonly hashAlgorithm

Readonly maxFee

Readonly mosaic

Readonly networkType

Readonly recipientAddress

Readonly secret

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

getSecretByte

Returns Uint8Array

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

mosaic: Mosaic