Add a programs version (#1045)

* Add a version number to programs

* integrate program version number to ts

* changelog

* add version number ro run command

* rename version number

* add program version number export to test-cli

* release checklist addition

* lint

* Apply suggestions from code review

Co-authored-by: peg <peg@magmacollective.org>

* Apply suggestions from code review

Co-authored-by: Hernando Castano <HCastano@users.noreply.github.com>
Co-authored-by: peg <peg@magmacollective.org>

* clean

* Update pallets/programs/src/benchmarking.rs

Co-authored-by: Hernando Castano <HCastano@users.noreply.github.com>

* fix benchmark

---------

Co-authored-by: peg <peg@magmacollective.org>
Co-authored-by: Hernando Castano <HCastano@users.noreply.github.com>

CHANGELOG.md

@@ -18,6 +18,7 @@ At the moment this project **does not** adhere to
  cleaned up. A lot of storage entries, events, and extrinsics were removed from the `Registry`
  pallet. The genesis build config was also removed. Additionally, the `new/user/` HTTP endpoint in
  the TSS was removed since it was no longer necessary.
+- In [#1045](https://github.com/entropyxyz/entropy-core/pull/1045), `ProgramsInfo` now takes `version_number` to maintain backwards compatibility if programs runtime is updated 
 
 ### Added
 - Jumpstart network ([#918](https://github.com/entropyxyz/entropy-core/pull/918))
@@ -33,6 +34,7 @@ At the moment this project **does not** adhere to
 - Attestation pallet ([#1003](https://github.com/entropyxyz/entropy-core/pull/1003))
 - Update test CLI for new registration and signing flows ([#1008](https://github.com/entropyxyz/entropy-core/pull/1008))
 - Add remove program function to entropy-client ([#1023](https://github.com/entropyxyz/entropy-core/pull/1023))
+- Add a programs version ([#1045](https://github.com/entropyxyz/entropy-core/pull/1045))
 
 ### Changed
 - Fix TSS `AccountId` keys in chainspec ([#993](https://github.com/entropyxyz/entropy-core/pull/993))

RELEASE_CHECKLIST.md

@@ -14,6 +14,7 @@ tagged as the final release.
 - [ ] If an existing call/extrinsic has changed (new pallet index, new call index, parameter changes,
  etc.), bump `transaction_version` and bump `spec_version`
 - [ ] If you're confused about what to bump, read [this](https://paritytech.github.io/polkadot-sdk/master/sp_version/struct.RuntimeVersion.html)
+- [ ] If the programs runtime has been updated increment `PROGRAM_VERSION_NUMBER` in `shared` crate
 - [ ] Update runtime benchmarks
  - `cargo build -p entropy --release --features runtime-benchmarks && ./scripts/benchmarks.sh`
  - Note: These should ideally be run on [reference hardware](https://wiki.polkadot.network/docs/maintain-guides-how-to-validate-polkadot#reference-hardware) (i.e `c6i.4xlarge` on AWS)

crates/client/src/client.rs

@@ -196,6 +196,7 @@ pub async fn sign(
 }
 
 /// Store a program on chain and return it's hash
+#[allow(clippy::too_many_arguments)]
 #[tracing::instrument(
  skip_all,
  fields(
@@ -210,12 +211,14 @@ pub async fn store_program(
  configuration_interface: Vec<u8>,
  auxiliary_data_interface: Vec<u8>,
  oracle_data_pointer: Vec<u8>,
+ version_number: u8,
 ) -> Result<<EntropyConfig as Config>::Hash, ClientError> {
  let set_program_tx = entropy::tx().programs().set_program(
  program,
  configuration_interface,
  auxiliary_data_interface,
  oracle_data_pointer,
+ version_number,
  );
  let in_block =
  submit_transaction_with_pair(api, rpc, deployer_pair, &set_program_tx, None).await?;

crates/client/src/tests.rs

@@ -98,6 +98,7 @@ async fn test_store_and_remove_program() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();
@@ -142,6 +143,7 @@ async fn test_remove_program_reference_counter() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();

crates/shared/src/constants.rs

@@ -76,3 +76,6 @@ pub const SIGNER_THRESHOLD: u8 = 2;
 
 /// For testing to line up chain mock data and reshare_test
 pub const TEST_RESHARE_BLOCK_NUMBER: u32 = 5;
+
+/// Program version number, must be incremented if version number changes
+pub const PROGRAM_VERSION_NUMBER: u8 = 0;

crates/test-cli/Cargo.toml

@@ -20,3 +20,4 @@ hex ="0.4.3"
 bincode ="1.3.3"
 x25519-dalek ="2.0.1"
 sp-runtime ={ version="32.0.0", default-features=false }
+entropy-shared={ version="0.2.0", path="../shared" }

crates/test-cli/src/lib.rs

@@ -30,6 +30,7 @@ use entropy_client::{
  VERIFYING_KEY_LENGTH,
  },
 };
+pub use entropy_shared::PROGRAM_VERSION_NUMBER;
 use sp_core::{sr25519, Hasher, Pair};
 use sp_runtime::traits::BlakeTwo256;
 use std::{fs, path::PathBuf};
@@ -74,6 +75,8 @@ enum CliCommand {
  /// interface. If no such file exists, it is assumed the program has no configuration
  /// interface.
  programs: Vec<String>,
+ /// Option of version numbers to go with the programs, will default to 0 if None
+ program_version_numbers: Option<Vec<u8>>,
  /// A name or mnemonic from which to derive a program modification keypair.
  /// This is used to send the register extrinsic so it must be funded
  /// If giving a name it must be preceded with "//", eg: "--mnemonic-option //Alice"
@@ -109,6 +112,8 @@ enum CliCommand {
  /// interface. If no such file exists, it is assumed the program has no configuration
  /// interface.
  programs: Vec<String>,
+ /// Option of version numbers to go with the programs, will default to 0 if None
+ program_version_numbers: Option<Vec<u8>>,
  /// The mnemonic to use for the call
  #[arg(short, long)]
  mnemonic_option: Option<String>,
@@ -121,6 +126,8 @@ enum CliCommand {
  config_interface_file: Option<PathBuf>,
  /// The path to a file containing the program aux interface (defaults to empty)
  aux_data_interface_file: Option<PathBuf>,
+ /// The version number of the program's runtime you compiled with
+ program_version_number: Option<u8>,
  /// The mnemonic to use for the call
  #[arg(short, long)]
  mnemonic_option: Option<String>,
@@ -170,6 +177,7 @@ pub async fn run_command(
  program_file_option: Option<PathBuf>,
  config_interface_file_option: Option<PathBuf>,
  aux_data_interface_file_option: Option<PathBuf>,
+ program_version_number_option: Option<u8>,
 ) -> anyhow::Result<String> {
  let cli = Cli::parse();
 
@@ -183,7 +191,7 @@ pub async fn run_command(
  let rpc = get_rpc(&endpoint_addr).await?;
 
  match cli.command {
- CliCommand::Register { mnemonic_option, programs } => {
+ CliCommand::Register { mnemonic_option, programs, program_version_numbers } => {
  let mnemonic = if let Some(mnemonic_option) = mnemonic_option {
  mnemonic_option
  } else {
@@ -196,9 +204,19 @@ pub async fn run_command(
 
  let mut programs_info = vec![];
 
- for program in programs {
+ for (i, program) in programs.into_iter().enumerate() {
+ let program_version_number =
+ program_version_numbers.as_ref().map_or(0u8, |versions| versions[i]);
  programs_info.push(
- Program::from_hash_or_filename(&api, &rpc, &program_keypair, program).await?.0,
+ Program::from_hash_or_filename(
+ &api,
+ &rpc,
+ &program_keypair,
+ program,
+ program_version_number,
+ )
+ .await?
+ .0,
  );
  }
 
@@ -248,6 +266,7 @@ pub async fn run_command(
  program_file,
  config_interface_file,
  aux_data_interface_file,
+ program_version_number,
  } => {
  let mnemonic = if let Some(mnemonic_option) = mnemonic_option {
  mnemonic_option
@@ -276,6 +295,11 @@ pub async fn run_command(
  )?,
  };
 
+ let program_version_number = match program_version_number_option {
+ Some(program_version_number) => program_version_number,
+ None => program_version_number.unwrap_or(0u8),
+ };
+
  let hash = store_program(
  &api,
  &rpc,
@@ -284,6 +308,7 @@ pub async fn run_command(
  config_interface,
  aux_data_interface,
  vec![],
+ program_version_number,
  )
  .await?;
  Ok(format!("Program stored {hash}"))
@@ -305,7 +330,12 @@ pub async fn run_command(
 
  Ok("Program removed".to_string())
  },
- CliCommand::UpdatePrograms { signature_verifying_key, mnemonic_option, programs } => {
+ CliCommand::UpdatePrograms {
+ signature_verifying_key,
+ mnemonic_option,
+ programs,
+ program_version_numbers,
+ } => {
  let mnemonic = if let Some(mnemonic_option) = mnemonic_option {
  mnemonic_option
  } else {
@@ -315,9 +345,20 @@ pub async fn run_command(
  println!("Program account: {}", program_keypair.public());
 
  let mut programs_info = Vec::new();
- for program in programs {
+
+ for (i, program) in programs.into_iter().enumerate() {
+ let program_version_number =
+ program_version_numbers.as_ref().map_or(0u8, |versions| versions[i]);
  programs_info.push(
- Program::from_hash_or_filename(&api, &rpc, &program_keypair, program).await?.0,
+ Program::from_hash_or_filename(
+ &api,
+ &rpc,
+ &program_keypair,
+ program,
+ program_version_number,
+ )
+ .await?
+ .0,
  );
  }
 
@@ -459,6 +500,7 @@ impl Program {
  rpc: &LegacyRpcMethods<EntropyConfig>,
  keypair: &sr25519::Pair,
  hash_or_filename: String,
+ program_version_number: u8,
  ) -> anyhow::Result<Self> {
  match hex::decode(hash_or_filename.clone()) {
  Ok(hash) => {
@@ -474,10 +516,15 @@ impl Program {
  };
  Ok(Self::new(H256(hash_32), configuration))
  },
- Err(_) => Self::from_file(api, rpc, keypair, hash_or_filename).await,
+ Err(_) => {
+ Self::from_file(api, rpc, keypair, hash_or_filename, program_version_number)
+ .await
+ },
  }
  },
- Err(_) => Self::from_file(api, rpc, keypair, hash_or_filename).await,
+ Err(_) => {
+ Self::from_file(api, rpc, keypair, hash_or_filename, program_version_number).await
+ },
  }
  }
 
@@ -488,6 +535,7 @@ impl Program {
  rpc: &LegacyRpcMethods<EntropyConfig>,
  keypair: &sr25519::Pair,
  filename: String,
+ program_version_number: u8,
  ) -> anyhow::Result<Self> {
  let program_bytecode = fs::read(&filename)?;
 
@@ -526,6 +574,7 @@ impl Program {
  config_description,
  auxiliary_data_schema,
  vec![],
+ program_version_number,
  )
  .await
  {

crates/test-cli/src/main.rs

@@ -22,7 +22,7 @@ use entropy_test_cli::run_command;
 #[tokio::main]
 async fn main() -> anyhow::Result<()> {
  let now = Instant::now();
- match run_command(None, None, None).await {
+ match run_command(None, None, None, None).await {
  Ok(output) => {
  println!("Success: {}", output.green());
  println!("{}", format!("That took {:?}", now.elapsed()).yellow());

crates/threshold-signature-server/src/helpers/tests.rs

@@ -317,6 +317,7 @@ pub async fn store_program_and_register(
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();

crates/threshold-signature-server/src/user/tests.rs

@@ -650,6 +650,7 @@ async fn test_program_with_config() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();
@@ -855,6 +856,7 @@ async fn test_compute_hash() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();
@@ -947,6 +949,7 @@ async fn test_fail_infinite_program() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();
@@ -1031,6 +1034,7 @@ async fn test_device_key_proxy() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();
@@ -1183,6 +1187,7 @@ async fn test_faucet() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();
@@ -1347,6 +1352,7 @@ async fn test_registration_flow() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();

crates/threshold-signature-server/src/validator/tests.rs

@@ -198,6 +198,7 @@ async fn test_reshare() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();

crates/threshold-signature-server/tests/register_and_sign.rs

@@ -64,6 +64,7 @@ async fn integration_test_register_and_sign() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();

crates/threshold-signature-server/tests/sign_eth_tx.rs

@@ -74,6 +74,7 @@ async fn integration_test_sign_eth_tx() {
  vec![],
  vec![],
  vec![],
+ 0u8,
  )
  .await
  .unwrap();