@provablehq/sdk 0.9.1 → 0.9.3

package/dist/mainnet/account.d.ts

@@ -1,4 +1,4 @@
-import { Address, ComputeKey, PrivateKey, Signature, ViewKey, PrivateKeyCiphertext, RecordCiphertext, RecordPlaintext } from "./wasm";
+import { Address, ComputeKey, Field, Group, PrivateKey, Signature, ViewKey, PrivateKeyCiphertext, RecordCiphertext, RecordPlaintext } from "./wasm.js";
 interface AccountParam {
     privateKey?: string;
     seed?: Uint8Array;
@@ -182,6 +182,41 @@ export declare class Account {
      * const decryptedRecords = account.decryptRecords(records);
      */
     decryptRecords(ciphertexts: string[]): RecordPlaintext[];
+    /**
+     * Generates a record view key from the account owner's view key and the record ciphertext.
+     * 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!);
+     *
+     * // 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);
+     */
+    generateRecordViewKey(recordCiphertext: RecordCiphertext | string): Field;
+    /**
+     * 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
+     * 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;
     /**
      * Determines whether the account owns a ciphertext record.
      * @param {RecordCiphertext | string} ciphertext The record ciphertext to check ownership of

package/dist/mainnet/browser.d.ts

@@ -1,38 +1,38 @@
-import "./polyfill/shared";
-import { Account } from "./account";
-import { AleoNetworkClient, ProgramImports } from "./network-client";
-import { BlockJSON, Header, Metadata } from "./models/blockJSON";
-import { ConfirmedTransactionJSON } from "./models/confirmed_transaction";
-import { DeploymentJSON, VerifyingKeys } from "./models/deployment/deploymentJSON";
-import { DeploymentObject } from "./models/deployment/deploymentObject";
-import { ExecutionJSON, FeeExecutionJSON } from "./models/execution/executionJSON";
-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";
-import { OutputObject } from "./models/output/outputObject";
-import { OwnerJSON } from "./models/owner/ownerJSON";
-import { PlaintextArray } from "./models/plaintext/array";
-import { PlaintextLiteral } from "./models/plaintext/literal";
-import { PlaintextObject } from "./models/plaintext/plaintext";
-import { PlaintextStruct } from "./models/plaintext/struct";
-import { RatificationJSON } from "./models/ratification";
-import { SolutionsJSON, SolutionJSON, PartialSolutionJSON } from "./models/solution";
-import { TransactionJSON } from "./models/transaction/transactionJSON";
-import { TransactionObject } from "./models/transaction/transactionObject";
-import { TransitionJSON } from "./models/transition/transitionJSON";
-import { TransitionObject } from "./models/transition/transitionObject";
-import { AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, CachedKeyPair, FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider";
-import { OfflineKeyProvider, OfflineSearchParams } from "./offline-key-provider";
-import { BlockHeightSearch, NetworkRecordProvider, RecordProvider, RecordSearchParams } from "./record-provider";
+import "./polyfill/shared.js";
+import { Account } from "./account.js";
+import { AleoNetworkClient, ProgramImports } from "./network-client.js";
+import { BlockJSON, Header, Metadata } from "./models/blockJSON.js";
+import { ConfirmedTransactionJSON } from "./models/confirmed_transaction.js";
+import { DeploymentJSON, VerifyingKeys } from "./models/deployment/deploymentJSON.js";
+import { DeploymentObject } from "./models/deployment/deploymentObject.js";
+import { ExecutionJSON, FeeExecutionJSON } from "./models/execution/executionJSON.js";
+import { ExecutionObject, FeeExecutionObject } from "./models/execution/executionObject.js";
+import { FinalizeJSON } from "./models/finalizeJSON.js";
+import { FunctionObject } from "./models/functionObject.js";
+import { ImportedVerifyingKeys, ImportedPrograms } from "./models/imports.js";
+import { InputJSON } from "./models/input/inputJSON.js";
+import { InputObject } from "./models/input/inputObject.js";
+import { OutputJSON } from "./models/output/outputJSON.js";
+import { OutputObject } from "./models/output/outputObject.js";
+import { OwnerJSON } from "./models/owner/ownerJSON.js";
+import { PlaintextArray } from "./models/plaintext/array.js";
+import { PlaintextLiteral } from "./models/plaintext/literal.js";
+import { PlaintextObject } from "./models/plaintext/plaintext.js";
+import { PlaintextStruct } from "./models/plaintext/struct.js";
+import { RatificationJSON } from "./models/ratification.js";
+import { SolutionsJSON, SolutionJSON, PartialSolutionJSON } from "./models/solution.js";
+import { TransactionJSON } from "./models/transaction/transactionJSON.js";
+import { TransactionObject } from "./models/transaction/transactionObject.js";
+import { TransitionJSON } from "./models/transition/transitionJSON.js";
+import { TransitionObject } from "./models/transition/transitionObject.js";
+import { AleoKeyProvider, AleoKeyProviderParams, AleoKeyProviderInitParams, CachedKeyPair, FunctionKeyPair, FunctionKeyProvider, KeySearchParams } from "./function-key-provider.js";
+import { OfflineKeyProvider, OfflineSearchParams } from "./offline-key-provider.js";
+import { BlockHeightSearch, NetworkRecordProvider, RecordProvider, RecordSearchParams } from "./record-provider.js";
 declare function initializeWasm(): Promise<void>;
-export { createAleoWorker } from "./managed-worker";
-export { ProgramManager } from "./program-manager";
-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 { createAleoWorker } from "./managed-worker.js";
+export { ProgramManager } from "./program-manager.js";
+export { logAndThrow } from "./utils.js";
+export { Address, Authorization, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, Execution as FunctionExecution, ExecutionRequest, ExecutionResponse, EncryptionToolkit, 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.js";
 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 { 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.js";
 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, };

package/dist/mainnet/browser.js

@@ -1,8 +1,8 @@
 import 'core-js/proposals/json-parse-with-source.js';
-import { ViewKey, ComputeKey, Address, PrivateKeyCiphertext, PrivateKey, RecordCiphertext, ProvingKey, VerifyingKey } from '@provablehq/wasm/mainnet.js';
-export { Address, BHP1024, BHP256, BHP512, BHP768, Ciphertext, ComputeKey, ExecutionResponse, Field, Execution as FunctionExecution, Group, OfflineQuery, Pedersen128, Pedersen64, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution } from '@provablehq/wasm/mainnet.js';
-import { C as CREDITS_PROGRAM_KEYS, c as PRIVATE_TRANSFER, d as PRIVATE_TO_PUBLIC_TRANSFER, f as PUBLIC_TRANSFER, g as PUBLIC_TRANSFER_AS_SIGNER, h as PUBLIC_TO_PRIVATE_TRANSFER, l as logAndThrow } from './program-manager-DMDKstZ8.js';
-export { A as AleoKeyProvider, a as AleoKeyProviderParams, b as AleoNetworkClient, K as KEY_STORE, e as PRIVATE_TRANSFER_TYPES, P as ProgramManager, V as VALID_TRANSFER_TYPES } from './program-manager-DMDKstZ8.js';
+import { ViewKey, ComputeKey, Address, PrivateKeyCiphertext, PrivateKey, RecordCiphertext, EncryptionToolkit, Group, ProvingKey, VerifyingKey } from '@provablehq/wasm/mainnet.js';
+export { Address, Authorization, BHP1024, BHP256, BHP512, BHP768, Ciphertext, ComputeKey, EncryptionToolkit, ExecutionRequest, ExecutionResponse, Field, Execution as FunctionExecution, Group, OfflineQuery, Pedersen128, Pedersen64, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager as ProgramManagerBase, ProvingKey, RecordCiphertext, RecordPlaintext, Scalar, Signature, Transaction, Transition, VerifyingKey, ViewKey, initThreadPool, verifyFunctionExecution } from '@provablehq/wasm/mainnet.js';
+import { C as CREDITS_PROGRAM_KEYS, c as PRIVATE_TRANSFER, d as PRIVATE_TO_PUBLIC_TRANSFER, f as PUBLIC_TRANSFER, g as PUBLIC_TRANSFER_AS_SIGNER, h as PUBLIC_TO_PRIVATE_TRANSFER, l as logAndThrow } from './program-manager-BfZnPCKl.js';
+export { A as AleoKeyProvider, a as AleoKeyProviderParams, b as AleoNetworkClient, K as KEY_STORE, e as PRIVATE_TRANSFER_TYPES, P as ProgramManager, V as VALID_TRANSFER_TYPES } from './program-manager-BfZnPCKl.js';
 import { wrap } from 'comlink';
 
 /**
@@ -230,6 +230,54 @@ class Account {
     decryptRecords(ciphertexts) {
         return ciphertexts.map((ciphertext) => this._viewKey.decrypt(ciphertext));
     }
+    /**
+     * Generates a record view key from the account owner's view key and the record ciphertext.
+     * 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!);
+     *
+     * // 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);
+     */
+    generateRecordViewKey(recordCiphertext) {
+        if (typeof recordCiphertext === 'string') {
+            recordCiphertext = RecordCiphertext.fromString(recordCiphertext);
+        }
+        if (!(recordCiphertext.isOwner(this._viewKey))) {
+            throw new Error("The record ciphertext does not belong to this account");
+        }
+        return EncryptionToolkit.generateRecordViewKey(this._viewKey, recordCiphertext);
+    }
+    /**
+     * 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
+     * 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) {
+        if (typeof tpk === 'string') {
+            tpk = Group.fromString(tpk);
+        }
+        return EncryptionToolkit.generateTvk(this._viewKey, tpk);
+    }
     /**
      * Determines whether the account owns a ciphertext record.
      * @param {RecordCiphertext | string} ciphertext The record ciphertext to check ownership of