platform icon indicating copy to clipboard operation
platform copied to clipboard

test: enable withdrawals in test suite

Open shumkov opened this issue 1 year ago • 1 comments

Issue being fixed or feature implemented

We would like to test withdrawals with test suite

What was done?

  • Enabled withdrawal tests
  • Updated to recent SDK changes

How Has This Been Tested?

Running test suite

Breaking Changes

None

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

shumkov avatar Oct 03 '24 09:10 shumkov

Walkthrough

The pull request introduces changes to the creditWithdrawal function in the creditWithdrawal.ts file, specifically modifying how the options parameter is handled by adjusting the order of operations. Additionally, it re-enables the withdrawal test suite in the withdrawals.spec.js file, updates the initial balance for identities, and modifies how the withdrawal address is passed in tests. The overall logic and structure of both the function and tests remain intact, focusing on improving clarity and functionality without altering existing behaviors.

Changes

File Path Change Summary
packages/js-dash-sdk/src/SDK/Client/Platform/methods/identities/creditWithdrawal.ts Modified the creditWithdrawal function to reorder handling of the options parameter, ensuring defaults can be overridden.
packages/platform-test-suite/test/e2e/withdrawals.spec.js Re-enabled the Withdrawals test suite, increased initial balance from 1,000,000 to 2,000,000, and updated withdrawal address handling.

Possibly related issues

  • dashpay/platform#2101: The changes in this PR contribute to enabling withdrawals, which is a key objective of this issue.
  • dashpay/platform#2204: The re-enabling of the withdrawal test suite aligns with the goal of enabling withdrawal tests as described in this issue.

Possibly related PRs

  • #2201: This PR modifies the same creditWithdrawal function, focusing on the handling of the options parameter, which is directly related to the changes made in this PR.
  • #2191: This PR refactors the withdrawal amount validation, which is related to the overall withdrawal process and may impact the tests in the main PR that validate withdrawal scenarios.
  • #2203: Although this PR focuses on improving logging for withdrawal transactions, it is related to the withdrawal process and could provide context for the tests in the main PR that deal with withdrawal functionalities.

Suggested labels

enhancement, js-sdk

Suggested reviewers

  • lklimek
  • QuantumExplorer
  • pshenmic

Poem

🐇 In the meadow where bunnies play,
Changes hop in a joyful way.
With withdrawals now clear and bright,
Our code dances in the light!
Options reorder, tests anew,
Hopping forward, we bid adieu! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 03ad26f04f83216f80e588b2fe7376e6459dab50 and d964ee9b1e4275516371b33f2c29f62ba70f3db3.

📒 Files selected for processing (1)
  • packages/platform-test-suite/test/e2e/withdrawals.spec.js (7 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/platform-test-suite/test/e2e/withdrawals.spec.js

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 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.

coderabbitai[bot] avatar Oct 03 '24 09:10 coderabbitai[bot]