bigshortbets / indexer

Subsquid indexer aligned with P2P Market metadata
MIT License
1 stars 3 forks source link

Tasks #71

Closed TomaszGol closed 1 month ago

TomaszGol commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This update introduces new types and classes to manage market and historical market prices, alongside various utility improvements. Significant changes include the introduction of MarketPrices and HistoricalMarketPrice types to the GraphQL schema, the addition of new resolvers and providers for handling blockchain safe modes, and a refactor of the OraclePriceProvider class to leverage a new Provider class for API initialization.

Changes

File Change Summary
schema.graphql Added new types MarketPrices and HistoricalMarketPrice with fields id, price, timestamp, and market.
src/model/generated/index.ts Added export statement for "marketPrices.model".
src/model/generated/marketPrices.model.ts Introduced MarketPrices class representing market prices.
src/model/generated/historicalMarketPrice.model.ts Introduced HistoricalMarketPrice class representing historical market prices.
src/server-extension/resolvers/blockchainSafeModeResolver.ts Introduced BlockchainSafeMode and BlockchainSafeModeResolver classes for blockchain safe mode information.
src/server-extension/resolvers/playerLeaderboardPlace.ts Introduced PlayerLeaderBoardResolver class for retrieving player leaderboard places.
src/utils/blockchainSafeModeProvider.ts Introduced BlockchainSafeModeProvider class for interacting with blockchain API to retrieve safe mode info.
src/utils/oraclePriceProvider.ts Refactored to use Provider class for API initialization, modified method signature.
src/utils/provider.ts Introduced Provider class for setting up RPC connections and API initialization.
src/utils/userLeaderboardPlaceProvider.ts Introduced function getUserPlace to retrieve user position in a general leaderboard.
src/eventprocessor/market/marketRemovedEventProcessor.ts Modified query method to delete records from multiple tables related to specific market_id.

Sequence Diagrams

Market Prices Flow

sequenceDiagram
    participant Client
    participant GraphQLServer
    participant MarketPricesModel
    participant HistoricalMarketPriceModel

    Client->>GraphQLServer: Query MarketPrices
    GraphQLServer->>MarketPricesModel: Fetch current market prices
    MarketPricesModel-->>GraphQLServer: Return market prices
    GraphQLServer-->>Client: Return market prices

    Client->>GraphQLServer: Query HistoricalMarketPrice
    GraphQLServer->>HistoricalMarketPriceModel: Fetch historical market prices
    HistoricalMarketPriceModel-->>GraphQLServer: Return historical prices
    GraphQLServer-->>Client: Return historical prices

Poem

In fields of code where updates bloom,
New types and classes lift the gloom.
Market prices, safe modes too,
With these changes, skies turn blue.
APIs now with ease we steer,
A future bright, the path is clear.
🐇✨


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 Configration 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.