@provablehq/sdk 0.10.2 → 0.10.3

package/dist/testnet/models/record-scanner/recordsFilter.d.cts

@@ -0,0 +1,35 @@
+import { RecordSearchParams } from "../record-provider/recordSearchParams.js";
+import { RecordsResponseFilter } from "./recordsResponseFilter.js";
+/**
+ * RecordsFilter is an extension of RecordSearchParams that represents a filter for scanning encrypted or owned records.
+ *
+ * @example
+ * const recordsFilter: RecordsFilter = {
+ *     start: 0,
+ *     end: 100,
+ *     programs: ["credits.aleo"],
+ *     records: ["credits"],
+ *     functions: ["transfer_public_to_private"],
+ *     response: {
+ *         program: true,
+ *         record: true,
+ *         function: true,
+ *         transition: true,
+ *         block_height: true,
+ *         transaction_id: true,
+ *     }
+ *     results_per_page: 100,
+ *     page: 0,
+ * }
+ */
+export interface RecordsFilter extends RecordSearchParams {
+    commitments?: string[];
+    response?: RecordsResponseFilter;
+    start?: number;
+    end?: number;
+    programs?: string[];
+    records?: string[];
+    functions?: string[];
+    results_per_page?: number;
+    page?: number;
+}

package/dist/testnet/models/record-scanner/recordsFilter.d.ts

@@ -1,5 +1,5 @@
-import { RecordSearchParams } from "../record-provider/recordSearchParams";
-import { RecordsResponseFilter } from "./recordsResponseFilter";
+import { RecordSearchParams } from "../record-provider/recordSearchParams.js";
+import { RecordsResponseFilter } from "./recordsResponseFilter.js";
 /**
  * RecordsFilter is an extension of RecordSearchParams that represents a filter for scanning encrypted or owned records.
  *

package/dist/testnet/models/record-scanner/recordsResponseFilter.d.cts

@@ -0,0 +1,42 @@
+/**
+ * RecordsResponseFilter 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 recordsResponseFilter: RecordsResponseFilter = {
+ *     block_height: true,
+ *     block_timestamp: true,
+ *     checksum: true,
+ *     commitment: true,
+ *     record_ciphertext: true,
+ *     function_name: true,
+ *     nonce: true,
+ *     output_index: true,
+ *     owner: true,
+ *     program_name: true,
+ *     record_name: true,
+ *     sender_ciphertext: true,
+ *     transaction_id: true,
+ *     transition_id: true,
+ *     transaction_index: true,
+ *     transition_index: true,
+ * }
+ */
+export type RecordsResponseFilter = {
+    block_height?: boolean;
+    block_timestamp?: boolean;
+    checksum?: boolean;
+    commitment?: boolean;
+    record_ciphertext?: boolean;
+    sender_ciphertext?: boolean;
+    function_name?: boolean;
+    nonce?: boolean;
+    output_index?: boolean;
+    owner?: boolean;
+    program_name?: boolean;
+    record_name?: boolean;
+    transaction_id?: boolean;
+    transition_id?: boolean;
+    transaction_index?: boolean;
+    transition_index?: boolean;
+};

package/dist/testnet/models/record-scanner/registrationRequest.d.cts

@@ -0,0 +1,13 @@
+/**
+ * RegistrationRequest is a type that represents a request to register an account's view key with a record scanning service.
+ *
+ * @example
+ * const registrationRequest: RegistrationRequest = {
+ *     view_key: "AViewKey1ccEt8A2Ryva5rxnKcAbn7wgTaTsb79tzkKHFpeKsm9NX",
+ *     start: 123456,
+ * }
+ */
+export type RegistrationRequest = {
+    view_key: string;
+    start: number;
+};

package/dist/testnet/models/record-scanner/registrationResponse.d.cts

@@ -0,0 +1,13 @@
+/**
+ * RegistrationResponse is a type that represents a response from a record scanning service's registration endpoint.
+ *
+ * @example
+ * const registrationResponse: RegistrationResponse = {
+ *     uuid: "5291249998620209321712738612705518874926462927543783711572375085855029172391field",
+ *     status: "pending",
+ * }
+ */
+export interface RegistrationResponse {
+    uuid: string;
+    status?: string;
+}

package/dist/testnet/models/record-scanner/registrationResult.d.cts

@@ -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/testnet/models/record-scanner/revokeResult.d.cts

@@ -0,0 +1,17 @@
+import type { RecordScannerFailure } from "./error.js";
+/**
+ * Response from the record scanning service's revoke endpoint on success.
+ *
+ * @example
+ * const revokeResponse: RevokeResponse = { status: "OK" };
+ */
+export interface RevokeResponse {
+    status: string;
+}
+/** Success variant of revoke result. */
+export interface RevokeSuccess {
+    ok: true;
+    data: RevokeResponse;
+}
+/** Result of revoke(); never throws on HTTP error. */
+export type RevokeResult = RevokeSuccess | RecordScannerFailure;

package/dist/testnet/models/record-scanner/serialNumbersResult.d.cts

@@ -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/testnet/models/record-scanner/statusResponse.d.cts

@@ -0,0 +1,13 @@
+/**
+ * StatusResponse is a type that represents a response from a record scanning service's status endpoint.
+ *
+ * @example
+ * const statusResponse: StatusResponse = {
+ *     synced: true,
+ *     percentage: 100,
+ * }
+ */
+export interface StatusResponse {
+    synced: boolean;
+    percentage: number;
+}

package/dist/testnet/models/record-scanner/statusResult.d.cts

@@ -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/testnet/models/record-scanner/tagsResult.d.cts

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

package/dist/testnet/models/request.d.cts

@@ -0,0 +1,14 @@
+import { InputID } from "./inputID.js";
+export interface RequestJSON {
+    signer: string;
+    network: string;
+    program: string;
+    method: string;
+    input_ids: InputID[];
+    inputs: string[];
+    signature: string;
+    sk_tag: string;
+    tvk: string;
+    tcm: string;
+    scm: string;
+}

package/dist/testnet/models/request.d.ts

@@ -1,4 +1,4 @@
-import { InputID } from "./inputID";
+import { InputID } from "./inputID.js";
 export interface RequestJSON {
     signer: string;
     network: string;

package/dist/testnet/models/solution.d.cts

@@ -0,0 +1,14 @@
+export interface SolutionsJSON {
+    version: BigInt;
+    solutions?: SolutionJSON[];
+}
+export interface SolutionJSON {
+    partial_solution: PartialSolutionJSON;
+    target: BigInt;
+}
+export interface PartialSolutionJSON {
+    solution_id: string;
+    epoch_hash: string;
+    address: string;
+    counter: BigInt;
+}

package/dist/testnet/models/transaction/transactionJSON.d.cts

@@ -0,0 +1,11 @@
+import { DeploymentJSON } from "../deployment/deploymentJSON.js";
+import { ExecutionJSON, FeeExecutionJSON } from "../execution/executionJSON.js";
+import { OwnerJSON } from "../owner/ownerJSON.js";
+export interface TransactionJSON {
+    type: string;
+    id: string;
+    deployment?: DeploymentJSON;
+    execution?: ExecutionJSON;
+    fee: FeeExecutionJSON;
+    owner?: OwnerJSON;
+}

package/dist/testnet/models/transaction/transactionObject.d.cts

@@ -0,0 +1,14 @@
+import { DeploymentObject } from "../deployment/deploymentObject.js";
+import { ExecutionObject, FeeExecutionObject } from "../execution/executionObject.js";
+import { OwnerObject } from "../owner/ownerObject.js";
+export interface TransactionObject {
+    type: string;
+    id: string;
+    execution?: ExecutionObject;
+    deployment?: DeploymentObject;
+    fee: FeeExecutionObject;
+    owner?: OwnerObject;
+    feeAmount?: bigint;
+    baseFee?: bigint;
+    priorityFee?: bigint;
+}

package/dist/testnet/models/transition/transitionJSON.d.cts

@@ -0,0 +1,13 @@
+import { InputJSON } from "../input/inputJSON.js";
+import { OutputJSON } from "../output/outputJSON.js";
+export interface TransitionJSON {
+    id: string;
+    program: string;
+    function: string;
+    inputs?: (InputJSON)[];
+    outputs?: (OutputJSON)[];
+    proof: string;
+    tpk: string;
+    tcm: string;
+    fee: bigint;
+}

package/dist/testnet/models/transition/transitionObject.d.cts

@@ -0,0 +1,15 @@
+import { InputObject } from "../input/inputObject.js";
+import { OutputObject } from "../output/outputObject.js";
+import { Field, Group } from "../../wasm.js";
+export interface TransitionObject {
+    id: string;
+    program: string;
+    function: string;
+    inputs?: (InputObject)[];
+    outputs?: (OutputObject)[];
+    proof: string;
+    tpk: string | Group;
+    tcm: string | Field;
+    scm: string | Field;
+    fee: bigint;
+}