Class Rfq`Beta`

Message sent by Alice to PFI to request a quote (RFQ)

Hierarchy (view full)

Message
- Rfq

Constructors

constructor

new Rfq(metadata, data, signature?, privateData?): Rfq
Parameters
- metadata: RfqMetadata
- data: RfqData
- Optional signature: string
- Optional privateData: RfqPrivateData
Returns Rfq
Overrides Message.constructor

Properties

`Protected` _signature

_signature: undefined | string

signature that verifies that authenticity and integrity of a message

`Readonly` data

data: RfqData

Rfq's data containing information to initiate an exchange between Alice and a PFI

`Readonly` kind

kind: "rfq" = 'rfq'

The message kind (rfq)

`Readonly` metadata

metadata: RfqMetadata

Metadata such as sender, recipient, date created, and ID

`Readonly` privateData

privateData: undefined | RfqPrivateData

Rfq's unhashed private information to initiate an exchange between Alice and a PFI

`Readonly` validNext

validNext: Set<MessageKind> = ...

a set of valid Message kinds that can come after an rfq

Accessors

createdAt

get createdAt(): string
Message creation time. Expressed as ISO8601

Returns string
Inherited from Message.createdAt

exchangeId

get exchangeId(): string
ID for an "exchange" of messages between Alice - PFI. Uses the id of the RFQ that initiated the exchange

Returns string
Inherited from Message.exchangeId

externalId

get externalId(): undefined | string
the external ID

Returns undefined | string
Inherited from Message.externalId

from

get from(): string
The sender's DID

Returns string
Inherited from Message.from

id

get id(): string
the message id

Returns string
Inherited from Message.id

protocol

get protocol(): `${number}`
the protocol version

Returns `${number}`
Inherited from Message.protocol

signature

get signature(): undefined | string
the message's cryptographic signature

Returns undefined | string
Inherited from Message.signature

to

get to(): string
the recipient's DID

Returns string
Inherited from Message.to

Methods

digest

digest(): Uint8Array
Computes a digest of the payload by:
- JSON serializing the payload as per RFC-8785: JSON Canonicalization Scheme
- sha256 hashing the serialized payload
Returns Uint8Array
The SHA-256 hash of the canonicalized payload, represented as a byte array.

Inherited from Message.digest

isClose

isClose(): this is Close
Close type guard

Returns this is Close
Inherited from Message.isClose

isOrder

isOrder(): this is Order
Order type guard

Returns this is Order
Inherited from Message.isOrder

isOrderStatus

isOrderStatus(): this is OrderStatus
OrderStatus type guard

Returns this is OrderStatus
Inherited from Message.isOrderStatus

isQuote

isQuote(): this is Quote
Quote type guard

Returns this is Quote
Inherited from Message.isQuote

isRfq

isRfq(): this is Rfq
Rfq type guard

Returns this is Rfq
Inherited from Message.isRfq

sign

sign(did): Promise<void>
Signs the message as a jws with detached content and sets the signature property
Parameters
- did: BearerDid
  the signer's DID
Returns Promise<void>
Throws
If the signature could not be produced

Inherited from Message.sign

toJSON

toJSON(): MessageModel
Converts this rfq message to a json object

Returns MessageModel
Overrides Message.toJSON

validate

validate(): void
Valid structure of the message including the presence of the signature using the official spec JSON Schemas

Returns void
Throws
If the message's structure does not match the JSON schemas

Overrides Message.validate

validateData

validateData(): void
Validates data section of message only using the official TBDex JSON Schemas. This is useful for partially validating unsigned messages.

Returns void
Throws
If the structure of the messages's data does not match the JSON schemas

Inherited from Message.validateData

verify

verify(): Promise<string>
Validates the message structure and verifies the cryptographic signature

Returns Promise<string>
Signer's DID

Throws
if the message signature is invalid

Throws
if the message structure is invalid

Throws
see Crypto.verify

Inherited from Message.verify

`Private` verifyAllPrivateData

verifyAllPrivateData(): void
Verify the presence and integrity of all possible properties in Rfq.privateData.

Returns void
Throws
if there are properties missing in Rfq.privateData or which do not match the corresponding hashed property in Rfq.data

verifyClaims

verifyClaims(offering): Promise<void>
checks the claims provided in this rfq against an offering's requirements
Parameters
- offering: Offering
  the offering to check against
Returns Promise<void>
Throws
if rfq's claims do not fulfill the offering's requirements

`Private` verifyClaimsHash

verifyClaimsHash(): void
Returns void

verifyOfferingRequirements

verifyOfferingRequirements(offering): Promise<void>
evaluates this rfq against the provided offering
Parameters
- offering: Offering
  the offering to evaluate this rfq against
Returns Promise<void>
Throws
if Rfq.data.offeringId doesn't match the provided offering's id

See
RfqData#offeringId

Throws
if payinAmount in Rfq.data exceeds the provided offering's max units allowed or is below the offering's min units allowed

Throws
if payinMethod in Rfq.data property kind cannot be validated against the provided offering's payinMethod kinds

Throws
if payinMethod in Rfq.data property paymentDetails cannot be validated against the provided offering's payinMethod requiredPaymentDetails

Throws
if payoutMethod in Rfq.data property kind cannot be validated against the provided offering's payoutMethod kinds

Throws
if payoutMethod in Rfq.data property paymentDetails cannot be validated against the provided offering's payoutMethod requiredPaymentDetails

`Private` verifyPayinDetailsHash

verifyPayinDetailsHash(): void
Returns void

`Private` verifyPaymentMethod

verifyPaymentMethod(selectedPaymentKind, selectedPaymentDetailsHash, selectedPaymentDetails, allowedPaymentMethods, payDirection): void
Validate the Rfq's payin/payout method against an Offering's allow payin/payout methods
Parameters
- selectedPaymentKind: undefined | string
- selectedPaymentDetailsHash: undefined | string
- selectedPaymentDetails: undefined | Record<string, any>
- allowedPaymentMethods: PayinMethod[]
  The Offering's allowed payin/payout methods
- payDirection: "payin" | "payout"
  Either 'payin' or 'payout', used to provide more detailed error messages.
Returns void
Throws
if rfqPaymentMethod property kind cannot be validated against the provided offering's paymentMethod's kinds

Throws
if Rfq.privateData property paymentDetails is missing but is necessary to validate against the provided offering's paymentMethod's kinds

Throws
if rfqPaymentMethod property paymentDetails cannot be validated against the provided offering's paymentMethod's requiredPaymentDetails

`Private` verifyPayoutDetailsHash

verifyPayoutDetailsHash(): void
Returns void

`Private` verifyPresentPrivateData

verifyPresentPrivateData(): void
Verify the integrity properties that are present in Rfq.privateData.

Returns void
Throws
if there are properties present in Rfq.privateData which do not match the corresponding hashed property in Rfq.data

verifySignature

verifySignature(): Promise<string>
Verifies the integrity of the cryptographic signature

Returns Promise<string>
Resource signer's DID

Throws
if the resource signature is invalid

Throws
if the signer's DID does not match Resource.metadata.from

Inherited from Message.verifySignature

`Static` create

create(opts): Rfq
Creates an rfq with the given options
Parameters
- opts: CreateRfqOptions
  options to create an rfq
Returns Rfq
Rfq

`Private` `Static` digestPrivateData

digestPrivateData(salt, value): string
Given a salt and a value, compute a deterministic digest used in hashed fields in RfqData
Parameters
- salt: string
- value: any
Returns string
salted hash of the private data value

`Static` generateId

generateId(messageKind): string
Generates a unique id with the message kind's prefix
Parameters
- messageKind: MessageKind
Returns string
Inherited from Message.generateId

`Private` `Static` hashPrivateData

hashPrivateData(unhashedRfqData): {
data: RfqData;
privateData: RfqPrivateData;
}
Hash private RFQ data and set private fields in an RfqPrivateData object
Parameters
- unhashedRfqData: CreateRfqData
Returns {
data: RfqData;
privateData: RfqPrivateData;
}
An object with fields data and privateData.
- data: RfqData
- privateData: RfqPrivateData

`Static` parse

parse(rawMessage, opts?): Promise<Rfq>
Parses a json message into an Rfq
Parameters
- rawMessage: string | MessageModel
  the rfq to parse
- Optional opts: ParseRfqOptions
Returns Promise<Rfq>
The parsed Rfq

Throws
if the rfq could not be parsed or is not a valid Rfq

Class RfqBeta

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

metadata: RfqMetadata

data: RfqData

Optional signature: string

Optional privateData: RfqPrivateData

Returns Rfq

Properties

Protected _signature

Readonly data

Readonly kind

Readonly metadata

Readonly privateData

Readonly validNext

Accessors

createdAt

Returns string

exchangeId

Returns string

externalId

Returns undefined | string

from

Returns string

id

Returns string

protocol

Returns `${number}`

signature

Returns undefined | string

to

Returns string

Methods

digest

Returns Uint8Array

isClose

Returns this is Close

isOrder

Returns this is Order

isOrderStatus

Returns this is OrderStatus

isQuote

Returns this is Quote

isRfq

Returns this is Rfq

sign

Parameters

did: BearerDid

Returns Promise<void>

Throws

toJSON

Returns MessageModel

validate

Returns void

Throws

validateData

Returns void

Throws

verify

Returns Promise<string>

Throws

Throws

Throws

Private verifyAllPrivateData

Returns void

Throws

verifyClaims

Parameters

offering: Offering

Returns Promise<void>

Throws

Private verifyClaimsHash

Returns void

Class Rfq`Beta`

`Optional` signature: string

`Optional` privateData: RfqPrivateData

`Protected` _signature

`Readonly` data

`Readonly` kind

`Readonly` metadata

`Readonly` privateData

`Readonly` validNext

`Private` verifyAllPrivateData

`Private` verifyClaimsHash

`Private` verifyPayinDetailsHash

`Private` verifyPaymentMethod

`Private` verifyPayoutDetailsHash

`Private` verifyPresentPrivateData

`Static` create

`Private` `Static` digestPrivateData

`Static` generateId

`Private` `Static` hashPrivateData

Returns {
data: RfqData;
privateData: RfqPrivateData;
}

`Static` parse

`Optional` opts: ParseRfqOptions