Class BalanceBeta

A Balance is a protected resource used to communicate the amounts of each currency held by the PFI on behalf of its customer.

Hierarchy (view full)

Constructors

constructor

Properties

data kind metadata

Accessors

createdAt from id protocol signature updatedAt

Methods

digest isBalance isOffering sign toJSON validate validateData verify verifySignature create generateId parse

Constructors

constructor

Properties

Readonly data

data: BalanceData

Balance's data such as currencies and available amounts

Readonly kind

kind: "balance" = 'balance'

The resource kind (balance)

Readonly metadata

metadata: BalanceMetadata

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

Accessors

createdAt

  • get createdAt(): string

  • Resource creation time. Expressed as ISO8601

    Returns string

from

  • get from(): string

  • The sender's DID

    Returns string

id

  • get id(): string

  • the resource's id

    Returns string

protocol

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

  • the protocol version

    Returns `${number}`

signature

  • get signature(): undefined | string

  • the resource's cryptographic signature

    Returns undefined | string

updatedAt

  • get updatedAt(): undefined | string

  • Resource last updated time. Expressed as ISO8601

    Returns undefined | 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.

isBalance

isOffering

sign

  • sign(did): Promise<void>

  • Signs the resource 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 resource including the presence of the signature using the official spec JSON Schemas

    Returns void

    Throws

    If the resource's structure does not match the JSON schemas

validateData

  • validateData(): void

  • Validates data section of resource only using the official TBDex JSON Schemas. This is useful for partially validating unsigned resources.

    Returns void

    Throws

    If the structure of the Resource's data does not match the JSON schemas

verify

  • verify(): Promise<string>

  • Validates the resource structure and verifies 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

    Throws

    if the resource 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(resourceKind): string

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

    Parameters

    Returns string

Static parse

  • parse(rawMessage): Promise<Balance>

  • Parses a json resource into an Balance

    Parameters

    Returns Promise<Balance>

    The parsed Balance

    Throws

    if the balance could not be parsed or is not a valid Balance

Settings

Member Visibility

Theme

On This Page

constructordatakindmetadatacreatedAtfromidprotocolsignatureupdatedAtdigestisBalanceisOfferingsigntoJSONvalidatevalidateDataverifyverifySignaturecreategenerateIdparse