feat(sdk): make wasm sdk complete for all state transitions and most queries #2690
Conversation
WalkthroughThis update introduces a comprehensive WebAssembly (WASM) interface for the Dash SDK, adding modules for querying platform data (identities, contracts, documents, tokens, epochs, groups, voting, system, protocol) and performing state transitions (contracts, documents, identity, tokens). It also enhances thread safety, dependency management, documentation, and service worker caching for the WASM SDK. Changes
Sequence Diagram(s)sequenceDiagram
participant JS as JavaScript (WASM Consumer)
participant WASM as WasmSdk (WASM Module)
participant SDK as Rust SDK Core
participant Platform as Dash Platform
JS->>WASM: Call query or state transition function (e.g., get_identity, document_create)
WASM->>SDK: Parse inputs, build request, perform key/contract/identity lookup
SDK->>Platform: Fetch data or broadcast state transition
Platform-->>SDK: Return result (data or confirmation)
SDK-->>WASM: Return result or error
WASM-->>JS: Serialize and return as JsValue (JSON or object)
Possibly related PRs
Suggested labels
Poem
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ gRPC Query Coverage Report |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 16
♻️ Duplicate comments (1)
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (1)
56-60: Security: Same key validation issue as in contracts module.The can_sign_with method should properly validate keys instead of always returning true.
🧹 Nitpick comments (24)
packages/wasm-sdk/src/lib.rs (1)
9-14: Consider namespace pollution from wildcard re-exports.The module organization looks good, but using wildcard re-exports (
pub use queries::*andpub use state_transitions::*) can lead to namespace pollution and make it harder to track where specific items come from. Consider using more specific re-exports if the API surface becomes too large.packages/wasm-sdk/src/queries/mod.rs (1)
1-20: Well-organized module structure with a note on re-exports.The module organization is logical and follows good naming conventions. However, the wildcard re-exports (
pub use module::*) can lead to namespace pollution and make it harder to track the origin of specific items. Consider using more selective re-exports if the API surface becomes large or if there are naming conflicts.packages/wasm-sdk/service-worker-simple.js (1)
1-106: Well-implemented service worker with good caching strategy.The cache-first approach with background updates is appropriate for WASM assets. The versioned cache names and proper cleanup of old caches are excellent practices.
Consider these enhancements:
// Add cache versioning based on build hash or timestamp -const CACHE_NAME = 'wasm-sdk-cache-v7'; // Increment to force cache update +const CACHE_NAME = 'wasm-sdk-cache-v7-' + (self.BUILD_HASH || 'dev'); // Add integrity checking for cached responses if (cachedResponse) { + // Verify cached response is still valid + if (cachedResponse.headers.get('content-length') === '0') { + console.log('[SW] Cached response appears invalid, fetching fresh'); + return fetch(event.request); + } console.log('[SW] Cache hit:', url.pathname);packages/wasm-sdk/CLAUDE.md (1)
1-49: Helpful documentation content with formatting improvements needed.The document provides valuable guidance for working with the WASM SDK and correctly clarifies that CORS/SSL issues don't exist with Dash Platform endpoints. The architecture overview and troubleshooting sections are particularly useful.
Improve formatting and address static analysis issues:
-# CLAUDE.md +# CLAUDE.md This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. ## Important Notes ### Network Connectivity + **THERE ARE NO CORS OR SSL ISSUES WITH THE DASH PLATFORM ENDPOINTS IN WASM-SDK** + - - Parameter validation (identity IDs, contract IDs, etc.) + - Parameter validation (identity IDs, contract IDs, etc.) - - Whether the SDK is in the correct network mode (testnet vs mainnet) + - Whether the SDK is in the correct network mode (testnet vs. mainnet)Consider using proper markdown list formatting and fixing the spacing issues throughout the document.
packages/wasm-sdk/src/sdk.rs (1)
54-99: Consider documenting the testing purpose of this method.This appears to be a testing/debugging utility. Consider adding a comment explaining its purpose and whether it should be included in production builds.
/// Test serialization of different object types +/// +/// This method is intended for testing and debugging purposes to verify +/// that various data structures can be properly serialized to JavaScript. +/// Consider using conditional compilation to exclude from production builds. #[wasm_bindgen(js_name = testSerialization)]packages/wasm-sdk/src/queries/protocol.rs (1)
46-48: Address TODO: Implement actual vote count and threshold retrieval.The current implementation sets vote_count to None and determines threshold_reached based only on activation height presence. This should retrieve actual voting data from the platform.
Would you like me to create an issue to track implementing the actual vote count and threshold retrieval from the platform?
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (2)
215-221: Address TODO: Implement proper document serialization.The current implementation only returns basic document information. Full document serialization is needed.
Would you like me to help implement proper document serialization or create an issue to track this?
411-497: Track unimplemented token operations.Four token operations are not yet implemented: transfer, freeze, unfreeze, and destroy_frozen. These return placeholder error messages.
Would you like me to create issues to track the implementation of these token operations?
packages/wasm-sdk/src/queries/epoch.rs (4)
146-153: Remove redundant sorting.The manual sorting after fetching seems redundant. The
FinalizedEpochQueryshould already return results in the requested order. If the SDK doesn't respect the ordering, that should be fixed in the SDK rather than sorted here.Consider removing the manual sorting or adding a comment explaining why it's necessary if the SDK doesn't guarantee order.
185-190: Incomplete implementation needs attention.This function currently returns an empty result with a TODO comment indicating that the SDK doesn't support querying by (epoch, ProTxHash) tuple. This incomplete functionality should be tracked.
Would you like me to open an issue to track implementing the proper query structure for
GetEvonodesProposedEpochBlocksByIdsRequest?
231-243: Simplify ProTxHash conversion.The conversion from Identifier back to ProTxHash is unnecessarily complex. Consider creating a helper method or using a more direct conversion approach.
Consider extracting this conversion logic into a helper function:
+fn identifier_to_pro_tx_hash(identifier: &Identifier) -> ProTxHash { + let bytes = identifier.to_buffer(); + let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes) + .expect("identifier should be valid hash bytes"); + ProTxHash::from_raw_hash(hash) +} // Then in the map: - let bytes = identifier.to_buffer(); - let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes).unwrap(); - let pro_tx_hash = ProTxHash::from_raw_hash(hash); + let pro_tx_hash = identifier_to_pro_tx_hash(&identifier);
245-253: Remove redundant sorting.Similar to
get_finalized_epoch_infos, the manual sorting seems redundant if the query respects ordering.packages/wasm-sdk/src/queries/system.rs (2)
60-72: Implement actual platform status retrieval.The function currently returns static placeholder data. The TODO comment indicates this should fetch actual status from the platform.
Would you like me to help implement the actual platform status retrieval or open an issue to track this?
261-261: Consider making the path configurable.The function uses an empty root path. Should this be a parameter to allow querying elements at different paths?
packages/wasm-sdk/src/queries/group.rs (3)
233-237: Good use of console warning for unimplemented features.Appropriately warns users about unimplemented owner and moderator role queries.
Would you like me to help implement the owner and moderator role queries when the SDK supports them?
303-318: Consider using structured types instead of manual JSON construction.The function manually constructs JSON objects instead of using properly typed structs. This approach is less type-safe and harder to maintain.
Define response structs similar to other functions:
#[derive(Serialize, Deserialize)] #[serde(rename_all = "camelCase")] struct GroupInfosResponse { group_infos: Vec<GroupInfoDetail>, } #[derive(Serialize, Deserialize)] #[serde(rename_all = "camelCase")] struct GroupInfoDetail { group_contract_position: u32, members: Vec<GroupMember>, group_required_power: u32, }
392-397: Incomplete action serialization.The function only returns action IDs without the full action event structure. The TODO indicates this needs proper serialization implementation.
Would you like me to help implement the full action event serialization?
packages/wasm-sdk/src/state_transitions/identity/mod.rs (2)
57-61: Document the simplified signing behavior.The
can_sign_withmethod always returnstrue, which bypasses actual public key verification. This simplification should be documented.Add a comment explaining this limitation:
fn can_sign_with(&self, _identity_public_key: &IdentityPublicKey) -> bool { - // For simplicity, we assume the signer can sign with any key - // In a real implementation, you'd check if the public key matches + // FIXME: This is a simplification - in production, this should verify + // that the provided public key corresponds to our private key. + // Currently assumes the caller has already verified key ownership. true }
403-478: Consider using structured types for public key input.The manual JSON parsing for public keys is error-prone. Consider defining a proper input type.
Define an input struct:
#[derive(Deserialize)] #[serde(rename_all = "camelCase")] struct PublicKeyInput { key_type: String, purpose: String, #[serde(default = "default_security_level")] security_level: String, data: String, } fn default_security_level() -> String { "HIGH".to_string() }packages/wasm-sdk/src/queries/document.rs (1)
41-42: Document the unused parameters.The
data_contractanddocument_typeparameters are accepted but not used (marked with underscores). Consider adding a comment explaining the future use case.Add a comment:
fn from_document( doc: &Document, _data_contract: &dash_sdk::platform::DataContract, _document_type: dash_sdk::dpp::data_contract::document_type::DocumentTypeRef ) -> Result<Self, JsError> { use dash_sdk::dpp::document::DocumentV0Getters; - // For now, we'll continue with the existing approach - // In the future, we could use the document type to better interpret the data + // TODO: Use data_contract and document_type to provide better type interpretation + // and validation of document properties based on the contract schemapackages/wasm-sdk/src/queries/identity.rs (2)
46-46: Remove obsolete commentThe comment about
DapiRequestExecutoris no longer relevant since it's not used in this implementation.- // DapiRequestExecutor not needed anymore
66-80: Consider documenting pagination limitationsThe current implementation fetches all keys before applying offset and limit client-side. This could be inefficient for identities with many keys. Consider adding a comment explaining this limitation.
// Apply offset and limit if provided + // TODO: This applies pagination client-side after fetching all keys. + // Consider implementing server-side pagination when available in the SDK. let start = offset.unwrap_or(0) as usize;packages/wasm-sdk/src/queries/voting.rs (2)
79-92: Complete implementation for contested resources responseThe function currently returns an empty
contestedResourcesarray regardless of the actual response. This appears to be a placeholder implementation that needs to be completed.The response parsing for contested resources needs to be implemented. Would you like me to help implement the proper response handling or create an issue to track this?
1-392: Complete placeholder implementations in voting queriesAll functions in this module execute the gRPC requests but return empty/placeholder responses. Based on the returned metadata, the requests are successful, but the actual data parsing is not implemented. This pattern is consistent across:
get_contested_resources(returns empty array)get_contested_resource_vote_state(returns empty contenders)get_contested_resource_voters_for_identity(returns empty voters)get_contested_resource_identity_votes(returns empty votes)get_vote_polls_by_end_date(returns empty votePollsByTimestamps)Would you like me to help implement the proper response parsing for these voting queries or create tracking issues for each function?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (25)
packages/rs-sdk-trusted-context-provider/src/provider.rs(5 hunks)packages/rs-sdk/Cargo.toml(1 hunks)packages/rs-sdk/src/sdk.rs(4 hunks)packages/wasm-sdk/CLAUDE.md(1 hunks)packages/wasm-sdk/Cargo.toml(2 hunks)packages/wasm-sdk/service-worker-simple.js(1 hunks)packages/wasm-sdk/src/context_provider.rs(1 hunks)packages/wasm-sdk/src/lib.rs(1 hunks)packages/wasm-sdk/src/queries/data_contract.rs(1 hunks)packages/wasm-sdk/src/queries/document.rs(1 hunks)packages/wasm-sdk/src/queries/epoch.rs(1 hunks)packages/wasm-sdk/src/queries/group.rs(1 hunks)packages/wasm-sdk/src/queries/identity.rs(1 hunks)packages/wasm-sdk/src/queries/mod.rs(1 hunks)packages/wasm-sdk/src/queries/protocol.rs(1 hunks)packages/wasm-sdk/src/queries/system.rs(1 hunks)packages/wasm-sdk/src/queries/token.rs(1 hunks)packages/wasm-sdk/src/queries/voting.rs(1 hunks)packages/wasm-sdk/src/sdk.rs(6 hunks)packages/wasm-sdk/src/state_transitions/contracts/mod.rs(1 hunks)packages/wasm-sdk/src/state_transitions/documents.rs(0 hunks)packages/wasm-sdk/src/state_transitions/documents/mod.rs(1 hunks)packages/wasm-sdk/src/state_transitions/identity/mod.rs(1 hunks)packages/wasm-sdk/src/state_transitions/mod.rs(1 hunks)packages/wasm-sdk/src/state_transitions/tokens/mod.rs(1 hunks)
💤 Files with no reviewable changes (1)
- packages/wasm-sdk/src/state_transitions/documents.rs
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/wasm-sdk/src/context_provider.rspackages/wasm-sdk/src/state_transitions/mod.rspackages/wasm-sdk/src/queries/mod.rspackages/rs-sdk/src/sdk.rspackages/wasm-sdk/src/lib.rspackages/rs-sdk-trusted-context-provider/src/provider.rspackages/wasm-sdk/src/queries/protocol.rspackages/wasm-sdk/src/state_transitions/contracts/mod.rspackages/wasm-sdk/src/queries/data_contract.rspackages/wasm-sdk/src/state_transitions/identity/mod.rspackages/wasm-sdk/src/queries/document.rspackages/wasm-sdk/src/queries/group.rspackages/wasm-sdk/src/queries/system.rspackages/wasm-sdk/src/state_transitions/tokens/mod.rspackages/wasm-sdk/src/queries/epoch.rspackages/wasm-sdk/src/queries/identity.rspackages/wasm-sdk/src/queries/voting.rspackages/wasm-sdk/src/queries/token.rspackages/wasm-sdk/src/sdk.rspackages/wasm-sdk/src/state_transitions/documents/mod.rs
`**/*.{js,ts,tsx}`: Lint JavaScript/TypeScript code using `yarn lint`
**/*.{js,ts,tsx}: Lint JavaScript/TypeScript code usingyarn lint
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/wasm-sdk/service-worker-simple.js
🧠 Learnings (23)
packages/rs-sdk/Cargo.toml (12)
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/Cargo.toml:22-22
Timestamp: 2024-10-29T10:42:00.521Z
Learning: In `packages/rs-dapi-client/Cargo.toml`, `backon` will not work without the `tokio-sleep` feature in our setup, so it's unnecessary to declare `tokio-sleep` as a separate feature in the `[features]` section.
Learnt from: QuantumExplorer
PR: dashpay/platform#2431
File: packages/rs-drive/Cargo.toml:55-60
Timestamp: 2025-01-19T07:36:46.042Z
Learning: The grovedb dependencies in packages/rs-drive/Cargo.toml and related files are intentionally kept at specific revisions rather than using the latest stable version, with plans to update them at a later time.
Learnt from: shumkov
PR: dashpay/platform#2248
File: packages/rs-drive-abci/src/main.rs:106-111
Timestamp: 2024-10-17T08:52:54.300Z
Learning: In this project, the environment variable `CARGO_PKG_RUST_VERSION` is defined and can be used safely with the `env!` macro.
Learnt from: shumkov
PR: dashpay/platform#2375
File: packages/rs-drive-abci/Cargo.toml:61-63
Timestamp: 2024-12-05T09:29:38.918Z
Learning: In the `drive-abci` package, avoid adding unused dependencies like `hashbrown` to `Cargo.toml`. The team relies on CI to detect dependency version issues.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Applies to **/*.rs : Check Rust code using `cargo check --workspace`
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Applies to **/*.rs : Rust code should be formatted using `cargo fmt --all`
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:129-130
Timestamp: 2024-10-10T10:30:25.283Z
Learning: In the codebase `packages/rs-sdk/src/mock/sdk.rs`, `tokio::sync::Mutex` is used instead of `std::sync::Mutex` because `std::sync::MutexGuard` is not `Send` and cannot be used in async contexts.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
packages/wasm-sdk/src/context_provider.rs (2)
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:93-99
Timestamp: 2024-11-22T08:19:14.448Z
Learning: In `packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs`, the `insert_contract` method requires an owned `BlockInfo`, so cloning `block_info` is necessary when calling it.
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts is already handled in the data contract validation process, specifically in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs.
packages/wasm-sdk/Cargo.toml (16)
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/Cargo.toml:22-22
Timestamp: 2024-10-29T10:42:00.521Z
Learning: In `packages/rs-dapi-client/Cargo.toml`, `backon` will not work without the `tokio-sleep` feature in our setup, so it's unnecessary to declare `tokio-sleep` as a separate feature in the `[features]` section.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2375
File: packages/rs-drive-abci/Cargo.toml:61-63
Timestamp: 2024-12-05T09:29:38.918Z
Learning: In the `drive-abci` package, avoid adding unused dependencies like `hashbrown` to `Cargo.toml`. The team relies on CI to detect dependency version issues.
Learnt from: QuantumExplorer
PR: dashpay/platform#2431
File: packages/rs-drive/Cargo.toml:55-60
Timestamp: 2025-01-19T07:36:46.042Z
Learning: The grovedb dependencies in packages/rs-drive/Cargo.toml and related files are intentionally kept at specific revisions rather than using the latest stable version, with plans to update them at a later time.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Applies to **/*.rs : Check Rust code using `cargo check --workspace`
Learnt from: shumkov
PR: dashpay/platform#2248
File: packages/rs-drive-abci/src/main.rs:106-111
Timestamp: 2024-10-17T08:52:54.300Z
Learning: In this project, the environment variable `CARGO_PKG_RUST_VERSION` is defined and can be used safely with the `env!` macro.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: shumkov
PR: dashpay/platform#2317
File: packages/rs-dapi-client/src/address_list.rs:175-180
Timestamp: 2024-11-28T13:49:17.301Z
Learning: In Rust code in `packages/rs-dapi-client/src/address_list.rs`, do not change the interface of deprecated methods like `add_uri`, even to fix potential panics.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use Yarn workspaces to manage multiple packages in the monorepo structure
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Applies to **/*.rs : Rust code should be linted using `cargo clippy --workspace`
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Applies to **/*.rs : Rust code should be formatted using `cargo fmt --all`
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
packages/wasm-sdk/src/state_transitions/mod.rs (8)
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-drive-abci/src/platform_types/platform_state/mod.rs:141-141
Timestamp: 2024-10-08T13:28:03.529Z
Learning: When converting `PlatformStateV0` to `PlatformStateForSavingV1` in `packages/rs-drive-abci/src/platform_types/platform_state/mod.rs`, only version `0` needs to be handled in the match on `platform_state_for_saving_structure_default` because the changes are retroactive.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
packages/wasm-sdk/src/queries/mod.rs (8)
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
packages/rs-sdk/src/sdk.rs (19)
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:129-130
Timestamp: 2024-10-10T10:30:25.283Z
Learning: In the codebase `packages/rs-sdk/src/mock/sdk.rs`, `tokio::sync::Mutex` is used instead of `std::sync::Mutex` because `std::sync::MutexGuard` is not `Send` and cannot be used in async contexts.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/address_list.rs:63-73
Timestamp: 2024-10-29T14:16:40.972Z
Learning: In the Rust SDK, it's acceptable to use `expect()` that panics on errors in the `Mockable` trait implementations during testing, and the `Mockable` trait will be refactored in a future PR.
Learnt from: shumkov
PR: dashpay/platform#2248
File: packages/rs-drive-abci/src/main.rs:106-111
Timestamp: 2024-10-17T08:52:54.300Z
Learning: In this project, the environment variable `CARGO_PKG_RUST_VERSION` is defined and can be used safely with the `env!` macro.
Learnt from: QuantumExplorer
PR: dashpay/platform#2182
File: packages/rs-dpp/src/util/units.rs:57-57
Timestamp: 2024-10-09T00:22:57.778Z
Learning: The macro `dash_to_duffs` in `units.rs` is not used in production code.
Learnt from: QuantumExplorer
PR: dashpay/platform#2182
File: packages/rs-dpp/src/util/units.rs:57-57
Timestamp: 2024-09-29T09:35:11.094Z
Learning: The macro `dash_to_duffs` in `units.rs` is not used in production code.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount from crate::balances::credits is compatible with u64 when used for token base supply.
Learnt from: QuantumExplorer
PR: dashpay/platform#2559
File: packages/rs-drive-abci/src/query/token_queries/token_perpetual_distribution_last_claim/v0/mod.rs:128-0
Timestamp: 2025-04-21T00:38:44.796Z
Learning: In the Dash Platform codebase, EpochIndex is defined as u16, making it safe to cast to u32 without overflow concerns.
Learnt from: shumkov
PR: dashpay/platform#2449
File: packages/rs-sdk/src/platform/transition/fungible_tokens/unfreeze.rs:148-148
Timestamp: 2025-02-14T04:31:57.245Z
Learning: The third boolean parameter in `get_identity_contract_nonce` method controls whether to bump (increment) the nonce when set to `true`.
packages/wasm-sdk/src/lib.rs (6)
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:129-130
Timestamp: 2024-10-10T10:30:25.283Z
Learning: In the codebase `packages/rs-sdk/src/mock/sdk.rs`, `tokio::sync::Mutex` is used instead of `std::sync::Mutex` because `std::sync::MutexGuard` is not `Send` and cannot be used in async contexts.
packages/wasm-sdk/CLAUDE.md (4)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2489
File: packages/rs-dpp/Cargo.toml:32-32
Timestamp: 2025-03-11T09:39:23.071Z
Learning: In the Dash Platform project, dependencies are currently managed using Git repository references with tags (repo+tag format in Cargo.toml) rather than published crates, as the team is not currently publishing crates to crates.io.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
packages/rs-sdk-trusted-context-provider/src/provider.rs (7)
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:129-130
Timestamp: 2024-10-10T10:30:25.283Z
Learning: In the codebase `packages/rs-sdk/src/mock/sdk.rs`, `tokio::sync::Mutex` is used instead of `std::sync::Mutex` because `std::sync::MutexGuard` is not `Send` and cannot be used in async contexts.
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:93-99
Timestamp: 2024-11-22T08:19:14.448Z
Learning: In `packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs`, the `insert_contract` method requires an owned `BlockInfo`, so cloning `block_info` is necessary when calling it.
Learnt from: shumkov
PR: dashpay/platform#2317
File: packages/rs-dapi-client/src/address_list.rs:175-180
Timestamp: 2024-11-28T13:49:17.301Z
Learning: In Rust code in `packages/rs-dapi-client/src/address_list.rs`, do not change the interface of deprecated methods like `add_uri`, even to fix potential panics.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: shumkov
PR: dashpay/platform#2266
File: packages/rs-sdk/src/sync.rs:171-221
Timestamp: 2024-10-25T10:35:05.071Z
Learning: In `packages/rs-sdk/src/sync.rs`, within the `retry` function, the closure passed to `.when()` in `backon::Retryable::retry` is not executed concurrently, so using a mutable variable like `retries` inside it does not lead to data races.
packages/wasm-sdk/src/queries/protocol.rs (13)
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-drive-abci/tests/strategy_tests/main.rs:1162-1162
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust test file `packages/rs-drive-abci/tests/strategy_tests/main.rs`, specific protocol versions like `PROTOCOL_VERSION_1` are intentionally used in tests instead of `PROTOCOL_VERSION_LATEST`.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-drive-abci/tests/strategy_tests/main.rs:1162-1162
Timestamp: 2024-10-04T09:08:47.901Z
Learning: In the Rust test file `packages/rs-drive-abci/tests/strategy_tests/main.rs`, specific protocol versions like `PROTOCOL_VERSION_1` are intentionally used in tests instead of `PROTOCOL_VERSION_LATEST`.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: shumkov
PR: dashpay/platform#2422
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:152-163
Timestamp: 2025-01-15T08:09:59.365Z
Learning: In the `transition_to_version_8` function, errors from `grove_get_path_query` when retrieving active contested resource votes are intentionally logged and ignored (returning `Ok(())`) to allow the protocol upgrade to proceed despite query failures.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use `rs-platform-version` for protocol versioning in platform components
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-drive-abci/src/platform_types/platform_state/mod.rs:141-141
Timestamp: 2024-10-08T13:28:03.529Z
Learning: When converting `PlatformStateV0` to `PlatformStateForSavingV1` in `packages/rs-drive-abci/src/platform_types/platform_state/mod.rs`, only version `0` needs to be handled in the match on `platform_state_for_saving_structure_default` because the changes are retroactive.
packages/wasm-sdk/src/state_transitions/contracts/mod.rs (10)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts is already handled in the data contract validation process, specifically in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts (ensuring it's between 3 and 100 characters) is already handled at the data contract validation level in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs, making additional checks in the update operations redundant.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/wallet-utils-contract/src/lib.rs:14-17
Timestamp: 2024-11-25T07:48:09.831Z
Learning: In the `wallet-utils-contract` (file `packages/wallet-utils-contract/src/lib.rs`), the `OWNER_ID_BYTES` constant is intentionally initialized to all zeros.
packages/wasm-sdk/src/queries/data_contract.rs (11)
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts is already handled in the data contract validation process, specifically in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts (ensuring it's between 3 and 100 characters) is already handled at the data contract validation level in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs, making additional checks in the update operations redundant.
Learnt from: shumkov
PR: dashpay/platform#2314
File: packages/wallet-contract/test/bootstrap.js:14-16
Timestamp: 2024-11-06T07:27:01.722Z
Learning: In `packages/wallet-contract/test/bootstrap.js`, for Mocha tests in Node.js, async functions like `loadWasmDpp` can be assigned directly to `beforeAll` without wrapping them in another async function.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
packages/wasm-sdk/src/state_transitions/identity/mod.rs (10)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-04T14:16:05.798Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
packages/wasm-sdk/src/queries/document.rs (7)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: shumkov
PR: dashpay/platform#2182
File: packages/rs-platform-version/src/version/drive_abci_versions.rs:116-121
Timestamp: 2024-09-29T13:13:54.230Z
Learning: Adding Rust doc comments to structs and fields is recommended to enhance clarity and documentation.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
packages/wasm-sdk/src/queries/group.rs (3)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
packages/wasm-sdk/src/queries/system.rs (13)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2347
File: packages/rs-drive/tests/query_tests.rs:438-460
Timestamp: 2024-11-25T01:17:02.001Z
Learning: In Rust test files (`packages/rs-drive/tests/query_tests.rs`), when code is used only in tests, defining explicit enums for fields (like the `status` field in the `Withdrawal` struct) may not be necessary; using primitive types is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs:94-94
Timestamp: 2024-11-20T10:01:50.837Z
Learning: In `packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs`, when converting with `PublicKey::try_from`, it's acceptable to use `.expect()` to handle potential conversion errors.
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (8)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount from crate::balances::credits is compatible with u64 when used for token base supply.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount is defined as `type TokenAmount = u64` in balances/credits.rs, making it directly compatible with u64 values without any conversion needed.
packages/wasm-sdk/src/queries/epoch.rs (10)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: QuantumExplorer
PR: dashpay/platform#2559
File: packages/rs-drive-abci/src/query/token_queries/token_perpetual_distribution_last_claim/v0/mod.rs:128-0
Timestamp: 2025-04-21T00:38:44.796Z
Learning: In the Dash Platform codebase, EpochIndex is defined as u16, making it safe to cast to u32 without overflow concerns.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
packages/wasm-sdk/src/queries/identity.rs (10)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
packages/wasm-sdk/src/queries/voting.rs (12)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: shumkov
PR: dashpay/platform#2422
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:152-163
Timestamp: 2025-01-15T08:09:59.365Z
Learning: In the `transition_to_version_8` function, errors from `grove_get_path_query` when retrieving active contested resource votes are intentionally logged and ignored (returning `Ok(())`) to allow the protocol upgrade to proceed despite query failures.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-04T14:16:05.798Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
packages/wasm-sdk/src/queries/token.rs (12)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount is defined as `type TokenAmount = u64` in balances/credits.rs, making it directly compatible with u64 values without any conversion needed.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount from crate::balances::credits is compatible with u64 when used for token base supply.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:129-130
Timestamp: 2024-10-10T10:30:25.283Z
Learning: In the codebase `packages/rs-sdk/src/mock/sdk.rs`, `tokio::sync::Mutex` is used instead of `std::sync::Mutex` because `std::sync::MutexGuard` is not `Send` and cannot be used in async contexts.
Learnt from: shumkov
PR: dashpay/platform#2255
File: packages/dashmate/src/status/scopes/platform.js:112-116
Timestamp: 2024-10-19T06:10:00.808Z
Learning: In the Dashmate project, when fetching from Tenderdash RPC endpoints like `/status`, `/net_info`, and `/abci_info`, if one request fails, it's likely that the others will fail as well, so individual error handling for each fetch may not be necessary.
Learnt from: QuantumExplorer
PR: dashpay/platform#2431
File: packages/rs-drive/src/drive/tokens/system/fetch_token_total_supply/v0/mod.rs:31-71
Timestamp: 2025-01-19T07:36:32.294Z
Learning: Token ID zero validation is not required in the fetch_token_total_supply_v0 method, as confirmed by the maintainer.
packages/wasm-sdk/src/sdk.rs (16)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:129-130
Timestamp: 2024-10-10T10:30:25.283Z
Learning: In the codebase `packages/rs-sdk/src/mock/sdk.rs`, `tokio::sync::Mutex` is used instead of `std::sync::Mutex` because `std::sync::MutexGuard` is not `Send` and cannot be used in async contexts.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts is already handled in the data contract validation process, specifically in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/dapi-grpc/src/mock.rs:125-145
Timestamp: 2024-10-29T14:16:00.141Z
Learning: Using `serde_json` encoding produces deterministic output required to identify requests and responses by hash, therefore `serde_json` is used as the basic serialization algorithm for mocking.
packages/wasm-sdk/src/state_transitions/documents/mod.rs (8)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
🧬 Code Graph Analysis (3)
packages/wasm-sdk/src/context_provider.rs (1)
packages/rs-sdk-trusted-context-provider/src/provider.rs (1)
add_known_contract(159-163)
packages/wasm-sdk/src/queries/protocol.rs (1)
packages/wasm-sdk/src/sdk.rs (1)
version(50-52)
packages/wasm-sdk/src/state_transitions/contracts/mod.rs (1)
packages/wasm-sdk/src/state_transitions/identity/mod.rs (5)
state_transition(179-180)state_transition(534-535)new(26-43)sign(47-55)can_sign_with(57-61)
🪛 LanguageTool
packages/wasm-sdk/CLAUDE.md
[grammar] ~1-~1: Use proper spacing conventions.
Context: # CLAUDE.md This file provides guidance to Claude Co...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...en working with code in this repository. ## Important Notes ### Network Connectivit...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ... in this repository. ## Important Notes ### Network Connectivity **THERE ARE NO CORS...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~8-~8: There might be a mistake here.
Context: ...UES WITH THE DASH PLATFORM ENDPOINTS IN WASM-SDK** - The Dash Platform HTTPS endpoints (...
(QB_NEW_EN_OTHER)
[grammar] ~9-~9: There might be a mistake here.
Context: ...2.176.90:1443) work perfectly fine from browsers - These endpoints have proper CORS head...
(QB_NEW_EN_OTHER)
[grammar] ~10-~10: There might be a mistake here.
Context: ...hese endpoints have proper CORS headers configured - SSL certificates are valid and accept...
(QB_NEW_EN_OTHER)
[grammar] ~11-~11: There might be a mistake here.
Context: ... certificates are valid and accepted by browsers - If you see connection errors, check: ...
(QB_NEW_EN_OTHER)
[grammar] ~14-~14: Use proper spacing conventions.
Context: ...ation (identity IDs, contract IDs, etc.) - Whether the SDK is in the correct networ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~15-~15: Punctuate Latin abbreviations correctly.
Context: ...is in the correct network mode (testnet vs mainnet) - The actual error message d...
(QB_NEW_EN_OTHER_ERROR_IDS_000036)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...etails (not just assuming it's CORS/SSL) ## Architecture The WASM SDK is a WebAssem...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ...assuming it's CORS/SSL) ## Architecture The WASM SDK is a WebAssembly build of t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~20-~20: Use proper spacing conventions.
Context: ... SDK that runs in browsers. It provides: 1. Queries - Read operations that fetch d...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[typographical] ~22-~22: To join two clauses or set off examples, consider using an em dash.
Context: ...at runs in browsers. It provides: 1. Queries - Read operations that fetch data from Dash Pl...
(QB_NEW_EN_DASH_RULE_EM)
[typographical] ~23-~23: To join two clauses or set off examples, consider using an em dash.
Context: ...etch data from Dash Platform 2. State Transitions - Write operations that modify state on Dash Pl...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...tions that modify state on Dash Platform ### Key Components - src/sdk.rs - Main SD...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...ate on Dash Platform ### Key Components - src/sdk.rs - Main SDK wrapper with WasmSdk and Was...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ...ions (identity, documents, tokens, etc.) - src/state_transitions/ - State transition implementations - `s...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~31-~31: Use proper spacing conventions.
Context: ... interface for testing SDK functionality ### Building Run ./build.sh to build the ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ... testing SDK functionality ### Building Run ./build.sh to build the WASM modul...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~35-~35: Use articles correctly.
Context: ...to build the WASM module. Output goes topkg/` directory. ### Testing 1. Star...
(QB_NEW_EN_OTHER_ERROR_IDS_000004)
[grammar] ~35-~35: Use proper spacing conventions.
Context: ...module. Output goes to pkg/ directory. ### Testing 1. Start web server: `python3 -...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~37-~37: Use proper spacing conventions.
Context: ...t goes to pkg/ directory. ### Testing 1. Start web server: `python3 -m http.serve...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~40-~40: There might be a mistake here.
Context: ...: python3 -m http.server 8888 2. Open http://localhost:8888 3. Select network (testnet/mainnet) 4. ...
(QB_NEW_EN_OTHER)
[grammar] ~41-~41: There might be a mistake here.
Context: ...http://localhost:8888 3. Select network (testnet/mainnet) 4. Choose operation type (queries/state...
(QB_NEW_EN_OTHER)
[grammar] ~42-~42: There might be a mistake here.
Context: ...4. Choose operation type (queries/state transitions) 5. Fill in parameters and execute ## C...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: Place a period at the end of declarative sentences.
Context: ...tions) 5. Fill in parameters and execute ## Common Issues 1. **"time not implemente...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
[grammar] ~45-~45: Use proper spacing conventions.
Context: ...parameters and execute ## Common Issues 1. **"time not implemented on this platform"*...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[typographical] ~47-~47: To join two clauses or set off examples, consider using an em dash.
Context: ...ues 1. "time not implemented on this platform" - Fixed by using js_sys::Date::now() in WASM bui...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~47-~47: There might be a mistake here.
Context: ... by using js_sys::Date::now() in WASM builds 2. Import errors - Token functions ...
(QB_NEW_EN_OTHER)
[typographical] ~48-~48: To join two clauses or set off examples, consider using an em dash.
Context: ...Date::now()` in WASM builds 2. Import errors - Token functions are methods on WasmSdk, not s...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~48-~48: There might be a mistake here.
Context: ... are methods on WasmSdk, not standalone functions 3. Network timeouts - Usually means...
(QB_NEW_EN_OTHER)
[typographical] ~49-~49: To join two clauses or set off examples, consider using an em dash.
Context: ..., not standalone functions 3. Network timeouts - Usually means invalid parameters or identities,...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~49-~49: Place a period at the end of declarative sentences.
Context: ...d parameters or identities, NOT network issues
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
🪛 markdownlint-cli2 (0.17.2)
packages/wasm-sdk/CLAUDE.md
8-8: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
9-9: Bare URL used
(MD034, no-bare-urls)
40-40: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: Rust packages (dash-sdk) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Linting
- GitHub Check: Rust packages (dash-sdk) / Formatting
- 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 Docker images (Drive, drive, drive-abci) / Build Drive image
- GitHub Check: Build JS packages / Build JS
- GitHub Check: build-wasm-sdk
🔇 Additional comments (32)
packages/rs-sdk/Cargo.toml (1)
50-51: LGTM! Proper conditional dependency for WASM targets.The addition of
js-sysas a conditional dependency forwasm32targets follows the established pattern and is necessary for JavaScript interoperability in WASM environments.packages/wasm-sdk/src/context_provider.rs (1)
129-132: LGTM! Proper delegation pattern maintained.The
add_known_contractmethod correctly delegates to the inner provider's method, maintaining consistency with the existing wrapper pattern used throughoutWasmTrustedContext.packages/wasm-sdk/Cargo.toml (3)
26-26: LGTM! Crypto feature addition for web-sys.Adding the 'Crypto' feature to web-sys is appropriate for cryptographic operations in the WASM environment.
35-45: LGTM! Appropriate dependencies for WASM SDK functionality.The added dependencies are well-chosen for the WASM SDK:
serdewith derive feature for serializationserde_jsonfor JSON handlinghexandbase64for encoding/decodingjs-sysfor JavaScript interopdapi-grpcandrs-dapi-clientfor platform communicationAll versions follow semantic versioning conventions.
51-54: LGTM! Appropriate build optimizations for WASM.The build configuration changes are suitable for WASM:
lto = "fat"enables aggressive link-time optimization for smaller binary sizewasm-opt = falsedisables additional optimization to prevent potential issuesThese settings are common practices for WASM builds where binary size and compatibility are important.
packages/wasm-sdk/src/state_transitions/mod.rs (1)
1-11: Excellent modular organization for state transitions.The module structure cleanly organizes state transition functionality by domain (contracts, documents, identity, tokens) and provides convenient re-exports for easy access. This aligns well with the comprehensive WASM SDK enhancements described in the PR.
packages/rs-sdk/src/sdk.rs (2)
209-225: Excellent cross-platform time abstraction.The helper function cleanly handles time retrieval for both native and WASM environments. The WASM implementation correctly converts JavaScript's millisecond timestamp to seconds, and the panic for pre-EPOCH time is appropriate for this context.
382-382: Good refactoring to use centralized time function.Replacing the inline time retrieval code with the
get_current_time_seconds()helper improves maintainability and ensures consistent WASM compatibility across both nonce methods.Also applies to: 468-468
packages/rs-sdk-trusted-context-provider/src/provider.rs (3)
51-51: Excellent thread safety improvement for known contracts cache.Converting to
Arc<Mutex<HashMap>>ensures thread-safe access to the contracts cache, which is essential for the async WASM SDK operations.Also applies to: 130-130
143-149: Proper mutex usage patterns throughout.The lock acquisition and explicit
drop()calls follow good practices for minimizing lock contention. Theunwrap()usage is appropriate here as mutex poisoning would indicate serious underlying issues.Also applies to: 158-163
483-487: Good thread-safe contract lookup implementation.The method properly acquires the mutex lock, performs the lookup, and releases the lock before delegating to the fallback provider if needed.
packages/wasm-sdk/src/sdk.rs (6)
22-24: LGTM!The addition of
JsErrorandserde_jsonimports supports the new methods appropriately.
50-52: LGTM!Clean implementation of protocol version getter.
102-107: LGTM!Appropriate internal utility method for cloning the SDK instance.
658-661: LGTM!Appropriate visibility change to allow state transition modules to access the trusted context cache.
699-699: LGTM!Helpful comment documenting the architectural refactoring.
761-761: LGTM!Correct usage of SDK's platform version for serialization operations.
Also applies to: 774-774
packages/wasm-sdk/src/queries/protocol.rs (2)
6-21: LGTM!Well-structured data types with appropriate serde attributes for JavaScript interoperability.
66-102: LGTM!Well-implemented function with proper error handling and pagination support.
packages/wasm-sdk/src/queries/data_contract.rs (1)
14-27: LGTM!Clean implementation with proper error handling.
packages/wasm-sdk/src/queries/epoch.rs (3)
12-34: LGTM!The
EpochInfostruct and its conversion fromExtendedEpochInfoare well-implemented with proper serde attributes for JavaScript compatibility and correct fee multiplier conversion from permille.
36-66: LGTM!The
get_epochs_infofunction correctly implements epoch querying with proper pagination and filtering.
259-269: LGTM!Simple and correct implementation for fetching the current epoch.
packages/wasm-sdk/src/queries/system.rs (3)
165-165: Verify tuple struct assumption.Similar to
TotalCreditsInPlatform, this assumesPrefundedSpecializedBalanceis a tuple struct.
182-243: LGTM!Comprehensive implementation with proper gRPC response handling and error cases.
127-133: No changes needed: tuple struct assumption is valid.The
TotalCreditsInPlatformtype is defined aspub struct TotalCreditsInPlatform(pub Credits);in
packages/rs-drive-proof-verifier/src/types.rs, so accessingcredits.0correctly yields the innerCredits(u64).packages/wasm-sdk/src/queries/group.rs (1)
15-72: LGTM!Well-structured group info retrieval with proper response formatting.
packages/wasm-sdk/src/state_transitions/identity/mod.rs (3)
64-200: LGTM!Well-implemented credit transfer with proper validation, key matching, and error handling.
489-504: Excellent key validation logic!The validation properly prevents disabling master keys, critical authentication keys, and transfer keys, which protects users from accidentally locking themselves out.
685-694: Correct voting key security level.Good implementation - voting keys correctly use HIGH security level instead of MASTER.
packages/wasm-sdk/src/queries/document.rs (1)
139-145: Good handling of unsupported features.Appropriately warns users about unsupported where and orderBy clauses rather than silently ignoring them.
packages/wasm-sdk/src/state_transitions/documents/mod.rs (1)
60-64: Implement proper key verification in can_sign_withThe
can_sign_withmethod always returnstrue, which bypasses key compatibility checks. This could lead to signing with incorrect keys.fn can_sign_with(&self, _identity_public_key: &IdentityPublicKey) -> bool { - // For simplicity, we assume the signer can sign with any key - // In a real implementation, you'd check if the public key matches - true + // Verify that the identity public key corresponds to our private key + if let Ok(secp) = dash_sdk::dpp::dashcore::secp256k1::Secp256k1::new() { + if let Ok(secret_key) = dash_sdk::dpp::dashcore::secp256k1::SecretKey::from_slice(&self.private_key.inner.secret_bytes()) { + let public_key = dash_sdk::dpp::dashcore::secp256k1::PublicKey::from_secret_key(&secp, &secret_key); + let public_key_bytes = public_key.serialize().to_vec(); + + // Check based on key type + match _identity_public_key.key_type() { + KeyType::ECDSA_SECP256K1 => { + return _identity_public_key.data().as_slice() == public_key_bytes.as_slice(); + } + KeyType::ECDSA_HASH160 => { + use dash_sdk::dpp::dashcore::hashes::{Hash, hash160}; + let hash = hash160::Hash::hash(&public_key_bytes).to_byte_array().to_vec(); + return _identity_public_key.data().as_slice() == hash.as_slice(); + } + _ => return false, + } + } + } + false }⛔ Skipped due to learnings
Learnt from: QuantumExplorer PR: dashpay/platform#2257 File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151 Timestamp: 2024-11-20T16:05:40.200Z Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.Learnt from: QuantumExplorer PR: dashpay/platform#2673 File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197 Timestamp: 2025-06-18T03:44:14.385Z Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.Learnt from: QuantumExplorer PR: dashpay/platform#2215 File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30 Timestamp: 2024-10-09T00:22:57.778Z Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.Learnt from: QuantumExplorer PR: dashpay/platform#2215 File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30 Timestamp: 2024-10-06T16:11:34.946Z Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.Learnt from: QuantumExplorer PR: dashpay/platform#2257 File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220 Timestamp: 2024-11-20T20:43:41.185Z Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.Learnt from: lklimek PR: dashpay/platform#2254 File: packages/rs-sdk/src/sdk.rs:654-658 Timestamp: 2024-10-18T15:43:32.447Z Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.Learnt from: lklimek PR: dashpay/platform#2277 File: packages/rs-sdk/src/core/transaction.rs:0-0 Timestamp: 2024-10-29T14:40:54.727Z Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.Learnt from: lklimek PR: dashpay/platform#1924 File: packages/rs-sdk/src/sdk.rs:855-870 Timestamp: 2024-12-03T15:00:50.385Z Learning: In `packages/rs-sdk/src/sdk.rs`, remember that `rustls_pemfile::certs` returns an iterator over `Result`, not a `Result` directly. Handle it accordingly in future code reviews.Learnt from: QuantumExplorer PR: dashpay/platform#2257 File: packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs:94-94 Timestamp: 2024-11-20T10:01:50.837Z Learning: In `packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs`, when converting with `PublicKey::try_from`, it's acceptable to use `.expect()` to handle potential conversion errors.Learnt from: lklimek PR: dashpay/platform#2405 File: packages/wasm-sdk/src/verify.rs:26-68 Timestamp: 2025-02-10T11:26:36.709Z Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
| let matching_key = if let Some(requested_key_id) = key_id { | ||
| // Find specific key by ID | ||
| owner_identity.public_keys() | ||
| .get(&requested_key_id) | ||
| .filter(|key| { | ||
| key.purpose() == Purpose::AUTHENTICATION && | ||
| key.key_type() == KeyType::ECDSA_HASH160 && | ||
| key.data().as_slice() == public_key_hash160.as_slice() | ||
| }) | ||
| .ok_or_else(|| JsValue::from_str(&format!("Key with ID {} not found or doesn't match private key", requested_key_id)))? | ||
| .clone() | ||
| } else { | ||
| // Find any matching authentication key | ||
| owner_identity.public_keys().iter() | ||
| .find(|(_, key)| { | ||
| key.purpose() == Purpose::AUTHENTICATION && | ||
| key.key_type() == KeyType::ECDSA_HASH160 && | ||
| key.data().as_slice() == public_key_hash160.as_slice() | ||
| }) | ||
| .map(|(_, key)| key.clone()) | ||
| .ok_or_else(|| JsValue::from_str("No matching authentication key found for the provided private key"))? | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Extract duplicate key matching logic into a helper function.
The key matching logic is duplicated between contract_create and contract_update. Consider extracting it into a shared helper function.
+/// Find a matching authentication key for the given public key hash
+fn find_matching_auth_key(
+ identity: &dash_sdk::platform::Identity,
+ public_key_hash160: &[u8],
+ requested_key_id: Option<u32>,
+) -> Result<IdentityPublicKey, JsValue> {
+ use dash_sdk::dpp::identity::accessors::IdentityGettersV0;
+
+ if let Some(key_id) = requested_key_id {
+ // Find specific key by ID
+ identity.public_keys()
+ .get(&key_id)
+ .filter(|key| {
+ key.purpose() == Purpose::AUTHENTICATION &&
+ key.key_type() == KeyType::ECDSA_HASH160 &&
+ key.data().as_slice() == public_key_hash160
+ })
+ .ok_or_else(|| JsValue::from_str(&format!("Key with ID {} not found or doesn't match private key", key_id)))
+ .map(|k| k.clone())
+ } else {
+ // Find any matching authentication key
+ identity.public_keys().iter()
+ .find(|(_, key)| {
+ key.purpose() == Purpose::AUTHENTICATION &&
+ key.key_type() == KeyType::ECDSA_HASH160 &&
+ key.data().as_slice() == public_key_hash160
+ })
+ .map(|(_, key)| key.clone())
+ .ok_or_else(|| JsValue::from_str("No matching authentication key found for the provided private key"))
+ }
+}Then use it in both functions:
- // Find matching key - prioritize key_id if provided, otherwise find any authentication key
- let matching_key = if let Some(requested_key_id) = key_id {
- // ... existing code ...
- } else {
- // ... existing code ...
- };
+ let matching_key = find_matching_auth_key(&owner_identity, &public_key_hash160, key_id)?;Also applies to: 269-290
🤖 Prompt for AI Agents
In packages/wasm-sdk/src/state_transitions/contracts/mod.rs around lines 126 to
147 and also lines 269 to 290, the key matching logic is duplicated in
contract_create and contract_update functions. Extract this duplicated logic
into a single helper function that takes the owner_identity, optional key_id,
and public_key_hash160 as parameters and returns the matching key or an error.
Replace the duplicated code in both functions by calling this new helper
function to improve code reuse and maintainability.
| fn can_sign_with(&self, _identity_public_key: &IdentityPublicKey) -> bool { | ||
| // For simplicity, we assume the signer can sign with any key | ||
| // In a real implementation, you'd check if the public key matches | ||
| true | ||
| } |
There was a problem hiding this comment.
Security: Implement proper key validation in can_sign_with.
Always returning true bypasses critical security checks. The method should verify that the signer's public key matches the identity public key.
fn can_sign_with(&self, _identity_public_key: &IdentityPublicKey) -> bool {
- // For simplicity, we assume the signer can sign with any key
- // In a real implementation, you'd check if the public key matches
- true
+ // TODO: Implement proper key validation
+ // Compare the public key derived from self.private_key with identity_public_key
+ true
}Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In packages/wasm-sdk/src/state_transitions/contracts/mod.rs around lines 62 to
66, the can_sign_with method currently returns true unconditionally, bypassing
security checks. Modify this method to properly validate that the signer's
public key matches the provided identity_public_key by implementing a comparison
or verification logic instead of always returning true.
| if key_bytes.len() != 32 { | ||
| return Err(JsValue::from_str("Private key must be 32 bytes")); | ||
| } | ||
| PrivateKey::from_slice(&key_bytes, dash_sdk::dpp::dashcore::Network::Testnet) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Don't hardcode network to Testnet.
The network should be determined from the SDK context or passed as a parameter to support both mainnet and testnet.
- PrivateKey::from_slice(&key_bytes, dash_sdk::dpp::dashcore::Network::Testnet)
+ // TODO: Get network from SDK context
+ PrivateKey::from_slice(&key_bytes, dash_sdk::dpp::dashcore::Network::Testnet)🏁 Script executed:
#!/bin/bash
# Check if there's a way to get network from SDK context
rg -A 5 "network|Network" packages/wasm-sdk/src/Length of output: 21176
🏁 Script executed:
#!/bin/bash
# Search for can_sign_with implementation in wasm-sdk
rg -n 'can_sign_with' -A5 packages/wasm-sdk/srcLength of output: 2874
Fix hardcoded Testnet and strengthen signer validation
The PrivateKey::from_slice call in state_transitions/contracts/mod.rs is currently hardcoded to Testnet, and all can_sign_with implementations simply return true, bypassing real key checks.
Locations to address:
- packages/wasm-sdk/src/state_transitions/contracts/mod.rs:
• Line 40: replace hardcodedNetwork::Testnetwith the runtime SDK network
• Lines 62–66: implement real public-key matching instead of always returningtrue - Similar stubs in:
• packages/wasm-sdk/src/state_transitions/tokens/mod.rs
• packages/wasm-sdk/src/state_transitions/documents/mod.rs
• packages/wasm-sdk/src/state_transitions/identity/mod.rs - (Optional) packages/wasm-sdk/src/sdk.rs: stubbed
can_sign_withat line 785
Suggested diff for contracts/mod.rs:
- PrivateKey::from_slice(&key_bytes, dash_sdk::dpp::dashcore::Network::Testnet)
+ PrivateKey::from_slice(&key_bytes, sdk.network)And for can_sign_with:
- fn can_sign_with(&self, _identity_public_key: &IdentityPublicKey) -> bool {
- // For simplicity, we assume the signer can sign with any key
- true
- }
+ fn can_sign_with(&self, identity_public_key: &IdentityPublicKey) -> bool {
+ // Ensure the requested key matches this signer’s public key
+ &self.key_pair.public_key().to_bytes()[..] == identity_public_key.as_bytes()
+ }Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In packages/wasm-sdk/src/state_transitions/contracts/mod.rs at line 40, replace
the hardcoded Network::Testnet argument in PrivateKey::from_slice with the
network value obtained dynamically from the runtime SDK configuration. Then,
between lines 62 and 66, update the can_sign_with implementation to perform an
actual check that verifies if the provided public key matches the signer's key
instead of always returning true. Apply similar fixes to the corresponding files
in tokens, documents, and identity directories, and optionally update the stub
in sdk.rs at line 785 to implement real key validation.
| let (last_claim_timestamp_ms, last_claim_block_height) = match moment { | ||
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::BlockBasedMoment(height) => { | ||
| (0, height) // No timestamp available for block-based | ||
| }, | ||
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::TimeBasedMoment(timestamp) => { | ||
| (timestamp, 0) // No block height available for time-based | ||
| }, | ||
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::EpochBasedMoment(epoch) => { | ||
| (0, epoch as u64) // Convert epoch to u64, no timestamp available | ||
| }, | ||
| }; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add moment type to response to clarify field meanings
The current implementation returns 0 for either last_claim_timestamp_ms or last_claim_block_height depending on the moment type, which could be confusing. Consider adding a field to indicate the moment type.
#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
struct LastClaimResponse {
+ moment_type: String,
last_claim_timestamp_ms: u64,
last_claim_block_height: u64,
}And update the response creation:
let (last_claim_timestamp_ms, last_claim_block_height) = match moment {
dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::BlockBasedMoment(height) => {
(0, height) // No timestamp available for block-based
},
// ... rest of the match arms
};
+
+ let moment_type = match moment {
+ RewardDistributionMoment::BlockBasedMoment(_) => "block",
+ RewardDistributionMoment::TimeBasedMoment(_) => "time",
+ RewardDistributionMoment::EpochBasedMoment(_) => "epoch",
+ }.to_string();
let response = LastClaimResponse {
+ moment_type,
last_claim_timestamp_ms,
last_claim_block_height,
};📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| let (last_claim_timestamp_ms, last_claim_block_height) = match moment { | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::BlockBasedMoment(height) => { | |
| (0, height) // No timestamp available for block-based | |
| }, | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::TimeBasedMoment(timestamp) => { | |
| (timestamp, 0) // No block height available for time-based | |
| }, | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::EpochBasedMoment(epoch) => { | |
| (0, epoch as u64) // Convert epoch to u64, no timestamp available | |
| }, | |
| }; | |
| // --- Update the response struct to include the moment type --- | |
| #[derive(Serialize, Deserialize, Debug)] | |
| #[serde(rename_all = "camelCase")] | |
| struct LastClaimResponse { | |
| moment_type: String, | |
| last_claim_timestamp_ms: u64, | |
| last_claim_block_height: u64, | |
| } | |
| // ... later, inside `get_token_perpetual_distribution_last_claim` ... | |
| let (last_claim_timestamp_ms, last_claim_block_height) = match moment { | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::BlockBasedMoment(height) => { | |
| (0, height) // No timestamp available for block-based | |
| }, | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::TimeBasedMoment(timestamp) => { | |
| (timestamp, 0) // No block height available for time-based | |
| }, | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::EpochBasedMoment(epoch) => { | |
| (0, epoch as u64) // Convert epoch to u64, no timestamp available | |
| }, | |
| }; | |
| // New: derive a human‐readable moment_type | |
| let moment_type = match moment { | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::BlockBasedMoment(_) => "block", | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::TimeBasedMoment(_) => "time", | |
| dash_sdk::dpp::data_contract::associated_token::token_perpetual_distribution::reward_distribution_moment::RewardDistributionMoment::EpochBasedMoment(_) => "epoch", | |
| } | |
| .to_string(); | |
| let response = LastClaimResponse { | |
| moment_type, | |
| last_claim_timestamp_ms, | |
| last_claim_block_height, | |
| }; |
🤖 Prompt for AI Agents
In packages/wasm-sdk/src/queries/token.rs around lines 439 to 449, the code
returns 0 for either last_claim_timestamp_ms or last_claim_block_height based on
the moment type, which can be unclear. Add a new field to the response structure
to explicitly indicate the moment type (e.g., BlockBased, TimeBased, EpochBased)
and update the response creation logic to include this field alongside the
existing timestamp and block height values.
| web_sys::console::log_1(&JsValue::from_str(&format!( | ||
| "Derived public key (hex): {}", | ||
| hex::encode(&public_key_bytes) | ||
| ))); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove or conditionalize debug logging
Debug console.log statements should be removed or wrapped in a debug flag for production code.
- // Log debug information
- web_sys::console::log_1(&JsValue::from_str(&format!(
- "Derived public key (hex): {}",
- hex::encode(&public_key_bytes)
- )));
+ // Only log in debug mode
+ #[cfg(debug_assertions)]
+ {
+ web_sys::console::log_1(&JsValue::from_str(&format!(
+ "Derived public key (hex): {}",
+ hex::encode(&public_key_bytes)
+ )));
+ }Also applies to: 217-225
🤖 Prompt for AI Agents
In packages/wasm-sdk/src/state_transitions/documents/mod.rs around lines 184 to
187 and also lines 217 to 225, the debug logging using web_sys::console::log_1
should be removed or wrapped in a conditional debug flag to prevent debug output
in production. Refactor these console log statements to only execute when a
debug mode or feature flag is enabled, ensuring no debug logs appear in
production builds.
| let entropy_bytes = { | ||
| let mut entropy = [0u8; 32]; | ||
| if let Some(window) = web_sys::window() { | ||
| if let Ok(crypto) = window.crypto() { | ||
| let _ = crypto.get_random_values_with_u8_array(&mut entropy); | ||
| } | ||
| } | ||
| entropy | ||
| }; |
There was a problem hiding this comment.
Add fallback or error handling for entropy generation
The entropy generation could fail silently if the crypto API is unavailable, resulting in predictable all-zero entropy.
// Generate entropy for the state transition
let entropy_bytes = {
let mut entropy = [0u8; 32];
if let Some(window) = web_sys::window() {
if let Ok(crypto) = window.crypto() {
let _ = crypto.get_random_values_with_u8_array(&mut entropy);
+ } else {
+ return Err(JsValue::from_str("Crypto API not available for entropy generation"));
}
+ } else {
+ return Err(JsValue::from_str("Window object not available for entropy generation"));
}
entropy
};📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| let entropy_bytes = { | |
| let mut entropy = [0u8; 32]; | |
| if let Some(window) = web_sys::window() { | |
| if let Ok(crypto) = window.crypto() { | |
| let _ = crypto.get_random_values_with_u8_array(&mut entropy); | |
| } | |
| } | |
| entropy | |
| }; | |
| // Generate entropy for the state transition | |
| let entropy_bytes = { | |
| let mut entropy = [0u8; 32]; | |
| if let Some(window) = web_sys::window() { | |
| if let Ok(crypto) = window.crypto() { | |
| let _ = crypto.get_random_values_with_u8_array(&mut entropy); | |
| } else { | |
| return Err(JsValue::from_str("Crypto API not available for entropy generation")); | |
| } | |
| } else { | |
| return Err(JsValue::from_str("Window object not available for entropy generation")); | |
| } | |
| entropy | |
| }; |
🤖 Prompt for AI Agents
In packages/wasm-sdk/src/state_transitions/documents/mod.rs around lines 1474 to
1482, the entropy generation silently fails by returning all-zero bytes if the
crypto API is unavailable. Add proper error handling or a fallback mechanism to
ensure entropy is not predictable. For example, return a Result type or panic
with an error message if entropy cannot be securely generated, or implement an
alternative entropy source to avoid using zeroed bytes.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (4)
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (2)
181-253: Suggest refactoring to reduce code duplication.The
token_mintfunction is well-implemented with good error handling and documentation. However, it shares approximately 80% of its logic withtoken_burn, creating significant code duplication.Consider extracting common operations into additional helper functions:
- Token operation setup (parameter parsing, contract fetching, nonce retrieval)
- State transition execution (broadcasting and result formatting)
This would improve maintainability and reduce the risk of inconsistencies between token operations.
271-335: Approve implementation but suggest addressing code duplication.The
token_burnfunction is correctly implemented with proper error handling and follows the same pattern astoken_mint. However, the significant code duplication between these functions should be addressed through refactoring as mentioned in the previous comment.packages/wasm-sdk/src/state_transitions/documents/mod.rs (2)
102-110: Conditionalize debug logging for production buildsDebug console logging should be wrapped in conditional compilation to prevent debug output in production builds.
- // Log debug information - web_sys::console::log_1(&JsValue::from_str(&format!( - "Looking for authentication key with public key: {}", - hex::encode(&public_key_bytes) - ))); - web_sys::console::log_1(&JsValue::from_str(&format!( - "Public key hash160: {}", - hex::encode(&public_key_hash160) - ))); + // Only log in debug mode + #[cfg(debug_assertions)] + { + web_sys::console::log_1(&JsValue::from_str(&format!( + "Looking for authentication key with public key: {}", + hex::encode(&public_key_bytes) + ))); + web_sys::console::log_1(&JsValue::from_str(&format!( + "Public key hash160: {}", + hex::encode(&public_key_hash160) + ))); + }And also for the matching key found logging:
- if matches { - web_sys::console::log_1(&JsValue::from_str(&format!( - "Found matching key: ID={}, Type={:?}", - key.id(), - key.key_type() - ))); - } + #[cfg(debug_assertions)] + if matches { + web_sys::console::log_1(&JsValue::from_str(&format!( + "Found matching key: ID={}, Type={:?}", + key.id(), + key.key_type() + ))); + }Also applies to: 132-137
1276-1284: Add proper error handling for entropy generationThe entropy generation could fail silently if the crypto API is unavailable, resulting in predictable all-zero entropy which compromises security.
// Generate entropy for the state transition let entropy_bytes = { let mut entropy = [0u8; 32]; if let Some(window) = web_sys::window() { if let Ok(crypto) = window.crypto() { let _ = crypto.get_random_values_with_u8_array(&mut entropy); + } else { + return Err(JsValue::from_str("Crypto API not available for entropy generation")); } + } else { + return Err(JsValue::from_str("Window object not available for entropy generation")); } entropy };
🧹 Nitpick comments (3)
packages/dash-platform-balance-checker/src/main_simple.rs (1)
51-114: Consider refactoring the deep nested pattern matching for better maintainability.While the response handling logic is functionally correct and properly handles all expected cases, the deep nesting (4-5 levels) significantly impacts readability and maintainability. Consider extracting helper functions to flatten the structure.
Example refactor approach:
// Extract helper functions fn extract_identity_from_response(response: GetIdentityResponse) -> Option<Vec<u8>> { response.inner.version? .v0()? .result? .identity() } fn extract_balance_from_response(response: GetIdentityBalanceResponse) -> Option<u64> { response.inner.version? .v0()? .result? .balance() }This would make the main logic more readable while maintaining the same functionality.
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (1)
352-437: Document implementation timeline for stub functions.The token transfer, freeze, unfreeze, and destroy operations are declared but not yet implemented. While this may be intentional for this PR, consider:
- Adding TODO comments with implementation priorities
- Documenting the expected timeline for these features
- Ensuring the function signatures align with the expected implementation requirements
This will help track progress and ensure consistent API design when these functions are implemented.
packages/wasm-sdk/src/queries/epoch.rs (1)
127-142: Improve efficiency by avoiding unnecessary collection and sort.The code collects all results into a vector and then sorts them, but this could be optimized since the query already specifies the direction.
Consider leveraging the query ordering to avoid the need for explicit sorting:
- // Convert to our response format and sort by epoch index - let mut epochs: Vec<FinalizedEpochInfo> = epochs_result + // Convert to our response format + let epochs: Vec<FinalizedEpochInfo> = epochs_result .into_iter() .filter_map(|(epoch_index, epoch_opt)| { epoch_opt.map(|epoch| { use dash_sdk::dpp::block::finalized_epoch_info::v0::getters::FinalizedEpochInfoGettersV0; FinalizedEpochInfo { index: epoch_index as u16, first_core_block_height: epoch.first_core_block_height(), first_block_height: epoch.first_block_height(), start_time: epoch.first_block_time(), fee_multiplier: epoch.fee_multiplier_permille() as f64 / 1000.0, protocol_version: epoch.protocol_version(), } }) }) .collect(); - - // Sort based on ascending flag - epochs.sort_by(|a, b| { - if is_ascending { - a.index.cmp(&b.index) - } else { - b.index.cmp(&a.index) - } - });The query construction already handles the ordering, so explicit sorting may be redundant.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (9)
packages/dash-platform-balance-checker/src/main_simple.rs(2 hunks)packages/rs-drive-abci/Cargo.toml(1 hunks)packages/rs-drive-abci/src/query/identity_based_queries/identity_by_non_unique_public_key_hash/v0/mod.rs(1 hunks)packages/simple-signer/Cargo.toml(1 hunks)packages/simple-signer/src/lib.rs(1 hunks)packages/strategy-tests/Cargo.toml(1 hunks)packages/wasm-sdk/src/queries/epoch.rs(1 hunks)packages/wasm-sdk/src/state_transitions/documents/mod.rs(1 hunks)packages/wasm-sdk/src/state_transitions/tokens/mod.rs(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/rs-drive-abci/src/query/identity_based_queries/identity_by_non_unique_public_key_hash/v0/mod.rs
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/simple-signer/Cargo.toml
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/dash-platform-balance-checker/src/main_simple.rspackages/simple-signer/src/lib.rspackages/wasm-sdk/src/queries/epoch.rspackages/wasm-sdk/src/state_transitions/tokens/mod.rspackages/wasm-sdk/src/state_transitions/documents/mod.rs
🧠 Learnings (8)
📓 Common learnings
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/mimic/test_quorum.rs:159-164
Timestamp: 2024-11-20T16:16:01.830Z
Learning: QuantumExplorer prefers not to receive auto-generated messages asking to post on social media.
packages/strategy-tests/Cargo.toml (13)
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/Cargo.toml:22-22
Timestamp: 2024-10-29T10:42:00.521Z
Learning: In `packages/rs-dapi-client/Cargo.toml`, `backon` will not work without the `tokio-sleep` feature in our setup, so it's unnecessary to declare `tokio-sleep` as a separate feature in the `[features]` section.
Learnt from: shumkov
PR: dashpay/platform#2375
File: packages/rs-drive-abci/Cargo.toml:61-63
Timestamp: 2024-12-05T09:29:38.918Z
Learning: In the `drive-abci` package, avoid adding unused dependencies like `hashbrown` to `Cargo.toml`. The team relies on CI to detect dependency version issues.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-drive-abci/src/platform_types/platform_state/mod.rs:141-141
Timestamp: 2024-10-08T13:28:03.529Z
Learning: When converting `PlatformStateV0` to `PlatformStateForSavingV1` in `packages/rs-drive-abci/src/platform_types/platform_state/mod.rs`, only version `0` needs to be handled in the match on `platform_state_for_saving_structure_default` because the changes are retroactive.
Learnt from: QuantumExplorer
PR: dashpay/platform#2431
File: packages/rs-drive/Cargo.toml:55-60
Timestamp: 2025-01-19T07:36:46.042Z
Learning: The grovedb dependencies in packages/rs-drive/Cargo.toml and related files are intentionally kept at specific revisions rather than using the latest stable version, with plans to update them at a later time.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-drive-abci/tests/strategy_tests/main.rs:1162-1162
Timestamp: 2024-10-04T09:08:47.901Z
Learning: In the Rust test file `packages/rs-drive-abci/tests/strategy_tests/main.rs`, specific protocol versions like `PROTOCOL_VERSION_1` are intentionally used in tests instead of `PROTOCOL_VERSION_LATEST`.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-drive-abci/tests/strategy_tests/main.rs:1162-1162
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust test file `packages/rs-drive-abci/tests/strategy_tests/main.rs`, specific protocol versions like `PROTOCOL_VERSION_1` are intentionally used in tests instead of `PROTOCOL_VERSION_LATEST`.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2440
File: packages/rs-drive-abci/Cargo.toml:76-76
Timestamp: 2025-01-24T07:54:55.723Z
Learning: In the drive-abci package, bls-signatures is intentionally declared twice:
1. As an optional dependency in [dependencies] to make it an optional feature in production
2. As a non-optional dependency in [dev-dependencies] to ensure it's always available for tests
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use custom serialization with `rs-platform-serialization` for data structures
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use `rs-platform-version` for protocol versioning in platform components
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
packages/rs-drive-abci/Cargo.toml (16)
Learnt from: shumkov
PR: dashpay/platform#2375
File: packages/rs-drive-abci/Cargo.toml:61-63
Timestamp: 2024-12-05T09:29:38.918Z
Learning: In the `drive-abci` package, avoid adding unused dependencies like `hashbrown` to `Cargo.toml`. The team relies on CI to detect dependency version issues.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/Cargo.toml:22-22
Timestamp: 2024-10-29T10:42:00.521Z
Learning: In `packages/rs-dapi-client/Cargo.toml`, `backon` will not work without the `tokio-sleep` feature in our setup, so it's unnecessary to declare `tokio-sleep` as a separate feature in the `[features]` section.
Learnt from: QuantumExplorer
PR: dashpay/platform#2431
File: packages/rs-drive/Cargo.toml:55-60
Timestamp: 2025-01-19T07:36:46.042Z
Learning: The grovedb dependencies in packages/rs-drive/Cargo.toml and related files are intentionally kept at specific revisions rather than using the latest stable version, with plans to update them at a later time.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-drive-abci/src/platform_types/platform_state/mod.rs:141-141
Timestamp: 2024-10-08T13:28:03.529Z
Learning: When converting `PlatformStateV0` to `PlatformStateForSavingV1` in `packages/rs-drive-abci/src/platform_types/platform_state/mod.rs`, only version `0` needs to be handled in the match on `platform_state_for_saving_structure_default` because the changes are retroactive.
Learnt from: QuantumExplorer
PR: dashpay/platform#2440
File: packages/rs-drive-abci/Cargo.toml:76-76
Timestamp: 2025-01-24T07:54:55.723Z
Learning: In the drive-abci package, bls-signatures is intentionally declared twice:
1. As an optional dependency in [dependencies] to make it an optional feature in production
2. As a non-optional dependency in [dev-dependencies] to ensure it's always available for tests
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs:94-94
Timestamp: 2024-11-20T10:01:50.837Z
Learning: In `packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs`, when converting with `PublicKey::try_from`, it's acceptable to use `.expect()` to handle potential conversion errors.
Learnt from: shumkov
PR: dashpay/platform#2305
File: packages/rs-drive-abci/src/abci/handler/finalize_block.rs:81-0
Timestamp: 2024-11-03T10:39:11.242Z
Learning: In `packages/rs-drive-abci/src/abci/handler/finalize_block.rs`, the use of `.expect("commit transaction")` after `app.commit_transaction(platform_version)` is intentional due to the provided comment explaining its necessity. Do not flag this usage in future reviews.
Learnt from: shumkov
PR: dashpay/platform#2489
File: packages/rs-dpp/Cargo.toml:32-32
Timestamp: 2025-03-11T09:39:23.071Z
Learning: In the Dash Platform project, dependencies are currently managed using Git repository references with tags (repo+tag format in Cargo.toml) rather than published crates, as the team is not currently publishing crates to crates.io.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: shumkov
PR: dashpay/platform#2248
File: packages/rs-drive-abci/src/main.rs:106-111
Timestamp: 2024-10-17T08:52:54.300Z
Learning: In this project, the environment variable `CARGO_PKG_RUST_VERSION` is defined and can be used safely with the `env!` macro.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-drive-abci/tests/strategy_tests/main.rs:1162-1162
Timestamp: 2024-10-04T09:08:47.901Z
Learning: In the Rust test file `packages/rs-drive-abci/tests/strategy_tests/main.rs`, specific protocol versions like `PROTOCOL_VERSION_1` are intentionally used in tests instead of `PROTOCOL_VERSION_LATEST`.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-drive-abci/tests/strategy_tests/main.rs:1162-1162
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust test file `packages/rs-drive-abci/tests/strategy_tests/main.rs`, specific protocol versions like `PROTOCOL_VERSION_1` are intentionally used in tests instead of `PROTOCOL_VERSION_LATEST`.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
packages/dash-platform-balance-checker/src/main_simple.rs (18)
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-drive-abci/src/platform_types/platform_state/mod.rs:141-141
Timestamp: 2024-10-08T13:28:03.529Z
Learning: When converting `PlatformStateV0` to `PlatformStateForSavingV1` in `packages/rs-drive-abci/src/platform_types/platform_state/mod.rs`, only version `0` needs to be handled in the match on `platform_state_for_saving_structure_default` because the changes are retroactive.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: shumkov
PR: dashpay/platform#2317
File: packages/rs-dapi-client/src/address_list.rs:175-180
Timestamp: 2024-11-28T13:49:17.301Z
Learning: In Rust code in `packages/rs-dapi-client/src/address_list.rs`, do not change the interface of deprecated methods like `add_uri`, even to fix potential panics.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/executor.rs:49-56
Timestamp: 2024-10-28T10:38:49.538Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, the `ExecutionResponse` struct always has a non-optional `address` field of type `Address` because an address is always present when there's a successful response.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: lklimek
PR: dashpay/platform#2337
File: packages/rs-dapi-client/src/executor.rs:161-212
Timestamp: 2024-11-20T14:14:54.721Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, the `WrapWithExecutionResult` trait supports on-the-fly type conversions using the `From` trait, which is useful when using the `?` operator to return errors.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/platform/fetch_unproved.rs:0-0
Timestamp: 2024-10-30T11:04:33.634Z
Learning: In `packages/rs-sdk/src/platform/fetch_unproved.rs`, the `execute()` method consumes the request object, so cloning the request is necessary before passing it to `execute()` and `maybe_from_unproved_with_metadata`.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-04T14:16:05.798Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
packages/simple-signer/src/lib.rs (6)
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/Cargo.toml:22-22
Timestamp: 2024-10-29T10:42:00.521Z
Learning: In `packages/rs-dapi-client/Cargo.toml`, `backon` will not work without the `tokio-sleep` feature in our setup, so it's unnecessary to declare `tokio-sleep` as a separate feature in the `[features]` section.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs:94-94
Timestamp: 2024-11-20T10:01:50.837Z
Learning: In `packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs`, when converting with `PublicKey::try_from`, it's acceptable to use `.expect()` to handle potential conversion errors.
packages/wasm-sdk/src/queries/epoch.rs (20)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: QuantumExplorer
PR: dashpay/platform#2559
File: packages/rs-drive-abci/src/query/token_queries/token_perpetual_distribution_last_claim/v0/mod.rs:128-0
Timestamp: 2025-04-21T00:38:44.796Z
Learning: In the Dash Platform codebase, EpochIndex is defined as u16, making it safe to cast to u32 without overflow concerns.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-dpp/src/data_contract/associated_token/token_perpetual_distribution/v0/methods.rs:10-12
Timestamp: 2025-02-03T23:39:10.579Z
Learning: Block interval calculations in token distribution logic should use checked arithmetic operations (checked_sub, checked_add) to prevent potential overflows, especially when dealing with block heights and intervals.
Learnt from: QuantumExplorer
PR: dashpay/platform#2584
File: packages/rs-dpp/src/data_contract/methods/registration_cost/v1/mod.rs:31-78
Timestamp: 2025-05-02T18:13:31.615Z
Learning: In fee calculation contexts, saturating arithmetic operations (like saturating_add and saturating_mul) are acceptable as users would never practically be able to pay fees approaching u64::MAX. Explicit overflow checking is unnecessary in these scenarios.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-08T13:25:15.577Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-21T01:03:42.458Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-09T00:22:57.778Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-03T05:17:52.648Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:119-120
Timestamp: 2024-10-06T16:18:07.994Z
Learning: In the `run_block_proposal` function in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, it's acceptable to pass `platform_state` to `perform_events_on_first_block_of_protocol_change`, even if `block_platform_state` has been updated.
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (18)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: shumkov
PR: dashpay/platform#2305
File: packages/rs-drive-abci/src/abci/handler/finalize_block.rs:81-0
Timestamp: 2024-11-03T10:39:11.242Z
Learning: In `packages/rs-drive-abci/src/abci/handler/finalize_block.rs`, the use of `.expect("commit transaction")` after `app.commit_transaction(platform_version)` is intentional due to the provided comment explaining its necessity. Do not flag this usage in future reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
Learnt from: lklimek
PR: dashpay/platform#2318
File: .github/workflows/tests-build-image.yml:45-45
Timestamp: 2024-11-13T10:31:30.891Z
Learning: In the dashpay/platform repository, changes to `.github/workflows/tests-build-image.yml` that switch the Docker image platform from `linux/arm64` to `linux/amd64` for testing purposes are acceptable when required to run on GitHub-hosted runners. ARM64 testing is covered on the testnet.
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: lklimek
PR: dashpay/platform#1924
File: packages/rs-sdk/src/sdk.rs:855-870
Timestamp: 2024-12-03T15:00:50.385Z
Learning: In `packages/rs-sdk/src/sdk.rs`, remember that `rustls_pemfile::certs` returns an iterator over `Result`, not a `Result` directly. Handle it accordingly in future code reviews.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-dpp/src/data_contract/associated_token/token_perpetual_distribution/v0/methods.rs:10-12
Timestamp: 2025-02-03T23:39:10.579Z
Learning: Block interval calculations in token distribution logic should use checked arithmetic operations (checked_sub, checked_add) to prevent potential overflows, especially when dealing with block heights and intervals.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount from crate::balances::credits is compatible with u64 when used for token base supply.
Learnt from: QuantumExplorer
PR: dashpay/platform#2432
File: packages/rs-dpp/src/data_contract/associated_token/token_configuration/v0/mod.rs:222-225
Timestamp: 2025-01-20T16:20:59.791Z
Learning: In the Dash Platform codebase, TokenAmount is defined as `type TokenAmount = u64` in balances/credits.rs, making it directly compatible with u64 values without any conversion needed.
packages/wasm-sdk/src/state_transitions/documents/mod.rs (38)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs:94-94
Timestamp: 2024-11-20T10:01:50.837Z
Learning: In `packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs`, when converting with `PublicKey::try_from`, it's acceptable to use `.expect()` to handle potential conversion errors.
Learnt from: shumkov
PR: dashpay/platform#2298
File: packages/dashmate/src/listr/tasks/ssl/zerossl/cleanupZeroSSLCertificatesTaskFactory.js:66-69
Timestamp: 2024-10-31T15:43:16.094Z
Learning: In Listr tasks, when in debug mode, prefer using `console.warn` for logging instead of `task.output`.
Learnt from: shumkov
PR: dashpay/platform#2449
File: packages/rs-drive-abci/src/execution/platform_events/initialization/create_genesis_state/test/tokens.rs:107-150
Timestamp: 2025-03-13T07:24:37.295Z
Learning: In the RS SDK test data generation code, logging private keys is intentional and only enabled when a developer explicitly chooses to enable it, which is acceptable in test code contexts.
Learnt from: lklimek
PR: dashpay/platform#2381
File: packages/rs-sdk/scripts/connect_to_remote.sh:0-0
Timestamp: 2024-12-10T12:39:38.182Z
Learning: When reviewing scripts in `packages/rs-sdk/scripts/`, avoid suggesting additional error handling and timeout management that complicate the script without adding significant value.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/mock_fetch.rs:159-159
Timestamp: 2024-10-30T11:04:54.154Z
Learning: In Rust tests, only include `setup_logs()` when logging is necessary; there's no need to add it to every test.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: shumkov
PR: dashpay/platform#2201
File: packages/rs-platform-version/src/version/v2.rs:1186-1188
Timestamp: 2024-10-03T11:51:06.980Z
Learning: In the `IdentityTransitionVersions` structure within `packages/rs-platform-version/src/version/v2.rs`, the field `credit_withdrawal` does not need the `identity_` prefix since it is already encompassed within identity state transitions.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/wallet-utils-contract/src/lib.rs:14-17
Timestamp: 2024-11-25T07:48:09.831Z
Learning: In the `wallet-utils-contract` (file `packages/wallet-utils-contract/src/lib.rs`), the `OWNER_ID_BYTES` constant is intentionally initialized to all zeros.
Learnt from: lklimek
PR: dashpay/platform#1924
File: packages/rs-sdk/src/sdk.rs:855-870
Timestamp: 2024-12-03T15:00:50.385Z
Learning: In `packages/rs-sdk/src/sdk.rs`, remember that `rustls_pemfile::certs` returns an iterator over `Result`, not a `Result` directly. Handle it accordingly in future code reviews.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-dapi-client/src/transport/wasm_channel.rs:100-114
Timestamp: 2025-01-23T08:59:30.805Z
Learning: In WebAssembly context, using panic for unrecoverable errors (like oneshot channel failures) is an acceptable pattern when properly documented, as recovery might not be meaningful in such cases.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-dapi-client/src/transport/wasm_channel.rs:100-114
Timestamp: 2025-01-23T08:59:30.805Z
Learning: In WebAssembly context, using panic for unrecoverable errors (like oneshot channel failures) is an acceptable pattern when properly documented, as recovery might not be meaningful in such cases.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-dapi-client/src/transport/wasm_channel.rs:100-114
Timestamp: 2025-01-23T08:59:30.805Z
Learning: In WebAssembly context, using panic for unrecoverable errors (like oneshot channel failures) is an acceptable pattern when properly documented, as recovery might not be meaningful in such cases.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-drive-abci/src/platform_types/platform_state/mod.rs:141-141
Timestamp: 2024-10-08T13:28:03.529Z
Learning: When converting `PlatformStateV0` to `PlatformStateForSavingV1` in `packages/rs-drive-abci/src/platform_types/platform_state/mod.rs`, only version `0` needs to be handled in the match on `platform_state_for_saving_structure_default` because the changes are retroactive.
Learnt from: shumkov
PR: dashpay/platform#2305
File: packages/rs-drive-abci/src/abci/handler/finalize_block.rs:81-0
Timestamp: 2024-11-03T10:39:11.242Z
Learning: In `packages/rs-drive-abci/src/abci/handler/finalize_block.rs`, the use of `.expect("commit transaction")` after `app.commit_transaction(platform_version)` is intentional due to the provided comment explaining its necessity. Do not flag this usage in future reviews.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2318
File: .github/workflows/tests-build-image.yml:45-45
Timestamp: 2024-11-13T10:31:30.891Z
Learning: In the dashpay/platform repository, changes to `.github/workflows/tests-build-image.yml` that switch the Docker image platform from `linux/arm64` to `linux/amd64` for testing purposes are acceptable when required to run on GitHub-hosted runners. ARM64 testing is covered on the testnet.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
Learnt from: pauldelucia
PR: dashpay/platform#2523
File: packages/rs-drive/src/drive/contract/update/update_contract/v1/update_description/v1/mod.rs:147-151
Timestamp: 2025-04-11T09:08:05.652Z
Learning: Description length validation for data contracts (ensuring it's between 3 and 100 characters) is already handled at the data contract validation level in packages/rs-dpp/src/data_contract/methods/validate_update/v0/mod.rs, making additional checks in the update operations redundant.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: shumkov
PR: dashpay/platform#2182
File: packages/rs-platform-version/src/version/drive_abci_versions.rs:116-121
Timestamp: 2024-09-29T13:13:54.230Z
Learning: Adding Rust doc comments to structs and fields is recommended to enhance clarity and documentation.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/core_types/validator_set/v0/mod.rs:299-299
Timestamp: 2024-10-21T01:03:42.458Z
Learning: In the `test_serialize_deserialize_validator_set_v0` test within `packages/rs-dpp/src/core_types/validator_set/v0/mod.rs`, deterministic BLS keys cannot be easily used; therefore, using `BlsPublicKey::generate()` is acceptable.
Learnt from: lklimek
PR: dashpay/platform#2337
File: packages/rs-dapi-client/src/executor.rs:161-212
Timestamp: 2024-11-20T14:14:54.721Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, the `WrapWithExecutionResult` trait supports on-the-fly type conversions using the `From` trait, which is useful when using the `?` operator to return errors.
Learnt from: shumkov
PR: dashpay/platform#2317
File: packages/rs-dapi-client/src/address_list.rs:175-180
Timestamp: 2024-11-28T13:49:17.301Z
Learning: In Rust code in `packages/rs-dapi-client/src/address_list.rs`, do not change the interface of deprecated methods like `add_uri`, even to fix potential panics.
Learnt from: shumkov
PR: dashpay/platform#2270
File: packages/dapi/lib/grpcServer/handlers/platform/broadcastStateTransitionHandlerFactory.js:90-96
Timestamp: 2024-10-24T05:01:51.097Z
Learning: In `broadcastStateTransitionHandlerFactory.js`, error handling when querying transaction status is handled in the API script.
🧬 Code Graph Analysis (3)
packages/dash-platform-balance-checker/src/main_simple.rs (1)
packages/dapi-grpc/clients/platform/v0/web/platform_pb.d.ts (4)
GetIdentityBalanceRequest(333-348)GetIdentityRequest(165-180)GetIdentityRequestV0(187-204)GetIdentityBalanceRequestV0(355-372)
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (7)
packages/wasm-sdk/src/state_transitions/documents/mod.rs (4)
state_transition(290-291)state_transition(595-596)document(1079-1081)transition(1125-1126)packages/wasm-sdk/src/state_transitions/contracts/mod.rs (1)
state_transition(296-297)packages/wasm-sdk/src/state_transitions/identity/mod.rs (2)
state_transition(133-134)state_transition(490-491)packages/rs-dpp/src/tokens/mod.rs (1)
calculate_token_id(27-32)packages/rs-sdk/src/platform/fetch.rs (1)
fetch(92-97)packages/rs-sdk-trusted-context-provider/src/provider.rs (1)
new(96-103)packages/wasm-sdk/src/sdk.rs (1)
from(43-45)
packages/wasm-sdk/src/state_transitions/documents/mod.rs (6)
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (2)
state_transition(246-247)state_transition(328-329)packages/wasm-sdk/src/state_transitions/contracts/mod.rs (1)
state_transition(296-297)packages/wasm-sdk/src/state_transitions/identity/mod.rs (2)
state_transition(133-134)state_transition(490-491)packages/rs-sdk-trusted-context-provider/src/provider.rs (1)
new(96-103)packages/wasm-sdk/src/sdk.rs (1)
network(55-57)packages/rs-sdk/src/platform/documents/document_query.rs (1)
new_with_data_contract_id(88-102)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: Rust packages (dash-sdk) / Unused dependencies
- GitHub Check: Rust packages (dash-sdk) / Linting
- GitHub Check: Rust packages (dash-sdk) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Tests
- GitHub Check: Rust packages (dash-sdk) / Formatting
- GitHub Check: Rust packages (drive-abci) / Unused dependencies
- GitHub Check: Rust packages (drive-abci) / Linting
- GitHub Check: Rust packages (drive-abci) / Tests
- GitHub Check: Rust packages (drive-abci) / Check each feature
- GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
- 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 JS packages / Build JS
- GitHub Check: build-wasm-sdk
🔇 Additional comments (13)
packages/dash-platform-balance-checker/src/main_simple.rs (5)
3-4: Import changes look correct for the new protobuf API style.The added imports properly support the versioned request/response pattern and the new unified execution approach.
Also applies to: 7-7
40-46: Request construction correctly implements the versioned protobuf pattern.The change from direct field setting to the nested
version: Some(get_identity_request::Version::V0(...))structure properly follows the new API design.
49-49: Method call correctly uses the unified execution approach.The change from a direct method call to
dapi.execute(request, RequestSettings::default())aligns with the architectural shift described in the PR objectives.
64-71: Balance request construction follows the same correct versioned pattern.The implementation is consistent with the identity request and properly constructs the versioned message structure.
84-87: Credit to DASH conversion calculation is correct.The division by 100_000_000.0 properly converts from credits (smallest unit) to DASH, which uses 8 decimal places.
packages/strategy-tests/Cargo.toml (1)
38-38: LGTM! Feature enablement aligns with PR objectives.The addition of the
"state-transitions"feature to thesimple-signerdependency is appropriate and necessary for enabling state transition signing capabilities in strategy tests.packages/rs-drive-abci/Cargo.toml (1)
33-33: LGTM! Consistent feature enablement.The addition of the
"state-transitions"feature to thesimple-signerdependency is consistent with other packages and necessary for the enhanced WASM SDK functionality.packages/simple-signer/src/lib.rs (1)
1-6: LGTM! Well-structured conditional compilation.The restructuring appropriately:
- Conditionally compiles the
signermodule only when the"state-transitions"feature is enabled- Makes
SingleKeySigneralways available through the newsingle_key_signermodule- Provides convenient access via re-export at the crate root
This supports flexible feature-based compilation while maintaining essential functionality.
packages/wasm-sdk/src/state_transitions/tokens/mod.rs (2)
1-25: LGTM! Comprehensive module structure.The imports and module structure are well-organized with appropriate dependencies for token state transition functionality. The documentation clearly explains the module's purpose.
27-160: LGTM! Well-designed helper functions.The helper functions provide excellent separation of concerns:
parse_token_params: Clean parameter validation and parsingfetch_and_cache_token_contract: Proper caching integration with trusted contextscreate_signer_and_public_key: Consolidated signer creation (addresses previous redundancy issues)format_token_result: Comprehensive result formatting for different proof typesThe network is correctly retrieved from
sdk.networkinstead of being hardcoded, addressing previous concerns.packages/wasm-sdk/src/state_transitions/documents/mod.rs (1)
32-1319: Well-structured implementation with good separation of concernsThe document state transition implementations follow a consistent and well-organized pattern:
- Helper functions effectively reduce code duplication and provide reusable utilities for identifier parsing, contract caching, key matching, and result building
- Consistent error handling across all operations with appropriate error messages
- Proper async/await usage for network operations
- Uniform result format using JavaScript objects with consistent field names
The code demonstrates good WASM binding practices and maintains consistency with the broader SDK architecture.
packages/wasm-sdk/src/queries/epoch.rs (2)
35-65: LGTM! Well-structured epoch query implementation.The function properly handles query construction, error handling, and response serialization. The use of
filter_mapto handle optional epochs is appropriate.
308-318: LGTM! Clean and straightforward current epoch implementation.The function correctly fetches and converts the current epoch information with proper error handling.
| Some(dapi_grpc::platform::v0::get_evonodes_proposed_epoch_blocks_response::get_evonodes_proposed_epoch_blocks_response_v0::Result::Proof(_)) => { | ||
| // For proof responses, we would need to verify the proof | ||
| // For now, return empty as proof verification is complex | ||
| vec![] |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document the proof verification limitation clearly.
The function returns an empty vector for proof responses without clear documentation about this limitation, which could mislead users expecting actual proof verification.
Add clear documentation about the current limitation:
Some(dapi_grpc::platform::v0::get_evonodes_proposed_epoch_blocks_response::get_evonodes_proposed_epoch_blocks_response_v0::Result::Proof(_)) => {
- // For proof responses, we would need to verify the proof
- // For now, return empty as proof verification is complex
+ // TODO: Implement proof verification
+ // Currently returns empty as proof verification is not yet implemented
+ // Users should be aware this provides incomplete functionality
vec![]
}🤖 Prompt for AI Agents
In packages/wasm-sdk/src/queries/epoch.rs around lines 229 to 232, the code
returns an empty vector for proof responses without verifying the proof, but
this limitation is not clearly documented. Add a clear comment explaining that
proof verification is currently not implemented and that the empty vector is a
placeholder, so users understand this limitation and do not expect actual proof
verification results.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/simple-signer/src/single_key_signer.rs (2)
49-56: Network parameter inconsistency in auto-detection.The
networkparameter is ignored when parsing WIF strings, asPrivateKey::from_wif()extracts the network from the WIF format itself. This could lead to confusion if the caller expects the network parameter to be validated against the WIF-encoded network.Consider validating that the network parameter matches the network encoded in the WIF:
pub fn from_string(private_key_str: &str, network: dashcore::Network) -> Result<Self, String> { // Try hex first if it looks like hex, then WIF if private_key_str.len() == 64 && private_key_str.chars().all(|c| c.is_ascii_hexdigit()) { Self::from_hex(private_key_str, network) } else { - Self::new(private_key_str) + let signer = Self::new(private_key_str)?; + if signer.private_key.network != network { + return Err(format!("WIF network ({:?}) doesn't match expected network ({:?})", + signer.private_key.network, network)); + } + Ok(signer) } }
83-123: Refactor to reduce code duplication in public key derivation.The
can_sign_with()method contains duplicate code for deriving the public key from the private key in both ECDSA key type branches.Extract the common public key derivation logic:
fn can_sign_with(&self, identity_public_key: &IdentityPublicKey) -> bool { - // Check if the public key matches our private key + // Helper function to derive public key from private key + let derive_public_key = || -> Option<dashcore::secp256k1::PublicKey> { + let secp = dashcore::secp256k1::Secp256k1::new(); + let secret_key = dashcore::secp256k1::SecretKey::from_slice( + &self.private_key.inner.secret_bytes(), + ).ok()?; + Some(dashcore::secp256k1::PublicKey::from_secret_key(&secp, &secret_key)) + }; + + let public_key = match derive_public_key() { + Some(pk) => pk, + None => return false, + }; + match identity_public_key.key_type() { KeyType::ECDSA_SECP256K1 => { // Compare full public key - let secp = dashcore::secp256k1::Secp256k1::new(); - let secret_key = match dashcore::secp256k1::SecretKey::from_slice( - &self.private_key.inner.secret_bytes(), - ) { - Ok(sk) => sk, - Err(_) => return false, - }; - let public_key = - dashcore::secp256k1::PublicKey::from_secret_key(&secp, &secret_key); let public_key_bytes = public_key.serialize(); identity_public_key.data().as_slice() == public_key_bytes } KeyType::ECDSA_HASH160 => { // Compare hash160 of public key use dashcore::hashes::{hash160, Hash}; - - let secp = dashcore::secp256k1::Secp256k1::new(); - let secret_key = match dashcore::secp256k1::SecretKey::from_slice( - &self.private_key.inner.secret_bytes(), - ) { - Ok(sk) => sk, - Err(_) => return false, - }; - let public_key = - dashcore::secp256k1::PublicKey::from_secret_key(&secp, &secret_key); let public_key_bytes = public_key.serialize(); let public_key_hash160 = hash160::Hash::hash(&public_key_bytes) .to_byte_array() .to_vec(); identity_public_key.data().as_slice() == public_key_hash160.as_slice() } _ => false, // We only support ECDSA keys } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/simple-signer/src/single_key_signer.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/simple-signer/src/single_key_signer.rs
🧠 Learnings (2)
📓 Common learnings
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/mimic/test_quorum.rs:159-164
Timestamp: 2024-11-20T16:16:01.830Z
Learning: QuantumExplorer prefers not to receive auto-generated messages asking to post on social media.
packages/simple-signer/src/single_key_signer.rs (7)
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs:19-30
Timestamp: 2024-10-06T16:11:34.946Z
Learning: In the Rust file `packages/rs-drive-abci/src/execution/platform_events/core_based_updates/update_masternode_identities/create_owner_identity/v1/mod.rs`, within the `create_owner_identity_v1` function, the `add_public_keys` method of the `Identity` struct cannot fail and does not require explicit error handling.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/core_types/validator_set/v0/mod.rs:299-299
Timestamp: 2024-10-21T01:03:42.458Z
Learning: In the `test_serialize_deserialize_validator_set_v0` test within `packages/rs-dpp/src/core_types/validator_set/v0/mod.rs`, deterministic BLS keys cannot be easily used; therefore, using `BlsPublicKey::generate()` is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2235
File: packages/rs-dpp/src/identity/identity_public_key/v0/methods/mod.rs:8-9
Timestamp: 2024-10-10T05:10:50.059Z
Learning: In the codebase, importing `Secp256k1` from `dashcore::key::Secp256k1` is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs:94-94
Timestamp: 2024-11-20T10:01:50.837Z
Learning: In `packages/rs-drive-abci/src/platform_types/platform_state/v0/old_structures/mod.rs`, when converting with `PublicKey::try_from`, it's acceptable to use `.expect()` to handle potential conversion errors.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (16)
- GitHub Check: Rust packages (drive-abci) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Detect immutable structure changes
- GitHub Check: Rust packages (dash-sdk) / Tests
- GitHub Check: Rust packages (dash-sdk) / Unused dependencies
- GitHub Check: Rust packages (drive-abci) / Tests
- GitHub Check: Rust packages (dash-sdk) / Linting
- GitHub Check: Rust packages (drive-abci) / Unused dependencies
- GitHub Check: Rust packages (drive-abci) / Linting
- GitHub Check: Rust packages (drive-abci) / Formatting
- 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
- GitHub Check: Rust crates security audit
- GitHub Check: build-wasm-sdk
🔇 Additional comments (3)
packages/simple-signer/src/single_key_signer.rs (3)
64-81: Well-implemented signing method with proper error handling.The
sign()method correctly handles only supported ECDSA key types and provides clear error messages for unsupported key types. The use ofdashcore::signer::sign()and proper error propagation is appropriate.
16-47: Comprehensive constructor methods with good validation.The multiple constructor methods provide flexible ways to create the signer from different key formats. The validation in
from_hex()is thorough, checking both string length and decoded byte length.
131-172: Good test coverage for the main functionality.The tests cover WIF creation, hex creation, and auto-detection functionality. The test data uses valid key formats and verifies expected behaviors.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
packages/wasm-sdk/src/queries/epoch.rs (1)
67-76: Remove code duplication between EpochInfo and FinalizedEpochInfo structs.The
FinalizedEpochInfostruct is identical toEpochInfostruct defined earlier. This creates unnecessary code duplication and maintenance burden.
🧹 Nitpick comments (1)
packages/wasm-sdk/src/queries/epoch.rs (1)
207-207: Consider more robust error handling for hash conversion.The code uses
.unwrap()when converting bytes to hash, which could panic if the conversion fails. While this might be acceptable for internal SDK data, consider using proper error handling for better robustness.- let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes).unwrap(); + let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes) + .map_err(|e| JsError::new(&format!("Failed to convert bytes to hash: {}", e)))?;Apply similar change to both occurrences (lines 207 and 270).
Also applies to: 270-270
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/wasm-sdk/src/queries/epoch.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/wasm-sdk/src/queries/epoch.rs
🧠 Learnings (2)
📓 Common learnings
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/mimic/test_quorum.rs:159-164
Timestamp: 2024-11-20T16:16:01.830Z
Learning: QuantumExplorer prefers not to receive auto-generated messages asking to post on social media.
packages/wasm-sdk/src/queries/epoch.rs (30)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: QuantumExplorer
PR: dashpay/platform#2559
File: packages/rs-drive-abci/src/query/token_queries/token_perpetual_distribution_last_claim/v0/mod.rs:128-0
Timestamp: 2025-04-21T00:38:44.796Z
Learning: In the Dash Platform codebase, EpochIndex is defined as u16, making it safe to cast to u32 without overflow concerns.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-dpp/src/data_contract/associated_token/token_perpetual_distribution/v0/methods.rs:10-12
Timestamp: 2025-02-03T23:39:10.579Z
Learning: Block interval calculations in token distribution logic should use checked arithmetic operations (checked_sub, checked_add) to prevent potential overflows, especially when dealing with block heights and intervals.
Learnt from: QuantumExplorer
PR: dashpay/platform#2584
File: packages/rs-dpp/src/data_contract/methods/registration_cost/v1/mod.rs:31-78
Timestamp: 2025-05-02T18:13:31.615Z
Learning: In fee calculation contexts, saturating arithmetic operations (like saturating_add and saturating_mul) are acceptable as users would never practically be able to pay fees approaching u64::MAX. Explicit overflow checking is unnecessary in these scenarios.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-08T13:25:15.577Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-21T01:03:42.458Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-09T00:22:57.778Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-03T05:17:52.648Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:119-120
Timestamp: 2024-10-06T16:18:07.994Z
Learning: In the `run_block_proposal` function in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, it's acceptable to pass `platform_state` to `perform_events_on_first_block_of_protocol_change`, even if `block_platform_state` has been updated.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:93-99
Timestamp: 2024-11-22T08:19:14.448Z
Learning: In `packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs`, the `insert_contract` method requires an owned `BlockInfo`, so cloning `block_info` is necessary when calling it.
Learnt from: QuantumExplorer
PR: dashpay/platform#2347
File: packages/rs-drive/tests/query_tests.rs:438-460
Timestamp: 2024-11-25T01:17:02.001Z
Learning: In Rust test files (`packages/rs-drive/tests/query_tests.rs`), when code is used only in tests, defining explicit enums for fields (like the `status` field in the `Withdrawal` struct) may not be necessary; using primitive types is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2332
File: packages/rs-drive-proof-verifier/src/error.rs:21-23
Timestamp: 2024-11-15T14:39:23.704Z
Learning: In the `packages/rs-drive-proof-verifier`, avoid suggesting size limits for `proof_bytes` in errors unless there's a specific need, as it may not be necessary.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-04T14:16:05.798Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: lklimek
PR: dashpay/platform#1924
File: packages/rs-sdk/src/sdk.rs:855-870
Timestamp: 2024-12-03T15:00:50.385Z
Learning: In `packages/rs-sdk/src/sdk.rs`, remember that `rustls_pemfile::certs` returns an iterator over `Result`, not a `Result` directly. Handle it accordingly in future code reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
- GitHub Check: Rust packages (drive-abci) / Tests
- GitHub Check: Rust packages (dash-sdk) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Tests
- GitHub Check: Rust packages (drive-abci) / Check each feature
- GitHub Check: Rust packages (drive-abci) / Linting
- GitHub Check: Rust packages (dash-sdk) / Unused dependencies
- GitHub Check: Rust packages (dash-sdk) / Linting
- GitHub Check: Rust packages (drive-abci) / Unused dependencies
- GitHub Check: Rust packages (drive-abci) / Formatting
- GitHub Check: Rust crates security audit
- GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
- GitHub Check: Build JS packages / Build JS
- GitHub Check: build-wasm-sdk
🔇 Additional comments (3)
packages/wasm-sdk/src/queries/epoch.rs (3)
183-190: LGTM! Proper epoch bounds checking implemented.The bounds checking for epoch values before casting from u32 to u16 correctly prevents silent truncation and provides clear error messages.
Also applies to: 246-253
100-104: LGTM! Saturating arithmetic prevents overflow.The use of
saturating_addandsaturating_subcorrectly prevents overflow/underflow issues in epoch calculation.
1-10: LGTM! Well-structured imports and dependencies.The imports are appropriate and well-organized for the WASM SDK functionality.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/wasm-sdk/src/queries/epoch.rs (2)
194-196: Consider handling potential hash conversion error.While the identifier should always be 32 bytes, using
unwrap()could panic if this invariant is violated.- let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes).unwrap(); + let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes) + .map_err(|_| JsError::new("Invalid identifier length"))?;
253-265: Extract duplicated ProTxHash conversion logic.The conversion from Identifier to ProposerBlockCount is duplicated between
get_evonodes_proposed_epoch_blocks_by_idsandget_evonodes_proposed_epoch_blocks_by_range.Add a helper function:
fn identifier_to_proposer_block_count(identifier: dash_sdk::dpp::identifier::Identifier, count: u64) -> Result<ProposerBlockCount, JsError> { let bytes = identifier.to_buffer(); let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes) .map_err(|_| JsError::new("Invalid identifier length"))?; let pro_tx_hash = ProTxHash::from_raw_hash(hash); Ok(ProposerBlockCount { proposer_pro_tx_hash: pro_tx_hash.to_string(), count, }) }Then use it in both functions:
- .map(|(identifier, count)| { - // Convert Identifier back to ProTxHash - let bytes = identifier.to_buffer(); - let hash = dash_sdk::dpp::dashcore::hashes::sha256d::Hash::from_slice(&bytes).unwrap(); - let pro_tx_hash = ProTxHash::from_raw_hash(hash); - ProposerBlockCount { - proposer_pro_tx_hash: pro_tx_hash.to_string(), - count, - } - }) + .map(|(identifier, count)| identifier_to_proposer_block_count(identifier, count)) + .collect::<Result<Vec<_>, _>>()?;Also applies to: 190-202
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/wasm-sdk/src/queries/epoch.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/wasm-sdk/src/queries/epoch.rs
🧠 Learnings (2)
📓 Common learnings
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/mimic/test_quorum.rs:159-164
Timestamp: 2024-11-20T16:16:01.830Z
Learning: QuantumExplorer prefers not to receive auto-generated messages asking to post on social media.
packages/wasm-sdk/src/queries/epoch.rs (30)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: QuantumExplorer
PR: dashpay/platform#2559
File: packages/rs-drive-abci/src/query/token_queries/token_perpetual_distribution_last_claim/v0/mod.rs:128-0
Timestamp: 2025-04-21T00:38:44.796Z
Learning: In the Dash Platform codebase, EpochIndex is defined as u16, making it safe to cast to u32 without overflow concerns.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-dpp/src/data_contract/associated_token/token_perpetual_distribution/v0/methods.rs:10-12
Timestamp: 2025-02-03T23:39:10.579Z
Learning: Block interval calculations in token distribution logic should use checked arithmetic operations (checked_sub, checked_add) to prevent potential overflows, especially when dealing with block heights and intervals.
Learnt from: QuantumExplorer
PR: dashpay/platform#2584
File: packages/rs-dpp/src/data_contract/methods/registration_cost/v1/mod.rs:31-78
Timestamp: 2025-05-02T18:13:31.615Z
Learning: In fee calculation contexts, saturating arithmetic operations (like saturating_add and saturating_mul) are acceptable as users would never practically be able to pay fees approaching u64::MAX. Explicit overflow checking is unnecessary in these scenarios.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-21T01:03:42.458Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-08T13:25:15.577Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-03T05:17:52.648Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-09T00:22:57.778Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:119-120
Timestamp: 2024-10-06T16:18:07.994Z
Learning: In the `run_block_proposal` function in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, it's acceptable to pass `platform_state` to `perform_events_on_first_block_of_protocol_change`, even if `block_platform_state` has been updated.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:93-99
Timestamp: 2024-11-22T08:19:14.448Z
Learning: In `packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs`, the `insert_contract` method requires an owned `BlockInfo`, so cloning `block_info` is necessary when calling it.
Learnt from: QuantumExplorer
PR: dashpay/platform#2347
File: packages/rs-drive/tests/query_tests.rs:438-460
Timestamp: 2024-11-25T01:17:02.001Z
Learning: In Rust test files (`packages/rs-drive/tests/query_tests.rs`), when code is used only in tests, defining explicit enums for fields (like the `status` field in the `Withdrawal` struct) may not be necessary; using primitive types is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2332
File: packages/rs-drive-proof-verifier/src/error.rs:21-23
Timestamp: 2024-11-15T14:39:23.704Z
Learning: In the `packages/rs-drive-proof-verifier`, avoid suggesting size limits for `proof_bytes` in errors unless there's a specific need, as it may not be necessary.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-04T14:16:05.798Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: lklimek
PR: dashpay/platform#1924
File: packages/rs-sdk/src/sdk.rs:855-870
Timestamp: 2024-12-03T15:00:50.385Z
Learning: In `packages/rs-sdk/src/sdk.rs`, remember that `rustls_pemfile::certs` returns an iterator over `Result`, not a `Result` directly. Handle it accordingly in future code reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
- GitHub Check: Rust packages (drive-abci) / Linting
- GitHub Check: Rust packages (dash-sdk) / Tests
- GitHub Check: Rust packages (drive-abci) / Tests
- GitHub Check: Rust packages (dash-sdk) / Unused dependencies
- GitHub Check: Rust packages (dash-sdk) / Linting
- 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
- GitHub Check: build-wasm-sdk
🔇 Additional comments (6)
packages/wasm-sdk/src/queries/epoch.rs (6)
1-10: LGTM!The imports are well-organized and appropriate for the WASM epoch query module.
11-33: Well-structured data type with proper conversion logic.The
EpochInfostruct and itsFromimplementation are correctly designed for JavaScript interoperability with camelCase field names and proper fee multiplier conversion from permille to decimal.
35-65: Clean implementation of epoch info fetching.The function properly handles optional parameters, constructs the query correctly, and provides clear error messages. Good use of the SDK's type-safe query interfaces.
67-143: Robust implementation with proper overflow protection.The function correctly uses saturating arithmetic to prevent overflow issues and handles both ascending and descending queries appropriately. The manual sorting ensures consistent output ordering.
172-178: Good epoch validation!The validation properly prevents overflow by checking against
u16::MAXbefore casting, providing a clear error message.
281-291: Clean implementation for fetching current epoch.The function correctly uses the SDK's
FetchCurrenttrait and provides proper error handling.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
packages/wasm-sdk/GROUP_QUERIES_DOCUMENTATION.md (4)
1-7: Tighten spacing & heading formatting for cleaner renderingThere’s an extra blank line after the H1 plus inconsistent blank-line spacing around subsequent headings. This produces ragged spacing when rendered and breaks some MD linters. Consider a single blank line after each heading only.
-# Group Queries Implementation - -This document describes the implementation of group queries in the WASM SDK. +# Group Queries Implementation + +This document describes the implementation of group queries in the WASM SDK.
20-30: JSON examples contain inline comments → invalid JSONThe blocks are fenced as
javascriptbut presented as JSON structures. Inline comments (// ...) make them unparsable if users copy-paste into tooling.Quick fix: either
- switch the fence to
js/javascriptand addconst example = …, or- keep the fence as
jsonand remove comments.- "members": { - "identityId1": 100, // member ID -> voting power - "identityId2": 50 - }, - "requiredPower": 100 // minimum power needed for decisions + "members": { + "identityId1": 100, + "identityId2": 50 + }, + "requiredPower": 100
34-42: Clarify pagination semanticsReaders will wonder whether
start_atis inclusive or exclusive and what the defaultlimitis whennullis passed. A single sentence here avoids guesswork.Example:
start_at(exclusive) defaults to the lowest member ID whennull.
limitdefaults to the server-side maximum (currently 100).
62-67: Explicitly flag unimplemented parameters to avoid confusion
owner_data_contractsandmoderator_data_contractsare “not yet implemented”, yet they’re listed as parameters. Until supported, consider moving them to a separate Future Work section so TypeScript users don’t look for nonexistent bindings.packages/wasm-sdk/src/queries/document.rs (1)
169-178: Improve identifier detection heuristic to reduce false positives.The current heuristic assumes any 44-character alphanumeric string is a Base58-encoded identifier, which could incorrectly classify regular strings as identifiers.
Consider a more robust approach:
- // Check if it's an identifier (base58 encoded) - if s.len() == 44 && s.chars().all(|c| c.is_alphanumeric()) { - // Try to parse as identifier - match Identifier::from_string(s, dash_sdk::dpp::platform_value::string_encoding::Encoding::Base58) { - Ok(id) => Ok(platform_value!(id)), - Err(_) => Ok(Value::Text(s.clone())), - } - } else { - Ok(Value::Text(s.clone())) - } + // Try to parse as identifier first, fall back to text + match Identifier::from_string(s, dash_sdk::dpp::platform_value::string_encoding::Encoding::Base58) { + Ok(id) => Ok(platform_value!(id)), + Err(_) => Ok(Value::Text(s.clone())), + }This approach attempts identifier parsing directly without relying on string characteristics, reducing false positives.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
packages/rs-drive/QUERY_QUICK_REFERENCE.md(1 hunks)packages/rs-drive/SECONDARY_INDEX_QUERIES.md(1 hunks)packages/wasm-sdk/CLAUDE.md(1 hunks)packages/wasm-sdk/Cargo.toml(3 hunks)packages/wasm-sdk/GROUP_QUERIES_DOCUMENTATION.md(1 hunks)packages/wasm-sdk/src/queries/document.rs(1 hunks)packages/wasm-sdk/src/queries/epoch.rs(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/wasm-sdk/Cargo.toml
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/wasm-sdk/src/queries/epoch.rspackages/wasm-sdk/src/queries/document.rs
🧠 Learnings (7)
📓 Common learnings
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/mimic/test_quorum.rs:159-164
Timestamp: 2024-11-20T16:16:01.830Z
Learning: QuantumExplorer prefers not to receive auto-generated messages asking to post on social media.
packages/wasm-sdk/src/queries/epoch.rs (29)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` requires true blocking behavior, which is why a non-blocking WebAssembly implementation using `wasm_bindgen_futures::spawn_local` is not suitable.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: QuantumExplorer
PR: dashpay/platform#2644
File: packages/rs-drive/src/cache/system_contracts.rs:18-19
Timestamp: 2025-05-28T16:22:26.334Z
Learning: In packages/rs-drive/src/cache/system_contracts.rs, the `active_since_protocol_version` field in `ActiveSystemDataContract` struct is intentionally added for future use, not current implementation. QuantumExplorer confirmed this is "meant for later" when questioned about the `#[allow(unused)]` attribute.
Learnt from: shumkov
PR: dashpay/platform#2259
File: packages/rs-dapi-client/src/dapi_client.rs:137-139
Timestamp: 2024-10-22T10:53:12.111Z
Learning: In `packages/rs-dapi-client/src/dapi_client.rs`, when passing data into asynchronous code, ensure that data structures are `Send + Sync`. Using `Arc<AtomicUsize>` is necessary for the retry counter.
Learnt from: QuantumExplorer
PR: dashpay/platform#2559
File: packages/rs-drive-abci/src/query/token_queries/token_perpetual_distribution_last_claim/v0/mod.rs:128-0
Timestamp: 2025-04-21T00:38:44.796Z
Learning: In the Dash Platform codebase, EpochIndex is defined as u16, making it safe to cast to u32 without overflow concerns.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-06T16:17:34.571Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:105-105
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In `run_block_proposal` in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, when retrieving `last_block_time_ms`, it's acceptable to use `platform_state` instead of `block_platform_state`, even after updating the protocol version.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-dpp/src/data_contract/associated_token/token_perpetual_distribution/v0/methods.rs:10-12
Timestamp: 2025-02-03T23:39:10.579Z
Learning: Block interval calculations in token distribution logic should use checked arithmetic operations (checked_sub, checked_add) to prevent potential overflows, especially when dealing with block heights and intervals.
Learnt from: QuantumExplorer
PR: dashpay/platform#2584
File: packages/rs-dpp/src/data_contract/methods/registration_cost/v1/mod.rs:31-78
Timestamp: 2025-05-02T18:13:31.615Z
Learning: In fee calculation contexts, saturating arithmetic operations (like saturating_add and saturating_mul) are acceptable as users would never practically be able to pay fees approaching u64::MAX. Explicit overflow checking is unnecessary in these scenarios.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-21T01:03:42.458Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: QuantumExplorer
PR: dashpay/platform#2227
File: packages/rs-dpp/src/fee/default_costs/mod.rs:15-17
Timestamp: 2024-10-08T13:25:15.577Z
Learning: Using `&'static FeeVersion` references in `CachedEpochIndexFeeVersions` is acceptable and does not introduce lifetime or ownership issues in this context.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:654-658
Timestamp: 2024-10-18T15:43:32.447Z
Learning: In `packages/rs-sdk/src/sdk.rs`, within the `verify_metadata_height` function, when using `compare_exchange` on `last_seen_height`, it's acceptable to use `Ordering::Relaxed` for the failure ordering, as any inconsistency would only trigger an extra loop iteration without affecting correctness.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-03T05:17:52.648Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2200
File: packages/rs-drive-proof-verifier/src/unproved.rs:234-234
Timestamp: 2024-10-09T00:22:57.778Z
Learning: When `node_id` is not provided, assigning a placeholder `node_id` with a zeroed array is acceptable.
Learnt from: QuantumExplorer
PR: dashpay/platform#2215
File: packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs:119-120
Timestamp: 2024-10-06T16:18:07.994Z
Learning: In the `run_block_proposal` function in `packages/rs-drive-abci/src/execution/engine/run_block_proposal/mod.rs`, it's acceptable to pass `platform_state` to `perform_events_on_first_block_of_protocol_change`, even if `block_platform_state` has been updated.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-dapi-client/src/executor.rs:38-38
Timestamp: 2024-10-29T14:44:01.184Z
Learning: In `packages/rs-dapi-client/src/executor.rs`, for the structs `ExecutionError<E>` and `ExecutionResponse<R>`, only the serde derives (`Serialize`, `Deserialize`) should be conditional based on the "mocks" feature; the other derives (`Debug`, `Clone`, `Eq`, `PartialEq`) should always be present.
Learnt from: shumkov
PR: dashpay/platform#2345
File: packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs:93-99
Timestamp: 2024-11-22T08:19:14.448Z
Learning: In `packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs`, the `insert_contract` method requires an owned `BlockInfo`, so cloning `block_info` is necessary when calling it.
Learnt from: QuantumExplorer
PR: dashpay/platform#2332
File: packages/rs-drive-proof-verifier/src/error.rs:21-23
Timestamp: 2024-11-15T14:39:23.704Z
Learning: In the `packages/rs-drive-proof-verifier`, avoid suggesting size limits for `proof_bytes` in errors unless there's a specific need, as it may not be necessary.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: lklimek
PR: dashpay/platform#2207
File: packages/rs-drive-proof-verifier/src/proof.rs:1646-1664
Timestamp: 2024-10-04T14:16:05.798Z
Learning: In the implementation of `FromProof<platform::GetContestedResourceIdentityVotesRequest>` in `packages/rs-drive-proof-verifier/src/proof.rs`, when matching `maybe_votes`, using `.expect()` on `v.into_iter().next()` is acceptable because the prior match arm `Some(v) if v.is_empty()` ensures that the map is not empty, preventing a panic.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs:148-151
Timestamp: 2024-11-20T16:05:40.200Z
Learning: In `packages/rs-drive-abci/src/platform_types/signature_verification_quorum_set/v0/for_saving.rs`, when converting public keys from `QuorumForSavingV0` to `VerificationQuorum`, it's acceptable to use `.expect()` for public key conversion, as the conversion has been verified and panics are acceptable in this context.
Learnt from: lklimek
PR: dashpay/platform#1924
File: packages/rs-sdk/src/sdk.rs:855-870
Timestamp: 2024-12-03T15:00:50.385Z
Learning: In `packages/rs-sdk/src/sdk.rs`, remember that `rustls_pemfile::certs` returns an iterator over `Result`, not a `Result` directly. Handle it accordingly in future code reviews.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/tests/strategy_tests/masternodes.rs:212-220
Timestamp: 2024-11-20T20:43:41.185Z
Learning: In `packages/rs-drive-abci/tests/strategy_tests/masternodes.rs`, the pattern of generating a `PrivateKey`, converting it to bytes, and reconstructing a `BlsPrivateKey` from those bytes is intentional. Avoid suggesting to simplify this code in future reviews.
packages/wasm-sdk/src/queries/document.rs (7)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: shumkov
PR: dashpay/platform#2182
File: packages/rs-platform-version/src/version/drive_abci_versions.rs:116-121
Timestamp: 2024-09-29T13:13:54.230Z
Learning: Adding Rust doc comments to structs and fields is recommended to enhance clarity and documentation.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2254
File: packages/rs-sdk/src/sdk.rs:585-585
Timestamp: 2024-10-18T15:39:51.172Z
Learning: The 'platform' project uses Rust version 1.80, so code in 'packages/rs-sdk' can use features available in Rust 1.80, such as the `abs_diff()` method.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/rs-sdk/src/sync.rs:88-95
Timestamp: 2025-01-23T09:23:32.740Z
Learning: The `block_on` function in `packages/rs-sdk/src/sync.rs` is currently only used in tests, and its WebAssembly implementation is deferred until there's a user request for it.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Documents and data contracts should use state transitions for updates
packages/rs-drive/QUERY_QUICK_REFERENCE.md (2)
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-drive/src/drive/tokens/distribution/queries.rs:57-57
Timestamp: 2025-02-03T23:34:43.081Z
Learning: In Rust query implementations, the `..` operator after a value creates a `RangeFrom` bound rather than performing vector slicing, which is a safe operation for constructing range-based queries.
packages/rs-drive/SECONDARY_INDEX_QUERIES.md (2)
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: QuantumExplorer
PR: dashpay/platform#2450
File: packages/rs-drive/src/drive/tokens/distribution/queries.rs:57-57
Timestamp: 2025-02-03T23:34:43.081Z
Learning: In Rust query implementations, the `..` operator after a value creates a `RangeFrom` bound rather than performing vector slicing, which is a safe operation for constructing range-based queries.
packages/wasm-sdk/CLAUDE.md (1)
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
packages/wasm-sdk/GROUP_QUERIES_DOCUMENTATION.md (1)
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
🪛 LanguageTool
packages/rs-drive/QUERY_QUICK_REFERENCE.md
[grammar] ~1-~1: Use correct spacing
Context: # Dash Platform Query Quick Reference ## Can we do multiple ranges on one index?...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...ce ## Can we do multiple ranges on one index? YES, with limitations: - ✅ **2 range ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~8-~8: Use correct spacing
Context: ...- ❌ More than 2 range clauses → Not supported ### Valid Example: ```json { "where": [ ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~10-~10: Use correct spacing
Context: ...ge clauses** → Not supported ### Valid Example: json { "where": [ ["age", ">", 18], ["age", "<=", 65] ] } → Internally becomes: `age BetweenExclu...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~19-~19: Use correct spacing
Context: ..."age", "<=", 65] ] } → Internally becomes: `age BetweenExcludeLeft [18, 65]` ### Invalid Example:json { "where": ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~21-~21: Use correct spacing
Context: ...tweenExcludeLeft [18, 65]` ### Invalid Example: json { "where": [ ["age", ">", 18], ["salary", "<", 100000] ] } → Error: Range clauses must be on same ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~30-~30: There might be a problem here.
Context: ...} ``` → Error: Range clauses must be on same field ## Compound Index Queries For index [A, B...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~32-~32: Use correct spacing
Context: ...ust be on same field ## Compound Index Queries For index [A, B, C], ranges can be on A...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~37-~37: Use correct spacing
Context: ...e- Range on C: MUST haveA == valueANDB == value` ### Examples: ```json // ✅ Valid: Range on...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~39-~39: Use correct spacing
Context: ...have A == value AND B == value ### Examples: json // ✅ Valid: Range on B with equality on A { "where": [ ["A", "==", 5], ["B", ">", 10] ] } // ❌ Invalid: Range on B without equality on A { "where": [ ["B", ">", 10] // Error: Missing A ] } ## Key Query Rules 1. **Fields MUST be in...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~57-~57: Use correct spacing
Context: ...rror: Missing A ] } ``` ## Key Query Rules 1. Fields MUST be indexed (no queries on...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~59-~59: There might be a mistake here.
Context: ...be indexed** (no queries on non-indexed fields) 2. One IN clause per query (max 100...
(QB_NEW_EN_OTHER)
[grammar] ~60-~60: There might be a mistake here.
Context: ...2. One IN clause per query (max 100 values) 3. One range clause per query (can ...
(QB_NEW_EN_OTHER)
[grammar] ~61-~61: There might be a problem here.
Context: ... per query** (can be combined from 2 on same field) 4. Limits: Default 100, Max 100 (co...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~62-~62: There might be a mistake here.
Context: ...ld) 4. Limits: Default 100, Max 100 (configurable) 5. Special queryable fields: $id,...
(QB_NEW_EN_OTHER)
[grammar] ~63-~63: Use correct spacing
Context: ...lds**: $id, $ownerId, $createdAt, $updatedAt, $revision ## ProveOptions Warning When using proof...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~65-~65: Use correct spacing
Context: ...pdatedAt, $revision` ## ProveOptions Warning When using proof generation with GroveD...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~67-~67: Use correct spacing
Context: ...rning When using proof generation with GroveDB: rust ProveOptions { decrease_limit_on_empty_sub_query_result: true, // ALWAYS use true in production } Setting to false can cause memory exh...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~73-~73: Use articles correctly
Context: ... false can cause memory exhaustion if query matches many empty subtrees!
(QB_NEW_EN_OTHER_ERROR_IDS_11)
packages/rs-drive/SECONDARY_INDEX_QUERIES.md
[typographical] ~1-~1: To join two clauses or set off examples, consider using an em dash.
Context: ... Dash Platform Secondary Index Document Queries - Comprehensive Guide for AI Agents ## Ov...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~1-~1: Use correct spacing
Context: ...nt Queries - Comprehensive Guide for AI Agents ## Overview Dash Platform uses a hierarch...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use proper spacing conventions.
Context: ...hensive Guide for AI Agents ## Overview Dash Platform uses a hierarchical authen...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~5-~5: Use correct spacing
Context: ...lementation details for secondary index queries. ## Key Concepts ### 1. Query Structure A...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~7-~7: Use correct spacing
Context: ...ls for secondary index queries. ## Key Concepts ### 1. Query Structure All document querie...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~9-~9: Use correct spacing
Context: ...queries. ## Key Concepts ### 1. Query Structure All document queries in Dash Platform a...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~11-~11: Use correct spacing
Context: ... the DriveDocumentQuery struct, which contains: rust pub struct DriveDocumentQuery<'a> { pub contract: &'a DataContract, pub document_type: DocumentTypeRef<'a>, pub internal_clauses: InternalClauses, pub offset: Option<u16>, pub limit: Option<u16>, pub order_by: IndexMap<String, OrderClause>, pub start_at: Option<[u8; 32]>, pub start_at_included: bool, pub block_time_ms: Option<u64>, } ### 2. Internal Clauses The `InternalClaus...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~27-~27: Use correct spacing
Context: ...ms: Option, } ``` ### 2. Internal Clauses The InternalClauses struct organizes ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~29-~29: Use correct spacing
Context: ...es` struct organizes WHERE clauses into categories: rust pub struct InternalClauses { pub primary_key_in_clause: Option<WhereClause>, // IN clause on $id pub primary_key_equal_clause: Option<WhereClause>, // == clause on $id pub in_clause: Option<WhereClause>, // Single IN clause on indexed field pub range_clause: Option<WhereClause>, // Single range clause (may be combined from 2) pub equal_clauses: BTreeMap<String, WhereClause>, // Multiple == clauses } ## Query Capabilities ### 1. Supported Op...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~41-~41: Use correct spacing
Context: ... // Multiple == clauses } ``` ## Query Capabilities ### 1. Supported Operators - Equality:...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~43-~43: Use correct spacing
Context: ...## Query Capabilities ### 1. Supported Operators - Equality: == (Equal) - **Comparison...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~49-~49: Use correct spacing
Context: ...eRight- **Membership**:in(In) - **String**:StartsWith` ### 2. Multiple Range Queries on Single Fi...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~51-~51: There might be a problem here.
Context: ...With` ### 2. Multiple Range Queries on Single Field YES, but with strict limitations: - ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~53-~53: Use correct spacing
Context: ...on Single Field YES, but with strict limitations: - Exactly 2 range clauses can be combin...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~55-~55: There might be a mistake here.
Context: ...clauses** can be combined on the same field - They must form valid bounds (one up...
(QB_NEW_EN_OTHER)
[grammar] ~56-~56: There might be a mistake here.
Context: ... must form valid bounds (one upper, one lower) - Valid combinations are automatically ...
(QB_NEW_EN_OTHER)
[grammar] ~57-~57:
Context: ...atically converted to Between operators: - field >= X && field <= Y → field Between [X, Y] - field >= X && field < Y → field BetweenExcludeRight [X, Y] - field > X && field <= Y → field BetweenExcludeLeft [X, Y] - field > X && field < Y → field BetweenExcludeBounds [X, Y] ...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~63-~63: Use correct spacing
Context: ... field BetweenExcludeBounds [X, Y] Example: json { "where": [ ["age", ">", 18], ["age", "<", 65] ] } This is valid and will be internally co...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~72-~72: There might be a mistake here.
Context: ... valid and will be internally converted to: age BetweenExcludeBounds [18, 65] ### 3. Query Types #### Simple Equality Q...
(QB_NEW_EN_OTHER)
[grammar] ~74-~74: Use correct spacing
Context: ...enExcludeBounds [18, 65]` ### 3. Query Types #### Simple Equality Query ```json { "wher...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~76-~76: Use correct spacing
Context: ...## 3. Query Types #### Simple Equality Query json { "where": [ ["firstName", "==", "Alice"] ] } #### Range Query ```json { "where": [ ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~85-~85: Use correct spacing
Context: ...", "==", "Alice"] ] } #### Range Queryjson { "where": [ ["age", ">=", 18] ] } #### IN Queryjson { "where": [ ["s...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~94-~94: Use correct spacing
Context: ... ["age", ">=", 18] ] } #### IN Queryjson { "where": [ ["status", "in", ["active", "pending", "approved"]] ] } #### Combined Queryjson { "where": [ ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~103-~103: Use correct spacing
Context: ..., "approved"]] ] } #### Combined Queryjson { "where": [ ["category", "==", "electronics"], ["price", ">=", 100], ["price", "<=", 1000] ], "orderBy": [ ["price", "asc"] ], "limit": 50 } ``` ### 4. Special Fields These fields can be ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~118-~118: Use correct spacing
Context: ... ], "limit": 50 } ``` ### 4. Special Fields These fields can be queried without bei...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~120-~120:
Context: ...eing explicitly defined in the document type: - $id - Document identifier - $ownerId - Owne...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~121-~121:
Context: ...n the document type: - $id - Document identifier - $ownerId - Owner identifier - $createdAt - Creat...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~122-~122:
Context: ...ocument identifier - $ownerId - Owner identifier - $createdAt - Creation timestamp - $updatedAt - Upd...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~123-~123:
Context: ...er identifier - $createdAt - Creation timestamp - $updatedAt - Update timestamp - $revision - Docume...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~124-~124:
Context: ...ation timestamp - $updatedAt - Update timestamp - $revision - Document revision number ## Compound I...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~125-~125: Use correct spacing
Context: ...stamp - $revision - Document revision number ## Compound Index Queries ### How Compoun...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~127-~127: Use correct spacing
Context: ...ment revision number ## Compound Index Queries ### How Compound Indexes Work When an inde...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~129-~129: Use correct spacing
Context: ...Index Queries ### How Compound Indexes Work When an index has multiple properties [...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~134-~134: There might be a mistake here.
Context: ... Level 3: Property C values (under each A,B combination) - Level 4: Document IDs ...
(QB_NEW_EN_OTHER)
[grammar] ~135-~135: Use correct spacing
Context: ...ch A,B combination) - Level 4: Document IDs ### Range Queries on Compound Indexes **Ra...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~137-~137: Use correct spacing
Context: ...ment IDs ### Range Queries on Compound Indexes **Range queries CAN be performed on any p...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~139-~139: Use correct spacing
Context: ...L properties that come before it in the index. #### For index [A, B, C]: ✅ **Valid - Range...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~141-~141: Use correct spacing
Context: ...it in the index. #### For index [A, B, C]: ✅ **Valid - Range on A (first property)...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[typographical] ~143-~143: To join two clauses or set off examples, consider using an em dash.
Context: ... index. #### For index [A, B, C]: ✅ Valid - Range on A (first property): ```json {...
(QB_NEW_EN_DASH_RULE_EM)
[grammar] ~143-~143: Use correct spacing
Context: ..., B, C]: ✅ Valid - Range on A (first property): json { "where": [ ["A", ">", 10], ["A", "<", 20] ] } ✅ **Valid - Range on B with equality on...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~153-~153: There might be a mistake here.
Context: ...✅ Valid - Range on B with equality on A: json { "where": [ ["A", "==", 5], // Required: equality on A ["B", ">", 100], ["B", "<=", 200] ] } ✅ **Valid - Range on C with equalities ...
(QB_NEW_EN_OTHER)
[grammar] ~164-~164: There might be a mistake here.
Context: ...d - Range on C with equalities on A and B:** json { "where": [ ["A", "==", 5], // Required: equality on A ["B", "==", 10], // Required: equality on B ["C", ">=", 1000] ] } ❌ **Invalid - Range on B without equali...
(QB_NEW_EN_OTHER)
[grammar] ~175-~175: Use correct spacing
Context: ...nvalid - Range on B without equality on A:** json { "where": [ ["B", ">", 100] // Error: Cannot query B without specifying A ] } ❌ **Invalid - Range on C without equali...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~184-~184: Use correct spacing
Context: ...nvalid - Range on C without equality on B:** json { "where": [ ["A", "==", 5], ["C", ">", 1000] // Error: Cannot skip B in the index ] } ### Why This Design? The hierarchical stru...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~194-~194: Use correct spacing
Context: ... B in the index ] } ``` ### Why This Design? The hierarchical structure means: 1. To...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~196-~196: Use colons correctly
Context: ...his Design? The hierarchical structure means: 1. To query at any level, you must provide ...
(QB_NEW_EN_OTHER_ERROR_IDS_30)
[grammar] ~197-~197: There might be a mistake here.
Context: ... must provide the complete path to that level 2. This is like a file system where you can't l...
(QB_NEW_EN_OTHER)
[grammar] ~198-~198: There might be a mistake here.
Context: ...cuments/` without specifying which home directory 3. It ensures efficient traversal of the auth...
(QB_NEW_EN_OTHER)
[grammar] ~199-~199: There might be a mistake here.
Context: ...versal of the authenticated merkle tree structure ### Practical Example Given an index on [c...
(QB_NEW_EN_OTHER)
[grammar] ~201-~201: Use correct spacing
Context: ...ed merkle tree structure ### Practical Example Given an index on [category, brand, pri...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~203-~203: Use correct spacing
Context: ...le Given an index on [category, brand, price]: json // Query electronics from Apple with price range { "where": [ ["category", "==", "electronics"], // Required ["brand", "==", "Apple"], // Required ["price", ">=", 500], ["price", "<=", 2000] ] } This creates the path: `/category=elect...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~216-~216: Use correct spacing
Context: ..."<=", 2000] ] } ``` This creates the path: /category=electronics/brand=Apple/price=[500,2000]/ ## Restrictions and Validation Rules ###...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~218-~218: Use correct spacing
Context: ...2000]/` ## Restrictions and Validation Rules ### 1. Index Requirements - **Queries MUST...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~220-~220: Use correct spacing
Context: ...ions and Validation Rules ### 1. Index Requirements - Queries MUST match an index defined i...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~222-~222: There might be a mistake here.
Context: ...atch an index** defined in the document type - Non-indexed fields cannot be queried ...
(QB_NEW_EN_OTHER)
[grammar] ~223-~223: There might be a mistake here.
Context: ...ndexed fields cannot be queried (error: WhereClauseOnNonIndexedProperty) - Query must be within `MAX_INDEX_DIFFE...
(QB_NEW_EN_OTHER)
[grammar] ~224-~224: There might be a mistake here.
Context: ...AX_INDEX_DIFFERENCE` (2) of an existing index ### 2. Limit Restrictions - **Default limi...
(QB_NEW_EN_OTHER)
[grammar] ~226-~226: Use correct spacing
Context: ... (2) of an existing index ### 2. Limit Restrictions - Default limit: 100 documents - **Maxi...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~231-~231: Use correct spacing
Context: ... limit is 0, defaults to system default (100) ### 3. Clause Restrictions - **Primary key...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~233-~233: Use correct spacing
Context: ... to system default (100) ### 3. Clause Restrictions - Primary key queries: Only ONE equal o...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~242-~242: Use correct spacing
Context: ...field cannot appear in different clause types ### 4. Invalid Query Examples #### Multipl...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~244-~244: Use correct spacing
Context: ...rent clause types ### 4. Invalid Query Examples #### Multiple IN clauses (INVALID) ```json {...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~246-~246: Use correct spacing
Context: ...uery Examples #### Multiple IN clauses (INVALID) json { "where": [ ["category", "in", ["A", "B"]], ["status", "in", ["active", "pending"]] ] } #### Range on multiple fields (INVALID) ```j...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~256-~256: Use correct spacing
Context: ... ] } #### Range on multiple fields (INVALID)json { "where": [ ["age", ">", 18], ["salary", "<", 100000] ] } #### Conflicting clauses (INVALID)json {...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~266-~266: Use correct spacing
Context: ...00] ] } #### Conflicting clauses (INVALID)json { "where": [ ["age", "==", 25], ["age", ">", 30] ] } ``` ## ProveOptions and GroveDB Integration #...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~276-~276: Use correct spacing
Context: ... ] } ``` ## ProveOptions and GroveDB Integration ### ProveOptions Structure The `ProveOptio...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~278-~278: Use correct spacing
Context: ...d GroveDB Integration ### ProveOptions Structure The ProveOptions struct (from grovedb...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~280-~280: Use correct spacing
Context: ... (from grovedb v3.0.0) configures proof generation: rust pub struct ProveOptions { /// Decrease the available limit by 1 for empty subtrees /// WARNING: Set to false only if you know there are few empty subtrees /// Otherwise can cause memory exhaustion pub decrease_limit_on_empty_sub_query_result: bool, } ### Key Points: 1. Default behavior: W...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~291-~291: Use correct spacing
Context: ..._sub_query_result: bool, } ``` ### Key Points: 1. Default behavior: When None is pass...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~293-~293: There might be a mistake here.
Context: ...ommon in codebase), default options are used 2. Memory safety: The `decrease_lim...
(QB_NEW_EN_OTHER)
[grammar] ~294-~294: There might be a mistake here.
Context: ...rsing many empty branches in the merkle tree 3. Usage: Pass to `grovedb.get_prov...
(QB_NEW_EN_OTHER)
[grammar] ~295-~295: There might be a mistake here.
Context: ....get_proved_path_query()` as the second parameter ## Query Execution Flow 1. Parsing: J...
(QB_NEW_EN_OTHER)
[grammar] ~297-~297: Use correct spacing
Context: ...he second parameter ## Query Execution Flow 1. Parsing: JSON/CBOR query → `DocumentQ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~301-~301: There might be a mistake here.
Context: ...ct 2. Validation: - Check field existence - Validate operators - Ensure ind...
(QB_NEW_EN_OTHER)
[grammar] ~302-~302: There might be a mistake here.
Context: ... - Check field existence - Validate operators - Ensure index match - Check limi...
(QB_NEW_EN_OTHER)
[grammar] ~303-~303: There might be a mistake here.
Context: ... - Validate operators - Ensure index match - Check limits 3. **Internal Clause ...
(QB_NEW_EN_OTHER)
[grammar] ~304-~304: There might be a mistake here.
Context: ...tors - Ensure index match - Check limits 3. Internal Clause Extraction: Grou...
(QB_NEW_EN_OTHER)
[grammar] ~306-~306: There might be a mistake here.
Context: ...Index Selection: Find best matching index 5. Path Query Generation: Convert t...
(QB_NEW_EN_OTHER)
[grammar] ~307-~307: There might be a mistake here.
Context: .... Path Query Generation: Convert to GroveDB PathQuery 6. Execution: - Without proof: Direc...
(QB_NEW_EN_OTHER)
[grammar] ~309-~309: There might be a mistake here.
Context: ...on**: - Without proof: Direct query execution - With proof: Use `get_proved_path_q...
(QB_NEW_EN_OTHER)
[grammar] ~311-~311: Use correct spacing
Context: ...: Documents with optional cryptographic proof ## Best Practices for AI Agents 1. **Alwa...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~313-~313: Use correct spacing
Context: ...graphic proof ## Best Practices for AI Agents 1. Always check if fields are indexed be...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~315-~315: There might be a mistake here.
Context: ...ys check if fields are indexed** before querying 2. Use compound indexes when queryi...
(QB_NEW_EN_OTHER)
[grammar] ~316-~316: There might be a mistake here.
Context: ...mpound indexes** when querying multiple fields 3. Prefer equality queries over ran...
(QB_NEW_EN_OTHER)
[grammar] ~317-~317: There might be a mistake here.
Context: ...uality queries** over range queries for performance 4. Limit IN clause values to reason...
(QB_NEW_EN_OTHER)
[grammar] ~318-~318: There might be a mistake here.
Context: ...use values** to reasonable amounts (<50 recommended) 5. Use pagination (start_at/start_a...
(QB_NEW_EN_OTHER)
[grammar] ~319-~319: There might be a mistake here.
Context: ...(start_at/start_after) for large result sets 6. Combine range clauses on same fi...
(QB_NEW_EN_OTHER)
[grammar] ~320-~320: Use articles correctly
Context: ...lt sets 6. Combine range clauses on same field for efficiency 7. **Avoid queries...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~320-~320: There might be a mistake here.
Context: ...mbine range clauses** on same field for efficiency 7. Avoid queries far from indexes (...
(QB_NEW_EN_OTHER)
[grammar] ~321-~321: There might be a mistake here.
Context: ...oid queries far from indexes** (will be rejected) ## Error Handling Common query errors: - ...
(QB_NEW_EN_OTHER)
[grammar] ~323-~323: Use correct spacing
Context: ... indexes** (will be rejected) ## Error Handling Common query errors: - `QuerySyntaxErro...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~325-~325:
Context: ...ected) ## Error Handling Common query errors: - QuerySyntaxError::WhereClauseOnNonIndexedProperty - Field not indexed - `QuerySyntaxError::...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~326-~326:
Context: ...ClauseOnNonIndexedProperty- Field not indexed -QuerySyntaxError::InvalidInClauseValue- IN clause validation failed -QuerySyn...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~327-~327:
Context: ...idInClauseValue- IN clause validation failed -QuerySyntaxError::MultipleRangeClauses- Invalid range combination -QuerySynta...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~328-~328:
Context: ...::MultipleRangeClauses- Invalid range combination -QuerySyntaxError::QueryTooFarFromIndex- No suitable index found -QuerySyntaxE...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~329-~329:
Context: ...eryTooFarFromIndex- No suitable index found -QuerySyntaxError::InvalidLimit` - Limit exceeds maximum ## Summary Dash...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~330-~330: There might be a problem here.
Context: ...taxError::InvalidLimit` - Limit exceeds maximum ## Summary Dash Platform's query system is designe...
(QB_NEW_EN_MERGED_MATCH)
[style] ~335-~335: The double modal “Requires indexed” is nonstandard (only accepted in certain dialects). Consider “to be indexed”.
Context: ...esigned for: - Efficiency: Requires indexed fields - Safety: Limits prevent res...
(NEEDS_FIXED)
[grammar] ~335-~335: There might be a mistake here.
Context: ...for: - Efficiency: Requires indexed fields - Safety: Limits prevent resource e...
(QB_NEW_EN_OTHER)
[grammar] ~336-~336: There might be a mistake here.
Context: ...s - Safety: Limits prevent resource exhaustion - Flexibility: Supports various ope...
(QB_NEW_EN_OTHER)
[grammar] ~337-~337: There might be a mistake here.
Context: ...ility**: Supports various operators and combinations - Verifiability: Optional cryptogra...
(QB_NEW_EN_OTHER)
[grammar] ~338-~338: There might be a mistake here.
Context: ...ty**: Optional cryptographic proofs via GroveDB The system intelligently combines multi...
(QB_NEW_EN_OTHER)
packages/wasm-sdk/CLAUDE.md
[grammar] ~1-~1: Use correct spacing
Context: # CLAUDE.md This file provides guidance to Claude C...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...ai/code) when working with code in this repository. ## Important Notes ### Network Connectivi...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ... code in this repository. ## Important Notes ### Network Connectivity **THERE ARE NO COR...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~8-~8: There might be a mistake here.
Context: ...UES WITH THE DASH PLATFORM ENDPOINTS IN WASM-SDK** - The Dash Platform HTTPS endpoints (...
(QB_NEW_EN_OTHER)
[grammar] ~9-~9: There might be a mistake here.
Context: ...2.176.90:1443) work perfectly fine from browsers - These endpoints have proper CORS head...
(QB_NEW_EN_OTHER)
[grammar] ~10-~10: There might be a mistake here.
Context: ...hese endpoints have proper CORS headers configured - SSL certificates are valid and accept...
(QB_NEW_EN_OTHER)
[grammar] ~11-~11: There might be a mistake here.
Context: ... certificates are valid and accepted by browsers - If you see connection errors, check: ...
(QB_NEW_EN_OTHER)
[grammar] ~15-~15: Use periods with abbreviations
Context: ...is in the correct network mode (testnet vs mainnet) - The actual error message d...
(QB_NEW_EN_OTHER_ERROR_IDS_34)
[grammar] ~16-~16: There might be a problem here.
Context: ...message details (not just assuming it's CORS/SSL) ## Architecture The WASM SDK is a WebAssembly build of ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~20-~20: There might be a problem here.
Context: ... the Dash SDK that runs in browsers. It provides: 1. Queries - Read operations that fetch data from Dash Platform 2. *...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~23-~23: There might be a problem here.
Context: ...etch data from Dash Platform 2. State Transitions - Write operations that modify state on Dash Platform ###...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~23-~23: Use correct spacing
Context: ...te operations that modify state on Dash Platform ### Key Components - src/sdk.rs - Main S...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~25-~25: There might be a problem here.
Context: ... modify state on Dash Platform ### Key Components - src/sdk.rs - Main SDK wrapper with WasmSdk and WasmS...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~27-~27:
Context: ...rs- Main SDK wrapper with WasmSdk and WasmSdkBuilder -src/queries/` - All query implementations (identity, do...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~29-~29: Use correct spacing
Context: ...tokens, etc.) - src/state_transitions/ - State transition implementations - `src...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~29-~29:
Context: .../state_transitions/- State transition implementations -src/context_provider/` - Context providers for trusted/untrusted...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~30-~30:
Context: ...Context providers for trusted/untrusted modes - index.html - Example web interface for testing SDK f...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~31-~31: There might be a problem here.
Context: ...- Example web interface for testing SDK functionality ### Building Run ./build.sh to build the WASM modu...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~35-~35: Use articles correctly
Context: ...to build the WASM module. Output goes topkg/` directory. ### Testing 1. Star...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~35-~35: There might be a problem here.
Context: ... the WASM module. Output goes to pkg/ directory. ### Testing 1. Start web server: `python3 -m http.serv...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~40-~40: There might be a mistake here.
Context: ...: python3 -m http.server 8888 2. Open http://localhost:8888 3. Select network (testnet/mainnet) 4. ...
(QB_NEW_EN_OTHER)
[grammar] ~41-~41: There might be a mistake here.
Context: ...http://localhost:8888 3. Select network (testnet/mainnet) 4. Choose operation type (queries/state...
(QB_NEW_EN_OTHER)
[grammar] ~42-~42: There might be a mistake here.
Context: ...4. Choose operation type (queries/state transitions) 5. Fill in parameters and execute ## C...
(QB_NEW_EN_OTHER)
[grammar] ~43-~43: There might be a mistake here.
Context: ... transitions) 5. Fill in parameters and execute ## Common Issues 1. **"time not implement...
(QB_NEW_EN_OTHER)
[grammar] ~45-~45: Use correct spacing
Context: ...ll in parameters and execute ## Common Issues 1. **"time not implemented on this platform"...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~47-~47: There might be a mistake here.
Context: ...ues 1. "time not implemented on this platform" - Fixed by using `js_sys::Date::now()...
(QB_NEW_EN_OTHER)
[grammar] ~47-~47: There might be a mistake here.
Context: ... by using js_sys::Date::now() in WASM builds 2. Import errors - Token functions ...
(QB_NEW_EN_OTHER)
[grammar] ~48-~48: There might be a problem here.
Context: ...Date::now()` in WASM builds 2. Import errors - Token functions are methods on WasmSdk, not s...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~48-~48: There might be a mistake here.
Context: ... are methods on WasmSdk, not standalone functions 3. Network timeouts - Usually means...
(QB_NEW_EN_OTHER)
[grammar] ~49-~49: There might be a problem here.
Context: ..., not standalone functions 3. Network timeouts - Usually means invalid parameters or identities,...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~49-~49: There might be a mistake here.
Context: ...d parameters or identities, NOT network issues ## Query Support The WASM SDK now fully s...
(QB_NEW_EN_OTHER)
[grammar] ~51-~51: Use correct spacing
Context: ...dentities, NOT network issues ## Query Support The WASM SDK now fully supports where a...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~53-~53: Use correct spacing
Context: ... where and orderBy clauses for document queries: ### Where Clauses - Format: JSON array of c...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~57-~57:
Context: ...ld, operator, value], ...]- Supported operators: -==or=- Equal ->` - Greater than - ...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~58-~58:
Context: ... Supported operators: - == or = - Equal - > - Greater than - >= - Greater than or...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~59-~59:
Context: ...- == or = - Equal - > - Greater than - >= - Greater than or equals - < - Less t...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~60-~60:
Context: ...Greater than - >= - Greater than or equals - < - Less than - <= - Less than or equal...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~61-~61:
Context: ...- Greater than or equals - < - Less than - <= - Less than or equals - in or In - ...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~62-~62:
Context: ...< - Less than - <= - Less than or equals - in or In - In array - startsWith or `St...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~63-~63:
Context: ...ss than or equals - in or In - In array - startsWith or StartsWith - String prefix match - ...
(QB_NEW_EN_OTHER_ERROR_IDS_)
[grammar] ~65-~65: Use correct spacing
Context: ...udeLeft, BetweenExcludeRight` - Range operators ### Order By Clauses - Format: JSON array o...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~69-~69: Use correct spacing
Context: ... direction], ...]- Direction:"asc"or"desc"` ### Example ```javascript const whereClaus...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~71-~71: Use correct spacing
Context: ...- Direction:"asc"or"desc"` ### Example javascript const whereClause = JSON.stringify([ ["$ownerId", ">", "5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk"], ["age", ">=", 18] ]); const orderBy = JSON.stringify([ ["$createdAt", "desc"], ["name", "asc"] ]);
(QB_NEW_EN_OTHER_ERROR_IDS_5)
packages/wasm-sdk/GROUP_QUERIES_DOCUMENTATION.md
[grammar] ~1-~1: Use correct spacing
Context: # Group Queries Implementation This document describes the implementat...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...ementation of group queries in the WASM SDK. ## Overview The group queries allow you t...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use proper spacing conventions.
Context: ...up queries in the WASM SDK. ## Overview The group queries allow you to interact ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~7-~7: Use correct spacing
Context: ...used to manage collective ownership and permissions. ## Implemented Queries ### 1. `get_group_...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~9-~9: There might be a problem here.
Context: ...ership and permissions. ## Implemented Queries ### 1. get_group_info Fetches information about a specific g...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~13-~13: Use correct spacing
Context: ... Fetches information about a specific group. **Parameters:** -sdk`: The WASM SDK ins...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~18-~18: There might be a problem here.
Context: ...e position of the group in the contract (u32) Returns: javascript { "members": { "identityId1": 100, // member ID -> voting power "identityId2": 50 }, "requiredPower": 100 // minimum power needed for decisions } Returns null if the group doesn't exi...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~30-~30: There might be a problem here.
Context: ...``` Returns null if the group doesn't exist. ### 2. `get_group_members` Gets members of a specific group with ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~34-~34: Use correct spacing
Context: ...cific group with optional filtering and pagination. Parameters: - sdk: The WASM SDK ins...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~42-~42: There might be a problem here.
Context: ... - limit: Optional limit on number of results Returns: javascript [ { "memberId": "identityId1", "power": 100 }, { "memberId": "identityId2", "power": 50 } ] ### 3. get_identity_groups Retrieves all groups associated with a...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~60-~60: Use correct spacing
Context: ...s all groups associated with a specific identity. Parameters: - sdk: The WASM SDK ins...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~67-~67: There might be a problem here.
Context: ... to search for moderator roles (not yet implemented) Returns: javascript [ { "dataContractId": "contractId1", "groupContractPosition": 0, "role": "member", "power": 100 // only for member role } ] Note: Currently only member role quer...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~81-~81: There might be a problem here.
Context: ...ntract queries not yet available in the SDK. ### 4. get_groups_data_contracts Fetches all groups for multiple data c...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~85-~85: Use correct spacing
Context: ... Fetches all groups for multiple data contracts. **Parameters:** -sdk`: The WASM SDK ins...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~89-~89: There might be a problem here.
Context: ...ay of data contract IDs to fetch groups from Returns: javascript [ { "dataContractId": "contractId1", "groups": [ { "position": 0, "group": { "members": { "identityId1": 100 }, "requiredPower": 100 } } ] } ] ## Implementation Details The implementat...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~111-~111: Use correct spacing
Context: ... } ] } ] ``` ## Implementation Details The implementation uses: - Dash SDK's `...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~113-~113: Use colons correctly
Context: ...lementation Details The implementation uses: - Dash SDK's Fetch and FetchMany traits fo...
(QB_NEW_EN_OTHER_ERROR_IDS_30)
[grammar] ~114-~114: Use correct spacing
Context: ...DK's Fetch and FetchMany traits for querying - GroupQuery and GroupInfosQuery types from the SDK - ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~115-~115: Use correct spacing
Context: ...yandGroupInfosQuerytypes from the SDK -serde_wasm_bindgenwithjson_compatible` serializer for proper...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~116-~116: There might be a mistake here.
Context: ...serializer for proper JavaScript object conversion - Base58 encoding for all identifiers pass...
(QB_NEW_EN_OTHER)
[grammar] ~117-~117: There might be a mistake here.
Context: ...ding for all identifiers passed to/from JavaScript ## Error Handling All functions return pr...
(QB_NEW_EN_OTHER)
[grammar] ~119-~119: Use proper spacing conventions.
Context: ...ed to/from JavaScript ## Error Handling All functions return proper error messag...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~122-~122: There might be a mistake here.
Context: ...essages when: - Invalid identifiers are provided - Network errors occur - Groups or cont...
(QB_NEW_EN_OTHER)
[grammar] ~123-~123: There might be a mistake here.
Context: ...entifiers are provided - Network errors occur - Groups or contracts don't exist ## E...
(QB_NEW_EN_OTHER)
[grammar] ~124-~124: There might be a mistake here.
Context: ...rrors occur - Groups or contracts don't exist ## Example Usage ```javascript import ini...
(QB_NEW_EN_OTHER)
[grammar] ~126-~126: Use correct spacing
Context: ...ps or contracts don't exist ## Example Usage javascript import init, { WasmSdkBuilder, get_group_info, get_group_members, get_identity_groups, get_groups_data_contracts } from './pkg/wasm_sdk.js'; // Initialize SDK await init(); const builder = new WasmSdkBuilder(); builder.with_core("127.0.0.1", 20002, "regtest", ""); const sdk = await builder.build(); // Get group info const groupInfo = await get_group_info( sdk, 'GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec', 0 ); // Get group members with pagination const members = await get_group_members( sdk, 'GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec', 0, null, // all members null, // start from beginning 10 // limit to 10 results ); // Get groups for an identity const identityGroups = await get_identity_groups( sdk, '4EfA9Jrvv3nnCFdSf7fad59851iiTRZ6Wcu6YVJ4iSeF', ['GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'], // check member role in this contract null, null );
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🪛 markdownlint-cli2 (0.17.2)
packages/rs-drive/QUERY_QUICK_REFERENCE.md
10-10: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
21-21: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
39-39: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (6)
packages/wasm-sdk/GROUP_QUERIES_DOCUMENTATION.md (1)
128-140: Import statement mixes default & named exports—verify accuracy
initis the default export from the generated WASM glue; everything else is named. The current lineimport init, { WasmSdkBuilder, ... }is correct only if your build emitsdefaultand named exports. Double-checkwasm-bindgenflags—older templates needimport init, * as sdk from ....packages/rs-drive/QUERY_QUICK_REFERENCE.md (1)
1-73: Excellent documentation for query capabilities and limitations.This quick reference document provides clear, actionable guidance on Dash Platform's query system. The examples effectively illustrate valid and invalid query patterns, and the warnings about ProveOptions are crucial for production safety.
packages/wasm-sdk/CLAUDE.md (1)
1-82: Helpful documentation for AI-assisted development.This documentation provides clear guidance for AI agents working with the WASM SDK, addressing common misconceptions about CORS/SSL issues and providing practical examples for query syntax.
packages/rs-drive/SECONDARY_INDEX_QUERIES.md (1)
1-340: Comprehensive and well-structured documentation for secondary index queries.This guide provides thorough coverage of the query system, including capabilities, limitations, and best practices. The detailed examples and error handling guidance make it particularly valuable for developers and AI agents.
packages/wasm-sdk/src/queries/epoch.rs (1)
1-297: Well-implemented epoch query functions with proper error handling.The implementation follows the established WASM SDK patterns and includes appropriate error handling, serialization, and async operations. The previous review concerns appear to have been addressed effectively.
packages/wasm-sdk/src/queries/document.rs (1)
1-370: Well-structured document query implementation with comprehensive functionality.The implementation provides robust document querying capabilities with proper error handling, serialization, and support for complex where and order clauses. The code follows established WASM SDK patterns effectively.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
packages/wasm-sdk/src/queries/document.rs (5)
44-45: Remove unused parameters or add TODO comment for future use.The
_data_contractand_document_typeparameters are currently unused but could be valuable for future enhancements like type validation or schema-aware property interpretation.Either remove these parameters if not needed, or add a TODO comment explaining their intended future use:
fn from_document( doc: &Document, - _data_contract: &dash_sdk::platform::DataContract, - _document_type: dash_sdk::dpp::data_contract::document_type::DocumentTypeRef + // TODO: Use data_contract and document_type for schema validation and type interpretation + _data_contract: &dash_sdk::platform::DataContract, + _document_type: dash_sdk::dpp::data_contract::document_type::DocumentTypeRef ) -> Result<Self, JsError> {
171-176: Improve identifier detection reliability.The hardcoded 44-character length check and alphanumeric validation may produce false positives or miss valid identifiers with different characteristics.
Consider using a more robust identifier detection approach:
-// Check if it's an identifier (base58 encoded) -if s.len() == 44 && s.chars().all(|c| c.is_alphanumeric()) { +// Try to parse as identifier first, fall back to text if it fails +match Identifier::from_string(s, dash_sdk::dpp::platform_value::string_encoding::Encoding::Base58) { + Ok(id) => Ok(platform_value!(id)), + Err(_) => Ok(Value::Text(s.clone())), +}This approach removes the hardcoded assumptions and relies on the actual identifier parsing logic.
289-298: Optimize data contract fetching to reduce redundant calls.The
get_documentsfunction fetches the data contract for every query, which could be expensive for repeated calls with the same contract ID.Consider caching the data contract or fetching it only once when needed:
// Fetch the data contract to get the document type +// TODO: Consider caching data contracts to avoid repeated fetches let data_contract = dash_sdk::platform::DataContract::fetch(sdk.as_ref(), contract_id) .await .map_err(|e| JsError::new(&format!("Failed to fetch data contract: {}", e)))? .ok_or_else(|| JsError::new("Data contract not found"))?;The SDK's existing context provider caching mechanism could be leveraged for this optimization.
408-412: Document the hardcoded DPNS field structure.The hardcoded field path "records.identity" assumes a specific DPNS document structure that may not be obvious to maintainers.
Add a comment explaining the DPNS document structure:
+// DPNS domain documents have a "records.identity" field that contains the identity ID +// that owns the domain name let where_clause = WhereClause { field: "records.identity".to_string(), operator: WhereOperator::Equal, value: Value::Identifier(identity_id_parsed.to_buffer()), };
67-67: Handle potential None value from revision() method.The
unwrap_or(0)might mask legitimate cases where revision should be None, potentially causing confusion in the frontend.Consider preserving the Option type or handling None more explicitly:
-revision: doc.revision().unwrap_or(0), +revision: doc.revision().unwrap_or(1), // Documents start at revision 1Or change the DocumentResponse field to
Option<u64>if None is a valid state.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/wasm-sdk/src/queries/document.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Rust code should be formatted using `cargo fmt --all` Rust code shoul...
**/*.rs: Rust code should be formatted usingcargo fmt --all
Rust code should be linted usingcargo clippy --workspace
Check Rust code usingcargo check --workspace
Run Rust tests usingcargo test
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/wasm-sdk/src/queries/document.rs
🧠 Learnings (2)
📓 Common learnings
Learnt from: QuantumExplorer
PR: dashpay/platform#2439
File: packages/rs-dpp/src/errors/consensus/state/token/mod.rs:4-22
Timestamp: 2025-01-23T02:10:08.979Z
Learning: The user QuantumExplorer prefers to handle documentation of breaking changes separately from the code changes, particularly for token-related error types and validation rules.
Learnt from: QuantumExplorer
PR: dashpay/platform#2673
File: packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/identity_update/mod.rs:1164-1197
Timestamp: 2025-06-18T03:44:14.385Z
Learning: QuantumExplorer determined that a CodeRabbit suggestion about fixing signable_bytes calculation in identity update tests with contract-bound keys was incorrect - the code flow is working as intended without the suggested changes.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/verify.rs:26-68
Timestamp: 2025-02-10T11:26:36.709Z
Learning: In the wasm-sdk package, empty vectors and placeholder values are intentionally used in verification functions during the proof-of-concept stage to ensure proper compilation and type checking.
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-04T09:08:48.470Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: shumkov
PR: dashpay/platform#2206
File: packages/rs-platform-version/src/version/protocol_version.rs:155-157
Timestamp: 2024-10-09T00:22:57.778Z
Learning: In the dashmate default configurations, the default protocol version for local networks has been removed, and an update mechanism for the protocol version in the consensus parameters has been implemented.
Learnt from: lklimek
PR: dashpay/platform#2405
File: packages/wasm-sdk/src/lib.rs:13-17
Timestamp: 2025-01-23T09:43:25.080Z
Learning: The codebase uses tracing_wasm for WebAssembly tracing as it provides sufficient functionality for the project's needs.
Learnt from: QuantumExplorer
PR: dashpay/platform#2257
File: packages/rs-drive-abci/src/mimic/test_quorum.rs:159-164
Timestamp: 2024-11-20T16:16:01.830Z
Learning: QuantumExplorer prefers not to receive auto-generated messages asking to post on social media.
packages/wasm-sdk/src/queries/document.rs (5)
Learnt from: CR
PR: dashpay/platform#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-01T13:35:47.879Z
Learning: Use WASM bindings to connect Rust and JavaScript code for cross-language integration
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/src/core/transaction.rs:0-0
Timestamp: 2024-10-29T14:40:54.727Z
Learning: In `packages/rs-sdk/src/platform/document_query.rs` and `packages/rs-sdk/src/core/transaction.rs`, certain places don't implement `IntoInner`, so direct error mappings cannot be simplified using `IntoInner`. A TODO comment has been added to address this in a future PR.
Learnt from: shumkov
PR: dashpay/platform#2182
File: packages/rs-platform-version/src/version/drive_abci_versions.rs:116-121
Timestamp: 2024-09-29T13:13:54.230Z
Learning: Adding Rust doc comments to structs and fields is recommended to enhance clarity and documentation.
Learnt from: lklimek
PR: dashpay/platform#2232
File: packages/rs-sdk/src/mock/sdk.rs:90-95
Timestamp: 2024-10-10T10:30:19.883Z
Learning: In `packages/rs-sdk/src/mock/sdk.rs`, the `load_expectations` method in `MockDashPlatformSdk` remains asynchronous (`async`) for backward compatibility, even though it now delegates to the synchronous `load_expectations_sync` method.
Learnt from: lklimek
PR: dashpay/platform#2277
File: packages/rs-sdk/tests/fetch/config.rs:233-233
Timestamp: 2024-10-30T11:19:59.163Z
Learning: In the Rust SDK's `rs-sdk/tests` integration tests (e.g., in `packages/rs-sdk/tests/fetch/config.rs`), we cannot create objects during tests because there is no support for object creation in this context. Therefore, hardcoded values for test identities must be used.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
- GitHub Check: Rust packages (dash-sdk) / Check each feature
- GitHub Check: Rust packages (dash-sdk) / Unused dependencies
- GitHub Check: Rust packages (dash-sdk) / Tests
- GitHub Check: Rust packages (drive) / Linting
- GitHub Check: Rust packages (drive) / Formatting
- GitHub Check: Rust packages (drive-abci) / Check each feature
- GitHub Check: Rust packages (drive-abci) / Tests
- GitHub Check: Rust packages (drive-abci) / Linting
- GitHub Check: Build JS packages / Build JS
- GitHub Check: build-wasm-sdk
🔇 Additional comments (3)
packages/wasm-sdk/src/queries/document.rs (3)
198-312: Excellent implementation of document querying with comprehensive features.The
get_documentsfunction provides a well-structured approach to document querying with support for filtering, ordering, pagination, and proper error handling. The JSON-to-platform-value conversion and query clause parsing are well implemented.
314-371: Clean and efficient single document fetch implementation.The
get_documentfunction follows a clear pattern with proper error handling and null return for missing documents.
373-452: Well-implemented DPNS username lookup with proper error handling.The
get_dpns_usernamefunction correctly queries DPNS domains and constructs usernames from the label and parent domain fields.
|
Self Reviewed. |
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores
Checklist:
For repository code-owners and collaborators only