cerc-io/ipld-eth-beacon-indexer
19
0
Fork 0
Code Issues 4 Pull Requests 2 Actions Packages Projects Releases 9 Wiki Activity
This application will capture all the BeaconState's and SignedBeaconBlock's from the consensus chain on Ethereum.
12 Commits 5 Branches 9 Tags 272 MiB
Go 98.4%
Makefile 1%
Shell 0.3%
Dockerfile 0.3%
827475f029
Go to file
Abdul Rabbani 827475f029 Add DB Connection and Logging 
* Utilize LogRus
* Create a DB connection using PGX.
* Create an internal boot package for starting the application.
2022-04-20 15:44:15 -04:00
.github/ISSUE_TEMPLATE Update Templates 2022-04-19 17:48:33 -04:00
cmd Add DB Connection and Logging 2022-04-20 15:44:15 -04:00
internal/boot Add DB Connection and Logging 2022-04-20 15:44:15 -04:00
pkg Add DB Connection and Logging 2022-04-20 15:44:15 -04:00
.gitignore Add DB Connection and Logging 2022-04-20 15:44:15 -04:00
go.mod A very generic package for implementing PGX driver 2022-04-20 12:12:55 -04:00
go.sum A very generic package for implementing PGX driver 2022-04-20 12:12:55 -04:00
LICENSE Initial commit 2022-04-19 14:42:32 -04:00
main.go Utilize Cobra 2022-04-19 17:09:59 -04:00
README.md Update cobra to require head or historic when using capture. 2022-04-20 09:25:47 -04:00

README.md

ipld-ethcl-indexer

This application will capture all the BeaconState's and SignedBeaconBlock's from the consensus chain on Ethereum.

Running the Application

To run the application, utilize the following command, and update the values as needed.

go run main.go capture head --db.address localhost \
  --db.password password \
  --db.port 8077 \
  --db.username username \
  --lh.address localhost \
  --lh.port 5052

Contribution

If you want to contribute please make sure you do the following:

  • Create a Github issue before starting your work.
  • Follow the branching structure.
  • Delete your branch once it has been merged.
    • Do not delete the develop branch. We can add branch protection once we make the branch public.

Branching Structure

The branching structure is as follows: main <-- develop <-- your-branch.

It is adviced that your-branch follows the following structure: {type}/{issue-number}-{description}.

  • type - This can be anything identifying the reason for this PR, for example: bug, feature, release.
  • issue-number - This is the issue number of the GitHub issue. It will help users easily find a full description of the issue you are trying to solve.
  • description - A few words to identify your issue.