Merge remote-tracking branch 'stacks-network/develop' into feat/shadow-marf

Author: jcnelson

.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 \

CHANGELOG.md

@@ -9,12 +9,14 @@ 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
 - 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?`
+  - `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

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"

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";