@provablehq/sdk 0.9.7 → 0.9.9

package/dist/testnet/models/record-provider/encryptedRecord.d.ts

@@ -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/testnet/models/record-provider/ownedRecord.d.ts

@@ -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/testnet/models/record-provider/recordSearchParams.d.ts

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

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

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

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

@@ -0,0 +1,35 @@
+import { RecordSearchParams } from "../record-provider/recordSearchParams";
+import { RecordsResponseFilter } from "./recordsResponseFilter";
+/**
+ * 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/recordsResponseFilter.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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,
+ *     checksum: true,
+ *     commitment: true,
+ *     record_ciphertext: true,
+ *     function_name: true,
+ *     nonce: true,
+ *     output_index: true,
+ *     owner: true,
+ *     program_name: true,
+ *     record_name: true,
+ *     transaction_id: true,
+ *     transition_id: true,
+ *     transaction_index: true,
+ *     transition_index: true,
+ * }
+ */
+export type RecordsResponseFilter = {
+    blockHeight?: boolean;
+    checksum?: boolean;
+    commitment?: boolean;
+    record_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.ts

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

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

package/dist/testnet/network-client.d.ts

@@ -12,6 +12,18 @@ interface AleoNetworkClientOptions {
         [key: string]: string;
     };
 }
+/**
+ * Options for submitting a proving request.
+ *
+ * @property provingRequest {ProvingRequest | string} The proving request being submitted to the network.
+ * @property url {string} The URL of the delegated proving service.
+ * @property apiKey {string} The API key to use for authentication.
+ */
+interface DelegatedProvingParams {
+    provingRequest: ProvingRequest | string;
+    url?: string;
+    apiKey?: string;
+}
 /**
  * Client library that encapsulates REST calls to publicly exposed endpoints of Aleo nodes. The methods provided in this
  * allow users to query public information from the Aleo blockchain and submit transactions to the network.
@@ -34,6 +46,7 @@ declare class AleoNetworkClient {
     ctx: {
         [key: string]: string;
     };
+    verboseErrors: boolean;
     readonly network: string;
     constructor(host: string, options?: AleoNetworkClientOptions);
     /**
@@ -59,7 +72,6 @@ declare class AleoNetworkClient {
      * Set a new host for the networkClient
      *
      * @param {string} host The address of a node hosting the Aleo API
-     * @param host
      *
      * @example
      * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
@@ -71,6 +83,20 @@ declare class AleoNetworkClient {
      * networkClient.setHost("http://api.explorer.provable.com/v1");
      */
     setHost(host: string): void;
+    /**
+     * Set verbose errors to true or false for the `AleoNetworkClient`. When set to true, if `submitTransaction` fails, the failure responses will report descriptive information as to why the transaction failed.
+     *
+     * @param {boolean} verboseErrors Set verbose error mode to true or false for the AleoNetworkClient.
+     * @example
+     * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
+     *
+     * // Create a networkClient
+     * const networkClient = new AleoNetworkClient();
+     *
+     * // Set debug mode to true
+     * networkClient.setVerboseTransactionErrors(true);
+     **/
+    setVerboseErrors(verboseErrors: boolean): void;
     /**
      * Set a header in the `AleoNetworkClient`s header map
      *
@@ -711,11 +737,10 @@ declare class AleoNetworkClient {
     /**
      * Submit a `ProvingRequest` to a remote proving service for delegated proving. If the broadcast flag of the `ProvingRequest` is set to `true` the remote service will attempt to broadcast the result `Transaction` on behalf of the requestor.
      *
-     * @param {ProvingRequest | string} provingRequest - The `ProvingRequest` (generated by the ProgramManager) to submit.
-     * @param {string} url - (Optional) The url of the proving service.
+     * @param {DelegatedProvingParams} options - The optional parameters required to submit a proving request.
      * @returns {Promise<ProvingResponse>} The ProvingResponse containing the transaction result and the result of the broadcast if the `broadcast` flag was set to `true`.
      */
-    submitProvingRequest(provingRequest: ProvingRequest | string, url?: string): Promise<ProvingResponse>;
+    submitProvingRequest(options: DelegatedProvingParams): Promise<ProvingResponse>;
     /**
      * Await a submitted transaction to be confirmed or rejected on the Aleo network.
      *

package/dist/testnet/program-manager.d.ts

@@ -1,9 +1,11 @@
 import { Account } from "./account.js";
 import { AleoNetworkClient, AleoNetworkClientOptions, ProgramImports } from "./network-client.js";
 import { ImportedPrograms, ImportedVerifyingKeys } from "./models/imports.js";
-import { RecordProvider, RecordSearchParams } from "./record-provider.js";
+import { RecordProvider } from "./record-provider.js";
+import { RecordSearchParams } from "./models/record-provider/recordSearchParams.js";
 import { FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider.js";
 import { Authorization, ExecutionResponse, OfflineQuery, RecordPlaintext, PrivateKey, Program, ProvingKey, ProvingRequest, VerifyingKey, Transaction } from "./wasm.js";
+import { OwnedRecord } from "./models/record-provider/ownedRecord.js";
 /**
  * Represents the options for executing a transaction in the Aleo network.
  * This interface is used to specify the parameters required for building and submitting an execution transaction.
@@ -1085,6 +1087,6 @@ declare class ProgramManager {
      * @param {string} program The program source code
      */
     verifyProgram(program: string): boolean;
-    getCreditsRecord(amount: number, nonces: string[], record?: RecordPlaintext | string, params?: RecordSearchParams): Promise<RecordPlaintext>;
+    getCreditsRecord(amount: number, nonces: string[], record?: RecordPlaintext | string, params?: RecordSearchParams): Promise<OwnedRecord>;
 }
 export { ProgramManager, AuthorizationOptions, FeeAuthorizationOptions, ExecuteOptions, ProvingRequestOptions };