Generate unbonding token metadata on the fly for the approval dialog

apps/extension/.env

@@ -1,6 +1,6 @@
 
 PRAX=lkpmkhpnhknhmibgnmmhdhgdilepfghe
-IDB_VERSION=32
+IDB_VERSION=33
 USDC_ASSET_ID="reum7wQmk/owgvGMWMZn/6RFPV24zIKq3W6In/WwZgg="
 MINIFRONT_URL=https://app.testnet.penumbra.zone/
 PENUMBRA_NODE_PD_URL=https://grpc.testnet.penumbra.zone/

apps/extension/src/state/tx-approval.ts

@@ -66,9 +66,9 @@ export const createTxApprovalSlice = (): SliceCreator<TxApprovalSlice> => (set,
     const getMetadata = async (assetId: AssetId) => {
       try {
         const { denomMetadata } = await viewClient.assetMetadataById({ assetId });
-        return denomMetadata ?? new Metadata();
+        return denomMetadata ?? new Metadata({ penumbraAssetId: assetId });
       } catch {
-        return new Metadata();
+        return new Metadata({ penumbraAssetId: assetId });
       }
     };
 

packages/storage/src/indexed-db/index.ts

@@ -118,7 +118,10 @@ export class IndexedDb implements IndexedDbInterface {
 
     const instance = new this(db, new IbdUpdater(db), constants, chainId);
     await instance.saveLocalAssetsMetadata(); // Pre-load asset metadata
-    await instance.addEpoch(0n); // Create first epoch
+
+    const existing0thEpoch = await instance.getEpochByHeight(0n);
+    if (!existing0thEpoch) await instance.addEpoch(0n); // Create first epoch
+
     return instance;
   }
   close(): void {

packages/types/src/indexed-db.ts

@@ -219,4 +219,5 @@ export const IDB_TABLES: Tables = {
   prices: 'PRICES',
   validator_infos: 'VALIDATOR_INFOS',
   transactions: 'TRANSACTIONS',
+  full_sync_height: 'FULL_SYNC_HEIGHT',
 };

packages/wasm/crate/Cargo.toml

@@ -38,6 +38,7 @@ hex                      = "0.4.3"
 indexed_db_futures       = "0.4.1"
 prost                    = "0.12.3"
 rand_core                = { version = "0.6.4", features = ["getrandom"] }
+regex                    = { version = "1.8.1" }
 serde                    = { version = "1.0.197", features = ["derive"] }
 serde-wasm-bindgen       = "0.6.5"
 thiserror                = "1.0"

packages/wasm/crate/src/lib.rs

@@ -8,6 +8,7 @@ pub mod build;
 pub mod dex;
 pub mod error;
 pub mod keys;
+pub mod metadata;
 pub mod note_record;
 pub mod planner;
 pub mod storage;

packages/wasm/crate/src/metadata.rs

@@ -0,0 +1,42 @@
+use penumbra_proto::core::asset::v1::Metadata;
+use regex::Regex;
+
+pub static UNBONDING_TOKEN_REGEX: &str = "^uunbonding_(?P<data>start_at_(?P<start>[0-9]+)_(?P<validator>penumbravalid1(?P<id>[a-zA-HJ-NP-Z0-9]+)))$";
+pub static DELEGATION_TOKEN_REGEX: &str =
+    "^udelegation_(?P<data>penumbravalid1[a-zA-HJ-NP-Z0-9]+)$";
+pub static SHORTENED_ID_LENGTH: usize = 8;
+
+pub fn customize_symbol(metadata: Metadata) -> Metadata {
+    if let Some(unbonding_match) = Regex::new(UNBONDING_TOKEN_REGEX)
+        .expect("regex is valid")
+        .captures(&metadata.base)
+    {
+        let id_match = unbonding_match.name("id").unwrap().as_str();
+        let shortened_id = id_match
+            .chars()
+            .take(SHORTENED_ID_LENGTH)
+            .collect::<String>();
+        let start_match = unbonding_match.name("start").unwrap().as_str();
+
+        Metadata {
+            symbol: format!("unbondUMat{start_match}({shortened_id}…)"),
+            ..metadata
+        }
+    } else if let Some(delegation_match) = Regex::new(DELEGATION_TOKEN_REGEX)
+        .expect("regex is valid")
+        .captures(&metadata.base)
+    {
+        let id_match = delegation_match.name("id").unwrap().as_str();
+        let shortened_id = id_match
+            .chars()
+            .take(SHORTENED_ID_LENGTH)
+            .collect::<String>();
+
+        Metadata {
+            symbol: format!("delUM({shortened_id}…)"),
+            ..metadata
+        }
+    } else {
+        metadata
+    }
+}

packages/wasm/crate/src/planner.rs

@@ -3,6 +3,7 @@ use std::collections::BTreeMap;
 use anyhow::anyhow;
 use ark_ff::UniformRand;
 use decaf377::{Fq, Fr};
+use penumbra_asset::asset::Metadata;
 use penumbra_asset::{asset, Balance, Value};
 use penumbra_dex::swap_claim::SwapClaimPlan;
 use penumbra_dex::{
@@ -22,7 +23,7 @@ use penumbra_proto::DomainType;
 use penumbra_sct::params::SctParameters;
 use penumbra_shielded_pool::{fmd, OutputPlan, SpendPlan};
 use penumbra_stake::rate::RateData;
-use penumbra_stake::{IdentityKey, Penalty, UndelegateClaimPlan};
+use penumbra_stake::{IdentityKey, Penalty, Undelegate, UndelegateClaimPlan};
 use penumbra_transaction::gas::GasCost;
 use penumbra_transaction::memo::MemoPlaintext;
 use penumbra_transaction::{plan::MemoPlan, ActionPlan, TransactionParameters, TransactionPlan};
@@ -31,6 +32,7 @@ use rand_core::OsRng;
 use wasm_bindgen::prelude::wasm_bindgen;
 use wasm_bindgen::JsValue;
 
+use crate::metadata::customize_symbol;
 use crate::note_record::SpendableNoteRecord;
 use crate::storage::IndexedDBStorage;
 use crate::utils;
@@ -319,11 +321,12 @@ pub async fn plan_transaction(
         let rate_data: RateData = rate_data
             .ok_or_else(|| anyhow!("missing rate data in undelegation"))?
             .try_into()?;
-        actions.push(
-            rate_data
-                .build_undelegate(epoch.into(), value.amount)
-                .into(),
-        );
+
+        let undelegate = rate_data.build_undelegate(epoch.into(), value.amount);
+
+        save_unbonding_token_metadata_if_needed(&undelegate, &storage).await?;
+
+        actions.push(undelegate.into());
     }
 
     for tpr::UndelegateClaim {
@@ -480,3 +483,25 @@ pub async fn plan_transaction(
 
     Ok(serde_wasm_bindgen::to_value(&plan)?)
 }
+
+/// When planning an undelegate action, there may not be metadata yet in the
+/// IndexedDB database for the unbonding token that the transaction will output.
+/// That's because unbonding tokens are tied to a specific height. If unbonding
+/// tokens for a given validator and a given height don't exist yet, we'll
+/// generate them here and save them to the database, so that they can render
+/// correctly in the transaction approval dialog.
+async fn save_unbonding_token_metadata_if_needed(
+    undelegate: &Undelegate,
+    storage: &IndexedDBStorage,
+) -> WasmResult<()> {
+    let metadata = undelegate.unbonding_token().denom();
+
+    if storage.get_asset(&metadata.id()).await?.is_none() {
+        let metadata_proto = metadata.to_proto();
+        let customized_metadata_proto = customize_symbol(metadata_proto);
+        let customized_metadata = Metadata::try_from(customized_metadata_proto)?;
+        storage.add_asset(&customized_metadata).await
+    } else {
+        Ok(())
+    }
+}

packages/wasm/crate/src/storage.rs

@@ -41,6 +41,7 @@ pub struct Tables {
     pub gas_prices: String,
     pub epochs: String,
     pub transactions: String,
+    pub full_sync_height: String,
 }
 
 pub struct IndexedDBStorage {
@@ -176,6 +177,31 @@ impl IndexedDBStorage {
             .transpose()?)
     }
 
+    pub async fn add_asset(&self, metadata: &Metadata) -> WasmResult<()> {
+        let tx = self
+            .db
+            .transaction_on_one_with_mode(&self.constants.tables.assets, Readwrite)?;
+        let store = tx.object_store(&self.constants.tables.assets)?;
+        let metadata_js = serde_wasm_bindgen::to_value(&metadata.to_proto())?;
+
+        store.put_val_owned(&metadata_js)?;
+
+        Ok(())
+    }
+
+    pub async fn get_full_sync_height(&self) -> WasmResult<Option<u64>> {
+        let tx = self
+            .db
+            .transaction_on_one(&self.constants.tables.full_sync_height)?;
+        let store = tx.object_store(&self.constants.tables.full_sync_height)?;
+
+        Ok(store
+            .get_owned("height")?
+            .await?
+            .map(serde_wasm_bindgen::from_value)
+            .transpose()?)
+    }
+
     pub async fn get_note(
         &self,
         commitment: &note::StateCommitment,

packages/wasm/crate/tests/build.rs

@@ -86,6 +86,7 @@ mod tests {
             gas_prices: String,
             epochs: String,
             transactions: String,
+            full_sync_height: String,
         }
 
         // Define `IndexDB` table parameters and constants.
@@ -99,6 +100,7 @@ mod tests {
             gas_prices: "GAS_PRICES".to_string(),
             epochs: "EPOCHS".to_string(),
             transactions: "TRANSACTIONS".to_string(),
+            full_sync_height: "FULL_SYNC_HEIGHT".to_string(),
         };
 
         let constants: IndexedDbConstants = IndexedDbConstants {