[Feature] Re-add Aleo private key encryption to SDK + add private key encryption demo to aleo.tools (ProvableHQ#479)

* Add message signing and record encryption/decryption to Aleo.tools

* Add message signing and record encryption/decryption using a sample record to Aleo.tools

* Add Alert UI elements for verification + clear state when signing message

* Ensure sign & verify state clear on key change

* Small formatting nit

* Second small formatting nit

* Add back private key encryption and re-organize rust SDK dependencies

* Add private key encrpytion to aleo.tools

* Remove the wasm compilation target of death from SnarkVM_console

* Add minor state management updates

* update UI with advanced tab for account encrypt + decrypt

* improve formatting and fix broken copy buttons

---------

Signed-off-by: Mike Turner <[email protected]>
Co-authored-by: collin <[email protected]>

Author: iamalwaysuncomfortable

Cargo.lock

@@ -46,15 +46,25 @@ default-features = false
 
 [dependencies.ureq]
 version = "2.6.2"
+features = [ "json" ]
 optional = true
 
 [dependencies.serde_json]
 version = "1.0.91"
 
-[dependencies.snarkvm]
-workspace = true
+[dependencies.snarkvm-console]
 features = [ "parallel" ]
 optional = true
+version = "0.9.13"
+
+[dependencies.snarkvm-synthesizer]
+features = [ "parallel" ]
+optional = true
+version = "0.9.13"
+
+[dependencies.snarkvm-utilities]
+features = [ "parallel" ]
+version = "0.9.13"
 
 [dev-dependencies.bencher]
 version = "0.1.5"
@@ -63,6 +73,7 @@ version = "0.1.5"
 version = "0.3.1"
 
 [features]
-default = [ "blocking", "snarkvm" ]
+default = [ "blocking", "snarkvm-synthesizer", "snarkvm-console" ]
 async = [ "reqwest" ]
 blocking = [ "ureq" ]
+wasm = [ "snarkvm-console" ]

rust/Cargo.toml

@@ -16,7 +16,7 @@
 
 #[macro_use]
 extern crate bencher;
-use snarkvm::console::{
+use snarkvm_console::{
     account::{Address, PrivateKey},
     network::Testnet3,
 };

rust/benches/account.rs

@@ -18,7 +18,7 @@
 extern crate bencher;
 
 use aleo_rust::Encryptor;
-use snarkvm::console::{account::PrivateKey, network::Testnet3};
+use snarkvm_console::{account::PrivateKey, network::Testnet3};
 
 use bencher::Bencher;
 use rand::SeedableRng;

rust/benches/private_key_encryption.rs

@@ -14,15 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with the Aleo library. If not, see <https://www.gnu.org/licenses/>.
 
-use snarkvm::{
-    console::{
-        account::PrivateKey,
-        network::Network,
-        program::{Ciphertext, Identifier, Literal, Plaintext},
-        types::Field,
-    },
-    prelude::Uniform,
+use snarkvm_console::{
+    account::PrivateKey,
+    network::Network,
+    program::{Ciphertext, Identifier, Literal, Plaintext},
+    types::Field,
 };
+use snarkvm_utilities::Uniform;
 
 use anyhow::{anyhow, Result};
 use once_cell::sync::OnceCell;
@@ -97,7 +95,8 @@ impl<N: Network> Encryptor<N> {
 mod tests {
     use super::*;
 
-    use snarkvm::prelude::{TestRng, Testnet3 as CurrentNetwork};
+    use snarkvm_console::network::Testnet3 as CurrentNetwork;
+    use snarkvm_utilities::TestRng;
 
     #[test]
     fn test_encryptor_encrypt_and_decrypt() {

rust/src/account/encryptor.rs

@@ -17,13 +17,11 @@
 use crate::AleoAPIClient;
 
 use anyhow::{anyhow, bail, Result};
-use snarkvm::{
-    console::{
-        program::{Network, ProgramID},
-        types::Field,
-    },
-    synthesizer::{Block, Program, Transaction},
+use snarkvm_console::{
+    program::{Network, ProgramID},
+    types::Field,
 };
+use snarkvm_synthesizer::{Block, Program, Transaction};
 use std::convert::TryInto;
 
 impl<N: Network> AleoAPIClient<N> {

rust/src/api/asynchronous.rs

@@ -17,14 +17,12 @@
 use crate::AleoAPIClient;
 
 use anyhow::{anyhow, bail, Result};
-use snarkvm::{
-    console::{
-        account::ViewKey,
-        program::{Ciphertext, Network, ProgramID, Record},
-        types::Field,
-    },
-    synthesizer::{Block, Program, Transaction},
+use snarkvm_console::{
+    account::ViewKey,
+    program::{Ciphertext, Network, ProgramID, Record},
+    types::Field,
 };
+use snarkvm_synthesizer::{Block, Program, Transaction};
 use std::{convert::TryInto, ops::Range};
 
 #[cfg(not(feature = "async"))]
@@ -174,7 +172,7 @@ mod tests {
     use super::*;
 
     use crate::testnet3;
-    use snarkvm::console::{account::PrivateKey, network::Testnet3};
+    use snarkvm_console::{account::PrivateKey, network::Testnet3};
     use std::{convert::TryFrom, str::FromStr};
 
     type N = Testnet3;

rust/src/api/blocking.rs

@@ -24,7 +24,7 @@ pub mod asynchronous;
 #[cfg(feature = "async")]
 pub use asynchronous::*;
 
-use snarkvm::{console::program::Network, prelude::Testnet3};
+use snarkvm_console::{network::Testnet3, program::Network};
 use std::marker::PhantomData;
 
 pub struct AleoAPIClient<N: Network> {

rust/src/api/mod.rs

@@ -3,6 +3,7 @@ import {
   PrivateKey,
   Signature,
   ViewKey,
+  PrivateKeyCiphertext,
   RecordCiphertext,
 } from "@aleohq/wasm";
 
@@ -56,25 +57,25 @@ export class Account {
     this.adr = Address.from_private_key(this.pk);
   }
 
-  // /**
-  //  * Attempts to create an account from a private key ciphertext
-  //  * @param {PrivateKeyCiphertext | string} ciphertext
-  //  * @param {string} password
-  //  * @returns {PrivateKey | Error}
-  //  *
-  //  * @example
-  //  * let ciphertext = PrivateKey.newEncrypted("password");
-  //  * let account = Account.fromCiphertext(ciphertext, "password");
-  //  */
-  // public static fromCiphertext(ciphertext: PrivateKeyCiphertext | string, password: string) {
-  //   try {
-  //     ciphertext = (typeof ciphertext === "string") ? PrivateKeyCiphertext.fromString(ciphertext) : ciphertext;
-  //     const pk = PrivateKey.fromPrivateKeyCiphertext(ciphertext, password);
-  //     return new Account({ privateKey: pk.to_string() });
-  //   } catch(e) {
-  //     throw new Error("Wrong password or invalid ciphertext");
-  //   }
-  // }
+  /**
+   * Attempts to create an account from a private key ciphertext
+   * @param {PrivateKeyCiphertext | string} ciphertext
+   * @param {string} password
+   * @returns {PrivateKey | Error}
+   *
+   * @example
+   * let ciphertext = PrivateKey.newEncrypted("password");
+   * let account = Account.fromCiphertext(ciphertext, "password");
+   */
+  public static fromCiphertext(ciphertext: PrivateKeyCiphertext | string, password: string) {
+    try {
+      ciphertext = (typeof ciphertext === "string") ? PrivateKeyCiphertext.fromString(ciphertext) : ciphertext;
+      const pk = PrivateKey.fromPrivateKeyCiphertext(ciphertext, password);
+      return new Account({ privateKey: pk.to_string() });
+    } catch(e) {
+      throw new Error("Wrong password or invalid ciphertext");
+    }
+  }
 
   private privateKeyFromParams(params: AccountParam) {
     if (params.seed) {
@@ -102,18 +103,18 @@ export class Account {
     return this.address().to_string()
   }
 
-  // /**
-  //  * Encrypt the account's private key with a password
-  //  * @param {string} ciphertext
-  //  * @returns {PrivateKeyCiphertext}
-  //  *
-  //  * @example
-  //  * let account = new Account();
-  //  * let ciphertext = account.encryptAccount("password");
-  //  */
-  // encryptAccount(password: string) {
-  //   return this.pk.toCiphertext(password);
-  // }
+  /**
+   * Encrypt the account's private key with a password
+   * @param {string} ciphertext
+   * @returns {PrivateKeyCiphertext}
+   *
+   * @example
+   * let account = new Account();
+   * let ciphertext = account.encryptAccount("password");
+   */
+  encryptAccount(password: string) {
+    return this.pk.toCiphertext(password);
+  }
 
   /**
    * Decrypts a Record in ciphertext form into plaintext

sdk/src/account.ts

@@ -60,41 +60,41 @@ describe('Account', () => {
             expect(account.address().to_string()).toEqual(addressString);
             expect(account.toString()).toEqual(addressString);
         });
-        //
-        // test('can encrypt an account and decrypt to the same account', () => {
-        //     const newAccount = new Account();
-        //     const privateKeyCiphertext = newAccount.encryptAccount("mypassword");
-        //     const privateKeyCiphertextString = privateKeyCiphertext.toString();
-        //
-        //     // Generate account from valid private key string
-        //     const accountFromString = Account.fromCiphertext(privateKeyCiphertextString, "mypassword");
-        //     const accountFromObject = Account.fromCiphertext(privateKeyCiphertext, "mypassword");
-        //
-        //     for (const account of [accountFromString, accountFromObject]) {
-        //         // Test that expected output is generated
-        //         expect(account.privateKey().to_string()).toEqual(newAccount.privateKey().to_string());
-        //         expect(account.viewKey().to_string()).toEqual(newAccount.viewKey().to_string());
-        //         expect(account.address().to_string()).toEqual(newAccount.toString());
-        //         expect(account.toString()).toEqual(newAccount.toString());
-        //     }
-        // });
-        //
-        // test('fails to create an account from a bad password', () => {
-        //     const newAccount = new Account();
-        //     const privateKeyCiphertext = newAccount.encryptAccount("mypassword");
-        //     const privateKeyCiphertextString = privateKeyCiphertext.toString();
-        //
-        //     try {
-        //         Account.fromCiphertext(privateKeyCiphertextString, "badpassword");
-        //         Account.fromCiphertext(privateKeyCiphertext, "badpassword");
-        //
-        //         // Should not get here
-        //         expect(true).toBe(false);
-        //     } catch (err) {
-        //         // The account should fail to decrypt
-        //         expect(true).toBe(true);
-        //     }
-        // });
+
+        test('can encrypt an account and decrypt to the same account', () => {
+            const newAccount = new Account();
+            const privateKeyCiphertext = newAccount.encryptAccount("mypassword");
+            const privateKeyCiphertextString = privateKeyCiphertext.toString();
+
+            // Generate account from valid private key string
+            const accountFromString = Account.fromCiphertext(privateKeyCiphertextString, "mypassword");
+            const accountFromObject = Account.fromCiphertext(privateKeyCiphertext, "mypassword");
+
+            for (const account of [accountFromString, accountFromObject]) {
+                // Test that expected output is generated
+                expect(account.privateKey().to_string()).toEqual(newAccount.privateKey().to_string());
+                expect(account.viewKey().to_string()).toEqual(newAccount.viewKey().to_string());
+                expect(account.address().to_string()).toEqual(newAccount.toString());
+                expect(account.toString()).toEqual(newAccount.toString());
+            }
+        });
+
+        test('fails to create an account from a bad password', () => {
+            const newAccount = new Account();
+            const privateKeyCiphertext = newAccount.encryptAccount("mypassword");
+            const privateKeyCiphertextString = privateKeyCiphertext.toString();
+
+            try {
+                Account.fromCiphertext(privateKeyCiphertextString, "badpassword");
+                Account.fromCiphertext(privateKeyCiphertext, "badpassword");
+
+                // Should not get here
+                expect(true).toBe(false);
+            } catch (err) {
+                // The account should fail to decrypt
+                expect(true).toBe(true);
+            }
+        });
     });
 
     describe('View Key Record Decryption', () => {