@provablehq/sdk 0.10.2 → 0.10.4

package/dist/mainnet/models/external-signing.d.cts

@@ -0,0 +1,123 @@
+import { Address, Field, Group, Signature, ViewKey } from "../wasm.js";
+/** A Field, a string representation, or raw LE bytes. */
+export type FieldLike = Field | string | Uint8Array;
+/** A Group, a Field (x-coordinate), a string representation, or raw LE bytes. */
+export type GroupLike = Group | Field | string | Uint8Array;
+/** A ViewKey, a string representation, or raw LE bytes. */
+export type ViewKeyLike = ViewKey | string | Uint8Array;
+/** A Signature, a string representation, or raw LE bytes. */
+export type SignatureLike = Signature | string | Uint8Array;
+/** An Address, a string representation, or raw LE bytes. */
+export type AddressLike = Address | string | Uint8Array;
+/** An input ID is either a single Field-like (public/private) or a 5-tuple (record) with flexible deserialization. */
+export type InputID = FieldLike | [FieldLike, GroupLike, FieldLike, FieldLike, FieldLike];
+export declare function toField(value: FieldLike): Field;
+export declare function toGroup(value: GroupLike): Group;
+export declare function toViewKey(value: ViewKeyLike): ViewKey;
+export declare function toSignature(value: SignatureLike): Signature;
+export declare function toAddress(value: AddressLike): Address;
+/** Output format discriminant for `computeExternalSigningInputs`. */
+export type OutputFormat = "string" | "bytes";
+/** Maps an {@link OutputFormat} to the concrete field-element representation. */
+export type FieldOutput<F extends OutputFormat> = F extends "bytes" ? Uint8Array : string;
+/**
+ * Type surrounding the input to an external signing request.
+ *
+ * The generic parameter `F` controls whether field elements are serialised as
+ * human-readable strings (`"string"`, the default) or raw little-endian bytes
+ * (`"bytes"`).
+ *
+ * @property {string} signingInputType - The type of signing input being requested.
+ * @property {FieldOutput<F>} index - The index of the output represented as an Ed/BLS-377 base field element.
+ * @property {FieldOutput<F>[]} data - The data represented as Ed/BLS-377 base field elements.
+ * @property {string} [name] - The name of the record being requested.
+ * @property {FieldOutput<F>} [h] - The h value of the record represented as an Ed/BLS-377 base field element.
+ * @property {FieldOutput<F>} [tag] - The tag of the record represented as an Ed/BLS-377 base field element.
+ * @property {FieldOutput<F>} [recordViewKey] - The record view key (present for record inputs when viewKey was provided).
+ */
+export interface RequestSignInput<F extends OutputFormat = "string"> {
+    signingInputType: "constant" | "public" | "private" | "record" | "external_record" | "dynamic_record";
+    index: FieldOutput<F>;
+    data: FieldOutput<F>[];
+    name?: string;
+    h?: FieldOutput<F>;
+    tag?: FieldOutput<F>;
+    recordViewKey?: FieldOutput<F>;
+}
+/**
+ * Type representing the output of an external signing request.
+ *
+ * The generic parameter `F` controls whether field elements are serialised as
+ * human-readable strings (`"string"`, the default) or raw little-endian bytes
+ * (`"bytes"`).
+ *
+ * @property {FieldOutput<F>} functionId - The function ID as Ed/BLS-377 base field element(s).
+ * @property {boolean} isRoot - Whether this is a top-level transition.
+ * @property {RequestSignInput<F>[]} requestInputs - The inputs to the function being executed.
+ * @property {FieldOutput<F>} [checksum] - The Ed/BLS-377 base field representation of the program checksum.
+ * @property {string} [signer] - The signer address string (present when viewKey was provided).
+ * @property {string} [skTag] - The tag secret key string (present when viewKey was provided).
+ */
+export interface ExternalSigningInput<F extends OutputFormat = "string"> {
+    functionId: FieldOutput<F>;
+    isRoot: boolean;
+    requestInputs: RequestSignInput<F>[];
+    checksum?: FieldOutput<F>;
+    signer?: string;
+    skTag?: string;
+}
+/**
+ * Type representing the options for pre-computing the inputs to an external signing request.
+ *
+ * @property {string} programName - The name of the program containing the function to execute.
+ * @property {string} functionName - The name of the function to execute within the program.
+ * @property {string[]} inputs - The inputs to the function being executed.
+ * @property {string[]} inputTypes - The input types of the function (e.g. ["address.public", "u64.public"]).
+ * @property {boolean} isRoot - Whether this transition is the first transition being executed in a transaction.
+ * @property {FieldLike} [checksum] - The optional checksum of the program.
+ * @property {ViewKeyLike} [viewKey] - The optional view key used to derive signer and skTag.
+ * @property {OutputFormat} [outputFormat] - Controls whether field elements are serialised as strings (default) or Uint8Arrays.
+ */
+export interface ExternalSigningOptions {
+    programName: string;
+    functionName: string;
+    inputs: string[];
+    inputTypes: string[];
+    isRoot: boolean;
+    checksum?: FieldLike | null;
+    viewKey?: ViewKeyLike | null;
+    outputFormat?: OutputFormat;
+}
+/** Common parameters shared by all `buildExecutionRequest` variants. */
+export interface ExecutionRequestParams {
+    programId: string;
+    functionName: string;
+    inputs: string[];
+    inputTypes: string[];
+    signature: SignatureLike;
+    tvk: FieldLike;
+    signer: AddressLike;
+    skTag: FieldLike;
+}
+/** Provide explicit record view keys and gammas. */
+export interface RecordViewKeyStrategy {
+    recordViewKeys?: FieldLike[];
+    gammas?: GroupLike[];
+}
+/** Provide a view key to derive record view keys internally. */
+export interface ViewKeyStrategy {
+    viewKey: ViewKeyLike;
+    gammas?: GroupLike[];
+}
+/** Provide pre-computed input IDs directly. */
+export interface InputIdStrategy {
+    inputIds: InputID[];
+}
+/** Determines how record input IDs are resolved when building an ExecutionRequest. */
+export type InputStrategy = RecordViewKeyStrategy | ViewKeyStrategy | InputIdStrategy;
+/** Returns `true` if the strategy provides a `viewKey` for deriving record view keys. */
+export declare function isViewKeyStrategy(r: InputStrategy): r is ViewKeyStrategy;
+/** Returns `true` if the strategy provides pre-computed `inputIds`. */
+export declare function isInputIdStrategy(r: InputStrategy): r is InputIdStrategy;
+/** Returns `true` if the strategy provides explicit `recordViewKeys` (or is the default empty variant). */
+export declare function isRecordViewKeyStrategy(r: InputStrategy): r is RecordViewKeyStrategy;

package/dist/mainnet/models/finalizeJSON.d.cts

@@ -0,0 +1,6 @@
+export interface FinalizeJSON {
+    "type": string;
+    "mapping_id": string;
+    "key_id": string;
+    "value_id": string;
+}

package/dist/mainnet/models/functionInput.d.cts

@@ -0,0 +1,7 @@
+export interface FunctionInput {
+    type: string;
+    visibility: string;
+    record?: string;
+    register?: string;
+    members?: FunctionInput[];
+}

package/dist/mainnet/models/functionObject.d.cts

@@ -0,0 +1,8 @@
+import { VerifyingKey } from "../wasm.js";
+export interface FunctionObject {
+    "name": string;
+    "constraints": number;
+    "variables": number;
+    "verifyingKey": string | VerifyingKey;
+    "certificate": string;
+}

package/dist/mainnet/models/imports.d.cts

@@ -0,0 +1,7 @@
+interface ImportedVerifyingKeys {
+    [key: string]: Array<[string, string]>;
+}
+interface ImportedPrograms {
+    [key: string]: string;
+}
+export { ImportedVerifyingKeys, ImportedPrograms };

package/dist/mainnet/models/input/inputJSON.d.cts

@@ -0,0 +1,10 @@
+/**
+ * Object representation of an Input as raw JSON returned from a SnarkOS node.
+ */
+export interface InputJSON {
+    type: string;
+    id: string;
+    tag?: string;
+    value?: string;
+    dynamic_id?: string;
+}

package/dist/mainnet/models/input/inputObject.d.cts

@@ -0,0 +1,15 @@
+/**
+ * Aleo function Input represented as a typed typescript object.
+ */
+import { Ciphertext, Field, Plaintext } from "../../wasm.js";
+import { PlaintextObject } from "../plaintext/plaintext.js";
+/**
+ * Object representation of an Input as raw JSON returned from a SnarkOS node.
+ */
+export interface InputObject {
+    type: "string";
+    id: "string" | Field;
+    tag?: string | Field;
+    value?: Ciphertext | Plaintext | PlaintextObject;
+    dynamic_id?: string | Field;
+}

package/dist/mainnet/models/inputID.d.cts

@@ -0,0 +1,4 @@
+export interface InputID {
+    type: string;
+    id: string;
+}

package/dist/mainnet/models/keyPair.d.cts

@@ -0,0 +1,4 @@
+import { ProvingKey, VerifyingKey } from "../wasm.js";
+type FunctionKeyPair = [ProvingKey, VerifyingKey];
+type CachedKeyPair = [Uint8Array, Uint8Array];
+export { CachedKeyPair, FunctionKeyPair };

package/dist/mainnet/models/output/outputJSON.d.cts

@@ -0,0 +1,7 @@
+export interface OutputJSON {
+    type: string;
+    id: string;
+    checksum?: string;
+    value: string;
+    dynamic_id?: string;
+}

package/dist/mainnet/models/output/outputObject.d.cts

@@ -0,0 +1,18 @@
+/**
+ * Aleo function Input represented as a typed typescript object.
+ */
+import { Field, Ciphertext, Plaintext } from "../../wasm.js";
+import { PlaintextObject } from "../plaintext/plaintext.js";
+/**
+ * Object representation of an Input as raw JSON returned from a SnarkOS node.
+ */
+export interface OutputObject {
+    type: string;
+    id: string | Field;
+    value?: Ciphertext | Plaintext | PlaintextObject;
+    checksum?: string | Field;
+    program?: string;
+    function?: string;
+    arguments?: Array<Plaintext> | Array<OutputObject>;
+    dynamic_id?: string | Field;
+}

package/dist/mainnet/models/owner/ownerJSON.d.cts

@@ -0,0 +1,4 @@
+export interface OwnerJSON {
+    address: string;
+    signature: string;
+}

package/dist/mainnet/models/owner/ownerObject.d.cts

@@ -0,0 +1,5 @@
+import { Address, Signature } from "../../wasm.js";
+export interface OwnerObject {
+    address: string | Address;
+    signature: string | Signature;
+}

package/dist/mainnet/models/plaintext/array.d.cts

@@ -0,0 +1,3 @@
+import { PlaintextLiteral } from "./literal.js";
+import { PlaintextStruct } from "./struct.js";
+export type PlaintextArray = PlaintextLiteral[] | PlaintextStruct[] | PlaintextArray[];

package/dist/mainnet/models/plaintext/literal.d.cts

@@ -0,0 +1 @@
+export type PlaintextLiteral = boolean | bigint | number | string;

package/dist/mainnet/models/plaintext/plaintext.d.cts

@@ -0,0 +1,5 @@
+import { Plaintext } from "../../wasm.js";
+import { PlaintextArray } from "./array.js";
+import { PlaintextLiteral } from "./literal.js";
+import { PlaintextStruct } from "./struct.js";
+export type PlaintextObject = PlaintextArray | PlaintextLiteral | PlaintextStruct | Plaintext;

package/dist/mainnet/models/plaintext/struct.d.cts

@@ -0,0 +1,5 @@
+import { PlaintextArray } from "./array.js";
+import { PlaintextLiteral } from "./literal.js";
+export type PlaintextStruct = {
+    [key: string]: PlaintextArray | PlaintextLiteral | PlaintextStruct;
+};

package/dist/mainnet/models/provingRequest.d.cts

@@ -0,0 +1,6 @@
+import { AuthorizationJSON } from "./authorization.js";
+export interface ProvingRequestJSON {
+    authorization: AuthorizationJSON;
+    fee_authorization?: AuthorizationJSON;
+    broadcast: boolean;
+}

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

@@ -1,4 +1,4 @@
-import { AuthorizationJSON } from "./authorization";
+import { AuthorizationJSON } from "./authorization.js";
 export interface ProvingRequestJSON {
     authorization: AuthorizationJSON;
     fee_authorization?: AuthorizationJSON;

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

@@ -0,0 +1,51 @@
+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_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/ratification.d.cts

@@ -0,0 +1,4 @@
+export interface RatificationJSON {
+    type: string;
+    amount: number;
+}

package/dist/mainnet/models/record-provider/encryptedRecord.d.cts

@@ -0,0 +1,58 @@
+/**
+ * Encrypted Record found on chain. This type provides the record ciphertext and metadata from the ledger such as the record's name, the program/function that produced it, etc.
+ *
+ * @property {string} commitment - The commitment of the record.
+ * @property {string | undefined} checksum - The checksum of the record.
+ * @property {number | undefined} block_height - The block height of the record.
+ * @property {number | undefined} block_timestamp - The block timestamp of the record.
+ * @property {string | undefined} program_name - The name of the program that produced the record.
+ * @property {string | undefined} function_name - The name of the function that produced the record.
+ * @property {number | undefined} output_index - The output index of the record.
+ * @property {string | undefined} owner - The owner of the record.
+ * @property {string | undefined} record_ciphertext - The ciphertext of the record.
+ * @property {string | undefined} record_name - The name of the record.
+ * @property {string | undefined} record_nonce - The nonce of the record.
+ * @property {string | undefined} sender_ciphertext - The ciphertext of the sender.
+ * @property {string | undefined} transaction_id - The ID of the transaction that produced the record.
+ * @property {string | undefined} transition_id - The ID of the transition that produced the record.
+ * @property {number | undefined} transaction_index - The index of the transaction that produced the record.
+ * @property {number | undefined} transition_index - The index of the transition that produced the record.
+ *
+ * @example
+ * const encryptedRecord: EncryptedRecord = {
+ *     commitment: "1754131901135854615627743152473414463769543922079966020586765988138574911385field",
+ *     checksum: "731623304764338277682996290553427512270277231686866672455141481050283829616field",
+ *     block_height: 123456,
+ *     block_timestamp: 1725845998,
+ *     program_name: "credits.aleo",
+ *     function_name: "transfer_private",
+ *     output_index: 0,
+ *     owner: "ciphertext1qgqdetlfzk98jkm4e7sgqml66e3x2gpg5d6udkpw0g67z0tplkpmzrm6q5dyfd7xhgmhedvptxzwfhrtxaqn7n0hs0esge3lwg9s2zukqgzxd0cr",
+ *     record_ciphertext: "record1qyqsqt43u9kp97svljyyup3v4jmppd0vgght9edvvmtxx6mxycsej8cwqsrxzmt0w4h8ggcqqgqspf8zqut2ycnap7f0uzz5ktu0cxscca96urtkg2aweuzn70787dsrpp6x76m9de0kjezrqqpqyqp3mn3xeh53lukvcy406amjf5g0ksl3saauzjk0j4ljtjqq6kqlqhdz05sw92zye96qym7kp83ra0eesgtwhaw37c85r499456se8ts28m90p6x2unwv9k97ct4w35x7unf0fshg6t0de0hyet3w45hyetyyvqqyqgq4t2wr9tmcrfha5tfz5j585ptvvslqe0f6sf29vytshhdh7ym05rpqct4w35x7unf0fjkghm4de6xjmprqqpqzqru6p7fef29vuz6smyqwcn3z7jhxtdgjdw5xv23ppxhpgnvu72fp8hz6fjt6gsdn8yxhzq7gpsah0rscwqrzxwl5e8aemkj5gt09y7q5506yrf",
+ *     record_name: "credits",
+ *     record_nonce: "3077450429259593211617823051143573281856129402760267155982965992208217472983group",
+ *     sender_ciphertext: "1754131901135854615627743152473414463769543922079966020586765988138574911385field",
+ *     transaction_id: "at1f8ueqxu3x49sckpc6jlg676tmxumddzer3fwe2l0dxwj4dqxygyqua4u2q",
+ *     transition_id: "au17mm5v7sfwus6y40xsyc99d5rtsr4vsajdec6twdjzv0m458q85zspqdnka",
+ *     transaction_index: 0,
+ *     transition_index: 0,
+ * }
+ */
+export type EncryptedRecord = {
+    commitment: string;
+    checksum?: string;
+    block_height?: number;
+    block_timestamp?: number;
+    program_name?: string;
+    function_name?: string;
+    output_index?: number;
+    owner?: string;
+    record_ciphertext?: string;
+    record_name?: string;
+    record_nonce?: string;
+    sender_ciphertext?: string;
+    transaction_id?: string;
+    transition_id?: string;
+    transaction_index?: number;
+    transition_index?: number;
+};

package/dist/mainnet/models/record-provider/ownedRecord.d.cts

@@ -0,0 +1,60 @@
+/**
+ * Record owned by a registered view key. This type provides the record ciphertext, record plaintext and metadata from the ledger such as the record's name, the program/function that produced it, etc.
+ *
+ * @property {number | undefined} block_height - Block height where the record was created.
+ * @property {number | undefined} block_timestamp - The timestamp of the block that the record was created in.
+ * @property {string | undefined} commitment - Commitment of the record.
+ * @property {string | undefined} function_name - Name of the function that created the record.
+ * @property {number | undefined} output_index - Index of the output in the function call that created the record.
+ * @property {string | undefined} owner - Address of the record owner.
+ * @property {string | undefined} program_name - Name of the program that created the record.
+ * @property {string | undefined} record_ciphertext - Encrypted ciphertext of the record.
+ * @property {string | undefined} record_name - Name of the record.
+ * @property {string | undefined} sender - Address of the sender.
+ * @property {boolean | undefined} spent - Whether the record has been spent.
+ * @property {string | undefined} tag - Tag associated with the record.
+ * @property {string | undefined} transaction_id - ID of the transaction that created the record.
+ * @property {string | undefined} transition_id - ID of the transition that created the record.
+ * @property {string | undefined} transaction_index - Index of the transaction in the block.
+ * @property {string | undefined} transition_index - Index of the transition in the transaction.
+ *
+ * @example
+ * const ownedRecord: OwnedRecord = {
+ *     block_height: 123456,
+ *     block_timestamp: 1725845998,
+ *     commitment: "1754131901135854615627743152473414463769543922079966020586765988138574911385field",
+ *     function_name: "transfer_public_to_private",
+ *     output_index: 0,
+ *     owner: "ciphertext1qgqdetlfzk98jkm4e7sgqml66e3x2gpg5d6udkpw0g67z0tplkpmzrm6q5dyfd7xhgmhedvptxzwfhrtxaqn7n0hs0esge3lwg9s2zukqgzxd0cr",
+ *     program_name: "credits.aleo",
+ *     record_ciphertext: "record1qyqsqt43u9kp97svljyyup3v4jmppd0vgght9edvvmtxx6mxycsej8cwqsrxzmt0w4h8ggcqqgqspf8zqut2ycnap7f0uzz5ktu0cxscca96urtkg2aweuzn70787dsrpp6x76m9de0kjezrqqpqyqp3mn3xeh53lukvcy406amjf5g0ksl3saauzjk0j4ljtjqq6kqlqhdz05sw92zye96qym7kp83ra0eesgtwhaw37c85r499456se8ts28m90p6x2unwv9k97ct4w35x7unf0fshg6t0de0hyet3w45hyetyyvqqyqgq4t2wr9tmcrfha5tfz5j585ptvvslqe0f6sf29vytshhdh7ym05rpqct4w35x7unf0fjkghm4de6xjmprqqpqzqru6p7fef29vuz6smyqwcn3z7jhxtdgjdw5xv23ppxhpgnvu72fp8hz6fjt6gsdn8yxhzq7gpsah0rscwqrzxwl5e8aemkj5gt09y7q5506yrf",
+ *     record_plaintext: "{ owner: aleo1j7qxyunfldj2lp8hsvy7mw5k8zaqgjfyr72x2gh3x4ewgae8v5gscf5jh3.private, microcredits: 1500000000000000u64.private, _nonce: 3077450429259593211617823051143573281856129402760267155982965992208217472983group.public , _version: 1u8 }",
+ *     record_name: "credits",
+ *     spent: true,
+ *     sender: "aleo1sf5kk4f8mcmgjasw9fannmm0h8z2nwqxu5e200cjneu28jxvtvpqulfxsa",
+ *     tag: "6511661650536816422260305447175136877451468301541296257226129781611237851030field",
+ *     transaction_id: "at1f8ueqxu3x49sckpc6jlg676tmxumddzer3fwe2l0dxwj4dqxygyqua4u2q",
+ *     transition_id: "au17mm5v7sfwus6y40xsyc99d5rtsr4vsajdec6twdjzv0m458q85zspqdnka",
+ *     transaction_index: 0,
+ *     transition_index: 0,
+ * }
+ */
+export type OwnedRecord = {
+    block_height?: number;
+    block_timestamp?: number;
+    commitment?: string;
+    function_name?: string;
+    output_index?: number;
+    owner?: string;
+    program_name?: string;
+    record_ciphertext?: string;
+    record_plaintext?: string;
+    record_name?: string;
+    sender?: string;
+    spent?: boolean;
+    tag?: string;
+    transaction_id?: string;
+    transition_id?: string;
+    transaction_index?: number;
+    transition_index?: number;
+};

package/dist/mainnet/models/record-provider/recordSearchParams.d.cts

@@ -0,0 +1,19 @@
+/**
+ * Interface for record search parameters. This allows for arbitrary search parameters to be passed to record provider
+ * implementations.
+ *
+ * @example
+ * const recordSearchParams: RecordSearchParams = {
+ *     // Declared fields
+ *     unspent: true,
+ *     nonces: ["3077450429259593211617823051143573281856129402760267155982965992208217472983group"],
+ *     // Arbitrary fields
+ *     startHeight: 123456,
+ *     programName: "credits.aleo"
+ * }
+ */
+export interface RecordSearchParams {
+    unspent?: boolean;
+    nonces?: string[];
+    [key: string]: any;
+}

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

@@ -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.cts

@@ -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.cts

@@ -0,0 +1,47 @@
+import { OwnedFilter } from "./ownedFilter.js";
+/**
+ * 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 no UUID is configured, the UUID is invalid, or a record scanner request fails due to an invalid UUID/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/error.d.ts

@@ -1,4 +1,4 @@
-import { OwnedFilter } from "./ownedFilter";
+import { OwnedFilter } from "./ownedFilter.js";
 /**
  * Error thrown when a record scanner request fails (e.g. /register, /register/encrypted).
  * Includes HTTP status so callers can handle 422 vs 500 etc.

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

@@ -0,0 +1,22 @@
+import { RecordSearchParams } from "../record-provider/recordSearchParams.js";
+import { RecordsFilter } from "./recordsFilter.js";
+import { OwnedRecordsResponseFilter } from "./ownedRecordsResponseFilter.js";
+/**
+ * OwnedFilter is an extension of RecordSearchParams that represents a filter for scanning owned records.
+ *
+ * @example
+ * const ownedFilter: OwnedFilter = {
+ *     unspent: true,
+ *     nonces: ["3077450429259593211617823051143573281856129402760267155982965992208217472983group"],
+ *     filter: {
+ *         program: "credits.aleo",
+ *         record: "credits",
+ *     },
+ * }
+ */
+export interface OwnedFilter extends RecordSearchParams {
+    filter?: RecordsFilter;
+    responseFilter?: OwnedRecordsResponseFilter;
+    unspent?: boolean;
+    uuid?: string;
+}

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

@@ -1,6 +1,6 @@
-import { RecordSearchParams } from "../record-provider/recordSearchParams";
-import { RecordsFilter } from "./recordsFilter";
-import { OwnedRecordsResponseFilter } from "./ownedRecordsResponseFilter";
+import { RecordSearchParams } from "../record-provider/recordSearchParams.js";
+import { RecordsFilter } from "./recordsFilter.js";
+import { OwnedRecordsResponseFilter } from "./ownedRecordsResponseFilter.js";
 /**
  * OwnedFilter is an extension of RecordSearchParams that represents a filter for scanning owned records.
  *

package/dist/mainnet/models/record-scanner/ownedRecordsResponseFilter.d.cts

@@ -0,0 +1,42 @@
+/**
+ * OwnedRecordsResponseFilter is a type that represents a filter for the response from a record provider.
+ * A `true` value for a field in the filter will include that field in the response.
+ *
+ * @example
+ * const ownedRecordsResponseFilter: OwnedRecordsResponseFilter = {
+ *     commitment: true,
+ *     owner: true,
+ *     tag: true,
+ *     sender: true,
+ *     spent: true,
+ *     record_ciphertext: true,
+ *     block_height: true,
+ *     block_timestamp: true,
+ *     output_index: true,
+ *     record_name: true,
+ *     function_name: true,
+ *     program_name: true,
+ *     transition_id: true,
+ *     transaction_id: true,
+ *     transaction_index: true,
+ *     transition_index: true,
+ * }
+ */
+export interface OwnedRecordsResponseFilter {
+    commitment?: boolean;
+    owner?: boolean;
+    tag?: boolean;
+    sender?: boolean;
+    spent?: boolean;
+    record_ciphertext?: boolean;
+    block_height?: boolean;
+    block_timestamp?: boolean;
+    output_index?: boolean;
+    record_name?: boolean;
+    function_name?: boolean;
+    program_name?: boolean;
+    transition_id?: boolean;
+    transaction_id?: boolean;
+    transaction_index?: boolean;
+    transition_index?: boolean;
+}

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

@@ -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;