Merge pull request #6499 from stacks-network/develop

merge develop -> aac-client-breaking

Author: kantai

.cargo/config.toml

@@ -1,7 +1,7 @@
 [alias]
 stacks-node = "run --package stacks-node --"
 fmt-stacks = "fmt -- --config group_imports=StdExternalCrate,imports_granularity=Module"
-clippy-stacks = "clippy -p stx-genesis -p libstackerdb -p stacks-signer -p pox-locking -p clarity-serialization -p clarity -p libsigner -p stacks-common --no-deps --tests --all-features -- -D warnings"
+clippy-stacks = "clippy -p stx-genesis -p libstackerdb -p stacks-signer -p pox-locking -p clarity-types -p clarity -p libsigner -p stacks-common --no-deps --tests --all-features -- -D warnings"
 clippy-stackslib = "clippy -p stackslib --no-deps -- -Aclippy::all -Wclippy::indexing_slicing -Wclippy::nonminimal_bool -Wclippy::clone_on_copy"
 
 # Uncomment to improve performance slightly, at the cost of portability

.github/workflows/cargo-hack-check.yml

@@ -92,7 +92,7 @@ jobs:
         run: |
           cargo hack check \
             -p clarity \
-            -p clarity-serialization \
+            -p clarity-types \
             -p stacks-common \
             --each-feature \
             --no-dev-deps \
@@ -102,7 +102,7 @@ jobs:
       - name: Run cargo hack check (WASM Deterministic)
         run: |
           cargo hack check \
-            -p clarity-serialization \
+            -p clarity-types \
             -p stacks-common \
             --each-feature \
             --no-dev-deps \

.github/workflows/clippy.yml

@@ -42,3 +42,7 @@ jobs:
       - name: Clippy
         id: clippy
         run: cargo clippy-stacks
+
+      - name: Clippy Stackslib
+        id: clippy-stackslib
+        run: cargo clippy-stackslib

CHANGELOG.md

@@ -9,19 +9,29 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
 
 ### Added
 
+- Renamed `clarity-serialization` to `clarity-types`.
 - Add `stackerdb_timeout_secs` to miner config for limiting duration of StackerDB HTTP requests.
 - When determining a global transaction replay set, the state evaluator now uses a longest-common-prefix algorithm to find a replay set in the case where a single replay set has less than 70% of signer weight.
-- New endpoint /v3/tenures/blocks/ allowing retrieving the list of stacks blocks from a burn block
+- New endpoints /v3/tenures/blocks/, /v3/tenures/blocks/hash, /v3/tenures/blocks/height allowing retrieving the list of stacks blocks from a burn block
 - Creates epoch 3.3 and costs-4 in preparation for a hardfork to activate Clarity 4
 - Adds support for new Clarity 4 builtins (not activated until epoch 3.3):
   - `contract-hash?`
+  - `current-contract`
+  - `block-time`
+  - `to-ascii?`
+- Added `contract_cost_limit_percentage` to the miner config file — sets the percentage of a block’s execution cost at which, if a large non-boot contract call would cause a BlockTooBigError, the miner will stop adding further non-boot contract calls and only include STX transfers and boot contract calls for the remainder of the block.
 
 ### Changed
 
 - Clarity errors pertaining to syntax binding errors have been made more
   expressive (#6337)
 - Removed affirmation maps logic throughout, upgrading chainstate DB schema to 11 and burnchain DB schema to 3 (#6314)
 
+### Fixed
+
+- When running `stacks-inspect decode-tx`, print the correct version of the address (mainnet or testnet) based on the transaction passed in
+- When a contract deploy is analyzed, it will no longer throw a `CostError` when the contract contains an undefined top-level variable. Instead, it will throw a `UndefinedVariable` error.
+
 ## [3.2.0.0.1]
 
 ### Added

CONTRIBUTING.md

@@ -56,7 +56,7 @@ For an example of this process, see PRs
   test, module, function, etc.), each should be documented according
   to our [coding guidelines](#Coding-Guidelines).
 
-> [*] The Changelog focuses on product changes. A "major change" refers to updates that have a direct impact on the end user, such as introducing new features, modifying existing functionality, or optimizing runtime performance. 
+> [*] The Changelog focuses on product changes. A "major change" refers to updates that have a direct impact on the end user, such as introducing new features, modifying existing functionality, or optimizing runtime performance.
 On the other hand, changes that do not need to be reflected in the Changelog include code refactoring, writing tests, or automating processes, as these do not directly affect the user experience.
 
 ## Git Commit Messages
@@ -374,10 +374,10 @@ A test should be marked `#[ignore]` if:
 - **Integration tests need to be properly tagged** using [pinny-rs](https://github.com/BitcoinL2-Labs/pinny-rs/) crate. Tagging requires two fundamental steps:
   1. Define allowed tags in the package `Cargo.toml` file (if needed).
   2. Apply relevant tags to the tests, picking from the allowed set.
-  
+
   Then it will be possible to run tests with filtering based on the tags using `cargo test` and `cargo nextest` runner.
   > For more information and examples on how tagging works, refer to the [pinny-rs](https://github.com/BitcoinL2-Labs/pinny-rs/) readme.
-  
+
   Below the tag set currently defined with related purpose:
 
   | Tag             | Description                                  |
@@ -406,16 +406,26 @@ cargo fmt-stacks
 
 ## Clippy Warnings
 
-PRs will be checked against `clippy` and will _fail_ if any clippy warnings are generated.
-Unfortunately, not all existing clippy warnings have been addressed throughout stacks-core, so arguments must be passed via the command line. 
-Therefore, we handle `clippy` configurations using a Cargo alias: `cargo clippy-stacks`
+All PRs are checked with `clippy`, and the CI will **fail** if any warnings are raised.
+Because not all existing clippy warnings in `stacks-core` have been addressed, we use Cargo aliases to standardize how clippy is run across different parts of the codebase.
+
+Two commands are available:
 
-You can check what warnings need to be addressed locally via: 
+- `cargo clippy-stacks`
+  Runs clippy across the core packages of the repository (e.g. `stx-genesis`, `clarity`, `stacks-signer`, etc.).
+
+- `cargo clippy-stackslib`
+  Runs clippy specifically on the `stackslib` package, with a different configuration.
+
+To check warnings locally, run:
 
 ```bash
 cargo clippy-stacks
+cargo clippy-stackslib
 ```
 
+Make sure both commands pass before opening a pull request.
+
 ## Comments
 
 Comments are very important for the readability and correctness of the codebase. The purpose of comments is:
@@ -491,7 +501,7 @@ impl<'a, 'b> ReadOnlyChecker<'a, 'b> {
     /// - Returns CheckErrors::WriteAttemptedInReadOnly if there is a read-only
     ///   violation, i.e. if some function marked read-only attempts to modify
     ///   the chainstate.
-    pub fn run(&mut self, contract_analysis: &ContractAnalysis) -> CheckResult<()>
+    pub fn run(&mut self, contract_analysis: &ContractAnalysis) -> Result<(), CheckError>
 ```
 
 This comment is considered positive because it explains the contract of the function in pseudo-code. Someone who understands the constructs mentioned could, e.g., write a test for this method from this description.

Cargo.lock

@@ -4,7 +4,7 @@ members = [
     "stackslib",
     "stacks-common",
     "pox-locking",
-    "clarity-serialization",
+    "clarity-types",
     "clarity",
     "stx-genesis",
     "libstackerdb",

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
-name = "clarity-serialization"
+name = "clarity-types"
 version = "0.0.1"
 edition = "2024"
-description = "Serialization and deserialization for Stacks Clarity smart contract language types."
+description = "Canonical Rust representations for Clarity's core data types, error definitions, and serialization format."
 license = "GPLv3"
 homepage = "https://github.com/stacks-network/stacks-core"
 repository = "https://github.com/stacks-network/stacks-core"
@@ -14,7 +14,7 @@ lazy_static = { workspace = true }
 regex = { version = "1", default-features = false }
 rusqlite = { workspace = true, optional = true }
 serde = { workspace = true }
-serde_json = { version = "1.0", default-features = false }
+serde_json = { version = "1.0", default-features = false, optional = true }
 serde_derive = { workspace = true }
 slog = { workspace = true }
 stacks_common = { package = "stacks-common", path = "../stacks-common", default-features = false }
@@ -28,7 +28,7 @@ default = []
 testing = []
 developer-mode = ["stacks_common/developer-mode"]
 slog_json = ["stacks_common/slog_json"]
-rusqlite = ["stacks_common/rusqlite", "dep:rusqlite"]
+rusqlite = ["stacks_common/rusqlite", "dep:rusqlite", "dep:serde_json"]
 
 # Wasm-specific features for easier configuration
 wasm-web = ["stacks_common/wasm-web"]

clarity-serialization/Cargo.toml renamed to clarity-types/Cargo.toml

@@ -1,8 +1,8 @@
-# Clarity Serialization (`clarity-serialization`)
+# Clarity Types (`clarity-types`)
 
 [![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
-A Rust crate for representing, serializing, and deserializing data types from the Stacks Clarity smart contract language.
+A Rust crate for representing all core data types, errors, and serializable structures of the Stacks Clarity smart contract language.
 
 ## Overview
 
@@ -13,6 +13,7 @@ This crate provides the core components for working with Clarity data structures
 *   **Canonical Data Structures**: Rust representations for all Clarity types, including `int`, `uint`, `bool`, `principal`, `optional`, `response`, `tuple`, `list`, `buffer`, and strings.
 *   **Consensus-Compatible Binary Codec**: Implements the binary serialization and deserialization format required by the Stacks blockchain.
 *   **Type Safety**: Includes type-checking logic (`admits`, `least_supertype`) for validating values against type signatures.
+*   **Canonical Errors**: The definitive enums for all static analysis, runtime, and internal errors that can occur during Clarity execution.
 
 ## Quick Start: Usage Examples
 
@@ -21,7 +22,7 @@ This crate provides the core components for working with Clarity data structures
 This example demonstrates how to construct a complex Clarity `(tuple)` and serialize it to its hexadecimal string representation, which is suitable for use as a transaction argument.
 
 ```rust
-use clarity_serialization::types::{PrincipalData, TupleData, Value};
+use clarity_types::types::{PrincipalData, TupleData, Value};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     // 1. Construct the individual values that will go into our tuple.
@@ -64,7 +65,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 This example shows the reverse process: taking a hex string and deserializing it into a structured `Value` object, while validating it against an expected type.
 
 ```rust
-use clarity_serialization::types::{TypeSignature, Value};
+use clarity_types::types::{TypeSignature, Value};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let hex_string = "0c000000030269640100000000000000000000000000000065086d657461646174610a0200000004deadbeef056f776e65720514a46ff88886c2ef9762d970b4d2c63678835bd39d";