updated docs

Author: rdeioris

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 ### Added
 
 - Added a new RPC endpoint `/v3/health` to query the node's health status. The endpoint returns a 200 status code with relevant synchronization information (including the node's current Stacks tip height, the maximum Stacks tip height among its neighbors, and the difference between these two). A user can use the `difference_from_max_peer` value to decide what is a good threshold for them before considering the node out of sync. The endpoint returns a 500 status code if the query cannot retrieve viable data.
+- Added a new query string option for rpc readonly call (cost_tracker=) for allowing faster "free" cost tracking mode. When the "free" mode is enabled, max_execution_time is automatically activated (can be configured with the read_only_max_execution_time_secs connection option, default is 30 seconds)
 
 ### Changed
 

docs/rpc/openapi.yaml

@@ -229,6 +229,12 @@ paths:
           description: The Stacks chain tip to query from. If tip == latest, the query will be run from the latest
             known tip (includes unconfirmed state).
           required: false
+        - name: cost_tracker
+          in: query
+          schema:
+            type: string
+          description: the cost tracker to apply ("limited" or "free").
+          required: false
       requestBody:
         description: map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.
         required: true

stackslib/src/config/mod.rs

@@ -3709,6 +3709,13 @@ pub struct ConnectionOptionsFile {
     /// @default: [`DEFAULT_BLOCK_PROPOSAL_MAX_AGE_SECS`]
     /// @units: seconds
     pub block_proposal_max_age_secs: Option<u64>,
+
+    /// Maximum time (in seconds) that a readonly call in free cost tracking mode
+    /// can run before being interrupted
+    /// ---
+    /// @default: 30
+    /// @units: seconds
+    pub read_only_max_execution_time_secs: Option<u64>,
 }
 
 impl ConnectionOptionsFile {
@@ -3860,6 +3867,9 @@ impl ConnectionOptionsFile {
             block_proposal_max_age_secs: self
                 .block_proposal_max_age_secs
                 .unwrap_or(DEFAULT_BLOCK_PROPOSAL_MAX_AGE_SECS),
+            read_only_max_execution_time_secs: self
+                .read_only_max_execution_time_secs
+                .unwrap_or(default.read_only_max_execution_time_secs),
             ..default
         })
     }