Package org.symbol.sdk.symbol.descriptors

Class SecretProofTransactionV1Descriptor

java.lang.Object

org.symbol.sdk.symbol.descriptors.SecretProofTransactionV1Descriptor

All Implemented Interfaces:

SymbolTransactionDescriptor, SymbolTypedDescriptor, TypedDescriptor

---

public final class SecretProofTransactionV1Descriptor extends Object implements SymbolTransactionDescriptor

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.

• Constructor Summary

  Constructors

  Constructor

  Description

  SecretProofTransactionV1Descriptor(String recipientAddress, String secret, String hashAlgorithm)

  Creates a descriptor for SecretProofTransactionV1 from string-form values.

  SecretProofTransactionV1Descriptor(Address recipientAddress, CryptoTypes.Hash256 secret, LockHashAlgorithm hashAlgorithm)

  Creates a descriptor for SecretProofTransactionV1.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  SecretProofTransactionV1Descriptor

  proof(byte[] proof)

  Sets the proof field.

  SecretProofTransactionV1Descriptor

  proof(String proof)

  Sets the proof field.

  Map<String,Object>

  toMap()

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

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • SecretProofTransactionV1Descriptor

    public SecretProofTransactionV1Descriptor(Address recipientAddress, CryptoTypes.Hash256 secret, LockHashAlgorithm hashAlgorithm)

    Creates a descriptor for SecretProofTransactionV1.

    Parameters:

    recipientAddress - Address that receives the funds once unlocked.

    secret - Hashed proof.

    hashAlgorithm - Algorithm used to hash the proof.

  • SecretProofTransactionV1Descriptor

    public SecretProofTransactionV1Descriptor(String recipientAddress, String secret, String hashAlgorithm)

    Creates a descriptor for SecretProofTransactionV1 from string-form values.

    Parameters:

    recipientAddress - Address that receives the funds once unlocked.

    secret - Hashed proof.

    hashAlgorithm - Algorithm used to hash the proof.

• Method Details

  • proof

    public SecretProofTransactionV1Descriptor proof(byte[] proof)

    SecretProofTransactionV1Descriptor.proof

    Sets the proof field.

    Parameters:

    proof - Original random set of bytes that were hashed.

    Returns:

    This descriptor for chaining.

  • proof

    public SecretProofTransactionV1Descriptor proof(String proof)

    SecretProofTransactionV1Descriptor.proof

    Sets the proof field.

    Parameters:

    proof - Original random set of bytes that were hashed.

    Returns:

    This descriptor for chaining.

  • toMap

    public Map<String,Object> toMap()

    SecretProofTransactionV1Descriptor.toMap

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

    Specified by:

    toMap in interface TypedDescriptor

    Returns:

    Descriptor map that can be passed to a transaction factory.