From 8b61b912517b17a2727f76b7139d254263b303d4 Mon Sep 17 00:00:00 2001 From: Tiago Carvalho Date: Mon, 12 Aug 2024 13:14:32 +0100 Subject: [PATCH 1/2] Support arbitrary addresses in `balances.toml` --- crates/apps_lib/src/config/genesis.rs | 125 +++++++++++++++++- .../apps_lib/src/config/genesis/templates.rs | 10 +- .../src/config/genesis/transactions.rs | 9 +- crates/node/src/shell/init_chain.rs | 2 +- crates/tests/src/e2e/setup.rs | 5 +- 5 files changed, 136 insertions(+), 15 deletions(-) diff --git a/crates/apps_lib/src/config/genesis.rs b/crates/apps_lib/src/config/genesis.rs index 5d7d4a8534..6e879c5c66 100644 --- a/crates/apps_lib/src/config/genesis.rs +++ b/crates/apps_lib/src/config/genesis.rs @@ -30,6 +30,110 @@ use namada_sdk::token::Denomination; use namada_sdk::{storage, token}; use serde::{Deserialize, Serialize}; +#[derive( + Clone, + Debug, + BorshSerialize, + BorshDeserialize, + BorshDeserializer, + PartialEq, + Eq, + Ord, + PartialOrd, + Hash, +)] +#[allow(missing_docs)] +pub enum GenesisBalanceAddress { + PublicKey(StringEncoded), + Address(Address), +} + +impl GenesisBalanceAddress { + /// Return an [`Address`] from this [`GenesisBalanceAddress`]. + #[inline] + pub fn address(&self) -> Address { + match self { + Self::Address(addr) => addr.clone(), + Self::PublicKey(pk) => (&pk.raw).into(), + } + } +} + +impl Serialize for GenesisBalanceAddress { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + match self { + GenesisBalanceAddress::Address(address) => { + Serialize::serialize(&address, serializer) + } + GenesisBalanceAddress::PublicKey(pk) => { + Serialize::serialize(pk, serializer) + } + } + } +} + +impl<'de> Deserialize<'de> for GenesisBalanceAddress { + fn deserialize(deserializer: D) -> Result + where + D: serde::Deserializer<'de>, + { + struct FieldVisitor; + + impl<'de> serde::de::Visitor<'de> for FieldVisitor { + type Value = GenesisBalanceAddress; + + fn expecting( + &self, + formatter: &mut Formatter<'_>, + ) -> std::fmt::Result { + formatter + .write_str("a bech32m encoded public key or an address") + } + + fn visit_str(self, value: &str) -> Result + where + E: serde::de::Error, + { + GenesisBalanceAddress::from_str(value) + .map_err(serde::de::Error::custom) + } + } + + deserializer.deserialize_str(FieldVisitor) + } +} + +impl Display for GenesisBalanceAddress { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + GenesisBalanceAddress::Address(address) => write!(f, "{address}"), + GenesisBalanceAddress::PublicKey(pk) => write!(f, "{}", pk), + } + } +} + +impl FromStr for GenesisBalanceAddress { + type Err = String; + + fn from_str(value: &str) -> Result { + // Try to deserialize a PK first + let maybe_pk = StringEncoded::::from_str(value); + match maybe_pk { + Ok(pk) => Ok(GenesisBalanceAddress::PublicKey(pk)), + Err(_) => { + // If that doesn't work, attempt to retrieve + // an address + let address = + Address::from_str(value).map_err(|err| err.to_string())?; + Ok(GenesisBalanceAddress::Address(address)) + } + } + } +} + #[derive( Clone, Debug, @@ -49,6 +153,18 @@ pub enum GenesisAddress { EstablishedAddress(EstablishedAddress), } +impl From for GenesisBalanceAddress { + #[inline] + fn from(genesis_addr: GenesisAddress) -> Self { + match genesis_addr { + GenesisAddress::PublicKey(pk) => Self::PublicKey(pk), + GenesisAddress::EstablishedAddress(addr) => { + Self::Address(Address::Established(addr)) + } + } + } +} + impl GenesisAddress { /// Return an [`Address`] from this [`GenesisAddress`]. #[inline] @@ -427,7 +543,8 @@ pub fn make_dev_genesis( .first() .unwrap(); let genesis_addr = - GenesisAddress::EstablishedAddress(tx.tx.data.address.raw.clone()); + GenesisAddress::EstablishedAddress(tx.tx.data.address.raw.clone()) + .into(); let balance = *nam_balances.0.get(&genesis_addr).unwrap(); let bonded = { @@ -544,10 +661,12 @@ pub fn make_dev_genesis( .unwrap(); let validator_addr = - GenesisAddress::EstablishedAddress(validator_address.clone()); + GenesisAddress::EstablishedAddress(validator_address.clone()) + .into(); let account_pk = GenesisAddress::PublicKey(StringEncoded::new( consensus_keypair.ref_to(), - )); + )) + .into(); nam_balances.0.insert(validator_addr, first_val_balance); nam_balances.0.insert(account_pk, first_val_balance); diff --git a/crates/apps_lib/src/config/genesis/templates.rs b/crates/apps_lib/src/config/genesis/templates.rs index 5c6e682a24..8b430c2db8 100644 --- a/crates/apps_lib/src/config/genesis/templates.rs +++ b/crates/apps_lib/src/config/genesis/templates.rs @@ -24,7 +24,7 @@ use super::transactions::{self, Transactions}; use super::utils::{read_toml, write_toml}; use crate::config::genesis::chain::DeriveEstablishedAddress; use crate::config::genesis::transactions::{BondTx, SignedBondTx}; -use crate::config::genesis::GenesisAddress; +use crate::config::genesis::GenesisBalanceAddress; use crate::wallet::Alias; pub const BALANCES_FILE_NAME: &str = "balances.toml"; @@ -141,7 +141,7 @@ pub struct DenominatedBalances { Eq, )] pub struct RawTokenBalances( - pub BTreeMap, + pub BTreeMap, ); /// Genesis balances for a given token @@ -157,7 +157,7 @@ pub struct RawTokenBalances( Eq, )] pub struct TokenBalances( - pub BTreeMap, + pub BTreeMap, ); /// Genesis validity predicates @@ -522,7 +522,7 @@ pub struct IbcParams { } impl TokenBalances { - pub fn get(&self, addr: &GenesisAddress) -> Option { + pub fn get(&self, addr: &GenesisBalanceAddress) -> Option { self.0.get(addr).map(|amt| amt.amount()) } } @@ -1048,7 +1048,7 @@ mod tests { let sk = key::testing::keypair_1(); let pk = sk.ref_to(); let address = - GenesisAddress::PublicKey(StringEncoded { raw: pk.clone() }); + GenesisBalanceAddress::PublicKey(StringEncoded { raw: pk.clone() }); let balance = token::Amount::from(101_000_001); let token_alias = Alias::from("Some_token".to_string()); let contents = format!( diff --git a/crates/apps_lib/src/config/genesis/transactions.rs b/crates/apps_lib/src/config/genesis/transactions.rs index 34d086f30b..c1b4f9a5ba 100644 --- a/crates/apps_lib/src/config/genesis/transactions.rs +++ b/crates/apps_lib/src/config/genesis/transactions.rs @@ -42,7 +42,7 @@ use crate::config::genesis::chain::DeriveEstablishedAddress; use crate::config::genesis::templates::{ TemplateValidation, Unvalidated, Validated, }; -use crate::config::genesis::{utils, GenesisAddress}; +use crate::config::genesis::{utils, GenesisAddress, GenesisBalanceAddress}; use crate::wallet::{CliWalletUtils, WalletTransport}; /// Dummy chain id used to sign [`Tx`] objects at pre-genesis. @@ -1197,9 +1197,10 @@ fn validate_bond( // Check and update token balance of the source let native_token = ¶meters.parameters.native_token; + let source = GenesisBalanceAddress::from(source.clone()); match balances.get_mut(native_token) { Some(balances) => { - let balance = balances.amounts.get_mut(source); + let balance = balances.amounts.get_mut(&source); match balance { Some(balance) => { if *balance < *amount { @@ -1213,7 +1214,7 @@ fn validate_bond( } else { // Deduct the amount from source if amount == balance { - balances.amounts.remove(source); + balances.amounts.remove(&source); } else if let Some(new_balance) = balance.checked_sub(*amount) { @@ -1254,7 +1255,7 @@ fn validate_bond( #[derive(Clone, Debug)] pub struct TokenBalancesForValidation { /// Accumulator for tokens transferred to accounts - pub amounts: BTreeMap, + pub amounts: BTreeMap, } pub fn validate_established_account( diff --git a/crates/node/src/shell/init_chain.rs b/crates/node/src/shell/init_chain.rs index 498ee5d6bc..a5c9d415c1 100644 --- a/crates/node/src/shell/init_chain.rs +++ b/crates/node/src/shell/init_chain.rs @@ -512,7 +512,7 @@ where }; for (owner, balance) in balances { - if let genesis::GenesisAddress::PublicKey(pk) = owner { + if let genesis::GenesisBalanceAddress::PublicKey(pk) = owner { namada_sdk::account::init_account_storage( &mut self.state, &owner.address(), diff --git a/crates/tests/src/e2e/setup.rs b/crates/tests/src/e2e/setup.rs index a2fdab0e31..d494f8e8f3 100644 --- a/crates/tests/src/e2e/setup.rs +++ b/crates/tests/src/e2e/setup.rs @@ -251,7 +251,7 @@ where .get_mut(&Alias::from_str("nam").expect("Infallible")) .expect("NAM balances should exist in pre-genesis wallet already"); nam_balances.0.insert( - GenesisAddress::PublicKey(StringEncoded::new(sk.ref_to())), + GenesisAddress::PublicKey(StringEncoded::new(sk.ref_to())).into(), token::DenominatedAmount::new( token::Amount::from_uint(1000000, NATIVE_MAX_DECIMAL_PLACES) .unwrap(), @@ -259,7 +259,8 @@ where ), ); nam_balances.0.insert( - GenesisAddress::EstablishedAddress(validator_address.clone()), + GenesisAddress::EstablishedAddress(validator_address.clone()) + .into(), token::DenominatedAmount::new( token::Amount::from_uint(2000000, NATIVE_MAX_DECIMAL_PLACES) .unwrap(), From f58bc905c1f1b577ff302095857e9f4ed70612ae Mon Sep 17 00:00:00 2001 From: Tiago Carvalho Date: Tue, 13 Aug 2024 09:32:18 +0100 Subject: [PATCH 2/2] Changelog for #3614 --- .../improvements/3614-implicit-addr-balances-toml.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .changelog/unreleased/improvements/3614-implicit-addr-balances-toml.md diff --git a/.changelog/unreleased/improvements/3614-implicit-addr-balances-toml.md b/.changelog/unreleased/improvements/3614-implicit-addr-balances-toml.md new file mode 100644 index 0000000000..b09c9a259e --- /dev/null +++ b/.changelog/unreleased/improvements/3614-implicit-addr-balances-toml.md @@ -0,0 +1,3 @@ +- Support additional address kinds in `balances.toml` genesis file. + Previously, only established addresses and public keys were supported. + ([\#3614](https://github.com/anoma/namada/pull/3614)) \ No newline at end of file