@provablehq/sdk 0.9.16-rc → 0.9.16

package/dist/{testnet/keys/provider → mainnet}/function-key-provider.d.ts

@@ -1,7 +1,7 @@
-import { Key } from "../../constants";
-import { CachedKeyPair, FunctionKeyPair } from "../../models/keyPair";
-import { KeyStore } from "../keystore/keystore";
-import { ProvingKey, VerifyingKey } from "../../wasm";
+import { Key } from "./constants.js";
+import { ProvingKey, VerifyingKey } from "./wasm.js";
+type FunctionKeyPair = [ProvingKey, VerifyingKey];
+type CachedKeyPair = [Uint8Array, Uint8Array];
 type AleoKeyProviderInitParams = {
     proverUri?: string;
     verifierUri?: string;
@@ -122,11 +122,11 @@ interface FunctionKeyProvider {
      *
      *
      * const keyProvider = new AleoKeyProvider();
-     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const networkClient = new AleoNetworkClient("https://api.provable.com/v2");
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for value transfers
-     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+     * const programManager = new ProgramManager("https://api.provable.com/v2", keyProvider, recordProvider);
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * // Keys can also be fetched manually
@@ -134,13 +134,6 @@ interface FunctionKeyProvider {
      * const [transferPrivateProvingKey, transferPrivateVerifyingKey] = await keyProvider.functionKeys(searchParams);
      */
     functionKeys(params?: KeySearchParams): Promise<FunctionKeyPair>;
-    /**
-     * Gets an object which implements the `KeyStore` interface key store object for accessing proving and verifying
-     * keys directly from persistent storage.
-     *
-     * @return {KeyStore}
-     */
-    keyStore(): Promise<KeyStore | undefined>;
     /**
      * Get fee_private function keys from the credits.aleo program
      *
@@ -179,12 +172,12 @@ interface FunctionKeyProvider {
      *
      * @example
      * // Create a new object which implements the KeyProvider interface
-     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const networkClient = new AleoNetworkClient("https://api.provable.com/v2");
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for value transfers
-     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+     * const programManager = new ProgramManager("https://api.provable.com/v2", keyProvider, recordProvider);
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * // Keys can also be fetched manually
@@ -209,7 +202,6 @@ declare class AleoKeyProvider implements FunctionKeyProvider {
     keyUris: string;
     fetchBytes(url?: string): Promise<Uint8Array>;
     constructor();
-    keyStore(): Promise<KeyStore | undefined>;
     /**
      * Use local memory to store keys
      *
@@ -257,12 +249,12 @@ declare class AleoKeyProvider implements FunctionKeyProvider {
      *
      * @example
      * // Create a new object which implements the KeyProvider interface
-     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const networkClient = new AleoNetworkClient("https://api.provable.com/v2");
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for value transfers
-     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+     * const programManager = new ProgramManager("https://api.provable.com/v2", keyProvider, recordProvider);
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * // Keys can also be fetched manually using the key provider
@@ -281,12 +273,12 @@ declare class AleoKeyProvider implements FunctionKeyProvider {
      *
      * @example
      * // Create a new AleoKeyProvider object
-     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const networkClient = new AleoNetworkClient("https://api.provable.com/v2");
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for value transfers
-     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+     * const programManager = new ProgramManager("https://api.provable.com/v2", keyProvider, recordProvider);
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * // Keys can also be fetched manually
@@ -316,12 +308,12 @@ declare class AleoKeyProvider implements FunctionKeyProvider {
      *
      * @example
      * // Create a new AleoKeyProvider
-     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const networkClient = new AleoNetworkClient("https://api.provable.com/v2");
      * const keyProvider = new AleoKeyProvider();
      * const recordProvider = new NetworkRecordProvider(account, networkClient);
      *
      * // Initialize a program manager with the key provider to automatically fetch keys for value transfers
-     * const programManager = new ProgramManager("https://api.explorer.provable.com/v1", keyProvider, recordProvider);
+     * const programManager = new ProgramManager("https://api.provable.com/v2", keyProvider, recordProvider);
      * programManager.transfer(1, "aleo166q6ww6688cug7qxwe7nhctjpymydwzy2h7rscfmatqmfwnjvggqcad0at", "public", 0.5);
      *
      * // Keys can also be fetched manually
@@ -372,4 +364,4 @@ declare class AleoKeyProvider implements FunctionKeyProvider {
     getVerifyingKey(verifierUri: string): Promise<VerifyingKey>;
     unBondPublicKeys(): Promise<FunctionKeyPair>;
 }
-export { AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, FunctionKeyProvider, KeySearchParams };
+export { AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, CachedKeyPair, FunctionKeyPair, FunctionKeyProvider, KeySearchParams };

package/dist/mainnet/models/cryptoBoxPubkey.d.ts

@@ -0,0 +1,4 @@
+export interface CryptoBoxPubKey {
+    key_id: string;
+    public_key: string;
+}

package/dist/mainnet/models/encryptedProvingRequest.d.ts

@@ -0,0 +1,4 @@
+export interface EncryptedProvingRequest {
+    key_id: string;
+    ciphertext: string;
+}

package/dist/mainnet/models/provingResponse.d.ts

@@ -1,5 +1,51 @@
-import { TransactionJSON } from "./transaction/transactionJSON";
+import { TransactionJSON } from "./transaction/transactionJSON.js";
+/** HTTP status and optional message from snarkOS broadcast (Accepted/Rejected variants). */
+export interface BroadcastResponse {
+    status_code: bigint | number;
+    message?: string;
+}
+/** Result of the optional broadcast step. Discriminated by `status`. */
+export type BroadcastResult = {
+    status: "Accepted";
+    status_code: bigint | number;
+    message?: string;
+} | {
+    status: "Rejected";
+    status_code: bigint | number;
+    message?: string;
+} | {
+    status: "Failed";
+    message: string;
+} | {
+    status: "Skipped";
+};
+/** Success response body for POST /prove (HTTP 200). */
 export interface ProvingResponse {
     transaction: TransactionJSON;
-    broadcast?: boolean;
+    broadcast_result: BroadcastResult;
+}
+/** Error response body for POST /prove (HTTP 400, 500, 503). Same shape for all error cases. */
+export interface ProveApiErrorBody {
+    message: string;
+}
+/** Error thrown on prove API failure; `status` is set for retry logic (e.g. retryWithBackoff checks error.status >= 500). */
+export interface ProvingRequestError extends Error {
+    status?: number;
+}
+/** Success variant of a proving request result. */
+export interface ProvingSuccess {
+    ok: true;
+    data: ProvingResponse;
+}
+/** Failure variant of a proving request result (HTTP 400, 500, 503). */
+export interface ProvingFailure {
+    ok: false;
+    status: number;
+    error: ProveApiErrorBody;
 }
+/** Result of a proving request. Type used to give callers the ability to self-handle errors. */
+export type ProvingResult = ProvingSuccess | ProvingFailure;
+/** Type guard: value is a ProvingResponse. */
+export declare function isProvingResponse(value: unknown): value is ProvingResponse;
+/** Type guard: value is a ProveApiErrorBody. */
+export declare function isProveApiErrorBody(value: unknown): value is ProveApiErrorBody;

package/dist/mainnet/models/record-scanner/encryptedRecordsResult.d.ts

@@ -0,0 +1,7 @@
+import type { RecordScannerFailure } from "./error.js";
+import type { EncryptedRecord } from "../record-provider/encryptedRecord.js";
+export interface EncryptedRecordsSuccess {
+    ok: true;
+    data: EncryptedRecord[];
+}
+export type EncryptedRecordsResult = EncryptedRecordsSuccess | RecordScannerFailure;

package/dist/mainnet/models/record-scanner/encryptedRegistrationRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Payload for the /register/encrypted record scanner endpoint.
+ * Contains the ephemeral key id and the sealed ciphertext of the registration request.
+ */
+export interface EncryptedRegistrationRequest {
+    key_id: string;
+    ciphertext: string;
+}

package/dist/mainnet/models/record-scanner/error.d.ts

@@ -0,0 +1,47 @@
+import { OwnedFilter } from "./ownedFilter";
+/**
+ * Error thrown when a record scanner request fails (e.g. /register, /register/encrypted).
+ * Includes HTTP status so callers can handle 422 vs 500 etc.
+ */
+export declare class RecordScannerRequestError extends Error {
+    readonly status: number;
+    constructor(message: string, status: number);
+}
+/** Error thrown when findCreditsRecord or findCreditsRecords is called but decryption is not enabled on the record scanner. */
+export declare class DecryptionNotEnabledError extends Error {
+    readonly filter?: OwnedFilter;
+    constructor(message: string, filter?: OwnedFilter);
+}
+/** Error thrown when findCreditsRecord or findCreditsRecords is called but no view key for the UUID is stored in viewKeys or the account. */
+export declare class ViewKeyNotStoredError extends Error {
+    readonly uuid?: string;
+    readonly filter?: OwnedFilter;
+    constructor(message: string, uuid?: string, filter?: OwnedFilter);
+}
+/** Error thrown when no record matches the supplied search filter (e.g. findCreditsRecord / findCreditsRecords). */
+export declare class RecordNotFoundError extends Error {
+    readonly filter?: OwnedFilter;
+    constructor(message: string, filter?: OwnedFilter);
+}
+/** Error thrown when a record scanner request fails due to an invalid response. */
+export declare class UUIDError extends Error {
+    readonly uuid?: string;
+    readonly filter?: OwnedFilter;
+    constructor(message: string, uuid?: string, filter?: OwnedFilter);
+}
+/** General error payload returned from record-scanner endpoints on failure. */
+export interface RecordScannerErrorBody {
+    /** Raw error text returned by the service. */
+    message: string;
+    /** HTTP status code from the response. */
+    status: number;
+}
+/**
+ * Failure variant shared by record-scanner result types.
+ * Use with a success interface to form a discriminated union (e.g. Success | RecordScannerFailure).
+ */
+export interface RecordScannerFailure {
+    ok: false;
+    status: number;
+    error: RecordScannerErrorBody;
+}

package/dist/mainnet/models/record-scanner/ownedFilter.d.ts

@@ -8,7 +8,6 @@ import { OwnedRecordsResponseFilter } from "./ownedRecordsResponseFilter";
  * const ownedFilter: OwnedFilter = {
  *     unspent: true,
  *     nonces: ["3077450429259593211617823051143573281856129402760267155982965992208217472983group"],
- *     decrypt: true,
  *     filter: {
  *         program: "credits.aleo",
  *         record: "credits",
@@ -16,7 +15,6 @@ import { OwnedRecordsResponseFilter } from "./ownedRecordsResponseFilter";
  * }
  */
 export interface OwnedFilter extends RecordSearchParams {
-    decrypt?: boolean;
     filter?: RecordsFilter;
     responseFilter?: OwnedRecordsResponseFilter;
     unspent?: boolean;

package/dist/mainnet/models/record-scanner/ownedRecordsResult.d.ts

@@ -0,0 +1,13 @@
+import type { RecordScannerFailure } from "./error.js";
+import type { OwnedRecord } from "../record-provider/ownedRecord.js";
+/**
+ * Success variant of ownedRecords() result.
+ *
+ * @property ok - Whether the request was successful, always true for this interface variant.
+ * @property data - List of owned records corresponding to the filter used.
+ */
+export interface OwnedRecordsSuccess {
+    ok: true;
+    data: OwnedRecord[];
+}
+export type OwnedRecordsResult = OwnedRecordsSuccess | RecordScannerFailure;

package/dist/mainnet/models/record-scanner/registrationResponse.d.ts

@@ -4,12 +4,10 @@
  * @example
  * const registrationResponse: RegistrationResponse = {
  *     uuid: "5291249998620209321712738612705518874926462927543783711572375085855029172391field",
- *     job_id: "3019177021147406178755252788128212930359855601860174268911518336835545087409field",
  *     status: "pending",
  * }
  */
 export interface RegistrationResponse {
     uuid: string;
-    job_id?: string;
     status?: string;
 }

package/dist/mainnet/models/record-scanner/registrationResult.d.ts

@@ -0,0 +1,9 @@
+import type { RecordScannerFailure } from "./error.js";
+import type { RegistrationResponse } from "./registrationResponse.js";
+/** Success variant of registration result. */
+export interface RegisterSuccess {
+    ok: true;
+    data: RegistrationResponse;
+}
+/** Result of register() and registerEncrypted(); never throws on HTTP error. */
+export type RegisterResult = RegisterSuccess | RecordScannerFailure;

package/dist/mainnet/models/record-scanner/serialNumbersResult.d.ts

@@ -0,0 +1,15 @@
+import type { RecordScannerFailure } from "./error.js";
+/**
+ * Success variant of serialNumbers() result.
+ *
+ * @property ok - Whether the request was successful, always true for this interface.
+ * @property data - A map of serial numbers to whether they are owned by the account.
+ */
+export interface SerialNumbersSuccess {
+    ok: true;
+    data: Record<string, boolean>;
+}
+/**
+ * Success or failure variant of serialNumbers() result.
+ */
+export type SerialNumbersResult = SerialNumbersSuccess | RecordScannerFailure;

package/dist/mainnet/models/record-scanner/statusResult.d.ts

@@ -0,0 +1,13 @@
+import type { RecordScannerFailure } from "./error.js";
+import type { StatusResponse } from "./statusResponse.js";
+/**
+ * Success variant of status() result.
+ *
+ * @property ok - Whether the request was successful, always true for this interface variant.
+ * @property data - StatusResponse returned by the server.
+ */
+export interface StatusSuccess {
+    ok: true;
+    data: StatusResponse;
+}
+export type StatusResult = StatusSuccess | RecordScannerFailure;

package/dist/mainnet/models/record-scanner/tagsResult.d.ts

@@ -0,0 +1,12 @@
+import type { RecordScannerFailure } from "./error.js";
+/**
+ * Success variant of tags() result.
+ *
+ * @property ok - Whether the request was successful, always true for this interface variant.
+ * @property data - A map of tags to whether they are owned by the account.
+ */
+export interface TagsSuccess {
+    ok: true;
+    data: Record<string, boolean>;
+}
+export type TagsResult = TagsSuccess | RecordScannerFailure;