Feat/chain-id

.github/actions/docsgen/Dockerfile.docsgen

@@ -10,8 +10,8 @@ RUN cargo build
 
 RUN mkdir /out
 
-RUN /src/target/debug/blockstack-core docgen | jq . > /out/clarity-reference.json
-RUN /src/target/debug/blockstack-core docgen_boot | jq . > /out/boot-contracts-reference.json
+RUN /src/target/debug/stacks-inspect docgen | jq . > /out/clarity-reference.json
+RUN /src/target/debug/stacks-inspect docgen_boot | jq . > /out/boot-contracts-reference.json
 
 FROM scratch AS export-stage
 COPY --from=build /out/clarity-reference.json /

.vscode/launch.json

@@ -8,11 +8,11 @@
             "cargo": {
                 "args": [
                     "build",
-                    "--bin=blockstack-core",
+                    "--bin=stacks-inspect",
                     "--package=blockstack-core"
                 ],
                 "filter": {
-                    "name": "blockstack-core",
+                    "name": "stacks-inspect",
                     "kind": "bin"
                 }
             },
@@ -118,11 +118,11 @@
                 "args": [
                     "test",
                     "--no-run",
-                    "--bin=blockstack-core",
+                    "--bin=stacks-inspect",
                     "--package=blockstack-core"
                 ],
                 "filter": {
-                    "name": "blockstack-core",
+                    "name": "stacks-inspect",
                     "kind": "bin"
                 }
             },

CHANGELOG.md

@@ -21,25 +21,27 @@ the node to spend up to 30 minutes migrating the data to a new schema.
 ### Changed
 - The MARF implementation will now defer calculating the root hash of a new trie
   until the moment the trie is committed to disk.  This avoids gratuitous hash
-calculations, and yields a performance improvement of anywhere between 10x and
-200x (#3041).
+  calculations, and yields a performance improvement of anywhere between 10x and
+  200x (#3041).
 - The MARF implementation will now store tries to an external file for instances
   where the tries are expected to exceed the SQLite page size (namely, the
-Clarity database). This improves read performance by a factor of 10x to 14x
-(#3059).
+  Clarity database). This improves read performance by a factor of 10x to 14x
+  (#3059).
 - The MARF implementation may now cache trie nodes in RAM if directed to do so
   by an environment variable (#3042).
 - Sortition processing performance has been improved by about an order of
   magnitude, by avoiding a slew of expensive database reads (#3045).  WARNING:
-applying this change to an existing chainstate directory will take a few
-minutes when the node starts up.
+  applying this change to an existing chainstate directory will take a few
+  minutes when the node starts up.
 - Updated chains coordinator so that before a Stacks block or a burn block is processed, 
   an event is sent through the event dispatcher. This fixes #3015. 
 - Expose a node's public key and public key hash160 (i.e. what appears in
   /v2/neighbors) via the /v2/info API endpoint (#3046)
 - Reduced the default subsequent block attempt timeout from 180 seconds to 30
   seconds, based on benchmarking the new MARF performance data during a period
-of network congestion (#3098)
+  of network congestion (#3098)
+- The `blockstack-core` binary has been renamed to `stacks-inspect`.
+  This binary provides CLI tools for chain and mempool inspection.
 
 ## [2.05.0.1.0]
 

Cargo.toml

@@ -21,7 +21,7 @@ name = "blockstack_lib"
 path = "src/lib.rs"
 
 [[bin]]
-name = "blockstack-core"
+name = "stacks-inspect"
 path = "src/main.rs"
 
 [[bin]]

build-scripts/Dockerfile.linux-arm64

@@ -20,4 +20,4 @@ RUN CC=aarch64-linux-gnu-gcc \
 RUN mkdir /out && cp -R /src/target/aarch64-unknown-linux-gnu/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core /out/blockstack-cli /out/clarity-cli /out/stacks-node /
+COPY --from=build /out/stacks-inspect /out/blockstack-cli /out/clarity-cli /out/stacks-node /

build-scripts/Dockerfile.linux-armv7

@@ -20,4 +20,4 @@ RUN CC=arm-linux-gnueabihf-gcc \
 RUN mkdir /out && cp -R /src/target/armv7-unknown-linux-gnueabihf/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core /out/blockstack-cli /out/clarity-cli /out/stacks-node /
+COPY --from=build /out/stacks-inspect /out/blockstack-cli /out/clarity-cli /out/stacks-node /

build-scripts/Dockerfile.linux-musl-x64

@@ -20,4 +20,4 @@ RUN CC=musl-gcc \
 RUN mkdir /out && cp -R /src/target/x86_64-unknown-linux-musl/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core /out/blockstack-cli /out/clarity-cli /out/stacks-node /
+COPY --from=build /out/stacks-inspect /out/blockstack-cli /out/clarity-cli /out/stacks-node /

build-scripts/Dockerfile.linux-x64

@@ -17,4 +17,4 @@ RUN cargo build --release --workspace --target x86_64-unknown-linux-gnu
 RUN mkdir /out && cp -R /src/target/x86_64-unknown-linux-gnu/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core /out/blockstack-cli /out/clarity-cli /out/stacks-node /
+COPY --from=build /out/stacks-inspect /out/blockstack-cli /out/clarity-cli /out/stacks-node /

build-scripts/Dockerfile.macos-arm64

@@ -21,4 +21,4 @@ RUN . /opt/osxcross/env-macos-aarch64 && \
 RUN mkdir /out && cp -R /src/target/aarch64-apple-darwin/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core /out/blockstack-cli /out/clarity-cli /out/stacks-node /
+COPY --from=build /out/stacks-inspect /out/blockstack-cli /out/clarity-cli /out/stacks-node /

build-scripts/Dockerfile.macos-x64

@@ -21,4 +21,4 @@ RUN . /opt/osxcross/env-macos-x86_64 && \
 RUN mkdir /out && cp -R /src/target/x86_64-apple-darwin/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core /out/blockstack-cli /out/clarity-cli /out/stacks-node /
+COPY --from=build /out/stacks-inspect /out/blockstack-cli /out/clarity-cli /out/stacks-node /

build-scripts/Dockerfile.windows-x64

@@ -19,4 +19,4 @@ RUN CC_x86_64_pc_windows_gnu=x86_64-w64-mingw32-gcc \
 RUN mkdir /out && cp -R /src/target/x86_64-pc-windows-gnu/release/. /out
 
 FROM scratch AS export-stage
-COPY --from=build /out/blockstack-core.exe /out/blockstack-cli.exe /out/clarity-cli.exe /out/stacks-node.exe /
+COPY --from=build /out/stacks-inspect.exe /out/blockstack-cli.exe /out/clarity-cli.exe /out/stacks-node.exe /

circle.yml

@@ -15,15 +15,15 @@ jobs:
             cargo build
       - run:
           command: |
-            ./target/debug/blockstack-core local initialize db &&
-            ./target/debug/blockstack-core local check sample-contracts/tokens.clar db &&
-            ./target/debug/blockstack-core local launch S1G2081040G2081040G2081040G208105NK8PE5.tokens sample-contracts/tokens.clar db &&
-            ./target/debug/blockstack-core local check sample-contracts/names.clar db &&
-            ./target/debug/blockstack-core local launch S1G2081040G2081040G2081040G208105NK8PE5.names sample-contracts/names.clar db &&
-            ./target/debug/blockstack-core local execute db S1G2081040G2081040G2081040G208105NK8PE5.tokens mint! SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR u100000
+            ./target/debug/stacks-inspect local initialize db &&
+            ./target/debug/stacks-inspect local check sample-contracts/tokens.clar db &&
+            ./target/debug/stacks-inspect local launch S1G2081040G2081040G2081040G208105NK8PE5.tokens sample-contracts/tokens.clar db &&
+            ./target/debug/stacks-inspect local check sample-contracts/names.clar db &&
+            ./target/debug/stacks-inspect local launch S1G2081040G2081040G2081040G208105NK8PE5.names sample-contracts/names.clar db &&
+            ./target/debug/stacks-inspect local execute db S1G2081040G2081040G2081040G208105NK8PE5.tokens mint! SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR u100000
       - run:
           command: |
-            echo "(get-balance 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR)" | ./target/debug/blockstack-core local eval S1G2081040G2081040G2081040G208105NK8PE5.tokens db
+            echo "(get-balance 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR)" | ./target/debug/stacks-inspect local eval S1G2081040G2081040G2081040G208105NK8PE5.tokens db
   unit_tests_with_cov:
     machine: true
     working_directory: ~/blockstack

clarity/src/vm/analysis/arithmetic_checker/mod.rs

@@ -151,7 +151,9 @@ impl<'a> ArithmeticOnlyChecker<'a> {
         {
             match native_var {
                 ContractCaller | TxSender | TotalLiquidMicroSTX | BlockHeight | BurnBlockHeight
-                | Regtest | TxSponsor | Mainnet => Err(Error::VariableForbidden(native_var)),
+                | Regtest | TxSponsor | Mainnet | ChainId => {
+                    Err(Error::VariableForbidden(native_var))
+                }
                 NativeNone | NativeTrue | NativeFalse => Ok(()),
             }
         } else {

clarity/src/vm/analysis/arithmetic_checker/tests.rs

@@ -113,6 +113,7 @@ fn test_variables_fail_arithmetic_check_clarity1() {
         ),
         ("(define-private (foo) tx-sponsor?)", Ok(())),
         ("(define-private (foo) is-in-mainnet)", Ok(())),
+        ("(define-private (foo) chain-id)", Ok(())),
     ];
 
     for (contract, result) in tests.iter() {
@@ -170,6 +171,10 @@ fn test_variables_fail_arithmetic_check_clarity2() {
             "(define-private (foo) is-in-mainnet)",
             Err(VariableForbidden(NativeVariables::Mainnet)),
         ),
+        (
+            "(define-private (foo) chain-id)",
+            Err(VariableForbidden(NativeVariables::ChainId)),
+        ),
     ];
 
     for (contract, result) in tests.iter() {

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

@@ -360,6 +360,7 @@ fn type_reserved_variable(variable_name: &str, version: &ClarityVersion) -> Opti
             TotalLiquidMicroSTX => TypeSignature::UIntType,
             Regtest => TypeSignature::BoolType,
             Mainnet => TypeSignature::BoolType,
+            ChainId => TypeSignature::UIntType,
         };
         Some(var_type)
     } else {

clarity/src/vm/clarity.rs

@@ -119,6 +119,7 @@ pub trait ClarityConnection {
     fn with_readonly_clarity_env<F, R>(
         &mut self,
         mainnet: bool,
+        chain_id: u32,
         sender: PrincipalData,
         sponsor: Option<PrincipalData>,
         cost_track: LimitedCostTracker,
@@ -129,8 +130,9 @@ pub trait ClarityConnection {
     {
         let epoch_id = self.get_epoch();
         self.with_clarity_db_readonly_owned(|clarity_db| {
-            let mut vm_env =
-                OwnedEnvironment::new_cost_limited(mainnet, clarity_db, cost_track, epoch_id);
+            let mut vm_env = OwnedEnvironment::new_cost_limited(
+                mainnet, chain_id, clarity_db, cost_track, epoch_id,
+            );
             let result = vm_env
                 .execute_in_env(sender, sponsor, to_do)
                 .map(|(result, _, _)| result);

clarity/src/vm/contexts.rs

@@ -51,6 +51,10 @@ use crate::vm::version::ClarityVersion;
 
 use crate::vm::coverage::CoverageReporter;
 
+use crate::vm::tests::test_only_mainnet_to_chain_id;
+
+use stacks_common::consts::CHAIN_ID_TESTNET;
+
 use serde::Serialize;
 
 pub const MAX_CONTEXT_DEPTH: u16 = 256;
@@ -204,6 +208,8 @@ pub struct GlobalContext<'a> {
     pub coverage_reporting: Option<CoverageReporter>,
     /// This is the epoch of the the block that this transaction is executing within.
     epoch_id: StacksEpochId,
+    /// This is the chain ID of the transaction
+    pub chain_id: u32,
 }
 
 #[derive(Serialize, Deserialize, Clone)]
@@ -543,7 +549,13 @@ impl<'a> OwnedEnvironment<'a> {
     pub fn new(database: ClarityDatabase<'a>) -> OwnedEnvironment<'a> {
         let epoch = StacksEpochId::Epoch2_05;
         OwnedEnvironment {
-            context: GlobalContext::new(false, database, LimitedCostTracker::new_free(), epoch),
+            context: GlobalContext::new(
+                false,
+                CHAIN_ID_TESTNET,
+                database,
+                LimitedCostTracker::new_free(),
+                epoch,
+            ),
             default_contract: ContractContext::new(
                 QualifiedContractIdentifier::transient(),
                 ClarityVersion::Clarity1,
@@ -560,8 +572,10 @@ impl<'a> OwnedEnvironment<'a> {
     ) -> OwnedEnvironment<'a> {
         let cost_track = LimitedCostTracker::new_max_limit(&mut database, epoch, use_mainnet)
             .expect("FAIL: problem instantiating cost tracking");
+        let chain_id = test_only_mainnet_to_chain_id(use_mainnet);
+
         OwnedEnvironment {
-            context: GlobalContext::new(use_mainnet, database, cost_track, epoch),
+            context: GlobalContext::new(use_mainnet, chain_id, database, cost_track, epoch),
             default_contract: ContractContext::new(
                 QualifiedContractIdentifier::transient(),
                 ClarityVersion::Clarity1,
@@ -580,12 +594,14 @@ impl<'a> OwnedEnvironment<'a> {
 
     pub fn new_free(
         mainnet: bool,
+        chain_id: u32,
         database: ClarityDatabase<'a>,
         epoch_id: StacksEpochId,
     ) -> OwnedEnvironment<'a> {
         OwnedEnvironment {
             context: GlobalContext::new(
                 mainnet,
+                chain_id,
                 database,
                 LimitedCostTracker::new_free(),
                 epoch_id,
@@ -600,12 +616,13 @@ impl<'a> OwnedEnvironment<'a> {
 
     pub fn new_cost_limited(
         mainnet: bool,
+        chain_id: u32,
         database: ClarityDatabase<'a>,
         cost_tracker: LimitedCostTracker,
         epoch_id: StacksEpochId,
     ) -> OwnedEnvironment<'a> {
         OwnedEnvironment {
-            context: GlobalContext::new(mainnet, database, cost_tracker, epoch_id),
+            context: GlobalContext::new(mainnet, chain_id, database, cost_tracker, epoch_id),
             default_contract: ContractContext::new(
                 QualifiedContractIdentifier::transient(),
                 ClarityVersion::Clarity1,
@@ -1426,6 +1443,7 @@ impl<'a> GlobalContext<'a> {
     // Instantiate a new Global Context
     pub fn new(
         mainnet: bool,
+        chain_id: u32,
         database: ClarityDatabase,
         cost_track: LimitedCostTracker,
         epoch_id: StacksEpochId,
@@ -1438,6 +1456,7 @@ impl<'a> GlobalContext<'a> {
             event_batches: Vec::new(),
             mainnet,
             epoch_id,
+            chain_id,
             coverage_reporting: None,
         }
     }

clarity/src/vm/costs/mod.rs

@@ -36,6 +36,7 @@ use crate::vm::types::{
     TypeSignature, NONE,
 };
 use crate::vm::{ast, eval_all, ClarityName, SymbolicExpression, Value};
+use stacks_common::consts::{CHAIN_ID_MAINNET, CHAIN_ID_TESTNET};
 use stacks_common::types::StacksEpochId;
 
 pub mod constants;
@@ -241,6 +242,7 @@ pub struct TrackerData {
     ///  evaluated, so no epoch identifier is necessary.
     epoch: StacksEpochId,
     mainnet: bool,
+    chain_id: u32,
 }
 
 #[derive(Clone)]
@@ -623,6 +625,7 @@ fn load_cost_functions(
 impl LimitedCostTracker {
     pub fn new(
         mainnet: bool,
+        chain_id: u32,
         limit: ExecutionCost,
         clarity_db: &mut ClarityDatabase,
         epoch: StacksEpochId,
@@ -637,6 +640,7 @@ impl LimitedCostTracker {
             memory: 0,
             epoch,
             mainnet,
+            chain_id,
         };
         assert!(clarity_db.is_stack_empty());
         cost_tracker.load_costs(clarity_db, true)?;
@@ -645,6 +649,7 @@ impl LimitedCostTracker {
 
     pub fn new_mid_block(
         mainnet: bool,
+        chain_id: u32,
         limit: ExecutionCost,
         clarity_db: &mut ClarityDatabase,
         epoch: StacksEpochId,
@@ -659,6 +664,7 @@ impl LimitedCostTracker {
             memory: 0,
             epoch,
             mainnet,
+            chain_id,
         };
         cost_tracker.load_costs(clarity_db, false)?;
         Ok(Self::Limited(cost_tracker))
@@ -670,8 +676,16 @@ impl LimitedCostTracker {
         epoch: StacksEpochId,
         use_mainnet: bool,
     ) -> Result<LimitedCostTracker> {
+        use crate::vm::tests::test_only_mainnet_to_chain_id;
+        let chain_id = test_only_mainnet_to_chain_id(use_mainnet);
         assert!(clarity_db.is_stack_empty());
-        LimitedCostTracker::new(use_mainnet, ExecutionCost::max_value(), clarity_db, epoch)
+        LimitedCostTracker::new(
+            use_mainnet,
+            chain_id,
+            ExecutionCost::max_value(),
+            clarity_db,
+            epoch,
+        )
     }
 
     pub fn new_free() -> LimitedCostTracker {
@@ -840,10 +854,16 @@ fn compute_cost(
     eval_in_epoch: StacksEpochId,
 ) -> Result<ExecutionCost> {
     let mainnet = cost_tracker.mainnet;
+    let chain_id = cost_tracker.chain_id;
     let mut null_store = NullBackingStore::new();
     let conn = null_store.as_clarity_db();
-    let mut global_context =
-        GlobalContext::new(mainnet, conn, LimitedCostTracker::new_free(), eval_in_epoch);
+    let mut global_context = GlobalContext::new(
+        mainnet,
+        chain_id,
+        conn,
+        LimitedCostTracker::new_free(),
+        eval_in_epoch,
+    );
 
     let cost_contract = cost_tracker
         .cost_contracts