@provablehq/wasm 0.9.2 → 0.9.3

package/dist/mainnet/aleo_wasm.d.ts

@@ -116,6 +116,87 @@ export class Address {
    */
   verify(message: Uint8Array, signature: Signature): boolean;
 }
+/**
+ * Authorization object containing the authorization for a transaction.
+ */
+export class Authorization {
+  private constructor();
+  free(): void;
+  /**
+   * Create a new authorization from a request object.
+   *
+   * @param {ExecutionRequest} request The ExecutionRequest to build the authorization from.
+   */
+  static new(request: ExecutionRequest): Authorization;
+  /**
+   * Returns a new and independent replica of the Authorization.
+   */
+  replicate(): Authorization;
+  /**
+   * Returns the string representation of the Authorization.
+   */
+  toString(): string;
+  /**
+   * Reconstructs an Authorization object from its string representation.
+   *
+   * @param {String} authorization The string representation of the Authorization.
+   */
+  static fromString(authorization: string): Authorization;
+  /**
+   * Returns the left-endian byte representation of the Authorization.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Creates an authorization object from a left-endian byte representation of an Authorization.
+   *
+   * @param {Uint8Array} bytes Left-endian bytes representing the Authorization.
+   */
+  static fromBytesLe(bytes: Uint8Array): Authorization;
+  /**
+   * Check if an Authorization object is the same as another.
+   *
+   * @param {Authorization} other The Authorization object to determine equality with.
+   */
+  equals(other: Authorization): boolean;
+  /**
+   * Returns the number of `Request`s in the Authorization.
+   */
+  len(): number;
+  /**
+   * Return `true` if the Authorization is empty.
+   */
+  isEmpty(): boolean;
+  /**
+   * Returns `true` if the Authorization is for `credits.aleo/fee_private`.
+   */
+  isFeePrivate(): boolean;
+  /**
+   * Returns `true` if the Authorization is for `credits.aleo/fee_public`.
+   */
+  isFeePublic(): boolean;
+  /**
+   * Returns `true` if the Authorization is for `credits.aleo/split`.
+   */
+  isSplit(): boolean;
+  /**
+   * Insert a transition into the Authorization.
+   *
+   * @param {Transition} transition The transition object to insert into the Authorization.
+   */
+  insertTransition(transition: Transition): void;
+  /**
+   * Get the transitions in an Authorization.
+   *
+   * @returns {Array<Transition>} Array of transition objects
+   */
+  transitions(): Array<any>;
+  /**
+   * Returns the execution ID for the Authorization.
+   *
+   * @returns {Field} The execution ID for the Authorization, call toString() after this result to get the string representation.
+   */
+  toExecutionId(): Field;
+}
 export class BHP1024 {
   free(): void;
   /**
@@ -228,8 +309,6 @@ export class BHP768 {
  * SnarkVM Ciphertext object. A Ciphertext represents an symmetrically encrypted plaintext. This
  * object provides decryption methods to recover the plaintext from the ciphertext (given the
  * api consumer has the proper decryption materials).
- *
- * @example
  */
 export class Ciphertext {
   private constructor();
@@ -353,6 +432,28 @@ export class ComputeKey {
    */
   pr_sig(): Group;
 }
+export class EncryptionToolkit {
+  private constructor();
+  free(): void;
+  /**
+   * Generates a transition view key from the view key and the transition public 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
+   */
+  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.
+   */
+  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.
+   */
+  static decryptTransitionWithVk(transition: Transition, transition_vk: Field): Transition;
+}
 /**
  * Execution of an Aleo program.
  */
@@ -390,6 +491,93 @@ export class Execution {
    */
   transitions(): Array<any>;
 }
+export class ExecutionRequest {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the request as a string.
+   */
+  toString(): string;
+  /**
+   * Builds a request object from a string representation of a request.
+   */
+  static fromString(request: string): ExecutionRequest;
+  /**
+   * Returns the bytes representation of the request.
+   */
+  toBytesLe(): Uint8Array;
+  /**
+   * Creates an request object from a bytes representation of an request.
+   */
+  static fromBytesLe(bytes: Uint8Array): ExecutionRequest;
+  /**
+   * Returns the request signer.
+   */
+  signer(): Address;
+  /**
+   * Returns the network ID.
+   */
+  network_id(): number;
+  /**
+   * Returns the program ID.
+   */
+  program_id(): string;
+  /**
+   * Returns the function name.
+   */
+  function_name(): string;
+  /**
+   * Returns the input IDs for the transition.
+   */
+  input_ids(): Array<any>;
+  /**
+   * Returns the function inputs as an array of strings.
+   */
+  inputs(): Array<any>;
+  /**
+   * Returns the signature for the transition.
+   */
+  signature(): Signature;
+  /**
+   * Returns the tag secret key `sk_tag`.
+   */
+  sk_tag(): Field;
+  /**
+   * Returns the transition view key `tvk`.
+   */
+  tvk(): Field;
+  /**
+   * Returns the transition public key `tpk`.
+   */
+  to_tpk(): Group;
+  /**
+   * Returns the transition commitment `tcm`.
+   */
+  tcm(): Field;
+  /**
+   * Returns the signer commitment `scm`.
+   */
+  scm(): Field;
+  /**
+   * Create a new request by signing over a program ID and set of inputs.
+   *
+   * @param {PrivateKey} private_key The private key of the signer.
+   * @param {string} program_id The id of the program to create the signature for.
+   * @param {string} function_name The function name to create the signature for.
+   * @param {string[]} inputs The inputs to the function.
+   * @param {string[]} input_types The input types of the function.
+   * @param {Field | undefined} root_tvk The tvk of the function at the top of the call graph. This is undefined if this request is built for the top-level call or if there is only one function in the call graph.
+   * @param {boolean} is_root Flag to indicate if this is the top level function in the call graph.
+   */
+  static sign(private_key: PrivateKey, program_id: string, function_name: string, inputs: Array<any>, input_types: Array<any>, root_tvk: Field | null | undefined, is_root: boolean): ExecutionRequest;
+  /**
+   * Verify the input types within a request.
+   *
+   * @param {string[]} The input_types within the request.
+   * @param {boolean} Flag to indicate whether this request is the first function in the call graph.
+   */
+  verify(input_types: Array<any>, is_root: boolean): boolean;
+}
 /**
  * Webassembly Representation of an Aleo function execution response
  *
@@ -1297,6 +1485,29 @@ export class Program {
 export class ProgramManager {
   private constructor();
   free(): void;
+  /**
+   * Create an execution `Authorization` for a given program:function tuple with specified inputs.
+   *
+   * @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 authorize(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
+   * any previously created authorization by calling (authorization.toExecutionId()).
+   *
+   * @param private_key The private key of the signer.
+   * @param deployment_or_execution_id The id of the deployment or execution to authorize the fee program for.
+   * @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
+   * @returns {Authorization}
+   */
+  static authorizeFee(private_key: PrivateKey, deployment_or_execution_id: string, base_fee_credits: number, priority_fee_credits: number, fee_record?: RecordPlaintext | null): Promise<Authorization>;
   /**
    * Deploy an Aleo program
    *
@@ -1683,7 +1894,7 @@ export class RecordCiphertext {
    */
   static fromString(record: string): RecordCiphertext;
   /**
-   * Return the string reprensentation of the record ciphertext
+   * Return the string representation of the record ciphertext
    *
    * @returns {string} String representation of the record ciphertext
    */
@@ -1696,6 +1907,15 @@ export class RecordCiphertext {
    * @returns {RecordPlaintext} Record plaintext object
    */
   decrypt(view_key: ViewKey): RecordPlaintext;
+  /**
+   * 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;
   /**
    * Determines if the account corresponding to the view key is the owner of the record
    *
@@ -1732,6 +1952,18 @@ export class RecordCiphertext {
    * Get the field array representation of the record ciphertext.
    */
   toFields(): Array<any>;
+  /**
+   * Decrypt the record ciphertext into plaintext using a record view key.
+   *
+   * @param {Field} record_vk Record view key used to decrypt the record.
+   *
+   * @returns {RecordPlaintext}
+   */
+  decryptWithRecordViewKey(record_vk: Field): RecordPlaintext;
+  /**
+   * Get the record nonce.
+   */
+  nonce(): Group;
 }
 /**
  * Plaintext representation of an Aleo record
@@ -2163,7 +2395,6 @@ export class Transaction {
    */
   id(): string;
   /**
-   * Get the
    * Get the type of the transaction (will return "deploy" or "execute")
    *
    * @returns {string} Transaction type
@@ -2292,6 +2523,14 @@ export class Transition {
    * Get the transition signer commitment of the transition.
    */
   scm(): Field;
+  /**
+   * Decrypt the transition using the transition view key.
+   *
+   * @param {Field} tvk The transition view key.
+   *
+   * @returns {Transition} The transition with public values for inputs and outputs.
+   */
+  decryptTransition(tvk: Field): Transition;
 }
 /**
  * Verifying key for a function within an Aleo program