search

osmosis-labs / osmosis-frontend

Web interface for Osmosis Zone
https://app.osmosis.zone/
Apache License 2.0
230 stars 416 forks source link

Use Skip API key with tx status endpoints #3849

Closed jonator closed 2 weeks ago

jonator commented 2 weeks ago

What is the purpose of the change:

Linear Task

This PR refactors the Skip TransferStatusProvider to dep-inject the tx status and track endpoints so that we can create serverless functions that utilize the credentialed SkipApiClient on the server.

Also, I refactored the trackTransaction POST call to skip to be within a catch clause instead of a try catch statement. This makes it slightly more readable as there's less jumping around when interpreting the logic related to prompting Skip to track transactions before continuing the polling.

Brief Changelog

Testing and Verifying

Tested locally with Skip transfers in the deposit/withdraw flow, verifying that conclusive statuses can be received from Skip.

vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
osmosis-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 1:04am
4 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **osmosis-frontend-datadog** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-frontend-datadog/4TiNUXynKrdqSvT5Aka8F1UpHu3s)) | [Visit Preview](https://osmosis-frontend-datadog-git-jon-skip-status-api-key-osmo-labs.vercel.app) | | Sep 19, 2024 1:04am | | **osmosis-frontend-dev** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-frontend-dev/7UiConi1AuCyrvm5Db6rg2Lss6hQ)) | [Visit Preview](https://osmosis-frontend-dev-git-jon-skip-status-api-key-osmo-labs.vercel.app) | | Sep 19, 2024 1:04am | | **osmosis-frontend-edgenet** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-frontend-edgenet/3Jzg1AwgeJLsGriBNVeiy2Q7j2wC)) | | | Sep 19, 2024 1:04am | | **osmosis-testnet** | ⬜️ Ignored ([Inspect](https://vercel.com/osmo-labs/osmosis-testnet/4gJjQ4xtC3ycGztom7kaDkQEkhYm)) | [Visit Preview](https://osmosis-testnet-git-jon-skip-status-api-key-osmo-labs.vercel.app) | | Sep 19, 2024 1:04am |
coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes introduce a new interface, SkipStatusProvider, which includes methods for tracking and retrieving transaction statuses. The SkipTransferStatusProvider class is modified to use this interface instead of directly depending on SkipApiClient. This enhances the modularity and error handling of transaction status retrieval. Additionally, the overall structure of the polling function is maintained while improving the separation of concerns within the codebase.

Changes

Files Change Summary
packages/bridge/src/skip/transfer-status.ts Introduced SkipStatusProvider interface with methods for tracking and retrieving transaction status. Modified SkipTransferStatusProvider to accept SkipStatusProvider in its constructor, enhancing error handling and modularity.

Possibly related PRs

Suggested reviewers

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between e0bc08dffe7366c66a9e0e4b385abe0cb1248325 and 2e771be9ab575093fd28fe03cb6529a5207d1f8a.
Files selected for processing (1) * packages/bridge/src/skip/transfer-status.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1) * packages/bridge/src/skip/transfer-status.ts
--- 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 , please review it.` -- `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 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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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.