Class OrderInstructionsBeta

Sent by the PFI to Alice to convey payment instructions.

Hierarchy (view full)

Constructors

constructor

Properties

_signature data kind metadata validNext

Accessors

createdAt exchangeId externalId from id protocol signature to

Methods

digest isCancel isClose isOrder isOrderInstructions isOrderStatus isQuote isRfq sign toJSON validate validateData verify verifySignature create generateId parse

Constructors

constructor

Properties

Protected _signature

_signature: undefined | string

signature that verifies that authenticity and integrity of a message

Readonly data

data: OrderInstructionsData

OrderInstructions' specific data containing payin and payout instructions

Readonly kind

kind: "orderinstructions" = 'orderinstructions'

The message kind orderinstructions.

Readonly metadata

metadata: OrderInstructionsMetadata

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

Readonly validNext

validNext: Set<MessageKind> = ...

A set of valid Message kinds that can come after an Order Instructions

Accessors

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

Methods

digest

  • digest(): Uint8Array

  • Computes a digest of the payload by:

    Returns Uint8Array

    The SHA-256 hash of the canonicalized payload, represented as a byte array.

isCancel

isClose

isOrder

isOrderInstructions

isOrderStatus

isQuote

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

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

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 create

Static generateId

  • generateId(messageKind): string

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

    Parameters

    Returns string

Static parse

  • parse(rawMessage): Promise<OrderInstructions>

  • Parses a JSON message into an OrderInstructions.

    Parameters

    • rawMessage: string | MessageModel

      The OrderInstructions to parse.

    Returns Promise<OrderInstructions>

    The parsed OrderInstructions.

    Throws

    Error if the OrderInstructions could not be parsed or is not a valid OrderInstructions.

Settings

Member Visibility

Theme

On This Page

constructor_signaturedatakindmetadatavalidNextcreatedAtexchangeIdexternalIdfromidprotocolsignaturetodigestisCancelisCloseisOrderisOrderInstructionsisOrderStatusisQuoteisRfqsigntoJSONvalidatevalidateDataverifyverifySignaturecreategenerateIdparse