Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: proof result error for credit transfers in sdk #2451

Merged
merged 2 commits into from
Feb 4, 2025

Conversation

pauldelucia
Copy link
Member

@pauldelucia pauldelucia commented Feb 4, 2025

Issue being fixed or feature implemented

Credit transfers return a (PartialIdentity, PartialIdentity) but we were expecting a PartialIdentity.

What was done?

How Has This Been Tested?

DET

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
  • I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

  • I have assigned this pull request to a milestone

Summary by CodeRabbit

  • Refactor
    • Enhanced the credit transfer process to provide detailed information about both sender and receiver balances, maintaining consistent functionality for users.

Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

This change updates the transfer_credits method within the TransferToIdentity trait and its implementation for the Identity struct. The return type has been modified to return a tuple containing both sender and receiver balances. The result from the broadcast_and_wait call is now destructured into two PartialIdentity objects, allowing for detailed error handling and balance retrieval for both identities involved in the transfer.

Changes

File Change Summary
packages/rs-sdk/.../transfer.rs Updated transfer_credits in trait and Identity implementation to change return type to (u64, u64) and destructure the response from broadcast_and_wait for both sender and receiver balances.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant TransferCredits
    participant BroadcastAndWait

    Client->>TransferCredits: Call transfer_credits()
    TransferCredits->>BroadcastAndWait: Invoke broadcast_and_wait(...)
    BroadcastAndWait-->>TransferCredits: Return (sender, receiver) tuple
    TransferCredits->>TransferCredits: Extract sender.balance and receiver.balance
    TransferCredits-->>Client: Return (sender.balance, receiver.balance) result
Loading

Possibly related PRs

Suggested reviewers

  • shumkov
  • QuantumExplorer

Poem

I'm just a rabbit with a digital beat,
Hopping through code on nimble feet,
Transferring credits with a clever twist,
Now sender's balance can't be missed,
A byte-sized hop in our code's story,
Celebrating change in our new glory!
🐇💻

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9bfa5b and ac8f617.

📒 Files selected for processing (1)
  • packages/rs-sdk/src/platform/transition/transfer.rs (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Rust packages (dash-sdk) / Unused dependencies
  • GitHub Check: Rust packages (dash-sdk) / Tests
  • GitHub Check: Rust packages (dash-sdk) / Linting
  • GitHub Check: Rust packages (dash-sdk) / Check each feature
  • GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
  • GitHub Check: Build JS packages / Build JS
🔇 Additional comments (1)
packages/rs-sdk/src/platform/transition/transfer.rs (1)

48-48: LGTM!

The implementation signature correctly matches the trait definition.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@QuantumExplorer QuantumExplorer added this to the v2.0.0 milestone Feb 4, 2025
@QuantumExplorer QuantumExplorer merged commit 2b1c252 into v2.0-dev Feb 4, 2025
25 checks passed
@QuantumExplorer QuantumExplorer deleted the fix/sdk-credit-transfers branch February 4, 2025 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants