@provablehq/wasm 0.9.9 → 0.9.10

package/dist/mainnet/aleo_wasm.d.ts

@@ -16,6 +16,18 @@ export function initThreadPool(url: URL, num_threads: number): Promise<void>;
  * @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 | undefined, imported_verifying_keys: object | null | undefined, block_height: number): boolean;
+/**
+ * Set test consensus version heights for testing.
+ *
+ * @param {string | undefined} heights The block heights at which each consensus version applies. This input should be a simple csv list of block heights and there should be one number for each consensus version. If left undefined, the default test heights will be applied.
+ *
+ * @example
+ * import { getOrInitConsensusVersionHeights } from @provablehq/sdk;
+ *
+ * Set the consensus version heights.
+ * getOrInitConsensusVersionTestHeights("0,1,2,3,4,5,6,7,8,9");
+ */
+export function getOrInitConsensusVersionTestHeights(heights?: string | null): Array<any>;
 /**
  * Public address of an Aleo account
  */
@@ -144,6 +156,12 @@ export class Authorization {
    * @param {Uint8Array} bytes Left-endian bytes representing the Authorization.
    */
   static fromBytesLe(bytes: Uint8Array): Authorization;
+  /**
+   * Get the function name.
+   *
+   * @returns {string} The function name.
+   */
+  functionName(): string;
   /**
    * Returns `true` if the Authorization is for `credits.aleo/fee_public`.
    */
@@ -809,6 +827,10 @@ export class Field {
    * Create a field element from a Uint8Array of left endian bytes.
    */
   static fromBytesLe(bytes: Uint8Array): Field;
+  /**
+   * Initializes a new field as a domain separator.
+   */
+  static newDomainSeparator(domain: string): Field;
   /**
    * Add two field elements.
    */
@@ -1636,9 +1658,9 @@ export class Plaintext {
   private constructor();
   free(): void;
   /**
-   * Get the left endian boolean array representation of the bits of the plaintext.
+   * Get the little endian boolean array representation of the bits of the plaintext.
    *
-   * @returns {Array} The left endian boolean array representation of the bits of the plaintext.
+   * @returns {Array} The little endian boolean array representation of the bits of the plaintext.
    */
   toBitsLe(): Array<any>;
   /**
@@ -1658,15 +1680,15 @@ export class Plaintext {
    */
   static fromString(plaintext: string): Plaintext;
   /**
-   * Get the left endian byte array representation of the plaintext.
+   * Get the little endian byte array representation of the plaintext.
    *
-   * @returns {Uint8Array} The left endian byte array representation of the plaintext.
+   * @returns {Uint8Array} The little 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.
+   * @param {Array} bits A little endian boolean array representing the bits plaintext.
    *
    * @returns {Plaintext} The plaintext object.
    */
@@ -1674,17 +1696,47 @@ export class Plaintext {
   /**
    * Get a plaintext object from a series of bytes.
    *
-   * @param {Uint8Array} bytes A left endian byte array representing the plaintext.
+   * @param {Uint8Array} bytes A little endian byte array representing the plaintext.
    *
    * @returns {Plaintext} The plaintext object.
    */
   static fromBytesLe(bytes: Uint8Array): Plaintext;
+  /**
+   * Get the raw field array representation of the plaintext.
+   *
+   * @returns {Array} The raw field array representation of the plaintext.
+   */
+  toFieldsRaw(): Array<any>;
   /**
    * Gives the type of the plaintext.
    *
    * @returns {string} The type of the plaintext.
    */
   plaintextType(): string;
+  /**
+   * Get the raw big endian boolean array representation of the bits of the plaintext.
+   *
+   * @returns {Array} The raw big endian boolean array representation of the bits of the plaintext.
+   */
+  toBitsRawBe(): Array<any>;
+  /**
+   * Get the raw little endian boolean array representation of the bits of the plaintext.
+   *
+   * @returns {Array} The raw little endian boolean array representation of the bits of the plaintext.
+   */
+  toBitsRawLe(): Array<any>;
+  /**
+   * Get the raw big endian byte array representation of the plaintext.
+   *
+   * @returns {Uint8Array} The raw big endian byte array representation of the plaintext.
+   */
+  toBytesRawBe(): Uint8Array;
+  /**
+   * Get the raw little endian byte array representation of the plaintext.
+   *
+   * @returns {Uint8Array} The raw little endian byte array representation of the plaintext.
+   */
+  toBytesRawLe(): Uint8Array;
   /**
    * Encrypt a plaintext with a transition view key.
    *
@@ -2175,12 +2227,13 @@ export class ProgramManager {
   /**
    * Synthesize proving and verifying keys for a program
    *
-   * @param program {string} The program source code of the program to synthesize keys for
-   * @param function_id {string} The function to synthesize keys for
-   * @param inputs {Array} The inputs to the function
-   * @param imports {Object | undefined} The imports for the program
+   * @param {string} program The program source code of the program to synthesize keys for
+   * @param {string} function_id The function to synthesize keys for
+   * @param {Array} inputs The inputs to the function
+   * @param {Object | undefined} imports The imports for the program
    */
   static synthesizeKeyPair(private_key: PrivateKey, program: string, function_id: string, inputs: Array<any>, imports?: object | null, edition?: number | null): Promise<KeyPair>;
+  static loadInclusionProver(proving_key: ProvingKey): void;
   /**
    * 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
@@ -2284,26 +2337,31 @@ export class ProgramManager {
    * @returns {u64} Fee in microcredits
    */
   static estimateFinalizeFee(program: string, _function: string): bigint;
+  /**
+   * Execute an authorization.
+   *
+   * @param authorization The authorization to execute.
+   * @param fee_authorization The fee authorization to execute.
+   * @param program The program authorized to be executed.
+   * @param imports The imports of the program being executed.
+   * @param url The url to get the inclusion proving information from.
+   * @param offline_query Optional offline query object if building a Transaction offline.
+   */
+  static executeAuthorization(authorization: Authorization, fee_authorization: Authorization | null | undefined, program: string, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, fee_proving_key?: ProvingKey | null, fee_verifying_key?: VerifyingKey | null, imports?: object | null, url?: string | 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
    * program executions.
    *
-   * Disclaimer: Fee estimation is experimental and may not represent a correct estimate on any current or future network
-   *
-   * @param private_key The private key of the sender
-   * @param program The source code of the program to estimate the execution fee for
-   * @param function The name of the function to execute
-   * @param inputs A javascript array of inputs to the function
-   * @param url The url of the Aleo network node to send the transaction to
+   * @param program The source code of the program to estimate the execution fee for.
+   * @param function The name of the function to estimate the execution fee for.
    * @param imports (optional) Provide a list of imports to use for the 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" \}
-   * @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
+   * @param edition {
    * @returns {u64} Fee in microcredits
    */
-  static estimateExecutionFee(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, url?: string | null, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, offline_query?: OfflineQuery | null, edition?: number | null): Promise<bigint>;
+  static estimateExecutionFee(program: string, _function: string, imports?: object | null, edition?: number | null): Promise<bigint>;
   /**
    * Execute an arbitrary function locally
    *
@@ -2325,6 +2383,20 @@ export class ProgramManager {
    * @param {VerifyingKey | undefined} verifying_key (optional) Provide a verifying key to use for the function execution
    */
   static executeFunctionOffline(private_key: PrivateKey, program: string, _function: string, inputs: Array<any>, prove_execution: boolean, cache: boolean, imports?: object | null, proving_key?: ProvingKey | null, verifying_key?: VerifyingKey | null, url?: string | null, offline_query?: OfflineQuery | null, edition?: number | null): Promise<ExecutionResponse>;
+  /**
+   * Estimate Fee for an Authorization.
+   *
+   * @param authorization Authorization to estimate the fee for.
+   * @param program The program the Authorization is for.
+   * @param imports Provide a list of imports to use for the 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" \}
+   * @param offline_query The offline query object used to insert the global state root and state paths needed to create
+   * a valid inclusion proof offline.
+   * @param edition: Optional edition to estimate the fee for.
+   * @returns {u64} Fee in microcredits
+   */
+  static estimateFeeForAuthorization(authorization: Authorization, program: string, imports?: object | null, edition?: number | null): Promise<bigint>;
   /**
    * Execute Aleo function and create an Aleo execution transaction
    *