Merge pull request #5902 from hugocaillard/refactor/wasm-target-conditional-compilation

refactor: rename `clarity/canonical` cargo feature to `rusqlite`

Author: obycode

clarity/Cargo.toml

@@ -27,11 +27,11 @@ regex = "1"
 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", optional = true, default-features = false }
+stacks_common = { package = "stacks-common", path = "../stacks-common", default-features = false }
 rstest = "0.17.0"
 rstest_reuse = "0.5.0"
 hashbrown = { workspace = true }
-rusqlite = { workspace = true, optional = true}
+rusqlite = { workspace = true, optional = true }
 
 [dependencies.serde_json]
 version = "1.0"
@@ -49,11 +49,11 @@ mutants = "0.0.3"
 # criterion = "0.3"
 
 [features]
-default = ["canonical"]
-canonical = ["rusqlite", "stacks_common/canonical"]
+default = ["rusqlite"]
 developer-mode = ["stacks_common/developer-mode"]
 slog_json = ["stacks_common/slog_json"]
-testing = ["canonical"]
+rusqlite = ["stacks_common/rusqlite", "dep:rusqlite"]
+testing = []
 devtools = []
 rollback_value_check = []
 disable-costs = []

clarity/src/vm/analysis/mod.rs

@@ -36,15 +36,15 @@ use self::type_checker::v2_1::TypeChecker as TypeChecker2_1;
 pub use self::types::{AnalysisPass, ContractAnalysis};
 use crate::vm::ast::{build_ast_with_rules, ASTRules};
 use crate::vm::costs::LimitedCostTracker;
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 use crate::vm::database::MemoryBackingStore;
 use crate::vm::database::STORE_CONTRACT_SRC_INTERFACE;
 use crate::vm::representations::SymbolicExpression;
 use crate::vm::types::{QualifiedContractIdentifier, TypeSignature};
 use crate::vm::ClarityVersion;
 
 /// Used by CLI tools like the docs generator. Not used in production
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 pub fn mem_type_check(
     snippet: &str,
     version: ClarityVersion,

clarity/src/vm/database/clarity_store.rs

@@ -14,14 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 use rusqlite::Connection;
 use stacks_common::types::chainstate::{StacksBlockId, TrieHash};
 use stacks_common::util::hash::{hex_bytes, to_hex, Sha512Trunc256Sum};
 
 use crate::vm::analysis::AnalysisDatabase;
 use crate::vm::contexts::GlobalContext;
-#[cfg(feature = "canonical")]
 use crate::vm::database::{
     ClarityDatabase, ClarityDeserializable, ClaritySerializable, NULL_BURN_STATE_DB, NULL_HEADER_DB,
 };
@@ -85,7 +84,7 @@ pub trait ClarityBackingStore {
     fn get_open_chain_tip_height(&mut self) -> u32;
     fn get_open_chain_tip(&mut self) -> StacksBlockId;
 
-    #[cfg(feature = "canonical")]
+    #[cfg(feature = "rusqlite")]
     fn get_side_store(&mut self) -> &Connection;
 
     fn get_cc_special_cases_handler(&self) -> Option<SpecialCaseHandler> {
@@ -222,7 +221,7 @@ impl ClarityBackingStore for NullBackingStore {
         panic!("NullBackingStore can't retrieve data")
     }
 
-    #[cfg(feature = "canonical")]
+    #[cfg(feature = "rusqlite")]
     fn get_side_store(&mut self) -> &Connection {
         panic!("NullBackingStore has no side store")
     }

clarity/src/vm/database/mod.rs

@@ -13,7 +13,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 pub use sqlite::MemoryBackingStore;
 
 pub use self::clarity_db::{
@@ -22,7 +22,7 @@ pub use self::clarity_db::{
 };
 pub use self::clarity_store::{ClarityBackingStore, SpecialCaseHandler};
 pub use self::key_value_wrapper::{RollbackWrapper, RollbackWrapperPersistedLog};
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 pub use self::sqlite::SqliteConnection;
 pub use self::structures::{
     ClarityDeserializable, ClaritySerializable, DataMapMetadata, DataVariableMetadata,
@@ -32,6 +32,6 @@ pub use self::structures::{
 pub mod clarity_db;
 pub mod clarity_store;
 mod key_value_wrapper;
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 pub mod sqlite;
 mod structures;

clarity/src/vm/docs/contracts.rs

@@ -4,13 +4,13 @@ use hashbrown::{HashMap, HashSet};
 use stacks_common::consts::CHAIN_ID_TESTNET;
 use stacks_common::types::StacksEpochId;
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 use crate::vm::analysis::mem_type_check;
 use crate::vm::analysis::ContractAnalysis;
 use crate::vm::ast::{build_ast_with_rules, ASTRules};
 use crate::vm::contexts::GlobalContext;
 use crate::vm::costs::LimitedCostTracker;
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 use crate::vm::database::MemoryBackingStore;
 use crate::vm::docs::{get_input_type_string, get_output_type_string, get_signature};
 use crate::vm::types::{FunctionType, QualifiedContractIdentifier, Value};
@@ -63,7 +63,7 @@ fn make_func_ref(func_name: &str, func_type: &FunctionType, description: &str) -
     }
 }
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 #[allow(clippy::expect_used)]
 fn get_constant_value(var_name: &str, contract_content: &str) -> Value {
     let to_eval = format!("{}\n{}", contract_content, var_name);
@@ -72,7 +72,7 @@ fn get_constant_value(var_name: &str, contract_content: &str) -> Value {
         .expect("BUG: failed to return constant value")
 }
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 fn doc_execute(program: &str) -> Result<Option<Value>, vm::Error> {
     let contract_id = QualifiedContractIdentifier::transient();
     let mut contract_context = ContractContext::new(contract_id.clone(), ClarityVersion::Clarity2);
@@ -99,7 +99,7 @@ fn doc_execute(program: &str) -> Result<Option<Value>, vm::Error> {
     })
 }
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 #[allow(clippy::expect_used)]
 pub fn make_docs(
     content: &str,
@@ -185,7 +185,7 @@ pub fn make_docs(
 
 /// Produce a set of documents for multiple contracts, supplied as a list of `(contract_name, contract_content)` pairs,
 ///  and a map from `contract_name` to corresponding `ContractSupportDocs`
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 pub fn produce_docs_refs<A: AsRef<str>, B: AsRef<str>>(
     contracts: &[(A, B)],
     support_docs: &HashMap<&str, ContractSupportDocs>,

clarity/src/vm/errors.rs

@@ -16,7 +16,7 @@
 
 use std::{error, fmt};
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 use rusqlite::Error as SqliteError;
 use serde_json::Error as SerdeJSONErr;
 use stacks_common::types::chainstate::BlockHeaderHash;
@@ -57,7 +57,7 @@ pub enum InterpreterError {
     UninitializedPersistedVariable,
     FailedToConstructAssetTable,
     FailedToConstructEventBatch,
-    #[cfg(feature = "canonical")]
+    #[cfg(feature = "rusqlite")]
     SqliteError(IncomparableError<SqliteError>),
     BadFileName,
     FailedToCreateDataDirectory,
@@ -241,7 +241,7 @@ mod test {
     fn error_formats() {
         let t = "(/ 10 0)";
         let expected = "DivisionByZero
- Stack Trace: 
+ Stack Trace:
 _native_:native_div
 ";
 

clarity/src/vm/mod.rs

@@ -42,7 +42,7 @@ pub mod coverage;
 
 pub mod events;
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 pub mod tooling;
 
 #[cfg(any(test, feature = "testing"))]

stacks-common/Cargo.toml

@@ -65,11 +65,11 @@ features = ["std"]
 rand_core = { workspace = true }
 
 [features]
-default = ["canonical", "developer-mode"]
-canonical = ["rusqlite"]
+default = ["developer-mode"]
 developer-mode = []
 slog_json = ["slog-json"]
-testing = ["canonical"]
+rusqlite = ["dep:rusqlite"]
+testing = []
 serde = []
 bech32_std = []
 bech32_strict = []

stacks-common/src/bitvec.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 use rusqlite::types::{FromSql, FromSqlError, FromSqlResult, ToSql, ToSqlOutput, ValueRef};
 use serde::{Deserialize, Serialize};
 
@@ -106,7 +106,7 @@ impl<'de, const MAX_SIZE: u16> Deserialize<'de> for BitVec<MAX_SIZE> {
     }
 }
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 impl<const MAX_SIZE: u16> FromSql for BitVec<MAX_SIZE> {
     fn column_result(value: ValueRef<'_>) -> FromSqlResult<Self> {
         let bytes = hex_bytes(value.as_str()?).map_err(|e| FromSqlError::Other(Box::new(e)))?;
@@ -115,7 +115,7 @@ impl<const MAX_SIZE: u16> FromSql for BitVec<MAX_SIZE> {
     }
 }
 
-#[cfg(feature = "canonical")]
+#[cfg(feature = "rusqlite")]
 impl<const MAX_SIZE: u16> ToSql for BitVec<MAX_SIZE> {
     fn to_sql(&self) -> rusqlite::Result<ToSqlOutput<'_>> {
         let hex = bytes_to_hex(self.serialize_to_vec().as_slice());

stacks-common/src/deps_common/bitcoin/util/hash.rs

@@ -50,7 +50,6 @@ impl_array_newtype!(Ripemd160Hash, u8, 20);
 /// A Bitcoin hash160, 20-bytes, computed from x as RIPEMD160(SHA256(x))
 pub struct Hash160([u8; 20]);
 impl_array_newtype!(Hash160, u8, 20);
-impl_byte_array_rusqlite_only!(Hash160);
 
 impl Hash160 {
     /// Convert the Hash160 inner bytes to a non-prefixed hex string