Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(jstzd): add bootstrap accounts to ProtocolParameterBuilder #578

Open
wants to merge 1 commit into
base: huanchengchang-jstz-149
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/jstzd/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ async-trait.workspace = true
bollard.workspace = true
futures-util.workspace = true
http.workspace = true
jstz_crypto = { path = "../jstz_crypto" }
octez = { path = "../octez" }
reqwest.workspace = true
rust-embed.workspace = true
Expand Down
80 changes: 80 additions & 0 deletions crates/jstzd/src/protocol/bootstrap.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
use jstz_crypto::public_key::PublicKey;
use serde_json::Value;

#[derive(Clone, PartialEq, Eq, Debug)]
pub struct BootstrapAccount {
public_key: PublicKey,
amount_tez: u64,
}

impl BootstrapAccount {
pub fn new(public_key: &str, amount: u64) -> anyhow::Result<Self> {
Ok(Self {
public_key: PublicKey::from_base58(public_key)?,
amount_tez: amount,
})
}
}

#[derive(Default)]
pub struct BootstrapAccounts {
pub accounts: Vec<BootstrapAccount>,
}

impl From<BootstrapAccounts> for Value {
fn from(value: BootstrapAccounts) -> Self {
Value::Array(
value
.accounts
.iter()
.map(|v| {
Value::Object({
let mut map = serde_json::Map::new();
map.insert(
"public_key".to_owned(),
Value::String(v.public_key.to_string()),
);
map.insert(
"amount".to_owned(),
Value::Number(v.amount_tez.into()),
);
map
})
})
.collect(),
)
}
}

#[cfg(test)]
mod tests {
use serde_json::Value;

use super::{BootstrapAccount, BootstrapAccounts};

const ACCOUNT_PUBLIC_KEY: &str =
"edpkubRfnPoa6ts5vBdTB5syvjeK2AyEF3kyhG4Sx7F9pU3biku4wv";

#[test]
fn bootstrap_account_new() {
let account = BootstrapAccount::new(ACCOUNT_PUBLIC_KEY, 1000).unwrap();
assert_eq!(account.public_key.to_string(), ACCOUNT_PUBLIC_KEY);
assert_eq!(account.amount_tez, 1000);
}

#[test]
fn serde_value_from_bootstrap_accounts() {
let accounts = BootstrapAccounts {
accounts: vec![BootstrapAccount::new(ACCOUNT_PUBLIC_KEY, 1000).unwrap()],
};
let value = Value::from(accounts);
let arr = value.as_array().unwrap();
assert_eq!(arr.len(), 1);
let account = arr.last().unwrap().as_object().unwrap();
assert_eq!(
account.get("public_key").unwrap().as_str().unwrap(),
ACCOUNT_PUBLIC_KEY
);
assert_eq!(account.get("amount").unwrap().as_u64().unwrap(), 1000);
}
}
50 changes: 47 additions & 3 deletions crates/jstzd/src/protocol/mod.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
mod bootstrap;

pub use bootstrap::BootstrapAccount;
use bootstrap::BootstrapAccounts;
use rust_embed::Embed;
use serde_json::Value;
use std::fmt::Display;
Expand Down Expand Up @@ -67,6 +71,7 @@ pub struct ProtocolParameterFile;
pub struct ProtocolParameterBuilder {
protocol: Protocol,
constants: ProtocolConstants,
bootstrap_accounts: BootstrapAccounts,
path: Option<PathBuf>,
}

Expand All @@ -85,6 +90,14 @@ impl ProtocolParameterBuilder {
self
}

pub fn set_bootstrap_accounts(
&mut self,
accounts: Vec<BootstrapAccount>,
) -> &mut Self {
self.bootstrap_accounts.accounts = accounts;
self
}

pub fn set_path(&mut self, path: &str) -> &mut Self {
self.path = Some(PathBuf::from(path));
self
Expand All @@ -102,6 +115,10 @@ impl ProtocolParameterBuilder {
let json = raw_json
.as_object_mut()
.ok_or(anyhow::anyhow!("Failed to convert json file"))?;
json.insert(
"bootstrap_accounts".to_owned(),
Value::from(self.bootstrap_accounts),
);
drop(f);
let path = self
.path
Expand All @@ -114,21 +131,34 @@ impl ProtocolParameterBuilder {

#[cfg(test)]
mod tests {
use super::{Protocol, ProtocolConstants, ProtocolParameterBuilder};
use super::{
BootstrapAccount, Protocol, ProtocolConstants, ProtocolParameterBuilder,
};

const ACCOUNT_PUBLIC_KEY: &str =
"edpktzB3sirfeX6PrgAgWvRVT8Fd28jVLbWXKJmaUrYmK2UoSHc1eJ";

#[test]
fn parameter_builder() {
let mut builder = ProtocolParameterBuilder::new();
builder
.set_constants(ProtocolConstants::TestConstants)
.set_protocol(Protocol::TestVersion)
.set_path("/test/path");
.set_path("/test/path")
.set_bootstrap_accounts(
[BootstrapAccount::new(ACCOUNT_PUBLIC_KEY, 1000).unwrap()].to_vec(),
);
assert_eq!(builder.constants, ProtocolConstants::TestConstants);
assert_eq!(
builder.path.unwrap().as_os_str().to_str().unwrap(),
"/test/path"
);
assert_eq!(builder.protocol.hash(), Protocol::TestVersion.hash());
assert_eq!(builder.bootstrap_accounts.accounts.len(), 1);
assert_eq!(
builder.bootstrap_accounts.accounts.last().unwrap(),
&BootstrapAccount::new(ACCOUNT_PUBLIC_KEY, 1000).unwrap()
);
}

#[test]
Expand All @@ -140,6 +170,7 @@ mod tests {
);
assert!(builder.path.is_none());
assert_eq!(builder.protocol, Protocol::Alpha);
assert!(builder.bootstrap_accounts.accounts.is_empty());
}

#[tokio::test]
Expand All @@ -150,7 +181,10 @@ mod tests {
builder
.set_path(expected_output_path.as_os_str().to_str().unwrap())
.set_protocol(Protocol::Alpha)
.set_constants(ProtocolConstants::Sandbox);
.set_constants(ProtocolConstants::Sandbox)
.set_bootstrap_accounts(
[BootstrapAccount::new(ACCOUNT_PUBLIC_KEY, 1000).unwrap()].to_vec(),
);
let output_path = builder.build().await.unwrap();
assert_eq!(expected_output_path, output_path);
let file = std::fs::File::open(output_path).unwrap();
Expand All @@ -162,5 +196,15 @@ mod tests {
.unwrap(),
2
);

// Check accounts
let accounts = json.get("bootstrap_accounts").unwrap().as_array().unwrap();
assert_eq!(accounts.len(), 1);
let account = accounts.last().unwrap().as_object().unwrap();
let mut keys = account.keys().collect::<Vec<_>>();
keys.sort();
assert_eq!(keys, ["amount", "public_key"]);
assert_eq!(account.get("amount").unwrap(), 1000);
assert_eq!(account.get("public_key").unwrap(), ACCOUNT_PUBLIC_KEY);
}
}