@interop/wallet-core 0.100.0 → 0.101.0

package/dist/testing/accountBuilder.d.ts

@@ -0,0 +1,237 @@
+import type { IZcap } from '@interop/data-integrity-core';
+import type { ZcapClient } from '@interop/ezcap';
+/**
+ * A fresh credential and the account Space id it will be carried under: a
+ * random ladder seed, and the standing client derived from the credential's
+ * unlock seed. Given a passphrase, the unlock seed derives under `FAST_KDF`
+ * and the credential is low-entropy; the unlock identity rides along so a
+ * test can name its unlock Space. Without one, the unlock seed is 32 random
+ * bytes and the credential is high-entropy.
+ *
+ * @param [options] {object}
+ * @param [options.passphrase] {string}
+ * @returns {Promise<object>}   `{ spaceId, ladderSeed, standing, lowEntropy,
+ *   unlock? }`
+ */
+export declare function mintCredential({ passphrase }?: {
+    passphrase?: string;
+}): Promise<{
+    unlock?: import("../keyring/unlockIdentity.js").UnlockIdentity | undefined;
+    spaceId: string;
+    ladderSeed: Uint8Array<ArrayBufferLike>;
+    standing: import("../unlock/standingClient.js").StandingUnlockClient;
+    lowEntropy: boolean;
+}>;
+/**
+ * A credential as {@link mintCredential} returns it.
+ */
+export type BuilderCredential = Awaited<ReturnType<typeof mintCredential>>;
+/**
+ * Establishes a credential-anchored account on the server, through one run of
+ * the signup ceremony. Each call is one run with its own in-memory pins, as a
+ * fresh tab's would be, so a test re-running a torn establishment passes the
+ * same `credential` again.
+ *
+ * @param options {object}
+ * @param options.serverUrl {string}   the booted server's URL
+ * @param [options.credential] {BuilderCredential}   from `mintCredential`; a
+ *   fresh high-entropy one when omitted
+ * @returns {Promise<object>}   the account's ids, the credential's ladder seed
+ *   and standing client, and the bridge and sibling delegations the re-bind
+ *   carried
+ */
+export declare function establishAccount({ serverUrl, credential }: {
+    serverUrl: string;
+    credential?: BuilderCredential;
+}): Promise<{
+    serverUrl: string;
+    spaceId: string;
+    accountDid: string;
+    annexSpaceId: string;
+    ladderSeed: Uint8Array<ArrayBufferLike>;
+    standing: import("../unlock/standingClient.js").StandingUnlockClient;
+    bridge: IZcap;
+    sibling: IZcap;
+}>;
+export type EstablishedAccount = Awaited<ReturnType<typeof establishAccount>>;
+/**
+ * A credential-anchored account with one passphrase.
+ *
+ * @param options {object}
+ * @param options.serverUrl {string}
+ * @param [options.passphrase] {string}   a unique one by default
+ * @returns {Promise<object>}   the established account plus `passphrase`
+ */
+export declare function buildPassphraseAccount({ serverUrl, passphrase }: {
+    serverUrl: string;
+    passphrase?: string;
+}): Promise<EstablishedAccount & {
+    passphrase: string;
+}>;
+/**
+ * Adds a second standing credential to the account, acting as the account's
+ * existing credential in a transient session: the standing establishment's
+ * ladder branch. The new credential's bridge and sibling delegations are
+ * signed by its OWN ladder VM; its record binds in memory; its ladder's rung
+ * 0 is committed into the pointed generation (blocking on this branch); the
+ * bind entry publishes, signed by the acting credential's ladder; and only
+ * then is the new credential escrowed into the roster, since a ladder-signed
+ * roster append is licensed at the inventory-changing version its own entry
+ * mints.
+ *
+ * A second call with the same passphrase is not a converging re-run: each
+ * call mints a fresh ladder seed, so the re-bind is refused at
+ * `publishUnlockKey`.
+ *
+ * @param options {object}
+ * @param options.account {EstablishedAccount}   the acting credential's
+ *   account
+ * @param [options.passphrase] {string}   the new credential's passphrase, a
+ *   unique one by default
+ * @returns {Promise<object>}   the new credential's passphrase, standing
+ *   client, ladder seed, bridge, and sibling
+ */
+export declare function addStandingCredential({ account, passphrase }: {
+    account: EstablishedAccount;
+    passphrase?: string;
+}): Promise<{
+    passphrase: string;
+    standing: import("../unlock/standingClient.js").StandingUnlockClient;
+    ladderSeed: Uint8Array<ArrayBufferLike>;
+    bridge: IZcap;
+    sibling: IZcap;
+}>;
+/**
+ * Issues one recovery code, acting as the account's credential in a
+ * transient session: the issuance's ladder branch. The code's bridge is
+ * signed by the code's own ladder VM and binds in memory; then the code's
+ * `keyAgreement` key publishes, its wrap is escrowed into the roster, and the
+ * authority half (its ladder VM and rung-0 commitment) publishes last. The
+ * code is not spent.
+ *
+ * @param options {object}
+ * @param options.account {EstablishedAccount}
+ * @returns {Promise<object>}   `{ code, client, recoveryKid, bridge }`
+ */
+export declare function issueRecoveryCode({ account }: {
+    account: EstablishedAccount;
+}): Promise<{
+    code: string;
+    client: import("../recovery/recoveryCode.js").RecoveryClient;
+    recoveryKid: string;
+    bridge: IZcap;
+}>;
+/**
+ * Self-enrolls one enrolled client with the account's credential
+ * (`selfEnrollClientCore`), writing the account log through the record's
+ * bridge. The `onCommitted` seam is an in-memory no-op: a wallet persists
+ * the pending client-key record there, and here the seeds the core hands
+ * back are returned to the caller, which is this fixture's persist. A torn
+ * run is not this fixture's subject.
+ *
+ * @param options {object}
+ * @param options.account {EstablishedAccount}
+ * @returns {Promise<object>}   the new client's seed, agents, signing key
+ *   multibase, did:webvh update keys, did:key, the user key it read, and a
+ *   zcap client signing as `<accountDid>#<signing key>`
+ */
+export declare function enrollClient({ account }: {
+    account: EstablishedAccount;
+}): Promise<{
+    clientSeed: Uint8Array<ArrayBufferLike>;
+    agents: import("@interop/was-client/identity").ProfileAgents;
+    signingKeyMultibase: string;
+    webvhUpdateKeys: import("../webvh/didWebvh.js").ClientWebvhUpdateKeys;
+    clientDid: string;
+    userKey: import("../keys/userKey.js").UserKey;
+    zcapClient: ZcapClient;
+}>;
+/**
+ * The passphrase shape plus a second standing credential.
+ *
+ * @param options {object}
+ * @param options.serverUrl {string}
+ * @param [options.passphrase] {string}   a unique one by default
+ * @returns {Promise<object>}   the passphrase account plus `second`
+ */
+export declare function buildSecondCredentialAccount({ serverUrl, passphrase }: {
+    serverUrl: string;
+    passphrase?: string;
+}): Promise<{
+    second: {
+        passphrase: string;
+        standing: import("../unlock/standingClient.js").StandingUnlockClient;
+        ladderSeed: Uint8Array<ArrayBufferLike>;
+        bridge: IZcap;
+        sibling: IZcap;
+    };
+    serverUrl: string;
+    spaceId: string;
+    accountDid: string;
+    annexSpaceId: string;
+    ladderSeed: Uint8Array<ArrayBufferLike>;
+    standing: import("../unlock/standingClient.js").StandingUnlockClient;
+    bridge: IZcap;
+    sibling: IZcap;
+    passphrase: string;
+}>;
+/**
+ * The passphrase shape plus one issued, unspent recovery code.
+ *
+ * @param options {object}
+ * @param options.serverUrl {string}
+ * @param [options.passphrase] {string}   a unique one by default
+ * @returns {Promise<object>}   the passphrase account plus `recovery`
+ */
+export declare function buildRecoveryCodeAccount({ serverUrl, passphrase }: {
+    serverUrl: string;
+    passphrase?: string;
+}): Promise<{
+    recovery: {
+        code: string;
+        client: import("../recovery/recoveryCode.js").RecoveryClient;
+        recoveryKid: string;
+        bridge: IZcap;
+    };
+    serverUrl: string;
+    spaceId: string;
+    accountDid: string;
+    annexSpaceId: string;
+    ladderSeed: Uint8Array<ArrayBufferLike>;
+    standing: import("../unlock/standingClient.js").StandingUnlockClient;
+    bridge: IZcap;
+    sibling: IZcap;
+    passphrase: string;
+}>;
+/**
+ * The passphrase shape plus one enrolled client.
+ *
+ * @param options {object}
+ * @param options.serverUrl {string}
+ * @param [options.passphrase] {string}   a unique one by default
+ * @returns {Promise<object>}   the passphrase account plus `client`
+ */
+export declare function buildEnrolledClientAccount({ serverUrl, passphrase }: {
+    serverUrl: string;
+    passphrase?: string;
+}): Promise<{
+    client: {
+        clientSeed: Uint8Array<ArrayBufferLike>;
+        agents: import("@interop/was-client/identity").ProfileAgents;
+        signingKeyMultibase: string;
+        webvhUpdateKeys: import("../webvh/didWebvh.js").ClientWebvhUpdateKeys;
+        clientDid: string;
+        userKey: import("../keys/userKey.js").UserKey;
+        zcapClient: ZcapClient;
+    };
+    serverUrl: string;
+    spaceId: string;
+    accountDid: string;
+    annexSpaceId: string;
+    ladderSeed: Uint8Array<ArrayBufferLike>;
+    standing: import("../unlock/standingClient.js").StandingUnlockClient;
+    bridge: IZcap;
+    sibling: IZcap;
+    passphrase: string;
+}>;
+//# sourceMappingURL=accountBuilder.d.ts.map

package/dist/testing/accountBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accountBuilder.d.ts","sourceRoot":"","sources":["../../src/testing/accountBuilder.ts"],"names":[],"mappings":"AAkDA,OAAO,KAAK,EAAoB,KAAK,EAAE,MAAM,8BAA8B,CAAA;AAC3E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AA6DhD;;;;;;;;;;;;GAYG;AACH,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACX,GAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAO;;;;;;GAc9B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAA;AAE1E;;;;;;;;;;;;;GAaG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,SAAS,EACT,UAAU,EACX,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAC/B;;;;;;;;;GA0EA;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,SAAS,EACT,UAA+B,EAChC,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,GAAG,OAAO,CAAC,kBAAkB,GAAG;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC,CAMvD;AAsFD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,OAAO,EACP,UAA+B,EAChC,EAAE;IACD,OAAO,EAAE,kBAAkB,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;;;;;;GA2EA;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,OAAO,EACR,EAAE;IACD,OAAO,EAAE,kBAAkB,CAAA;CAC5B;;;;;GAyCA;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAAC,EACjC,OAAO,EACR,EAAE;IACD,OAAO,EAAE,kBAAkB,CAAA;CAC5B;;;;;;;;GAkCA;AAED;;;;;;;GAOG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,SAAS,EACT,UAAU,EACX,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;;;;;;;;;;;;;;;;gBArU8C,MAAM;GA2UpD;AAED;;;;;;;GAOG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,SAAS,EACT,UAAU,EACX,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;;;;;;;;;;;;;;;gBA3V8C,MAAM;GAiWpD;AAED;;;;;;;GAOG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,SAAS,EACT,UAAU,EACX,EAAE;IACD,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;;;;;;;;;;;;;;;;;;gBAjX8C,MAAM;GAuXpD"}