Merge branch 'main' into golddydev/stake-addresses-in-spo-state

Author: golddydev

Cargo.lock

@@ -20,6 +20,7 @@ members = [
     "modules/stake_delta_filter",       # Filters address deltas
     "modules/epoch_activity_counter",   # Counts fees and block producers for rewards
     "modules/accounts_state",           # Tracks stake and reward accounts
+    "modules/assets_state",             # Tracks native asset mints and burns
 
     # Process builds
     "processes/omnibus",      # All-inclusive omnibus process

Cargo.toml

@@ -33,6 +33,7 @@ tracing = "0.1.40"
 futures = "0.3.31"
 minicbor = { version = "0.26.0", features = ["std", "half", "derive"] }
 num-traits = "0.2"
+imbl = { version = "5.0.0", features = ["serde"] }
 
 [lib]
 crate-type = ["rlib"]

common/Cargo.toml

@@ -1,74 +1,86 @@
 //! Common calculations for Cardano
 
 const BYRON_SLOTS_PER_EPOCH: u64 = 21_600;
-pub const SHELLEY_SLOTS_PER_EPOCH: u64 = 432_000;
-const SHELLEY_START_SLOT: u64 = 4_492_800;
-const SHELLEY_START_EPOCH: u64 = 208;
 
 /// Derive an epoch number from a slot, handling Byron/Shelley era changes
-pub fn slot_to_epoch(slot: u64) -> u64 {
-    slot_to_epoch_with_shelley_params(slot, SHELLEY_START_EPOCH, SHELLEY_SLOTS_PER_EPOCH)
-}
-
 pub fn slot_to_epoch_with_shelley_params(
     slot: u64,
     shelley_epoch: u64,
     shelley_epoch_len: u64,
-) -> u64 {
+) -> (u64, u64) {
     let shelley_start_slot = shelley_epoch * BYRON_SLOTS_PER_EPOCH;
     if slot < shelley_start_slot {
-        slot / BYRON_SLOTS_PER_EPOCH
+        (slot / BYRON_SLOTS_PER_EPOCH, slot % BYRON_SLOTS_PER_EPOCH)
     } else {
-        shelley_epoch + (slot - shelley_start_slot) / shelley_epoch_len
+        let slots_since_shelley_start = slot - shelley_start_slot;
+        (
+            shelley_epoch + slots_since_shelley_start / shelley_epoch_len,
+            slots_since_shelley_start % shelley_epoch_len,
+        )
+    }
+}
+
+pub fn slot_to_timestamp_with_params(slot: u64, byron_timestamp: u64, shelley_epoch: u64) -> u64 {
+    let shelley_start_slot = shelley_epoch * BYRON_SLOTS_PER_EPOCH;
+    if slot < shelley_start_slot {
+        byron_timestamp + slot * 20
+    } else {
+        let shelley_timestamp = byron_timestamp + shelley_start_slot * 20;
+        shelley_timestamp + (slot - shelley_start_slot)
     }
 }
 
 // -- Tests --
 #[cfg(test)]
 mod tests {
     use super::*;
+    const SHELLEY_START_EPOCH: u64 = 208;
+    const SHELLEY_SLOTS_PER_EPOCH: u64 = 432_000;
+    const BYRON_START_TIMESTAMP: u64 = 1506203091;
+
+    fn slot_to_epoch(slot: u64) -> (u64, u64) {
+        slot_to_epoch_with_shelley_params(slot, SHELLEY_START_EPOCH, SHELLEY_SLOTS_PER_EPOCH)
+    }
+
+    fn slot_to_timestamp(slot: u64) -> u64 {
+        slot_to_timestamp_with_params(slot, BYRON_START_TIMESTAMP, SHELLEY_START_EPOCH)
+    }
 
     #[test]
     fn byron_epoch_0() {
-        assert_eq!(0, slot_to_epoch(0));
+        assert_eq!(slot_to_epoch(0), (0, 0));
+        assert_eq!(slot_to_timestamp(0), 1506203091);
     }
 
     #[test]
     fn byron_epoch_1() {
-        assert_eq!(1, slot_to_epoch(21_600));
+        assert_eq!(slot_to_epoch(21_600), (1, 0));
+        assert_eq!(slot_to_timestamp(21_600), 1506635091);
     }
 
     #[test]
     fn byron_last_slot() {
-        assert_eq!(slot_to_epoch(4_492_799), 207);
+        assert_eq!(slot_to_epoch(4_492_799), (207, 21_599));
+        assert_eq!(slot_to_timestamp(4_492_799), 1596059071);
     }
 
     #[test]
     fn shelley_first_slot() {
-        assert_eq!(slot_to_epoch(4_492_800), 208);
+        assert_eq!(slot_to_epoch(4_492_800), (208, 0));
+        assert_eq!(slot_to_timestamp(4_492_800), 1596059091);
     }
 
     #[test]
     fn shelley_epoch_209_start() {
         // 432_000 slots later
-        assert_eq!(slot_to_epoch(4_492_800 + 432_000), 209);
-    }
-
-    #[test]
-    fn before_transition_boundary() {
-        // One slot before Shelley starts
-        assert_eq!(slot_to_epoch(4_492_799), 207);
-    }
-
-    #[test]
-    fn after_transition_boundary() {
-        // First Shelley slot
-        assert_eq!(slot_to_epoch(4_492_800), 208);
+        assert_eq!(slot_to_epoch(4_492_800 + 432_000), (209, 0));
+        assert_eq!(slot_to_timestamp(4_492_800 + 432_000), 1596491091);
     }
 
     #[test]
     fn mainnet_example_from_cexplorer() {
         // Slot 98_272_003 maps to epoch 425
-        assert_eq!(slot_to_epoch(98_272_003), 425);
+        assert_eq!(slot_to_epoch(98_272_003), (425, 35_203));
+        assert_eq!(slot_to_timestamp(98_272_003), 1689838294);
     }
 }

common/src/calculations.rs

@@ -0,0 +1,25 @@
+use crate::calculations::{slot_to_epoch_with_shelley_params, slot_to_timestamp_with_params};
+
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub struct GenesisValues {
+    pub byron_timestamp: u64,
+    pub shelley_epoch: u64,
+    pub shelley_epoch_len: u64,
+}
+
+impl GenesisValues {
+    pub fn mainnet() -> Self {
+        Self {
+            byron_timestamp: 1506203091,
+            shelley_epoch: 208,
+            shelley_epoch_len: 432000,
+        }
+    }
+
+    pub fn slot_to_epoch(&self, slot: u64) -> (u64, u64) {
+        slot_to_epoch_with_shelley_params(slot, self.shelley_epoch, self.shelley_epoch_len)
+    }
+    pub fn slot_to_timestamp(&self, slot: u64) -> u64 {
+        slot_to_timestamp_with_params(slot, self.byron_timestamp, self.shelley_epoch)
+    }
+}

common/src/genesis_values.rs

@@ -4,6 +4,7 @@ pub mod address;
 pub mod calculations;
 pub mod cip19;
 pub mod crypto;
+pub mod genesis_values;
 pub mod ledger_state;
 pub mod messages;
 pub mod params;

common/src/lib.rs

@@ -3,6 +3,7 @@
 // We don't use these messages in the acropolis_common crate itself
 #![allow(dead_code)]
 
+use crate::genesis_values::GenesisValues;
 use crate::ledger_state::SPOState;
 use crate::protocol_params::ProtocolParams;
 use crate::queries::parameters::{ParametersStateQuery, ParametersStateQueryResponse};
@@ -58,7 +59,9 @@ pub struct RawTxsMessage {
 
 /// Genesis completion message
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
-pub struct GenesisCompleteMessage {}
+pub struct GenesisCompleteMessage {
+    pub values: GenesisValues,
+}
 
 /// Message encapsulating multiple UTXO deltas, in order
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
@@ -67,6 +70,13 @@ pub struct UTXODeltasMessage {
     pub deltas: Vec<UTXODelta>,
 }
 
+/// Message encapsulating multiple asset deltas
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub struct AssetDeltasMessage {
+    /// Ordered set of deltas
+    pub deltas: NativeAssetsDelta,
+}
+
 /// Message encapsulating multiple transaction certificates, in order
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct TxCertificatesMessage {
@@ -225,6 +235,7 @@ pub enum CardanoMessage {
     ReceivedTxs(RawTxsMessage),              // Transaction available
     GenesisComplete(GenesisCompleteMessage), // Genesis UTXOs done + genesis params
     UTXODeltas(UTXODeltasMessage),           // UTXO deltas received
+    AssetDeltas(AssetDeltasMessage),         // Asset mint and burn deltas
     TxCertificates(TxCertificatesMessage),   // Transaction certificates received
     AddressDeltas(AddressDeltasMessage),     // Address deltas received
     Withdrawals(WithdrawalsMessage),         // Withdrawals from reward accounts

common/src/messages.rs

@@ -66,7 +66,7 @@ pub struct ShelleyProtocolParams {
     pub minfee_b: u32,
     pub pool_deposit: u64,
 
-    /// AKA desired_number_of_stake_pools, n_opt, technical parameter k
+    /// AKA desired_number_of_stake_pools, optimal_pool_count, n_opt, technical parameter k
     /// Important: *not to be mixed* with security parameter k, which is not here
     #[serde(rename = "nOpt")]
     pub stake_pool_target_num: u32,

common/src/protocol_params.rs

@@ -1,3 +1,8 @@
+use crate::{AssetName, PolicyId};
+
+pub const DEFAULT_ASSETS_QUERY_TOPIC: (&str, &str) =
+    ("assets-state-query-topic", "cardano.query.assets");
+
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub enum AssetsStateQuery {
     GetAssetsList,
@@ -10,7 +15,7 @@ pub enum AssetsStateQuery {
 
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub enum AssetsStateQueryResponse {
-    AssetsList(AssetsList),
+    AssetsList(imbl::HashMap<PolicyId, imbl::HashMap<AssetName, u64>>),
     AssetInfo(AssetInfo),
     AssetHistory(AssetHistory),
     AssetTransactions(AssetTransactions),

common/src/queries/assets.rs

@@ -101,9 +101,15 @@ pub struct BlockInfo {
     /// Epoch number
     pub epoch: u64,
 
+    /// Epoch slot number
+    pub epoch_slot: u64,
+
     /// Does this block start a new epoch?
     pub new_epoch: bool,
 
+    /// UNIX timestamp
+    pub timestamp: u64,
+
     /// Protocol era
     pub era: Era,
 }
@@ -147,6 +153,23 @@ pub struct StakeRewardDelta {
     pub delta: i64,
 }
 
+pub type PolicyId = [u8; 28];
+pub type NativeAssets = Vec<(PolicyId, Vec<NativeAsset>)>;
+pub type NativeAssetsDelta = Vec<(PolicyId, Vec<NativeAssetDelta>)>;
+pub type AssetName = Vec<u8>;
+
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub struct NativeAsset {
+    pub name: AssetName,
+    pub amount: u64,
+}
+
+#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+pub struct NativeAssetDelta {
+    pub name: AssetName,
+    pub amount: i64,
+}
+
 /// Value (lovelace + multiasset)
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct Value {
@@ -167,11 +190,11 @@ impl Value {
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct ValueDelta {
     pub lovelace: i64,
-    pub assets: Vec<(PolicyId, Vec<NativeAssetDelta>)>,
+    pub assets: NativeAssetsDelta,
 }
 
 impl ValueDelta {
-    pub fn new(lovelace: i64, assets: Vec<(PolicyId, Vec<NativeAssetDelta>)>) -> Self {
+    pub fn new(lovelace: i64, assets: NativeAssetsDelta) -> Self {
         Self { lovelace, assets }
     }
 }
@@ -212,23 +235,6 @@ impl Neg for ValueDelta {
     }
 }
 
-pub type PolicyId = [u8; 28];
-pub type NativeAssets = Vec<(PolicyId, Vec<NativeAsset>)>;
-pub type NativeAssetsDelta = Vec<(PolicyId, Vec<NativeAssetDelta>)>;
-pub type AssetName = Vec<u8>;
-
-#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
-pub struct NativeAsset {
-    pub name: AssetName,
-    pub amount: u64,
-}
-
-#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
-pub struct NativeAssetDelta {
-    pub name: AssetName,
-    pub amount: i64,
-}
-
 /// Transaction output (UTXO)
 #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
 pub struct TxOutput {