Merge branch 'develop' into chore/update-openapi-spec

Author: Jiloc

.github/workflows/nix-check.yml

@@ -0,0 +1,41 @@
+name: Check Nix
+
+on:
+  merge_group:
+    types:
+      - checks_requested
+  push:
+    branches:
+      - master
+      - develop
+      - next
+    paths-ignore:
+      - "**.md"
+      - "**.yml"
+  workflow_dispatch:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+concurrency:
+  group: nix-${{ github.head_ref || github.ref || github.run_id }}
+  ## Always cancel duplicate jobs
+  cancel-in-progress: true
+
+run-name: ${{ github.ref_name }}
+
+permissions: {}
+
+jobs:
+  build-pkg:
+    name: Check Nix package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: DeterminateSystems/determinate-nix-action@d4b23d0b9eeeaeba3648c24d43bcb623dcf75336 # v3.7.0
+      - uses: DeterminateSystems/magic-nix-cache-action@e1c1dae8e170ed20fd2e6aaf9979ca2d3905d636  # v12
+        with:
+          use-flakehub: false  # Remove error when trying to authenticate without credentials
+      - run: nix flake check ./contrib/nix

CHANGELOG.md

@@ -7,10 +7,13 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 
 ## Unreleased
 
-- The HTTP `Date` header in responses now strictly follows RFC7231.
+### Added
+
+- Added `/v3/contracts/fast-call-read/:principal/:contract_name/:func_name` api endpoint. It allows to run read-only calls faster by disabling the cost and memory trackers. This endpoint requires authentication.
 
 ### Changed
 
+- The HTTP `Date` header in responses now strictly follows RFC7231.
 - When a previous block commit is unable to be RBFed, the miner will now just wait for it to be confirmed instead of submitting a new block commit which breaks the miner's UTXO chain.
 
 ### Fixed

Cargo.lock

@@ -18,8 +18,6 @@ name = "clarity"
 path = "./src/libclarity.rs"
 
 [dependencies]
-rand = { workspace = true }
-rand_chacha = { workspace = true }
 serde = "1"
 serde_derive = "1"
 serde_stacker = "0.1"
@@ -28,8 +26,8 @@ lazy_static = "1.4.0"
 integer-sqrt = "0.1.3"
 slog = { version = "2.5.2", features = [ "max_level_trace" ] }
 stacks_common = { package = "stacks-common", path = "../stacks-common", default-features = false }
-rstest = "0.17.0"
-rstest_reuse = "0.5.0"
+rstest = { version = "0.17.0", optional = true }
+rstest_reuse = { version = "0.5.0", optional = true }
 hashbrown = { workspace = true }
 rusqlite = { workspace = true, optional = true }
 
@@ -40,6 +38,8 @@ features = ["arbitrary_precision", "unbounded_depth"]
 [dev-dependencies]
 assert-json-diff = "1.0.0"
 mutants = "0.0.3"
+rstest = { version = "0.17.0" }
+rstest_reuse = { version = "0.5.0" }
 # a nightly rustc regression (35dbef235 2021-03-02) prevents criterion from compiling
 #  but it isn't necessary for tests: only benchmarks. therefore, commenting out for now.
 # criterion = "0.3"
@@ -49,7 +49,8 @@ default = ["rusqlite"]
 developer-mode = ["stacks_common/developer-mode"]
 slog_json = ["stacks_common/slog_json"]
 rusqlite = ["stacks_common/rusqlite", "dep:rusqlite"]
-testing = []
+testing = ["rstest", "rstest_reuse"]
 devtools = []
 rollback_value_check = []
 disable-costs = []
+wasm-web = ["stacks_common/wasm-web"]

clarity/Cargo.toml

@@ -335,7 +335,7 @@ pub fn no_type() -> TypeSignature {
 }
 
 impl<'a, 'b> TypeChecker<'a, 'b> {
-    fn new(
+    pub fn new(
         db: &'a mut AnalysisDatabase<'b>,
         cost_track: LimitedCostTracker,
         build_type_map: bool,

clarity/src/vm/analysis/type_checker/v2_05/mod.rs

@@ -417,6 +417,25 @@ pub enum CostErrors {
     ExecutionTimeExpired,
 }
 
+impl fmt::Display for CostErrors {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            CostErrors::CostComputationFailed(ref s) => write!(f, "Cost computation failed: {s}"),
+            CostErrors::CostOverflow => write!(f, "Cost overflow"),
+            CostErrors::CostBalanceExceeded(ref total, ref limit) => {
+                write!(f, "Cost balance exceeded: total {total}, limit {limit}")
+            }
+            CostErrors::MemoryBalanceExceeded(ref used, ref limit) => {
+                write!(f, "Memory balance exceeded: used {used}, limit {limit}")
+            }
+            CostErrors::CostContractLoadFailure => write!(f, "Failed to load cost contract"),
+            CostErrors::InterpreterFailure => write!(f, "Interpreter failure"),
+            CostErrors::Expect(ref s) => write!(f, "Expectation failed: {s}"),
+            CostErrors::ExecutionTimeExpired => write!(f, "Execution time expired"),
+        }
+    }
+}
+
 impl CostErrors {
     fn rejectable(&self) -> bool {
         matches!(self, CostErrors::InterpreterFailure | CostErrors::Expect(_))

clarity/src/vm/costs/mod.rs

@@ -2627,7 +2627,7 @@ pub fn make_api_reference(function: &NativeFunctions) -> FunctionAPI {
     }
 }
 
-fn make_keyword_reference(variable: &NativeVariables) -> Option<KeywordAPI> {
+pub fn make_keyword_reference(variable: &NativeVariables) -> Option<KeywordAPI> {
     let keyword = match variable {
         NativeVariables::TxSender => TX_SENDER_KEYWORD.clone(),
         NativeVariables::ContractCaller => CONTRACT_CALLER_KEYWORD.clone(),

clarity/src/vm/docs/mod.rs

@@ -56,7 +56,6 @@ pub mod clarity;
 use std::collections::BTreeMap;
 
 use costs::CostErrors;
-use serde_json;
 use stacks_common::types::StacksEpochId;
 
 use self::analysis::ContractAnalysis;
@@ -77,6 +76,7 @@ pub use crate::vm::database::clarity_db::StacksEpoch;
 use crate::vm::errors::{
     CheckErrors, Error, InterpreterError, InterpreterResult as Result, RuntimeErrorType,
 };
+use crate::vm::events::StacksTransactionEvent;
 use crate::vm::functions::define::DefineResult;
 pub use crate::vm::functions::stx_transfer_consolidated;
 pub use crate::vm::representations::{
@@ -118,12 +118,12 @@ pub enum EvaluationResult {
 #[derive(Debug, Clone)]
 pub struct ExecutionResult {
     pub result: EvaluationResult,
-    pub events: Vec<serde_json::Value>,
+    pub events: Vec<StacksTransactionEvent>,
     pub cost: Option<CostSynthesis>,
     pub diagnostics: Vec<Diagnostic>,
 }
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Serialize)]
 pub struct CostSynthesis {
     pub total: ExecutionCost,
     pub limit: ExecutionCost,

clarity/src/vm/mod.rs

@@ -453,13 +453,17 @@ pub struct SymbolicExpression {
     pub id: u64,
 
     #[cfg(feature = "developer-mode")]
+    #[serde(default)]
     pub span: Span,
 
     #[cfg(feature = "developer-mode")]
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub pre_comments: Vec<(String, Span)>,
     #[cfg(feature = "developer-mode")]
+    #[serde(default, skip_serializing_if = "Option::is_none")]
     pub end_line_comment: Option<String>,
     #[cfg(feature = "developer-mode")]
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub post_comments: Vec<(String, Span)>,
 }
 
@@ -649,7 +653,7 @@ impl fmt::Display for SymbolicExpression {
     }
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
 pub struct Span {
     pub start_line: u32,
     pub start_column: u32,
@@ -665,12 +669,7 @@ impl Span {
         end_column: 0,
     };
 
-    pub fn zero() -> Span {
-        Span {
-            start_line: 0,
-            start_column: 0,
-            end_line: 0,
-            end_column: 0,
-        }
+    pub fn zero() -> Self {
+        Self::default()
     }
 }