bsv58 0.1.0

Ultra-fast Base58 codec for Bitcoin SV (SIMD x86/ARM)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

# .github/workflows/ci.yml
# Rust CI for bsv58: Tests, lint, bench, cross-compile (x86/ARM/Win).
# Triggers: Push/PR to main, weekly cron for perf regression.
name: CI
on:
  push:
    branches: [ "main", "dev" ]
  pull_request:
    branches: [ "main", "dev" ]
  schedule:
    - cron: '0 0 * * 0' # Weekly Sunday UTC
env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -Dwarnings
  RUST_BACKTRACE: 1
jobs:
  check:
    name: Check
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust (stable)
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy
          edition: "2024" # Requires 1.85+ (stable since Jul 2024)
      - name: Cache
        uses: Swatinem/rust-cache@v2
      - name: Check
        run: cargo check --all-features
      - name: Clippy
        run: cargo clippy --all-features -- -D clippy::perf -D clippy::pedantic -D clippy::nursery
      - name: Fmt
        run: cargo fmt --all -- --check
      - name: Install nightly (for udeps only)
        run: rustup toolchain install nightly --component clippy
      - name: Install cargo-udeps (pinned)
        run: cargo install cargo-udeps --git https://github.com/est31/cargo-udeps --tag v0.1.60 --force
      - name: Udeps (no unused deps)
        run: cargo +nightly udeps --all-features --all-targets
  test:
    name: Test
    needs: check
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          - os: ubuntu-24.04
            target: x86_64-unknown-linux-gnu
          - os: ubuntu-24.04-arm
            target: aarch64-unknown-linux-gnu
          - os: macos-latest
            target: aarch64-apple-darwin
          - os: windows-latest # Add Win for cross
            target: x86_64-pc-windows-msvc
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust (stable, cross)
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}
          components: rustfmt, clippy
          edition: "2024"
      - name: Install cross (for aarch64-linux on x86)
        if: matrix.target == 'aarch64-unknown-linux-gnu' && matrix.os == 'ubuntu-24.04'
        run: cargo install --git https://github.com/cross-rs/cross cross
      - name: Cache
        uses: Swatinem/rust-cache@v2
      - name: Build
        if: matrix.target != 'aarch64-unknown-linux-gnu' || matrix.os == 'ubuntu-24.04-arm'
        run: cargo build --target ${{ matrix.target }} --all-features --verbose
      - name: Build (cross)
        if: matrix.target == 'aarch64-unknown-linux-gnu' && matrix.os == 'ubuntu-24.04'
        run: cross build --target ${{ matrix.target }} --all-features --verbose
      - name: Run tests
        if: matrix.target != 'aarch64-unknown-linux-gnu' || matrix.os == 'ubuntu-24.04-arm'
        run: cargo test --target ${{ matrix.target }} --all-features --verbose
      - name: Run tests (cross)
        if: matrix.target == 'aarch64-unknown-linux-gnu' && matrix.os == 'ubuntu-24.04'
        run: cross test --target ${{ matrix.target }} --all-features --verbose
      - name: Install tarpaulin (Linux only)
        if: matrix.os == 'ubuntu-24.04' && matrix.target == 'x86_64-unknown-linux-gnu'
        run: cargo install cargo-tarpaulin --version 0.34.1 --locked
      - name: Coverage (Linux only)
        if: matrix.os == 'ubuntu-24.04' && matrix.target == 'x86_64-unknown-linux-gnu'
        run: cargo tarpaulin --all-features --out Xml
      - name: Upload coverage
        if: matrix.os == 'ubuntu-24.04' && matrix.target == 'x86_64-unknown-linux-gnu'
        uses: codecov/codecov-action@v4
        with:
          file: ./tarpaulin-report.xml
  bench:
    name: Bench
    needs: test
    runs-on: ubuntu-24.04
    if: github.event_name != 'schedule' || always() # Run always on cron
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust (stable)
        uses: dtolnay/rust-toolchain@stable
        with:
          edition: "2024"
      - name: Cache
        uses: Swatinem/rust-cache@v2
      - name: Install deps (Criterion HTML)
        run: sudo apt-get update && sudo apt-get install -y cmake linux-tools-common linux-tools-generic
      - name: Run benches
        run: |
          if [[ "${{ github.event_name }}" == "schedule" || "${{ github.ref }}" == "refs/pull/"* ]]; then
            cargo bench --all-features --bench bench
          else
            cargo bench --all-features --bench bench --no-run
          fi
      - name: Upload bench report
        if: success()
        uses: actions/upload-artifact@v4
        with:
          name: bench-report
          path: target/criterion/
          retention-days: 30
          compression-level: 6
  cross:
    name: Cross-Compile
    needs: test
    runs-on: ubuntu-24.04-arm
    strategy:
      matrix:
        target: [aarch64-unknown-linux-gnu]
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust (stable, cross)
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: ${{ matrix.target }}
          edition: "2024"
      - name: Cache
        uses: Swatinem/rust-cache@v2
      - name: Cross-build (release)
        run: cargo build --target ${{ matrix.target }} --all-features --release --verbose
  perf-regression:
    name: Perf Regression
    if: github.event_name == 'schedule'
    needs: bench
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # Git history for baselines
      - name: Install Rust (stable)
        uses: dtolnay/rust-toolchain@stable
        with:
          edition: "2024"
      - name: Cache
        uses: Swatinem/rust-cache@v2
      - name: Run full benches (JSON for parsing)
        run: cargo bench --all-features --bench bench --message-format json
      - name: Detect regression (>5% slowdown)
        uses: 99si/simple-bench-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          threshold: 5 # Tight for perf-critical
          json: true