-
Notifications
You must be signed in to change notification settings - Fork 5
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
Create, Add content FAQs.md #31
Conversation
Created Faq questions & added content to it.
Spelling, Grammar fixes
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.
I checked the doc for spelling and grammar.
### Can we run the setup on different languages? | ||
Yes, you can run the setup in different languages. The Snapshotter node is a complex system with multiple components written in different languages. Pooler is a Python program, while Audit Protocol is coded in Go. Since Pooler and Audit Protocol communicate via RabbitMQ, either component can be ported to different languages, making the Snapshotter node accessible to developers unfamiliar with Python or Go. | ||
|
||
### What is the purpose of the PROTOCOL_STATE_CONTRACT variable? |
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.
this should clarify that there are different protocol state contracts depending on the data source contract's chain as well as the epoch size on that chain that is preferred by devs. An epoch size of 1 means more real time use cases, 10 would mean better suited for aggregated dataset use cases like data dashboards
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.
The PROTOCOL_STATE_CONTRACT variable serves a crucial role by specifying the address of the protocol state contract. Its configuration depends on a couple of key factors:
Data Source Contract's Chain: The specific blockchain on which the data source contract is deployed influences the protocol state contract address.
Epoch Size Preference: The epoch size, chosen based on the application’s needs, affects how data is processed and utilized:
- Epoch Size of 1: Ideal for real-time use cases where immediate data processing is crucial.
- Epoch Size of 10: Better suited for use cases that involve aggregated data sets, like data dashboards, where data can be compiled and reviewed over a set period.
This setup allows developers to adapt the protocol according to varying requirements and use cases, ensuring flexibility across different blockchain platforms.
grammar
The FAQ docs reviews have been resolved. This is ready for its final checks |
### If you are a new Snapshotter, | ||
Enter the ChatID when prompted on the terminal during the node setup. | ||
|
||
### If you are an existing Snapshotter, |
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.
It's not about being a 'new snapshotter' or 'existing snapshotter'. It is about whether they have a previously existing installation.
updated rpc section & added link to the compute & config docs.
Created Faq questions & added content to it.