@ledgerhq/revault-api 1.20.0 → 1.21.0

package/lib/fakes.d.mts

@@ -1,5 +1,5 @@
 import { RequestType, VaultRequest, VaultRequestReview, Account } from '@prisma/client';
-import { y as UserChallenge, A as AccountResponse, s as VaultRequestResponse } from './app-types-Cvdd2De7.mjs';
+import { y as UserChallenge, A as AccountResponse, s as VaultRequestResponse } from './app-types-DxLEPfjw.mjs';
 import z__default from 'zod';
 
 declare const zCreateGroupRequestData: z__default.ZodObject<{

package/lib/fakes.mjs

@@ -4,6 +4,9 @@ import { ChallengeType, PsdModel, AccountType, AccountGovernanceType, Activation
 import 'axios';
 import invariant from 'invariant';
 import { omit, times } from 'lodash';
+import 'crypto';
+import 'fs/promises';
+import 'path';
 
 // src/__fakes__/responses.ts
 
@@ -85,28 +88,28 @@ var zUserRegistrationDeviceData = z.object({
   name: z.string().describe("Name of the user to register"),
   psdModel: z.nativeEnum(PsdModel).describe("Device model"),
   pubKey: zPubKey.describe("Device public key"),
-  confidentialityKey: zPubKey.describe("TODO describe"),
-  psdEphemeralKey: zPubKey.describe("TODO describe"),
-  psdEphemeralKeyAttestation: zHsmCertificate.describe("TODO describe")
-}).describe("TODO describe");
+  confidentialityKey: zPubKey,
+  psdEphemeralKey: zPubKey,
+  psdEphemeralKeyAttestation: zHsmCertificate
+}).describe("Data generated by the PSD to register on HSM");
 var zUserRegistrationChallenge = z.object({
-  challenge: z.string().describe("TODO describe"),
-  ephemeralPublicKey: zPubKey.describe("TODO describe"),
-  ephemeralPublicKeyAttestation: zHsmCertificate.describe("TODO describe"),
-  handshake: zHexString.describe("TODO describe"),
-  handshakeAttestation: zHsmCertificate.describe("TODO describe"),
-  u2fRegisterData: z.string().describe("TODO describe"),
-  ciphertext: z.string().describe("TODO describe"),
-  requestId: z.string().describe("TODO describe")
-}).describe("TODO describe");
+  challenge: z.string(),
+  ephemeralPublicKey: zPubKey,
+  ephemeralPublicKeyAttestation: zHsmCertificate,
+  handshake: zHexString,
+  handshakeAttestation: zHsmCertificate,
+  u2fRegisterData: z.string(),
+  ciphertext: z.string(),
+  requestId: z.string()
+}).describe("Challenge generated by HSM\xA0using the PSD registration data");
 z.object({
-  certificate: zHsmCertificate.describe("TODO describe"),
-  u2fRegister: zHexString.describe("TODO describe"),
-  u2fKeyHandle: zHexString.describe("TODO describe"),
-  registerData: z.string().describe("TODO describe"),
-  validationKey: zPubKey.describe("TODO describe"),
-  pairingPayload: z.string().describe("TODO describe")
-}).describe("TODO describe");
+  certificate: zHsmCertificate,
+  u2fRegister: zHexString,
+  u2fKeyHandle: zHexString,
+  registerData: z.string(),
+  validationKey: zPubKey,
+  pairingPayload: z.string()
+}).describe("Final registration response from PSD to HSM");
 z.object({
   confidentialityKeyCurve25519: z.string(),
   confidentialityKeySignature: z.string()
@@ -1208,6 +1211,11 @@ var serializeAccount = (account) => {
   };
   return zAccountResponse.parse(response);
 };
+var zRequestReviewStep = z.object({
+  stageName: z.string().regex(/^\w+$/).describe("The review stage name"),
+  quorum: z.number().int().min(1).describe("Quorum for the review step")
+});
+var zRequestReviewSteps = z.array(zRequestReviewStep);
 var zSciConfigData = z5.object({
   dapps: z5.array(z5.string()).nullable().describe("Allowed DApps, null allows all"),
   customContractCallEnabled: z5.boolean().describe("Allow non-DApp SCI")
@@ -1219,11 +1227,6 @@ var zCreateSciConfigRequestData = z5.object({
 var zEditSciConfigRequestData = z5.object({
   config: zSciConfigData
 });
-var zRequestReviewStep = z.object({
-  stageName: z.string().regex(/^\w+$/).describe("The review stage name"),
-  quorum: z.number().int().min(1).describe("Quorum for the review step")
-});
-var zRequestReviewSteps = z.array(zRequestReviewStep);
 var zGroupName = z5.string().min(1).max(19).describe("Group name");
 var zCreateGroupRequestData = z5.object({
   name: zGroupName,
@@ -1460,7 +1463,10 @@ var zVaultRequestMixinsByType = {
   }),
   [RequestType.CREATE_SETTLEMENT]: z5.object({
     type: z5.literal(RequestType.CREATE_SETTLEMENT),
-    data: zCreateSettlementRequestData
+    data: zCreateSettlementRequestData,
+    meta: z5.object({
+      hash: z5.string().nullable()
+    }).optional().nullable()
   }),
   [RequestType.FORCE_UNPLEDGE]: z5.object({
     type: z5.literal(RequestType.FORCE_UNPLEDGE),
@@ -1468,7 +1474,10 @@ var zVaultRequestMixinsByType = {
   }),
   [RequestType.TRADELINK_WITHDRAW]: z5.object({
     type: z5.literal(RequestType.TRADELINK_WITHDRAW),
-    data: zTradelinkWithdrawRequestData
+    data: zTradelinkWithdrawRequestData,
+    meta: z5.object({
+      hash: z5.string().nullable()
+    }).optional().nullable()
   }),
   // Deprecate ADMIN_GOV_RULE
   [RequestType.CREATE_ADMIN_GOV_RULE]: z5.object({
@@ -1502,7 +1511,13 @@ var zVaultRequestCommonMixin = z5.object({
   reviews: z5.array(zRequestReviewResponse).describe("Requests reviews"),
   // `type` and `data` are correlated -- See `zVaultRequestMixinsByType`
   createdAt: z5.coerce.date().describe("Creation timestamp"),
-  updatedAt: z5.coerce.date().describe("Last modification timestamp")
+  updatedAt: z5.coerce.date().describe("Last modification timestamp"),
+  // `inflight` is fetched from ONGOING RequestSaga
+  inflight: z5.object({
+    lastError: z5.string().describe("Error message from the last failure"),
+    numFailed: z5.number().int().describe("Number of failures so far"),
+    retryAfter: z5.coerce.date().describe("Date after which next retry is scheduled")
+  }).optional().describe("Extra information if the request is currently being processed")
 });
 var allowedRequestCreationInput = {
   [RequestType.CREATE_ADMIN]: zVaultRequestMixinsByType[RequestType.CREATE_ADMIN],
@@ -1679,12 +1694,16 @@ function serializeVaultRequest(request) {
     ...request,
     legacyId: request.gateId
   };
-  if (request.type === "CREATE_TRANSACTION") {
-    Object.assign(serialized, {
-      meta: {
-        hash: request.transactionMeta?.hash ?? null
-      }
-    });
+  switch (request.type) {
+    case "CREATE_TRANSACTION":
+    case "TRADELINK_WITHDRAW":
+    case "CREATE_SETTLEMENT":
+      Object.assign(serialized, {
+        meta: {
+          hash: request.transactionMeta?.hash ?? null
+        }
+      });
+      break;
   }
   return zVaultRequestResponse.parse(serialized);
 }