Package tbdex.sdk.messages

Class Rfq

  • All Implemented Interfaces:
    tbdex.sdk.messages.Message 
    
public final class Rfq
 implements Message

    Represents a Request for Quote (RFQ) message in the tbDEX protocol.

    An RFQ is used by Alice to request a quote from a PFI, specifying the payin, payout, and other requirements.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Rfq.Companion

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final MessageMetadata getMetadata() Metadata about the message, including sender, recipient, and protocol information.
      final RfqData getData() The public data part of the RFQ, such as payin, payout, and offering details.
      final RfqPrivateData getPrivateData() Optional private data, which may include sensitive information.
      final String getSignature() The signature verifying the authenticity and integrity of the RFQ message.
      final String toJsonString() Serializes the RFQ to a JSON string.
      final Unit verifyOfferingRequirements(Offering offering) Verifies that the RFQ meets the requirements specified by an Offering.
      final Unit verifyAllPrivateData() Verifies all private data within the RFQ.
      final Unit verifyPresentPrivateData() Verifies that all present private data fields in the RFQ match their corresponding hashes.
      final Unit sign(BearerDid bearerDid) Signs the RFQ using the provided Bearer DID.
      final Unit verify() Verifies the RFQ's signature and validity.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getMetadata

         final MessageMetadata getMetadata()

        Metadata about the message, including sender, recipient, and protocol information.

      • getData

         final RfqData getData()

        The public data part of the RFQ, such as payin, payout, and offering details.

      • getSignature

         final String getSignature()

        The signature verifying the authenticity and integrity of the RFQ message.

      • toJsonString

         final String toJsonString()

        Serializes the RFQ to a JSON string.

        Returns:

        The serialized JSON string of the RFQ.

      • verifyOfferingRequirements

         final Unit verifyOfferingRequirements(Offering offering)

        Verifies that the RFQ meets the requirements specified by an Offering.

        Parameters:
        offering - The offering against which the RFQ is being verified.

      • verifyPresentPrivateData

         final Unit verifyPresentPrivateData()

        Verifies that all present private data fields in the RFQ match their corresponding hashes.

      • sign

         final Unit sign(BearerDid bearerDid)

        Signs the RFQ using the provided Bearer DID.

        Parameters:
        bearerDid - The Bearer DID used to sign the RFQ.

      • verify

         final Unit verify()

        Verifies the RFQ's signature and validity.