feat: hardcoded identity transfers in strategy tests

[pauldelucia]

Issue being fixed or feature implemented

Changed StartIdentities hard_coded field so that the StateTransition is optional. This way we can easily use identities that already exist in the chain.

pub struct StartIdentities {
    pub number_of_identities: u16,
    pub keys_per_identity: u8,
    pub starting_balances: u64,
    pub extra_keys: KeyMaps,
    pub hard_coded: Vec<(Identity, Option<StateTransition>)>,
}

Also added handling for credit transfers where the sender and recipient are hardcoded, whereas before they were randomly selected from the known identities each time. This included optionally passing a new struct IdentityTransferInfo to OperationType::IdentityTransfer which specifies sender, recipient, and amount.

What was done?

How Has This Been Tested?

platform-tui

Breaking Changes

Checklist:

• [x] I have performed a self-review of my own code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] I have added or updated relevant unit/integration/functional/e2e tests
• [x] I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
• [x] 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

Summary by CodeRabbit

• New Features

  • Introduced new test cases for identity operations, including transfers and document handling.
  • Added a new structure, IdentityTransferInfo, to encapsulate identity transfer details.
  • Enhanced the flexibility of identity transfer operations by allowing specification of sender and recipient identities.
  • Updated identity insertion strategies to improve control over identity management during tests.

• Bug Fixes

  • Enhanced error handling and assertions in the testing framework for better validation of operations.

• Refactor

  • Modified existing tests and structures to improve data handling and enhance flexibility in identity management.
  • Updated method signatures to improve code clarity and maintainability.
  • Improved the handling of identity state transitions and dependencies in the code structure.

[coderabbitai[bot]]

Walkthrough

The pull request introduces significant updates to the testing framework for the run_chain_for_strategy function and related components. It adds new test cases, modifies existing ones, and enhances error handling and assertions across various test files. Changes also include updates to method signatures and data structures, particularly around identity transfers and state transitions. The modifications aim to improve the robustness and clarity of the tests and the underlying logic related to identity management and operations.

Changes

File Path	Change Summary
packages/rs-drive-abci/tests/strategy_tests/main.rs	- Added multiple new test cases for identity operations, including insertions and transfers. - Modified existing tests to include new parameters and logic changes. - Enhanced error handling and assertions. - Updated test configurations.
packages/rs-drive-abci/tests/strategy_tests/strategy.rs	- Removed import of instant_asset_lock_proof_fixture. - Updated identity_state_transitions_for_block method to use iterator with filter_map for handling identities. - Modified pattern matching for OperationType::IdentityTransfer.
packages/rs-drive-abci/tests/strategy_tests/voting_tests.rs	- Changed start_identities variable to define it as a vector of tuples (Identity, Option<StateTransition>) across multiple test functions, enhancing clarity.
packages/strategy-tests/src/lib.rs	- Updated hard_coded field in StartIdentities struct to allow optional StateTransition. - Modified identity_transfer operation in operations_based_transitions to accept an optional parameter.
packages/strategy-tests/src/operations.rs	- Introduced IdentityTransferInfo struct for identity transfer details. - Updated IdentityTransfer variant in OperationType to accept optional IdentityTransferInfo.
packages/strategy-tests/src/transitions.rs	- Changed create_identity_credit_transfer_transition function to accept an immutable reference for identity. - Added comments and documentation updates for clarity.

Possibly related PRs

• #2215: This PR introduces owner keys for identities, which is directly related to the changes in the main PR that involve identity transfer operations and the handling of identity management.
• #2234: This PR adds a parameter for specifying the signing withdrawal key in the withdrawal SDK call, which aligns with the changes in the main PR regarding identity transfer and management.
• #2289: This PR implements a transfer transition in the SDK, which is closely related to the modifications in the main PR that enhance identity transfer operations.

Suggested labels

enhancement, rs-sdk

Suggested reviewers

• shumkov
• QuantumExplorer

🐇 "In the realm of code, we hop and play,
New tests and changes brighten the day.
With identities dancing, transfers in sight,
Our functions now shine, oh what a delight!
So let’s celebrate this code we adore,
With each little change, we discover much more!" 🐇

---

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc0a653de328adacae4e8e85ab6971c42984786 and dc4882725f6ed6f7a6e4bc8835d84d95bd4ec41f.

📒 Files selected for processing (1)

* `packages/strategy-tests/src/transitions.rs` (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* packages/strategy-tests/src/transitions.rs

---

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 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.