Class TbdexHttpClientBeta

HTTP client for interacting with TBDex PFIs

Constructors

constructor

Properties

sendMessage

Methods

createExchange generateRequestToken getBalances getExchange getExchanges getOfferings getPfiServiceEndpoint submitClose submitOrder verifyRequestToken

Constructors

constructor

Properties

Private Static sendMessage

sendMessage: any

Methods

Static createExchange

  • createExchange(rfq, opts?): Promise<void>

  • Sends an RFQ and options to the PFI to initiate an exchange

    Parameters

    • rfq: Rfq

      The RFQ message that will be sent to the PFI

    • Optional opts: {
          replyTo?: string;
      }
      • Optional replyTo?: string

        A callback URL where the PFI will send subsequent messages

    Returns Promise<void>

    Throws

    if message verification fails

    Throws

    if recipient DID resolution fails

    Throws

    if recipient DID does not have a PFI service entry

Static generateRequestToken

  • generateRequestToken(params): Promise<string>

  • Creates and signs a request token (JWT) that's included as the value of Authorization header for requests sent to a PFI API's endpoints that require authentication

    JWT payload with the following claims:

    • aud
    • iss
    • exp
    • iat
    • jti The JWT is then signed and returned.

    Parameters

    Returns Promise<string>

    the request token (JWT)

    Throws

    RequestTokenSigningError If an error occurs during the token generation.

Static getBalances

Static getExchange

Static getExchanges

Static getOfferings

Static getPfiServiceEndpoint

  • getPfiServiceEndpoint(did): Promise<DidServiceEndpoint | DidServiceEndpoint[]>

  • returns the PFI service entry from the DID Doc of the DID provided

    Parameters

    • did: string

      the pfi's DID

    Returns Promise<DidServiceEndpoint | DidServiceEndpoint[]>

Static submitClose

  • submitClose(close): Promise<void>

  • Sends the Close message to the PFI

    Parameters

    Returns Promise<void>

    Throws

    if message verification fails

    Throws

    if recipient DID resolution fails

    Throws

    if recipient DID does not have a PFI service entry

Static submitOrder

  • submitOrder(order): Promise<void>

  • Sends the Order message to the PFI

    Parameters

    Returns Promise<void>

    Throws

    if message verification fails

    Throws

    if recipient DID resolution fails

    Throws

    if recipient DID does not have a PFI service entry

Static verifyRequestToken

Settings

Member Visibility

Theme

On This Page

constructorsendMessagecreateExchangegenerateRequestTokengetBalancesgetExchangegetExchangesgetOfferingsgetPfiServiceEndpointsubmitClosesubmitOrderverifyRequestToken