Add info about timelines and usage #609
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| @@ -14,6 +14,8 @@ import TabItem from "@theme/TabItem"; | |||
|
|
|||
| API tokens provide authenticated access to HyperSync services, enabling enhanced capabilities and usage tracking. While currently optional, they will become mandatory in the future and offer significant advantages for serious usage. | |||
|
|
|||
| **Starting from 9 May**, you will still be able to use HyperSync without API tokens, but **rate limits will be applied**. The service will remain **free to use until the end of May**. From **June onwards**, we will introduce a set of **tiered packages based on usage**. Indexers deployed to our hosted service will have special access to HyperSync that does not require a custom API token. | |||
There was a problem hiding this comment.
Should probably update a message in /hyperindex/messages
There was a problem hiding this comment.
I wonder if we should add some kind of note about API tokens in the HyperIndex docs also.
docs/HyperSync/api-tokens.mdx
Outdated
| To understand your current month's usage, visit [https://envio.dev/app/api-tokens](https://envio.dev/app/api-tokens). Usage is composed of two main components: | ||
|
|
||
| - **Number of Requests**: The total count of API requests made. | ||
| - **Credits**: A calculation based on the endpoint used and the size of the query. |
There was a problem hiding this comment.
Right now this calculation is too opaque and scary for a user IMO.
There was a problem hiding this comment.
What do you suggest? You can see it on the usage dashboard. We can create a separate doc on the calculation if you like but it's probably TMI for a user and subject to change during the course of this month.
There was a problem hiding this comment.
I think we still haven't even decided on the calc tbh as I know it varies a lot per use case. Maybe just to say the calc takes into account, data bandwidth, disk read etc and is a best representation of usage, we happy to expand upon detail on request?
I know if I was a user and a pricing calc was completley opaque it would be quite nerve wracking so I think we do need to share in more detail somewhere at somestage
There was a problem hiding this comment.
Cool I'll add that 👍🏼 sounds good.
There was a problem hiding this comment.
Done, thanks so much!
Co-authored-by: Jason Smythe <[email protected]>
| @@ -49,6 +49,20 @@ While HyperIndex gives you a complete indexing solution with schema management a | |||
|
|
|||
| --- | |||
|
|
|||
| ## Hypersync API Token Requirements | |||
|
|
|||
| Starting from **9 May 2024**, HyperSync (the data engine powering HyperIndex) will implement rate limits for requests without API tokens. Here's what you need to know: | |||
There was a problem hiding this comment.
We don't mention at all what the rate limits might be. We might want to mention, its rate limited to appox 100 req per minute and this means potentially your indexer may be 2x slower without a token. To avoid simply add a token?
There was a problem hiding this comment.
We haven't decided on this yet.
There was a problem hiding this comment.
Yeah, I thought leave this vague. But maybe be more direct in saying that if you want guaranteed uninterupted support use a token.
It is also hard to be precise. It is local rate limitting per hypersync instance, so for ETH we have 4 replicas now (we will reduce this in the future) - but that means 4x the rate limit. So best we can say is between 100 and 200 requests per minute or something like that.
For an indexer it'll only affect the height polling, don't think it'll make things slower for historical sync (at least at the levels of rate limiting we will have to start)
docs/HyperIndex/overview.md
Outdated
| - **Self-Hosted Deployments**: API tokens are required for unlimited HyperSync access in self-hosted deployments. The token can be set via the `ENVIO_API_TOKEN` environment variable in your indexer configuration. This can be read from the `.env` file in the root of your HyperIndex project. | ||
| - **Hosted Service**: Indexers deployed to our hosted service will have special access that doesn't require a custom API token | ||
| - **Free Usage**: The service remains free to use until the end of May 2024 | ||
| - **Future Pricing**: From June 2024 onwards, we will introduce tiered packages based on usage |
There was a problem hiding this comment.
We should maybe ask people to reach out to us for preffered introductory pricing given their use case
Co-authored-by: Jason Smythe <[email protected]>
Wait for https://github.com/enviodev/ui/pull/539 to be merged before including. Should be today.