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.

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

Internal docs for archive db apps #14269

Merged
merged 7 commits into from
Oct 6, 2023
Merged

Conversation

psteckler
Copy link
Member

Add internal documentation for archive_blocks, extract_blocks, and missing_blocks_auditor.

@psteckler psteckler requested a review from a team as a code owner October 4, 2023 23:56
@psteckler
Copy link
Member Author

!ci-build-me

@psteckler
Copy link
Member Author

!ci-build-me

Comment on lines 4 to 5
There are replayer cron jobs for mainnet, devnet, and berkeley. These
jobs are run daily, to replayer a day's worth of transactions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There are replayer cron jobs for mainnet, devnet, and berkeley. These
jobs are run daily, to replayer a day's worth of transactions.
There are replayer cron jobs for Mainnet, Devnet, and Berkeley. These
jobs are run daily to replay a day's worth of transactions.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in my own commit. I'm keeping the comma, though :-)

Comment on lines 8 to 10
a network, and loads the data into Postgresql. That results in an
archive database. The most recent replayer checkpoint file is
downloaded, which provides the starting point for the replayer. When
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
a network, and loads the data into Postgresql. That results in an
archive database. The most recent replayer checkpoint file is
downloaded, which provides the starting point for the replayer. When
a network, and loads the data into PostgreSQL. That results in an
archive database. The most recent replayer checkpoint file is
downloaded, which provides the starting point for the replayer. When

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in my commit.

Comment on lines 16 to 18
There is a separate checkpoint file bucket for each network. Bot the
checkpoint files and error files for a given network are uploaded to
the same bucket.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
There is a separate checkpoint file bucket for each network. Bot the
checkpoint files and error files for a given network are uploaded to
the same bucket.
There is a separate checkpoint file bucket for each network. Both the
checkpoint files and error files for a given network are uploaded to
the same bucket.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in my own commit.

(* missing_blocks_auditor looks for blocks without parent blocks in an
archive database.

The app also looks for blocks marked as pending that are lower
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The app also looks for blocks marked as pending that are lower
The missing blocks auditor app also looks for blocks marked as pending that are lower

Copy link
Contributor

Choose a reason for hiding this comment

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

"The app" is the ML file that is the missing blocks auditor app?

Copy link
Member Author

Choose a reason for hiding this comment

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

The .ml file gets compiled to an executable program. "The app" is the executable.

@psteckler
Copy link
Member Author

!ci-build-me

@psteckler
Copy link
Member Author

!ci-build-me

@psteckler
Copy link
Member Author

!ci-build-me

@psteckler psteckler merged commit 6f8414d into develop Oct 6, 2023
1 of 2 checks passed
@psteckler psteckler deleted the feature/document-archive-apps branch October 6, 2023 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants