@provablehq/wasm 0.6.13 → 0.7.0

package/README.md

@@ -1,5 +1,5 @@
 [![Crates.io](https://img.shields.io/crates/v/aleo-wasm.svg?color=neon)](https://crates.io/crates/aleo-wasm)
-[![Authors](https://img.shields.io/badge/authors-Aleo-orange.svg)](https://aleo.org)
+[![Authors](https://img.shields.io/badge/authors-Aleo-orange.svg)](https://provable.com)
 [![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.md)
 
 [![github]](https://github.com/ProvableHQ/sdk) [![crates-io]](https://crates.io/crates/aleo-wasm) [![docs-rs]](https://docs.rs/aleo-wasm/latest/aleo-wasm/)
@@ -12,9 +12,9 @@
 
 Aleo JavaScript and WebAssembly bindings for building zero-knowledge web applications.
 
-`Rust` compiles easily to `WebAssembly`, but creating the glue code necessary to use compiled WebAssembly binaries 
-from other languages such as JavaScript is a challenging task. `wasm-bindgen` is a tool that simplifies this process by 
-auto-generating JavaScript bindings to Rust code that has been compiled into WebAssembly. 
+`Rust` compiles easily to `WebAssembly`, but creating the glue code necessary to use compiled WebAssembly binaries
+from other languages such as JavaScript is a challenging task. `wasm-bindgen` is a tool that simplifies this process by
+auto-generating JavaScript bindings to Rust code that has been compiled into WebAssembly.
 
 This crate uses `wasm-bindgen` to create JavaScript bindings to Aleo source code so that it can be used to create zero-knowledge proofs directly within web browsers and `Node.js`.
 
@@ -56,7 +56,7 @@ wasm-pack test --[firefox/chrome/safari]
 
 ## Building Web Apps
 
-Further documentation and tutorials as to how to use the modules built from this crate to build web apps will be built 
+Further documentation and tutorials as to how to use the modules built from this crate to build web apps will be built
 in the future. However, in the meantime, the [provable.tools](https://provable.tools) website is a good
-example of how to use these modules to build a web app. Its source code can be found in the 
+example of how to use these modules to build a web app. Its source code can be found in the
 [Aleo SDK](https://github.com/ProvableHQ/sdk) repo in the `website` folder.

package/dist/{crates → mainnet}/aleo_wasm.d.ts

@@ -181,14 +181,14 @@ export class KeyPair {
 /**
 * Get the proving key. This method will remove the proving key from the key pair
 *
-* @returns {ProvingKey | Error}
+* @returns {ProvingKey}
 * @returns {ProvingKey}
 */
   provingKey(): ProvingKey;
 /**
 * Get the verifying key. This method will remove the verifying key from the key pair
 *
-* @returns {VerifyingKey | Error}
+* @returns {VerifyingKey}
 * @returns {VerifyingKey}
 */
   verifyingKey(): VerifyingKey;
@@ -374,7 +374,7 @@ export class PrivateKey {
 * and will be needed to decrypt the private key later, so it should be stored securely
 *
 * @param {string} secret Secret used to encrypt the private key
-* @returns {PrivateKeyCiphertext | Error} Ciphertext representation of the private key
+* @returns {PrivateKeyCiphertext} Ciphertext representation of the private key
 * @param {string} secret
 * @returns {PrivateKeyCiphertext}
 */
@@ -384,7 +384,7 @@ export class PrivateKey {
 * decrypt the private key later, so it should be stored securely
 *
 * @param {string} secret Secret used to encrypt the private key
-* @returns {PrivateKeyCiphertext | Error} Ciphertext representation of the private key
+* @returns {PrivateKeyCiphertext} Ciphertext representation of the private key
 * @param {string} secret
 * @returns {PrivateKeyCiphertext}
 */
@@ -394,7 +394,7 @@ export class PrivateKey {
 *
 * @param {PrivateKeyCiphertext} ciphertext Ciphertext representation of the private key
 * @param {string} secret Secret originally used to encrypt the private key
-* @returns {PrivateKey | Error} Private key
+* @returns {PrivateKey} Private key
 * @param {PrivateKeyCiphertext} ciphertext
 * @param {string} secret
 * @returns {PrivateKey}
@@ -412,7 +412,7 @@ export class PrivateKeyCiphertext {
 *
 * @param {PrivateKey} private_key Private key to encrypt
 * @param {string} secret Secret to encrypt the private key with
-* @returns {PrivateKeyCiphertext | Error} Private key ciphertext
+* @returns {PrivateKeyCiphertext} Private key ciphertext
 * @param {PrivateKey} private_key
 * @param {string} secret
 * @returns {PrivateKeyCiphertext}
@@ -423,7 +423,7 @@ export class PrivateKeyCiphertext {
 * encrypt the private key
 *
 * @param {string} secret Secret used to encrypt the private key
-* @returns {PrivateKey | Error} Private key
+* @returns {PrivateKey} Private key
 * @param {string} secret
 * @returns {PrivateKey}
 */
@@ -439,7 +439,7 @@ export class PrivateKeyCiphertext {
 * Creates a PrivateKeyCiphertext from a string
 *
 * @param {string} ciphertext Ciphertext string
-* @returns {PrivateKeyCiphertext | Error} Private key ciphertext
+* @returns {PrivateKeyCiphertext} Private key ciphertext
 * @param {string} ciphertext
 * @returns {PrivateKeyCiphertext}
 */
@@ -454,7 +454,7 @@ export class Program {
 * Create a program from a program string
 *
 * @param {string} program Aleo program source code
-* @returns {Program | Error} Program object
+* @returns {Program} Program object
 * @param {string} program
 * @returns {Program}
 */
@@ -503,7 +503,7 @@ export class Program {
 * to generate a web form to capture user inputs for an execution of a function.
 *
 * @param {string} function_name Name of the function to get inputs for
-* @returns {Array | Error} Array of function inputs
+* @returns {Array} Array of function inputs
 *
 * @example
 * const expected_inputs = [
@@ -542,7 +542,7 @@ export class Program {
 /**
 * Get a the list of a program's mappings and the names/types of their keys and values.
 *
-* @returns {Array | Error} - An array of objects representing the mappings in the program
+* @returns {Array} - An array of objects representing the mappings in the program
 * @example
 * const expected_mappings = [
 *    {
@@ -564,7 +564,7 @@ export class Program {
 * Get a javascript object representation of a program record and its types
 *
 * @param {string} record_name Name of the record to get members for
-* @returns {Object | Error} Object containing the record name, type, and members
+* @returns {Object} Object containing the record name, type, and members
 *
 * @example
 *
@@ -596,7 +596,7 @@ export class Program {
 * Get a javascript object representation of a program struct and its types
 *
 * @param {string} struct_name Name of the struct to get members for
-* @returns {Array | Error} Array containing the struct members
+* @returns {Array} Array containing the struct members
 *
 * @example
 *
@@ -721,7 +721,7 @@ export class ProgramManager {
 * are a string representing the program source code \{ "hello.aleo": "hello.aleo source code" \}
 * @param fee_proving_key (optional) Provide a proving key to use for the fee execution
 * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
-* @returns {Transaction | Error}
+* @returns {Transaction}
 * @param {PrivateKey} private_key
 * @param {string} program
 * @param {number} fee_credits
@@ -743,7 +743,7 @@ export class ProgramManager {
 * @param imports (optional) Provide a list of imports to use for the deployment fee estimation
 * in the form of a javascript object where the keys are a string of the program name and the values
 * are a string representing the program source code \{ "hello.aleo": "hello.aleo source code" \}
-* @returns {u64 | Error}
+* @returns {u64}
 * @param {string} program
 * @param {object | undefined} [imports]
 * @returns {Promise<bigint>}
@@ -757,7 +757,7 @@ export class ProgramManager {
 * Disclaimer: Fee estimation is experimental and may not represent a correct estimate on any current or future network
 *
 * @param name The name of the program to be deployed
-* @returns {u64 | Error}
+* @returns {u64}
 * @param {string} name
 * @returns {bigint}
 */
@@ -816,7 +816,7 @@ export class ProgramManager {
 * @param verifying_key (optional) Provide a verifying key to use for the function execution
 * @param fee_proving_key (optional) Provide a proving key to use for the fee execution
 * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
-* @returns {Transaction | Error}
+* @returns {Transaction}
 * @param {PrivateKey} private_key
 * @param {string} program
 * @param {string} _function
@@ -850,7 +850,7 @@ export class ProgramManager {
 * are a string representing the program source code \{ "hello.aleo": "hello.aleo source code" \}
 * @param proving_key (optional) Provide a verifying key to use for the fee estimation
 * @param verifying_key (optional) Provide a verifying key to use for the fee estimation
-* @returns {u64 | Error} Fee in microcredits
+* @returns {u64} Fee in microcredits
 * @param {PrivateKey} private_key
 * @param {string} program
 * @param {string} _function
@@ -872,7 +872,7 @@ export class ProgramManager {
 *
 * @param program The program containing the function to estimate the finalize fee for
 * @param function The function to estimate the finalize fee for
-* @returns {u64 | Error} Fee in microcredits
+* @returns {u64} Fee in microcredits
 * @param {string} program
 * @param {string} _function
 * @returns {bigint}
@@ -892,7 +892,7 @@ export class ProgramManager {
 * @param join_verifying_key (optional) Provide a verifying key to use for the join function
 * @param fee_proving_key (optional) Provide a proving key to use for the fee execution
 * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
-* @returns {Transaction | Error} Transaction object
+* @returns {Transaction} Transaction object
 * @param {PrivateKey} private_key
 * @param {RecordPlaintext} record_1
 * @param {RecordPlaintext} record_2
@@ -917,7 +917,7 @@ export class ProgramManager {
 * @param url The url of the Aleo network node to send the transaction to
 * @param split_proving_key (optional) Provide a proving key to use for the split function
 * @param split_verifying_key (optional) Provide a verifying key to use for the split function
-* @returns {Transaction | Error} Transaction object
+* @returns {Transaction} Transaction object
 * @param {PrivateKey} private_key
 * @param {number} split_amount
 * @param {RecordPlaintext} amount_record
@@ -943,7 +943,7 @@ export class ProgramManager {
 * function
 * @param fee_proving_key (optional) Provide a proving key to use for the fee execution
 * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
-* @returns {Transaction | Error}
+* @returns {Transaction}
 * @param {PrivateKey} private_key
 * @param {number} amount_credits
 * @param {string} recipient
@@ -1164,7 +1164,7 @@ export class ProvingKey {
 * Construct a new proving key from a byte array
 *
 * @param {Uint8Array} bytes Byte array representation of a proving key
-* @returns {ProvingKey | Error}
+* @returns {ProvingKey}
 * @param {Uint8Array} bytes
 * @returns {ProvingKey}
 */
@@ -1172,7 +1172,7 @@ export class ProvingKey {
 /**
 * Create a proving key from string
 *
-* @param {string | Error} String representation of the proving key
+* @param {string} String representation of the proving key
 * @param {string} string
 * @returns {ProvingKey}
 */
@@ -1180,7 +1180,7 @@ export class ProvingKey {
 /**
 * Return the byte representation of a proving key
 *
-* @returns {Uint8Array | Error} Byte array representation of a proving key
+* @returns {Uint8Array} Byte array representation of a proving key
 * @returns {Uint8Array}
 */
   toBytes(): Uint8Array;
@@ -1201,7 +1201,7 @@ export class RecordCiphertext {
 * Create a record ciphertext from a string
 *
 * @param {string} record String representation of a record ciphertext
-* @returns {RecordCiphertext | Error} Record ciphertext
+* @returns {RecordCiphertext} Record ciphertext
 * @param {string} record
 * @returns {RecordCiphertext}
 */
@@ -1218,7 +1218,7 @@ export class RecordCiphertext {
 * decrypt if the record was encrypted by the account corresponding to the view key
 *
 * @param {ViewKey} view_key View key used to decrypt the ciphertext
-* @returns {RecordPlaintext | Error} Record plaintext object
+* @returns {RecordPlaintext} Record plaintext object
 * @param {ViewKey} view_key
 * @returns {RecordPlaintext}
 */
@@ -1248,7 +1248,7 @@ export class RecordPlaintext {
 * Return a record plaintext from a string.
 *
 * @param {string} record String representation of a plaintext representation of an Aleo record
-* @returns {RecordPlaintext | Error} Record plaintext
+* @returns {RecordPlaintext} Record plaintext
 * @param {string} record
 * @returns {RecordPlaintext}
 */
@@ -1280,7 +1280,7 @@ export class RecordPlaintext {
 * @param {PrivateKey} private_key Private key of the account that owns the record
 * @param {string} program_id Program ID of the program that the record is associated with
 * @param {string} record_name Name of the record
-* @returns {string | Error} Serial number of the record
+* @returns {string} Serial number of the record
 * @param {PrivateKey} private_key
 * @param {string} program_id
 * @param {string} record_name
@@ -1344,7 +1344,7 @@ export class Transaction {
 * Create a transaction from a string
 *
 * @param {string} transaction String representation of a transaction
-* @returns {Transaction | Error}
+* @returns {Transaction}
 * @param {string} transaction
 * @returns {Transaction}
 */
@@ -1609,7 +1609,7 @@ export class VerifyingKey {
 * Construct a new verifying key from a byte array
 *
 * @param {Uint8Array} bytes Byte representation of a verifying key
-* @returns {VerifyingKey | Error}
+* @returns {VerifyingKey}
 * @param {Uint8Array} bytes
 * @returns {VerifyingKey}
 */
@@ -1618,7 +1618,7 @@ export class VerifyingKey {
 * Create a verifying key from string
 *
 * @param {String} string String representation of a verifying key
-* @returns {VerifyingKey | Error}
+* @returns {VerifyingKey}
 * @param {string} string
 * @returns {VerifyingKey}
 */
@@ -1626,7 +1626,7 @@ export class VerifyingKey {
 /**
 * Create a byte array from a verifying key
 *
-* @returns {Uint8Array | Error} Byte representation of a verifying key
+* @returns {Uint8Array} Byte representation of a verifying key
 * @returns {Uint8Array}
 */
   toBytes(): Uint8Array;