Merge pull request #65 from eqlabs/krisztian/improve-tip-calculation

feat: improve tip calculation

Author: kkovaacs

README.md

@@ -93,6 +93,11 @@ The API should expose a single `/sign` endpoint:
 
 An example implementation of the API is available [here](./examples/signer.rs).
 
+
+### Tip
+
+The transaction tip value used during submission is calculated based on the median tip value in the `latest` block. The exact value used during submission is `MAX(latest_median_tip * ${tip_boost}, ${minimum_tip})`, where `tip_boost` and `minimum_tip` can be configured using the `--tip-boost` and `--minimum-tip` CLI arguments.
+
 ## Monitoring
 
 A metrics endpoint is provided for scraping with Prometheus. By default the endpoint is available at `http://127.0.0.1:9090/metrics`. You can use the `--metrics-address` CLI option to change this address.

src/jsonrpc.rs

@@ -16,6 +16,7 @@ use starknet::{
 use crate::{
     attestation_info::AttestationInfo,
     signer::{AttestationSigner, SignError},
+    tip::TipCalculationParams,
 };
 
 #[derive(Debug, thiserror::Error)]
@@ -64,6 +65,7 @@ pub trait Client {
         &self,
         operational_address: Felt,
         signer: &AttestationSigner,
+        tip_calculation_params: &TipCalculationParams,
         block_hash: Felt,
     ) -> Result<Felt, ClientError>;
     async fn attestation_done_in_current_epoch(
@@ -94,10 +96,19 @@ impl Client for StarknetRpcClient {
         &self,
         operational_address: Felt,
         signer: &AttestationSigner,
+        tip_calculation_params: &TipCalculationParams,
         block_hash: Felt,
     ) -> Result<Felt, ClientError> {
         let chain_id = self.client.chain_id().await.context("Getting chain ID")?;
 
+        // Calculate tip as the median value from the latest block and apply params.
+        let latest_block = self
+            .client
+            .get_block_with_txs(BlockId::Tag(BlockTag::Latest))
+            .await?;
+        let current_median_tip = latest_block.median_tip();
+        let tip = tip_calculation_params.calculate_tip(current_median_tip);
+
         let account = ClearSigningAccount::new(&self.client, signer, operational_address, chain_id);
 
         let result = account
@@ -108,6 +119,7 @@ impl Client for StarknetRpcClient {
             }])
             .gas_price_estimate_multiplier(3.0)
             .gas_estimate_multiplier(3.0)
+            .tip(tip)
             .send()
             .await
             .context("Sending transaction")?;

src/main.rs

@@ -18,6 +18,7 @@ mod jsonrpc;
 mod metrics_exporter;
 mod signer;
 mod state;
+mod tip;
 
 #[derive(Parser)]
 #[command(version, about, long_about = None)]
@@ -90,6 +91,22 @@ struct Config {
 
     #[arg(long, default_value = "compact", value_name = "FORMAT")]
     pub log_format: LogFormat,
+
+    #[arg(
+        long,
+        long_help = "The median tip value from recent transactions is multiplied by this scaling factor when calculating the transaction tip.",
+        default_value = "1.0",
+        env = "VALIDATOR_ATTESTATION_TIP_BOOST"
+    )]
+    pub tip_boost: f64,
+
+    #[arg(
+        long,
+        long_help = "Minimum value of the transaction tip to use when submitting the attestation transaction.",
+        default_value = "0",
+        env = "VALIDATOR_ATTESTATION_MINIMUM_TIP"
+    )]
+    pub minimum_tip: u64,
 }
 
 #[derive(Clone, clap::ValueEnum)]
@@ -154,6 +171,11 @@ async fn main() -> anyhow::Result<()> {
         return Err(anyhow::anyhow!("Inappropriate JSON-RPC API version"));
     }
 
+    let tip_calculation_params = tip::TipCalculationParams {
+        tip_boost: config.tip_boost,
+        minimum_tip: config.minimum_tip,
+    };
+
     // Set up JSON-RPC client
     let chain_id = client.chain_id().await.context("Getting chain ID")?;
     let (staking_contract_address, attestation_contract_address) =
@@ -305,7 +327,7 @@ async fn main() -> anyhow::Result<()> {
                         metrics::gauge!("validator_attestation_starknet_latest_block_number").set(header.block_number as f64);
 
                         let old_state = state.clone();
-                        let result = state.handle_new_block_header(&client, config.staker_operational_address, &signer, header.block_number, header.block_hash).await;
+                        let result = state.handle_new_block_header(&client, config.staker_operational_address, &signer, &tip_calculation_params, header.block_number, header.block_hash).await;
                         match result {
                             Ok(new_state) => {
                                 tracing::debug!(?new_state, "State transition complete");