SecretProofTransactionV1Descriptor

SecretProofTransactionV1Descriptor

Type safe descriptor used to generate a descriptor map for SecretProofTransactionV1Descriptor.

Conclude a token swap between different chains (V1, latest). Use a SecretProofTransaction to unlock the funds locked by a SecretLockTransaction. The transaction must prove knowing the proof that unlocks the mosaics.

Constructors

new SecretProofTransactionV1Descriptor()

new SecretProofTransactionV1Descriptor(
   recipientAddress, 
   secret, 
   hashAlgorithm, 
   proof?): SecretProofTransactionV1Descriptor

Creates a descriptor for SecretProofTransactionV1.

Parameters

Parameter	Type	Description
recipientAddress	Address	Address that receives the funds once unlocked.
secret	Hash256	Hashed proof.
hashAlgorithm	LockHashAlgorithm	Algorithm used to hash the proof.
proof?	string | Uint8Array<ArrayBufferLike>	Original random set of bytes that were hashed.

Returns

SecretProofTransactionV1Descriptor

Properties

Property	Type
rawDescriptor	object
rawDescriptor.hashAlgorithm	LockHashAlgorithm
rawDescriptor.recipientAddress	Address
rawDescriptor.secret	Hash256
rawDescriptor.type	string

Methods

toMap()

toMap(): object

SecretProofTransactionV1Descriptor.toMap

Builds a representation of this descriptor that can be passed to a factory function.

Returns

object

Descriptor that can be passed to a factory function.