Skip to content

Commit 3fd137c

Browse files
committed
Merge upstream/main into feat/benchmarks
2 parents 3b34076 + 9c8eff3 commit 3fd137c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+2035
-3838
lines changed

.github/workflows/check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,4 @@ jobs:
121121
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
122122

123123
- name: Check spelling of files in the workspace
124-
uses: crate-ci/typos@2d0ce569feab1f8752f1dde43cc2f2aa53236e06 # v1.40.0
124+
uses: crate-ci/typos@bb4666ad77b539a6b4ce4eda7ebb6de553704021 # v1.42.0

.github/workflows/scorecard.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ jobs:
5252
path: results.sarif
5353
retention-days: 5
5454
- name: Upload SARIF to GitHub Code Scanning
55-
uses: github/codeql-action/upload-sarif@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9
55+
uses: github/codeql-action/upload-sarif@cdefb33c0f6224e58673d9004f47f7cb3e328b89 # v4.31.10
5656
with:
5757
sarif_file: results.sarif

.github/workflows/test.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ jobs:
3838

3939
- name: Cache cargo-nextest binary
4040
id: cache-cargo-nextest
41-
uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1
41+
uses: actions/cache@8b402f58fbc84540c8b491a91e594a4576fec3d7 # v5.0.2
4242
with:
4343
path: ~/.cargo/bin/cargo-nextest
4444
key: ${{ runner.os }}-cargo-nextest-${{ hashFiles('**/Cargo.lock') }}
4545

4646
- name: Install cargo-nextest
4747
if: steps.cache-cargo-nextest.outputs.cache-hit != 'true'
48-
uses: taiki-e/install-action@b9c5db3aef04caffaf95a1d03931de10fb2a140f # v2.65.1
48+
uses: taiki-e/install-action@542cebaaed782771e619bd5609d97659d109c492 # v2.66.7
4949
with:
5050
tool: cargo-nextest
5151

CONTRIBUTING.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Thanks for your interest in contributing! This guide explains how to set up your
2828
- `typos` for spell checking: `cargo install typos-cli` (or `brew install typos`)
2929
- A recent `rust-analyzer` for IDE support
3030
- Runtime/dev tools
31-
- For examples and some tests, you’ll need an Ethereum dev node such as Foundry’s `anvil`
31+
- For examples and some tests, you'll need an Ethereum dev node such as Foundry's `anvil`
32+
- The repository is exercised against `anvil`; if you encounter issues on other nodes/providers, please report them at https://github.com/OpenZeppelin/Event-Scanner/issues
3233

3334
---
3435

@@ -68,12 +69,30 @@ cargo test --features test-utils
6869
Run examples:
6970

7071
```bash
71-
RUST_LOG=info cargo run -p simple_counter
72+
RUST_LOG=info cargo run -p live_scanning
7273
# or
7374
RUST_LOG=info cargo run -p historical_scanning
7475
```
7576

76-
Note: Examples start a local `anvil` instance and deploy a demo contract.
77+
Logging / observability notes:
78+
79+
- The library's internal logs are **compile-time opt-in** via the `event-scanner` crate feature `tracing`.
80+
- If the feature is disabled, internal logging calls compile to **no-ops**.
81+
- Examples install a `tracing_subscriber` and read filters from `RUST_LOG`.
82+
83+
Enable `event-scanner` internal logs when running an example:
84+
85+
```bash
86+
RUST_LOG=event_scanner=debug cargo run -p historical_scanning --features event-scanner/tracing
87+
```
88+
89+
You can also combine filters to keep other dependencies quiet:
90+
91+
```bash
92+
RUST_LOG=warn,event_scanner=info cargo run -p historical_scanning --features event-scanner/tracing
93+
```
94+
95+
Note: Examples start a local `anvil` instance and deploy a demo contract. If you run into issues when using a different node/provider, please report them at https://github.com/OpenZeppelin/Event-Scanner/issues.
7796

7897
---
7998

0 commit comments

Comments
 (0)