Skip to content

feat: adding hinkal private batch payments #1627

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nkoreli
Copy link
Contributor

@nkoreli nkoreli commented May 25, 2025

Add Batch Payment Support for Hinkal Shielded Addresses

Description

This PR introduces batch payment functionality for Hinkal shielded addresses, allowing users to send multiple payments to different recipients in a single transaction. This feature improves efficiency and reduces gas costs when making multiple private payments.

Key Changes

  • Added sendBatchPaymentsToHinkalShieldedAddressesFromPublic function to support batch payments
  • Implemented test coverage for batch payment functionality
  • Maintains privacy guarantees of Hinkal by ensuring recipient addresses remain shielded

Technical Details

  • The batch payment function accepts arrays of:
    • Token addresses
    • Payment amounts
    • Recipient shielded addresses
  • Uses Hinkal's multiSendPrivateRecipients under the hood
  • Includes proper balance checks and transaction verification
  • Maintains compatibility with existing single-payment functions

Testing

Added test case that verifies:

  • Successful batch payments to multiple recipients
  • Correct balance updates for all recipients
  • Privacy guarantees (recipient addresses remain shielded)
  • Transaction status and confirmation

Security Considerations

  • All privacy features of Hinkal are preserved
  • Recipient addresses remain shielded throughout the transaction
  • Proper validation of input parameters
  • Maintains existing security checks and balances

Jest Configuration Change

  • For our tests we condition typescript parameter isolatedModules to false
  • This change was necessary because:
    • When isolatedModules is true, Jest doesn't transpile dynamic import statements to CommonJS format and, as a result, Jest's VM sandbox uses experimental ES loader features which fail with our test setup
    • Setting isolatedModules to false ensures proper transpilation of dynamic imports for Jest testing

Copy link
Contributor

coderabbitai bot commented May 25, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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


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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

@MantisClone
Copy link
Member

Directionally, this PR looks fine to me 👍 I don't know if it satisfies the requirements 🤷

Before merging, we must show that the monthly CI tests complete successfully by manually triggering them. However, CircleCI is not configured for PRs from external forks. I must copy these changes into an internal branch.

@MantisClone MantisClone self-requested a review June 17, 2025 20:24
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