feat: wasm sdk build proof-of-concept

[lklimek]

Issue being fixed or feature implemented

To make some decisions about direction in which we should move,
we need to validate if it's possible and reasonable to create WASM
bindings for Rust Dash SDK.

What was done?

1. Adjusted features to work with wasm32
2. Implemented WASM transport and other WASM-specific logic

How Has This Been Tested?

Created simple test web page in packages/wasm-sdk/index.html that tests SDK.

Note: It requires hardcoding quorums in packages/wasm-sdk/src/context_provider.rs.

Breaking Changes

TODO

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

  • Enhanced WebAssembly SDK with new methods for identity and data contract management, including interactive UI elements.
  • Added capabilities for secure context configuration and improved data verification.

• Refactor

  • Streamlined configuration and dependency management to optimize build pipelines and gRPC client performance across different architectures.
  • Updated build and optimization scripts for WebAssembly targets.

• Tests

  • Adjusted online connectivity tests to run conditionally, ensuring robust platform interactions.

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• Cargo.lock is excluded by !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

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

Walkthrough

This pull request introduces configuration and dependency updates across multiple packages to support the WebAssembly target and improve architecture‐specific behavior. New Rust flags have been added for the wasm32-unknown-unknown target in Cargo configuration files, experimental workspace exclusions have been set, and various crate feature adjustments have been made. It also restructures feature dependencies, improves error handling and conditional compilation, and adds new modules and functions for a WebAssembly SDK with enhanced identity, data contract, and gRPC transport capabilities.

Changes

File(s)	Change Summary
.cargo/config.toml, .cargo/config-release.toml	Added new target configuration for wasm32-unknown-unknown with rustflags = ['--cfg', 'getrandom_backend="wasm_js"'].
Cargo.toml (workspace)	Added an exclude = ["packages/wasm-sdk"] entry to omit the experimental wasm-sdk package.
packages/dapi-grpc/Cargo.toml, packages/dapi-grpc/build.rs	Simplified feature dependencies (client/server/serde changes) and introduced a new ImplType enum with methods for code generation based on implementation type.
packages/dapi-grpc/src/lib.rs	Modified conditional compilation attributes to exclude server/client files on the wasm target and include wasm-specific modules.
packages/js-dapi-client/package.json	Added the "dist" directory to the published files list.
packages/rs-dapi-client/**	Updated import sources for Uri, added an optional CA certificate field and a corresponding setter in DapiClient, revised ExecutionError equality logic, introduced conditional exports and modules (tonic_channel and wasm_channel), and implemented a new transport request for masternode list.
packages/rs-dpp/**	Adjusted dependency configurations (made some dependencies optional, updated features), modified conditional compilation (e.g. BLS-signatures), added a conversion module, and updated method signatures to conditionally include parameters.
packages/rs-drive-abci/**	Updated dependencies (e.g. tenderdash-abci, dapi-grpc, bls-signatures) and renamed time conversion methods from to_milis() to to_millis(), adding error mapping for invalid timestamps in block proposals and chain initialization.
packages/rs-drive-proof-verifier/**	Restructured dependency features (disabling default features, removing optional flags) and added an encoding method to serialize ContestedResource.
packages/rs-drive/Cargo.toml	Revised the dpp dependency declaration to include the explicit package name attribute.
packages/rs-platform-value/**	Removed regex and lazy_static dependencies; reworked the is_array_path function to use string operations instead of regex with corresponding test updates.
packages/rs-sdk/**	Updated dependency features (e.g., tokio), added a new method set_context_provider in Sdk, made asynchronous functions like parse_proof_with_metadata_and_proof public, and extended SdkBuilder with a CA certificate option. Also updated the synchronous block_on function for wasm targets and refined retry logic.
packages/wasm-dpp/**	Modified the crate type in Cargo.toml to include rlib and enhanced the wasm optimization command in the build script with additional flags.
packages/wasm-sdk/**	Introduced a new experimental WebAssembly SDK package: a new Cargo.toml configuration, build script (build.sh), demo HTML interface (index.html), and multiple source files (e.g. context_provider.rs, dpp.rs, error.rs, lib.rs, sdk.rs, state transitions, and verification modules) that wrap platform functionality for Wasm integration.
packages/rs-dapi-client/tests/local_platform_connectivity.rs	Changed conditional compilation from offline-testing to online-testing; updated address list initialization, client mutability, and access to execution results.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant UI as Web UI (index.html)
    participant B as WasmSdkBuilder
    participant S as WasmSdk
    participant CP as WasmContext
    U->>UI: Enter Identity/DataContract ID
    UI->>B: Initialize SDK (new_mainnet/new_testnet)
    B-->>S: Build WasmSdk instance
    U->>S: Set context provider (set_context_provider)
    U->>S: Call identity_fetch/data_contract_fetch
    S->>S: Process request asynchronously
    S-->>U: Return IdentityWasm/DataContractWasm result

Loading

Possibly related PRs

• perf(dpp): reduce JS binding size by 3x #2396: This PR relates at a code-level by addressing WebAssembly configuration and optimization aspects similar to those in the current pull request.

Suggested reviewers

• shumkov
• QuantumExplorer

Poem

I’m a hopping rabbit in a code-filled glen,
Leaping through configs and features again.
With wasm tuned and Rust flags set,
I dance on bytes without a fret.
In fields of functions I joyously roam,
Celebrating new code that feels like home!
🐇💻

---

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
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/dapi-grpc/build.rs (2)

256-263: Consider using constants for directory names.

The directory name strings could be defined as constants to avoid duplication and make updates easier.

 enum ImplType {
     Server,
     Client,
     Wasm,
 }

+const SERVER_DIR: &str = "server";
+const CLIENT_DIR: &str = "client";
+const WASM_DIR: &str = "wasm";
+
 impl ImplType {
     // ... configure method ...

     fn dirname(&self) -> String {
         match self {
-            Self::Server => "server",
-            Self::Client => "client",
-            Self::Wasm => "wasm",
+            Self::Server => SERVER_DIR,
+            Self::Client => CLIENT_DIR,
+            Self::Wasm => WASM_DIR,
         }
         .to_string()
     }
 }

---

268-276: Update documentation to include the new parameter.

The function documentation needs to be updated to include information about the typ parameter.

 /// Create a new MappingConfig instance.
 ///
 /// ## Arguments
 ///
 /// * `protobuf_file` - Path to the protobuf file to use as input.
 /// * `out_dir` - Output directory where subdirectories for generated files will be created.
+/// * `typ` - Implementation type that determines the build configuration and output directory.
 ///
-/// Depending on the features, either `client`, `server` or `client_server` subdirectory
+/// Depending on the implementation type, either `client`, `server` or `wasm` subdirectory
 /// will be created inside `out_dir`.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8993532 and 444014f.

📒 Files selected for processing (1)

• packages/dapi-grpc/build.rs (5 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (19)

• GitHub Check: Rust packages (drive-abci) / Detect immutable structure changes
• GitHub Check: Rust packages (drive-abci) / Check each feature
• GitHub Check: Rust packages (drive) / Tests
• GitHub Check: Rust packages (drive) / Unused dependencies
• GitHub Check: Rust packages (drive) / Linting
• GitHub Check: Rust packages (dpp) / Unused dependencies
• GitHub Check: Rust packages (dpp) / Tests
• GitHub Check: Rust packages (dpp) / Linting
• 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: Rust packages (dapi-grpc) / Check each feature
• GitHub Check: Rust packages (dapi-grpc) / Linting
• GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
• 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 JS packages / Build JS

🔇 Additional comments (3)

packages/dapi-grpc/build.rs (3)

15-27: LGTM! Well-structured implementation for handling different targets.

The main function effectively handles Server, Client, and Wasm implementations using feature flags and target architecture checks.

---

29-53: LGTM! Clean implementation of the code generation logic.

The function effectively handles code generation for both core and platform protos while maintaining proper error handling and build dependencies.

---

229-264: LGTM! Well-designed enum for handling different implementation types.

The ImplType enum and its methods provide a clean and type-safe way to handle different implementation configurations.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (8)

packages/rs-dpp/src/data_contract/document_type/class_methods/try_from_schema/v0/mod.rs (3)

725-725: Consider breaking down this large function.

The TODO comment correctly identifies that this function is quite large. Consider breaking it down into smaller, more focused functions:

• Schema reference resolution
• Type parsing and validation
• Nested property handling

---

749-795: Document the planned integer type refinements.

The commented-out code suggests future plans for more granular integer type handling. Consider:

1. Adding a TODO with a tracking issue for this enhancement.
2. Documenting the version in which this refinement is planned.

---

587-921: Reduce code duplication between property insertion functions.

The insert_values and insert_values_nested functions share similar logic for type parsing and validation. Consider:

1. Extracting common type parsing and validation logic into shared utility functions.
2. Creating a trait or enum to abstract the property storage strategy (flat vs. nested).

Example approach:

// Shared type parsing
fn parse_property_type(
    inner_properties: &BTreeMap<&str, &Value>,
    root_schema: &Value,
) -> Result<DocumentPropertyType, DataContractError> {
    // Common type parsing logic
}

// Strategy trait
trait PropertyStorage {
    fn store_property(
        &mut self,
        key: String,
        property: DocumentProperty,
    ) -> Result<(), DataContractError>;
}

// Implementations for flat and nested storage
struct FlatStorage(IndexMap<String, DocumentProperty>);
struct NestedStorage(IndexMap<String, DocumentProperty>);

packages/dapi-grpc/build.rs (3)

21-24: Improve error handling for target architecture check.

The current error handling using unwrap_or_default() could be more explicit about the fallback case.

Consider this alternative implementation:

-    if std::env::var("CARGO_CFG_TARGET_ARCH")
-        .unwrap_or_default()
-        .eq("wasm32")
+    if std::env::var("CARGO_CFG_TARGET_ARCH")
+        .map(|arch| arch == "wasm32")
+        .unwrap_or(false)

---

237-242: Consider removing unnecessary #[allow(unused)] attribute.

The ImplType enum is actively used in the code, so the #[allow(unused)] attribute appears to be unnecessary.

-#[allow(unused)]
 enum ImplType {
     Server,
     Client,
     Wasm,
 }

---

276-284: Update documentation to include the new typ parameter.

The function documentation needs to be updated to include information about the new typ parameter.

 /// Create a new MappingConfig instance.
 ///
 /// ## Arguments
 ///
 /// * `protobuf_file` - Path to the protobuf file to use as input.
 /// * `out_dir` - Output directory where subdirectories for generated files will be created.
+/// * `typ` - The implementation type that determines how the code is generated.
 ///
 /// Depending on the features, either `client`, `server` or `client_server` subdirectory
 /// will be created inside `out_dir`.

packages/rs-dpp/Cargo.toml (2)

125-148: Dash-SDK Features Configuration Review

Within the dash-sdk-features list, several features (e.g., "json-object", "platform-value", "system_contracts", etc.) remain commented out, while others (such as "identity-hashing", "data-contract-json-conversion", and "state-transition-value-conversion") are active. Please double-check that the removal (especially of "platform-value") and commenting-out of features are intentional and consistently reflected across the codebase. Clear documentation or a follow-up cleanup might also help avoid confusion later on.

---

212-213: Typo and New Feature Flag Review

• The comment on line 212 contains a typo ("Tring" should be "Trying").
• Additionally, the feature create-contested-document is introduced. Verify that its naming accurately reflects its intended functionality (i.e., confirm that “contested” is correct and not meant to be “consented” or another term).

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6fc1c38 and 977d6e0.

⛔ Files ignored due to path filters (1)

• Cargo.lock is excluded by !**/*.lock

📒 Files selected for processing (7)

• Cargo.toml (1 hunks)
• packages/dapi-grpc/build.rs (5 hunks)
• packages/rs-dpp/Cargo.toml (5 hunks)
• packages/rs-dpp/src/balances/credits.rs (0 hunks)
• packages/rs-dpp/src/data_contract/document_type/class_methods/try_from_schema/v0/mod.rs (1 hunks)
• packages/rs-dpp/src/data_contract/mod.rs (1 hunks)
• packages/rs-dpp/src/lib.rs (0 hunks)

💤 Files with no reviewable changes (2)

• packages/rs-dpp/src/lib.rs
• packages/rs-dpp/src/balances/credits.rs

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

• Cargo.toml
• packages/rs-dpp/src/data_contract/mod.rs

⏰ Context from checks skipped due to timeout of 90000ms (19)

• 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) / Tests
• GitHub Check: Rust packages (dash-sdk) / Linting
• GitHub Check: Rust packages (dash-sdk) / Check each feature
• GitHub Check: Rust packages (dapi-grpc) / Tests
• GitHub Check: Rust packages (dapi-grpc) / Check each feature
• GitHub Check: Rust packages (dapi-grpc) / Linting
• 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 Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
• GitHub Check: Build JS packages / Build JS

🔇 Additional comments (7)

packages/dapi-grpc/build.rs (1)

29-53: LGTM!

The generate_code function is well-structured and properly handles both core and platform proto generation with appropriate error messages and cargo directives.

packages/rs-dpp/Cargo.toml (6)

59-60: Optional Decimal Dependencies Update

rust_decimal and rust_decimal_macros have been marked as optional. This change enhances flexibility by allowing users to enable these dependencies only when needed. Please ensure that all code which requires them is properly gated behind feature flags.

---

63-63: Marking JSON Schema Compatibility Validator as Optional

The json-schema-compatibility-validator dependency is now optional. Verify that any functionality relying on it activates the respective feature flag so that builds without this dependency don’t break.

---

73-74: Dev Dependencies Version Update for Logging

The versions for env_logger and log in the dev-dependencies have been updated (with env_logger explicitly added and log updated to version 0.4.22). Please confirm that the versions are aligned with production usage if applicable, or if any conflicts might arise in test runs.

---

77-77: Default Feature Modification

The default feature has been updated to only include "state-transitions", thereby removing "platform-value". This change aligns with the overall objective to deprecate platform-value in defaults. Ensure that consumers who previously relied on the broader default set are updated accordingly or are aware of this behavioral change.

---

216-220: JSON Schema-Validation Feature Expansion

The json-schema-validation feature now includes "jsonschema", "platform-value-json", and "dep:json-schema-compatibility-validator". This appears consistent with the updated dependency configuration. Please ensure that the inclusion of the optional json-schema-compatibility-validator is accounted for in any conditional builds or feature tests.

---

291-291: Fee Distribution Feature Dependency Mapping

The fee-distribution feature now depends on "dep:rust_decimal" and "dep:rust_decimal_macros", which aligns with making those dependencies optional earlier. Confirm that any modules using fee-distribution logic correctly handle the scenario when these features are enabled.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/rs-dpp/src/tokens/token_event.rs (1)

33-52: Consider adding documentation for the Transfer variant.

The TokenEvent enum is well-structured with appropriate derive macros. The Transfer variant's parameter ordering is logical, placing required fields before optional ones.

Add documentation for the Transfer variant to clarify the purpose of each parameter:

 pub enum TokenEvent {
+    /// Transfers tokens from one identity to another
+    /// * `recipient_id` - The identifier of the recipient
+    /// * `public_note` - Optional public note visible to all
+    /// * `shared_encrypted_note` - Optional encrypted note shared between sender and recipient
+    /// * `personal_encrypted_note` - Optional personal encrypted note
+    /// * `amount` - The amount of tokens to transfer
     Transfer(
         RecipientIdentifier,
         TokenEventPublicNote,
         TokenEventSharedEncryptedNote,
         TokenEventPersonalEncryptedNote,
         TokenAmount,
     ),

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 977d6e0 and 70d9192.

📒 Files selected for processing (1)

• packages/rs-dpp/src/tokens/token_event.rs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (18)

• GitHub Check: Rust packages (drive-abci) / Tests
• GitHub Check: Rust packages (drive-abci) / Linting
• GitHub Check: Rust packages (drive-abci) / Formatting
• GitHub Check: Rust packages (drive) / Tests
• GitHub Check: Rust packages (drive-abci) / Check each feature
• GitHub Check: Rust packages (drive) / Unused dependencies
• GitHub Check: Rust packages (drive) / Linting
• GitHub Check: Rust packages (dpp) / Unused dependencies
• GitHub Check: Rust packages (dpp) / Tests
• GitHub Check: Rust packages (dpp) / Linting
• 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: Rust packages (dapi-grpc) / Linting
• GitHub Check: Build Docker images (Drive, drive, drive-abci) / Build Drive image
• 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 JS packages / Build JS

🔇 Additional comments (2)

packages/rs-dpp/src/tokens/token_event.rs (2)

128-134: LGTM! Encrypted note handling is well-implemented.

The implementation correctly maps the shared encrypted note fields to document properties, maintaining consistency with the existing pattern.

---

17-18:

✅ Verification successful

LGTM! Verify feature flag usage across the codebase.

The conditional compilation for WASM support is well-structured. The new type and import are correctly gated behind the state-transitions feature flag.

Let's verify the consistent usage of this feature flag:

Also applies to: 25-26

---

🏁 Script executed:

#!/bin/bash
# Description: Check for consistent usage of state-transitions feature flag
# across the codebase, particularly for SharedEncryptedNote.

# Search for SharedEncryptedNote usage
rg "SharedEncryptedNote" -A 3 -B 3

# Search for state-transitions feature usage
rg "#\[cfg\(feature\s*=\s*\"state-transitions\"\)\]" -A 3 -B 3

Length of output: 76484

---

Conditional Compilation for WASM Support – LGTM!

The new type definition TokenEventSharedEncryptedNote in packages/rs-dpp/src/tokens/token_event.rs is properly guarded by the state-transitions feature flag. The grep results show consistent usage of both SharedEncryptedNote and the feature flag across the codebase (with relevant occurrences in other modules confirming that this gating strategy is maintained). No issues were found with conditional compilation or integration with dependent code.