Merge pull request #5797 from stacks-network/release/3.1.0.0.5

Merge 3.1.0.0.5 to master
stacks-network · Feb 4, 2025 · c1a1f50 · c1a1f50
2 parents 9c8ed7b + 513dbc5
commit c1a1f50
Show file tree

Hide file tree

Showing 358 changed files with 16,085 additions and 13,476 deletions.
diff --git a/.cargo/config.toml b/.cargo/config.toml
@@ -1,6 +1,7 @@
 [alias]
 stacks-node = "run --package stacks-node --"
 fmt-stacks = "fmt -- --config group_imports=StdExternalCrate,imports_granularity=Module"
+clippy-stacks = "clippy -p libstackerdb -p stacks-signer -p pox-locking -p clarity -p libsigner -p stacks-common --no-deps --tests --all-features -- -D warnings"
 
 # Uncomment to improve performance slightly, at the cost of portability
 #   * Note that native binaries may not run on CPUs that are different from the build machine

diff --git a/.github/workflows/bitcoin-tests.yml b/.github/workflows/bitcoin-tests.yml
@@ -54,6 +54,7 @@ jobs:
           # - tests::neon_integrations::size_overflow_unconfirmed_microblocks_integration_test
           # - tests::neon_integrations::size_overflow_unconfirmed_stream_microblocks_integration_test
           # - tests::neon_integrations::runtime_overflow_unconfirmed_microblocks_integration_test
+          # - tests::epoch_25::microblocks_disabled
           # Disable this flaky test. Microblocks are no longer supported anyways.
           # - tests::neon_integrations::microblock_large_tx_integration_test_FLAKY
           - tests::neon_integrations::miner_submit_twice
@@ -80,10 +81,10 @@ jobs:
           - tests::neon_integrations::bitcoin_reorg_flap
           - tests::neon_integrations::bitcoin_reorg_flap_with_follower
           - tests::neon_integrations::start_stop_bitcoind
-          - tests::epoch_25::microblocks_disabled
           - tests::should_succeed_handling_malformed_and_valid_txs
           - tests::nakamoto_integrations::simple_neon_integration
-          - tests::nakamoto_integrations::flash_blocks_on_epoch_3
+          # Disable this flaky test. We don't need continue testing Epoch 2 -> 3 transition
+          # - tests::nakamoto_integrations::flash_blocks_on_epoch_3_FLAKY
           - tests::nakamoto_integrations::mine_multiple_per_tenure_integration
           - tests::nakamoto_integrations::block_proposal_api_endpoint
           - tests::nakamoto_integrations::miner_writes_proposed_block_to_stackerdb
@@ -124,21 +125,32 @@ jobs:
           - tests::signer::v0::signing_in_0th_tenure_of_reward_cycle
           - tests::signer::v0::continue_after_tenure_extend
           - tests::signer::v0::tenure_extend_after_idle_signers
+          - tests::signer::v0::tenure_extend_with_other_transactions
           - tests::signer::v0::tenure_extend_after_idle_miner
+          - tests::signer::v0::tenure_extend_after_failed_miner
           - tests::signer::v0::tenure_extend_succeeds_after_rejected_attempt
           - tests::signer::v0::stx_transfers_dont_effect_idle_timeout
           - tests::signer::v0::idle_tenure_extend_active_mining
           - tests::signer::v0::multiple_miners_with_custom_chain_id
           - tests::signer::v0::block_commit_delay
           - tests::signer::v0::continue_after_fast_block_no_sortition
           - tests::signer::v0::block_validation_response_timeout
+          - tests::signer::v0::block_validation_check_rejection_timeout_heuristic
+          - tests::signer::v0::block_validation_pending_table
+          - tests::signer::v0::new_tenure_while_validating_previous_scenario
           - tests::signer::v0::tenure_extend_after_bad_commit
           - tests::signer::v0::block_proposal_max_age_rejections
           - tests::signer::v0::global_acceptance_depends_on_block_announcement
           - tests::signer::v0::no_reorg_due_to_successive_block_validation_ok
           - tests::signer::v0::incoming_signers_ignore_block_proposals
           - tests::signer::v0::outgoing_signers_ignore_block_proposals
           - tests::signer::v0::injected_signatures_are_ignored_across_boundaries
+          - tests::signer::v0::fast_sortition
+          - tests::signer::v0::single_miner_empty_sortition
+          - tests::signer::v0::multiple_miners_empty_sortition
+          - tests::signer::v0::block_proposal_timeout
+          - tests::signer::v0::rejected_blocks_count_towards_miner_validity
+          - tests::signer::v0::allow_reorg_within_first_proposal_burn_block_timing_secs
           - tests::nakamoto_integrations::burn_ops_integration_test
           - tests::nakamoto_integrations::check_block_heights
           - tests::nakamoto_integrations::clarity_burn_state
@@ -158,6 +170,9 @@ jobs:
           - tests::nakamoto_integrations::sip029_coinbase_change
           - tests::nakamoto_integrations::clarity_cost_spend_down
           - tests::nakamoto_integrations::v3_blockbyheight_api_endpoint
+          - tests::nakamoto_integrations::mine_invalid_principal_from_consensus_buff
+          - tests::nakamoto_integrations::test_tenure_extend_from_flashblocks
+          - tests::nakamoto_integrations::restarting_miner
           # TODO: enable these once v1 signer is supported by a new nakamoto epoch
           # - tests::signer::v1::dkg
           # - tests::signer::v1::sign_request_rejected

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -112,19 +112,10 @@ jobs:
   ##         - commit to either (development, master) branch
   create-cache:
     if: |
-      needs.check-release.outputs.is_release == 'true' || (
-        github.event_name == 'workflow_dispatch' ||
-        github.event_name == 'pull_request' ||
-        github.event_name == 'merge_group' ||
-        (
-          contains('
-            refs/heads/master
-            refs/heads/develop
-            refs/heads/next
-          ', github.event.pull_request.head.ref) &&
-          github.event_name == 'push'
-        )
-      )
+      needs.check-release.outputs.is_release == 'true' ||
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'pull_request' ||
+      github.event_name == 'merge_group'
     name: Create Test Cache
     needs:
       - rustfmt
@@ -144,19 +135,9 @@ jobs:
   ##         - commit to either (development, next, master) branch
   stacks-core-tests:
     if: |
-      needs.check-release.outputs.is_release == 'true' || (
-        github.event_name == 'workflow_dispatch' ||
-        github.event_name == 'pull_request' ||
-        github.event_name == 'merge_group' ||
-        (
-          contains('
-            refs/heads/master
-            refs/heads/develop
-            refs/heads/next
-          ', github.event.pull_request.head.ref) &&
-          github.event_name == 'push'
-        )
-      )
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'pull_request' ||
+      github.event_name == 'merge_group'
     name: Stacks Core Tests
     needs:
       - rustfmt
@@ -177,19 +158,9 @@ jobs:
   ##         - commit to either (development, next, master) branch
   stacks-core-build-tests:
     if: |
-      needs.check-release.outputs.is_release == 'true' || (
-        github.event_name == 'workflow_dispatch' ||
-        github.event_name == 'pull_request' ||
-        github.event_name == 'merge_group' ||
-        (
-          contains('
-            refs/heads/master
-            refs/heads/develop
-            refs/heads/next
-          ', github.event.pull_request.head.ref) &&
-          github.event_name == 'push'
-        )
-      )
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'pull_request' ||
+      github.event_name == 'merge_group'
     name: Stacks Core Build Tests
     needs:
       - rustfmt
@@ -198,42 +169,21 @@ jobs:
 
   bitcoin-tests:
     if: |
-      needs.check-release.outputs.is_release == 'true' || (
-        github.event_name == 'workflow_dispatch' ||
-        github.event_name == 'pull_request' ||
-        github.event_name == 'merge_group' ||
-        (
-          contains('
-            refs/heads/master
-            refs/heads/develop
-            refs/heads/next
-          ', github.event.pull_request.head.ref) &&
-          github.event_name == 'push'
-        )
-      )
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'pull_request' ||
+      github.event_name == 'merge_group'
     name: Bitcoin Tests
     needs:
       - rustfmt
       - create-cache
       - check-release
     uses: ./.github/workflows/bitcoin-tests.yml
 
-
   p2p-tests:
     if: |
-      needs.check-release.outputs.is_release == 'true' || (
-        github.event_name == 'workflow_dispatch' ||
-        github.event_name == 'pull_request' ||
-        github.event_name == 'merge_group' ||
-        (
-          contains('
-            refs/heads/master
-            refs/heads/develop
-            refs/heads/next
-          ', github.event.pull_request.head.ref) &&
-          github.event_name == 'push'
-        )
-      )
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'pull_request' ||
+      github.event_name == 'merge_group'
     name: P2P Tests
     needs:
       - rustfmt

diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml
@@ -34,7 +34,4 @@ jobs:
           components: clippy
       - name: Clippy
         id: clippy
-        uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: -p libstackerdb -p stacks-signer -p pox-locking -p clarity -p libsigner -p stacks-common --no-deps --tests --all-features -- -D warnings
+        run: cargo clippy-stacks
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,45 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to the versioning scheme outlined in the [README.md](README.md).
 
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [3.1.0.0.5]
+
+### Added
+
+- Add miner configuration option `tenure_extend_cost_threshold` to specify the percentage of the tenure budget that must be spent before a time-based tenure extend is attempted
+
+### Changed
+
+- Miner will include other transactions in blocks with tenure extend transactions (#5760)
+- Add `block_rejection_timeout_steps` to miner configuration for defining rejections-based timeouts while waiting for signers response (#5705)
+- Miner will not issue a tenure extend until at least half of the block budget has been spent (#5757)
+
+### Fixed
+
+- Miners who restart their nodes immediately before a winning tenure now correctly detect that
+  they won the tenure after their nodes restart ([#5750](https://github.com/stacks-network/stacks-core/issues/5750)).
+
+## [3.1.0.0.4]
+
+### Added
+
+- The stacks-node miner now performs accurate tenure-extensions in certain bitcoin block production
+  cases: when a bitcoin block is produced before the previous bitcoin block's Stacks tenure started.
+  Previously, the miner had difficulty restarting their missed tenure and extending into the new
+  bitcoin block, leading to 1-2 bitcoin blocks of missed Stacks block production.
+- The event dispatcher now includes `consensus_hash` in the `/new_block` and `/new_burn_block` payloads. ([#5677](https://github.com/stacks-network/stacks-core/pull/5677))
+
+## Changed
+
+- When a miner reorgs the previous tenure due to a poorly timed block, it can now continue to build blocks on this new chain tip (#5691)
+
 ## [3.1.0.0.3]
 
 ### Added

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -387,6 +387,18 @@ You can automatically reformat your commit via:
 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`
+
+You can check what warnings need to be addressed locally via: 
+
+```bash
+cargo clippy-stacks
+```
+
 ## Comments
 
 Comments are very important for the readability and correctness of the codebase. The purpose of comments is: