Class MessageAbstract Beta

Readonly data

Abstract kind

Readonly metadata

Abstract validNext

createdAt

• get createdAt(): string

• Message creation time. Expressed as ISO8601

  Returns string

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

externalId

• get externalId(): undefined | string

• the external ID

  Returns undefined | string

from

• get from(): string

• The sender's DID

  Returns string

id

• get id(): string

• the message id

  Returns string

protocol

• get protocol(): `${number}`

• the protocol version

  Returns `${number}`

signature

• get signature(): undefined | string

• the message's cryptographic signature

  Returns undefined | string

to

• get to(): string

• the recipient's DID

  Returns string

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.

isCancel

• isCancel(): this is Cancel

• Cancel type guard

  Returns this is Cancel

isClose

• isClose(): this is Close

• Close type guard

  Returns this is Close

isOrder

• isOrder(): this is Order

• Order type guard

  Returns this is Order

isOrderInstructions

• isOrderInstructions(): this is OrderInstructions

• OrderInstructions type guard

  Returns this is OrderInstructions

isOrderStatus

• isOrderStatus(): this is OrderStatus

• OrderStatus type guard

  Returns this is OrderStatus

isQuote

• isQuote(): this is Quote

• Quote type guard

  Returns this is Quote

isRfq

• isRfq(): this is Rfq

• Rfq type guard

  Returns this is Rfq

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

toJSON

• toJSON(): MessageModel

• returns the message as a json object. Automatically used by JSON.stringify method.

  Returns MessageModel

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

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

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

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

Static generateId

• generateId(messageKind): string

• Generates a unique id with the message kind's prefix

  Parameters

  • messageKind: MessageKind

  Returns string