InjectiveLabs / sdk-python

Injective Exchange API for Python clients
Apache License 2.0
41 stars 27 forks source link

Fix/pagination next key #333

Closed aarmoa closed 4 months ago

aarmoa commented 4 months ago

Fixes CHAIN-123

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!IMPORTANT]

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (1) * `poetry.lock` is excluded by `!**/*.lock`

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update to version 1.5.3 of the project includes several key changes. The key parameter in the PaginationOption class was renamed to encoded_page_key, and the handling of pagination keys was adjusted to improve functionality. A new example file demonstrates making paginated requests with an async client, and tests were added to ensure the correct behavior of pagination features. Additionally, the project's version was updated in the configuration file.

Changes

File Path Change Summary
CHANGELOG.md Documented changes for version 1.5.3, including modifications to PaginationOption and pagination error fixes.
examples/chain_client/9_PaginatedRequestExample.py Introduced a new example for making paginated requests using an async client.
pyinjective/async_client.py Modified pagination key handling in initialize_tokens_from_chain_denoms method.
pyinjective/client/model/pagination.py Renamed key parameter to encoded_page_key in PaginationOption class and updated related logic.
pyproject.toml Updated project version from 1.5.2 to 1.5.3.
tests/client/chain/grpc/test_chain_grpc_auth_api.py Renamed key parameter to encoded_page_key in PaginationOption instantiation.
tests/client/model/test_pagination.py Added new tests for PaginationOption class.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ExampleScript as 9_PaginatedRequestExample.py
    participant AsyncClient as async_client.py
    participant PaginationOption as pagination.py
    participant Network as network.py

    User->>ExampleScript: Run script
    ExampleScript->>Network: Setup network
    ExampleScript->>AsyncClient: Fetch total supply (initial)
    AsyncClient->>PaginationOption: Create pagination request
    PaginationOption->>AsyncClient: Return paginated request
    AsyncClient->>ExampleScript: Return initial result
    loop Fetch subsequent pages
        ExampleScript->>AsyncClient: Fetch total supply (next page)
        AsyncClient->>PaginationOption: Create pagination request
        PaginationOption->>AsyncClient: Return paginated request
        AsyncClient->>ExampleScript: Return next page result
    end
    ExampleScript->>User: Display total supply data

Poem

In code we trust, with keys anew,
Paginated dreams come true,
Async flows and tests that gleam,
Version bumped, a coder's dream.
From Rabbit's warren, changes sprout,
A better path, there's no doubt.
🐇✨


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.