Changing fromCiphertext, verify, and getBlockRange to use object params

Pauan · Pauan · commit 1d69435ce5c2 · 2025-08-01T19:13:05.000-07:00
diff --git a/sdk/src/account.ts b/sdk/src/account.ts
@@ -68,17 +68,23 @@ export class Account {
 
   /**
    * Attempts to create an account from a private key ciphertext
-   * @param {PrivateKeyCiphertext | string} ciphertext The encrypted private key ciphertext or its string representation
-   * @param {string} password The password used to decrypt the private key ciphertext
+   * @param {Object} params
+   * @param {PrivateKeyCiphertext | string} params.ciphertext The encrypted private key ciphertext or its string representation
+   * @param {string} params.password The password used to decrypt the private key ciphertext
    * @returns {Account} A new Account instance created from the decrypted private key
    *
    * @example
    * import { Account } from "@provablehq/sdk/testnet.js";
    *
    * // Create an account object from a previously encrypted ciphertext and password.
-   * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext,
+   *     password: process.env.password,
+   * });
    */
-  public static fromCiphertext(ciphertext: PrivateKeyCiphertext | string, password: string): Account {
+  public static fromCiphertext(params: { ciphertext: PrivateKeyCiphertext | string, password: string }): Account {
+    let { ciphertext, password } = params;
+
     try {
       ciphertext = (typeof ciphertext === "string") ? PrivateKeyCiphertext.fromString(ciphertext) : ciphertext;
       const _privateKey = PrivateKey.fromPrivateKeyCiphertext(ciphertext, password);
@@ -211,7 +217,10 @@ export class Account {
    *
    * // Create a connection to the Aleo network and an account
    * const networkClient = new AleoNetworkClient({ host: "https://api.explorer.provable.com/v1" });
-   * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext!,
+   *     password: process.env.password!,
+   * });
    *
    * // Get the record ciphertexts from a transaction.
    * const transaction = await networkClient.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
@@ -241,7 +250,10 @@ export class Account {
    *
    * // Create a connection to the Aleo network and an account
    * const networkClient = new AleoNetworkClient({ host: "https://api.explorer.provable.com/v1" });
-   * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext!,
+   *     password: process.env.password!,
+   * });
    *
    * // Get the record ciphertexts from a transaction.
    * const transaction = await networkClient.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
@@ -259,14 +271,17 @@ export class Account {
    * This key can be used to decrypt the record without revealing the account's view key.
    * @param {RecordCiphertext | string} recordCiphertext The record ciphertext to generate the view key for
    * @returns {Field} The record view key
-   * 
+   *
    * @example
    * // Import the Account class
    * import { Account } from "@provablehq/sdk/testnet.js";
-   * 
+   *
    * // Create an account object from a previously encrypted ciphertext and password.
-   * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
-   * 
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext!,
+   *     password: process.env.password!,
+   * });
+   *
    * // Generate a record view key from the account's view key and a record ciphertext
    * const recordCiphertext = RecordCiphertext.fromString("your_record_ciphertext_here");
    * const recordViewKey = account.generateRecordViewKey(recordCiphertext);
@@ -283,18 +298,18 @@ export class Account {
 
   /**
    * Generates a transition view key from the account owner's view key and the transition public key.
-   * This key can be used to decrypt the private inputs and outputs of a the transition without 
+   * This key can be used to decrypt the private inputs and outputs of a the transition without
    * revealing the account's view key.
    * @param {string | Group} tpk The transition public key
    * @returns {Field} The transition view key
-   * 
+   *
    * @example
    * // Import the Account class
    * import { Account } from "@provablehq/sdk/testnet.js";
-   * 
+   *
    * // Generate a transition view key from the account's view key and a transition public key
    * const tpk = Group.fromString("your_transition_public_key_here");
-   * 
+   *
    * const transitionViewKey = account.generateTransitionViewKey(tpk);
    */
   generateTransitionViewKey(tpk: string | Group): Field {
@@ -315,7 +330,10 @@ export class Account {
    *
    * // Create a connection to the Aleo network and an account
    * const networkClient = new AleoNetworkClient({ host: "https://api.explorer.provable.com/v1" });
-   * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext!,
+   *     password: process.env.password!,
+   * });
    *
    * // Get the record ciphertexts from a transaction and check ownership of them.
    * const transaction = await networkClient.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
@@ -356,15 +374,18 @@ export class Account {
    * import { Account } from "@provablehq/sdk/testnet.js";
    *
    * // Create a connection to the Aleo network and an account
-   * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext,
+   *     password: process.env.password,
+   * });
    *
    * // Create an account and a message to sign.
    * const account = new Account();
    * const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
    * const signature = account.sign(message);
    *
    * // Verify the signature.
-   * assert(account.verify(message, signature));
+   * assert(account.verify({ message, signature }));
    */
   sign(message: Uint8Array): Signature {
     return this._privateKey.sign(message);
@@ -373,25 +394,30 @@ export class Account {
   /**
    * Verifies the Signature on a message.
    *
-   * @param {Uint8Array} message Message in bytes to be signed.
-   * @param {Signature} signature Signature to be verified.
+   * @param {Object} params
+   * @param {Uint8Array} params.message Message in bytes to be signed.
+   * @param {Signature} params.signature Signature to be verified.
    * @returns {boolean} True if the signature is valid, false otherwise.
    *
    * @example
    * // Import the Account class
    * import { Account } from "@provablehq/sdk/testnet.js";
    *
    * // Create a connection to the Aleo network and an account
-   * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+   * const account = Account.fromCiphertext({
+   *     ciphertext: process.env.ciphertext,
+   *     password: process.env.password,
+   * });
    *
    * // Sign a message.
    * const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
    * const signature = account.sign(message);
    *
    * // Verify the signature.
-   * assert(account.verify(message, signature));
+   * assert(account.verify({ message, signature }));
    */
-  verify(message: Uint8Array, signature: Signature): boolean {
+  verify(params: { message: Uint8Array, signature: Signature }): boolean {
+    const { message, signature } = params;
     return this._address.verify(message, signature);
   }
 }
diff --git a/sdk/src/network-client.ts b/sdk/src/network-client.ts
@@ -30,7 +30,10 @@ interface AleoNetworkClientOptions {
  * const localNetworkClient = new AleoNetworkClient({ host: "http://0.0.0.0:3030" });
  *
  * // Connection to a public beacon node
- * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+ * const account = Account.fromCiphertext({
+ *     ciphertext: process.env.ciphertext,
+ *     password: process.env.password,
+ * });
  * const publicNetworkClient = new AleoNetworkClient({ host: "http://api.explorer.provable.com/v1" });
  */
 class AleoNetworkClient {
@@ -192,7 +195,10 @@ class AleoNetworkClient {
      * import { Account, AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
      *
      * // Import an account from a ciphertext and password.
-     * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+     * const account = Account.fromCiphertext({
+     *     ciphertext: process.env.ciphertext,
+     *     password: process.env.password,
+     * });
      *
      * // Create a network client.
      * const networkClient = new AleoNetworkClient({ host: "http://api.explorer.provable.com/v1" });
@@ -298,7 +304,7 @@ class AleoNetworkClient {
             }
             try {
                 // Get 50 blocks (or the difference between the start and end if less than 50)
-                const blocks = await this.getBlockRange(start, end);
+                const blocks = await this.getBlockRange({ start, end });
                 end = start;
                 // Iterate through blocks to find unspent records
                 for (let i = 0; i < blocks.length; i++) {
@@ -527,7 +533,10 @@ class AleoNetworkClient {
      * @example
      * import { Account, AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
      *
-     * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+     * const account = Account.fromCiphertext({
+     *     ciphertext: process.env.ciphertext,
+     *     password: process.env.password,
+     * });
      *
      * // Create a network client and set an account to search for records with.
      * const networkClient = new AleoNetworkClient({ host: "http://api.explorer.provable.com/v1" });
@@ -617,24 +626,27 @@ class AleoNetworkClient {
     /**
      * Returns a range of blocks between the specified block heights. A maximum of 50 blocks can be fetched at a time.
      *
-     * @param {number} start Starting block to fetch.
-     * @param {number} end Ending block to fetch. This cannot be more than 50 blocks ahead of the start block.
+     * @param {Object} params
+     * @param {number} params.start Starting block to fetch.
+     * @param {number} params.end Ending block to fetch. This cannot be more than 50 blocks ahead of the start block.
      * @returns {Promise<Array<BlockJSON>>} An array of block objects
      *
      * @example
      * import { AleoNetworkClient } from "@provablehq/sdk/mainnet.js";
      *
      * // Fetch 50 blocks.
      * const (start, end) = (2050, 2100);
-     * const blockRange = networkClient.getBlockRange(start, end);
+     * const blockRange = networkClient.getBlockRange({ start, end });
      *
      * let cursor = start;
      * blockRange.forEach((block) => {
      *   assert(block.height == cursor);
      *   cursor += 1;
      *  }
      */
-    async getBlockRange(start: number, end: number): Promise<Array<BlockJSON>> {
+    async getBlockRange(params: { start: number, end: number }): Promise<Array<BlockJSON>> {
+        const { start, end } = params;
+
         try {
             this.ctx = { "X-ALEO-METHOD": "getBlockRange" };
             return await this.fetchData<Array<BlockJSON>>(
@@ -1236,7 +1248,10 @@ class AleoNetworkClient {
      * const networkClient = new AleoNetworkClient({ host: "http://api.explorer.provable.com/v1" });
      *
      * // Get the balance of an account from either an address object or address string.
-     * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+     * const account = Account.fromCiphertext({
+     *     ciphertext: process.env.ciphertext,
+     *     password: process.env.password,
+     * });
      * const publicBalance = await networkClient.getPublicBalance(account.address());
      * const publicBalanceFromString = await networkClient.getPublicBalance(account.address().to_string());
      * assert(publicBalance === publicBalanceFromString);
@@ -1589,7 +1604,10 @@ class AleoNetworkClient {
      * const programManager = new ProgramManager(networkClient);
      *
      * // Set the account for the program manager.
-     * programManager.setAccount(Account.fromCiphertext(process.env.ciphertext, process.env.password));
+     * programManager.setAccount(Account.fromCiphertext({
+     *     ciphertext: process.env.ciphertext,
+     *     password: process.env.password,
+     * }));
      *
      * // Build a transfer transaction.
      * const tx = await programManager.buildTransferPublicTransaction({
diff --git a/sdk/src/program-manager.ts b/sdk/src/program-manager.ts
@@ -927,12 +927,12 @@ class ProgramManager {
         try {
             feeRecord = privateFee
                 ? <RecordPlaintext>(
-                    await this.getCreditsRecord(
-                        priorityFee,
-                        [],
-                        feeRecord,
-                        recordSearchParams,
-                    )
+                    await this.getCreditsRecord({
+                        amount: priorityFee,
+                        nonces: [],
+                        record: feeRecord,
+                        params: recordSearchParams,
+                    })
                 )
                 : undefined;
         } catch (e: any) {
diff --git a/sdk/tests/account.test.ts b/sdk/tests/account.test.ts
@@ -75,8 +75,14 @@ describe('Account', () => {
             const privateKeyCiphertextString = privateKeyCiphertext.toString();
 
             // Generate account from valid private key string
-            const accountFromString = Account.fromCiphertext(privateKeyCiphertextString, "mypassword");
-            const accountFromObject = Account.fromCiphertext(privateKeyCiphertext, "mypassword");
+            const accountFromString = Account.fromCiphertext({
+                ciphertext: privateKeyCiphertextString,
+                password: "mypassword",
+            });
+            const accountFromObject = Account.fromCiphertext({
+                ciphertext: privateKeyCiphertext,
+                password: "mypassword",
+            });
 
             for (const account of [accountFromString, accountFromObject]) {
                 // Test that expected output is generated
@@ -93,8 +99,14 @@ describe('Account', () => {
             const privateKeyCiphertextString = privateKeyCiphertext.toString();
 
             try {
-                Account.fromCiphertext(privateKeyCiphertextString, "badpassword");
-                Account.fromCiphertext(privateKeyCiphertext, "badpassword");
+                Account.fromCiphertext({
+                    ciphertext: privateKeyCiphertextString,
+                    password: "badpassword",
+                });
+                Account.fromCiphertext({
+                    ciphertext: privateKeyCiphertext,
+                    password: "badpassword",
+                });
 
                 // Should not get here
                 expect(true).equal(false);
@@ -173,11 +185,11 @@ describe('Account', () => {
             expect(sign_spy.callCount).equal(2);
 
             const verify_spy = sinon.spy(account._address, 'verify');
-            const isValid = account.verify(message, signature);
+            const isValid = account.verify({ message, signature });
             expect(verify_spy.calledWith(message, signature)).equal(true);
-            const isSigValidForWrongMessage = account.verify(other_message, signature);
+            const isSigValidForWrongMessage = account.verify({ message: other_message, signature });
             expect(verify_spy.calledWith(other_message, signature)).equal(true);
-            const isSigValidForMultipleMessages = account.verify(other_message, other_signature);
+            const isSigValidForMultipleMessages = account.verify({ message: other_message, signature: other_signature });
             expect(verify_spy.calledWith(other_message, other_signature)).equal(true);
             expect(verify_spy.callCount).equal(3);
             // Ensure the signature was valid
diff --git a/sdk/tests/network-client.test.ts b/sdk/tests/network-client.test.ts
@@ -71,7 +71,7 @@ describe("NodeConnection", () => {
 
     describe("getBlockRange", () => {
         it.skip("should return an array of Block objects", async () => {
-            const blockRange = await connection.getBlockRange(1, 3);
+            const blockRange = await connection.getBlockRange({ start: 1, end: 3 });
             expect(Array.isArray(blockRange)).equal(true);
             expect((blockRange as BlockJSON[]).length).equal(3);
             expect(
diff --git a/sdk/tests/wasm.test.ts b/sdk/tests/wasm.test.ts
diff --git a/website/src/tabs/account/VerifyMessage.jsx b/website/src/tabs/account/VerifyMessage.jsx
