import { WrapOptions } from 'retry'; export { WrapOptions as RetryOptions } from 'retry'; import { z } from 'zod'; import { BaseLogger } from 'pino'; export { BaseLogger as Logger } from 'pino'; import { File as File$1 } from 'buffer'; type ApiRequestOptions = { readonly method: "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD" | "PATCH"; readonly url: string; readonly path?: Record; readonly cookies?: Record; readonly headers?: Record; readonly query?: Record; readonly formData?: Record; readonly body?: any; readonly mediaType?: string; readonly responseHeader?: string; readonly errors?: Record; readonly responseType?: // DO NOT REMOVE "arraybuffer" | "blob" | "document" | "json" | "text" | "stream"; }; interface OnCancel { readonly isResolved: boolean; readonly isRejected: boolean; readonly isCancelled: boolean; (cancelHandler: () => void): void; } declare class CancelablePromise implements Promise { #private; constructor(executor: (resolve: (value: T | PromiseLike) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void); get [Symbol.toStringTag](): string; then(onFulfilled?: ((value: T) => TResult1 | PromiseLike) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike) | null): Promise; catch(onRejected?: ((reason: any) => TResult | PromiseLike) | null): Promise; finally(onFinally?: (() => void) | null): Promise; cancel(): void; get isCancelled(): boolean; } type Resolver = (options: ApiRequestOptions) => Promise; type Headers = Record; type OpenAPIConfig = { BASE: string; VERSION: string; WITH_CREDENTIALS: boolean; CREDENTIALS: "include" | "omit" | "same-origin"; TOKEN?: string | Resolver | undefined; USERNAME?: string | Resolver | undefined; PASSWORD?: string | Resolver | undefined; HEADERS?: Headers | Resolver | undefined; ENCODE_PATH?: ((path: string) => string) | undefined; sindri?: SindriClient; }; declare abstract class BaseHttpRequest { readonly config: OpenAPIConfig; constructor(config: OpenAPIConfig); abstract request(options: ApiRequestOptions): CancelablePromise; } /** * Generic response for any client action. * E.g. job submission, patch, delete */ type ActionResponse = { success?: boolean; }; /** * Response containing an API key. * * This key is used in conjunction with the APIKey model * to authenticate users in the API. */ type APIKeyResponse = { /** * The API key. Will be `null` unless the key was created during the request. Keys are not stored in plaintext and can not be recovered after creation time. */ api_key: string | null; /** * The date that the API key was created. */ date_created: string; /** * The date that the API key will automatically expire. */ date_expires: string | null; /** * The last time that the API key was used to authenticate with the API. */ date_last_used: string | null; /** * The database ID for the API key. Used when deleting keys. */ id: string; /** * The human-readable name for the API key used for managing keys. */ name: string; /** * The non-secret key prefix. */ prefix: string; /** * The non-secret key suffix. Helpful for identifying keys if a name wasn't specified at creation time. */ suffix: string; }; /** * Client input to obtain an API key. */ type ObtainApikeyInput = { /** * Your account username. */ username: string; /** * Your account password. */ password: string; /** * A human readable name for your API key used to identify it when managing keys. */ name?: string; }; declare class AuthorizationService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Generate API Key * Generates a long-term API Key from your account's username and password. * @param requestBody * @param sindriTeamId Optional. Team ID for the API key. * @returns APIKeyResponse OK * @throws ApiError */ apikeyGenerate(requestBody: ObtainApikeyInput, sindriTeamId?: string | null): CancelablePromise; /** * API Key Generate * Generate an API key for the requesting team. * @param name An optional name or tag to assign to the generated API Key. * @returns APIKeyResponse Created * @throws ApiError */ apikeyGenerateWithAuth(name?: string): CancelablePromise; /** * API Key List * List API keys for the requesting team. * @returns APIKeyResponse OK * @throws ApiError */ apikeyList(): CancelablePromise>; /** * API Key Delete * Delete a specific API key. * @param apikeyId The UUID4 identifier associated with this API Key. * @returns ActionResponse OK * @throws ApiError */ apikeyDelete(apikeyId: string): CancelablePromise; } /** * JobStatus choices */ type JobStatus = "Queued" | "In Progress" | "Ready" | "Failed"; /** * Response for getting Boojum circuit info. */ type BoojumCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "boojum"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The field over which proofs take place. */ field: string | null; /** * The zkSync Era zkEVM version tag. */ zkevm_version: string | null; }; /** * Response for getting Circom circuit info. */ type CircomCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "circom"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The elliptic curve over which the proving protocol takes place. */ curve: string; /** * The number of constraints in the Rank-1 Constraint System (R1CS) of the circuit. */ num_constraints: number | null; /** * The number of public outputs from the circuit. */ num_outputs: number | null; /** * The number of private inputs for the circuit. */ num_private_inputs: number | null; /** * The number of public inputs for the circuit. */ num_public_inputs: number | null; }; /** * Response for getting Gnark circuit info. */ type GnarkCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "gnark"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The elliptic curve over which the proving protocol takes place. */ curve: string; /** * The Gnark frontend version tag. */ gnark_version: string; }; /** * Response for getting Halo2 circuit info. */ type Halo2CircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "halo2"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The path to the circuit struct definition. This is specified during creation in the included sindri.json file. */ class_name: string; /** * The elliptic curve over which the proving protocol takes place. */ curve: string; /** * The log_2 of the number of rows in the circuit, expressed as a matrix. */ degree: number; /** * The Halo2 frontend version tag. */ halo2_version: string; }; /** * Response for getting Polygon Hermez circuit info. */ type HermezCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "hermez"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The Polygon Hermez zkEVM version tag. */ zkevm_version: string | null; }; /** * Response for getting Jolt circuit info. */ type JoltCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "jolt"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The commitment scheme used in the Jolt zkVM prover. */ commitment_scheme: string; /** * Whether the Rust standard library is enabled for the guest code. */ std_enabled: boolean; /** * The Jolt frontend version tag. */ jolt_version: string; /** * The name of the circuit project specified in the included Cargo.toml file. */ package_name: string; /** * The name of the guest function in the user's uploaded guest code. */ guest_function: string; }; /** * Response for getting Noir circuit info. */ type NoirCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "noir"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The number of opcodes in the intermediate representation. */ acir_opcodes: number | null; /** * The number of constraints with an instantiated proving backend in the circuit. */ circuit_size: number | null; /** * The elliptic curve over which the proving protocol takes place. */ curve: string; /** * The name of the circuit project specified in the included Nargo.toml file. */ nargo_package_name: string; /** * The Noir frontend version tag. */ noir_version: string; }; /** * Response for getting OpenVM circuit info. */ type OpenvmCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "openvm"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The OpenVM frontend version tag. */ openvm_version: string; }; /** * Response for getting Plonky2 circuit info. */ type Plonky2CircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "plonky2"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The path to the circuit struct definition. This is specified during creation in the included sindri.json file. */ struct_name: string; /** * The Plonky2 frontend version tag. */ plonky2_version: string; }; /** * Response for getting SnarkVM circuit info. */ type SnarkvmCircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "snarkvm"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The main.aleo function name. */ function_name: string; /** * The network. */ network: string; }; /** * Response for getting SP1 circuit info. */ type Sp1CircuitInfoResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the sindri.json file. */ project_name: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: "sp1"; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The URL of the homepage for the team or project. */ homepage: string | null; /** * Metadata keys and values for the circuit that were specified at creation time. */ meta: Record; /** * The number of proofs submitted for this circuit. */ num_proofs: number | null; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * Whether the circuit is public. Public circuits can be used by any user. */ public: boolean; /** * The URL of a code repository for the circuit. */ repository: string | null; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * Tags for the circuit. */ tags: Array; /** * The name of the team that owns this circuit. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this circuit. */ team_avatar_url: string; /** * The name of the team that owns this circuit. */ team_name: string; /** * The slug of the team that owns this circuit. */ team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time: string | null; /** * Total compute time in seconds. */ compute_time_sec: number | null; /** * Detailed compute times for the circuit compilation. */ compute_times: null; /** * Total size of stored file(s) in bytes. */ file_size: number | null; /** * Queue time in ISO8601 format. */ queue_time: string | null; /** * Queue time in seconds. */ queue_time_sec: number | null; /** * The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload. */ uploaded_file_name: string; /** * Boolean indicating whether this circuit has a smart contract verifier available. */ has_smart_contract_verifier: boolean; /** * Boolean indicating whether this circuit has a verification key available. */ has_verification_key: boolean; /** * The verification key of this circuit. */ verification_key: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings: Array | null; /** * The error message for a failed circuit upload. */ error: string | null; /** * The SP1 frontend version tag. */ sp1_version: string; }; /** * Response for getting circuit info. */ type CircuitInfoResponse$1 = BoojumCircuitInfoResponse | CircomCircuitInfoResponse | Halo2CircuitInfoResponse | HermezCircuitInfoResponse | GnarkCircuitInfoResponse | JoltCircuitInfoResponse | NoirCircuitInfoResponse | OpenvmCircuitInfoResponse | Plonky2CircuitInfoResponse | SnarkvmCircuitInfoResponse | Sp1CircuitInfoResponse; /** * Client input to prove a circuit. */ type CircuitProveInput = { /** * An arbitrary mapping of metadata keys to string values. This can be used to track additional information about the proof such as an ID from an external system. */ meta?: Record; /** * An object mapping proof input variable names to their values. Can be a raw JSON object or a string serialized as JSON or TOML. */ proof_input: Record | string; /** * A boolean indicating whether to perform an internal verification check during the proof creation. */ perform_verify?: boolean; /** * Internal prover implementation setting. */ prover_implementation?: string; }; /** * CircuitType choices */ type CircuitType = "boojum" | "circom" | "gnark" | "halo2" | "hermez" | "jolt" | "noir" | "openvm" | "plonky2" | "snarkvm" | "sp1"; /** * Response for getting proof info. */ type ProofInfoResponse = { /** * A unique identifier generated for the proof. UUID4 format. */ proof_id: string; /** * @deprecated */ circuit_name: string; /** * The name of the project associated with this proof. */ project_name: string; /** * The circuit_id of the circuit associated with this proof. UUID4 format. */ circuit_id: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: CircuitType; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * Metadata keys and values for the proof that were specified at creation time. */ meta: Record; /** * A boolean indicating whether an internal verification check occurred during the proof creation. */ perform_verify: boolean; /** * The status of the proof job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; /** * The status of proof verification. */ verified: boolean | null; /** * The name of the team that owns this proof. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this proof. */ team_avatar_url: string; /** * The name of the team that owns this proof. */ team_name: string; /** * The slug of the team that owns this proof. */ team_slug: string; /** * The name of the team that owns the circuit associated with this proof. */ circuit_team: string; /** * URL for the avatar image of the team that owns the circuit associated with this proof. */ circuit_team_avatar_url: string; /** * The slug of the team that owns the circuit associated with this proof. */ circuit_team_slug: string; /** * Total compute time in ISO8601 format. */ compute_time?: string | null; /** * Total compute time in seconds. */ compute_time_sec?: number | null; /** * Detailed compute times for the proof generation. */ compute_times?: null; /** * Total size of stored file(s) in bytes. */ file_size?: number | null; /** * The succinct argument(s) of knowledge. */ proof?: Record | null; /** * The public outputs of the circuit. */ public?: null; /** * Queue time in ISO8601 format. */ queue_time?: string | null; /** * Queue time in seconds. */ queue_time_sec?: number | null; /** * The proof and public formatted as calldata for the smart contract verifier. */ smart_contract_calldata?: string | null; /** * Boolean indicating whether this proof has smart contract calldata available. */ has_smart_contract_calldata?: boolean; /** * Boolean indicating whether this proof's circuit has a verification key available. */ has_verification_key?: boolean; /** * The verification key of this circuit. */ verification_key?: Record | null; /** * A list of runtime warnings with UTC timestamps. */ warnings?: Array | null; /** * The error message for a failed proof. */ error?: string | null; }; declare class CircuitsService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Create Circuit * Create a circuit. * @param formData * @returns CircuitInfoResponse Created * @throws ApiError */ circuitCreate(formData: FormData | { files: Array; /** * An arbitrary mapping of metadata keys to string values. This can be used to track additional information about the circuit such as an ID from an external system. */ meta?: Record; /** * Tags for a circuit. */ tags?: Array; }): CancelablePromise; /** * Circuit List * List all circuits owned by team. * @returns CircuitInfoResponse OK * @throws ApiError */ circuitList(): CancelablePromise>; /** * Circuit Detail * Get info for an existing circuit. * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @param includeVerificationKey Indicates whether to include the verification key in the response. * @returns CircuitInfoResponse OK * @throws ApiError */ circuitDetail(circuitId: string, includeVerificationKey?: boolean): CancelablePromise; /** * Delete Circuit * Delete a circuit. * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @returns ActionResponse OK * @throws ApiError */ circuitDelete(circuitId: string): CancelablePromise; /** * Circuit Proofs * List all proofs for a circuit. * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @returns ProofInfoResponse OK * @throws ApiError */ circuitProofs(circuitId: string): CancelablePromise>; /** * Create Proof for Circuit * Prove a circuit with specific inputs. * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @param requestBody * @returns ProofInfoResponse Created * @throws ApiError */ proofCreate(circuitId: string, requestBody: CircuitProveInput): CancelablePromise; } /** * Response for getting circuit status. */ type CircuitStatusResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * The status of the circuit job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; }; type PagedCircuitInfoResponse = { items: Array; count: number; }; /** * Response for a project's latest circuit. */ type ProjectLatestCircuitResponse = { /** * A unique identifier generated for the circuit. UUID4 format. */ circuit_id: string; /** * The development framework used to write the circuit. This is specified during creation in the included sindri.json file. */ circuit_type: CircuitType; /** * The UTC datetime the circuit was uploaded in ISO8601 format. */ date_created: string; /** * The proving scheme for this circuit. This is specified during creation in the included sindri.json file. */ proving_scheme: string; /** * The status of the circuit job. */ status: JobStatus; }; /** * Response for getting project info. */ type ProjectInfoResponse = { /** * The UTC datetime the project was created in ISO8601 format. */ date_created: string; /** * Whether the project is public. */ is_public: boolean; /** * Labels for the project. */ labels: Array; /** * The most recent circuit tagged "latest" or the most recently created circuit if no circuit is tagged "latest". */ latest_circuit?: ProjectLatestCircuitResponse | null; /** * The name of the project. */ name: string; /** * The number of proofs created for this project. */ num_proofs: number | null; /** * A unique identifier generated for the project. UUID4 format. */ project_id: string; /** * Tags for the project. */ tags: Array; /** * The name of the team that owns this project. * @deprecated */ team: string; /** * URL for the avatar image of the team that owns this project. */ team_avatar_url: string; /** * The name of the team that owns this project. */ team_name: string; /** * The slug of the team that owns this project. */ team_slug: string; }; type PagedProjectInfoResponse = { items: Array; count: number; }; type PagedProofInfoResponse = { items: Array; count: number; }; /** * Client input to change their password. */ type PasswordChangeInput = { /** * Old password. */ old_password: string; /** * New password. */ new_password: string; }; /** * Client input for filtering project list. */ type ProjectListInput = { /** * Return projects owned by this team. * @deprecated */ team_name?: string | null; /** * Return projects owned by this team. */ team_slug?: string | null; }; /** * Client input to update project settings. */ type ProjectSettingsInput = { /** * Whether the project is public. */ is_public?: boolean | null; /** * The name of the project. */ name?: string | null; /** * List of labels to associate with the project. */ labels?: Array | null; }; /** * Client input for filtering proof histograms. */ 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; }; /** * Response for producing proof histograms. */ type ProofHistogramResponse = { /** * The bin size in seconds. */ bin_size: number; /** * A list of dictionaries in the format:
* ``` * { * 'bin': '2021-01-01T00:00:00Z', * 'ready': 2, * 'failed': 1, * 'in_progress': 3, * 'queued': 4, * } * ```
* 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>; /** * 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; }; /** * Client input for filtering proofs. */ type ProofListInput = { /** * Return proofs created after this date. */ date_created_after?: string | null; /** * Return proofs created before this date. */ date_created_before?: string | null; /** * Return proofs for this project. */ project_name?: string | null; /** * Return proofs with this job status. */ status?: JobStatus | null; }; /** * Response for getting proof status. */ type ProofStatusResponse = { /** * A unique identifier generated for the proof. UUID4 format. */ proof_id: string; /** * The status of the proof job. */ status: JobStatus; /** * The job is finished processing and waiting/polling can be terminated. */ finished_processing: boolean; }; /** * Response providing the smart contract verifier code. */ type SmartContractVerifierResponse = { /** * The smart contract verifier code. */ contract_code: string | null; }; /** * Client input to create a team. */ type TeamCreateInput = { /** * A description of the team. */ description?: string; /** * The display name of the team. */ display_name?: string; /** * The unique slug for the team (used for routing). */ slug: string; }; /** * Details about a team. */ type TeamDetail = { /** * URL for the team's avatar image. */ avatar_url: string; /** * The date that the team was created. */ date_created: string; description: string; /** * The URL for the team's github account. */ github_url: string; id: number; /** * Whether the team is a personal team. */ is_personal: boolean; /** * The name of the team. */ name: string; /** * The number of projects owned by the team. */ num_projects: number; /** * The number of proofs submitted by the team. */ num_proofs: number | null; /** * Whether the team is a Sindri corporate team. */ sindri_corporate: boolean; /** * The slug for the team (used for routing). */ slug: string; /** * The URL for the team's Twitter account. */ twitter_url: string; /** * The URL for the team's website. */ url: string; }; /** * Client input to invite a user to a team. */ type TeamInviteInput = { /** * The email address of the user to invite. */ email: string; }; /** * Details about a team member. */ type TeamMemberDetail = { email: string; username: string; }; /** * Details about a team's members. */ type TeamMembersResponse = { team_slug: string; members: Array; }; /** * Details about the currently authenticated team. */ type TeamMeResponse = { team: TeamDetail; }; /** * Client input to remove a user from a team. */ type TeamRemoveMemberInput = { /** * The slug of the team to remove the user from. */ team_slug: string; /** * The username of the user to remove. */ username: string; }; /** * Client input to update team settings. */ type TeamSettingsInput = { /** * The display name of the team. */ display_name?: string | null; /** * The URL for the team's github account. This is displayed on the team page. */ github_url?: string; /** * The URL for the team's Twitter account. This is displayed on the team page. */ twitter_url?: string | null; /** * The URL for the team's website. This is displayed on the team page. */ url?: string | null; }; /** * Client input to get logged in. */ type UserLoginInput = { /** * Your account username. */ username: string; /** * Your account password. */ password: string; }; /** * Details about the currently authenticated user. */ type UserMeResponse = { id: number; first_name: string; last_name: string; /** * The username of the user. */ username: string; /** * The email address of the user. */ email: string; /** * The date that the user joined Sindri. */ date_joined: string; /** * The teams that the user is a member of. */ teams: Array; }; type BinaryResponseType = typeof globalThis extends { ReadableStream: unknown; } ? Blob : NodeJS.ReadableStream; declare class InternalService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Circuit File Download * Obtain circuit file(s). * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @param path The optional file path within the circuit package to download. * @returns any OK * @throws ApiError */ circuitDownload(circuitId: string, path?: string): CancelablePromise; /** * Circuit Proofs * List all proofs for a circuit. * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @param limit The number of proofs to return. * @param offset The number of proofs to skip. * @returns PagedProofInfoResponse OK * @throws ApiError */ circuitProofsPaginated(circuitId: string, limit?: number, offset?: number): CancelablePromise; /** * Project Circuits * List all circuits for a project. * @param projectId The project identifer of the project. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for a project. * 2. `/` - The name of a project owned by the specified team. * @returns CircuitInfoResponse OK * @throws ApiError */ projectCircuits(projectId: string): CancelablePromise>; /** * Project Circuits * List all circuits for a project. * @param projectId The project identifer of the project. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for a project. * 2. `/` - The name of a project owned by the specified team. * @param limit The number of circuits to return. * @param offset The number of circuits to skip. * @returns PagedCircuitInfoResponse OK * @throws ApiError */ projectCircuitsPaginated(projectId: string, limit?: number, offset?: number): CancelablePromise; /** * Delete Project * Delete a project. * @param projectId The project identifer of the project. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for a project. * 2. `/` - The name of a project owned by the specified team. * @returns ActionResponse OK * @throws ApiError */ projectDelete(projectId: string): CancelablePromise; /** * Project Detail * Get info for a project. * @param projectId The project identifer of the project. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for a project. * 2. `/` - The name of a project owned by the specified team. * @returns ProjectInfoResponse OK * @throws ApiError */ projectDetail(projectId: string): CancelablePromise; /** * Project List * List all projects meeting filter criteria. * @param requestBody * @returns ProjectInfoResponse OK * @throws ApiError */ projectList(requestBody: ProjectListInput): CancelablePromise>; /** * Project List * List all projects meeting filter criteria. * @param requestBody * @param limit The number of projects to return. * @param offset The number of projects to skip. * @returns PagedProjectInfoResponse OK * @throws ApiError */ projectListPaginated(requestBody: ProjectListInput, limit?: number, offset?: number): CancelablePromise; /** * Project Proofs * Get all proofs for a project. * @param projectId The project identifer of the project. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for a project. * 2. `/` - The name of a project owned by the specified team. * @returns ProofInfoResponse OK * @throws ApiError */ projectProofs(projectId: string): CancelablePromise>; /** * Project Proofs * Get all proofs for a project. * @param projectId The project identifer of the project. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for a project. * 2. `/` - The name of a project owned by the specified team. * @param limit The number of proofs to return. * @param offset The number of proofs to skip. * @returns PagedProofInfoResponse OK * @throws ApiError */ projectProofsPaginated(projectId: string, limit?: number, offset?: number): CancelablePromise; /** * Update Project Settings * Update project settings. * @param projectName The name of a project associated with the team. * @param requestBody * @returns ProjectInfoResponse OK * @throws ApiError */ projectSettings(projectName: string, requestBody: ProjectSettingsInput): CancelablePromise; /** * Circuit Smart Contract Verifier * Get smart contract verifier for existing circuit * @param circuitId The circuit identifer of the circuit. * This can take one of the following forms: * * 1. `` - The unique UUID4 ID for an exact version of a compiled circuit. * 2. `` - The name of a circuit owned by the authenticated team. This will default to * the most recent version of the circuit tagged as `latest`. * 3. `:` - The name of a circuit owned by the authenticated team and an explicit * tag. This corresponds to the most recent compilation of the circuit with the specified tag. * 4. `/` - The name of a circuit owned by the specified team. This will * default to the most recent version of the circuit tagged as `latest`. * 5. `/:` - The name of a circuit owned by a specified team and an * explicit tag. This corresponds to the most recent compilation of the team's circuit with the * specified tag. * @returns SmartContractVerifierResponse OK * @throws ApiError */ circuitSmartContractVerifier(circuitId: string): CancelablePromise; /** * Circuit Status * Get status for a specific circuit. * @param circuitId The UUID4 identifier associated with this circuit. * @returns CircuitStatusResponse OK * @throws ApiError */ circuitStatus(circuitId: string): CancelablePromise; /** * Change Password * Change user password. Requires user authentication. * @param requestBody * @returns ActionResponse OK * @throws ApiError */ passwordChangeWithJwtAuth(requestBody: PasswordChangeInput): CancelablePromise; /** * Proof Histogram * Get histogram data for a team's proofs. * @param requestBody * @returns ProofHistogramResponse OK * @throws ApiError */ proofHistogram(requestBody: ProofHistogramInput): CancelablePromise; /** * Proof List * List proofs for the requesting team. * @param requestBody * @returns ProofInfoResponse OK * @throws ApiError */ proofList(requestBody: ProofListInput): CancelablePromise>; /** * Proof List * List proofs for the requesting team. * @param requestBody * @param limit The number of proofs to return. * @param offset The number of proofs to skip. * @returns PagedProofInfoResponse OK * @throws ApiError */ proofListPaginated(requestBody: ProofListInput, limit?: number, offset?: number): CancelablePromise; /** * Proof Status * Get status for a specific proof. * @param proofId The UUID4 identifier associated with this proof. * @returns ProofStatusResponse OK * @throws ApiError */ proofStatus(proofId: string): CancelablePromise; /** * Sindri Manifest Schema * Return Sindri manifest schema as JSON. * @returns any OK * @throws ApiError */ sindriManifestSchema(): CancelablePromise>; /** * Avatar Upload * Upload avatar for the team * @param formData * @returns TeamMeResponse Created * @throws ApiError */ teamAvatarUpload(formData: { files: Array; }): CancelablePromise; /** * Create Team * Create a new team * @param requestBody * @param sindriTeamId Required for Sindri JWT authentication. * @returns TeamDetail Created * @throws ApiError */ teamCreate(requestBody: TeamCreateInput, sindriTeamId?: string | null): CancelablePromise; /** * Team Detail * Return details for the specified team * @param teamSlug * @returns TeamDetail OK * @throws ApiError */ teamDetail(teamSlug: string): CancelablePromise; /** * Team Invite * Invite an email address to join the specified team * @param requestBody * @param sindriTeamId Required for Sindri JWT authentication. * @returns ActionResponse OK * @throws ApiError */ teamInvite(requestBody: TeamInviteInput, sindriTeamId?: string | null): CancelablePromise; /** * Team Me * Obtain team details for the currently authenticated team * @returns TeamMeResponse OK * @throws ApiError */ teamMe(): CancelablePromise; /** * Team Members * Return member list for the specified team * @param teamSlug * @param sindriTeamId Required for Sindri JWT authentication. * @returns TeamMembersResponse OK * @throws ApiError */ teamMembers(teamSlug: string, sindriTeamId?: string | null): CancelablePromise; /** * Team Remove Member * Remove a user from the specified team. Revokes all team API keys if the removed user was the last team member. * @param requestBody * @param sindriTeamId Required for Sindri JWT authentication. * @returns ActionResponse OK * @throws ApiError */ teamRemoveMember(requestBody: TeamRemoveMemberInput, sindriTeamId?: string | null): CancelablePromise; /** * Update Team Settings * Update team settings. * @param requestBody * @returns TeamDetail OK * @throws ApiError */ teamSettings(requestBody: TeamSettingsInput): CancelablePromise; /** * Login User * Login a user. * @param requestBody * @returns ActionResponse OK * @throws ApiError */ userLogin(requestBody: UserLoginInput): CancelablePromise; /** * Logout User * Logout a user. * @returns ActionResponse OK * @throws ApiError */ userLogout(): CancelablePromise; /** * User Me * Obtain user details. Requires user authentication. * @returns UserMeResponse OK * @throws ApiError */ userMe(): CancelablePromise; } declare class ProofsService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Proof Detail * Get info for a specific proof. * @param proofId The UUID4 identifier associated with this proof. * @param includeProof Indicates whether to include the proof in the response. * @param includePublic Indicates whether to include public inputs in the response. * @param includeSmartContractCalldata Indicates whether to include the proof and public formatted as smart contract calldata in the response. * @param includeVerificationKey Indicates whether to include the circuit's verification key in the response. * @returns ProofInfoResponse OK * @throws ApiError */ proofDetail(proofId: string, includeProof?: boolean, includePublic?: boolean, includeSmartContractCalldata?: boolean, includeVerificationKey?: boolean): CancelablePromise; /** * Delete Proof * Delete a specific proof. * @param proofId The UUID4 identifier associated with this proof. * @returns ActionResponse OK * @throws ApiError */ proofDelete(proofId: string): CancelablePromise; } type Schema = {}; type TokenObtainPairInputSchema = { password: string; /** * Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */ username: string; }; type TokenObtainPairOutputSchema = { /** * Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. */ username: string; refresh: string; access: string; }; type TokenRefreshInputSchema = { refresh: string; }; type TokenRefreshOutputSchema = { refresh: string; access: string | null; }; type TokenVerifyInputSchema = { token: string; }; declare class TokenService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Verify Token * @param requestBody * @returns Schema OK * @throws ApiError */ jwtTokenVerify(requestBody: TokenVerifyInputSchema): CancelablePromise; /** * Generate JWT Token Pair * Override the ninja_jwt default `obtain_token` method in order to * add email verification check before generating a token. * @param requestBody * @returns TokenObtainPairOutputSchema OK * @throws ApiError */ jwtTokenGenerate(requestBody: TokenObtainPairInputSchema): CancelablePromise; /** * Refresh Token * @param requestBody * @returns TokenRefreshOutputSchema OK * @throws ApiError */ jwtTokenRefresh(requestBody: TokenRefreshInputSchema): CancelablePromise; } type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest; declare class ApiClient { readonly authorization: AuthorizationService; readonly circuits: CircuitsService; readonly internal: InternalService; readonly proofs: ProofsService; readonly token: TokenService; readonly request: BaseHttpRequest; constructor(config?: Partial, HttpRequest?: HttpRequestConstructor); } /** * The minimum log level to print. */ type LogLevel = "silent" | "fatal" | "error" | "warn" | "info" | "debug" | "trace"; declare const ConfigSchema: z.ZodObject<{ auth: z.ZodDefault>>; }, "strip", z.ZodTypeAny, { auth: { apiKey: string; apiKeyId: string; apiKeyName: string; baseUrl: string; teamId: number; teamSlug: string; } | null; }, { auth?: { apiKey: string; apiKeyId: string; apiKeyName: string; baseUrl: string; teamId: number; teamSlug: string; } | null | undefined; }>; type ConfigSchema = z.infer; declare class Config { protected _config: ConfigSchema; protected readonly logger: BaseLogger | undefined; constructor(logger?: BaseLogger); get auth(): ConfigSchema["auth"]; get config(): ConfigSchema; reload(): void; update(configData: Partial): void; } type BrowserFile = File; declare const File: typeof File$1 | { new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): File; prototype: File; }; type Meta = Record; type CircuitInfoResponse = BoojumCircuitInfoResponse | CircomCircuitInfoResponse | Halo2CircuitInfoResponse | HermezCircuitInfoResponse | JoltCircuitInfoResponse | GnarkCircuitInfoResponse | NoirCircuitInfoResponse | OpenvmCircuitInfoResponse | Plonky2CircuitInfoResponse | SnarkvmCircuitInfoResponse | Sp1CircuitInfoResponse; /** * The options for authenticating with the API. */ interface AuthOptions { /** * The API key to use for authentication. */ apiKey?: string; /** * The base URL for the API. */ baseUrl?: string; } /** * Represents the primary client for interacting with the Sindri ZKP service API. This class serves * as the central entry point for the SDK, facilitating various operations such as compiling ZKP * circuits and generating proofs. * * The {@link SindriClient} class encapsulates all the necessary methods and properties required to * communicate effectively with the Sindri ZKP service, handling tasks like authentication, request * management, and response processing. * * Usage of this class typically involves instantiating it with appropriate authentication options * and then utilizing its methods to interact with the service. * * @example * // Create an instance of the `SindriClient` class. * const client = new SindriClient({ apiKey: 'your-api-key' }); * * // Use the client to interact with the Sindri ZKP service... */ declare class SindriClient { /** @hidden */ readonly _client: ApiClient; /** @hidden */ readonly _clientConfig: OpenAPIConfig; /** @hidden */ readonly _config: Config | undefined; readonly logger: BaseLogger; /** * Represents the polling interval in milliseconds used for querying the status of an endpoint. * This value determines the frequency at which the SDK polls an endpoint to check for any changes * in status. * * The choice of polling interval is critical for balancing responsiveness against resource * consumption. A shorter interval leads to more frequent updates, beneficial for * rapidly-changing statuses, but at the expense of higher network and computational load. In * contrast, a longer interval reduces resource usage but may delay the detection of status * changes. * * For more complex ZKP circuits, which may take longer to compile, considering a larger polling * interval could be advantageous. This approach minimizes unnecessary network traffic and * computational effort while awaiting the completion of these time-intensive operations. * * The default value is set to 1000 milliseconds (1 second), offering a general balance. However, * it can and should be adjusted based on the expected complexity and compilation time of the * circuits being processed. */ pollingInterval: number; /** * Represents the options for retrying requests to the Sindri ZKP service. * * See the [`retry` package](https://www.npmjs.com/package/retry#retrytimeoutsoptions) * documentation for more information on the available options. The values here are the defaults, * but they can be replaced with custom values in the constructor. */ retryOptions: WrapOptions; /** * Constructs a new instance of the {@link SindriClient} class for interacting with the Sindri ZKP * service. This constructor initializes the client with the necessary authentication options. * * The provided `authOptions` parameter allows for specifying authentication credentials and * configurations required for the client to communicate securely with the service. See * {@link SindriClient.authorize} for more details about how authentication credentials are sourced. * * @param authOptions - The authentication options for the client, including * credentials like API keys or tokens. Defaults to an empty object if not provided. * * @example * // Instantiating the SindriClient with authentication options * const client = new SindriClient({ apiKey: 'sindri-...-fskd' }); * * @see {@link SindriClient.authorize} for information on retrieving this value. */ constructor(authOptions?: AuthOptions, { retryOptions }?: { retryOptions?: WrapOptions; }); /** * Retrieves the current value of the client's API key used for authenticating with the Sindri ZKP * service. This property is crucial for ensuring secure communication with the API and is * typically set during client initialization. * * If the API key is not set or is in an invalid format (not a string), this getter returns * `null`. Proper management of the API key is essential for the security and proper functioning * of the SDK. * * @returns The current API key if set and valid, otherwise `null`. * * @example * const currentApiKey = client.apiKey; * if (currentApiKey) { * console.log('API Key is set.'); * } else { * console.log('API Key is not set or is invalid.'); * } */ get apiKey(): string | null; /** * Retrieves the current base URL of the Sindri ZKP service that the client is configured to * interact with. This URL forms the foundation of all API requests made by the client and is * typically set during client initialization. Anyone other than employees at Sindri can typically * ignore this and use the default value of `https://sindri.app`. * * @returns The current base URL of the Sindri ZKP service. * * @example * console.log(`Current base URL: ${client.baseUrl}`); */ get baseUrl(): string; /** Retrieves the current log level of the client. The log level determines the verbosity of logs * produced by the client which can be crucial for debugging and monitoring the client's * interactions with the Sindri ZKP service. * * @returns The current log level of the client. * * @example * console.log(`Current log level: ${client.logLevel}`); */ get logLevel(): LogLevel; /** * Sets the client's log level. This level determines the verbosity of logs produced by the * client, allowing for flexible control over the amount of information logged during operation. * * @param level - The new log level to set for the client. * * @example * // Set log level to debug. * client.logLevel = "debug"; */ set logLevel(level: LogLevel); /** * Authorizes the client with the Sindri ZKP service using the provided authentication options. * This method is called automatically after initializing a client, but you may call it again if * you would like to change the credentials. The logic around how credentials is as follows: * * 1. Any explicitly specified options in `authOptions` are always used if provided. * 2. The `SINDRI_API_KEY` and `SINDRI_BASE_URL` environment variables are checked next. * 3. The settings in `sindri.conf.json` (produced by running `sindri login` on the command-line) will be checked after that. * 4. Finally, the default value of `https://sindri.app` will be used for the base URL (this is * typically what you want unless you're an employee at Sindri). The API key will remain unset and * you will only be able to make requests that allow anonymous access. * * * @param authOptions - The authentication details required to authorize the client. * @returns True if authorization is successful, false otherwise. * * @example * const authOptions = { apiKey: 'sindri-...-jskd' }; * const isAuthorized = client.authorize(authOptions); * if (isAuthorized) { * console.log('Client is fully authorized.'); * } else { * console.log('Client is not authorized.'); * } */ authorize(authOptions: AuthOptions): boolean; /** * Creates a new {@link SindriClient} client instance. The class itself is not exported, so use * this method on the exported (or any other) client instance to create a new instance. The new * instance can be configured and used completely independently from any other instances. For * example it can use different credentials or a different log level. * * @param authOptions - The authentication options for the client, including * credentials like API keys or tokens. Defaults to an empty object if not provided. * @param options - Additional options for configuring the client. * @param options.retryOptions - The options related to retrying a request. * * @example * import sindri from 'sindri'; * * // Equivalent to: const myClient = new SindriClient({ ... }); * const myClient = sindri.create({ apiKey: 'sindri-mykey-1234'}); * * @returns The new client instance. */ create(authOptions: AuthOptions | undefined, options: { retryOptions?: WrapOptions; } | undefined): SindriClient; /** * Asynchronously creates and deploys a new circuit, initiating its compilation process. This * method is essential for submitting new versions of circuits to the Sindri ZKP service for * compilation. Upon deployment, it continuously polls the service to track the compilation status * until the process either completes successfully or fails. * * The method accepts two parameters: `project` and `tags`. The `project` parameter can be either * a string representing the path to the project or an array of files (browser or Node.js file * objects) constituting the circuit. The `tags` parameter is used to assign tags to the deployed * circuit, facilitating versioning and identification. By default, the circuit is tagged as * "latest". * * After successful deployment and compilation, the method returns a `CircuitInfoResponse` object, * which includes details about the compiled circuit, such as its identifier and status. * * @param project - In Node.js, this can either be a path to the root * directory of a Sindri project, the path to a gzipped tarball containing the project, or an * array of `buffer.File` objects. In a web browser, it can only be an array of `File` objects. * @param tags - The list of tags, or singular tag if a string is passed, that * should be associated with the deployed circuit. Defaults to `["latest"]`. Specify an empty * array to indicate that you don't care about the compilation outputs and just want to see if it * the circuit will compile. * @param meta - An object containing metadata to associate with the circuit build. This will be * merged into any metadata specified in the `SINDRI_META` environment variable. This variable can * be a JSON object (*e.g.* `{"key": "value"}`) or a colon-delimited set of assignments (*e.g.* * `key1=value1:key2=value2`). * @returns A promise which resolves to the details of the deployed circuit. * * @example * // Deploy a circuit with a project identifier and default `latest` tag. * const circuit = await client.createCircuit("/path/to/circuit-directory/"); * console.log("Did circuit compilation succeed?", circuit.status); * * @example * // Deploy a circuit with files and custom tags. * await client.createCircuit([file1, file2], ['v1.0', 'experimental']); */ createCircuit(project: string | Array, tags?: string | string[] | null, meta?: Meta): Promise; /** * Retrieves all proofs associated with a specified circuit. This method is essential for * obtaining a comprehensive list of proofs generated for a given circuit, identified by its * unique circuit ID. It returns an array of `ProofInfoResponse` objects, each representing a * proof associated with the circuit. * * The method is particularly useful in scenarios where tracking or auditing all proofs of a * circuit is necessary. This could include verifying the integrity of proofs, understanding their * usage, or simply enumerating them for record-keeping. * * The `circuitId` parameter is a string that uniquely identifies the circuit in question. It's * crucial to provide the correct circuit ID to retrieve the corresponding proofs accurately. * * @param circuitId - The unique identifier of the circuit for which proofs are to be retrieved. * @returns A promise that resolves to an array of details for each associated proof. * * @example * const proofs = await client.getAllCircuitProofs(circuitId); * console.log("Proofs:', proofs); */ getAllCircuitProofs(circuitId: string): Promise; /** * Retrieves all circuits associated with the team. This method fetches a list of all circuits * that have been created or accessed by the currently authenticated team. It's a key method for * managing and monitoring circuit usage within a team, offering insights into the variety and * scope of circuits in use. * * @returns A promise that resolves to an array of circuit information responses. * * @example * const circuits = await = client.getAllCircuits(); * console.log("Circuits:", circuits); */ getAllCircuits(): Promise; /** * Retrieves a specific circuit using its unique circuit ID. This method is crucial for obtaining * detailed information about a particular circuit, identified by the provided `circuitId`. It's * especially useful when detailed insights or operations on a single circuit are required, rather * than handling multiple circuits. * * *Note:* In case the provided `circuitId` is invalid or does not correspond to an existing circuit, * the promise may reject, indicating an error. Proper error handling is therefore essential when using this method. * * @param circuitId - The unique identifier of the circuit to retrieve. * @returns A promise that resolves to the information about the specified circuit. * * @example * const circuit = await client.getCircuit(circuitId); * console.log('Circuit details:', circuit); */ getCircuit(circuitId: string): Promise; /** * Retrieves detailed information about a specific proof, identified by its unique proof ID. This * method is vital for obtaining individual proof details, facilitating in-depth analysis or * verification of a particular proof within the system. * * The `proofId` parameter is the key identifier for the proof, and it should be provided to fetch * the corresponding information. The method returns a promise that resolves to a * {@link ProofInfoResponse}, containing all relevant details of the proof. * * @param proofId - The unique identifier of the proof to retrieve. * @returns A promise that resolves to the data about the specified proof. * * @example * const proof = await client.getProof(proofId); * console.log("Proof details:", proof); */ getProof(proofId: string): Promise; /** * Generates a proof for a specified circuit. This method is critical for creating a new proof * based on a given circuit, identified by `circuitId`, and the provided `proofInput`. It's * primarily used to validate or verify certain conditions or properties of the circuit without * revealing underlying data or specifics. The method continuously polls the service to track the * compilation status until the process either completes successfully or fails. * * The `circuitId` parameter specifies the unique identifier of the circuit for which the proof is * to be generated. The `proofInput` is a string that represents the necessary input data or * parameters required for generating the proof. * * @param circuitId - The unique identifier of the circuit for which the proof is being generated. * @param proofInput - The input data required for generating the proof. This should be a string * containing either JSON data or TOML data (in the case of Noir). * @param verify - A boolean indicating whether to perform a verification check of the generated * proof. * @param includeSmartContractCalldata - A boolean indicating whether to include calldata for the * proof that can be passed into a smart contract for verification. Note that not all frameworks * support this. * @param meta - An object containing metadata to associate with the proof. This will be merged * into any metadata specified in the `SINDRI_META` environment variable. This variable can be a * JSON object (*e.g.* `{"key": "value"}`) or a colon-delimited set of assignments (*e.g.* * `key1=value1:key2=value2`). * @returns A promise that resolves to the information of the generated proof. * * @example * const proof = await client.proveCircuit(circuitId, '{"X": 23, "Y": 52}'); * console.log("Generated proof:", proof); */ proveCircuit(circuitId: string, proofInput: string, verify?: boolean, includeSmartContractCalldata?: boolean, meta?: Meta): Promise; } declare const _default: SindriClient; export { type AuthOptions, type BoojumCircuitInfoResponse, type CircomCircuitInfoResponse, type CircuitInfoResponse, type CircuitType, type GnarkCircuitInfoResponse, type Halo2CircuitInfoResponse, type HermezCircuitInfoResponse, type JobStatus, type JoltCircuitInfoResponse, type LogLevel, type Meta, type NoirCircuitInfoResponse, type OpenvmCircuitInfoResponse, type Plonky2CircuitInfoResponse, type ProofInfoResponse, SindriClient, type SnarkvmCircuitInfoResponse, type Sp1CircuitInfoResponse, _default as default };