Automated Update for Version v1.15.0 (#189)

This PR contains automated updates to the internal API client and Sindri
manifest schema.

- **Raw API Version**: v1.15.0-rc2
- **Production API Version**: v1.15.0
- **Branch Name**: gha-automatic-update-206c260a7d3a79ce

Please review the changes, test new functionality manually, merge this
PR, and create a new release. Manual changes might be required if CI
fails.

If a new framework has been added, you will need to add a new response
type to the `CircuitInfoResponse` interface in `src/lib/client.ts`. You
may also need to re-record the test fixtures with `npm run test:record`
(export if not running against production and authenticate with first).

---------

Co-authored-by: GitHub Action <[email protected]>
Co-authored-by: Evan Sangaline <[email protected]>

sindri-manifest.json

@@ -845,6 +845,68 @@
       "enum": ["0.2.0", "0.2.1", "0.2.2"],
       "title": "Plonky2VersionOptions",
       "type": "string"
+    },
+    "Sp1ProvingSchemeOptions": {
+      "description": "The supported SP1 proving schemes.",
+      "enum": ["core", "compressed", "plonk", "groth16"],
+      "title": "Sp1ProvingSchemeOptions",
+      "type": "string"
+    },
+    "Sp1SindriManifest": {
+      "additionalProperties": false,
+      "description": "Sindri Manifest for SP1 program guest code.",
+      "properties": {
+        "circuitType": {
+          "const": "sp1",
+          "description": "The (frontend) development framework that your circuit is written with.",
+          "enum": ["sp1"],
+          "title": "Circuit Type",
+          "type": "string"
+        },
+        "name": {
+          "description": "The circuit name used to uniquely identify the circuit within your organization. Similar to a GitHub project name or a Docker image name.",
+          "error_messages": {
+            "pattern": "`name` must be a valid slug."
+          },
+          "pattern": "^[a-zA-Z0-9_-]+$",
+          "title": "Circuit Name",
+          "type": "string"
+        },
+        "provingScheme": {
+          "allOf": [
+            {
+              "$ref": "#/$defs/Sp1ProvingSchemeOptions"
+            }
+          ],
+          "default": "core",
+          "description": "The default SP1 proof type returned to the user is `core`."
+        },
+        "sp1Version": {
+          "allOf": [
+            {
+              "$ref": "#/$defs/Sp1VersionOptions"
+            }
+          ],
+          "default": "3.0.0",
+          "description": "SP1 version defaults to '3.0.0'"
+        },
+        "$schema": {
+          "type": "string",
+          "title": "Sindri Manifest JSON Schema URL",
+          "description": "The URL pointing to a Sindri JSON Manifest schema definition.",
+          "examples": ["https://sindri.app/api/v1/sindri-manifest-schema.json"]
+        }
+      },
+      "required": ["circuitType", "name"],
+      "title": "Sindri Manifest for SP1 guest code",
+      "type": "object"
+    },
+    "Sp1VersionOptions": {
+      "const": "3.0.0",
+      "description": "The supported SP1 zkVM versions.",
+      "enum": ["3.0.0"],
+      "title": "Sp1VersionOptions",
+      "type": "string"
     }
   },
   "anyOf": [
@@ -874,6 +936,9 @@
     },
     {
       "$ref": "#/$defs/Plonky2SindriManifest"
+    },
+    {
+      "$ref": "#/$defs/Sp1SindriManifest"
     }
   ],
   "description": "Sindri Manifest file schema for `sindri.json` files.",

src/lib/api/ApiClient.ts

@@ -29,7 +29,7 @@ export class ApiClient {
   ) {
     this.request = new HttpRequest({
       BASE: config?.BASE ?? "https://sindri.app",
-      VERSION: config?.VERSION ?? "1.14.5",
+      VERSION: config?.VERSION ?? "1.15.0",
       WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
       CREDENTIALS: config?.CREDENTIALS ?? "include",
       TOKEN: config?.TOKEN,

src/lib/api/core/OpenAPI.ts

@@ -27,7 +27,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
   BASE: "https://sindri.app",
-  VERSION: "1.14.5",
+  VERSION: "1.15.0",
   WITH_CREDENTIALS: false,
   CREDENTIALS: "include",
   TOKEN: undefined,

src/lib/api/index.ts

@@ -47,13 +47,18 @@ export type { ProjectListInput } from "./models/ProjectListInput";
 export type { ProjectSettingsInput } from "./models/ProjectSettingsInput";
 export type { ProofCannotBeCreatedResponse } from "./models/ProofCannotBeCreatedResponse";
 export type { ProofDoesNotExistResponse } from "./models/ProofDoesNotExistResponse";
+export type { ProofHistogramInput } from "./models/ProofHistogramInput";
+export type { ProofHistogramResponse } from "./models/ProofHistogramResponse";
 export type { ProofInfoResponse } from "./models/ProofInfoResponse";
 export type { ProofListInput } from "./models/ProofListInput";
 export type { ProofStatusResponse } from "./models/ProofStatusResponse";
 export type { Schema } from "./models/Schema";
 export type { SmartContractVerifierResponse } from "./models/SmartContractVerifierResponse";
+export type { Sp1CircuitInfoResponse } from "./models/Sp1CircuitInfoResponse";
 export type { TeamDetail } from "./models/TeamDetail";
 export type { TeamDoesNotExistResponse } from "./models/TeamDoesNotExistResponse";
+export type { TeamMemberDetail } from "./models/TeamMemberDetail";
+export type { TeamMembersResponse } from "./models/TeamMembersResponse";
 export type { TeamMeResponse } from "./models/TeamMeResponse";
 export type { TokenObtainPairInputSchema } from "./models/TokenObtainPairInputSchema";
 export type { TokenObtainPairOutputSchema } from "./models/TokenObtainPairOutputSchema";

src/lib/api/models/APIKeyDoesNotExistResponse.ts

@@ -10,5 +10,6 @@
 export type APIKeyDoesNotExistResponse = {
   apikey_id: string;
   error: string;
+  exception_id?: string;
   message: string;
 };

src/lib/api/models/APIKeyErrorResponse.ts

@@ -8,6 +8,7 @@
  * Error: User does not exist or password is incorrect.
  */
 export type APIKeyErrorResponse = {
-  username: string;
+  exception_id?: string;
   message?: string;
+  username: string;
 };

src/lib/api/models/CircuitDoesNotExistResponse.ts

@@ -9,6 +9,7 @@
  */
 export type CircuitDoesNotExistResponse = {
   error: string;
+  exception_id?: string;
   circuit_id: string;
   message: string;
 };

src/lib/api/models/CircuitInfoResponse.ts

@@ -10,6 +10,7 @@ import type { Halo2CircuitInfoResponse } from "./Halo2CircuitInfoResponse";
 import type { JoltCircuitInfoResponse } from "./JoltCircuitInfoResponse";
 import type { NoirCircuitInfoResponse } from "./NoirCircuitInfoResponse";
 import type { Plonky2CircuitInfoResponse } from "./Plonky2CircuitInfoResponse";
+import type { Sp1CircuitInfoResponse } from "./Sp1CircuitInfoResponse";
 
 /**
  * Response for getting circuit info.
@@ -21,4 +22,5 @@ export type CircuitInfoResponse =
   | GnarkCircuitInfoResponse
   | JoltCircuitInfoResponse
   | NoirCircuitInfoResponse
-  | Plonky2CircuitInfoResponse;
+  | Plonky2CircuitInfoResponse
+  | Sp1CircuitInfoResponse;

src/lib/api/models/CircuitIsNotReadyResponse.ts

@@ -8,7 +8,8 @@
  * Error: The circuit is not ready to accept proofs
  */
 export type CircuitIsNotReadyResponse = {
-  error: string;
   circuit_id: string;
+  error: string;
+  exception_id?: string;
   message?: string;
 };

src/lib/api/models/CircuitType.ts

@@ -13,4 +13,5 @@ export type CircuitType =
   | "halo2"
   | "jolt"
   | "noir"
-  | "plonky2";
+  | "plonky2"
+  | "sp1";

src/lib/api/models/ComingSoonResponse.ts

@@ -7,5 +7,6 @@
  * Response for NotImplementedError
  */
 export type ComingSoonResponse = {
+  exception_id?: string;
   message?: string;
 };

src/lib/api/models/ForgeInternalErrorResponse.ts

@@ -7,6 +7,6 @@
  * Response for ForgeInternalError
  */
 export type ForgeInternalErrorResponse = {
-  error: string;
+  exception_id?: string;
   message?: string;
 };

src/lib/api/models/ForgeInvalidUploadResponse.ts

@@ -8,5 +8,6 @@
  */
 export type ForgeInvalidUploadResponse = {
   error: string;
+  exception_id?: string;
   message?: string;
 };

src/lib/api/models/ForgeValueErrorResponse.ts

@@ -8,5 +8,6 @@
  */
 export type ForgeValueErrorResponse = {
   error: string;
+  exception_id?: string;
   message?: string;
 };

src/lib/api/models/JWTTokenErrorResponse.ts

@@ -8,6 +8,7 @@
  * Error: User does not exist or password is incorrect.
  */
 export type JWTTokenErrorResponse = {
-  username: string;
   detail?: string;
+  exception_id?: string;
+  username: string;
 };

src/lib/api/models/ProjectDoesNotExistResponse.ts

@@ -9,6 +9,7 @@
  */
 export type ProjectDoesNotExistResponse = {
   error: string;
-  project_id: string;
+  exception_id?: string;
   message: string;
+  project_id: string;
 };

src/lib/api/models/ProofCannotBeCreatedResponse.ts

@@ -9,5 +9,6 @@
  */
 export type ProofCannotBeCreatedResponse = {
   error: string;
+  exception_id?: string;
   message?: string;
 };

src/lib/api/models/ProofDoesNotExistResponse.ts

@@ -9,6 +9,7 @@
  */
 export type ProofDoesNotExistResponse = {
   error: string;
-  proof_id: string;
+  exception_id?: string;
   message: string;
+  proof_id: string;
 };

src/lib/api/models/ProofHistogramInput.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Client input for filtering proof histograms.
+ */
+export type ProofHistogramInput = {
+  /**
+   * The bin size in seconds.
+   */
+  bin_size?: number;
+  /**
+   * Limit to proofs created on/after this timezone-aware, ISO8601 formatted time.
+   */
+  start_time: string;
+  /**
+   * Limit to proofs created on/before this timezone-aware, ISO8601 formatted time. Defaults to now.
+   */
+  end_time?: string | null;
+};

src/lib/api/models/ProofHistogramResponse.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Response for producing proof histograms.
+ */
+export type ProofHistogramResponse = {
+  /**
+   * The bin size in seconds.
+   */
+  bin_size: number;
+  /**
+   * A list of dictionaries in the format:</br>
+   * ```
+   * {
+   * 'bin': '2021-01-01T00:00:00Z',
+   * 'ready': 2,
+   * 'failed': 1,
+   * 'in_progress': 3,
+   * 'queued': 4,
+   * }
+   * ```</br>
+   * where 'bin' is an ISO8601 timestamp indicating the start
+   * of the bin, and proof status keys (e.g. 'ready') indicating
+   * the number of proofs with that status in the bin.
+   */
+  data: Array<Record<string, any>>;
+  /**
+   * The end of the histogram in timezone-aware ISO8601 format.
+   */
+  end_time: string;
+  /**
+   * The start of the histogram in timezone-aware ISO8601 format.
+   */
+  start_time: string;
+};