Implement lacking ts equality check in payload. (#30)

Bartosz Lenart · bartossh · web-flow · commit 35a303985376 · 2025-01-30T11:03:58.000+01:00
### References [TASK RDS-2005](https://redstone-team.atlassian.net/browse/RDS-2005) Implements check against payload timestamps being equal. --------- Co-authored-by: bartossh <bartosz.lenart@redstone.com>
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # RustSDK - Audit guide
 
+This repository is an integral part of the https://github.com/redstone-finance/redstone-oracles-monorepo repository,
+especially of the solana-connector package (https://github.com/redstone-finance/redstone-oracles-monorepo/tree/main/packages/solana-connector) and is subject of all their licenses.
+
 <!-- TOC -->
 
 - [RustSDK - Audit guide](#rustsdk---audit-guide)
@@ -26,11 +29,11 @@ The direct path should look like:
 
 ### Documentation
 
-- Redstone crate documentation [./crates/redstone/README.md](./crates/redstone/README.md)
-  - RedstoneConfig is abstraction required as configuration for the RedStone protocol.
-    [redstone/trait.RedStoneConfig](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/trait.RedStoneConfig.html)
+- Redstone crate documentation [here](./crates/redstone/README.md)
+  - RedstoneConfig is abstraction required as configuration for the RedStone protocol
+    [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/trait.RedStoneConfig.html).
   - Process Payload function is the main processor of the RedStone payload
-    [redstone/core/processor/fn.process_payload](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor/fn.process_payload.html)
+    [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor/fn.process_payload.html).
 - General [RedStone Blockchain Oracles docs](https://docs.redstone.finance/docs/get-started/data-formatting-processing/)
   - Especially [The push model docs](https://docs.redstone.finance/docs/get-started/models/redstone-push/)
 
diff --git a/crates/redstone/README.md b/crates/redstone/README.md
@@ -14,63 +14,55 @@
 
 ## Rust SDK Overview
 
-The main documentation page [rust/redstone/rust_sdk_2/redstone/index.html](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/index.html)
+The main documentation page [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/index.html)
 lists the collection of utilities to make deserializing and decrypting RedStone payload as well as
 the Rust based blockchain utils, cryptographic methods, network and contract primitives.
 
 ## Network
 
 Network module contains primitives that allow to communicate via processor module with clear interface giving clear `Error` messages
-and `Environment` trait all in one place [rust/redstone/rust_sdk_2/redstone/network](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/network/index.html).
+and `Environment` trait all in one place [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/network/index.html).
 
 ## Configuration
 
-Configuration module contains configuration for the RedStone payload processor [rust/redstone/rust_sdk_2/redstone/core/config](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/config/index.html).
+Configuration module contains configuration for the RedStone payload processor [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/config/index.html).
 
 - Configuration for the RedStone Rust-SDK is given as a pluggable entity. Any type implementing RedStoneConfig trait
-  is a valid type to be used as config [redstone/trait.RedStoneConfig](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/trait.RedStoneConfig.html)
+  is a valid type to be used as config [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/trait.RedStoneConfig.html)
   Configuration requires to allow for perforimng two actions and to provide the Config type:
   - Crypto operations needed for address recovery. Different blockchains requires different cryptographic flavors.
   - Environment in which we execute. Provides logging etc. The same situation of flavors applies for the Environment.
   - Please check specific blockchain module for the implementation of Crypto and Environment modules:
-    - Default [rust/redstone/rust_sdk_2/redstone/default_ext](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/default_ext/index.html)
-    - Solana [rust/redstone/rust_sdk_2/redstone/solana](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/solana/index.html)
-    - Radix [/rust/redstone/rust_sdk_2/redstone/radix](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/radix/index.html)
-    - Casper [rust/redstone/rust_sdk_2/redstone/casper](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/casper/index.html)
+    - Default [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/default_ext/index.html)
+    - Solana [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/solana/index.html)
+    - Radix [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/radix/index.html)
+    - Casper [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/casper/index.html)
   - Config type - configuration for a RedStone payload processor.
-    Specifies the parameters necessary for the verification and aggregation of values from various data points passed by the RedStone payload.
-    [rust/redstone/rust_sdk_2/redstone/core/config/struct.Config](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/config/struct.Config.html)
+    Specifies the parameters necessary for the verification and aggregation of values from various data points passed by the RedStone payload
+    [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/config/struct.Config.html).
 
 ## Processor
 
-Processor module contains the main processor of the RedStone payload [rust/redstone/rust_sdk_2/redstone/core/processor](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor/index.html).
+Processor module contains the main processor of the RedStone payload [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor/index.html).
 
-- To proses payload use `process_payload` function in processor module
-  [rust/redstone/rust_sdk_2/redstone/core/processor/fn.process_payload.html](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor/fn.process_payload.html)
+- To process payload use `process_payload` function in processor module
+  [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor/fn.process_payload.html) and its the main entrypoint in the core::processor module.
+  It parses payload-bytes to DataPackages, consisting of DataPoints, see: https://docs.redstone.finance/img/payload.png
+  each DataPackage is signed by a signer, to be recovered having the DataPackage's data and the signature (both are included in the payload-bytes).
+  The recovering is important in the aggregation process: only the data signed by trusted signers (part of z Config) are counted to the aggregation (median value),
+  it also validates timestamps (if they're not too old/far/future and all shall be equal).
+  The aggregation (median values) is based on building a matrix: for each feed_id (in rows) from the Config the values for particular trusted signers in columns (taken by their indices).
   - The `config` argument is described above Configuration.
-  - The `payload` argument is type that is convertible to bytes (Vec<u8>), and the bytes encoding is described in
-    [redstone.finance docs data-formatting-processing](https://docs.redstone.finance/docs/get-started/data-formatting-processing/#how-data-is-encoded-before-being-put-on-the-blockchain)
-  - The result of `process_payload` [rust/redstone/rust_sdk_2/redstone/core/processor_result/type.ProcessorResult](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor_result/type.ProcessorResult.html)
+  - The `payload` argument is type that is convertible to bytes (Vec<u8>), and the bytes encoding is described in Redstone Finance Docs:
+    [data formatting](https://docs.redstone.finance/docs/get-started/data-formatting-processing/#how-data-is-encoded-before-being-put-on-the-blockchain).
+  - The result of `process_payload` [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor_result/type.ProcessorResult.html)
     returns success or an error:
-    - Success contains a validated payload [rust/redstone/rust_sdk_2/redstone/core/processor_result/struct.ValidatedPayload](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor_result/struct.ValidatedPayload.html)
+    - Success contains a validated payload [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/core/processor_result/struct.ValidatedPayload.html)
       containing a `min_timestamp` in [ ms ] which is the minimum timestamp encountered during processing and `values` (`Vec<Value>`)
-      where [rust/redstone/rust_sdk_2/redstone/struct.Value](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/struct.Value.html)
+      where Value [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/struct.Value.html)
       Each element in this vector represents a processed value corresponding to the passed data_feed item in the Config
 
 ## Contract
 
-Contract module contains contract primitives used for verification of the contract data and logic [rust/redstone/rust_sdk_2/redstone/contract/index.html](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/contract/index.html)
-For the specific verification primitive description look in to [rust/redstone/rust_sdk_2/redstone/contract/verification](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/contract/verification/index.html)
-
-## Cryptographic methods
-
-1. [`redstone` crate with
-   `crypto_secp256k1`](https://docs.redstone.finance/rust/redstone/crypto_secp256k1/redstone/index.html)
-   pure Rust implementation
-2. [`redstone` crate with `crypto_secp256k1` and
-   `network_casper`](https://docs.redstone.finance/rust/redstone/crypto_secp256k1,network_casper/redstone/index.html)
-   extension for Casper
-3. [`redstone` crate with `crypto_radix` and
-   `network_radix`](https://docs.redstone.finance/rust/redstone/crypto_radix,network_radix/redstone/index.html)
-   extension for Radix
-4. Solana [rust/redstone/rust_sdk_2/redstone/solana/enum.SolanaCrypto](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/solana/enum.SolanaCrypto.html)
+Contract module contains contract primitives used for verification of the contract data and logic [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/contract/index.html)
+For the specific verification primitive description look in to [here](https://docs.redstone.finance/rust/redstone/rust_sdk_2/redstone/contract/verification/index.html)
diff --git a/crates/redstone/src/core/processor.rs b/crates/redstone/src/core/processor.rs
@@ -52,16 +52,13 @@ impl<T: RedStoneConfig> RedStonePayloadProcessor for T {
 }
 
 fn make_processor_result<Env: Environment>(config: &Config, payload: Payload) -> ProcessorResult {
-    let min_timestamp = payload.get_min_validated_timestamp(config)?;
+    let timestamp = payload.get_validated_timestamp(config)?;
 
     let values = aggregate_values(payload.data_packages, config)?;
 
-    Env::print(|| format!("{:?} {:?}", min_timestamp, values));
+    Env::print(|| format!("{:?} {:?}", timestamp, values));
 
-    Ok(ValidatedPayload {
-        values,
-        min_timestamp,
-    })
+    Ok(ValidatedPayload { values, timestamp })
 }
 
 #[cfg(feature = "helpers")]
@@ -91,19 +88,19 @@ mod tests {
                 ETH,
                 11,
                 TEST_SIGNER_ADDRESS_1,
-                (TEST_BLOCK_TIMESTAMP + 5).into(),
+                (TEST_BLOCK_TIMESTAMP + 400).into(),
             ),
             DataPackage::test_single_data_point(
                 ETH,
                 13,
                 TEST_SIGNER_ADDRESS_2,
-                (TEST_BLOCK_TIMESTAMP + 3).into(),
+                (TEST_BLOCK_TIMESTAMP + 400).into(),
             ),
             DataPackage::test_single_data_point(
                 BTC,
                 32,
                 TEST_SIGNER_ADDRESS_2,
-                (TEST_BLOCK_TIMESTAMP - 2).into(),
+                (TEST_BLOCK_TIMESTAMP + 400).into(),
             ),
             DataPackage::test_single_data_point(
                 BTC,
@@ -121,7 +118,7 @@ mod tests {
         assert_eq!(
             result,
             Ok(ValidatedPayload {
-                min_timestamp: (TEST_BLOCK_TIMESTAMP - 2).into(),
+                timestamp: (TEST_BLOCK_TIMESTAMP + 400).into(),
                 values: vec![12u8, 31].iter_into()
             })
         );
@@ -133,12 +130,12 @@ mod tests {
             DataPackage::test_multi_data_point(
                 vec![(ETH, 10), (BTC, 31)],
                 TEST_SIGNER_ADDRESS_2,
-                (TEST_BLOCK_TIMESTAMP + 3).into(),
+                (TEST_BLOCK_TIMESTAMP + 5).into(),
             ),
             DataPackage::test_multi_data_point(
                 vec![(ETH, 13), (BTC, 32)],
                 TEST_SIGNER_ADDRESS_1,
-                (TEST_BLOCK_TIMESTAMP + 400).into(),
+                (TEST_BLOCK_TIMESTAMP + 5).into(),
             ),
         ];
 
@@ -150,7 +147,7 @@ mod tests {
         assert_eq!(
             result,
             Ok(ValidatedPayload {
-                min_timestamp: (TEST_BLOCK_TIMESTAMP + 3).into(),
+                timestamp: (TEST_BLOCK_TIMESTAMP + 5).into(),
                 values: vec![11u8, 31].iter_into()
             })
         );
@@ -162,22 +159,22 @@ mod tests {
             DataPackage::test_multi_data_point(
                 vec![(BTC, 30), (ETH, 11)],
                 TEST_SIGNER_ADDRESS_1,
-                (TEST_BLOCK_TIMESTAMP + 5).into(),
+                (TEST_BLOCK_TIMESTAMP).into(),
             ),
             DataPackage::test_multi_data_point(
                 vec![(ETH, 10), (BTC, 31)],
                 TEST_SIGNER_ADDRESS_2,
-                (TEST_BLOCK_TIMESTAMP + 3).into(),
+                (TEST_BLOCK_TIMESTAMP).into(),
             ),
             DataPackage::test_multi_data_point(
                 vec![(BTC, 34), (ETH, 12)],
                 TEST_SIGNER_ADDRESS_2, // REPETITION OF A SIGNER
-                (TEST_BLOCK_TIMESTAMP - 2).into(),
+                (TEST_BLOCK_TIMESTAMP).into(),
             ),
             DataPackage::test_multi_data_point(
                 vec![(ETH, 13), (BTC, 32)],
                 TEST_SIGNER_ADDRESS_1,
-                (TEST_BLOCK_TIMESTAMP + 400).into(),
+                (TEST_BLOCK_TIMESTAMP).into(),
             ),
         ];
 
@@ -199,12 +196,12 @@ mod tests {
             DataPackage::test_multi_data_point(
                 vec![(ETH, 10), (BTC, 31), (BTC, 33)], // REPETITION IN DATAPOINTS HERE.
                 TEST_SIGNER_ADDRESS_2,
-                (TEST_BLOCK_TIMESTAMP + 3).into(),
+                (TEST_BLOCK_TIMESTAMP).into(),
             ),
             DataPackage::test_multi_data_point(
                 vec![(ETH, 13), (BTC, 32)],
                 TEST_SIGNER_ADDRESS_1,
-                (TEST_BLOCK_TIMESTAMP + 400).into(),
+                (TEST_BLOCK_TIMESTAMP).into(),
             ),
         ];
 
diff --git a/crates/redstone/src/core/processor_result.rs b/crates/redstone/src/core/processor_result.rs
@@ -10,11 +10,11 @@ pub type ProcessorResult = Result<ValidatedPayload, Error>;
 /// particularly focusing on time-sensitive data and its associated values, according to the `Config`.
 #[derive(Debug, Eq, PartialEq)]
 pub struct ValidatedPayload {
-    /// The minimum timestamp encountered during processing.
+    /// The timestamp encountered during processing.
     ///
-    /// This field captures the earliest time point (in milliseconds since the Unix epoch)
+    /// This field captures the time point (in milliseconds since the Unix epoch)
     /// among the processed data packages, indicating the starting boundary of the dataset's time range.
-    pub min_timestamp: TimestampMillis,
+    pub timestamp: TimestampMillis,
 
     /// A collection of values processed during the operation.
     ///
@@ -25,6 +25,6 @@ pub struct ValidatedPayload {
 
 impl From<ValidatedPayload> for (TimestampMillis, Vec<Value>) {
     fn from(validated_payload: ValidatedPayload) -> Self {
-        (validated_payload.min_timestamp, validated_payload.values)
+        (validated_payload.timestamp, validated_payload.values)
     }
 }
diff --git a/crates/redstone/src/network/error.rs b/crates/redstone/src/network/error.rs
@@ -108,6 +108,11 @@ pub enum Error {
     /// Includes FeedId that is reocuring.
     ConfigReocuringFeedId(FeedId),
 
+    /// Indicates that payload timestamps are not equal.
+    ///
+    /// Contains the first timestamp and the one that is not equal to the first one.
+    TimestampDifferentThanOthers(TimestampMillis, TimestampMillis),
+
     /// Indicates that the provided data timestamp is not greater than a previously written package timestamp.
     ///
     /// For the price adapter to accept a new price update, the associated timestamp must be
@@ -148,6 +153,7 @@ impl Error {
             Error::ConfigReocuringSigner(_) => 516,
             Error::ConfigEmptyFeedIds => 517,
             Error::ConfigReocuringFeedId(_) => 518,
+            Error::TimestampDifferentThanOthers(_, _) => 519,
             Error::InsufficientSignerCount(data_package_index, value, _) => {
                 (2000 + data_package_index * 10 + value) as u16
             }
@@ -220,6 +226,11 @@ impl Display for Error {
                     feed_id.as_hex_str()
                 )
             }
+            Error::TimestampDifferentThanOthers(first, outstandig) => write!(
+                f,
+                "Timestamp {:?} is not equal to the first on {:?} in the payload.",
+                outstandig, first
+            ),
             Error::DataTimestampMustBeGreaterThanBefore(current, before) => {
                 write!(
                     f,
diff --git a/crates/redstone/src/protocol/payload.rs b/crates/redstone/src/protocol/payload.rs
