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

Integrators - Walkthrough supporting a new chain #3

Open
maoueh opened this issue Mar 15, 2022 · 2 comments
Open

Integrators - Walkthrough supporting a new chain #3

maoueh opened this issue Mar 15, 2022 · 2 comments

Comments

@maoueh
Copy link
Contributor

maoueh commented Mar 15, 2022

The goal of this task is to write the content required for an integrators to start integrating a new chain completely. The actual content still need to be worked on, it's a bit unclear the exact content we need, but here a rough plan I current have:

  • Introduction asking to read the concepts & overview of the operators section to get a good understanding of the Firehose system
  • Instrument a chain adding prints to stdout at the correct places (showcase dummy chain?)
  • Clone firehose-acme and perform the necessary steps to configure it for this new chain (rm -rf .git, git init, Renaming acme and various strings, update some files).
  • Data modelling by copying over the proto-acme to proto-<chain> and model the first pass of data.
  • Make the node starts (updating nodemanager package to launch the binary with the correct flags)
  • Update the console reader to construct the block format by parsing the various lines coming in.
  • Perform a full working setup where Firehose is able to stream blocks out
@sosedoff
Copy link

Setting up new chain integration could be done via a bootstrap script: ie run the script, it'll ask the name of the new integration, specifics, etc. Think of it as a simple wizard script.

@maoueh
Copy link
Contributor Author

maoueh commented Mar 21, 2022

Agreed, that's a good idea!

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

No branches or pull requests

2 participants