Skip to content

feat(sdk): add client-side validate_base_structure for document and token transitions #3133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
thepastaclaw wants to merge 14 commits into
base: v3.1-dev
Choose a base branch
from
Draft

feat(sdk): add client-side validate_base_structure for document and token transitions #3133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
4568e47
feat(sdk): add client-side validate_base_structure for document and t…
thepastaclaw Feb 20, 2026
e52eb1f
fix: replace unwrap() with safe if-let in validation error handling
thepastaclaw Feb 20, 2026
1ac31c3
style: apply cargo fmt to rs-sdk and rs-dapi
thepastaclaw Feb 21, 2026
e47606b
fix(wasm-sdk): add maxLength to indexed rarity field in test fixture
thepastaclaw Feb 21, 2026
a39718c
test(sdk): add validate_base_structure error path tests for document …
thepastaclaw Feb 21, 2026
b8e5813
test(sdk): add validate_base_structure error path tests for all builders
thepastaclaw Feb 21, 2026
c30a1bf
refactor(sdk): remove 5 redundant document nonce-masking tests
thepastaclaw Feb 21, 2026
f8cb63a
refactor(sdk): extract validate_batch_base_structure helper to reduce…
thepastaclaw Mar 16, 2026
26d5181
refactor(sdk): extract shared test helpers to reduce test duplication
thepastaclaw Mar 16, 2026
72a0d81
test(sdk): add document builder sign() integration test
thepastaclaw Mar 16, 2026
569a2ca
fix(sdk): log dropped validation errors in validate_batch_base_structure
thepastaclaw Mar 17, 2026
ebc6d26
test(sdk): add happy-path sign() tests for all document builders
thepastaclaw Mar 17, 2026
6f7cd0b
test(sdk): add happy-path sign() tests for all token builders
thepastaclaw Mar 17, 2026
6343a25
test(sdk): assert non-empty signature in document builder happy-path …
thepastaclaw Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,4 @@ book/book/

# gRPC coverage report
grpc-coverage-report.txt
worktrees/
1 change: 1 addition & 0 deletions packages/rs-sdk/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ arc-swap = { version = "1.7.1" }
chrono = { version = "0.4.38" }
dpp = { path = "../rs-dpp", default-features = false, features = [
"dash-sdk-features",
"validation",
] }
Comment on lines 10 to 13
Copy link
Collaborator Author

@thepastaclaw thepastaclaw Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Suggestion: 'validation' feature moved from dev-dependencies to unconditional dependency

Previously validation was only in [dev-dependencies] for dpp. This PR adds it to the main [dependencies], which pulls in jsonschema (custom fork), json-schema-compatibility-validator, platform-value-json, and enables dashcore/eddsa (ed25519-dalek) for all SDK consumers. The SDK only uses BatchTransition::validate_base_structure() from this feature. Consider gating behind an optional SDK feature flag (e.g., client-validation) so consumers wanting minimal binary size can opt out.

source: unknown

🤖 Fix this with AI agents 
These findings are from an automated code review. Verify each finding against the current code and only fix it if needed.

In `packages/rs-sdk/Cargo.toml`:
- [SUGGESTION] lines 10-13: 'validation' feature moved from dev-dependencies to unconditional dependency
  Previously `validation` was only in `[dev-dependencies]` for dpp. This PR adds it to the main `[dependencies]`, which pulls in `jsonschema` (custom fork), `json-schema-compatibility-validator`, `platform-value-json`, and enables `dashcore/eddsa` (ed25519-dalek) for all SDK consumers. The SDK only uses `BatchTransition::validate_base_structure()` from this feature. Consider gating behind an optional SDK feature flag (e.g., `client-validation`) so consumers wanting minimal binary size can opt out.

dapi-grpc = { path = "../dapi-grpc", default-features = false }
rs-dapi-client = { path = "../rs-dapi-client", default-features = false }
Expand Down
2 changes: 2 additions & 0 deletions packages/rs-sdk/src/platform.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ pub mod identities_contract_keys_query;
pub mod query;
#[cfg(feature = "shielded")]
pub mod shielded;
#[cfg(test)]
pub(crate) mod test_helpers;
pub mod tokens;
pub mod transition;
pub mod trunk_branch_sync;
Expand Down
12 changes: 12 additions & 0 deletions packages/rs-sdk/src/platform/documents/transitions/create.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::platform::transition::broadcast::BroadcastStateTransition;
use crate::platform::transition::put_settings::PutSettings;
use crate::platform::transition::validation::validate_batch_base_structure;
use crate::{Error, Sdk};
use dpp::data_contract::accessors::v0::DataContractV0Getters;
use dpp::data_contract::DataContract;
Expand Down Expand Up @@ -166,6 +167,9 @@ impl DocumentCreateTransitionBuilder {
self.state_transition_creation_options,
)?;

// Validate the transition structure before returning
validate_batch_base_structure(&state_transition, platform_version)?;

Ok(state_transition)
}
}
Expand Down Expand Up @@ -248,3 +252,11 @@ impl Sdk {
}
}
}

#[cfg(test)]
mod validation_tests {
#[test]
fn validate_base_structure_error_case() {
super::super::tests::assert_document_create_validate_base_structure_error();
}
}
12 changes: 12 additions & 0 deletions packages/rs-sdk/src/platform/documents/transitions/delete.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::platform::transition::broadcast::BroadcastStateTransition;
use crate::platform::transition::put_settings::PutSettings;
use crate::platform::transition::validation::validate_batch_base_structure;
use crate::platform::Identifier;
use crate::{Error, Sdk};
use dpp::data_contract::accessors::v0::DataContractV0Getters;
Expand Down Expand Up @@ -207,6 +208,9 @@ impl DocumentDeleteTransitionBuilder {
self.state_transition_creation_options,
)?;

// Validate the transition structure before returning
validate_batch_base_structure(&state_transition, platform_version)?;

Ok(state_transition)
}
}
Expand Down Expand Up @@ -285,3 +289,11 @@ impl Sdk {
}
}
}

#[cfg(test)]
mod validation_tests {
#[test]
fn validate_base_structure_error_case() {
super::super::tests::assert_document_delete_validate_base_structure_error();
}
}
2 changes: 2 additions & 0 deletions packages/rs-sdk/src/platform/documents/transitions/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ pub mod delete;
pub mod purchase;
pub mod replace;
pub mod set_price;
#[cfg(test)]
mod tests;
pub mod transfer;

pub use create::{DocumentCreateResult, DocumentCreateTransitionBuilder};
Expand Down
12 changes: 12 additions & 0 deletions packages/rs-sdk/src/platform/documents/transitions/purchase.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::platform::transition::broadcast::BroadcastStateTransition;
use crate::platform::transition::put_settings::PutSettings;
use crate::platform::transition::validation::validate_batch_base_structure;
use crate::platform::Identifier;
use crate::{Error, Sdk};
use dpp::data_contract::accessors::v0::DataContractV0Getters;
Expand Down Expand Up @@ -221,6 +222,9 @@ impl DocumentPurchaseTransitionBuilder {
self.state_transition_creation_options,
)?;

// Validate the transition structure before returning
validate_batch_base_structure(&state_transition, platform_version)?;

Ok(state_transition)
}
}
Expand Down Expand Up @@ -302,3 +306,11 @@ impl Sdk {
}
}
}

#[cfg(test)]
mod validation_tests {
#[test]
fn validate_base_structure_error_case() {
super::super::tests::assert_document_purchase_validate_base_structure_error();
}
}
12 changes: 12 additions & 0 deletions packages/rs-sdk/src/platform/documents/transitions/replace.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::platform::transition::broadcast::BroadcastStateTransition;
use crate::platform::transition::put_settings::PutSettings;
use crate::platform::transition::validation::validate_batch_base_structure;
use crate::{Error, Sdk};
use dpp::data_contract::accessors::v0::DataContractV0Getters;
use dpp::data_contract::DataContract;
Expand Down Expand Up @@ -160,6 +161,9 @@ impl DocumentReplaceTransitionBuilder {
self.state_transition_creation_options,
)?;

// Validate the transition structure before returning
validate_batch_base_structure(&state_transition, platform_version)?;

Ok(state_transition)
}
}
Expand Down Expand Up @@ -248,3 +252,11 @@ impl Sdk {
}
}
}

#[cfg(test)]
mod validation_tests {
#[test]
fn validate_base_structure_error_case() {
super::super::tests::assert_document_replace_validate_base_structure_error();
}
}
12 changes: 12 additions & 0 deletions packages/rs-sdk/src/platform/documents/transitions/set_price.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::platform::transition::broadcast::BroadcastStateTransition;
use crate::platform::transition::put_settings::PutSettings;
use crate::platform::transition::validation::validate_batch_base_structure;
use crate::platform::Identifier;
use crate::{Error, Sdk};
use dpp::data_contract::accessors::v0::DataContractV0Getters;
Expand Down Expand Up @@ -208,6 +209,9 @@ impl DocumentSetPriceTransitionBuilder {
self.state_transition_creation_options,
)?;

// Validate the transition structure before returning
validate_batch_base_structure(&state_transition, platform_version)?;

Ok(state_transition)
}
}
Expand Down Expand Up @@ -286,3 +290,11 @@ impl Sdk {
}
}
}

#[cfg(test)]
mod validation_tests {
#[test]
fn validate_base_structure_error_case() {
super::super::tests::assert_document_set_price_validate_base_structure_error();
}
}
Loading
Loading