Merge pull request #2 from MaximFischuk/feature/zksnarks-api-support

Feature/zksnarks api support

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "quorum-vault-client"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 repository = "https://github.com/MaximFischuk/quorum-vault-client"
 documentation = "https://docs.rs/quorum-vault-client"
@@ -25,3 +25,5 @@ base64 = "0.21.0"
 [dev-dependencies]
 tokio = { version = "1.20.1", features = ["full"] }
 wiremock = "0.5.17"
+secp256k1 = "0.26.0"
+hex = "0.4.3"

examples/ethereum_wallet.rs

@@ -6,7 +6,7 @@ async fn main() {
     let client = VaultClient::new(
         VaultClientSettingsBuilder::default()
             .address("http://127.0.0.1:8200")
-            .token("s.NgpQWnkfYEAxVPC83Bxfa7cy")
+            .token("root")
             .build()
             .unwrap(),
     )

examples/keys.rs

@@ -7,7 +7,7 @@ async fn main() {
     let client = VaultClient::new(
         VaultClientSettingsBuilder::default()
             .address("http://127.0.0.1:8200")
-            .token("s.NgpQWnkfYEAxVPC83Bxfa7cy")
+            .token("root")
             .build()
             .unwrap(),
     )

examples/zksnarks.rs

@@ -0,0 +1,44 @@
+use vaultrs::client::{VaultClient, VaultClientSettingsBuilder};
+
+#[tokio::main]
+async fn main() {
+    // Create a client
+    let client = VaultClient::new(
+        VaultClientSettingsBuilder::default()
+            .address("http://localhost:8200")
+            .token("root")
+            .build()
+            .unwrap(),
+    )
+    .unwrap();
+
+    // Create a new account
+    let account = quorum_vault_client::api::create_zksnarks_account(&client, "quorum")
+        .await
+        .unwrap();
+    println!("account: {:?}", account);
+
+    // Read the account
+    let account =
+        quorum_vault_client::api::read_zksnarks_account(&client, "quorum", &account.public_key)
+            .await
+            .unwrap();
+    println!("account: {:?}", account);
+
+    // List the accounts
+    let accounts = quorum_vault_client::api::list_zksnarks_accounts(&client, "quorum")
+        .await
+        .unwrap();
+    println!("accounts: {:?}", accounts);
+
+    // Sign a message
+    let signature = quorum_vault_client::api::zksnarks_sign(
+        &client,
+        "quorum",
+        &account.public_key,
+        "some-data".as_bytes(),
+    )
+    .await
+    .unwrap();
+    println!("signature: {:?}", signature);
+}

src/api.rs

@@ -10,7 +10,15 @@ use crate::api::keys::requests::{
     SignRequest, UpdateKeyTagsRequest,
 };
 use crate::api::keys::responses::{KeyResponse, KeysResponse, SignResponse};
+use crate::api::zksnarks::requests::{
+    CreateZkSnarksAccountRequest, ListZkSnarksAccountsRequest, ReadZkSnarksAccountRequest,
+    ZkSnarksSignRequest,
+};
+use crate::api::zksnarks::responses::{
+    ZkSnarksAccountResponse, ZkSnarksAccountsResponse, ZkSnarksSignResponse,
+};
 use crate::error::ClientError;
+use crate::H256;
 use base64::Engine;
 use std::collections::HashMap;
 use vaultrs::client::Client;
@@ -19,6 +27,7 @@ use web3::types::{Address, TransactionRequest};
 
 pub mod ethereum;
 pub mod keys;
+pub mod zksnarks;
 
 /// Key crypto algorithm.
 pub enum KeyCryptoAlgorithm {
@@ -286,3 +295,94 @@ impl KeyCryptoAlgorithm {
         }
     }
 }
+
+/// Create a zk-SNARKs account (eddsa)
+/// See [CreateZkSnarksAccountRequest]
+pub async fn create_zksnarks_account(
+    client: &impl Client,
+    mount: &str,
+) -> Result<ZkSnarksAccountResponse, ClientError> {
+    let request = CreateZkSnarksAccountRequest::builder()
+        .mount(mount)
+        .build()
+        .unwrap();
+    vaultrs::api::exec_with_result(client, request)
+        .await
+        .map_err(Into::into)
+}
+
+/// Read a zk-SNARKs account
+/// See [ReadZkSnarksAccountRequest]
+pub async fn read_zksnarks_account(
+    client: &impl Client,
+    mount: &str,
+    id: &str,
+) -> Result<ZkSnarksAccountResponse, ClientError> {
+    let request = ReadZkSnarksAccountRequest::builder()
+        .mount(mount)
+        .id(id)
+        .build()
+        .unwrap();
+    vaultrs::api::exec_with_result(client, request)
+        .await
+        .map_err(Into::into)
+}
+
+/// List zk-SNARKs accounts
+/// See [ListZkSnarksAccountsRequest]
+pub async fn list_zksnarks_accounts(
+    client: &impl Client,
+    mount: &str,
+) -> Result<ZkSnarksAccountsResponse, ClientError> {
+    let request = ListZkSnarksAccountsRequest::builder()
+        .mount(mount)
+        .build()
+        .unwrap();
+    vaultrs::api::exec_with_result(client, request)
+        .await
+        .map_err(Into::into)
+}
+
+/// Sign a message with a zk-SNARKs account (eddsa)
+/// See [ZkSnarksSignResponse]
+pub async fn zksnarks_sign(
+    client: &impl Client,
+    mount: &str,
+    id: &str,
+    data: &[u8],
+) -> Result<ZkSnarksSignResponse, ClientError> {
+    let hash = keccak256(data);
+    let hex = H256::from(hash);
+    let encoded = format!("{:?}", hex);
+    let request = ZkSnarksSignRequest::builder()
+        .mount(mount)
+        .id(id)
+        .data(encoded)
+        .build()
+        .unwrap();
+    vaultrs::api::exec_with_result(client, request)
+        .await
+        .map_err(Into::into)
+}
+
+/// Sign a message with a zk-SNARKs account (eddsa)
+/// Data must be a 32 byte hash
+/// See [ZkSnarksSignResponse]
+pub async fn zksnarks_sign_hash(
+    client: &impl Client,
+    mount: &str,
+    id: &str,
+    data: [u8; 32],
+) -> Result<ZkSnarksSignResponse, ClientError> {
+    let hex = H256::from(data);
+    let encoded = format!("{:?}", hex);
+    let request = ZkSnarksSignRequest::builder()
+        .mount(mount)
+        .id(id)
+        .data(encoded)
+        .build()
+        .unwrap();
+    vaultrs::api::exec_with_result(client, request)
+        .await
+        .map_err(Into::into)
+}

src/api/zksnarks.rs

@@ -0,0 +1,2 @@
+pub mod requests;
+pub mod responses;

src/api/zksnarks/requests.rs

@@ -0,0 +1,83 @@
+use crate::api::zksnarks::responses::*;
+use rustify_derive::Endpoint;
+
+/// ## Create Zk-Snarks Account
+/// This endpoint creates a new Zk-Snarks account.
+///
+/// * Path: /zk-snarks/accounts
+/// * Method: POST
+/// * Response: [ZkSnarksAccountResponse]
+#[derive(Builder, Debug, Endpoint)]
+#[endpoint(
+    path = "{self.mount}/zk-snarks/accounts",
+    method = "POST",
+    response = "ZkSnarksAccountResponse",
+    builder = "true"
+)]
+#[builder(setter(into))]
+pub struct CreateZkSnarksAccountRequest {
+    #[endpoint(skip)]
+    pub mount: String,
+}
+
+/// ## Read Zk-Snarks Account
+/// This endpoint gets a Zk-Snarks account by ID.
+///
+/// * Path: /zk-snarks/accounts/{self.id}
+/// * Method: GET
+/// * Response: [ZkSnarksAccountResponse]
+#[derive(Builder, Debug, Endpoint)]
+#[endpoint(
+    path = "{self.mount}/zk-snarks/accounts/{self.id}",
+    method = "GET",
+    response = "ZkSnarksAccountResponse",
+    builder = "true"
+)]
+#[builder(setter(into))]
+pub struct ReadZkSnarksAccountRequest {
+    #[endpoint(skip)]
+    pub mount: String,
+    pub id: String,
+}
+
+/// ## List Zk-Snarks Accounts
+/// This endpoint gets all Zk-Snarks accounts.
+///
+/// * Path: /zk-snarks/accounts
+/// * Method: GET
+/// * Response: [ZkSnarksAccountsResponse]
+#[derive(Builder, Debug, Endpoint)]
+#[endpoint(
+    path = "{self.mount}/zk-snarks/accounts",
+    method = "GET",
+    response = "ZkSnarksAccountsResponse",
+    builder = "true"
+)]
+#[builder(setter(into))]
+pub struct ListZkSnarksAccountsRequest {
+    #[endpoint(skip)]
+    pub mount: String,
+}
+
+/// ## Sign data with Zk-Snarks Account
+/// This endpoint signs data with a Zk-Snarks account.
+///
+/// * Path: /zk-snarks/accounts/{self.id}/sign
+/// * Method: POST
+/// * Response: [ZkSnarksSignResponse]
+#[derive(Builder, Debug, Endpoint)]
+#[endpoint(
+    path = "{self.mount}/zk-snarks/accounts/{self.id}/sign",
+    method = "POST",
+    response = "ZkSnarksSignResponse",
+    builder = "true"
+)]
+#[builder(setter(into))]
+pub struct ZkSnarksSignRequest {
+    #[endpoint(skip)]
+    pub mount: String,
+    #[endpoint(skip)]
+    pub id: String,
+    #[endpoint(body)]
+    pub data: String,
+}

src/api/zksnarks/responses.rs

@@ -0,0 +1,22 @@
+use serde::{Deserialize, Serialize};
+
+/// Response from executing [CreateZkSnarksAccountRequest][crate::api::zksnarks::requests::CreateZkSnarksAccountRequest]
+#[derive(Deserialize, Debug, Serialize)]
+pub struct ZkSnarksAccountResponse {
+    pub curve: String,
+    pub namespace: String,
+    pub public_key: String,
+    pub signing_algorithm: String,
+}
+
+/// Response from executing [ListZkSnarksAccountsRequest][crate::api::zksnarks::requests::ListZkSnarksAccountsRequest]
+#[derive(Deserialize, Debug, Serialize)]
+pub struct ZkSnarksAccountsResponse {
+    pub keys: Vec<String>,
+}
+
+/// Response from executing [ZkSnarksSignRequest][crate::api::zksnarks::requests::ZkSnarksSignRequest]
+#[derive(Deserialize, Debug, Serialize)]
+pub struct ZkSnarksSignResponse {
+    pub signature: String,
+}

tests/api/mod.rs

@@ -1,2 +1,3 @@
 mod ethereum;
 mod keys;
+mod zksnarks;