Program config storage (#593)

* add program config storage * update relayer * relayer tests * fix server tests * programs benchmark * program benchmarks * fix all tests * change function to change program data * clean * add changelog * tweaks * change program data to instance
entropyxyz · Jan 18, 2024 · 9458361 · 9458361
1 parent 9181513
commit 9458361
Show file tree

Hide file tree

Showing 20 changed files with 446 additions and 206 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@ At the moment this project **does not** adhere to
 - In [#592](https://github.com/entropyxyz/entropy-core/pull/592), the `local-devnet` chain-type was
   renamed to `devnet-local`. Additionally, the default chain type when none is specified is now
   `dev` instead of `local`.
+- A user now needs to add a program config, which gets packaged with their program pointer to create program info. This changes both register and change_program_info (previously change_program_pointer). As well set_program now also takes program_type_definition. ([#593](https://github.com/entropyxyz/entropy-core/pull/593))
 
 ### Added
 - Test CLI which calls the same code as in integration tests ([#417](https://github.com/entropyxyz/entropy-core/pull/417))
@@ -34,6 +35,7 @@ At the moment this project **does not** adhere to
 - Add ref counter to programs ([#585](https://github.com/entropyxyz/entropy-core/pull/585/))
 - Add `--setup-only` flag ([#588](https://github.com/entropyxyz/entropy-core/pull/588/))
 - Add --version flag and about field to TSS ([#590](https://github.com/entropyxyz/entropy-core/pull/590/))
+- Program config storage ([#593](https://github.com/entropyxyz/entropy-core/pull/593))
 
 ### Changed
 - Crate name refactor ([#561](https://github.com/entropyxyz/entropy-core/pull/561))

diff --git a/crates/test-cli/src/main.rs b/crates/test-cli/src/main.rs
@@ -24,7 +24,10 @@ use std::{
 use clap::{Parser, Subcommand};
 use colored::Colorize;
 use entropy_testing_utils::{
-    chain_api::entropy::runtime_types::bounded_collections::bounded_vec::BoundedVec,
+    chain_api::{
+        entropy::runtime_types::bounded_collections::bounded_vec::BoundedVec,
+        entropy::runtime_types::pallet_relayer::pallet::ProgramInstance,
+    },
     constants::{AUXILARY_DATA_SHOULD_SUCCEED, TEST_PROGRAM_WASM_BYTECODE},
     test_client::{
         derive_static_secret, get_accounts, get_api, get_rpc, register, sign, update_program,
@@ -70,6 +73,8 @@ enum CliCommand {
         key_visibility: Visibility,
         /// The hash of the initial program for the account
         program_hashes: Vec<H256>,
+        /// The program configs of the initial programs for the account
+        program_configs: Vec<Vec<u8>>,
     },
     /// Ask the network to sign a given message
     Sign {
@@ -94,6 +99,8 @@ enum CliCommand {
         program_account_name: String,
         /// The path to a .wasm file containing the program (defaults to test program)
         program_file: Option<PathBuf>,
+        /// The path to a file containing the program config (defaults to empty)
+        program_config_file: Option<PathBuf>,
     },
     /// Display a list of registered Entropy accounts
     Status,
@@ -157,6 +164,7 @@ async fn run_command() -> anyhow::Result<String> {
             program_account_name,
             key_visibility,
             program_hashes,
+            program_configs,
         } => {
             let signature_request_keypair: sr25519::Pair =
                 SeedString::new(signature_request_account_name).try_into()?;
@@ -176,14 +184,22 @@ async fn run_command() -> anyhow::Result<String> {
                 },
                 Visibility::Public => KeyVisibility::Public,
             };
+            let mut programs_info = vec![];
+
+            for i in 0..program_hashes.len() {
+                programs_info.push(ProgramInstance {
+                    program_pointer: program_hashes[i],
+                    program_config: program_configs[i].clone(),
+                });
+            }
 
             let (registered_info, keyshare_option) = register(
                 &api,
                 &rpc,
                 signature_request_keypair.clone(),
                 program_account,
                 key_visibility_converted,
-                BoundedVec(program_hashes),
+                BoundedVec(programs_info),
             )
             .await?;
 
@@ -225,6 +241,7 @@ async fn run_command() -> anyhow::Result<String> {
             signature_request_account_name,
             program_account_name,
             program_file,
+            program_config_file,
         } => {
             let signature_request_keypair: sr25519::Pair =
                 SeedString::new(signature_request_account_name).try_into()?;
@@ -235,9 +252,14 @@ async fn run_command() -> anyhow::Result<String> {
                 None => TEST_PROGRAM_WASM_BYTECODE.to_owned(),
             };
 
+            let program_config = match program_config_file {
+                Some(file_name) => fs::read(file_name)?,
+                None => vec![],
+            };
+
             let program_keypair: sr25519::Pair =
                 SeedString::new(program_account_name).try_into()?;
-            update_program(&api, &program_keypair, program).await?;
+            update_program(&api, &program_keypair, program, program_config).await?;
             Ok("Program updated".to_string())
         },
         CliCommand::Status => {

diff --git a/crates/testing-utils/src/test_client/mod.rs b/crates/testing-utils/src/test_client/mod.rs
@@ -36,6 +36,7 @@ use entropy_protocol::{
 use entropy_tss::{
     chain_api::{
         entropy, entropy::runtime_types::bounded_collections::bounded_vec::BoundedVec,
+        entropy::runtime_types::pallet_relayer::pallet::ProgramInstance,
         entropy::runtime_types::pallet_relayer::pallet::RegisteredInfo, EntropyConfig,
     },
     common::{get_current_subgroup_signers, Hasher, UserSignatureRequest},
@@ -46,7 +47,7 @@ use sp_core::{crypto::AccountId32, sr25519, Bytes, Pair};
 use subxt::{
     backend::legacy::LegacyRpcMethods,
     tx::{PairSigner, Signer},
-    utils::{AccountId32 as SubxtAccountId32, Static, H256},
+    utils::{AccountId32 as SubxtAccountId32, Static},
     Config, OnlineClient,
 };
 use synedrion::k256::ecdsa::{RecoveryId, Signature as k256Signature, VerifyingKey};
@@ -71,7 +72,7 @@ pub async fn register(
     signature_request_keypair: sr25519::Pair,
     program_account: SubxtAccountId32,
     key_visibility: KeyVisibility,
-    program_hashes: BoundedVec<H256>,
+    programs_data: BoundedVec<ProgramInstance>,
 ) -> anyhow::Result<(RegisteredInfo, Option<KeyShare<KeyParams>>)> {
     // Check if user is already registered
     let account_id32: AccountId32 = signature_request_keypair.public().into();
@@ -89,7 +90,7 @@ pub async fn register(
         signature_request_keypair.clone(),
         program_account,
         key_visibility,
-        program_hashes,
+        programs_data,
     )
     .await?;
 
@@ -249,8 +250,9 @@ pub async fn update_program(
     api: &OnlineClient<EntropyConfig>,
     program_modification_keypair: &sr25519::Pair,
     program: Vec<u8>,
+    program_type_definition: Vec<u8>,
 ) -> anyhow::Result<<EntropyConfig as Config>::Hash> {
-    let update_program_tx = entropy::tx().programs().set_program(program);
+    let update_program_tx = entropy::tx().programs().set_program(program, program_type_definition);
     let program_modification_account =
         PairSigner::<EntropyConfig, sr25519::Pair>::new(program_modification_keypair.clone());
 
@@ -273,14 +275,14 @@ pub async fn update_pointer(
     rpc: &LegacyRpcMethods<EntropyConfig>,
     signature_request_account: &sr25519::Pair,
     pointer_modification_account: &sr25519::Pair,
-    program_hashes: BoundedVec<<EntropyConfig as Config>::Hash>,
+    program_instance: BoundedVec<ProgramInstance>,
 ) -> anyhow::Result<()> {
     let block_hash =
         rpc.chain_get_block_hash(None).await?.ok_or_else(|| anyhow!("Error getting block hash"))?;
 
     let update_pointer_tx = entropy::tx()
         .relayer()
-        .change_program_pointer(signature_request_account.public().into(), program_hashes);
+        .change_program_instance(signature_request_account.public().into(), program_instance);
 
     let account_id32: AccountId32 = pointer_modification_account.public().into();
     let account_id: <EntropyConfig as Config>::AccountId = account_id32.into();
@@ -329,15 +331,15 @@ pub async fn put_register_request_on_chain(
     signature_request_keypair: sr25519::Pair,
     program_modification_account: SubxtAccountId32,
     key_visibility: KeyVisibility,
-    program_hashes: BoundedVec<H256>,
+    program_instance: BoundedVec<ProgramInstance>,
 ) -> anyhow::Result<()> {
     let signature_request_pair_signer =
         PairSigner::<EntropyConfig, sp_core::sr25519::Pair>::new(signature_request_keypair);
 
     let registering_tx = entropy::tx().relayer().register(
         program_modification_account,
         Static(key_visibility),
-        program_hashes,
+        program_instance,
     );
 
     api.tx()

diff --git a/crates/threshold-signature-server/entropy_metadata.scale b/crates/threshold-signature-server/entropy_metadata.scale
diff --git a/crates/threshold-signature-server/src/helpers/tests.rs b/crates/threshold-signature-server/src/helpers/tests.rs
@@ -185,9 +185,10 @@ pub async fn update_programs(
     entropy_api: &OnlineClient<EntropyConfig>,
     program_modification_account: &sr25519::Pair,
     initial_program: Vec<u8>,
+    program_config: Vec<u8>,
 ) -> <EntropyConfig as Config>::Hash {
     // update/set their programs
-    let update_program_tx = entropy::tx().programs().set_program(initial_program);
+    let update_program_tx = entropy::tx().programs().set_program(initial_program, program_config);
 
     let program_modification_account =
         PairSigner::<EntropyConfig, sr25519::Pair>::new(program_modification_account.clone());

diff --git a/crates/threshold-signature-server/src/helpers/user.rs b/crates/threshold-signature-server/src/helpers/user.rs
@@ -26,15 +26,15 @@ use sha1::{Digest as Sha1Digest, Sha1};
 use sha2::{Digest as Sha256Digest, Sha256};
 use sha3::{Digest as Sha3Digest, Keccak256, Sha3_256};
 use sp_core::{sr25519, Bytes, Pair};
-use subxt::{
-    backend::legacy::LegacyRpcMethods, tx::PairSigner, utils::AccountId32, Config, OnlineClient,
-};
+use subxt::{backend::legacy::LegacyRpcMethods, tx::PairSigner, utils::AccountId32, OnlineClient};
 use synedrion::KeyShare;
 use tokio::time::timeout;
 use x25519_dalek::PublicKey;
 
 use crate::{
-    chain_api::{entropy, EntropyConfig},
+    chain_api::{
+        entropy, entropy::runtime_types::pallet_relayer::pallet::ProgramInstance, EntropyConfig,
+    },
     helpers::substrate::get_program,
     signing_client::{protocol_transport::open_protocol_connections, Listener, ListenerState},
     user::{api::UserRegistrationInfo, errors::UserErr},
@@ -174,7 +174,7 @@ pub async fn compute_hash(
     rpc: &LegacyRpcMethods<EntropyConfig>,
     hashing_algorithm: &HashingAlgorithm,
     runtime: &mut Runtime,
-    program_pointers: &[<EntropyConfig as Config>::Hash],
+    programs_data: &[ProgramInstance],
     message: &[u8],
 ) -> Result<[u8; 32], UserErr> {
     match hashing_algorithm {
@@ -211,7 +211,7 @@ pub async fn compute_hash(
             Ok(hash)
         },
         HashingAlgorithm::Custom(i) => {
-            let program = get_program(api, rpc, &program_pointers[*i]).await?;
+            let program = get_program(api, rpc, &programs_data[*i].program_pointer).await?;
             runtime.custom_hash(program.as_slice(), message).map_err(|e| e.into())
         },
     }

diff --git a/crates/threshold-signature-server/src/user/api.rs b/crates/threshold-signature-server/src/user/api.rs
@@ -147,25 +147,25 @@ pub async fn sign_tx(
 
     let message = hex::decode(&user_sig_req.message)?;
 
-    if user_details.program_pointers.0.is_empty() {
+    if user_details.programs_data.0.is_empty() {
         return Err(UserErr::NoProgramPointerDefined());
     }
     // handle aux data padding, if it is not explicit by client for ease send through None, error if incorrect length
     let auxilary_data_vec;
     if let Some(auxilary_data) = user_sig_req.clone().auxilary_data {
-        if auxilary_data.len() < user_details.program_pointers.0.len() {
+        if auxilary_data.len() < user_details.programs_data.0.len() {
             return Err(UserErr::MismatchAuxData);
         } else {
             auxilary_data_vec = auxilary_data;
         }
     } else {
-        auxilary_data_vec = vec![None; user_details.program_pointers.0.len()];
+        auxilary_data_vec = vec![None; user_details.programs_data.0.len()];
     }
 
     let mut runtime = Runtime::new(ProgramConfig { fuel: MAX_INSTRUCTIONS_PER_PROGRAM });
 
-    for (i, program_pointer) in user_details.program_pointers.0.iter().enumerate() {
-        let program = get_program(&api, &rpc, program_pointer).await?;
+    for (i, program_info) in user_details.programs_data.0.iter().enumerate() {
+        let program = get_program(&api, &rpc, &program_info.program_pointer).await?;
         let auxilary_data = auxilary_data_vec[i].as_ref().map(hex::decode).transpose()?;
         let signature_request = SignatureRequest { message: message.clone(), auxilary_data };
         runtime.evaluate(&program, &signature_request)?;
@@ -189,7 +189,7 @@ pub async fn sign_tx(
         &rpc,
         &user_sig_req.hash,
         &mut runtime,
-        &user_details.program_pointers.0,
+        &user_details.programs_data.0,
         message.as_slice(),
     )
     .await?;