@layer-drone/protocol 0.3.0 → 0.6.0

package/src/client/types.gen.ts

@@ -9,6 +9,7 @@ export type CreateApiTokenResponseDto = {
   scopes: Array<
     | "manageTokens"
     | "manageFlights"
+    | "manageFlightReviews"
     | "manageFlightPlans"
     | "manageMissions"
     | "manageVaults"
@@ -16,6 +17,10 @@ export type CreateApiTokenResponseDto = {
     | "manageContracts"
     | "redrive"
     | "updateOnChainData"
+    | "syncEventProcessorState"
+    | "manageZones"
+    | "manageProposals"
+    | "approveProposals"
     | "all"
   >;
 };
@@ -25,6 +30,7 @@ export type CreateApiTokenRequestDto = {
   scopes: Array<
     | "manageTokens"
     | "manageFlights"
+    | "manageFlightReviews"
     | "manageFlightPlans"
     | "manageMissions"
     | "manageVaults"
@@ -32,6 +38,10 @@ export type CreateApiTokenRequestDto = {
     | "manageContracts"
     | "redrive"
     | "updateOnChainData"
+    | "syncEventProcessorState"
+    | "manageZones"
+    | "manageProposals"
+    | "approveProposals"
     | "all"
   >;
   orgId: number;
@@ -42,6 +52,7 @@ export type UpdateApiTokenRequestDto = {
   scopes?: Array<
     | "manageTokens"
     | "manageFlights"
+    | "manageFlightReviews"
     | "manageFlightPlans"
     | "manageMissions"
     | "manageVaults"
@@ -49,6 +60,10 @@ export type UpdateApiTokenRequestDto = {
     | "manageContracts"
     | "redrive"
     | "updateOnChainData"
+    | "syncEventProcessorState"
+    | "manageZones"
+    | "manageProposals"
+    | "approveProposals"
     | "all"
   >;
 };
@@ -62,6 +77,7 @@ export type UpdateApiTokenResponseDto = {
   scopes: Array<
     | "manageTokens"
     | "manageFlights"
+    | "manageFlightReviews"
     | "manageFlightPlans"
     | "manageMissions"
     | "manageVaults"
@@ -69,6 +85,10 @@ export type UpdateApiTokenResponseDto = {
     | "manageContracts"
     | "redrive"
     | "updateOnChainData"
+    | "syncEventProcessorState"
+    | "manageZones"
+    | "manageProposals"
+    | "approveProposals"
     | "all"
   >;
 };
@@ -296,6 +316,16 @@ export type FlightDto = {
   block_number: number;
   block_timestamp: number;
   transaction_hash: string;
+  payout: {
+    id: string;
+    missionId: string;
+    flightReviewId: string;
+    recipient: string;
+    amount: string;
+    tokenContractAddress: string;
+    chainId: number;
+    createdAt: Date;
+  };
 };
 
 export type CreateFileRequestDto = {
@@ -502,10 +532,43 @@ export type CreateFlightPlanResponse = {
   updated_at: Date;
 };
 
+export type GetFlightReviewResponseDto = {
+  flightId: string;
+  owner: string;
+  validator: string;
+  isApproved: boolean;
+  storageKey: string;
+  filesHash: string;
+  missionId: string;
+  validationLogUri: string;
+  contractAddress: string;
+  chainId: number;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+export type GetFlightReviewsResponseDto = {
+  flightReviews: Array<{
+    flightId: string;
+    owner: string;
+    validator: string;
+    isApproved: boolean;
+    storageKey: string;
+    filesHash: string;
+    missionId: string;
+    validationLogUri: string;
+    contractAddress: string;
+    chainId: number;
+    createdAt: Date;
+    updatedAt: Date;
+  }>;
+};
+
 export type GetProvenanceCryptoKeyResponse = {
   KeyId: string;
   PublicKey: string;
   KeySpec?:
+    | "ECC_NIST_EDWARDS25519"
     | "ECC_NIST_P256"
     | "ECC_NIST_P384"
     | "ECC_NIST_P521"
@@ -514,6 +577,9 @@ export type GetProvenanceCryptoKeyResponse = {
     | "HMAC_256"
     | "HMAC_384"
     | "HMAC_512"
+    | "ML_DSA_44"
+    | "ML_DSA_65"
+    | "ML_DSA_87"
     | "RSA_2048"
     | "RSA_3072"
     | "RSA_4096"
@@ -529,6 +595,83 @@ export type GetProvenanceCryptoKeyResponse = {
   >;
 };
 
+export type GetMissionResponseDto = {
+  id: string;
+  vaultId: string;
+  requestor: string;
+  zoneId: string;
+  isOpen: boolean;
+  flightPlanId: number;
+  isReservable: boolean;
+  tags: {
+    [key: string]: string;
+  };
+  captureStartTime: Date;
+  captureEndTime: Date;
+  campaigns: Array<string>;
+  contractAddress: string;
+  chainId: number;
+  createdAt: Date;
+  updatedAt: Date;
+  payout: {
+    id: string;
+    recipient: string;
+    amount: string;
+    flightReviewId: string;
+    createdAt: Date;
+  };
+  vault: {
+    id: string;
+    amount: string;
+    collateralTokenAddress: string;
+    funder: string;
+    contractAddress: string;
+    chainId: number;
+    createdAt: Date;
+    updatedAt: Date;
+  };
+};
+
+export type GetMissionsResponseDto = {
+  missions: Array<{
+    id: string;
+    vaultId: string;
+    requestor: string;
+    zoneId: string;
+    isOpen: boolean;
+    flightPlanId: number;
+    isReservable: boolean;
+    tags: {
+      [key: string]: string;
+    };
+    captureStartTime: Date;
+    captureEndTime: Date;
+    campaigns: Array<string>;
+    contractAddress: string;
+    chainId: number;
+    createdAt: Date;
+    updatedAt: Date;
+    payout: {
+      id: string;
+      recipient: string;
+      amount: string;
+      flightReviewId: string;
+      createdAt: Date;
+    };
+    vault: {
+      id: string;
+      amount: string;
+      collateralTokenAddress: string;
+      funder: string;
+      contractAddress: string;
+      chainId: number;
+      createdAt: Date;
+      updatedAt: Date;
+    };
+  }>;
+  hasNextPage: boolean;
+};
+
 export type CreateMissionRequestDto = {
   missions: Array<{
     zoneId: string;
@@ -539,7 +682,7 @@ export type CreateMissionRequestDto = {
     endTime: Date;
     collateralToken: string;
     decimals: number;
-    isReservable: boolean;
+    isReservable?: boolean;
     tags?: {
       [key: string]: string;
     };
@@ -555,6 +698,7 @@ export type CreateMissionResponseDto = {
       id: string;
       vaultId: string;
       amount: string;
+      collateralToken: string;
       zoneId: string;
       flightPlanId: number;
       campaigns: Array<string>;
@@ -679,6 +823,7 @@ export type GetWebhooksResponse = Array<{
   active: boolean;
   failure_count: number;
   last_failure_reason: string;
+  previous_secret_expires_at: Date;
   created_at: string;
   updated_at: string;
 }>;
@@ -699,6 +844,7 @@ export type GetWebhookResponse = {
   active: boolean;
   failure_count: number;
   last_failure_reason: string;
+  previous_secret_expires_at: Date;
   created_at: string;
   updated_at: string;
 };
@@ -734,6 +880,7 @@ export type UpdateWebhookResponse = {
   active: boolean;
   failure_count: number;
   last_failure_reason: string;
+  previous_secret_expires_at: Date;
   created_at: string;
   updated_at: string;
 };
@@ -742,8 +889,15 @@ export type DeleteWebhookResponse = {
   message: string;
 };
 
+export type RegenerateWebhookSecretBody =
+  | {
+      previous_secret_expires_at?: Date;
+    }
+  | unknown;
+
 export type RegenerateWebhookSecretResponseDto = {
   secret: string;
+  previous_secret_expires_at: Date;
 };
 
 export type TestWebhookResponse = {
@@ -755,6 +909,51 @@ export type GetWebhookStatusResponse = {
   error?: string;
 };
 
+export type CreateZoneDto = {
+  id: string;
+  region_id: number;
+  is_flyable?: boolean;
+};
+
+export type ZoneResponseDto = {
+  id: string;
+  region_id: number;
+  is_flyable: boolean;
+  created_at: Date;
+  updated_at: Date;
+};
+
+export type UpdateZoneDto = {
+  is_flyable: boolean;
+};
+
+export type SyncEventProcessorMissionsRequestDto = {
+  missionIds: Array<string>;
+  missionDataContractAddress: string;
+  missionEscrowContractAddress: string;
+};
+
+export type SyncEventProcessorMissionsResponseDto = {
+  succeeded: Array<string>;
+  failed: Array<{
+    missionId: string;
+    error: string;
+  }>;
+};
+
+export type SyncEventProcessorFlightReviewsRequestDto = {
+  flightIds: Array<string>;
+  flightReviewContractAddress: string;
+};
+
+export type SyncEventProcessorFlightReviewsResponseDto = {
+  succeeded: Array<string>;
+  failed: Array<{
+    flightId: string;
+    error: string;
+  }>;
+};
+
 export type AlchemyWebhookBodyDto = {
   [key: string]: unknown;
 };
@@ -1323,6 +1522,53 @@ export type FlightPlansControllerGetResponses = {
 export type FlightPlansControllerGetResponse =
   FlightPlansControllerGetResponses[keyof FlightPlansControllerGetResponses];
 
+export type FlightReviewsControllerGetFlightReviewData = {
+  body?: never;
+  path: {
+    id: bigint;
+  };
+  query?: never;
+  url: "/flight-reviews/{id}";
+};
+
+export type FlightReviewsControllerGetFlightReviewErrors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Flight review not found
+   */
+  404: unknown;
+};
+
+export type FlightReviewsControllerGetFlightReviewResponses = {
+  200: GetFlightReviewResponseDto;
+};
+
+export type FlightReviewsControllerGetFlightReviewResponse =
+  FlightReviewsControllerGetFlightReviewResponses[keyof FlightReviewsControllerGetFlightReviewResponses];
+
+export type FlightReviewsControllerGetFlightReviewsData = {
+  body?: never;
+  path?: never;
+  query: {
+    updated_at_gt: Date;
+    updated_at_lt: Date;
+  };
+  url: "/flight-reviews";
+};
+
+export type FlightReviewsControllerGetFlightReviewsErrors = {
+  401: unknown;
+  403: unknown;
+};
+
+export type FlightReviewsControllerGetFlightReviewsResponses = {
+  200: GetFlightReviewsResponseDto;
+};
+
+export type FlightReviewsControllerGetFlightReviewsResponse =
+  FlightReviewsControllerGetFlightReviewsResponses[keyof FlightReviewsControllerGetFlightReviewsResponses];
+
 export type KeysControllerGetProvenanceCryptoKeyData = {
   body?: never;
   path?: never;
@@ -1337,6 +1583,70 @@ export type KeysControllerGetProvenanceCryptoKeyResponses = {
 export type KeysControllerGetProvenanceCryptoKeyResponse =
   KeysControllerGetProvenanceCryptoKeyResponses[keyof KeysControllerGetProvenanceCryptoKeyResponses];
 
+export type MissionsControllerGetMissionData = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: {
+    relations?:
+      | "vault"
+      | "payout"
+      | "campaigns"
+      | Array<"vault" | "payout" | "campaigns">;
+  };
+  url: "/missions/{id}";
+};
+
+export type MissionsControllerGetMissionErrors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Mission not found
+   */
+  404: unknown;
+};
+
+export type MissionsControllerGetMissionResponses = {
+  200: GetMissionResponseDto;
+};
+
+export type MissionsControllerGetMissionResponse =
+  MissionsControllerGetMissionResponses[keyof MissionsControllerGetMissionResponses];
+
+export type MissionsControllerGetMissionsData = {
+  body?: never;
+  path?: never;
+  query?: {
+    updatedAt_gt?: Date;
+    updatedAt_lt?: Date;
+    createdAt_gt?: Date;
+    createdAt_lt?: Date;
+    isOpen?: string;
+    zoneIds?: string | Array<string>;
+    flightPlanId?: number;
+    page?: number;
+    relations?:
+      | "vault"
+      | "payout"
+      | "campaigns"
+      | Array<"vault" | "payout" | "campaigns">;
+  };
+  url: "/missions";
+};
+
+export type MissionsControllerGetMissionsErrors = {
+  401: unknown;
+  403: unknown;
+};
+
+export type MissionsControllerGetMissionsResponses = {
+  200: GetMissionsResponseDto;
+};
+
+export type MissionsControllerGetMissionsResponse =
+  MissionsControllerGetMissionsResponses[keyof MissionsControllerGetMissionsResponses];
+
 export type MissionsControllerCreateMissionsData = {
   body: CreateMissionRequestDto;
   path?: never;
@@ -1494,20 +1804,6 @@ export type SchemaControllerGetEventSchemaResponses = {
   200: unknown;
 };
 
-export type SchemaControllerGetFlightPlanSchemaData = {
-  body?: never;
-  path?: never;
-  query?: never;
-  url: "/schema/flight-plan";
-};
-
-export type SchemaControllerGetFlightPlanSchemaResponses = {
-  /**
-   * Get flight plan schema
-   */
-  200: unknown;
-};
-
 export type VaultsControllerCreateVaultsData = {
   body: CreateVaultsRequestDto;
   path?: never;
@@ -1647,7 +1943,7 @@ export type WebhooksControllerUpdateResponse =
   WebhooksControllerUpdateResponses[keyof WebhooksControllerUpdateResponses];
 
 export type WebhooksControllerRegenerateSecretData = {
-  body?: never;
+  body: RegenerateWebhookSecretBody;
   path: {
     org_id: number;
     id: number;
@@ -1712,6 +2008,132 @@ export type WebhooksControllerGetStatusResponses = {
 export type WebhooksControllerGetStatusResponse =
   WebhooksControllerGetStatusResponses[keyof WebhooksControllerGetStatusResponses];
 
+export type ZonesControllerCreateZoneData = {
+  body: CreateZoneDto;
+  path?: never;
+  query?: never;
+  url: "/zones";
+};
+
+export type ZonesControllerCreateZoneErrors = {
+  /**
+   * Invalid zone id (must be a valid level-9 H3 cell)
+   */
+  400: unknown;
+  401: unknown;
+  403: unknown;
+  /**
+   * Zone already exists
+   */
+  409: unknown;
+};
+
+export type ZonesControllerCreateZoneResponses = {
+  201: ZoneResponseDto;
+};
+
+export type ZonesControllerCreateZoneResponse =
+  ZonesControllerCreateZoneResponses[keyof ZonesControllerCreateZoneResponses];
+
+export type ZonesControllerDeleteZoneData = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/zones/{id}";
+};
+
+export type ZonesControllerDeleteZoneErrors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Zone not found
+   */
+  404: unknown;
+};
+
+export type ZonesControllerDeleteZoneResponses = {
+  /**
+   * Zone deleted
+   */
+  204: void;
+};
+
+export type ZonesControllerDeleteZoneResponse =
+  ZonesControllerDeleteZoneResponses[keyof ZonesControllerDeleteZoneResponses];
+
+export type ZonesControllerUpdateZoneData = {
+  body: UpdateZoneDto;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/zones/{id}";
+};
+
+export type ZonesControllerUpdateZoneErrors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Zone not found
+   */
+  404: unknown;
+};
+
+export type ZonesControllerUpdateZoneResponses = {
+  200: ZoneResponseDto;
+};
+
+export type ZonesControllerUpdateZoneResponse =
+  ZonesControllerUpdateZoneResponses[keyof ZonesControllerUpdateZoneResponses];
+
+export type EventProcessorMissionsSyncControllerResyncMissionsData = {
+  body: SyncEventProcessorMissionsRequestDto;
+  path?: never;
+  query?: never;
+  url: "/event-processor/missions/sync";
+};
+
+export type EventProcessorMissionsSyncControllerResyncMissionsErrors = {
+  401: unknown;
+  403: unknown;
+};
+
+export type EventProcessorMissionsSyncControllerResyncMissionsResponses = {
+  /**
+   * Per-mission success or failure.
+   */
+  200: SyncEventProcessorMissionsResponseDto;
+};
+
+export type EventProcessorMissionsSyncControllerResyncMissionsResponse =
+  EventProcessorMissionsSyncControllerResyncMissionsResponses[keyof EventProcessorMissionsSyncControllerResyncMissionsResponses];
+
+export type EventProcessorFlightReviewsSyncControllerResyncFlightReviewsData = {
+  body: SyncEventProcessorFlightReviewsRequestDto;
+  path?: never;
+  query?: never;
+  url: "/event-processor/flightreviews";
+};
+
+export type EventProcessorFlightReviewsSyncControllerResyncFlightReviewsErrors =
+  {
+    401: unknown;
+    403: unknown;
+  };
+
+export type EventProcessorFlightReviewsSyncControllerResyncFlightReviewsResponses =
+  {
+    /**
+     * Per-flight success or failure.
+     */
+    200: SyncEventProcessorFlightReviewsResponseDto;
+  };
+
+export type EventProcessorFlightReviewsSyncControllerResyncFlightReviewsResponse =
+  EventProcessorFlightReviewsSyncControllerResyncFlightReviewsResponses[keyof EventProcessorFlightReviewsSyncControllerResyncFlightReviewsResponses];
+
 export type AlchemyControllerHandleWebhookData = {
   body: AlchemyWebhookBodyDto;
   path?: never;

package/src/event/parser.ts

@@ -2,28 +2,80 @@ import type { Request } from "express";
 
 import { Event } from "./types.gen";
 
-const WEBHOOK_SECRET_HEADER = "X-Webhook-Secret";
+/** Primary signing secret for this delivery (current secret). */
+export const WEBHOOK_SECRET_HEADER = "X-Webhook-Secret";
 
+/**
+ * During rotation, the prior secret value still valid for receivers who have not
+ * updated their stored secret yet (must be sent together with the expiry header).
+ */
+export const WEBHOOK_PREVIOUS_SECRET_HEADER = "X-Webhook-Previous-Secret";
+
+/**
+ * ISO-8601 instant; after this time the previous secret must no longer be accepted.
+ */
+export const WEBHOOK_PREVIOUS_SECRET_EXPIRES_AT_HEADER =
+  "X-Webhook-Previous-Secret-Expires-At";
+
+/**
+ * Verify an inbound webhook using the signing secret your app has configured.
+ *
+ * Compares `X-Webhook-Secret` to `webhookSecret`. If that fails, checks optional
+ * rotation headers from LayerDrone: when both `X-Webhook-Previous-Secret` and
+ * `X-Webhook-Previous-Secret-Expires-At` are present, the request is accepted if
+ * your configured secret still matches the announced previous secret (same value
+ * as in `X-Webhook-Previous-Secret`) and the expiry has not passed.
+ */
 export function parseWebhookEvent(req: Request, webhookSecret: string) {
-  const secret = getSecretHeader(req.headers);
-  if (typeof secret !== "string") {
+  const incoming = getFirstHeader(req.headers, WEBHOOK_SECRET_HEADER);
+  if (typeof incoming !== "string") {
     throw new Error("Webhook request signature is not a string");
   }
   if (!Buffer.isBuffer(req.body)) {
     throw new Error("Webhook request body is not a Buffer");
   }
-  if (secret !== webhookSecret) {
+
+  if (incoming === webhookSecret) {
+    return Event.parse(JSON.parse(req.body.toString("utf-8")));
+  }
+
+  const announcedPrevious = getFirstHeader(
+    req.headers,
+    WEBHOOK_PREVIOUS_SECRET_HEADER,
+  );
+  const expiresRaw = getFirstHeader(
+    req.headers,
+    WEBHOOK_PREVIOUS_SECRET_EXPIRES_AT_HEADER,
+  );
+
+  if (announcedPrevious === undefined || expiresRaw === undefined) {
     throw new Error("Invalid webhook secret");
   }
-  return Event.parse(JSON.parse(req.body.toString("utf-8")));
+
+  const expiresAt = new Date(expiresRaw);
+  if (Number.isNaN(expiresAt.getTime())) {
+    throw new Error("Invalid webhook secret");
+  }
+
+  if (Date.now() >= expiresAt.getTime()) {
+    throw new Error("Invalid webhook secret");
+  }
+
+  if (webhookSecret === announcedPrevious) {
+    return Event.parse(JSON.parse(req.body.toString("utf-8")));
+  }
+
+  throw new Error("Invalid webhook secret");
 }
 
-function getSecretHeader(headers: Request["headers"]) {
-  let value =
-    headers[WEBHOOK_SECRET_HEADER] ??
-    headers[WEBHOOK_SECRET_HEADER.toLowerCase()];
+function getFirstHeader(
+  headers: Request["headers"],
+  canonicalName: string,
+): string | undefined {
+  const lower = canonicalName.toLowerCase();
+  let value = headers[canonicalName] ?? headers[lower];
   if (Array.isArray(value)) {
     value = value[0];
   }
-  return value;
+  return typeof value === "string" ? value : undefined;
 }