Add staking token and numeraires (#17)

* Add staking token and numeraires

* changeset

* changelog

input/penumbra-testnet-deimos-6.json

@@ -211,5 +211,6 @@
         }
       ]
     }
-  ]
+  ],
+  "canonicalNumeraires": ["wtest_usd", "transfer/channel-3/uusdc"]
 }

npm/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @penumbra-labs/registry
 
+## 4.0.0
+
+### Major Changes
+
+- Added stakingAssetId and numeraires
+
 ## 3.0.0
 
 ### Major Changes

npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penumbra-labs/registry",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Chain and asset registry for Penumbra",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

npm/src/client.ts

@@ -12,7 +12,9 @@ export interface Registry {
   chainId: string;
   ibcConnections: Chain[];
   rpcs: Rpc[];
-  assetById: Record<Jsonified<AssetId>, Metadata>;
+  assetById: Record<Jsonified<AssetId>, Jsonified<Metadata>>;
+  stakingAssetId: Jsonified<AssetId>;
+  numeraires: Jsonified<AssetId>[];
 }
 
 export interface Chain {

registry/penumbra-testnet-deimos-6.json

@@ -369,5 +369,10 @@
         }
       ]
     }
-  }
+  },
+  "stakingAssetId": "KeqcLzNx9qSH5+lcJHBB9KNW+YPrBk5dKzvPMiypahA=",
+  "numeraires": [
+    "reum7wQmk/owgvGMWMZn/6RFPV24zIKq3W6In/WwZgg=",
+    "CKBQapu+DkQpsKyTfKESLTV19/NPWR5sNZtvQsd3Hw8="
+  ]
 }

tools/compiler/src/parser.rs

@@ -13,6 +13,7 @@ pub struct ChainConfig {
     pub rpcs: Vec<Rpc>,
     pub ibc_connections: Vec<IbcInput>,
     pub native_assets: Vec<Metadata>,
+    pub canonical_numeraires: Vec<String>,
 }
 
 #[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]

tools/compiler/src/processor.rs

@@ -3,7 +3,8 @@ use std::collections::BTreeMap;
 use std::fs;
 use std::path::Path;
 
-use penumbra_asset::asset::Metadata;
+use penumbra_asset::asset::{Id, Metadata};
+use penumbra_asset::STAKING_TOKEN_ASSET_ID;
 use penumbra_proto::penumbra::core::asset::v1 as pb;
 use serde::{Deserialize, Serialize};
 use tokio::task;
@@ -44,6 +45,8 @@ pub struct Registry {
     pub ibc_connections: Vec<Chain>,
     pub rpcs: Vec<Rpc>,
     pub asset_by_id: BTreeMap<String, Metadata>, // Using a BTreeMap to have sorted (deterministic) output
+    pub staking_asset_id: String,
+    pub numeraires: Vec<String>,
 }
 
 pub async fn generate_registry() -> AppResult<()> {
@@ -100,8 +103,8 @@ pub fn transport_metadata_along_channel(
     Ok(Metadata::try_from(pb_metadata)?)
 }
 
-pub fn base64_id(m: &Metadata) -> AppResult<String> {
-    let id_json = serde_json::to_value(m.id())?;
+pub fn base64_id(id: &Id) -> AppResult<String> {
+    let id_json = serde_json::to_value(id)?;
     let base64_str = id_json
         .get("inner")
         .and_then(|s| s.as_str()) // This extracts the string without the double quotes
@@ -141,11 +144,22 @@ async fn process_chain_config(chain_config: ChainConfig) -> AppResult<Registry>
             .map(Into::into)
             .collect(),
         asset_by_id: all_metadata
+            .clone()
             .into_iter()
             .map(|m| {
-                let id = base64_id(&m)?;
+                let id = base64_id(&m.id())?;
                 Ok((id, m))
             })
             .collect::<AppResult<_>>()?,
+        staking_asset_id: base64_id(&STAKING_TOKEN_ASSET_ID)?,
+        numeraires: all_metadata
+            .into_iter()
+            .filter(|metadata| {
+                chain_config
+                    .canonical_numeraires
+                    .contains(&metadata.base_denom().denom)
+            })
+            .filter_map(|m| base64_id(&m.id()).ok())
+            .collect(),
     })
 }

tools/compiler/tests/test_parser.rs

@@ -19,7 +19,8 @@ fn test_get_chain_configs_reads_configs_correctly() {
         "chainId": "test-chain-1",
         "rpcs": [],
         "ibcConnections": [],
-        "nativeAssets": []
+        "nativeAssets": [],
+        "canonicalNumeraires": []
     })
     .to_string();
     create_test_config_file(temp_input_dir.path(), "test-chain-1.json", &config_content);
@@ -42,7 +43,9 @@ fn test_get_chain_configs_reads_multiple_configs_correctly() {
         "chainId": "test-chain-1",
         "rpcs": [],
         "ibcConnections": [],
-        "nativeAssets": []
+        "nativeAssets": [],
+        "canonicalNumeraires": []
+
     })
     .to_string();
     create_test_config_file(
@@ -55,7 +58,9 @@ fn test_get_chain_configs_reads_multiple_configs_correctly() {
         "chainId": "test-chain-2",
         "rpcs": [],
         "ibcConnections": [],
-        "nativeAssets": []
+        "nativeAssets": [],
+        "canonicalNumeraires": []
+
     })
     .to_string();
     create_test_config_file(

tools/compiler/tests/test_processor.rs

@@ -1,3 +1,4 @@
+use penumbra_asset::asset::Metadata;
 use penumbra_registry::parser::IbcInput;
 use penumbra_registry::processor::{base64_id, transport_metadata_along_channel};
 
@@ -10,10 +11,10 @@ fn base64_id_extracts_correctly() {
                 "inner": "KeqcLzNx9qSH5+lcJHBB9KNW+YPrBk5dKzvPMiypahA="
             }
         }"#;
-    let metadata = serde_json::from_str(asset_json).unwrap();
+    let metadata: Metadata = serde_json::from_str(asset_json).unwrap();
 
     assert_eq!(
-        base64_id(&metadata).unwrap(),
+        base64_id(&metadata.id()).unwrap(),
         "KeqcLzNx9qSH5+lcJHBB9KNW+YPrBk5dKzvPMiypahA="
     );
 }