Sync with upstream rust bitcoin

.cargo/mutants.toml

@@ -0,0 +1,64 @@
+additional_cargo_args = ["--all-features"]
+examine_globs = ["consensus_encoding/src/**/*.rs", "units/src/**/*.rs", "primitives/src/**/*.rs"]
+exclude_globs = [
+    "units/src/amount/verification.rs" # kani tests
+]
+exclude_re = [
+    "impl Arbitrary",
+    "impl Debug",
+    "impl fmt::Debug",
+    ".*Error",
+    "deserialize", # Skip serde mutation tests
+    "serde_details::<impl de::Visitor<'_>", # Skip serde mutation tests
+    "Iterator", # Mutating operations in an iterator can result in an infinite loop
+    "<impl .*Decodable for .*>::decoder", # Mutant replacing Default::default() is equivalent to returning new()
+    "<impl .*Decoder for .*>::read_limit", # Function is for optimization and does not need to be tested.
+
+
+    # ----------------------------------Crate-specific exclusions----------------------------------
+    # units
+    # src/amount/mod.rs
+    "units/.* parse_signed_to_satoshi", # Can't kill all mutants since there is no denomination smaller than Satoshi
+    "units/.* fmt_satoshi_in", # Related to formatting/display
+    "units/.* dec_width", # Replacing num /= 10 with num %=10 in a loop causes a timeout due to infinite loop
+    # src/locktime/relative.rs
+    "units/.* LockTime::to_consensus_u32", # Mutant from replacing | with ^, this returns the same value since the XOR is taken against the u16 with an all-zero bitmask
+    "units/.* FeeRate::fee_vb", # Deprecated
+    "units/.* FeeRate::fee_wu", # Deprecated
+    "units/.* SignedAmount::checked_abs", # Deprecated
+    "units/.* NumberOfBlocks::value", # Deprecated
+    "units/.* NumberOf512Seconds::to_consensus_u32", # Deprecated
+    "units/.* MedianTimePast::to_consensus_u32", # Deprecated
+    "units/.* Height::to_consensus_u32", # Deprecated
+    "units/.* Sequence::to_hex", # Deprecated
+    "units/.* Sequence::from_512_second_intervals", # Mutant from replacing | with ^, this returns the same value since the XOR is taken against the u16 with an all-zero bitmask
+
+    # primitives
+    "primitives/.* Opcode::classify", # Not possible to kill all mutants without individually checking every opcode classification
+    "primitives/.* Block<Checked>::cached_witness_root", # Skip getters
+    "primitives/.* Block<Checked>::transactions", # Skip getters
+    "primitives/.* Script::to_bytes", # Deprecated
+    "primitives/.* decode_cursor", # Mutating operations in decode_cursor can result in an infinite loop
+    "primitives/.* fmt_debug", # Mutants from formatting/display changes
+    "primitives/.* fmt_debug_pretty", # Mutants from formatting/display changes
+    "primitives/.* CompactTarget::to_hex", # Deprecated
+    "primitives/.* Script::to_hex", # Deprecated
+    "primitives/.* Script<T>::to_hex", # Deprecated
+    "primitives/.* ScriptBuf::to_hex", # Deprecated
+    "primitives/.* ScriptBuf<T>::to_hex", # Deprecated
+    "primitives/.* <impl Encoder for .*Encoder<'_>>::current_chunk", # Replacing the return with Some(vec![]) causes an infinite loop.
+    "primitives/.* <impl Encoder for .*Encoder<'_>>::advance", # Replacing the return with true causes an infinite loop.
+    "primitives/.* <impl Decoder for WitnessDecoder>::push_bytes", # Replacing == with != causes an infinite loop
+    "primitives/.* WitnessDecoder::resize_if_needed", # Replacing *= with += still resizes the buffer making the mutant untestable.
+    "primitives/.* replace \\+ with \\* in MerkleNode::calculate_root", # Replacing + with * causes an infinite loop
+    "primitives/.* replace == with != in MerkleNode::calculate_root", # Replacing == with != isn't caught unless alloc is disabled.
+
+    # consensus_encoding - most of these are for mutations in the logic used to determine when to stop encoding or decoding.
+    "consensus_encoding/.* <impl Decoder for ArrayDecoder<N>>::push_bytes", # Mutations cause an infinite loop
+    "consensus_encoding/.* <impl Decoder for .*>::end", # Mutations cause an infinite loop
+    "consensus_encoding/.* encode_to_vec", # Mutations cause an infinite loop
+    "consensus_encoding/.* encode_to_writer", # Mutations cause an infinite loop
+    "consensus_encoding/.* decode_from_slice", # Mutations cause an infinite loop
+    "consensus_encoding/.* decode_from_read", # Mutations cause an infinite loop
+    "consensus_encoding/.* <impl Decoder for .*>::push_bytes", # Mutations cause an infinite loop
+]

.gitattributes

@@ -0,0 +1 @@
+*.rs	diff=rust

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"
+    # Defines a cooldown period for dependency updates,
+    # allowing updates to be delayed for a configurable number of days.
+    cooldown:
+      default-days: 60

.github/labeler.yml

@@ -0,0 +1,15 @@
+ci:
+  - changed-files:
+    - any-glob-to-any-file: .github/**
+test:
+  - changed-files:
+    - any-glob-to-any-file: fuzz/**
+    - any-glob-to-any-file: '*/tests/**'
+    - any-glob-to-any-file: 'dep_test'
+    - any-glob-to-any-file: 'contrib/run_task.sh'
+    - any-glob-to-any-file: 'contrib/test_vars.sh'
+    - any-glob-to-any-file: '*/contrib/extra_tests.sh'
+    - any-glob-to-any-file: '*/contrib/test_vars.sh'
+doc:
+  - changed-files:
+    - any-glob-to-any-file: '**/*.md'

.github/workflows/README.md

@@ -0,0 +1,40 @@
+# rust-bitcoin workflow notes
+
+We are attempting to run max 20 parallel jobs using GitHub actions (usage limit for free tier).
+
+ref: https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration
+
+The minimal/recent lock files are handled by CI (`rust.yml`).
+
+## Jobs
+
+Run from rust.yml unless stated otherwise. Unfortunately we are now exceeding the 20 job target.
+(Prepare is quick and must be run first anyway.)
+
+0.  `Prepare`
+1.  `Stable - minimal`
+2.  `Stable - recent`
+3.  `Nightly - minimal`
+4.  `Nightly - recent`
+5.  `MSRV - minimal`
+6.  `MSRV - recent`
+7.  `Lint`
+8.  `Docs`
+9.  `Docsrs`
+10. `Bench`
+11. `Arch32bit`
+12. `Cross`
+13. `Embedded`
+14. `ASAN`
+15. `WASM`
+16. `Kani`
+17. `API`
+18. `Policy` - enforce repository coding policy.
+19. `Re-exports`
+20. `DiffMutants`
+21. `release` - run by `release.yml`
+22. `labeler` - run by `manage-pr.yml`
+23. `Shellcheck` - run by `shellcheck.yml`
+
+If any change touches the `.github/` directory then the `zizmor`, run by `zizmor.yml`, will be
+triggered for that PR.

.github/workflows/cargo-semver-checks-version

@@ -0,0 +1 @@
+0.45.0

.github/workflows/cron-daily-fuzz.yml

@@ -0,0 +1,100 @@
+# Automatically generated by fuzz/generate-files.sh
+name: Fuzz
+on:
+  schedule:
+    # 5am every day UTC, this correlates to:
+    # - 10pm PDT
+    # - 6am CET
+    # - 4pm AEDT
+    - cron: '00 05 * * *'
+permissions: {}
+
+jobs:
+  fuzz:
+    if: ${{ !github.event.act }}
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        # We only get 20 jobs at a time, we probably don't want to go
+        # over that limit with fuzzing because of the hour run time.
+        fuzz_target: [
+          bitcoin_arbitrary_block,
+          bitcoin_arbitrary_script,
+          bitcoin_arbitrary_transaction,
+          bitcoin_arbitrary_witness,
+          bitcoin_deserialize_block,
+          bitcoin_deserialize_prefilled_transaction,
+          bitcoin_deserialize_psbt,
+          bitcoin_deserialize_script,
+          bitcoin_deserialize_transaction,
+          bitcoin_deserialize_witness,
+          bitcoin_parse_address,
+          bitcoin_parse_outpoint,
+          bitcoin_script_bytes_to_asm_fmt,
+          consensus_encoding_decode_array,
+          consensus_encoding_decode_byte_vec,
+          consensus_encoding_decode_compact_size,
+          consensus_encoding_decode_decoder2,
+          hashes_json,
+          hashes_ripemd160,
+          hashes_sha1,
+          hashes_sha256,
+          hashes_sha512,
+          hashes_sha512_256,
+          p2p_arbitrary_addrv2,
+          p2p_deserialize_addrv2,
+          p2p_deserialize_raw_net_msg,
+          units_arbitrary_weight,
+          units_parse_amount,
+          units_parse_int,
+          units_standard_checks,
+        ]
+    steps:
+      - name: Install test dependencies
+        run: sudo apt-get update -y && sudo apt-get install -y binutils-dev libunwind8-dev libcurl4-openssl-dev libelf-dev libdw-dev cmake gcc libiberty-dev
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+
+        id: cache-fuzz
+        with:
+          path: |
+            ~/.cargo/bin
+            fuzz/target
+            target
+          key: cache-${{ matrix.target }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
+      - uses: dtolnay/rust-toolchain@5d458579430fc14a04a08a1e7d3694f545e91ce6 # stable
+        with:
+          toolchain: '1.74.0'
+      - name: fuzz
+        run: |
+          if [[ "${{ matrix.fuzz_target }}" =~ ^bitcoin ]]; then
+              export RUSTFLAGS='--cfg=hashes_fuzz --cfg=secp256k1_fuzz'
+          fi
+          echo "Using RUSTFLAGS $RUSTFLAGS"
+          cd fuzz && ./fuzz.sh "${{ matrix.fuzz_target }}"
+      - run: echo "${{ matrix.fuzz_target }}" >executed_${{ matrix.fuzz_target }}
+      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        with:
+          name: executed_${{ matrix.fuzz_target }}
+          path: executed_${{ matrix.fuzz_target }}
+
+  verify-execution:
+    if: ${{ !github.event.act }}
+    needs: fuzz
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+      - name: Display structure of downloaded files
+        run: ls -R
+      - run: find executed_* -type f -exec cat {} + | sort > executed
+      - run: source ./fuzz/fuzz-util.sh && listTargetNames | sort | diff - executed

.github/workflows/cron-daily-kani.yml

@@ -0,0 +1,19 @@
+# From https://model-checking.github.io/kani/install-github-ci.html
+name: Kani CI
+on:
+  schedule:
+    - cron: '59 23 * * *'       # midnight every day.
+permissions: {}
+jobs:
+  run-kani:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+    steps:
+      - name: 'Checkout your code.'
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: 'Run Kani on your code.'
+        uses: model-checking/kani-github-action@f838096619a707b0f6b2118cf435eaccfa33e51f # v1.1

.github/workflows/cron-weekly-cargo-mutants.yml

@@ -0,0 +1,49 @@
+name: Weekly cargo-mutants
+on:
+  schedule:
+    - cron: "0 0 * * 0" # runs weekly on Sunday at 00:00
+  workflow_dispatch: # allows manual triggering
+permissions: {}
+jobs:
+  cargo-mutants:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      issues: write
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: taiki-e/install-action@81ee1d48d9194cdcab880cbdc7d36e87d39874cb # v2.62.45
+        with:
+          tool: cargo-mutants
+      - run: cargo mutants --in-place --no-shuffle
+      - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        if: always()
+        with:
+          name: mutants.out
+          path: mutants.out
+      - name: Check for new mutants
+        if: always()
+        run: |
+          if [ -s mutants.out/missed.txt ]; then
+            echo "New missed mutants found"
+            MUTANTS_VERSION=$(cargo mutants --version)
+            gh issue create \
+            --title "New Mutants Found" \
+            --body "$(cat <<EOF
+          Displaying up to the first 10 mutants:
+          \`\`\`
+          $(head -n 10 mutants.out/missed.txt)
+          \`\`\`
+          Running cargo mutants version: ${MUTANTS_VERSION}
+          For the complete list, please check the [mutants.out artifact](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}).
+          EOF
+          )"
+            echo "create_issue=true" >> $GITHUB_ENV
+          else
+            echo "No new mutants found"
+            echo "create_issue=false" >> $GITHUB_ENV
+          fi
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/cron-weekly-rustfmt.yml

@@ -0,0 +1,35 @@
+name: Nightly rustfmt
+on:
+  schedule:
+    - cron: "0 0 * * 0" # runs weekly on Sunday at 00:00
+  workflow_dispatch: # allows manual triggering
+permissions: {}
+jobs:
+  format:
+    name: Nightly rustfmt
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - uses: dtolnay/rust-toolchain@55d80eb3c5a4228eec5390a083c092095115c6f1 # nightly
+        with:
+          components: rustfmt
+      - name: Run Nightly rustfmt
+        # Run the formatter and manually remove trailing whitespace.
+        run: cargo +nightly fmt && git ls-files -- '*.rs' -z | xargs sed -E -i'' -e 's/[[:space:]]+$//'
+      - name: Get the current date
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+        with:
+          author: Fmt Bot <bot@example.com>
+          title: Automated nightly rustfmt (${{ env.date }})
+          body: |
+           Automated nightly `rustfmt` changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
+          commit-message: ${{ env.date }} automated rustfmt nightly 
+          labels: rustfmt
+

.github/workflows/cron-weekly-update-cargo-semver-checks.yml

@@ -0,0 +1,46 @@
+name: Update cargo-semver-checks
+on:
+  schedule:
+    - cron: "0 0 * * 6" # runs every Saturday at 00:00
+  workflow_dispatch: # allows manual triggering
+permissions: {}
+jobs:
+  format:
+    name: Update cargo-semver-checks
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+      - name: Update semver-checks to use latest crates.io published version
+        run: |
+          set -x
+          # Grab the latest version of cargo semver-checks from crates.io
+          # that is not yanked.
+          LATEST_VERSION=$(curl --proto '=https' --tlsv1.3 -sSf -H "User-Agent: rust-bitcoin-ci" https://crates.io/api/v1/crates/cargo-semver-checks/versions | jq -r 'first( .versions[] | select(.yanked == false) ) | .num')
+          # Update the latest version in the reference file.
+          echo "${LATEST_VERSION}" > ./.github/workflows/cargo-semver-checks-version
+          echo "cargo_semver_checks_version=${LATEST_VERSION}" >> $GITHUB_ENV
+          # If somehow the latest version has not changed. In this case don't make an empty PR.
+          if ! git diff --exit-code > /dev/null; then
+              echo "Updated cargo-semver-checks. Opening PR."
+              echo "changes_made=true" >> $GITHUB_ENV
+          else
+              echo "Attempted to update cargo-semver-checks but the crates.io version did not change. Not opening any PR."
+              echo "changes_made=false" >> $GITHUB_ENV
+          fi
+      - name: Create Pull Request
+        if: env.changes_made == 'true'
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
+        with:
+          token: ${{ secrets.APOELSTRA_CREATE_PR_TOKEN }}
+          author: Update cargo-semver-checks Bot <bot@example.com>
+          committer: Update cargo-semver-checks Bot <bot@example.com>
+          title: Automated weekly update to cargo-semver-checks (to ${{ env.cargo_semver_checks_version }})
+          body: |
+           Automated update to Github CI workflow `semver-checks.yml` by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
+          commit-message: Automated update to Github CI to cargo-semver-checks version-${{ env.cargo_semver_checks_version }}
+          branch: create-pull-request/weekly-cargo-semver-checks-update