Add epoch to the UserChain and linera wallet show (#4458)

MathieuDutSik · web-flow · commit 44e63124d4ad · 2025-09-04T12:35:42.000Z
## Motivation The `linera wallet show` presents the data on the chain being tracked. Other information can be added easily. Fixes #2958 ## Proposal The `epoch` is always present in the output of `chain_info_query`. So, it can be added to the `UserChain` easily. Possible extension: * Adding if a chain is closed or not (it suffices to add a boolean to `ChainInfo`). ## Test Plan The readme test case fungible which is the only one with `linera wallet show` has been ## Release Plan - Nothing to do / These changes follow the usual release cycle. ## Links None.
diff --git a/linera-client/src/chain_listener.rs b/linera-client/src/chain_listener.rs
@@ -14,7 +14,7 @@ use futures::{
 };
 use linera_base::{
     crypto::{CryptoHash, Signer},
-    data_types::{ChainDescription, Timestamp},
+    data_types::{ChainDescription, Epoch, Timestamp},
     identifiers::{AccountOwner, BlobType, ChainId},
     task::NonBlockingFuture,
 };
@@ -107,6 +107,7 @@ pub trait ClientContext {
         chain_id: ChainId,
         owner: Option<AccountOwner>,
         timestamp: Timestamp,
+        epoch: Epoch,
     ) -> Result<(), Error>;
 
     async fn update_wallet(&mut self, client: &ContextChainClient<Self>) -> Result<(), Error>;
@@ -339,6 +340,7 @@ impl<C: ClientContext> ChainListener<C> {
                             new_chain_id,
                             Some(chain_owner),
                             block.header.timestamp,
+                            block.header.epoch,
                         )
                         .await?;
                     new_ids.insert(new_chain_id, ListeningMode::FullChain);
diff --git a/linera-client/src/client_context.rs b/linera-client/src/client_context.rs
@@ -6,7 +6,7 @@ use std::sync::Arc;
 use futures::Future;
 use linera_base::{
     crypto::{CryptoHash, ValidatorPublicKey},
-    data_types::{BlockHeight, Timestamp},
+    data_types::{BlockHeight, Epoch, Timestamp},
     identifiers::{Account, AccountOwner, ChainId},
     ownership::ChainOwnership,
     time::{Duration, Instant},
@@ -107,8 +107,9 @@ where
         chain_id: ChainId,
         owner: Option<AccountOwner>,
         timestamp: Timestamp,
+        epoch: Epoch,
     ) -> Result<(), Error> {
-        self.update_wallet_for_new_chain(chain_id, owner, timestamp)
+        self.update_wallet_for_new_chain(chain_id, owner, timestamp, epoch)
             .await
     }
 
@@ -306,6 +307,7 @@ impl<Env: Environment, W: Persist<Target = Wallet>> ClientContext<Env, W> {
         chain_id: ChainId,
         owner: Option<AccountOwner>,
         timestamp: Timestamp,
+        epoch: Epoch,
     ) -> Result<(), Error> {
         if self.wallet.get(chain_id).is_none() {
             self.mutate_wallet(|w| {
@@ -316,6 +318,7 @@ impl<Env: Environment, W: Persist<Target = Wallet>> ClientContext<Env, W> {
                     timestamp,
                     next_block_height: BlockHeight::ZERO,
                     pending_proposal: None,
+                    epoch: Some(epoch),
                 })
             })
             .await?;
@@ -388,7 +391,14 @@ impl<Env: Environment, W: Persist<Target = Wallet>> ClientContext<Env, W> {
         }
 
         self.wallet_mut()
-            .mutate(|w| w.assign_new_chain_to_owner(owner, chain_id, chain_description.timestamp()))
+            .mutate(|w| {
+                w.assign_new_chain_to_owner(
+                    owner,
+                    chain_id,
+                    chain_description.timestamp(),
+                    chain_description.config().epoch,
+                )
+            })
             .await
             .map_err(|e| error::Inner::Persistence(Box::new(e)))?
             .context("assigning new chain")?;
diff --git a/linera-client/src/unit_tests/chain_listener.rs b/linera-client/src/unit_tests/chain_listener.rs
@@ -8,7 +8,7 @@ use std::{sync::Arc, time::Duration};
 use futures::{lock::Mutex, FutureExt as _};
 use linera_base::{
     crypto::{AccountPublicKey, InMemorySigner},
-    data_types::{Amount, BlockHeight, TimeDelta, Timestamp},
+    data_types::{Amount, BlockHeight, Epoch, TimeDelta, Timestamp},
     identifiers::{Account, AccountOwner, ChainId},
     ownership::{ChainOwnership, TimeoutConfig},
 };
@@ -58,6 +58,7 @@ impl chain_listener::ClientContext for ClientContext {
         chain_id: ChainId,
         owner: Option<AccountOwner>,
         timestamp: Timestamp,
+        epoch: Epoch,
     ) -> Result<(), Error> {
         if self.wallet.get(chain_id).is_none() {
             self.wallet.insert(UserChain {
@@ -67,6 +68,7 @@ impl chain_listener::ClientContext for ClientContext {
                 timestamp,
                 next_block_height: BlockHeight::ZERO,
                 pending_proposal: None,
+                epoch: Some(epoch),
             });
         }
 
@@ -105,6 +107,8 @@ async fn test_chain_listener() -> anyhow::Result<()> {
     let genesis_config = make_genesis_config(&builder);
     let admin_id = genesis_config.admin_id();
     let storage = builder.make_storage().await?;
+    let epoch0 = client0.chain_info().await?.epoch;
+    let epoch1 = client1.chain_info().await?.epoch;
 
     let mut context = ClientContext {
         wallet: Wallet::new(genesis_config),
@@ -123,13 +127,14 @@ async fn test_chain_listener() -> anyhow::Result<()> {
         )),
     };
     context
-        .update_wallet_for_new_chain(chain_id0, Some(owner), clock.current_time())
+        .update_wallet_for_new_chain(chain_id0, Some(owner), clock.current_time(), epoch0)
         .await?;
     context
         .update_wallet_for_new_chain(
             client1.chain_id(),
             client1.preferred_owner(),
             clock.current_time(),
+            epoch1,
         )
         .await?;
 
diff --git a/linera-client/src/wallet.rs b/linera-client/src/wallet.rs
@@ -5,7 +5,7 @@ use std::{collections::BTreeMap, iter::IntoIterator};
 
 use linera_base::{
     crypto::CryptoHash,
-    data_types::{BlockHeight, ChainDescription, Timestamp},
+    data_types::{BlockHeight, ChainDescription, Epoch, Timestamp},
     ensure,
     identifiers::{AccountOwner, ChainId},
 };
@@ -109,6 +109,7 @@ impl Wallet {
         owner: AccountOwner,
         chain_id: ChainId,
         timestamp: Timestamp,
+        epoch: Epoch,
     ) -> Result<(), Error> {
         let user_chain = UserChain {
             chain_id,
@@ -117,6 +118,7 @@ impl Wallet {
             timestamp,
             next_block_height: BlockHeight(0),
             pending_proposal: None,
+            epoch: Some(epoch),
         };
         self.insert(user_chain);
         Ok(())
@@ -144,6 +146,7 @@ impl Wallet {
             next_block_height: info.next_block_height,
             timestamp: info.timestamp,
             pending_proposal,
+            epoch: Some(info.epoch),
         });
     }
 
@@ -165,6 +168,7 @@ pub struct UserChain {
     pub timestamp: Timestamp,
     pub next_block_height: BlockHeight,
     pub pending_proposal: Option<PendingProposal>,
+    pub epoch: Option<Epoch>,
 }
 
 impl Clone for UserChain {
@@ -176,6 +180,7 @@ impl Clone for UserChain {
             timestamp: self.timestamp,
             next_block_height: self.next_block_height,
             pending_proposal: self.pending_proposal.clone(),
+            epoch: self.epoch,
         }
     }
 }
@@ -187,18 +192,20 @@ impl UserChain {
         description: ChainDescription,
         timestamp: Timestamp,
     ) -> Self {
+        let epoch = description.config().epoch;
         Self {
             chain_id: description.into(),
             owner: Some(owner),
             block_hash: None,
             timestamp,
             next_block_height: BlockHeight::ZERO,
             pending_proposal: None,
+            epoch: Some(epoch),
         }
     }
 
     /// Creates an entry for a chain that we don't own. The timestamp must be the genesis
-    /// timestamp or earlier.
+    /// timestamp or earlier. The Epoch is `None`.
     pub fn make_other(chain_id: ChainId, timestamp: Timestamp) -> Self {
         Self {
             chain_id,
@@ -207,6 +214,7 @@ impl UserChain {
             timestamp,
             next_block_height: BlockHeight::ZERO,
             pending_proposal: None,
+            epoch: None,
         }
     }
 }
diff --git a/linera-faucet/server/src/tests.rs b/linera-faucet/server/src/tests.rs
@@ -8,7 +8,7 @@ use std::{collections::VecDeque, path::PathBuf, sync::Arc};
 use futures::lock::Mutex;
 use linera_base::{
     crypto::{AccountPublicKey, CryptoHash, InMemorySigner, TestString},
-    data_types::{Amount, Timestamp},
+    data_types::{Amount, Epoch, Timestamp},
     identifiers::{AccountOwner, ChainId},
 };
 use linera_client::{chain_listener, wallet::Wallet};
@@ -58,6 +58,7 @@ impl chain_listener::ClientContext for ClientContext {
         _: ChainId,
         _: Option<AccountOwner>,
         _: Timestamp,
+        _: Epoch,
     ) -> Result<(), linera_client::Error> {
         self.update_calls += 1;
         Ok(())
diff --git a/linera-service/src/cli/main.rs b/linera-service/src/cli/main.rs
@@ -171,9 +171,10 @@ impl Runnable for Job {
                     .await
                     .context("Failed to open chain")?;
                 let timestamp = certificate.block().header.timestamp;
+                let epoch = certificate.block().header.epoch;
                 let id = description.id();
                 context
-                    .update_wallet_for_new_chain(id, Some(new_owner), timestamp)
+                    .update_wallet_for_new_chain(id, Some(new_owner), timestamp, epoch)
                     .await?;
                 let time_total = time_start.elapsed();
                 info!(
@@ -225,8 +226,9 @@ impl Runnable for Job {
                 // No owner. This chain can be assigned explicitly using the assign command.
                 let owner = None;
                 let timestamp = certificate.block().header.timestamp;
+                let epoch = certificate.block().header.epoch;
                 context
-                    .update_wallet_for_new_chain(id, owner, timestamp)
+                    .update_wallet_for_new_chain(id, owner, timestamp, epoch)
                     .await?;
                 let time_total = time_start.elapsed();
                 info!(
@@ -2162,7 +2164,7 @@ async fn run(options: &ClientOptions) -> Result<i32, Error> {
             genesis_config.persist().await?;
             options
                 .create_wallet(genesis_config.into_value())?
-                .mutate(|wallet| wallet.extend(chains))
+                .mutate(|w| w.extend(chains))
                 .await?;
             options.initialize_storage().boxed().await?;
             info!(
@@ -2323,20 +2325,21 @@ async fn run(options: &ClientOptions) -> Result<i32, Error> {
                 owned,
             } => {
                 let start_time = Instant::now();
+                let wallet = options.wallet().await?;
                 let chain_ids = if let Some(chain_id) = chain_id {
                     ensure!(!owned, "Cannot specify both --owned and a chain ID");
                     vec![*chain_id]
                 } else if *owned {
-                    options.wallet().await?.owned_chain_ids()
+                    wallet.owned_chain_ids()
                 } else {
-                    options.wallet().await?.chain_ids()
+                    wallet.chain_ids()
                 };
                 if *short {
                     for chain_id in chain_ids {
                         println!("{chain_id}");
                     }
                 } else {
-                    wallet::pretty_print(&*options.wallet().await?, chain_ids).await;
+                    wallet::pretty_print(&wallet, chain_ids).await;
                 }
                 info!("Wallet shown in {} ms", start_time.elapsed().as_millis());
                 Ok(0)
@@ -2384,9 +2387,7 @@ async fn run(options: &ClientOptions) -> Result<i32, Error> {
                 options
                     .wallet()
                     .await?
-                    .mutate(|wallet| {
-                        wallet.extend([UserChain::make_other(*chain_id, Timestamp::now())])
-                    })
+                    .mutate(|w| w.extend([UserChain::make_other(*chain_id, Timestamp::now())]))
                     .await?;
                 if *sync {
                     options.run_with_storage(Job(options.clone())).await??;
diff --git a/linera-service/src/schema_export.rs b/linera-service/src/schema_export.rs
@@ -5,7 +5,7 @@ use std::sync::Arc;
 
 use linera_base::{
     crypto::CryptoHash,
-    data_types::{BlobContent, BlockHeight, NetworkDescription, Timestamp},
+    data_types::{BlobContent, BlockHeight, Epoch, NetworkDescription, Timestamp},
     identifiers::{AccountOwner, BlobId, ChainId},
 };
 use linera_chain::{
@@ -212,6 +212,7 @@ impl ClientContext for DummyContext {
         _: ChainId,
         _: Option<AccountOwner>,
         _: Timestamp,
+        _: Epoch,
     ) -> Result<(), Error> {
         Ok(())
     }
diff --git a/linera-service/src/wallet.rs b/linera-service/src/wallet.rs
@@ -18,6 +18,7 @@ pub async fn pretty_print(wallet: &Wallet, chain_ids: impl IntoIterator<Item = C
             Cell::new("Chain ID").add_attribute(Attribute::Bold),
             Cell::new("Latest Block").add_attribute(Attribute::Bold),
         ]);
+
     for chain_id in chain_ids {
         let Some(user_chain) = wallet.chains.get(&chain_id) else {
             panic!("Chain {} not found.", chain_id);
@@ -39,19 +40,25 @@ async fn update_table_with_chain(
     user_chain: &UserChain,
     is_default_chain: bool,
 ) {
+    let epoch = user_chain.epoch;
     let chain_id_cell = if is_default_chain {
         Cell::new(format!("{}", chain_id)).fg(Color::Green)
     } else {
         Cell::new(format!("{}", chain_id))
     };
+    let epoch_str = match epoch {
+        None => "-".to_string(),
+        Some(epoch) => format!("{}", epoch),
+    };
     let account_owner = user_chain.owner;
     table.add_row(vec![
         chain_id_cell,
         Cell::new(format!(
             r#"AccountOwner:       {}
 Block Hash:         {}
 Timestamp:          {}
-Next Block Height:  {}"#,
+Next Block Height:  {}
+Epoch:              {}"#,
             account_owner
                 .as_ref()
                 .map(|o| o.to_string())
@@ -61,7 +68,8 @@ Next Block Height:  {}"#,
                 .map(|bh| bh.to_string())
                 .unwrap_or_else(|| "-".to_string()),
             user_chain.timestamp,
-            user_chain.next_block_height
+            user_chain.next_block_height,
+            epoch_str
         )),
     ]);
 }
diff --git a/linera-web/src/lib.rs b/linera-web/src/lib.rs
@@ -140,6 +140,7 @@ impl JsFaucet {
                     account_owner,
                     description.id(),
                     description.timestamp(),
+                    description.config().epoch,
                 )
             })
             .await??;

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ impl JsFaucet {`
`140`	`140`	`account_owner,`
`141`	`141`	`description.id(),`
`142`	`142`	`description.timestamp(),`
	`143`	`+ description.config().epoch,`
`143`	`144`	`)`
`144`	`145`	`})`
`145`	`146`	`.await??;`