@provablehq/wasm 0.9.3 → 0.9.4

package/dist/mainnet/aleo_wasm.d.ts

@@ -13,7 +13,7 @@
  * @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, imports?: object | null, imported_verifying_keys?: object | null): boolean;
+export function verifyFunctionExecution(execution: Execution, verifying_key: VerifyingKey, program: Program, function_id: string, imports: object | null | undefined, imported_verifying_keys: object | null | undefined, block_height: number): boolean;
 export function runRayonThread(receiver: number): void;
 export function initThreadPool(url: URL, num_threads: number): Promise<void>;
 /**
@@ -305,6 +305,80 @@ export class BHP768 {
    */
   commitToGroup(input: Array<any>, randomizer: Scalar): Group;
 }
+/**
+ * Boolean element.
+ */
+export class Boolean {
+  free(): void;
+  /**
+   * Creates a Boolean from a native JS bool.
+   */
+  constructor(value: boolean);
+  /**
+   * Creates a boolean object from a string representation ("true"/"false").
+   */
+  static fromString(boolean: string): Boolean;
+  /**
+   * Returns the string representation of the boolean element.
+   */
+  toString(): string;
+  /**
+   * Create a boolean element from a Uint8Array of left endian bytes.
+   */
+  static fromBytesLe(bytes: Uint8Array): Boolean;
+  /**
+   * Encode the boolean element as a Uint8Array of left endian bytes.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Reconstruct a boolean element from a boolean array representation.
+   */
+  static fromBitsLe(bits: Array<any>): Boolean;
+  /**
+   * Get the left endian boolean array representation of the boolean element.
+   */
+  toBitsLe(): Array<any>;
+  /**
+   * Create a plaintext from the boolean element.
+   */
+  toPlaintext(): Plaintext;
+  /**
+   * Clone the boolean element.
+   */
+  clone(): Boolean;
+  /**
+   * Generate a random boolean element.
+   */
+  static random(): Boolean;
+  /**
+   * Logical NOT.
+   */
+  not(): Boolean;
+  /**
+   * Logical AND.
+   */
+  and(other: Boolean): Boolean;
+  /**
+   * Logical OR.
+   */
+  or(other: Boolean): Boolean;
+  /**
+   * Logical XOR.
+   */
+  xor(other: Boolean): Boolean;
+  /**
+   * Logical NAND.
+   */
+  nand(other: Boolean): Boolean;
+  /**
+   * Logical NOR.
+   */
+  nor(other: Boolean): Boolean;
+  /**
+   * Check if one boolean element equals another.
+   */
+  equals(other: Boolean): boolean;
+}
 /**
  * SnarkVM Ciphertext object. A Ciphertext represents an symmetrically encrypted plaintext. This
  * object provides decryption methods to recover the plaintext from the ciphertext (given the
@@ -325,10 +399,25 @@ export class Ciphertext {
   /**
    * Decrypt a ciphertext using the view key of the transition signer, transition public key, and
    * (program, function, index) tuple.
+   *
+   * @param {ViewKey} view_key The view key of the transition signer.
+   * @param {Group} transition_public_key The transition public key used to encrypt the ciphertext.
+   * @param {string} program The program ID associated with the ciphertext.
+   * @param {string} function_name The name of the function associated with the encrypted inputs and outputs.
+   * @param {u16} index The index of the input or output parameter that was encrypted.
+   *
+   * @returns {Plaintext} The decrypted plaintext.
    */
   decryptWithTransitionInfo(view_key: ViewKey, transition_public_key: Group, program: string, function_name: string, index: number): Plaintext;
   /**
    * Decrypt a ciphertext using the transition view key and a (program, function, index) tuple.
+   *
+   * @param {Field} transition_view_key The transition view key that was used to encrypt the ciphertext.
+   * @param {string} program The program ID associated with the ciphertext.
+   * @param {string} function_name The name of the function associated with the encrypted inputs and outputs.
+   * @param {u16} index The index of the input or output parameter that was encrypted.
+   *
+   * @returns {Plaintext} The decrypted plaintext.
    */
   decryptWithTransitionViewKey(transition_view_key: Field, program: string, function_name: string, index: number): Plaintext;
   /**
@@ -437,20 +526,40 @@ export class EncryptionToolkit {
   free(): void;
   /**
    * Generates a transition view key from the view key and the transition public key.
+   *
+   * @param {ViewKey} view_key The view key of the account that generated the transition.
+   * @param {Group} tpk The transition public key.
+   *
+   * @returns {Field} The transition view key.
    */
   static generateTvk(view_key: ViewKey, tpk: Group): Field;
   /**
    * Creates a record view key from the view key.  This can be later be used to decrypt a
+   *
+   * @param {ViewKey} view_key The view key of the owner of the record.
+   * @param {RecordCiphertext} record_ciphertext The record ciphertext used to derive the record view key.
+   *
+   * @returns {Field} The record view key.
    */
   static generateRecordViewKey(view_key: ViewKey, record_ciphertext: RecordCiphertext): Field;
   /**
    * Decrypts a record ciphertext using the record view key.  Decryption only succeeds
    * if the record view key was generated from the view key of the record owner.
+   *
+   * @param {Field} record_vk The record view key.
+   * @param {RecordCiphertext} record_ciphertext The record ciphertext to decrypt.
+   *
+   * @returns {RecordPlaintext} The decrypted record plaintext.
    */
   static decryptRecordWithRVk(record_vk: Field, record_ciphertext: RecordCiphertext): RecordPlaintext;
   /**
    * Decrypts a transition using the transition view key.  The ciphertext inputs and outputs
    * can only be decrypted if the transition view key was generated by the transaction signer.
+   *
+   * @param {Transition} transition The transition to decrypt.
+   * @param {Field} transition_vk The transition view key.
+   *
+   * @returns {Transition} The decrypted transition.
    */
   static decryptTransitionWithVk(transition: Transition, transition_vk: Field): Transition;
 }
@@ -496,10 +605,14 @@ export class ExecutionRequest {
   free(): void;
   /**
    * Returns the request as a string.
+   *
+   * @returns {string} String representation of the request.
    */
   toString(): string;
   /**
    * Builds a request object from a string representation of a request.
+   *
+   * @param {string} request String representation of the request.
    */
   static fromString(request: string): ExecutionRequest;
   /**
@@ -880,25 +993,36 @@ export class OfflineQuery {
   free(): void;
   /**
    * Creates a new offline query object. The state root is required to be passed in as a string
+   *
+   * @param {u32} block_height The block height.
+   * @param {string} state_root The state root of the current network.
+   *
+   * @returns {OfflineQuery} The newly created offline query object.
    */
   constructor(block_height: number, state_root: string);
   /**
    * Add a new block height to the offline query object.
+   *
+   * @param {u32} block_height The block height to add.
    */
   addBlockHeight(block_height: number): void;
   /**
    * Add a new state path to the offline query object.
    *
-   * @param {string} commitment: The commitment corresponding to a record inpout
-   * @param {string} state_path: The state path corresponding to the commitment
+   * @param {string} commitment: The commitment corresponding to a record input.
+   * @param {string} state_path: The state path corresponding to the commitment.
    */
   addStatePath(commitment: string, state_path: string): void;
   /**
-   * Get a json string representation of the offline query object
+   * Get a json string representation of the offline query object.
+   *
+   * @returns {string} JSON string representation of the offline query object.
    */
   toString(): string;
   /**
-   * Create an offline query object from a json string representation
+   * Create an offline query object from a json string representation.
+   *
+   * @param {string} JSON string representation of the offline query object.
    */
   static fromString(s: string): OfflineQuery;
 }
@@ -982,10 +1106,20 @@ export class Plaintext {
   find(name: string): Plaintext;
   /**
    * Encrypt a plaintext with an address and randomizer.
+   *
+   * @param {Address} address The address to encrypt the plaintext for.
+   * @param {Scalar} randomizer The randomizer to use for encryption.
+   *
+   * @returns {Ciphertext} The encrypted ciphertext.
    */
   encrypt(address: Address, randomizer: Scalar): Ciphertext;
   /**
    * Encrypt a plaintext with a transition view key.
+   *
+   * @param {Field} transition_view_key The transition view key of the transition
+   * associated with the plaintext.
+   *
+   * @returns {Ciphertext} The encrypted ciphertext.
    */
   encryptSymmetric(transition_view_key: Field): Ciphertext;
   /**
@@ -1006,6 +1140,8 @@ export class Plaintext {
   static fromBytesLe(bytes: Uint8Array): Plaintext;
   /**
    * Get the left endian byte array representation of the plaintext.
+   *
+   * @returns {Uint8Array} The left endian byte array representation of the plaintext.
    */
   toBytesLe(): Uint8Array;
   /**
@@ -1018,6 +1154,8 @@ export class Plaintext {
   static fromBitsLe(bits: Array<any>): Plaintext;
   /**
    * Get the left endian boolean array representation of the bits of the plaintext.
+   *
+   * @returns {Array} The left endian boolean array representation of the bits of the plaintext.
    */
   toBitsLe(): Array<any>;
   /**
@@ -1030,6 +1168,8 @@ export class Plaintext {
   static fromFields(fields: Array<any>): Plaintext;
   /**
    * Get the field array representation of the plaintext.
+   *
+   * @returns {Array} The field array representation of the plaintext.
    */
   toFields(): Array<any>;
   /**
@@ -1495,6 +1635,17 @@ export class ProgramManager {
    * @param imports The imports to the program in the format {"programname.aleo":"aleo instructions source code"}.
    */
   static authorize(private_key: PrivateKey, program: string, function_name: string, inputs: Array<any>, imports?: object | null): Promise<Authorization>;
+  /**
+   * Create an execution `Authorization` without generating a circuit. Use this function when
+   * fast delegated proving is needed.
+   *
+   * @param private_key The private key of the signer.
+   * @param program The program source code containing the function to authorize.
+   * @param function_name The function to authorize.
+   * @param inputs A javascript array of inputs to the function.
+   * @param imports The imports to the program in the format {"programname.aleo":"aleo instructions source code"}.
+   */
+  static buildAuthorizationUnchecked(private_key: PrivateKey, program: string, function_name: string, inputs: Array<any>, imports?: object | null): Promise<Authorization>;
   /**
    * Create an `Authorization` for `credits.aleo/fee_public` or `credits.aleo/fee_private`.
    * This object requires an associated execution or deployment ID. This can be gained from
@@ -1645,6 +1796,24 @@ export class ProgramManager {
    * @returns {Transaction} Transaction object
    */
   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>;
+  /**
+   * Create a `ProvingRequest` object. This object creates authorizations for the top level
+   * function and associated fee function. This object can be sent directly to a remote prover
+   * OR used to extract both execution and fee authorizations.
+   *
+   * @param private_key The private key of the signer.
+   * @param program The program source code containing the function to authorize.
+   * @param function_name The function to authorize.
+   * @param inputs A javascript array of inputs to the function.
+   * @param base_fee_credits The base fee to be paid for the authorization
+   * @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 imports The imports to the program in the format {"programname.aleo":"aleo instructions source code"}.
+   * @param url The url of the Aleo network node to send the transaction to
+   * @param broadcast (optional) Flag to indicate if the transaction should be broadcast
+   * @returns {Authorization}
+   */
+  static buildProvingRequest(private_key: PrivateKey, program: string, function_name: string, inputs: Array<any>, base_fee_credits: number, priority_fee_credits: number, fee_record: RecordPlaintext | null | undefined, imports: object | null | undefined, broadcast: boolean, unchecked: boolean): Promise<ProvingRequest>;
   /**
    * Split an Aleo credits record into two separate records. This function does not require a fee.
    *
@@ -1880,6 +2049,57 @@ export class ProvingKey {
    */
   toString(): string;
 }
+/**
+ * Represents a proving request to a prover.
+ */
+export class ProvingRequest {
+  private constructor();
+  free(): void;
+  /**
+   * Creates a new ProvingRequest from a function Authorization and an optional fee Authorization.
+   *
+   * @param {Authorization} authorization An Authorization for a function.
+   * @param {Authorization} fee_authorization The authorization for the `credits.aleo/fee_public` or `credits.aleo/fee_private` function that pays the fee for the execution of the main function.
+   * @param {boolean} broadcast Flag that indicates whether the remote proving service should attempt to submit the transaction on the caller's behalf.
+   */
+  static new(authorization: Authorization, fee_authorization: Authorization | null | undefined, broadcast: boolean): ProvingRequest;
+  /**
+   * Creates a ProvingRequest from a string representation.
+   *
+   * @param {Uint8Array} request String representation of the ProvingRequest.
+   */
+  static fromString(request: string): ProvingRequest;
+  /**
+   * Creates a string representation of the ProvingRequest.
+   */
+  toString(): string;
+  /**
+   * Creates a ProvingRequest from a left-endian byte representation of the ProvingRequest.
+   *
+   * @param {Uint8Array} bytes Left-endian bytes representing the proving request.
+   */
+  static fromBytesLe(bytes: Uint8Array): ProvingRequest;
+  /**
+   * Creates a left-endian byte representation of the ProvingRequest.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Get the Authorization of the main function in the ProvingRequest.
+   */
+  authorization(): Authorization;
+  /**
+   * Get the fee Authorization in the ProvingRequest.
+   */
+  feeAuthorization(): Authorization | undefined;
+  /**
+   * Get the broadcast flag set in the ProvingRequest.
+   */
+  broadcast(): boolean;
+  /**
+   * Check if a ProvingRequest is the same as another ProvingRequest.
+   */
+  equals(other: ProvingRequest): boolean;
+}
 /**
  * Encrypted Aleo record
  */
@@ -1942,14 +2162,20 @@ export class RecordCiphertext {
   static fromBytesLe(bytes: Uint8Array): RecordCiphertext;
   /**
    * Get the left endian byte array representation of the record ciphertext.
+   *
+   * @returns {Uint8Array} Left endian byte array representation of the record ciphertext.
    */
   toBytesLe(): Uint8Array;
   /**
    * Get the left endian boolean array representation of the record ciphertext bits.
+   *
+   * returns {Array} Left endian boolean array representation of the bits of the record ciphertext.
    */
   toBitsLe(): Array<any>;
   /**
    * Get the field array representation of the record ciphertext.
+   *
+   * @returns {Array} Field array representation of the record ciphertext.
    */
   toFields(): Array<any>;
   /**
@@ -1962,6 +2188,8 @@ export class RecordCiphertext {
   decryptWithRecordViewKey(record_vk: Field): RecordPlaintext;
   /**
    * Get the record nonce.
+   *
+   * @returns {Group} The record nonce.
    */
   nonce(): Group;
 }
@@ -1971,17 +2199,27 @@ export class RecordCiphertext {
 export class RecordPlaintext {
   private constructor();
   free(): void;
-  commitment(program_id: string, record_name: string): Field;
+  commitment(program_id: string, record_name: string, record_view_key: string): Field;
   /**
    * Return a record plaintext from a string.
    *
-   * @param {string} record String representation of a plaintext representation of an Aleo record
+   * @param {string} record String representation of a plaintext representation of an Aleo record.
+   *
    * @returns {RecordPlaintext} Record plaintext
    */
   static fromString(record: string): RecordPlaintext;
+  /**
+   * Get the record entry matching a key.
+   *
+   * @param {string} input The key to retrieve the value in the record data field.
+   *
+   * @returns {Plaintext} The plaintext value corresponding to the key.
+   */
   getMember(input: string): Plaintext;
   /**
    * Get the owner of the record.
+   *
+   * @returns {Address} Address of the owner of the record.
    */
   owner(): Address;
   /**
@@ -2084,14 +2322,24 @@ 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
+   * @param {string} record_view_key The string representation of the record view key.
    *
    * @returns {string} Serial number of the record
    */
-  serialNumberString(private_key: PrivateKey, program_id: string, record_name: string): string;
+  serialNumberString(private_key: PrivateKey, program_id: string, record_name: string, record_view_key: string): string;
   /**
    * Get the tag of the record using the graph key.
    */
   tag(graph_key: GraphKey, commitment: Field): Field;
+  /**
+   * Generate the record view key. The record view key can only decrypt record if the
+   * supplied view key belongs to the record owner.
+   *
+   * @param {ViewKey} view_key View key used to generate the record view key
+   *
+   * @returns {Group} record view key
+   */
+  recordViewKey(view_key: ViewKey): Field;
 }
 /**
  * Scalar field element.
@@ -2509,18 +2757,28 @@ export class Transition {
   outputs(convert_to_js: boolean): Array<any>;
   /**
    * Get the transition public key of the transition.
+   *
+   * @returns {Group} Transition public key
    */
   tpk(): Group;
   /**
    * Get the transition view key of the transition.
+   *
+   * @param {ViewKey} view_key The view key of the transition signer.
+   *
+   * @returns {Field} Transition view key
    */
   tvk(view_key: ViewKey): Field;
   /**
    * Get the transition commitment of the transition.
+   *
+   * @returns {Field} Transition commitment
    */
   tcm(): Field;
   /**
    * Get the transition signer commitment of the transition.
+   *
+   * @returns {Field} Transition signer commitment
    */
   scm(): Field;
   /**