@provablehq/wasm 0.8.7 → 0.9.0

package/dist/mainnet/aleo_wasm.d.ts

@@ -1,17 +1,19 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Verify an execution with a single function and a single transition. Executions with multiple
- * transitions or functions will fail to verify. Also, this does not verify that the state root of
- * the execution is included in the Aleo Network ledger.
+ * Verify an execution. Executions with multiple transitions must have the program source code and
+ * verifying keys of imported functions supplied from outside to correctly verify. Also, this does
+ * not verify that the state root of the execution is included in the Aleo Network ledger.
  *
  * @param {Execution} execution The function execution to verify
  * @param {VerifyingKey} verifying_key The verifying key for the function
  * @param {Program} program The program that the function execution belongs to
  * @param {String} function_id The name of the function that was executed
+ * @param {Object} imports The imports for the program in the form of { "program_id.aleo":"source code", ... }
+ * @param {Object} import_verifying_keys The verifying keys for the imports in the form of { "program_id.aleo": [["function, "verifying_key"], ...],  ...}
  * @returns {boolean} True if the execution is valid, false otherwise
  */
-export function verifyFunctionExecution(execution: Execution, verifying_key: VerifyingKey, program: Program, function_id: string): boolean;
+export function verifyFunctionExecution(execution: Execution, verifying_key: VerifyingKey, program: Program, function_id: string, imports?: object | null, imported_verifying_keys?: object | null): boolean;
 export function runRayonThread(receiver: number): void;
 export function initThreadPool(url: URL, num_threads: number): Promise<void>;
 /**
@@ -40,6 +42,54 @@ export class Address {
    * @param {ComputeKey} compute_key The compute key to derive the address from
    */
   static from_compute_key(compute_key: ComputeKey): Address;
+  /**
+   * Get an address from a series of bytes.
+   *
+   * @param {Uint8Array} bytes A left endian byte array representing the address.
+   *
+   * @returns {Address} The address object.
+   */
+  static fromBytesLe(bytes: Uint8Array): Address;
+  /**
+   * Get the left endian byte array representation of the address.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Get an address from a series of bits represented as a boolean array.
+   *
+   * @param {Array} bits A left endian boolean array representing the bits of the address.
+   *
+   * @returns {Address} The address object.
+   */
+  static fromBitsLe(bits: Array<any>): Address;
+  /**
+   * Get the left endian boolean array representation of the bits of the address.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Get an address object from an array of fields.
+   *
+   * @param {Array} fields An array of fields.
+   *
+   * @returns {Plaintext} The address object.
+   */
+  static fromFields(fields: Array<any>): Address;
+  /**
+   * Get the field array representation of the address.
+   */
+  toFields(): Array<any>;
+  /**
+   * Get an address object from a group.
+   *
+   * @param {Group} group The group object.
+   *
+   * @returns {Address} The address object.
+   */
+  static fromGroup(group: Group): Address;
+  /**
+   * Get the group representation of the address object.
+   */
+  toGroup(): Group;
   /**
    * Create an aleo address object from a string representation of an address
    *
@@ -54,6 +104,10 @@ export class Address {
    * @returns {string} String representation of the address
    */
   to_string(): string;
+  /**
+   * Get the plaintext representation of the address.
+   */
+  toPlaintext(): Plaintext;
   /**
    * Verify a signature for a message signed by the address
    *
@@ -214,6 +268,34 @@ export class Ciphertext {
    * @returns {Ciphertext} The Ciphertext object.
    */
   static fromBytesLe(bytes: Uint8Array): Ciphertext;
+  /**
+   * Get the left endian byte array representation of the ciphertext.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Get a ciphertext object from a series of bits represented as a boolean array.
+   *
+   * @param {Array} bits A left endian boolean array representing the bits of the ciphertext.
+   *
+   * @returns {Ciphertext} The ciphertext object.
+   */
+  static fromBitsLe(bits: Array<any>): Ciphertext;
+  /**
+   * Get the left endian boolean array representation of the bits of the ciphertext.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Get a ciphertext object from an array of fields.
+   *
+   * @param {Array} fields An array of fields.
+   *
+   * @returns {Ciphertext} The ciphertext object.
+   */
+  static fromFields(fields: Array<any>): Ciphertext;
+  /**
+   * Get the field array representation of the ciphertext.
+   */
+  toFields(): Array<any>;
   /**
    * Deserialize a Ciphertext string into a Ciphertext object.
    *
@@ -497,6 +579,10 @@ export class Group {
    * Get the left endian boolean array representation of the group element.
    */
   toBitsLe(): Array<any>;
+  /**
+   * Get the field array representation of the group.
+   */
+  toFields(): Array<any>;
   /**
    * Get the x-coordinate of the group element.
    */
@@ -731,11 +817,33 @@ export class Plaintext {
    */
   static fromBytesLe(bytes: Uint8Array): Plaintext;
   /**
-   * Generate a random plaintext element from a series of bytes.
-   *
-   * @param {Uint8Array} bytes A left endian byte array representing the plaintext.
+   * Get the left endian byte array representation of the plaintext.
    */
   toBytesLe(): Uint8Array;
+  /**
+   * Get a plaintext object from a series of bits represented as a boolean array.
+   *
+   * @param {Array} bits A left endian boolean array representing the bits plaintext.
+   *
+   * @returns {Plaintext} The plaintext object.
+   */
+  static fromBitsLe(bits: Array<any>): Plaintext;
+  /**
+   * Get the left endian boolean array representation of the bits of the plaintext.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Get a plaintext object from an array of fields.
+   *
+   * @param {Array} fields An array of fields.
+   *
+   * @returns {Plaintext} The plaintext object.
+   */
+  static fromFields(fields: Array<any>): Plaintext;
+  /**
+   * Get the field array representation of the plaintext.
+   */
+  toFields(): Array<any>;
   /**
    * Returns the string representation of the plaintext.
    *
@@ -1198,7 +1306,7 @@ export class ProgramManager {
    * form \{"program_name1": "program_source_code", "program_name2": "program_source_code", ..\}.
    * Note that all imported programs must be deployed on chain before the main program in order
    * for the deployment to succeed
-   * @param fee_credits The amount of credits to pay as a fee
+   * @param priority_fee_credits The optional priority fee to be paid for the transaction
    * @param fee_record The record to spend the fee from
    * @param url The url of the Aleo network node to send the transaction to
    * @param imports (optional) Provide a list of imports to use for the program deployment in the
@@ -1208,7 +1316,7 @@ export class ProgramManager {
    * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
    * @returns {Transaction}
    */
-  static buildDeploymentTransaction(private_key: PrivateKey, program: string, fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, imports?: object | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildDeploymentTransaction(private_key: PrivateKey, program: string, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, imports?: object | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
   /**
    * Estimate the fee for a program deployment
    *
@@ -1260,7 +1368,7 @@ export class ProgramManager {
    * @param program The source code of the program being executed
    * @param function The name of the function to execute
    * @param inputs A javascript array of inputs to the function
-   * @param fee_credits The amount of credits to pay as a fee
+   * @param priority_fee_credits The optional priority fee to be paid for the transaction
    * @param fee_record The record to spend the fee from
    * @param url The url of the Aleo network node to send the transaction to
    * If this is set to 'true' the keys synthesized (or passed in as optional parameters via the
@@ -1276,7 +1384,7 @@ export class ProgramManager {
    * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
    * @returns {Transaction}
    */
-  static buildExecutionTransaction(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildExecutionTransaction(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
   /**
    * Estimate Fee for Aleo function execution. Note if "cache" is set to true, the proving and
    * verifying keys will be stored in the ProgramManager's memory and used for subsequent
@@ -1316,7 +1424,7 @@ export class ProgramManager {
    * @param private_key The private key of the sender
    * @param record_1 The first record to combine
    * @param record_2 The second record to combine
-   * @param fee_credits The amount of credits to pay as a fee
+   * @param priority_fee_credits The opptional priority fee to be paid for the transaction
    * @param fee_record The record to spend the fee from
    * @param url The url of the Aleo network node to send the transaction to
    * @param join_proving_key (optional) Provide a proving key to use for the join function
@@ -1325,7 +1433,7 @@ export class ProgramManager {
    * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
    * @returns {Transaction} Transaction object
    */
-  static buildJoinTransaction(private_key: PrivateKey, record_1: RecordPlaintext, record_2: RecordPlaintext, fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, join_proving_key?: ProvingKey | null, join_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildJoinTransaction(private_key: PrivateKey, record_1: RecordPlaintext, record_2: RecordPlaintext, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, join_proving_key?: ProvingKey | null, join_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
   /**
    * Split an Aleo credits record into two separate records. This function does not require a fee.
    *
@@ -1347,7 +1455,7 @@ export class ProgramManager {
    * @param recipient The recipient of the transaction
    * @param transfer_type The type of the transfer (options: "private", "public", "private_to_public", "public_to_private")
    * @param amount_record The record to fund the amount from
-   * @param fee_credits The amount of credits to pay as a fee
+   * @param priority_fee_credits The optional priority fee to be paid for the transaction
    * @param fee_record The record to spend the fee from
    * @param url The url of the Aleo network node to send the transaction to
    * @param transfer_verifying_key (optional) Provide a verifying key to use for the transfer
@@ -1356,7 +1464,7 @@ export class ProgramManager {
    * @param fee_verifying_key (optional) Provide a verifying key to use for the fee execution
    * @returns {Transaction}
    */
-  static buildTransferTransaction(private_key: PrivateKey, amount_credits: number, recipient: string, transfer_type: string, amount_record: RecordPlaintext | null | undefined, fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, transfer_proving_key?: ProvingKey | null, transfer_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
+  static buildTransferTransaction(private_key: PrivateKey, amount_credits: number, recipient: string, transfer_type: string, amount_record: RecordPlaintext | null | undefined, priority_fee_credits: number, fee_record?: RecordPlaintext | null, url?: string | null, transfer_proving_key?: ProvingKey | null, transfer_verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null): Promise<Transaction>;
   /**
    * Synthesize proving and verifying keys for a program
    *
@@ -1604,6 +1712,26 @@ export class RecordCiphertext {
    * @returns {Field} tag of the record.
    */
   static tag(graph_key: GraphKey, commitment: Field): Field;
+  /**
+   * Get a record ciphertext object from a series of bytes.
+   *
+   * @param {Uint8Array} bytes A left endian byte array representing the record ciphertext.
+   *
+   * @returns {RecordCiphertext}
+   */
+  static fromBytesLe(bytes: Uint8Array): RecordCiphertext;
+  /**
+   * Get the left endian byte array representation of the record ciphertext.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Get the left endian boolean array representation of the record ciphertext bits.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Get the field array representation of the record ciphertext.
+   */
+  toFields(): Array<any>;
 }
 /**
  * Plaintext representation of an Aleo record
@@ -1682,6 +1810,30 @@ export class RecordPlaintext {
    * @returns {string} String representation of the record plaintext
    */
   toString(): string;
+  /**
+   * Get a record plaintext object from a series of bytes.
+   *
+   * @param {Uint8Array} bytes A left endian byte array representing the record plaintext.
+   *
+   * @returns {RecordPlaintext} The record plaintext.
+   */
+  static fromBytesLe(bytes: Uint8Array): RecordPlaintext;
+  /**
+   * Returns the left endian byte array representation of the record plaintext.
+   *
+   * @returns {Uint8Array} Byte array representation of the record plaintext.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Returns the left endian boolean array representation of the record plaintext bits.
+   *
+   * @returns {Array} Boolean array representation of the record plaintext bits.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Get the field array representation of the record plaintext.
+   */
+  toFields(): Array<any>;
   /**
    * Returns the amount of microcredits in the record
    *
@@ -1828,6 +1980,34 @@ export class Signature {
    * @returns {boolean} True if the signature is valid, false otherwise
    */
   verify(address: Address, message: Uint8Array): boolean;
+  /**
+   * Get a signature from a series of bytes.
+   *
+   * @param {Uint8Array} bytes A left endian byte array representing the signature.
+   *
+   * @returns {Signature} The signature object.
+   */
+  static fromBytesLe(bytes: Uint8Array): Signature;
+  /**
+   * Get the left endian byte array representation of the signature.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Get a signature from a series of bits represented as a boolean array.
+   *
+   * @param {Array} bits A left endian boolean array representing the bits of the signature.
+   *
+   * @returns {Signature} The signature object.
+   */
+  static fromBitsLe(bits: Array<any>): Signature;
+  /**
+   * Get the left endian boolean array representation of the bits of the signature.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Get the field array representation of the signature.
+   */
+  toFields(): Array<any>;
   /**
    * Get a signature from a string representation of a signature
    *
@@ -1841,6 +2021,10 @@ export class Signature {
    * @returns {string} String representation of a signature
    */
   to_string(): string;
+  /**
+   * Get the plaintext representation of the signature.
+   */
+  toPlaintext(): Plaintext;
 }
 /**
  * Webassembly Representation of an Aleo transaction