Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(stats): dependency table #1231

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat(stats): dependency table #1231

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
94c46e9
update requirements + add dependency table
bragov4ik Feb 5, 2025
57df88f
remove logging from DB tests
bragov4ik Feb 5, 2025
846a17b
improve dependency info
bragov4ik Feb 5, 2025
19b565a
clarify preferable
bragov4ik Feb 6, 2025
4f565cf
new entry
bragov4ik Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,10 @@ jobs:
if: success() || failure()

- name: DB tests
run: RUST_BACKTRACE=1 RUST_LOG=info cargo test --locked --workspace -- --nocapture --ignored
# No logs because they hinder performance too much (75s with vs 45s without on local machine)
# and there are too much logs to view in the browser, forcing to download .zip and open
# ~90 MB log file locally
run: RUST_BACKTRACE=1 cargo test --locked --workspace -- --nocapture --ignored
if: success() || failure()
env:
DATABASE_URL: postgres://postgres:admin@localhost:5432/
Expand Down
13 changes: 13 additions & 0 deletions stats/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ The service consists of 2 parts, a stats calculation library and a transport lay

- Postgresql database for this service
- Access to Blockscout database
- (Preferable) Access to Blockscout API
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does preferable mean and what happens if an access would not be available?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added some lead to more info, can you recheck and see if it's clear now?

Copy link
Member

@rimrakhimov rimrakhimov Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better now, yes. Though I still believe 'preferable' is not the best name for such (sometimes required sometimes optional) requirements, but I cannot come up with anything better as well

Copy link
Contributor Author

@bragov4ik bragov4ik Feb 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe someone on the tech call will come up with a better approach 😇

- (Optional) Access to User Ops Indexer database (actually just tables in Blockscout database)

### Dependecy version requirements

Usually, it's best to use the latest versions of all components. Nevertheless, if there is a need in using older versions, you can refer to the following table.

The table lists versions of Blockscout and User Ops Indexer that each Stats version was developed for and tested on.

| Stats version | Recommended Blockscout version | Recommended User Ops Indexer version |
|---|---|---|
| v2.4.0 | v6.10.1 | - (not yet supported) |
| v2.5.0 | v6.10.1 | - |

## Build

Expand Down
Loading