hoprnet / hopr-devrel

Projects related to support our users, node runners and developers
hopr-prompt.vercel.app
GNU General Public License v3.0
1 stars 12 forks source link

Token allocation subgraph #365

Closed jeandemeusy closed 2 months ago

jeandemeusy commented 5 months ago

This PR adds the implementation of a subgraph that indexes the HoprDistributor SC (0xB413a589ec21Cc1FEc27d1175105a47628676552), and retrieves all allocations and schedule by account.

PR ready for review, but not for deployment. A first draft deployment will be done first to test the returned data, after the review. If data returned conforms to Dune dashboard, the subgraph should be deployed with HOPR account.

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago
Walkthrough ## Walkthrough The project introduces a new subgraph, `subgraph-allocations`, designed to manage token allocations within the Hopr protocol. Key enhancements include a `.gitignore` file, a README for setup guidance, a comprehensive ABI for the `HoprDistributor` contract, TypeScript functions for event handling, and a GraphQL schema for data modeling. These additions streamline the development process and facilitate effective interaction with smart contract functionality. ## Changes | File Path | Change Summary | |-----------|----------------| | `subgraph/packages/subgraph-allocations/.gitignore` | Added to ignore logs, build artifacts, dependencies, caches, and environment-specific files. | | `subgraph/packages/subgraph-allocations/README.md` | Included instructions for installation, building, and deploying the subgraph for token allocations. | | `subgraph/packages/subgraph-allocations/abis/HoprDistributor.json` | Introduced ABI for managing token allocations and schedules within the `HoprDistributor` contract. | | `subgraph/packages/subgraph-allocations/package.json` | Defined scripts for code generation, building, deploying, and testing the subgraph. | | `subgraph/packages/subgraph-allocations/schema.graphql` | Added GraphQL type definitions for `Schedule`, `Allocation`, and `Account` entities. | | `subgraph/packages/subgraph-allocations/src/distributor.ts` | Introduced functions to handle allocation-related events from the `HoprDistributor` contract. | | `subgraph/packages/subgraph-allocations/src/utils.ts` | Imported `ethereum` from `@graphprotocol/graph-ts`. | | `subgraph/packages/subgraph-allocations/subgraph.yaml` | Configured Ethereum data source `HoprDistributor` with event mappings and handlers. | | `subgraph/packages/subgraph-allocations/tsconfig.json` | Extended base TypeScript configuration and specified directories for compilation. |

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
QYuQianchen commented 2 months ago

Updated implementation

jeandemeusy commented 2 months ago

Subgraph deployed using DevSafe and tested by CT.