bryanlabs / volunteer

Volunteer opportunities with Defiant Labs
Apache License 2.0
0 stars 0 forks source link

Research Cosmos-based Blockchains and Custom Modules to support the Cosmos Indexer #6

Open pharr117 opened 2 months ago

pharr117 commented 2 months ago

The Cosmos Indexer is an opensource indexer implementation written in Go that works directly with the Cosmos SDK to index Cosmos SDK based blockchains.

The indexer is written to be generic, in that it is intended to index any blockchain that is based on the Cosmos SDK. This is possible due to the common set of data points that are queryable across the Cosmos ecosystem and the availability of similar data shapes that are indexable.

There is one caveat to this: the Cosmos SDK allows new modules to be included in blockchains that use it. This provides developers with the flexibility to create new behavior, but it makes it difficult for indexers to know the shape of data for new blockchains.

The goal of this task is to:

  1. Support the Cosmos Indexer opensource repo by researching Cosmos SDK-based chains
  2. Discover new custom chain modules of interest
  3. Document the Transaction message types and how to build them
  4. Make contributions to the Cosmos Indexer Modules repo to support new chains

Resources

  1. Blockchain Indexing Explained
  2. Cosmos SDK Docs:
  3. cosmos-indexer repo - the main indexer implementation
  4. cosmos-indexer-modules - plug-and-play modules for supporting new chains
pharr117 commented 2 months ago

These downstream issues will be useful for starting references:

  1. https://github.com/DefiantLabs/cosmos-indexer-modules/issues/3
  2. https://github.com/DefiantLabs/cosmos-indexer-modules/issues/4
  3. https://github.com/DefiantLabs/cosmos-indexer-modules/issues/5