native token param

.changelog/unreleased/features/582-native-token-param.md

@@ -0,0 +1,2 @@
+- Allow to set the native token via genesis configuration.
+  ([#582](https://github.com/anoma/namada/pull/582))

.changelog/unreleased/miscellaneous/632-xan-to-nam.md

@@ -0,0 +1,2 @@
+- Renamed native token from XAN to NAM
+  ([#632](https://github.com/anoma/namada/pull/632))

apps/src/lib/cli.rs

@@ -1296,7 +1296,7 @@ pub mod args {
     const FEE_AMOUNT: ArgDefault<token::Amount> =
         arg_default("fee-amount", DefaultFn(|| token::Amount::from(0)));
     const FEE_TOKEN: ArgDefaultFromCtx<WalletAddress> =
-        arg_default_from_ctx("fee-token", DefaultFn(|| "XAN".into()));
+        arg_default_from_ctx("fee-token", DefaultFn(|| "NAM".into()));
     const FORCE: ArgFlag = flag("force");
     const DONT_PREFETCH_WASM: ArgFlag = flag("dont-prefetch-wasm");
     const GAS_LIMIT: ArgDefault<token::Amount> =

apps/src/lib/cli/context.rs

@@ -47,6 +47,8 @@ pub struct Context {
     pub global_config: GlobalConfig,
     /// The ledger configuration for a specific chain ID
     pub config: Config,
+    /// Native token's address
+    pub native_token: Address,
 }
 
 impl Context {
@@ -66,10 +68,12 @@ impl Context {
         let genesis_file_path = global_args
             .base_dir
             .join(format!("{}.toml", global_config.default_chain_id.as_str()));
-        let wallet = Wallet::load_or_new_from_genesis(
-            &chain_dir,
-            genesis_config::open_genesis_config(&genesis_file_path)?,
-        );
+        let genesis = genesis_config::read_genesis_config(&genesis_file_path);
+        let native_token = genesis.native_token;
+        let default_genesis =
+            genesis_config::open_genesis_config(genesis_file_path)?;
+        let wallet =
+            Wallet::load_or_new_from_genesis(&chain_dir, default_genesis);
 
         // If the WASM dir specified, put it in the config
         match global_args.wasm_dir.as_ref() {
@@ -88,6 +92,7 @@ impl Context {
             wallet,
             global_config,
             config,
+            native_token,
         })
     }
 

apps/src/lib/client/tx.rs

@@ -11,7 +11,7 @@ use itertools::Either::*;
 use namada::ledger::governance::storage as gov_storage;
 use namada::ledger::pos::{BondId, Bonds, Unbonds};
 use namada::proto::Tx;
-use namada::types::address::{xan as m1t, Address};
+use namada::types::address::Address;
 use namada::types::governance::{
     OfflineProposal, OfflineVote, Proposal, ProposalVote,
 };
@@ -23,7 +23,7 @@ use namada::types::transaction::governance::{
 };
 use namada::types::transaction::nft::{CreateNft, MintNft};
 use namada::types::transaction::{pos, InitAccount, InitValidator, UpdateVp};
-use namada::types::{address, storage, token};
+use namada::types::{storage, token};
 use namada::{ledger, vm};
 
 use super::rpc;
@@ -639,9 +639,13 @@ pub async fn submit_init_proposal(mut ctx: Context, args: args::InitProposal) {
             safe_exit(1)
         };
 
-        let balance = rpc::get_token_balance(&client, &m1t(), &proposal.author)
-            .await
-            .unwrap_or_default();
+        let balance = rpc::get_token_balance(
+            &client,
+            &ctx.native_token,
+            &proposal.author,
+        )
+        .await
+        .unwrap_or_default();
         if balance
             < token::Amount::from(governance_parameters.min_proposal_fund)
         {
@@ -911,7 +915,7 @@ pub async fn submit_bond(ctx: Context, args: args::Bond) {
     // Check bond's source (source for delegation or validator for self-bonds)
     // balance
     let bond_source = source.as_ref().unwrap_or(&validator);
-    let balance_key = token::balance_key(&address::xan(), bond_source);
+    let balance_key = token::balance_key(&ctx.native_token, bond_source);
     let client = HttpClient::new(args.tx.ledger_address.clone()).unwrap();
     match rpc::query_storage_value::<token::Amount>(&client, &balance_key).await
     {

apps/src/lib/client/utils.rs

@@ -612,18 +612,16 @@ pub fn init_network(
         })
     }
 
-    if let Some(token) = &mut config.token {
-        token.iter_mut().for_each(|(name, config)| {
-            if config.address.is_none() {
-                let address = address::gen_established_address("token");
-                config.address = Some(address.to_string());
-                wallet.add_address(name.clone(), address);
-            }
-            if config.vp.is_none() {
-                config.vp = Some("vp_token".to_string());
-            }
-        })
-    }
+    config.token.iter_mut().for_each(|(name, config)| {
+        if config.address.is_none() {
+            let address = address::gen_established_address("token");
+            config.address = Some(address.to_string());
+            wallet.add_address(name.clone(), address);
+        }
+        if config.vp.is_none() {
+            config.vp = Some("vp_token".to_string());
+        }
+    });
 
     if let Some(implicit) = &mut config.implicit {
         implicit.iter_mut().for_each(|(name, config)| {

apps/src/lib/config/genesis.rs

@@ -104,10 +104,13 @@ pub mod genesis_config {
     pub struct GenesisConfig {
         // Genesis timestamp
         pub genesis_time: Rfc3339String,
+        // Name of the native token - this must one of the tokens included in
+        // the `token` field
+        pub native_token: String,
         // Initial validator set
         pub validator: HashMap<String, ValidatorConfig>,
         // Token accounts present at genesis
-        pub token: Option<HashMap<String, TokenAccountConfig>>,
+        pub token: HashMap<String, TokenAccountConfig>,
         // Established accounts present at genesis
         pub established: Option<HashMap<String, EstablishedAccountConfig>>,
         // Implicit accounts present at genesis
@@ -479,32 +482,53 @@ pub mod genesis_config {
     }
 
     pub fn load_genesis_config(config: GenesisConfig) -> Genesis {
-        let wasms = config.wasm;
-        let validators: HashMap<String, Validator> = config
-            .validator
-            .iter()
-            .map(|(name, cfg)| (name.clone(), load_validator(cfg, &wasms)))
-            .collect();
-        let established_accounts: HashMap<String, EstablishedAccount> = config
-            .established
-            .unwrap_or_default()
+        let GenesisConfig {
+            genesis_time,
+            native_token,
+            validator,
+            token,
+            established,
+            implicit,
+            parameters,
+            pos_params,
+            gov_params,
+            wasm,
+        } = config;
+
+        let native_token = Address::decode(
+            token
+                .get(&native_token)
+                .expect(
+                    "Native token's alias must be present in the declared \
+                     tokens",
+                )
+                .address
+                .as_ref()
+                .expect("Missing native token address"),
+        )
+        .expect("Invalid address");
+
+        let validators: HashMap<String, Validator> = validator
             .iter()
-            .map(|(name, cfg)| (name.clone(), load_established(cfg, &wasms)))
+            .map(|(name, cfg)| (name.clone(), load_validator(cfg, &wasm)))
             .collect();
-        let implicit_accounts: HashMap<String, ImplicitAccount> = config
-            .implicit
+        let established_accounts: HashMap<String, EstablishedAccount> =
+            established
+                .unwrap_or_default()
+                .iter()
+                .map(|(name, cfg)| (name.clone(), load_established(cfg, &wasm)))
+                .collect();
+        let implicit_accounts: HashMap<String, ImplicitAccount> = implicit
             .unwrap_or_default()
             .iter()
             .map(|(name, cfg)| (name.clone(), load_implicit(cfg)))
             .collect();
-        let token_accounts = config
-            .token
-            .unwrap_or_default()
+        let token_accounts = token
             .iter()
             .map(|(_name, cfg)| {
                 load_token(
                     cfg,
-                    &wasms,
+                    &wasm,
                     &validators,
                     &established_accounts,
                     &implicit_accounts,
@@ -514,53 +538,66 @@ pub mod genesis_config {
 
         let parameters = Parameters {
             epoch_duration: EpochDuration {
-                min_num_of_blocks: config.parameters.min_num_of_blocks,
+                min_num_of_blocks: parameters.min_num_of_blocks,
                 min_duration: namada::types::time::Duration::seconds(
-                    config.parameters.min_duration,
+                    parameters.min_duration,
                 )
                 .into(),
             },
             max_expected_time_per_block:
                 namada::types::time::Duration::seconds(
-                    config.parameters.max_expected_time_per_block,
+                    parameters.max_expected_time_per_block,
                 )
                 .into(),
-            vp_whitelist: config.parameters.vp_whitelist.unwrap_or_default(),
-            tx_whitelist: config.parameters.tx_whitelist.unwrap_or_default(),
+            vp_whitelist: parameters.vp_whitelist.unwrap_or_default(),
+            tx_whitelist: parameters.tx_whitelist.unwrap_or_default(),
         };
 
+        let GovernanceParamsConfig {
+            min_proposal_fund,
+            max_proposal_code_size,
+            min_proposal_period,
+            max_proposal_content_size,
+            min_proposal_grace_epochs,
+            max_proposal_period,
+        } = gov_params;
         let gov_params = GovParams {
-            min_proposal_fund: config.gov_params.min_proposal_fund,
-            max_proposal_code_size: config.gov_params.max_proposal_code_size,
-            min_proposal_period: config.gov_params.min_proposal_period,
-            max_proposal_period: config.gov_params.max_proposal_period,
-            max_proposal_content_size: config
-                .gov_params
-                .max_proposal_content_size,
-            min_proposal_grace_epochs: config
-                .gov_params
-                .min_proposal_grace_epochs,
+            min_proposal_fund,
+            max_proposal_code_size,
+            min_proposal_period,
+            max_proposal_content_size,
+            min_proposal_grace_epochs,
+            max_proposal_period,
         };
 
+        let PosParamsConfig {
+            max_validator_slots,
+            pipeline_len,
+            unbonding_len,
+            votes_per_token,
+            block_proposer_reward,
+            block_vote_reward,
+            duplicate_vote_slash_rate,
+            light_client_attack_slash_rate,
+        } = pos_params;
         let pos_params = PosParams {
-            max_validator_slots: config.pos_params.max_validator_slots,
-            pipeline_len: config.pos_params.pipeline_len,
-            unbonding_len: config.pos_params.unbonding_len,
-            votes_per_token: BasisPoints::new(
-                config.pos_params.votes_per_token,
-            ),
-            block_proposer_reward: config.pos_params.block_proposer_reward,
-            block_vote_reward: config.pos_params.block_vote_reward,
+            max_validator_slots,
+            pipeline_len,
+            unbonding_len,
+            votes_per_token: BasisPoints::new(votes_per_token),
+            block_proposer_reward,
+            block_vote_reward,
             duplicate_vote_slash_rate: BasisPoints::new(
-                config.pos_params.duplicate_vote_slash_rate,
+                duplicate_vote_slash_rate,
             ),
             light_client_attack_slash_rate: BasisPoints::new(
-                config.pos_params.light_client_attack_slash_rate,
+                light_client_attack_slash_rate,
             ),
         };
 
         let mut genesis = Genesis {
-            genesis_time: config.genesis_time.try_into().unwrap(),
+            genesis_time: genesis_time.try_into().unwrap(),
+            native_token,
             validators: validators.into_values().collect(),
             token_accounts,
             established_accounts: established_accounts.into_values().collect(),
@@ -608,6 +645,7 @@ pub mod genesis_config {
 #[borsh_init(init)]
 pub struct Genesis {
     pub genesis_time: DateTimeUtc,
+    pub native_token: Address,
     pub validators: Vec<Validator>,
     pub token_accounts: Vec<TokenAccount>,
     pub established_accounts: Vec<EstablishedAccount>,
@@ -839,6 +877,7 @@ pub fn genesis() -> Genesis {
         parameters,
         pos_params: PosParams::default(),
         gov_params: GovParams::default(),
+        native_token: address::nam(),
     }
 }
 

apps/src/lib/node/ledger/mod.rs

@@ -30,6 +30,7 @@ use crate::config::TendermintMode;
 use crate::facade::tendermint_proto::abci::CheckTxType;
 use crate::facade::tower_abci::{response, split, Server};
 use crate::node::ledger::broadcaster::Broadcaster;
+use crate::node::ledger::config::genesis;
 use crate::node::ledger::shell::{Error, MempoolTxType, Shell};
 use crate::node::ledger::shims::abcipp_shim::AbcippShim;
 use crate::node::ledger::shims::abcipp_shim_types::shim::{Request, Response};
@@ -423,13 +424,18 @@ fn start_abci_broadcaster_shell(
     // Construct our ABCI application.
     let tendermint_mode = config.tendermint.tendermint_mode.clone();
     let ledger_address = config.shell.ledger_address;
+    #[cfg(not(feature = "dev"))]
+    let genesis = genesis::genesis(&config.shell.base_dir, &config.chain_id);
+    #[cfg(feature = "dev")]
+    let genesis = genesis::genesis();
     let (shell, abci_service) = AbcippShim::new(
         config,
         wasm_dir,
         broadcaster_sender,
         &db_cache,
         vp_wasm_compilation_cache,
         tx_wasm_compilation_cache,
+        genesis.native_token,
     );
 
     // Channel for signalling shut down to ABCI server

apps/src/lib/node/ledger/shell/finalize_block.rs

@@ -321,7 +321,6 @@ where
 /// are covered by the e2e tests.
 #[cfg(test)]
 mod test_finalize_block {
-    use namada::types::address::xan;
     use namada::types::storage::Epoch;
     use namada::types::transaction::{EncryptionKey, Fee};
 
@@ -349,7 +348,7 @@ mod test_finalize_block {
             let wrapper = WrapperTx::new(
                 Fee {
                     amount: i.into(),
-                    token: xan(),
+                    token: shell.storage.native_token.clone(),
                 },
                 &keypair,
                 Epoch(0),
@@ -420,7 +419,7 @@ mod test_finalize_block {
         let wrapper = WrapperTx::new(
             Fee {
                 amount: 0.into(),
-                token: xan(),
+                token: shell.storage.native_token.clone(),
             },
             &keypair,
             Epoch(0),
@@ -472,7 +471,7 @@ mod test_finalize_block {
         let wrapper = WrapperTx {
             fee: Fee {
                 amount: 0.into(),
-                token: xan(),
+                token: shell.storage.native_token.clone(),
             },
             pk: keypair.ref_to(),
             epoch: Epoch(0),
@@ -538,7 +537,7 @@ mod test_finalize_block {
             let wrapper_tx = WrapperTx::new(
                 Fee {
                     amount: 0.into(),
-                    token: xan(),
+                    token: shell.storage.native_token.clone(),
                 },
                 &keypair,
                 Epoch(0),
@@ -569,7 +568,7 @@ mod test_finalize_block {
             let wrapper_tx = WrapperTx::new(
                 Fee {
                     amount: 0.into(),
-                    token: xan(),
+                    token: shell.storage.native_token.clone(),
                 },
                 &keypair,
                 Epoch(0),