-
Notifications
You must be signed in to change notification settings - Fork 15
Use SDK and indexers package #308
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
base: main
Are you sure you want to change the base?
Conversation
b2f4839
to
fe0ebaf
Compare
fe0ebaf
to
2e5f6d1
Compare
ecbdb5c
to
d55bdac
Compare
d55bdac
to
0da211c
Compare
0da211c
to
ec05925
Compare
ec05925
to
104f14d
Compare
The PR is now ready for your review @sablier-labs/evm |
eda32e5
to
0e7fc98
Compare
0e7fc98
to
5cbe647
Compare
5cbe647
to
1e8cc1b
Compare
1e8cc1b
to
84a826a
Compare
Click to view recordingScreen.Recording.2025-04-30.at.11.26.41.mov |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Phenomenal work @PaulRBerg.
fc985e2
to
4b0103e
Compare
The PR is finally ready for review!! Not urgent but maybe we can get it done before EthCC — so that we can document the new AVCA product that will be released before or after EthCC. A review from @smol-ninja and either @razgraf or @gavriliumircea would be helpful (for the Indexers part). Note: it's a large diff so it's easier to review this by checking out the PR locally and browsing through the new codegens. The areas of interest are:
N.B. you may need to install the latest pre-requisities - check out the |
4b1c131
to
dc60ef2
Compare
refactor: run prettier after autogen graphql refactor: update autogen graphql docs
4d69bbd
to
be29596
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just had a second look and looks good to me now. Just pushed a new commit to fix some warnings and other minor errors.
be29596
to
d04b7d2
Compare
d04b7d2
to
c87a137
Compare
This new version auto-generates queries in the API section. The idea behind the Queries page under Indexers was to provide popular queries stemming from user requests over time. It was a good place to point to for copy-paste examples. As a general feedback for these auto-generate queries and descriptions: since they can already be found in the indexer's page, in the schema, in the Hasura (or similar explorer) section describing the endpoint, I don't see a point in duplicating them yet again in our docs. They don't provide extra value and they increase maintanance cost since we'll have to remember re-generating if/when we update our endpoints. I'd propose replacing them with the old custom queries and maybe adding a note about being able to find all filters and field descriptions using Hasura, if there's no human input necessary. |
We can add some default queries, too. But let's please do that after we merge the PR because it's been open for a long time. And let's only add a handful - getting some streams and some campaigns, and that's it. Also, the Indexers repo provides some default queries now (though they use the
The maintenance cost is super low now, because everything is automated. Bumping the |
The current docs contain the most requested ones e.g. streams from a campaign, campaigns with an asset, recipients who claimed etc. They can be probably be copy-pasted. |
Explainer
This PR significantly reduces the maintenance cost of the documentation site by auto-generating:
sablier
package, whose source code is available at https://github.com/sablier-labs/sdk@sablier/indexers
package, whose source code is available at https://github.com/sablier-labs/indexersIn addition, this PR has also made a few other improvements, such as integrating BiomeJS and polishing the ESLint config (using ESLint v9 now).
Issues Closed