minca
ApiInboxFunctions

Function: openKnock()

function openKnock(
   keys, 
   blob, 
   provider
): Promise<OpenedKnock | null>;

Defined in: packages/core/src/inbox/inbox.ts:251

Opens a knock and checks it through (spec 07 §6): sealed to one of these keys and naming it; signed under a note from its account that may write for the whole account, valid when it was signed; recent; and carrying a signed invitation from the same account to a private space that account alone founded.

Parameters

ParameterTypeDescription
keysreadonly Uint8Array<ArrayBufferLike>[]The private scalars it may be sealed to: the inbox keys, or the contact key
blobstring-
providerCryptoProvider-

Returns

Promise<OpenedKnock | null>

The knock, or null when it is anything less

On this page