@provablehq/sdk 0.8.7 → 0.9.0

package/dist/mainnet/account.d.ts

@@ -1,20 +1,21 @@
-import { Address, ComputeKey, PrivateKey, Signature, ViewKey, PrivateKeyCiphertext, RecordCiphertext } from "./wasm";
+import { Address, ComputeKey, PrivateKey, Signature, ViewKey, PrivateKeyCiphertext, RecordCiphertext, RecordPlaintext } from "./wasm";
 interface AccountParam {
     privateKey?: string;
     seed?: Uint8Array;
 }
 /**
  * Key Management class. Enables the creation of a new Aleo Account, importation of an existing account from
- * an existing private key or seed, and message signing and verification functionality.
- *
- * An Aleo Account is generated from a randomly generated seed (number) from which an account private key, view key,
- * and a public account address are derived. The private key lies at the root of an Aleo account. It is a highly
- * sensitive secret and should be protected as it allows for creation of Aleo Program executions and arbitrary value
- * transfers. The View Key allows for decryption of a user's activity on the blockchain. The Address is the public
- * address to which other users of Aleo can send Aleo credits and other records to. This class should only be used
- * environments where the safety of the underlying key material can be assured.
+ * an existing private key or seed, and message signing and verification functionality. An Aleo Account is generated
+ * from a randomly generated seed (number) from which an account private key, view key, and a public account address are
+ * derived. The private key lies at the root of an Aleo account. It is a highly sensitive secret and should be protected
+ * as it allows for creation of Aleo Program executions and arbitrary value transfers. The View Key allows for decryption
+ * of a user's activity on the blockchain. The Address is the public address to which other users of Aleo can send Aleo
+ * credits and other records to. This class should only be used in environments where the safety of the underlying key
+ * material can be assured.
  *
  * @example
+ * import { Account } from "@provablehq/sdk/testnet.js";
+ *
  * // Create a new account
  * const myRandomAccount = new Account();
  *
@@ -23,14 +24,14 @@ interface AccountParam {
  * const mySeededAccount = new Account({seed: seed});
  *
  * // Create an account from an existing private key
- * const myExistingAccount = new Account({privateKey: 'myExistingPrivateKey'})
+ * const myExistingAccount = new Account({privateKey: process.env.privateKey});
  *
  * // Sign a message
- * const hello_world = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
- * const signature = myRandomAccount.sign(hello_world)
+ * const hello_world = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100]);
+ * const signature = myRandomAccount.sign(hello_world);
  *
  * // Verify a signature
- * myRandomAccount.verify(hello_world, signature)
+ * assert(myRandomAccount.verify(hello_world, signature));
  */
 export declare class Account {
     _privateKey: PrivateKey;
@@ -40,101 +41,217 @@ export declare class Account {
     constructor(params?: AccountParam);
     /**
      * Attempts to create an account from a private key ciphertext
-     * @param {PrivateKeyCiphertext | string} ciphertext
-     * @param {string} password
-     * @returns {PrivateKey}
+     * @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
+     * @returns {Account} A new Account instance created from the decrypted private key
      *
      * @example
-     * const ciphertext = PrivateKey.newEncrypted("password");
+     * 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);
      */
     static fromCiphertext(ciphertext: PrivateKeyCiphertext | string, password: string): Account;
+    /**
+     * Creates a PrivateKey from the provided parameters.
+     * @param {AccountParam} params The parameters containing either a private key string or a seed
+     * @returns {PrivateKey} A PrivateKey instance derived from the provided parameters
+     */
     private privateKeyFromParams;
+    /**
+     * Returns the PrivateKey associated with the account.
+     * @returns {PrivateKey} The private key of the account
+     *
+     * @example
+     * import { Account } from "@provablehq/sdk/testnet.js";
+     *
+     * const account = new Account();
+     * const privateKey = account.privateKey();
+     */
     privateKey(): PrivateKey;
+    /**
+     * Returns the ViewKey associated with the account.
+     * @returns {ViewKey} The view key of the account
+     *
+     * @example
+     * import { Account } from "@provablehq/sdk/testnet.js";
+     *
+     * const account = new Account();
+     * const viewKey = account.viewKey();
+     */
     viewKey(): ViewKey;
+    /**
+     * Returns the ComputeKey associated with the account.
+     * @returns {ComputeKey} The compute key of the account
+     *
+     * @example
+     * import { Account } from "@provablehq/sdk/testnet.js";
+     *
+     * const account = new Account();
+     * const computeKey = account.computeKey();
+     */
     computeKey(): ComputeKey;
+    /**
+     * Returns the Aleo address associated with the account.
+     * @returns {Address} The public address of the account
+     *
+     * @example
+     * import { Account } from "@provablehq/sdk/testnet.js";
+     *
+     * const account = new Account();
+     * const address = account.address();
+     */
     address(): Address;
+    /**
+     * Deep clones the Account.
+     * @returns {Account} A new Account instance with the same private key
+     *
+     * @example
+     * import { Account } from "@provablehq/sdk/testnet.js";
+     *
+     * const account = new Account();
+     * const clonedAccount = account.clone();
+     */
     clone(): Account;
-    toString(): any;
     /**
-     * Encrypt the account's private key with a password
-     * @param {string} ciphertext
-     * @returns {PrivateKeyCiphertext}
+     * Returns the address of the account in a string representation.
+     *
+     * @returns {string} The string representation of the account address
+     */
+    toString(): string;
+    /**
+     * Encrypts the account's private key with a password.
+     *
+     * @param {string} password Password to encrypt the private key.
+     * @returns {PrivateKeyCiphertext} The encrypted private key ciphertext
      *
      * @example
+     * import { Account } from "@provablehq/sdk/testnet.js";
+     *
      * const account = new Account();
      * const ciphertext = account.encryptAccount("password");
+     * process.env.ciphertext = ciphertext.toString();
      */
-    encryptAccount(password: string): any;
+    encryptAccount(password: string): PrivateKeyCiphertext;
     /**
-     * Decrypts a Record in ciphertext form into plaintext
-     * @param {string} ciphertext
-     * @returns {Record}
+     * Decrypts an encrypted record string into a plaintext record object.
+     *
+     * @param {string} ciphertext A string representing the ciphertext of a record.
+     * @returns {RecordPlaintext} The decrypted record plaintext
      *
      * @example
-     * const account = new Account();
-     * const record = account.decryptRecord("record1ciphertext");
+     * // Import the AleoNetworkClient and Account classes
+     * import { AleoNetworkClient, Account } from "@provablehq/sdk/testnet.js";
+     *
+     * // Create a connection to the Aleo network and an account
+     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
+     *
+     * // Get the record ciphertexts from a transaction.
+     * const transaction = await networkClient.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
+     * const records = transaction.records();
+     *
+     * // Decrypt any records the account owns.
+     * const decryptedRecords = [];
+     * for (const record of records) {
+     *    if (account.decryptRecord(record)) {
+     *      decryptedRecords.push(record);
+     *    }
+     * }
      */
-    decryptRecord(ciphertext: string): any;
+    decryptRecord(ciphertext: string): RecordPlaintext;
     /**
-     * Decrypts an array of Records in ciphertext form into plaintext
-     * @param {string[]} ciphertexts
-     * @returns {Record[]}
+     * Decrypts an array of Record ciphertext strings into an array of record plaintext objects.
+     *
+     * @param {string[]} ciphertexts An array of strings representing the ciphertexts of records.
+     * @returns {RecordPlaintext[]} An array of decrypted record plaintexts
      *
      * @example
-     * const account = new Account();
-     * const record = account.decryptRecords(["record1ciphertext", "record2ciphertext"]);
+     * // Import the AleoNetworkClient and Account classes
+     * import { AleoNetworkClient, Account } from "@provablehq/sdk/testnet.js";
+     *
+     * // Create a connection to the Aleo network and an account
+     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
+     *
+     * // Get the record ciphertexts from a transaction.
+     * const transaction = await networkClient.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
+     * const records = transaction.records();
+     *
+     * // Decrypt any records the account owns. If the account owns no records, the array will be empty.
+     * const decryptedRecords = account.decryptRecords(records);
      */
-    decryptRecords(ciphertexts: string[]): any[];
+    decryptRecords(ciphertexts: string[]): RecordPlaintext[];
     /**
-     * Determines whether the account owns a ciphertext record
-     * @param {RecordCipherText | string} ciphertext
-     * @returns {boolean}
+     * Determines whether the account owns a ciphertext record.
+     * @param {RecordCiphertext | string} ciphertext The record ciphertext to check ownership of
+     * @returns {boolean} True if the account owns the record, false otherwise
      *
      * @example
+     * // Import the AleoNetworkClient and Account classes
+     * import { AleoNetworkClient, Account } from "@provablehq/sdk/testnet.js";
+     *
      * // Create a connection to the Aleo network and an account
-     * const connection = new AleoNetworkClient("https://api.explorer.provable.com/v1");
-     * const account = Account.fromCiphertext(process.env.ciphertext, process.env.password);
+     * const networkClient = new AleoNetworkClient("https://api.explorer.provable.com/v1");
+     * const account = Account.fromCiphertext(process.env.ciphertext!, process.env.password!);
      *
-     * // Get a record from the network
-     * const record = connection.getBlock(1234);
-     * const recordCipherText = record.transactions[0].execution.transitions[0].id;
+     * // Get the record ciphertexts from a transaction and check ownership of them.
+     * const transaction = await networkClient.getTransactionObject("at1fjy6s9md2v4rgcn3j3q4qndtfaa2zvg58a4uha0rujvrn4cumu9qfazxdd");
+     * const records = transaction.records();
      *
-     * // Check if the account owns the record
-     * if account.ownsRecord(recordCipherText) {
-     *     // Then one can do something like:
-     *     // Decrypt the record and check if it's spent
-     *     // Store the record in a local database
-     *     // Etc.
+     * // Check if the account owns any of the record ciphertexts present in the transaction.
+     * const ownedRecords = [];
+     * for (const record of records) {
+     *    if (account.ownsRecordCiphertext(record)) {
+     *      ownedRecords.push(record);
+     *    }
      * }
      */
-    ownsRecordCiphertext(ciphertext: RecordCiphertext | string): any;
+    ownsRecordCiphertext(ciphertext: RecordCiphertext | string): boolean;
     /**
      * Signs a message with the account's private key.
      * Returns a Signature.
      *
-     * @param {Uint8Array} message
-     * @returns {Signature}
+     * @param {Uint8Array} message Message to be signed.
+     * @returns {Signature} Signature over the message in bytes.
      *
      * @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);
+     *
+     * // 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])
-     * account.sign(message);
+     * const signature = account.sign(message);
+     *
+     * // Verify the signature.
+     * assert(account.verify(message, signature));
      */
-    sign(message: Uint8Array): any;
+    sign(message: Uint8Array): Signature;
     /**
      * Verifies the Signature on a message.
      *
-     * @param {Uint8Array} message
-     * @param {Signature} signature
-     * @returns {boolean}
+     * @param {Uint8Array} message Message in bytes to be signed.
+     * @param {Signature} signature Signature to be verified.
+     * @returns {boolean} True if the signature is valid, false otherwise.
      *
      * @example
-     * const account = new Account();
+     * // 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);
+     *
+     * // Sign a message.
      * const message = Uint8Array.from([104, 101, 108, 108, 111 119, 111, 114, 108, 100])
      * const signature = account.sign(message);
-     * account.verify(message, signature);
+     *
+     * // Verify the signature.
+     * assert(account.verify(message, signature));
      */
-    verify(message: Uint8Array, signature: Signature): any;
+    verify(message: Uint8Array, signature: Signature): boolean;
 }
 export {};

package/dist/mainnet/browser.d.ts

@@ -9,6 +9,7 @@ import { ExecutionJSON, FeeExecutionJSON } from "./models/execution/executionJSO
 import { ExecutionObject, FeeExecutionObject } from "./models/execution/executionObject";
 import { FinalizeJSON } from "./models/finalizeJSON";
 import { FunctionObject } from "./models/functionObject";
+import { ImportedVerifyingKeys, ImportedPrograms } from "./models/imports";
 import { InputJSON } from "./models/input/inputJSON";
 import { InputObject } from "./models/input/inputObject";
 import { OutputJSON } from "./models/output/outputJSON";
@@ -34,4 +35,4 @@ export { logAndThrow } from "./utils";
 export { Address, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, Execution as FunctionExecution, ExecutionResponse, Field, Group, OfflineQuery, Pedersen64, Pedersen128, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, RecordCiphertext, RecordPlaintext, Signature, Scalar, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution, } from "./wasm";
 export { initializeWasm };
 export { Key, CREDITS_PROGRAM_KEYS, KEY_STORE, PRIVATE_TRANSFER, PRIVATE_TO_PUBLIC_TRANSFER, PRIVATE_TRANSFER_TYPES, PUBLIC_TRANSFER, PUBLIC_TRANSFER_AS_SIGNER, PUBLIC_TO_PRIVATE_TRANSFER, VALID_TRANSFER_TYPES, } from "./constants";
-export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, AleoNetworkClient, BlockJSON, BlockHeightSearch, CachedKeyPair, ConfirmedTransactionJSON, DeploymentJSON, DeploymentObject, ExecutionJSON, ExecutionObject, FeeExecutionJSON, FeeExecutionObject, FinalizeJSON, FunctionObject, FunctionKeyPair, FunctionKeyProvider, Header, InputJSON, InputObject, KeySearchParams, Metadata, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, OutputJSON, OutputObject, OwnerJSON, PartialSolutionJSON, PlaintextArray, PlaintextLiteral, PlaintextObject, PlaintextStruct, ProgramImports, RatificationJSON, RecordProvider, RecordSearchParams, SolutionJSON, SolutionsJSON, TransactionJSON, TransactionObject, TransitionJSON, TransitionObject, VerifyingKeys, };
+export { Account, AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, AleoNetworkClient, BlockJSON, BlockHeightSearch, CachedKeyPair, ConfirmedTransactionJSON, DeploymentJSON, DeploymentObject, ExecutionJSON, ExecutionObject, FeeExecutionJSON, FeeExecutionObject, FinalizeJSON, FunctionObject, FunctionKeyPair, FunctionKeyProvider, Header, ImportedPrograms, ImportedVerifyingKeys, InputJSON, InputObject, KeySearchParams, Metadata, NetworkRecordProvider, OfflineKeyProvider, OfflineSearchParams, OutputJSON, OutputObject, OwnerJSON, PartialSolutionJSON, PlaintextArray, PlaintextLiteral, PlaintextObject, PlaintextStruct, ProgramImports, RatificationJSON, RecordProvider, RecordSearchParams, SolutionJSON, SolutionsJSON, TransactionJSON, TransactionObject, TransitionJSON, TransitionObject, VerifyingKeys, };