@provablehq/sdk 0.8.1 → 0.8.2

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * Aleo function Input represented as a typed typescript object.
+ */
+import { Ciphertext, Field, Plaintext } from "../../wasm";
+import { PlaintextObject } from "../plaintext/plaintext";
+/**
+ * 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;
+}

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Aleo function Input represented as a typed typescript object.
+ */
+import { Field, Ciphertext, Plaintext } from "../../wasm";
+import { PlaintextObject } from "../plaintext/plaintext";
+/**
+ * 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>;
+}

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/mainnet/models/transaction/transactionJSON.d.ts

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

package/dist/mainnet/models/transaction/transactionObject.d.ts

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

package/dist/mainnet/models/transition/transitionJSON.d.ts

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

package/dist/mainnet/models/transition/transitionObject.d.ts

@@ -0,0 +1,15 @@
+import { InputObject } from "../input/inputObject";
+import { OutputObject } from "../output/outputObject";
+import { Field, Group } from "../../wasm";
+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;
+}

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

@@ -0,0 +1,358 @@
+import { Account } from "./account";
+import { BlockJSON } from "./models/blockJSON";
+import { TransactionJSON } from "./models/transaction/transactionJSON";
+import { Plaintext, Program, RecordPlaintext, PrivateKey, Transaction } from "./wasm";
+import { ConfirmedTransactionJSON } from "./models/confirmed_transaction";
+type ProgramImports = {
+    [key: string]: string | Program;
+};
+interface AleoNetworkClientOptions {
+    headers?: {
+        [key: string]: 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.
+ *
+ * @param {string} host
+ * @example
+ * // Connection to a local node
+ * const localNetworkClient = new AleoNetworkClient("http://localhost:3030");
+ *
+ * // Connection to a public beacon node
+ * const publicnetworkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+ */
+declare class AleoNetworkClient {
+    host: string;
+    headers: {
+        [key: string]: string;
+    };
+    account: Account | undefined;
+    constructor(host: string, options?: AleoNetworkClientOptions);
+    /**
+     * Set an account to use in networkClient calls
+     *
+     * @param {Account} account
+     * @example
+     * const account = new Account();
+     * networkClient.setAccount(account);
+     */
+    setAccount(account: Account): void;
+    /**
+     * Return the Aleo account used in the networkClient
+     *
+     * @example
+     * const account = networkClient.getAccount();
+     */
+    getAccount(): Account | undefined;
+    /**
+     * Set a new host for the networkClient
+     *
+     * @param {string} host The address of a node hosting the Aleo API
+     * @param host
+     */
+    setHost(host: string): void;
+    /**
+     * Fetches data from the Aleo network and returns it as a JSON object.
+     *
+     * @param url
+     */
+    fetchData<Type>(url?: string): Promise<Type>;
+    /**
+     * Fetches data from the Aleo network and returns it as an unparsed string.
+     *
+     * This method should be used when it is desired to reconstitute data returned
+     * from the network into a WASM object.
+     *
+     * @param url
+     */
+    fetchRaw(url?: string): Promise<string>;
+    /**
+     * Attempts to find unspent records in the Aleo blockchain for a specified private key.
+     * @param {number} startHeight - The height at which to start searching for unspent records
+     * @param {number} endHeight - The height at which to stop searching for unspent records
+     * @param {string | PrivateKey} privateKey - The private key to use to find unspent records
+     * @param {number[]} amounts - The amounts (in microcredits) to search for (eg. [100, 200, 3000])
+     * @param {number} maxMicrocredits - The maximum number of microcredits to search for
+     * @param {string[]} nonces - The nonces of already found records to exclude from the search
+     *
+     * @example
+     * // Find all unspent records
+     * const privateKey = "[PRIVATE_KEY]";
+     * const records = networkClient.findUnspentRecords(0, undefined, privateKey);
+     *
+     * // Find specific amounts
+     * const startHeight = 500000;
+     * const amounts = [600000, 1000000];
+     * const records = networkClient.findUnspentRecords(startHeight, undefined, privateKey, amounts);
+     *
+     * // Find specific amounts with a maximum number of cumulative microcredits
+     * const maxMicrocredits = 100000;
+     * const records = networkClient.findUnspentRecords(startHeight, undefined, privateKey, undefined, maxMicrocredits);
+     */
+    findUnspentRecords(startHeight: number, endHeight: number | undefined, privateKey: string | PrivateKey | undefined, amounts: number[] | undefined, maxMicrocredits?: number | undefined, nonces?: string[] | undefined): Promise<Array<RecordPlaintext>>;
+    /**
+     * Returns the contents of the block at the specified block height.
+     *
+     * @param {number} height
+     * @example
+     * const block = networkClient.getBlock(1234);
+     */
+    getBlock(height: number): Promise<BlockJSON>;
+    /**
+     * Returns a range of blocks between the specified block heights.
+     *
+     * @param {number} start
+     * @param {number} end
+     * @example
+     * const blockRange = networkClient.getBlockRange(2050, 2100);
+     */
+    getBlockRange(start: number, end: number): Promise<Array<BlockJSON>>;
+    /**
+     * Returns the deployment transaction id associated with the specified program.
+     *
+     * @param {Program | string} program
+     * @returns {TransactionJSON}
+     */
+    getDeploymentTransactionIDForProgram(program: Program | string): Promise<string>;
+    /**
+     * Returns the deployment transaction associated with a specified program.
+     *
+     * @param {Program | string} program
+     * @returns {TransactionJSON}
+     */
+    getDeploymentTransactionForProgram(program: Program | string): Promise<TransactionJSON>;
+    /**
+     * Returns the deployment transaction associated with a specified program as a wasm object.
+     *
+     * @param {Program | string} program
+     * @returns {TransactionJSON}
+     */
+    getDeploymentTransactioObjectnForProgram(program: Program | string): Promise<Transaction>;
+    /**
+     * Returns the contents of the latest block.
+     *
+     * @example
+     * const latestHeight = networkClient.getLatestBlock();
+     */
+    getLatestBlock(): Promise<BlockJSON>;
+    /**
+     * Returns the latest committee.
+     *
+     * @returns {Promise<object>} A javascript object containing the latest committee
+     */
+    getLatestCommittee(): Promise<object>;
+    /**
+     * Returns the latest block height.
+     *
+     * @example
+     * const latestHeight = networkClient.getLatestHeight();
+     */
+    getLatestHeight(): Promise<number>;
+    /**
+     * Returns the source code of a program given a program ID.
+     *
+     * @param {string} programId The program ID of a program deployed to the Aleo Network
+     * @return {Promise<string>} Source code of the program
+     *
+     * @example
+     * const program = networkClient.getProgram("hello_hello.aleo");
+     * const expectedSource = "program hello_hello.aleo;\n\nfunction hello:\n    input r0 as u32.public;\n    input r1 as u32.private;\n    add r0 r1 into r2;\n    output r2 as u32.private;\n"
+     * assert.equal(program, expectedSource);
+     */
+    getProgram(programId: string): Promise<string>;
+    /**
+     * Returns a program object from a program ID or program source code.
+     *
+     * @param {string} inputProgram The program ID or program source code of a program deployed to the Aleo Network
+     * @return {Promise<Program>} Source code of the program
+     *
+     * @example
+     * const programID = "hello_hello.aleo";
+     * const programSource = "program hello_hello.aleo;\n\nfunction hello:\n    input r0 as u32.public;\n    input r1 as u32.private;\n    add r0 r1 into r2;\n    output r2 as u32.private;\n"
+     *
+     * // Get program object from program ID or program source code
+     * const programObjectFromID = await networkClient.getProgramObject(programID);
+     * const programObjectFromSource = await networkClient.getProgramObject(programSource);
+     *
+     * // Both program objects should be equal
+     * assert.equal(programObjectFromID.to_string(), programObjectFromSource.to_string());
+     */
+    getProgramObject(inputProgram: string): Promise<Program>;
+    /**
+     *  Returns an object containing the source code of a program and the source code of all programs it imports
+     *
+     * @param {Program | string} inputProgram The program ID or program source code of a program deployed to the Aleo Network
+     * @returns {Promise<ProgramImports>} Object of the form { "program_id": "program_source", .. } containing program id & source code for all program imports
+     *
+     * @example
+     * const double_test_source = "import multiply_test.aleo;\n\nprogram double_test.aleo;\n\nfunction double_it:\n    input r0 as u32.private;\n    call multiply_test.aleo/multiply 2u32 r0 into r1;\n    output r1 as u32.private;\n"
+     * const double_test = Program.fromString(double_test_source);
+     * const expectedImports = {
+     *     "multiply_test.aleo": "program multiply_test.aleo;\n\nfunction multiply:\n    input r0 as u32.public;\n    input r1 as u32.private;\n    mul r0 r1 into r2;\n    output r2 as u32.private;\n"
+     * }
+     *
+     * // Imports can be fetched using the program ID, source code, or program object
+     * let programImports = await networkClient.getProgramImports("double_test.aleo");
+     * assert.deepStrictEqual(programImports, expectedImports);
+     *
+     * // Using the program source code
+     * programImports = await networkClient.getProgramImports(double_test_source);
+     * assert.deepStrictEqual(programImports, expectedImports);
+     *
+     * // Using the program object
+     * programImports = await networkClient.getProgramImports(double_test);
+     * assert.deepStrictEqual(programImports, expectedImports);
+     */
+    getProgramImports(inputProgram: Program | string): Promise<ProgramImports>;
+    /**
+     * Get a list of the program names that a program imports.
+     *
+     * @param {Program | string} inputProgram - The program id or program source code to get the imports of
+     * @returns {string[]} - The list of program names that the program imports
+     *
+     * @example
+     * const programImportsNames = networkClient.getProgramImports("double_test.aleo");
+     * const expectedImportsNames = ["multiply_test.aleo"];
+     * assert.deepStrictEqual(programImportsNames, expectedImportsNames);
+     */
+    getProgramImportNames(inputProgram: Program | string): Promise<string[]>;
+    /**
+     * Returns the names of the mappings of a program.
+     *
+     * @param {string} programId - The program ID to get the mappings of (e.g. "credits.aleo")
+     * @example
+     * const mappings = networkClient.getProgramMappingNames("credits.aleo");
+     * const expectedMappings = ["account"];
+     * assert.deepStrictEqual(mappings, expectedMappings);
+     */
+    getProgramMappingNames(programId: string): Promise<Array<string>>;
+    /**
+     * Returns the value of a program's mapping for a specific key.
+     *
+     * @param {string} programId - The program ID to get the mapping value of (e.g. "credits.aleo")
+     * @param {string} mappingName - The name of the mapping to get the value of (e.g. "account")
+     * @param {string | Plaintext} key - The key of the mapping to get the value of (e.g. "aleo1rhgdu77hgyqd3xjj8ucu3jj9r2krwz6mnzyd80gncr5fxcwlh5rsvzp9px")
+     * @return {Promise<string>} String representation of the value of the mapping
+     *
+     * @example
+     * // Get public balance of an account
+     * const mappingValue = networkClient.getMappingValue("credits.aleo", "account", "aleo1rhgdu77hgyqd3xjj8ucu3jj9r2krwz6mnzyd80gncr5fxcwlh5rsvzp9px");
+     * const expectedValue = "0u64";
+     * assert.equal(mappingValue, expectedValue);
+     */
+    getProgramMappingValue(programId: string, mappingName: string, key: string | Plaintext): Promise<string>;
+    /**
+     * Returns the value of a mapping as a wasm Plaintext object. Returning an
+     * object in this format allows it to be converted to a Js type and for its
+     * internal members to be inspected if it's a struct or array.
+     *
+     * @example
+     * // Get the bond state as an account.
+     * const unbondedState = networkClient.getMappingPlaintext("credits.aleo", "bonded", "aleo1rhgdu77hgyqd3xjj8ucu3jj9r2krwz6mnzyd80gncr5fxcwlh5rsvzp9px");
+     *
+     * // Get the two members of the object individually.
+     * const validator = unbondedState.getMember("validator");
+     * const microcredits = unbondedState.getMember("microcredits");
+     *
+     * // Ensure the expected values are correct.
+     * assert.equal(validator, "aleo1u6940v5m0fzud859xx2c9tj2gjg6m5qrd28n636e6fdd2akvfcgqs34mfd");
+     * assert.equal(microcredits, BigInt("9007199254740991"));
+     *
+     * // Get a JS object representation of the unbonded state.
+     * const unbondedStateObject = unbondedState.toObject();
+     *
+     * const expectedState = {
+     *     validator: "aleo1u6940v5m0fzud859xx2c9tj2gjg6m5qrd28n636e6fdd2akvfcgqs34mfd",
+     *     microcredits: BigInt("9007199254740991")
+     * };
+     * assert.equal(unbondedState, expectedState);
+     *
+     * @param {string} programId - The program ID to get the mapping value of (e.g. "credits.aleo")
+     * @param {string} mappingName - The name of the mapping to get the value of (e.g. "account")
+     * @param {string | Plaintext} key - The key of the mapping to get the value of (e.g. "aleo1rhgdu77hgyqd3xjj8ucu3jj9r2krwz6mnzyd80gncr5fxcwlh5rsvzp9px")
+     *
+     * @return {Promise<string>} String representation of the value of the mapping
+     */
+    getProgramMappingPlaintext(programId: string, mappingName: string, key: string | Plaintext): Promise<Plaintext>;
+    /**
+     * Returns the latest state/merkle root of the Aleo blockchain.
+     *
+     * @example
+     * const stateRoot = networkClient.getStateRoot();
+     */
+    getStateRoot(): Promise<string>;
+    /**
+     * Returns a transaction by its unique identifier.
+     *
+     * @param {string} id
+     * @example
+     * const transaction = networkClient.getTransaction("at1handz9xjrqeynjrr0xay4pcsgtnczdksz3e584vfsgaz0dh0lyxq43a4wj");
+     */
+    getTransaction(transactionId: string): Promise<TransactionJSON>;
+    /**
+     * Returns a transaction as a wasm object. Getting a transaction of this type will allow the ability for the inputs,
+     * outputs, and records to be searched for and displayed.
+     *
+     * @example
+     * const transactionObject = networkClient.getTransaction("at1handz9xjrqeynjrr0xay4pcsgtnczdksz3e584vfsgaz0dh0lyxq43a4wj");
+     * // Get the transaction inputs as a JS array.
+     * const transactionOutputs = transactionObject.inputs(true);
+     *
+     * // Get the transaction outputs as a JS object.
+     * const transactionInputs = transactionObject.outputs(true);
+     *
+     * // Get any records generated in transitions in the transaction as a JS object.
+     * const records = transactionObject.records();
+     *
+     * // Get the transaction type.
+     * const transactionType = transactionObject.transactionType();
+     * assert.equal(transactionType, "Execute");
+     *
+     * // Get a JS representation of all inputs, outputs, and transaction metadata.
+     * const transactionSummary = transactionObject.summary();
+     *
+     * @param {string} transactionId
+     * @example
+     * const transaction = networkClient.getTransactionObject("at1handz9xjrqeynjrr0xay4pcsgtnczdksz3e584vfsgaz0dh0lyxq43a4wj");
+     */
+    getTransactionObject(transactionId: string): Promise<Transaction>;
+    /**
+     * Returns the transactions present at the specified block height.
+     *
+     * @param {number} height
+     * @example
+     * const transactions = networkClient.getTransactions(654);
+     */
+    getTransactions(height: number): Promise<Array<ConfirmedTransactionJSON>>;
+    /**
+     * Returns the transactions in the memory pool. This method requires access to a validator's REST API.
+     *
+     * @example
+     * const transactions = networkClient.getTransactionsInMempool();
+     */
+    getTransactionsInMempool(): Promise<Array<TransactionJSON>>;
+    /**
+     * Returns the transition ID of the transition corresponding to the ID of the input or output.
+     * @param {string} inputOrOutputID - ID of the input or output.
+     *
+     * @example
+     * const transitionId = networkClient.getTransitionId("2429232855236830926144356377868449890830704336664550203176918782554219952323field");
+     */
+    getTransitionId(inputOrOutputID: string): Promise<string>;
+    /**
+     * Submit an execute or deployment transaction to the Aleo network.
+     *
+     * @param {Transaction | string} transaction  - The transaction to submit to the network
+     * @returns {string} - The transaction id of the submitted transaction or the resulting error
+     */
+    submitTransaction(transaction: Transaction | string): Promise<string>;
+    /**
+     * Submit a solution to the Aleo network.
+     *
+     * @param {string} solution The string representation of the solution desired to be submitted to the network.
+     */
+    submitSolution(solution: string): Promise<string>;
+}
+export { AleoNetworkClient, AleoNetworkClientOptions, ProgramImports };

package/dist/mainnet/node-polyfill.d.ts

@@ -0,0 +1,5 @@
+import "./polyfill/shared";
+import "./polyfill/crypto";
+import "./polyfill/fetch";
+import "./polyfill/xmlhttprequest";
+import "./polyfill/worker";