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

Add docs for endBlock #494

Merged
merged 1 commit into from
Dec 4, 2023
Merged

Add docs for endBlock #494

merged 1 commit into from
Dec 4, 2023

Conversation

incrypto32
Copy link
Member

No description provided.

@github-actions
Copy link

github-actions bot commented Aug 29, 2023

📦 Next.js Bundle Analysis for @graphprotocol/docs

This analysis was generated by the Next.js Bundle Analysis action. 🤖

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/en/developing/creating-a-subgraph 26.61 KB 708.4 KB 202.40% (🟡 +0.02%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

@fordN fordN requested a review from azf20 August 29, 2023 15:53
Copy link
Contributor

@azf20 azf20 left a comment

Choose a reason for hiding this comment

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

Thanks - two small asks!

@@ -146,6 +147,8 @@ The important entries to update for the manifest are:

- `dataSources.source.startBlock`: the optional number of the block that the data source starts indexing from. In most cases, we suggest using the block in which the contract was created.

- `dataSources.source.endBlock`: the optional number of the block that the data source stops indexing at. When provided the dataSource stops indexing at the specified block.
Copy link
Contributor

Choose a reason for hiding this comment

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

is the block inclusive or exclusive? (i.e. in the example case does it index block 7175245 and stop, or does it stop before indexing 7175245?)

Copy link
Contributor

Choose a reason for hiding this comment

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

Additionally I think worth specifying the specVersion from which this is available

@azf20
Copy link
Contributor

azf20 commented Sep 15, 2023

Checking on this one @incrypto32?

@tamebadger
Copy link

what is the eta on this being merged ? is it safe to use endBlock now ?

@incrypto32 incrypto32 marked this pull request as ready for review December 3, 2023 06:31
@incrypto32 incrypto32 requested a review from a team as a code owner December 3, 2023 06:31
Copy link
Contributor

@azf20 azf20 left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@incrypto32 incrypto32 merged commit d9efb6f into main Dec 4, 2023
3 checks passed
@incrypto32 incrypto32 deleted the incrypto32/end-block-docs branch December 4, 2023 11:06
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