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

docs: erpc #76

Merged
merged 3 commits into from
Aug 8, 2024
Merged

docs: erpc #76

merged 3 commits into from
Aug 8, 2024

Conversation

kasrakhosravi
Copy link
Contributor

@kasrakhosravi kasrakhosravi commented Aug 7, 2024

Adding eRPC as RPC proxy and caching for indexing use-cases

@joshstevens19 let me know if this makes sense to be here :)

btw, the preview feature of Vercel needs authentication

Copy link

vercel bot commented Aug 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
rindexer-documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 8, 2024 6:29am

```

3. Send your first request:
Copy link
Owner

Choose a reason for hiding this comment

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

lets remove this send your first request and talk about rindexer aka now you can now set this rpc URl in the network > rpc name https://rindexer.xyz/docs/start-building/yaml-config/networks#rpc and then you are set to go

[eRPC](https://erpc.cloud/) is a fault-tolerant EVM RPC proxy and re-org aware permanent caching solution. It is built with read-heavy use-cases in mind such as data indexing and high-load frontend usage.

# Quickstart
Copy link
Owner

Choose a reason for hiding this comment

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

you can also do a shoutout in https://rindexer.xyz/docs/start-building/yaml-config/networks#rpc about this as in turn this is load balancing the request as well which rindexer doesn't have by default so this can be its default

@joshstevens19
Copy link
Owner

great PR yes it may be easier to run "npm dev" on the docs repo locally but i have allowed this to be seen now, added a few comments thanks for PR

@aramalipoor
Copy link

aramalipoor commented Aug 7, 2024

@joshstevens19 what do you think of adding erpc in the docker-compose.yml and also a basic erpc.yaml example.

So basically the flow for users will be to add their RPC endpoints in erpc.yaml and then in reindexer only use erpc.

A fun idea is if you can "import" erpc.yaml from reindexer config, so users don't need to change anything there if they add a new network in erpc.yaml.

@joshstevens19
Copy link
Owner

@joshstevens19 what do you think of adding erpc in the docker-compose.yml and also a basic erpc.yaml example.

So basically the flow for users will be to add their RPC endpoints in erpc.yaml and then in reindexer only use erpc.

A fun idea is if you can "import" erpc.yaml from reindexer config, so users don't need to change anything there if they add a new network in erpc.yaml.

what if we as you said exposed a new property in the rindexer.yaml called erpc and erpc could try to also read from an rindexer.yaml as well? this means we don't need 2 yamls firstly!

I'm not fully into making the docker have it by default though as deployments etc may get a bit odd so i think we can keep that as a manual step but just get them to add a section to the docker compose?

@kasrakhosravi
Copy link
Contributor Author

kasrakhosravi commented Aug 8, 2024

@joshstevens19 let me know your thoughts about this structure

references/rpc-node-providers
Screenshot 2024-08-08 at 10 58 54

start-building/yaml-config/networks
Screenshot 2024-08-08 at 10 59 03

@joshstevens19
Copy link
Owner

@joshstevens19 let me know your thoughts about this structure

references/rpc-node-providers Screenshot 2024-08-08 at 10 58 54

start-building/yaml-config/networks Screenshot 2024-08-08 at 10 59 03

this looks good !!

@joshstevens19
Copy link
Owner

let me know if this is the final version your end looks good mine - i will then merge @kasrakhosravi @aramalipoor

@kasrakhosravi
Copy link
Contributor Author

@joshstevens19 let's get this one merged in 🚀 we can later also think about an optional erpc property in rindexer.yaml if it makes sense

@joshstevens19 joshstevens19 merged commit 833ec93 into joshstevens19:master Aug 8, 2024
1 check passed
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