@ledgerhq/revault-sdk 0.12.0

package/lib/onboarding.js

@@ -0,0 +1,160 @@
+// src/onboarding.ts
+var roleLabels = {
+  WRAPPING_KEY_OWNER: "Wrapping Key",
+  MASTER_ADMIN: "Admin",
+  SHARED_OWNER: "Shared Owner"
+};
+var STEPS = {
+  /**
+   * Devices claiming
+   */
+  PENDING_DEVICE_CLAIMS: async ({ state, engine }, logger) => {
+    const roles = ["WRAPPING_KEY_OWNER", "MASTER_ADMIN", "SHARED_OWNER"];
+    const promises = [];
+    for (const role of roles) {
+      const roleIndex = roles.indexOf(role);
+      const nbAlreadyClaimed = state.claimedDevices.filter((c) => c.role === role).length;
+      for (let i = nbAlreadyClaimed; i < 3; i++) {
+        const index = roleIndex * 3 + i + 1;
+        const deviceName = `${roleLabels[role]} ${index}`;
+        const promise = engine.withDeviceIndex(index).claimDevice({ role, deviceName }).then(() => logger.info(`Claimed ${deviceName}`));
+        promises.push(promise);
+      }
+    }
+    await Promise.all(promises);
+    return engine.client.onboarding.commitDeviceClaims.mutate({ onboardingId: state.id });
+  },
+  /**
+   * Wrapping Key provisioning
+   */
+  PENDING_WRAPPING_KEY_PROVISIONING: async ({ state, engine }, logger) => {
+    const { id: onboardingId } = state;
+    state = await engine.client.onboarding.startWrappingKeyProvisioning.mutate({ onboardingId });
+    const wrappingKey = state.wrappingKey;
+    const toCollect = state.claimedDevices.filter((claimed) => {
+      if (claimed.role !== "WRAPPING_KEY_OWNER") return false;
+      const inFragment = !!state.wrappingKey?.fragments.find((f) => f.pubKey === claimed.pubKey);
+      return !inFragment;
+    }).map((c) => Number(c.deviceName.replace(roleLabels.WRAPPING_KEY_OWNER, "")));
+    await Promise.all(
+      toCollect.map(
+        (index) => engine.withDeviceIndex(index).collectWrappingKeyFragment(wrappingKey).then(() => logger.info(`Collected Wrapping Key ${index}`))
+      )
+    );
+    return engine.client.onboarding.commitWrappingKey.mutate({ onboardingId });
+  },
+  /**
+   * Init Master Admins registration
+   */
+  PENDING_MASTER_ADMINS_REGISTRATION_INIT: async ({ engine, state }) => engine.client.onboarding.startMasterAdminsRegistration.mutate({ onboardingId: state.id }),
+  /**
+   * Master Admins registration
+   */
+  PENDING_MASTER_ADMINS_REGISTRATION: async ({ state, engine }, logger) => {
+    const { id: onboardingId } = state;
+    const toRegister = state.claimedDevices.filter((claimed) => {
+      if (claimed.role !== "MASTER_ADMIN") return false;
+      const hasRegistered = !!state.masterAdmins.find((a) => a.pubKey === claimed.pubKey);
+      return !hasRegistered;
+    }).map((c) => Number(c.deviceName.replace(roleLabels.MASTER_ADMIN, "")));
+    await Promise.all(
+      toRegister.map(async (index) => {
+        const name = `${roleLabels.MASTER_ADMIN} ${index}`;
+        await engine.withDeviceIndex(index).registerDevice({ role: "ADMIN", name });
+        logger.info(`Registered ${name}`);
+      })
+    );
+    return engine.client.onboarding.createMasterAdminGroup.mutate({ onboardingId });
+  },
+  /**
+   * Init Shared Owners registration
+   */
+  PENDING_SHARED_OWNERS_REGISTRATION_INIT: async ({ engine, state }) => engine.client.onboarding.startSharedOwnersRegistration.mutate({ onboardingId: state.id }),
+  /**
+   * Shared Owners registration
+   */
+  PENDING_SHARED_OWNERS_REGISTRATION: async ({ state, engine }, logger) => {
+    const { id: onboardingId } = state;
+    const toRegister = state.claimedDevices.filter((claimed) => {
+      if (claimed.role !== "SHARED_OWNER") return false;
+      const hasRegistered = !!state.sharedOwners.find((a) => a.pubKey === claimed.pubKey);
+      return !hasRegistered;
+    }).map((c) => Number(c.deviceName.replace(roleLabels.SHARED_OWNER, "")));
+    await Promise.all(
+      toRegister.map(async (index) => {
+        const name = `${roleLabels.SHARED_OWNER} ${index}`;
+        await engine.withDeviceIndex(index).registerDevice({ role: "SHARED_OWNER", name });
+        logger.info(`Registered ${name}`);
+      })
+    );
+    return engine.client.onboarding.commitSharedOwnersRegistration.mutate({ onboardingId });
+  },
+  /**
+   * Review by master admins
+   */
+  PENDING_REVIEW_BY_MASTER_ADMINS: async ({ state, engine }, logger) => {
+    const { id: onboardingId } = state;
+    state = await engine.client.onboarding.startReviewByMasterAdmins.mutate({ onboardingId });
+    const toCollect = state.masterAdmins.filter((admin) => !admin.review?.signature);
+    await Promise.all(
+      toCollect.map(async (admin) => {
+        const index = Number(admin.name.replace(roleLabels.MASTER_ADMIN, ""));
+        const challenge = admin.review.challenge;
+        await engine.withDeviceIndex(index).reviewSharedOwner(challenge);
+        logger.info(`Approved with ${admin.name}`);
+      })
+    );
+    return engine.client.onboarding.commitReviewByMasterAdmins.mutate({ onboardingId });
+  },
+  /**
+   * Seed provisioning
+   */
+  PENDING_SEED_PROVISIONING: async ({ state, engine }, logger) => {
+    const { id: onboardingId } = state;
+    state = await engine.client.onboarding.startSeedProvisioning.mutate({ onboardingId });
+    const toCollect = state.sharedOwners.filter((so) => !so.review?.seedFragment);
+    await Promise.all(
+      toCollect.map(async (so) => {
+        const index = Number(so.name.replace(roleLabels.SHARED_OWNER, ""));
+        const challenge = so.review.seedChallenge;
+        await engine.withDeviceIndex(index).collectSeedFragment(challenge);
+        logger.info(`Collected fragment for ${so.name}`);
+      })
+    );
+    return engine.client.onboarding.commitSeedProvisioning.mutate({ onboardingId });
+  },
+  /**
+   * Workspace initialization
+   */
+  PENDING_WORKSPACE_INITIALIZATION: async ({ state, engine }) => engine.client.onboarding.initializeWorkspace.mutate({ onboardingId: state.id }),
+  /**
+   * Onboarding completed
+   */
+  COMPLETED: async ({ state }) => state
+};
+var STEPS_LIST = Object.values(STEPS);
+async function onboard({
+  engine,
+  untilStep
+}, logger) {
+  const { __onboardingId } = engine;
+  logger.info(`Joining onboarding ${__onboardingId}`);
+  let state = await engine.client.onboarding.getOnboarding.query({
+    onboardingId: __onboardingId
+  });
+  for (const step of STEPS_LIST.slice(STEPS_LIST.indexOf(STEPS[state.step]))) {
+    if (untilStep && state.step === untilStep) {
+      logger.info("Skipping the rest of the onboarding");
+      break;
+    }
+    const index = STEPS_LIST.indexOf(step);
+    const stepProgress = `${(index + 1).toString().padStart(2, "0")}/${STEPS_LIST.length}`;
+    logger.info(`(${stepProgress}) ${step.name}`);
+    state = await step({ engine, state }, logger);
+  }
+}
+export {
+  STEPS,
+  onboard
+};
+//# sourceMappingURL=onboarding.js.map

package/lib/onboarding.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/onboarding.ts"],"sourcesContent":["import type {\n  ClaimedRole,\n  OnboardingFullStateResponse,\n  OnboardingStep,\n} from \"@ledgerhq/revault-api\";\n\nimport type { Logger } from \"@/types\";\n\nimport type { Engine, WithOnboarding } from \"./engine/types\";\n\ntype StepAction = (\n  options: {\n    engine: Engine<WithOnboarding>;\n    state: OnboardingFullStateResponse;\n  },\n  logger: Logger,\n) => Promise<OnboardingFullStateResponse>;\n\nconst roleLabels: Record<ClaimedRole, string> = {\n  WRAPPING_KEY_OWNER: \"Wrapping Key\",\n  MASTER_ADMIN: \"Admin\",\n  SHARED_OWNER: \"Shared Owner\",\n};\n\nexport const STEPS = {\n  /**\n   * Devices claiming\n   */\n  PENDING_DEVICE_CLAIMS: async ({ state, engine }, logger) => {\n    const roles: ClaimedRole[] = [\"WRAPPING_KEY_OWNER\", \"MASTER_ADMIN\", \"SHARED_OWNER\"];\n    const promises: Promise<void>[] = [];\n    for (const role of roles) {\n      const roleIndex = roles.indexOf(role);\n      const nbAlreadyClaimed = state.claimedDevices.filter((c) => c.role === role).length;\n      for (let i = nbAlreadyClaimed; i < 3; i++) {\n        const index = roleIndex * 3 + i + 1;\n        const deviceName = `${roleLabels[role]} ${index}`;\n        const promise = engine\n          .withDeviceIndex(index)\n          .claimDevice({ role, deviceName })\n          .then(() => logger.info(`Claimed ${deviceName}`));\n        promises.push(promise);\n      }\n    }\n    await Promise.all(promises);\n    return engine.client.onboarding.commitDeviceClaims.mutate({ onboardingId: state.id });\n  },\n\n  /**\n   * Wrapping Key provisioning\n   */\n  PENDING_WRAPPING_KEY_PROVISIONING: async ({ state, engine }, logger) => {\n    const { id: onboardingId } = state;\n    state = await engine.client.onboarding.startWrappingKeyProvisioning.mutate({ onboardingId });\n    const wrappingKey = state.wrappingKey!;\n    const toCollect = state.claimedDevices\n      .filter((claimed) => {\n        if (claimed.role !== \"WRAPPING_KEY_OWNER\") return false;\n        const inFragment = !!state.wrappingKey?.fragments.find((f) => f.pubKey === claimed.pubKey);\n        return !inFragment;\n      })\n      .map((c) => Number(c.deviceName.replace(roleLabels.WRAPPING_KEY_OWNER, \"\")));\n    await Promise.all(\n      toCollect.map((index) =>\n        engine\n          .withDeviceIndex(index)\n          .collectWrappingKeyFragment(wrappingKey)\n          .then(() => logger.info(`Collected Wrapping Key ${index}`)),\n      ),\n    );\n    return engine.client.onboarding.commitWrappingKey.mutate({ onboardingId });\n  },\n\n  /**\n   * Init Master Admins registration\n   */\n  PENDING_MASTER_ADMINS_REGISTRATION_INIT: async ({ engine, state }) =>\n    engine.client.onboarding.startMasterAdminsRegistration.mutate({ onboardingId: state.id }),\n\n  /**\n   * Master Admins registration\n   */\n  PENDING_MASTER_ADMINS_REGISTRATION: async ({ state, engine }, logger) => {\n    const { id: onboardingId } = state;\n    const toRegister = state.claimedDevices\n      .filter((claimed) => {\n        if (claimed.role !== \"MASTER_ADMIN\") return false;\n        const hasRegistered = !!state.masterAdmins.find((a) => a.pubKey === claimed.pubKey);\n        return !hasRegistered;\n      })\n      .map((c) => Number(c.deviceName.replace(roleLabels.MASTER_ADMIN, \"\")));\n    await Promise.all(\n      toRegister.map(async (index) => {\n        const name = `${roleLabels.MASTER_ADMIN} ${index}`;\n        await engine.withDeviceIndex(index).registerDevice({ role: \"ADMIN\", name });\n        logger.info(`Registered ${name}`);\n      }),\n    );\n    return engine.client.onboarding.createMasterAdminGroup.mutate({ onboardingId });\n  },\n\n  /**\n   * Init Shared Owners registration\n   */\n  PENDING_SHARED_OWNERS_REGISTRATION_INIT: async ({ engine, state }) =>\n    engine.client.onboarding.startSharedOwnersRegistration.mutate({ onboardingId: state.id }),\n\n  /**\n   * Shared Owners registration\n   */\n  PENDING_SHARED_OWNERS_REGISTRATION: async ({ state, engine }, logger) => {\n    const { id: onboardingId } = state;\n    const toRegister = state.claimedDevices\n      .filter((claimed) => {\n        if (claimed.role !== \"SHARED_OWNER\") return false;\n        const hasRegistered = !!state.sharedOwners.find((a) => a.pubKey === claimed.pubKey);\n        return !hasRegistered;\n      })\n      .map((c) => Number(c.deviceName.replace(roleLabels.SHARED_OWNER, \"\")));\n    await Promise.all(\n      toRegister.map(async (index) => {\n        const name = `${roleLabels.SHARED_OWNER} ${index}`;\n        await engine.withDeviceIndex(index).registerDevice({ role: \"SHARED_OWNER\", name });\n        logger.info(`Registered ${name}`);\n      }),\n    );\n    return engine.client.onboarding.commitSharedOwnersRegistration.mutate({ onboardingId });\n  },\n\n  /**\n   * Review by master admins\n   */\n  PENDING_REVIEW_BY_MASTER_ADMINS: async ({ state, engine }, logger) => {\n    const { id: onboardingId } = state;\n    state = await engine.client.onboarding.startReviewByMasterAdmins.mutate({ onboardingId });\n    const toCollect = state.masterAdmins.filter((admin) => !admin.review?.signature);\n    await Promise.all(\n      toCollect.map(async (admin) => {\n        const index = Number(admin.name.replace(roleLabels.MASTER_ADMIN, \"\"));\n        const challenge = admin.review!.challenge;\n        await engine.withDeviceIndex(index).reviewSharedOwner(challenge);\n        logger.info(`Approved with ${admin.name}`);\n      }),\n    );\n    return engine.client.onboarding.commitReviewByMasterAdmins.mutate({ onboardingId });\n  },\n\n  /**\n   * Seed provisioning\n   */\n  PENDING_SEED_PROVISIONING: async ({ state, engine }, logger) => {\n    const { id: onboardingId } = state;\n    state = await engine.client.onboarding.startSeedProvisioning.mutate({ onboardingId });\n    const toCollect = state.sharedOwners.filter((so) => !so.review?.seedFragment);\n    await Promise.all(\n      toCollect.map(async (so) => {\n        const index = Number(so.name.replace(roleLabels.SHARED_OWNER, \"\"));\n        const challenge = so.review!.seedChallenge;\n        await engine.withDeviceIndex(index).collectSeedFragment(challenge);\n        logger.info(`Collected fragment for ${so.name}`);\n      }),\n    );\n    return engine.client.onboarding.commitSeedProvisioning.mutate({ onboardingId });\n  },\n\n  /**\n   * Workspace initialization\n   */\n  PENDING_WORKSPACE_INITIALIZATION: async ({ state, engine }) =>\n    engine.client.onboarding.initializeWorkspace.mutate({ onboardingId: state.id }),\n\n  /**\n   * Onboarding completed\n   */\n  COMPLETED: async ({ state }) => state,\n} as const satisfies Record<OnboardingStep, StepAction>;\n\nconst STEPS_LIST = Object.values(STEPS);\n\nexport async function onboard(\n  {\n    engine,\n    untilStep,\n  }: {\n    engine: Engine<WithOnboarding>;\n    untilStep?: OnboardingStep;\n  },\n  logger: Logger,\n): Promise<void> {\n  const { __onboardingId } = engine;\n  logger.info(`Joining onboarding ${__onboardingId}`);\n  let state = await engine.client.onboarding.getOnboarding.query({\n    onboardingId: __onboardingId,\n  });\n\n  for (const step of STEPS_LIST.slice(STEPS_LIST.indexOf(STEPS[state.step]))) {\n    if (untilStep && state.step === untilStep) {\n      logger.info(\"Skipping the rest of the onboarding\");\n      break;\n    }\n    const index = STEPS_LIST.indexOf(step);\n    const stepProgress = `${(index + 1).toString().padStart(2, \"0\")}/${STEPS_LIST.length}`;\n    logger.info(`(${stepProgress}) ${step.name}`);\n    state = await step({ engine, state }, logger);\n  }\n}\n"],"mappings":";AAkBA,IAAM,aAA0C;AAAA,EAC9C,oBAAoB;AAAA,EACpB,cAAc;AAAA,EACd,cAAc;AAChB;AAEO,IAAM,QAAQ;AAAA;AAAA;AAAA;AAAA,EAInB,uBAAuB,OAAO,EAAE,OAAO,OAAO,GAAG,WAAW;AAC1D,UAAM,QAAuB,CAAC,sBAAsB,gBAAgB,cAAc;AAClF,UAAM,WAA4B,CAAC;AACnC,eAAW,QAAQ,OAAO;AACxB,YAAM,YAAY,MAAM,QAAQ,IAAI;AACpC,YAAM,mBAAmB,MAAM,eAAe,OAAO,CAAC,MAAM,EAAE,SAAS,IAAI,EAAE;AAC7E,eAAS,IAAI,kBAAkB,IAAI,GAAG,KAAK;AACzC,cAAM,QAAQ,YAAY,IAAI,IAAI;AAClC,cAAM,aAAa,GAAG,WAAW,IAAI,CAAC,IAAI,KAAK;AAC/C,cAAM,UAAU,OACb,gBAAgB,KAAK,EACrB,YAAY,EAAE,MAAM,WAAW,CAAC,EAChC,KAAK,MAAM,OAAO,KAAK,WAAW,UAAU,EAAE,CAAC;AAClD,iBAAS,KAAK,OAAO;AAAA,MACvB;AAAA,IACF;AACA,UAAM,QAAQ,IAAI,QAAQ;AAC1B,WAAO,OAAO,OAAO,WAAW,mBAAmB,OAAO,EAAE,cAAc,MAAM,GAAG,CAAC;AAAA,EACtF;AAAA;AAAA;AAAA;AAAA,EAKA,mCAAmC,OAAO,EAAE,OAAO,OAAO,GAAG,WAAW;AACtE,UAAM,EAAE,IAAI,aAAa,IAAI;AAC7B,YAAQ,MAAM,OAAO,OAAO,WAAW,6BAA6B,OAAO,EAAE,aAAa,CAAC;AAC3F,UAAM,cAAc,MAAM;AAC1B,UAAM,YAAY,MAAM,eACrB,OAAO,CAAC,YAAY;AACnB,UAAI,QAAQ,SAAS,qBAAsB,QAAO;AAClD,YAAM,aAAa,CAAC,CAAC,MAAM,aAAa,UAAU,KAAK,CAAC,MAAM,EAAE,WAAW,QAAQ,MAAM;AACzF,aAAO,CAAC;AAAA,IACV,CAAC,EACA,IAAI,CAAC,MAAM,OAAO,EAAE,WAAW,QAAQ,WAAW,oBAAoB,EAAE,CAAC,CAAC;AAC7E,UAAM,QAAQ;AAAA,MACZ,UAAU;AAAA,QAAI,CAAC,UACb,OACG,gBAAgB,KAAK,EACrB,2BAA2B,WAAW,EACtC,KAAK,MAAM,OAAO,KAAK,0BAA0B,KAAK,EAAE,CAAC;AAAA,MAC9D;AAAA,IACF;AACA,WAAO,OAAO,OAAO,WAAW,kBAAkB,OAAO,EAAE,aAAa,CAAC;AAAA,EAC3E;AAAA;AAAA;AAAA;AAAA,EAKA,yCAAyC,OAAO,EAAE,QAAQ,MAAM,MAC9D,OAAO,OAAO,WAAW,8BAA8B,OAAO,EAAE,cAAc,MAAM,GAAG,CAAC;AAAA;AAAA;AAAA;AAAA,EAK1F,oCAAoC,OAAO,EAAE,OAAO,OAAO,GAAG,WAAW;AACvE,UAAM,EAAE,IAAI,aAAa,IAAI;AAC7B,UAAM,aAAa,MAAM,eACtB,OAAO,CAAC,YAAY;AACnB,UAAI,QAAQ,SAAS,eAAgB,QAAO;AAC5C,YAAM,gBAAgB,CAAC,CAAC,MAAM,aAAa,KAAK,CAAC,MAAM,EAAE,WAAW,QAAQ,MAAM;AAClF,aAAO,CAAC;AAAA,IACV,CAAC,EACA,IAAI,CAAC,MAAM,OAAO,EAAE,WAAW,QAAQ,WAAW,cAAc,EAAE,CAAC,CAAC;AACvE,UAAM,QAAQ;AAAA,MACZ,WAAW,IAAI,OAAO,UAAU;AAC9B,cAAM,OAAO,GAAG,WAAW,YAAY,IAAI,KAAK;AAChD,cAAM,OAAO,gBAAgB,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,KAAK,CAAC;AAC1E,eAAO,KAAK,cAAc,IAAI,EAAE;AAAA,MAClC,CAAC;AAAA,IACH;AACA,WAAO,OAAO,OAAO,WAAW,uBAAuB,OAAO,EAAE,aAAa,CAAC;AAAA,EAChF;AAAA;AAAA;AAAA;AAAA,EAKA,yCAAyC,OAAO,EAAE,QAAQ,MAAM,MAC9D,OAAO,OAAO,WAAW,8BAA8B,OAAO,EAAE,cAAc,MAAM,GAAG,CAAC;AAAA;AAAA;AAAA;AAAA,EAK1F,oCAAoC,OAAO,EAAE,OAAO,OAAO,GAAG,WAAW;AACvE,UAAM,EAAE,IAAI,aAAa,IAAI;AAC7B,UAAM,aAAa,MAAM,eACtB,OAAO,CAAC,YAAY;AACnB,UAAI,QAAQ,SAAS,eAAgB,QAAO;AAC5C,YAAM,gBAAgB,CAAC,CAAC,MAAM,aAAa,KAAK,CAAC,MAAM,EAAE,WAAW,QAAQ,MAAM;AAClF,aAAO,CAAC;AAAA,IACV,CAAC,EACA,IAAI,CAAC,MAAM,OAAO,EAAE,WAAW,QAAQ,WAAW,cAAc,EAAE,CAAC,CAAC;AACvE,UAAM,QAAQ;AAAA,MACZ,WAAW,IAAI,OAAO,UAAU;AAC9B,cAAM,OAAO,GAAG,WAAW,YAAY,IAAI,KAAK;AAChD,cAAM,OAAO,gBAAgB,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,KAAK,CAAC;AACjF,eAAO,KAAK,cAAc,IAAI,EAAE;AAAA,MAClC,CAAC;AAAA,IACH;AACA,WAAO,OAAO,OAAO,WAAW,+BAA+B,OAAO,EAAE,aAAa,CAAC;AAAA,EACxF;AAAA;AAAA;AAAA;AAAA,EAKA,iCAAiC,OAAO,EAAE,OAAO,OAAO,GAAG,WAAW;AACpE,UAAM,EAAE,IAAI,aAAa,IAAI;AAC7B,YAAQ,MAAM,OAAO,OAAO,WAAW,0BAA0B,OAAO,EAAE,aAAa,CAAC;AACxF,UAAM,YAAY,MAAM,aAAa,OAAO,CAAC,UAAU,CAAC,MAAM,QAAQ,SAAS;AAC/E,UAAM,QAAQ;AAAA,MACZ,UAAU,IAAI,OAAO,UAAU;AAC7B,cAAM,QAAQ,OAAO,MAAM,KAAK,QAAQ,WAAW,cAAc,EAAE,CAAC;AACpE,cAAM,YAAY,MAAM,OAAQ;AAChC,cAAM,OAAO,gBAAgB,KAAK,EAAE,kBAAkB,SAAS;AAC/D,eAAO,KAAK,iBAAiB,MAAM,IAAI,EAAE;AAAA,MAC3C,CAAC;AAAA,IACH;AACA,WAAO,OAAO,OAAO,WAAW,2BAA2B,OAAO,EAAE,aAAa,CAAC;AAAA,EACpF;AAAA;AAAA;AAAA;AAAA,EAKA,2BAA2B,OAAO,EAAE,OAAO,OAAO,GAAG,WAAW;AAC9D,UAAM,EAAE,IAAI,aAAa,IAAI;AAC7B,YAAQ,MAAM,OAAO,OAAO,WAAW,sBAAsB,OAAO,EAAE,aAAa,CAAC;AACpF,UAAM,YAAY,MAAM,aAAa,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,YAAY;AAC5E,UAAM,QAAQ;AAAA,MACZ,UAAU,IAAI,OAAO,OAAO;AAC1B,cAAM,QAAQ,OAAO,GAAG,KAAK,QAAQ,WAAW,cAAc,EAAE,CAAC;AACjE,cAAM,YAAY,GAAG,OAAQ;AAC7B,cAAM,OAAO,gBAAgB,KAAK,EAAE,oBAAoB,SAAS;AACjE,eAAO,KAAK,0BAA0B,GAAG,IAAI,EAAE;AAAA,MACjD,CAAC;AAAA,IACH;AACA,WAAO,OAAO,OAAO,WAAW,uBAAuB,OAAO,EAAE,aAAa,CAAC;AAAA,EAChF;AAAA;AAAA;AAAA;AAAA,EAKA,kCAAkC,OAAO,EAAE,OAAO,OAAO,MACvD,OAAO,OAAO,WAAW,oBAAoB,OAAO,EAAE,cAAc,MAAM,GAAG,CAAC;AAAA;AAAA;AAAA;AAAA,EAKhF,WAAW,OAAO,EAAE,MAAM,MAAM;AAClC;AAEA,IAAM,aAAa,OAAO,OAAO,KAAK;AAEtC,eAAsB,QACpB;AAAA,EACE;AAAA,EACA;AACF,GAIA,QACe;AACf,QAAM,EAAE,eAAe,IAAI;AAC3B,SAAO,KAAK,sBAAsB,cAAc,EAAE;AAClD,MAAI,QAAQ,MAAM,OAAO,OAAO,WAAW,cAAc,MAAM;AAAA,IAC7D,cAAc;AAAA,EAChB,CAAC;AAED,aAAW,QAAQ,WAAW,MAAM,WAAW,QAAQ,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG;AAC1E,QAAI,aAAa,MAAM,SAAS,WAAW;AACzC,aAAO,KAAK,qCAAqC;AACjD;AAAA,IACF;AACA,UAAM,QAAQ,WAAW,QAAQ,IAAI;AACrC,UAAM,eAAe,IAAI,QAAQ,GAAG,SAAS,EAAE,SAAS,GAAG,GAAG,CAAC,IAAI,WAAW,MAAM;AACpF,WAAO,KAAK,IAAI,YAAY,KAAK,KAAK,IAAI,EAAE;AAC5C,YAAQ,MAAM,KAAK,EAAE,QAAQ,MAAM,GAAG,MAAM;AAAA,EAC9C;AACF;","names":[]}

package/lib/types-BYNH6EdK.d.cts

@@ -0,0 +1,199 @@
+import { AppRouter, VaultRequestResponse, ApiChallenge, PsdUserCreationVaultRequestResponse, ClaimedRole, WrappingKeyResponse, PsdChallenge, OnboardingSeedChallenge } from '@ledgerhq/revault-api';
+import { D as Device } from './types-CsvE9Mlb.cjs';
+import { TRPCClient } from '@trpc/client';
+import { inferRouterOutputs, inferRouterInputs } from '@trpc/server';
+
+type TRPCClientOptions = {
+    baseUrl: string;
+    debugAuthToken?: string;
+    rootAuthToken?: string;
+    apiAccessToken?: string;
+    psdAuth?: string;
+};
+type RevaultApiTRPCClient = TRPCClient<AppRouter>;
+type RouterInputs = inferRouterInputs<AppRouter>;
+type RouterOutputs = inferRouterOutputs<AppRouter>;
+
+type EngineOptions = {
+    /**
+     * revault-api URL
+     */
+    baseUrl: string;
+    /**
+     * device-api URL
+     */
+    deviceApiUrl: string;
+    /**
+     * salt used by device-api
+     */
+    salt: string;
+    /**
+     * seed generation function used for device-api device spawn
+     */
+    genSeed: (p: {
+        salt: string;
+        index: number;
+    }) => string;
+};
+type EngineBase = {
+    /**
+     * revault-api client
+     */
+    client: RevaultApiTRPCClient;
+    /**
+     * Create a new revault-api client with the given options overriding the base ones
+     */
+    createClient: (opts: Partial<TRPCClientOptions>) => RevaultApiTRPCClient;
+};
+type EnhanceWithDevice<T> = T extends WithDevice | WithApiUser ? unknown : {
+    /**
+     * Mark the engine as targeting the given transport id for PSD communication.
+     * See `@ledgerhq/hw-transport` for more information.
+     *
+     * @param string transportId
+     */
+    withTransportId: (transportId: string) => Engine<T & WithDevice>;
+    /**
+     * Mark the engine as using device-api (for dev & test purposes) with the given device index.
+     *
+     * @param number deviceIndex
+     */
+    withDeviceIndex: (deviceIndex: number) => Engine<T & WithDevice>;
+};
+type EnhanceWithApiUser<T> = T extends WithDevice | WithApiUser | WithOnboarding ? unknown : {
+    /**
+     * Mark the engine as targeting API user
+     */
+    withApiUser: () => Engine<T & WithApiUser>;
+};
+type EnhanceWithOnboarding<T> = T extends WithOnboarding | WithWorkspace | WithApiUser ? unknown : {
+    /**
+     * Target the given onboarding id
+     *
+     * @param string Onboarding id
+     */
+    withOnboarding: (onboardingId: string) => Engine<T & WithOnboarding>;
+};
+type EnhanceWithWorkspace<T> = T extends WithWorkspace | WithOnboarding ? unknown : {
+    /**
+     * Target the given workspace
+     *
+     * @param string Workspace name
+     */
+    withWorkspace: (workspaceName: string) => Engine<T & WithWorkspace>;
+};
+type Decorate<T, TCond, TExtend> = T extends TCond ? TExtend : unknown;
+type Engine<T = unknown> = T & EngineBase & EnhanceWithDevice<T> & EnhanceWithApiUser<T> & EnhanceWithOnboarding<T> & EnhanceWithWorkspace<T> & Decorate<T, WithDevice, DecorateWithDevice<T>> & Decorate<T, WithWorkspace, DecorateWithWorkspace<T>> & Decorate<T, WithDevice & WithOnboarding, DecorateWithDeviceAndOnboarding>;
+type WithDevice = {
+    device: Device;
+};
+type DecorateWithDevice<T> = T extends WithWorkspace ? unknown : {
+    getWorkspaces: () => Promise<string[]>;
+};
+type WithApiUser = {
+    __isApiUser: true;
+};
+type RegisterOnboardingDeviceParams = {
+    role: "ADMIN" | "SHARED_OWNER";
+    name: string;
+};
+type WithOnboarding = {
+    __onboardingId: string;
+};
+type DecorateWithDeviceAndOnboarding = {
+    /**
+     * Claim the device as part of the onboarding
+     */
+    claimDevice: (p: {
+        role: ClaimedRole;
+        deviceName: string;
+    }) => Promise<void>;
+    /**
+     * Collect fragment of wrapping key
+     */
+    collectWrappingKeyFragment: (wrappingKey: WrappingKeyResponse) => Promise<void>;
+    /**
+     * Register device (either Admin or Shared-Owner)
+     */
+    registerDevice: (p: RegisterOnboardingDeviceParams) => Promise<void>;
+    /**
+     * Review Shared-Owner with Admin
+     */
+    reviewSharedOwner: (challenge: PsdChallenge) => Promise<void>;
+    /**
+     * Collect master seed fragment
+     */
+    collectSeedFragment: (challenge: OnboardingSeedChallenge) => Promise<void>;
+};
+type WithWorkspace = {
+    __workspaceName: string;
+};
+type DecorateWithWorkspace<T> = T extends WithPsdAuth | WithApiAuth ? DecorateWithWorkspaceAuthenticated<T> : DecorateWithWorkspaceUnauthenticated<T> & (T extends WithDevice ? DecorateWithDeviceAndWorkspaceUnauthenticated<T> : T extends WithApiUser ? DecorateWithApiUserAndWorkspaceUnauthenticated<T> : unknown);
+type DecorateWithWorkspaceUnauthenticated<T> = {
+    /**
+     * Directly pass a PsdAuth token
+     */
+    withPsdToken: (token: string) => Engine<T & WithPsdAuth>;
+};
+type DecorateWithWorkspaceAuthenticated<T> = T extends WithDevice ? DecorateWithWorkspacePsdAuthenticated : T extends WithApiUser ? DecorateWithWorkspaceApiAuthenticated : unknown;
+type ApproveRequestParams = {
+    onScreenDisplayed?: () => void;
+};
+type DecorateWithWorkspacePsdAuthenticated = {
+    /**
+     * Approve the given request
+     */
+    approve: (request: VaultRequestResponse, params?: ApproveRequestParams) => Promise<VaultRequestResponse>;
+    /**
+     * Reject the given request
+     */
+    reject: (request: VaultRequestResponse) => Promise<VaultRequestResponse>;
+};
+type DecorateWithWorkspaceApiAuthenticated = {
+    /**
+     * Get API challenge for the given request
+     */
+    getChallenge: (request: VaultRequestResponse) => Promise<ApiChallenge["payload"]>;
+    /**
+     * Approve the given request
+     */
+    approve: (request: VaultRequestResponse, signature: string) => Promise<VaultRequestResponse>;
+    /**
+     * Reject the given request
+     */
+    reject: (request: VaultRequestResponse, signature: string) => Promise<VaultRequestResponse>;
+};
+type DecorateWithDeviceAndWorkspaceUnauthenticated<T> = {
+    /**
+     * Login using the workspace & device that the engine are targeting
+     */
+    login: (opts?: {
+        validityDurationSecs?: number;
+        onScreenDisplayed?: () => void;
+    }) => Promise<Engine<T & WithPsdAuth>>;
+    /**
+     * Register the current device
+     */
+    register: (p: {
+        requestId: string;
+        role: "ADMIN" | "OPERATOR";
+        name: string;
+    }) => Promise<PsdUserCreationVaultRequestResponse>;
+};
+type WithPsdAuth = {
+    __psdToken: string;
+};
+type DecorateWithApiUserAndWorkspaceUnauthenticated<T> = {
+    /**
+     * Login using the workspace that the engine target and the given credentials
+     */
+    login: (credentials: {
+        apiKeyId: string;
+        apiKeySecret: string;
+    }) => Promise<Engine<T & WithApiAuth>>;
+};
+type WithApiAuth = {
+    __apiAuth: RouterOutputs["auth"]["authenticate"];
+};
+
+export type { ApproveRequestParams as A, DecorateWithDevice as D, Engine as E, RegisterOnboardingDeviceParams as R, WithOnboarding as W, EngineOptions as a, EngineBase as b, WithDevice as c, WithApiUser as d, DecorateWithDeviceAndOnboarding as e, WithWorkspace as f, DecorateWithWorkspace as g, DecorateWithWorkspaceUnauthenticated as h, DecorateWithWorkspacePsdAuthenticated as i, DecorateWithWorkspaceApiAuthenticated as j, DecorateWithDeviceAndWorkspaceUnauthenticated as k, WithPsdAuth as l, DecorateWithApiUserAndWorkspaceUnauthenticated as m, WithApiAuth as n, RouterInputs as o };

package/lib/types-CsvE9Mlb.d.cts

@@ -0,0 +1,159 @@
+import { PsdAuthChallengeResponse, PubKey, HsmCertificate, PsdPairingData } from '@ledgerhq/revault-api';
+
+type Device = {
+    /**
+     * Authenticate (resolve challenge for login)
+     */
+    authenticate: (opts: {
+        challenge: PsdAuthChallengeResponse;
+        workspaceName: string;
+    }) => Promise<string>;
+    /**
+     * Finalize pairing
+     */
+    finalizePairingHandshake: (opts: {
+        handshake: string;
+        ciphertext: string;
+    }) => Promise<string>;
+    /**
+     * Generate seed fragment from Shared-Owner device
+     */
+    generateSeedFragment: () => Promise<string>;
+    /**
+     * Generate Wrapping Key fragment from Wrapping-Key Owner device
+     */
+    generateWrappingKeyFragment: () => Promise<string>;
+    /**
+     * Get device attestation
+     */
+    getAttestation: () => Promise<{
+        attestation: {
+            codeHash: string;
+            attestationPub: string;
+            certificate: string;
+        };
+        buffer: Buffer;
+    }>;
+    /**
+     * Get device confidentiality key
+     */
+    getConfidentialityKey: () => Promise<{
+        confidentialityKeyCurve25519: string;
+        confidentialityKeySignature: string;
+    }>;
+    /**
+     * Get device confidentiality public key
+     */
+    getConfidentialityPubKey: () => Promise<{
+        pubKey: string;
+        signature: string;
+    }>;
+    /**
+     * Get device user id (the 16 chars user identifier displayed on Vault app)
+     */
+    getDeviceUserId: () => Promise<string>;
+    /**
+     * Get device U2F public key
+     */
+    getU2FPubKey: () => Promise<{
+        pubKey: string;
+        signature: string;
+    }>;
+    /**
+     * Get device validation public key
+     */
+    getValidationPubKey: () => Promise<{
+        pubKey: string;
+        signature: string;
+    }>;
+    /**
+     * Check is device has partition pairing
+     */
+    hasPairing: () => Promise<boolean>;
+    /**
+     * Initialize pairing handshake
+     */
+    initPairingHandshake: () => Promise<{
+        pubKey: string;
+        signature: string;
+    }>;
+    /**
+     * Open session
+     */
+    openSession: (opts: {
+        secureChannel: {
+            pubKey: PubKey;
+            certificate: HsmCertificate;
+        };
+    }) => Promise<void>;
+    /**
+     * Register device
+     */
+    register: (opts: {
+        challenge: string;
+        u2fRegisterData: string;
+        name: string;
+        role: "ADMIN" | "SHARED_OWNER" | "OPERATOR";
+    }) => Promise<{
+        u2fRegister: Buffer;
+        keyHandle: Buffer;
+        rfu: number;
+        pubKey: string;
+    }>;
+    /**
+     * Register data
+     */
+    registerData: (opts: {
+        challenge: string;
+    }) => Promise<string>;
+    /**
+     * Inject partition pairing
+     */
+    setPairing: (opts: {
+        pairing: PsdPairingData;
+    }) => Promise<void>;
+    /**
+     * Start KK pattern (related to noise channel)
+     */
+    startKKPatternAsResponder: (opts: {
+        handshake: string;
+        handshakeAttestation: HsmCertificate;
+        partitionId: string;
+    }) => Promise<{
+        handshake: string;
+        signature: string;
+    }>;
+    /**
+     * Start K pattern (related to noise channel)
+     */
+    startKPatternAsResponder: (opts: {
+        handshake: string;
+        handshakeAttestation: HsmCertificate;
+        partitionId: string;
+    }) => Promise<void>;
+    /**
+     * Approve with device
+     */
+    validateVaultOperation: (opts: {
+        actions: string[];
+    }) => Promise<string>;
+    /**
+     * Send arbitrary APDU
+     * apduCommand in HEX string format
+     */
+    sendAPDU: (apduCommand: string) => Promise<string>;
+    /**
+     * Poll device until it's plugged-on
+     *
+     */
+    poll: () => Promise<{
+        isAppOpened: boolean;
+    }>;
+    /**
+     * Returned when app is opened
+     * appName in string format
+     */
+    pollApp: (name: string) => Promise<string>;
+};
+
+export type { Device as D };