chore: fix types #736
chore: fix types #736
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @nakul1010, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refines the naming conventions for parameters related to offramp order creation within the gateway client and its associated type definitions. The changes aim to improve code clarity and maintainability by adopting more concise and consistent terminology for these properties.
Highlights
- Type Renaming: Renamed the
orderCreationDeadlineproperty tocreationDeadlineandorderOwnertoownerwithin theOfframpCreateOrderParamstype definition and its corresponding usage in theGatewayApiClient.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request renames two properties, orderCreationDeadline to creationDeadline and orderOwner to owner, across the codebase to fix type definitions. The changes in sdk/src/gateway/client.ts and sdk/src/gateway/types.ts are correct and consistent. However, the test file sdk/test/gateway.test.ts has not been fully updated to reflect these changes, which could lead to test failures. I've provided a suggestion to fix the test.
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughField names in OfframpCreateOrderParams.offrampArgs were renamed: orderCreationDeadline → creationDeadline and orderOwner → owner. The SDK client’s createOfframpOrder call and corresponding tests were updated to use the new names. No other logic or structure changes were introduced. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
sdk/src/gateway/types.ts (1)
435-436: Clarify units in JSDoc for creationDeadline.Add “(unix seconds)” to match OfframpQuote.deadline docs and avoid ms/sec confusion.
- /** @dev Timestamp by which the order must be created */ + /** @dev Timestamp by which the order must be created (unix seconds) */ creationDeadline: bigint;sdk/test/gateway.test.ts (1)
470-477: Avoid reflexive equality on dynamic creationDeadline.Assert type/value shape and separately check the dynamic field.
- expect(result.offrampArgs[0]).to.deep.equal({ - satAmountToLock: BigInt('10'), - satFeesMax: BigInt('100'), - creationDeadline: result.offrampArgs[0].creationDeadline, // timestamp is dynamic - outputScript: '0x1600149d5e60f3b5cc2d246f990692ee4b267d1cd58477', - token: '0xda472456b1a6a2fc9ae7edb0e007064224d4284c', - owner: '0xFAEe001465dE6D7E8414aCDD9eF4aC5A35B2B808', - }); + expect(result.offrampArgs[0]).to.include({ + satAmountToLock: BigInt('10'), + satFeesMax: BigInt('100'), + outputScript: '0x1600149d5e60f3b5cc2d246f990692ee4b267d1cd58477', + token: '0xda472456b1a6a2fc9ae7edb0e007064224d4284c', + owner: '0xFAEe001465dE6D7E8414aCDD9eF4aC5A35B2B808', + }); + expect(typeof result.offrampArgs[0].creationDeadline).toBe('bigint');
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
sdk/src/gateway/client.ts(1 hunks)sdk/src/gateway/types.ts(1 hunks)sdk/test/gateway.test.ts(1 hunks)
🧰 Additional context used
🪛 Gitleaks (8.27.2)
sdk/test/gateway.test.ts
475-475: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (4)
sdk/src/gateway/types.ts (1)
435-442: Rename to creationDeadline/owner looks correct and consistent.Types align with usage in client and tests; no issues spotted.
sdk/src/gateway/client.ts (2)
413-417: Field wiring LGTM.creationDeadline is correctly derived as BigInt(quote.deadline); owner sourced from fromUserAddress matches the new type.
410-418: No stale identifiers remain. Verified that searches fororderCreationDeadlineandorderOwnerreturned no matches.sdk/test/gateway.test.ts (1)
473-477: Test updates match the new type names.creationDeadline/owner assertions are now consistent with the SDK types.
Summary by CodeRabbit
Refactor
Tests