platform icon indicating copy to clipboard operation
platform copied to clipboard

chore(sdk): various sdk fixes

Open QuantumExplorer opened this issue 1 year ago • 1 comments

Issue being fixed or feature implemented

What was done?

How Has This Been Tested?

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

  • New Features

    • Introduced an address generation method for improved identity key management.
    • Enhanced query capabilities by adding support for voting, polling, and robust document queries.
    • Added a new withdrawal tracking schema to better document transaction details.
    • Improved RPC client resilience with a robust retry strategy and clearer error reporting.
  • Refactor

    • Made minor formatting updates and refinements to error handling for a more consistent experience.

QuantumExplorer avatar Nov 13 '24 08:11 QuantumExplorer

Walkthrough

This pull request introduces several improvements across multiple packages. In the rs-dpp package, a minor formatting adjustment was made, and new public methods and error variants were added with updated type signatures. In the rs-drive-abci package, logging was enhanced and BLS key generation was modified. The rs-drive package now includes new query modules, enriched test cases, and a new JSON schema for withdrawals. Additionally, the rs-sdk package received new error constants, a retry macro implementation for RPC calls, and removed extraneous debug logs.

Changes

File(s) Change Summary
rs-dpp/Cargo.toml; rs-dpp/src/errors/protocol_error.rs; rs-dpp/src/identity/identity_public_key/methods/{hash,hash/v0,v0/methods}/mod.rs • Cargo.toml: Minor formatting fix for ordered-float dependency.
• protocol_error.rs: Added BlsError variant with transparent wrapping.
• Identity public key modules: Added address method and updated validate_private_key_bytes parameter from slice to fixed array.
rs-drive-abci/src/query/document_query/v0/mod.rs; rs-drive-abci/tests/strategy_tests/masternodes.rs • Document query: Introduced a new logging statement for drive_query.
• Masternodes tests: Updated import and modified BLS key generation to use an explicit implementation.
rs-drive/src/query/mod.rs; rs-drive/tests/query_tests.rs; rs-drive/tests/supporting_files/contract/withdrawals/withdrawals.json • Query mod: Added new query modules, a ContractLookupFn type, a helper function, and new structs for query handling.
• Query tests: Added new tests for various query scenarios with null IDs.
• Withdrawals JSON: Introduced a new schema for withdrawal documents.
rs-sdk/src/core/dash_core_client.rs; rs-sdk/src/core/transaction.rs • Dash Core Client: Added three new error constants and a retry! macro; updated method signatures to return ContextProviderError.
• Transaction: Removed tracing debug logs from the asset lock proof waiting method.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant IdentityPublicKey
    participant V0Implementation
    Caller->>IdentityPublicKey: address(network)
    IdentityPublicKey->>V0Implementation: Delegate call to V0 variant
    V0Implementation-->>IdentityPublicKey: Return Address or ProtocolError
    IdentityPublicKey-->>Caller: Return result
sequenceDiagram
    participant Caller
    participant DashCoreClient
    participant RPCServer
    Caller->>DashCoreClient: get_balance() call
    DashCoreClient->>RPCServer: Make RPC call for balance
    alt transient error occurs
        RPCServer-->>DashCoreClient: Return transient error
        DashCoreClient->>DashCoreClient: Retry with Fibonacci backoff
        DashCoreClient->>RPCServer: Retry RPC call
    end
    RPCServer-->>DashCoreClient: Return successful result
    DashCoreClient-->>Caller: Return balance or ContextProviderError

Suggested reviewers

  • QuantumExplorer
  • shumkov

Poem

Oh, how I hop with glee,
New methods and types for all to see,
BLS errors and queries align,
Code carrots crunching, oh so fine,
With bug bops and retry hops in the night,
I dance in code fields under digital light!
🐇💻✨


📜 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 994f7627080e4ab490f1dbf0f09c0fb37d0fbbb0 and ee9d96499697f1783e6bccf5aa218a5c35c563a0.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (1)
  • packages/rs-dpp/Cargo.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/rs-dpp/Cargo.toml
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: Rust packages (drive-abci) / Formatting
  • GitHub Check: Rust packages (drive-abci) / Check each feature
  • GitHub Check: Rust packages (drive) / Unused dependencies
  • GitHub Check: Rust packages (drive) / Tests
  • GitHub Check: Rust packages (drive) / Linting
  • GitHub Check: Rust packages (drive) / Formatting
  • GitHub Check: Rust packages (dpp) / Unused dependencies
  • GitHub Check: Rust packages (dpp) / Tests
  • GitHub Check: Rust packages (dpp) / Linting
  • GitHub Check: Rust packages (dpp) / Formatting
  • GitHub Check: Rust packages (dpp) / Check each feature
  • 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 (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
  • GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
  • GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
  • GitHub Check: Build JS packages / Build JS

🪧 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.
  • @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 Nov 13 '24 08:11 coderabbitai[bot]

Became Stale.

QuantumExplorer avatar Sep 03 '25 16:09 QuantumExplorer