search

bigshortbets / indexer

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

margin-data-endpoints #59

Closed Mkurowski03 closed 1 month ago

Mkurowski03 commented 1 month ago

give-a-try version

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This update enhances margin data handling and dependencies in a codebase. It includes adding new resolver classes (MarginDataResolver and MarginResolver) for better querying of margin data, modifications to utility functions for improved data conversions, and updates to dependencies in the package.json file for improved compatibility and performance.

Changes

File Change Summary
package.json Updated several dependencies (@subsquid/substrate-processor, @subsquid/typeorm-store, typeorm, @types/node).
src/server-extension/resolvers/index.ts Added MarginDataResolver and MarginResolver to exported resolvers.
src/server-extension/resolvers/marginDataResolver.ts Introduced MarginDataResolver class with getMarginData method.
src/server-extension/resolvers/marginResolver.ts Introduced MarginResolver class with getMargin method.
src/utils/index.ts Added MarginDataProvider to existing exports.
src/utils/encodersUtils.ts Minor modification in convertStringValueToHexBigEndian function.
src/utils/marginDataProvider.ts Introduced MarginDataProvider class with getMarginDataForMarket method changes.
src/utils/marginProvider.ts New MarginProvider class focused on margin data retrieval and handling.
tsconfig.json Added "types": ["node"] under compiler options.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MarginResolver
    participant MarginDataProvider
    participant MarginApi

    User ->> MarginResolver: Request margin data
    MarginResolver ->> MarginDataProvider: getMarginDataForMarket(marketId, walletAddress)
    MarginDataProvider ->> MarginApi: Fetch margin data from API
    MarginApi -->> MarginDataProvider: Return margin data
    MarginDataProvider -->> MarginResolver: Return processed margin data
    MarginResolver -->> User: Return margin data

    User ->> MarginDataResolver: Request additional margin info
    MarginDataResolver ->> MarginProvider: getMarginForMarket(marketId, walletAddress)
    MarginProvider ->> MarginApi: Fetch additional margin info
    MarginApi -->> MarginProvider: Return extra margin info
    MarginProvider -->> MarginDataResolver: Return processed info
    MarginDataResolver -->> User: Return additional margin info

Poem

In code's vast and tangled weave,
Upgrades glitter, freshly sieved. 🌟
Margins now so clear, pristine,
Resolvers in their code convene.
Dependencies renewed, aligned,
In our quest, new paths we find! 🚀

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.
Klapeyron commented 1 month ago

followed in https://github.com/bigshortbets/indexer/pull/75, thanks!