feat: add Citadel record id and login outcome query params

src/helpers/citadelUtils.ts

@@ -9,12 +9,17 @@ export interface CitadelAllowParams {
   verifierId: string;
   network: string;
   clientId: string;
+  recordId: string;
   source?: string;
   torusLoginStatus?: TorusLoginStatus;
+  torusLoginInitiated?: boolean;
+  torusLoginSuccess?: boolean;
+  torusLoginFailed?: boolean;
 }
 
 export function buildAllowUrl(params: CitadelAllowParams): string {
   const url = new URL(`${CITADEL_SERVER_MAP[params.buildEnv]}/v1/signer/allow`);
+  url.searchParams.set("recordid", params.recordId);
   url.searchParams.set("verifier", params.verifier);
   url.searchParams.set("verifierid", params.verifierId);
   url.searchParams.set("network", params.network);
@@ -25,9 +30,24 @@ export function buildAllowUrl(params: CitadelAllowParams): string {
   if (params.torusLoginStatus) {
     url.searchParams.set("torusloginstatus", params.torusLoginStatus);
   }
+  if (typeof params.torusLoginInitiated !== "undefined") {
+    url.searchParams.set("toruslogininitiated", params.torusLoginInitiated.toString());
+  }
+  if (typeof params.torusLoginSuccess !== "undefined") {
+    url.searchParams.set("torusloginsuccess", params.torusLoginSuccess.toString());
+  }
+  if (typeof params.torusLoginFailed !== "undefined") {
+    url.searchParams.set("torusloginfailed", params.torusLoginFailed.toString());
+  }
   return url.toString();
 }
 
 export async function callAllowApi(params: CitadelAllowParams): Promise<void> {
   await get<void>(buildAllowUrl(params));
 }
+
+export function generateRecordId(): string {
+  const cr = typeof globalThis === "object" ? globalThis.crypto : null;
+  if (typeof cr?.randomUUID !== "function") throw new Error("crypto.randomUUID must be defined");
+  return cr.randomUUID();
+}

src/helpers/nodeUtils.ts

@@ -363,6 +363,7 @@ export async function retrieveOrImportShare(params: {
   overrideExistingKey: boolean;
   nodePubkeys: INodePub[];
   extraParams: TorusUtilsExtraParams;
+  recordId: string;
   newImportedShares?: ImportedShare[];
   checkCommitment?: boolean;
   source?: string;
@@ -388,6 +389,7 @@ export async function retrieveOrImportShare(params: {
     serverTimeOffset,
     checkCommitment = true,
     source,
+    recordId,
   } = params;
   await callAllowApi({
     buildEnv,
@@ -397,6 +399,8 @@ export async function retrieveOrImportShare(params: {
     clientId,
     source,
     torusLoginStatus: TorusLoginStatus.INITIATED,
+    recordId,
+    torusLoginInitiated: true,
   });
 
   // generate temporary private and public key that is used to secure receive shares

src/torus.ts

@@ -10,6 +10,7 @@ import {
   Curve,
   encodeEd25519Point,
   generateAddressFromPubKey,
+  generateRecordId,
   generateShares,
   getEd25519ExtendedPublicKey,
   getKeyCurve,
@@ -157,11 +158,13 @@ class Torus {
       network: this.network,
       clientId: this.clientId,
       source: this.source,
+      recordId: generateRecordId(),
     };
 
     let result: TorusKey;
     try {
       result = await retrieveOrImportShare({
+        recordId: allowParams.recordId,
         legacyMetadataHost: this.legacyMetadataHost,
         serverTimeOffset: this.serverTimeOffset,
         enableOneKey: this.enableOneKey,
@@ -184,11 +187,11 @@ class Torus {
         source: this.source,
       });
     } catch (error) {
-      this.reportSignerAllow({ ...allowParams, torusLoginStatus: TorusLoginStatus.FAILED });
+      this.reportSignerAllow({ ...allowParams, torusLoginStatus: TorusLoginStatus.FAILED, torusLoginFailed: true });
       throw error;
     }
 
-    this.reportSignerAllow({ ...allowParams, torusLoginStatus: TorusLoginStatus.SUCCESS });
+    this.reportSignerAllow({ ...allowParams, torusLoginStatus: TorusLoginStatus.SUCCESS, torusLoginSuccess: true });
     return result;
   }
 
@@ -261,6 +264,7 @@ class Torus {
     }
 
     return retrieveOrImportShare({
+      recordId: generateRecordId(),
       legacyMetadataHost: this.legacyMetadataHost,
       serverTimeOffset: this.serverTimeOffset,
       enableOneKey: this.enableOneKey,