@wellknown-id/wallet/view

#Variables

#MAX_SECRET_BYTES

const MAX_SECRET_BYTES: number;

The largest secret a wallet keeps (40 KB), the same on every device, so any secret travels in one message.

#Functions

#bondingNotice()

function bondingNotice(
   mine, 
   theirs, 
   iShowed
): BondingNotice;

What bonding two devices' personas will do, from the lines each sent (prd.md §4.10, "Before the holder confirms"), as planMerge will do it once the seeds travel: personas on one side only are that side's; a side whose own personas have all gone unused folds them, when the other's have been used, or, neither used, when the other side's were made first; where both have, nothing folds and the holder is told. The default is that of the device that showed the code (iShowed), unless it folds.

#Parameters

#Returns

BondingNotice

#exportConsentRecords()

function exportConsentRecords(
   records, 
   subject, 
   exportedAt?
): object;

The records as a JSON-LD document: subject is who they're about (the holder's did:key, say), records any mix of this device's and other devices' (with device). Values shared are never in a record, so never here; single-use key aliases stay behind.

#Parameters

#Returns

object

#offerNameAmong()

function offerNameAmong(typed, taken): object;

A name as the holder typed it, against the names of their other personas (taken): name normalised, offered the one it would take ("Work 2" if "Work" is taken, ignoring case), taken if they differ. Throws NameError if it can't be a name.

#Parameters

#Returns

object

#otherPersons()

function otherPersons(b): boolean;

Whether a bond is with another person's device (prd.md §7.10), whichever side showed the code: who a custodian can be (§7.11).

#Parameters

#Returns

boolean

#pairingMailbox()

function pairingMailbox(secret): string;

The relay mailbox two devices meet at to pair, named by a hash of the pairing secret (the secret never leaves the link).

#Parameters

#Returns

string

#parseHandoverUrl()

function parseHandoverUrl(url): Uint8Array<ArrayBufferLike> | undefined;

The secret in a link handing the holder's wellknown.id to a browser (…/take#1.<secret>), or undefined if url isn't one.

#Parameters

#Returns

Uint8Array<ArrayBufferLike> | undefined

#parsePairingUrl()

function parsePairingUrl(url): Uint8Array<ArrayBufferLike> | undefined;

The bonding secret in a pairing link (…/bond#1.<secret>), or undefined if url isn't one.

#Parameters

#Returns

Uint8Array<ArrayBufferLike> | undefined

#parseRecoveryCode()

function parseRecoveryCode(typed): Uint8Array;

A recovery code as typed (any case, with or without dashes or spaces; O for 0, I and L for 1). A code printed with its persona's name (Persona Work · 7K3P-…, prd.md §4.10) is read after the last ·: the name is a label, not part of the code.

#Parameters

#Returns

Uint8Array

#parseRecoveryUrl()

function parseRecoveryUrl(url): Uint8Array<ArrayBufferLike> | undefined;

The secret in a recovery link (…/recover#1.<S>), or undefined if url isn't one.

#Parameters

#Returns

Uint8Array<ArrayBufferLike> | undefined

#parseSignInUrl()

function parseSignInUrl(url): Uint8Array<ArrayBufferLike> | undefined;

The secret in a link asking a wallet to sign in for another device (…/signin#1.<secret>), or undefined if url isn't one.

#Parameters

#Returns

Uint8Array<ArrayBufferLike> | undefined

#toBase64()

function toBase64(bytes): string;

Standard base64 (RFC 4648 §4, padded), with no dependency on Buffer or btoa.

#Parameters

#Returns

string

#verifyDidKeySignature()

function verifyDidKeySignature(
   did, 
   data, 
   signature
): boolean;

Verifies a signature by a did:key, as the IdP does (apps/idp/lib/did-key.ts): Ed25519, or P-256 ECDSA with SHA-256 as raw r||s. Never throws.

#Parameters

#Returns

boolean

#whoSigned()

function whoSigned(
   entry, 
   here, 
   known
): 
  | {
  kind: "here";
}
  | {
  kind: "device";
  name: string;
}
  | {
  kind: "unknown";
}
  | {
  kind: "page";
};

Who made a record, for people: this device (here, its did:key), one of the devices known by name (did:key to name), a device this one doesn't know, or (unsigned) one of the holder's browsers.

#Parameters

#Returns

| { kind: "here"; } | { kind: "device"; name: string; } | { kind: "unknown"; } | { kind: "page"; }