Class Offering

  • All Implemented Interfaces:

    
    public final class Offering
    
                        

    Represents an Offering resource in the tbDEX protocol.

    An Offering is created by a PFI to define the exchange parameters, such as payin/payout details, exchange rates, required credentials, and cancellation policies.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class Offering.Companion
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final ResourceMetadata getMetadata() Metadata about the resource, including sender and resource type.
      final OfferingData getData() The details of the offering, including payin/payout methods, required claims, and cancellation.
      final String getSignature() The signature verifying the authenticity and integrity of the Offering resource.
      final String toJsonString() Serializes the Offering resource to a JSON string.
      final Unit sign(BearerDid bearerDid) Signs the Offering resource using the provided Bearer DID.
      final Unit verify() Verifies the Offering resource'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

      • getData

         final OfferingData getData()

        The details of the offering, including payin/payout methods, required claims, and cancellation.

      • getSignature

         final String getSignature()

        The signature verifying the authenticity and integrity of the Offering resource.

      • toJsonString

         final String toJsonString()

        Serializes the Offering resource to a JSON string.

        Returns:

        The serialized JSON string of the Offering resource.

      • sign

         final Unit sign(BearerDid bearerDid)

        Signs the Offering resource using the provided Bearer DID.

        Parameters:
        bearerDid - The Bearer DID used to sign the Offering resource.
      • verify

         final Unit verify()

        Verifies the Offering resource's signature and validity.