Skip to content

feat(drive): add array element indexing support #2974

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
pauldelucia wants to merge 16 commits into
base: v3.0-dev
Choose a base branch
from
Draft

feat(drive): add array element indexing support #2974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f66c5b8
feat(drive): add array element indexing support
pauldelucia Jan 10, 2026
313f024
fmt
pauldelucia Jan 10, 2026
71d8fd4
Merge branch 'v3.0-dev' into feat/arrayElementIndexing
pauldelucia Jan 10, 2026
acfa3fd
fix: coderabbit review fixes
pauldelucia Jan 10, 2026
59a7378
Merge branch 'feat/arrayElementIndexing' of https://github.com/dashpa…
pauldelucia Jan 10, 2026
f207c8d
fmt
pauldelucia Jan 11, 2026
71cc467
Merge branch 'v3.0-dev' into feat/arrayElementIndexing
pauldelucia Jan 12, 2026
3becadc
coderabbit fixes
pauldelucia Jan 12, 2026
8952edb
Merge branch 'feat/arrayElementIndexing' of https://github.com/dashpa…
pauldelucia Jan 12, 2026
1c4aa07
feat: more tests
pauldelucia Jan 12, 2026
6c0950d
feat(dpp): add array serialization support for document delete/update
pauldelucia Jan 12, 2026
6d6518b
fmt
pauldelucia Jan 12, 2026
20ee9b5
fix: add date to match
pauldelucia Jan 12, 2026
6361dc5
Merge branch 'v3.0-dev' into feat/arrayElementIndexing
pauldelucia Jan 13, 2026
3d1d2e7
coderabbit ai review suggestions
pauldelucia Jan 13, 2026
4cfdc7f
Merge branch 'feat/arrayElementIndexing' of https://github.com/dashpa…
pauldelucia Jan 13, 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
113 changes: 109 additions & 4 deletions packages/rs-dpp/src/data_contract/document_type/class_methods/try_from_schema/v0/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ use crate::consensus::basic::data_contract::{
use crate::consensus::ConsensusError;
use crate::data_contract::document_type::index::Index;
use crate::data_contract::document_type::index_level::IndexLevel;
#[cfg(feature = "validation")]
use crate::data_contract::document_type::property::ArrayItemType;
use crate::data_contract::document_type::property::DocumentProperty;
#[cfg(feature = "validation")]
use crate::data_contract::document_type::property::DocumentPropertyType;
Expand Down Expand Up @@ -410,7 +412,10 @@ impl DocumentTypeV0 {
}

// Validate indexed properties
index.properties.iter().try_for_each(|index_property| {
// Track array properties for validation
let mut array_property_position: Option<usize> = None;

index.properties.iter().enumerate().try_for_each(|(position, index_property)| {
// Do not allow to index already indexed system properties
if NOT_ALLOWED_SYSTEM_PROPERTIES
.contains(&index_property.name.as_str())
Expand Down Expand Up @@ -449,9 +454,92 @@ impl DocumentTypeV0 {

// Validate indexed property type
match &property_definition.property_type {
// Array and objects aren't supported for indexing yet
DocumentPropertyType::Array(_)
| DocumentPropertyType::Object(_)
// Arrays with indexable scalar element types are supported
DocumentPropertyType::Array(array_item_type) => {
// Validate that array item type is indexable
match array_item_type {
// String arrays must have bounded element length
ArrayItemType::String(_, max_len) => {
if max_len.is_none()
|| max_len.unwrap() as u16
> MAX_INDEXED_STRING_PROPERTY_LENGTH
{
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"maxLength".to_string(),
format!(
"array string items should have maxLength less or equal {}",
MAX_INDEXED_STRING_PROPERTY_LENGTH
),
)
.into(),
)));
}
}
// ByteArray elements must have bounded size
ArrayItemType::ByteArray(_, max_size) => {
if max_size.is_none()
|| max_size.unwrap() as u16
> MAX_INDEXED_BYTE_ARRAY_PROPERTY_LENGTH
{
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"maxItems".to_string(),
format!(
"array byteArray items should have maxItems less or equal {}",
MAX_INDEXED_BYTE_ARRAY_PROPERTY_LENGTH
),
)
.into(),
)));
}
}
// These scalar types are allowed
ArrayItemType::Integer
| ArrayItemType::Number
| ArrayItemType::Identifier
| ArrayItemType::Date => {}
// Boolean arrays don't make sense for indexing
ArrayItemType::Boolean => {
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexPropertyTypeError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"array of boolean".to_string(),
)
.into(),
)));
}
}

// Check if we already have an array property in this index
if array_property_position.is_some() {
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"array".to_string(),
"only one array property is allowed per index".to_string(),
)
.into(),
)));
}

// Record the position of the array property
array_property_position = Some(position);

Ok(())
}
// Objects and variable type arrays aren't supported for indexing
DocumentPropertyType::Object(_)
| DocumentPropertyType::VariableTypeArray(_) => {
Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexPropertyTypeError::new(
Expand Down Expand Up @@ -509,6 +597,23 @@ impl DocumentTypeV0 {
Ok(())
}
})?;

// If there's an array property, it must be at the last position
if let Some(pos) = array_property_position {
if pos != index.properties.len() - 1 {
let array_prop_name = &index.properties[pos].name;
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
array_prop_name.to_owned(),
"position".to_string(),
"array property must be the last property in a compound index".to_string(),
)
.into(),
)));
}
}
}

Ok((index.name.clone(), index))
Expand Down
113 changes: 109 additions & 4 deletions packages/rs-dpp/src/data_contract/document_type/class_methods/try_from_schema/v1/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ use crate::consensus::basic::data_contract::{
use crate::consensus::ConsensusError;
use crate::data_contract::document_type::index::Index;
use crate::data_contract::document_type::index_level::IndexLevel;
#[cfg(feature = "validation")]
use crate::data_contract::document_type::property::ArrayItemType;
use crate::data_contract::document_type::property::DocumentProperty;
#[cfg(feature = "validation")]
use crate::data_contract::document_type::property::DocumentPropertyType;
Expand Down Expand Up @@ -427,7 +429,10 @@ impl DocumentTypeV1 {
}

// Validate indexed properties
index.properties.iter().try_for_each(|index_property| {
// Track array properties for validation
let mut array_property_position: Option<usize> = None;

index.properties.iter().enumerate().try_for_each(|(position, index_property)| {
// Do not allow to index already indexed system properties
if NOT_ALLOWED_SYSTEM_PROPERTIES
.contains(&index_property.name.as_str())
Expand Down Expand Up @@ -466,9 +471,92 @@ impl DocumentTypeV1 {

// Validate indexed property type
match &property_definition.property_type {
// Array and objects aren't supported for indexing yet
DocumentPropertyType::Array(_)
| DocumentPropertyType::Object(_)
// Arrays with indexable scalar element types are supported
DocumentPropertyType::Array(array_item_type) => {
// Validate that array item type is indexable
match array_item_type {
// String arrays must have bounded element length
ArrayItemType::String(_, max_len) => {
if max_len.is_none()
|| max_len.unwrap() as u16
> MAX_INDEXED_STRING_PROPERTY_LENGTH
{
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"maxLength".to_string(),
format!(
"array string items should have maxLength less or equal {}",
MAX_INDEXED_STRING_PROPERTY_LENGTH
),
)
.into(),
)));
}
}
// ByteArray elements must have bounded size
ArrayItemType::ByteArray(_, max_size) => {
if max_size.is_none()
|| max_size.unwrap() as u16
> MAX_INDEXED_BYTE_ARRAY_PROPERTY_LENGTH
{
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"maxItems".to_string(),
format!(
"array byteArray items should have maxItems less or equal {}",
MAX_INDEXED_BYTE_ARRAY_PROPERTY_LENGTH
),
)
.into(),
)));
}
}
// These scalar types are allowed
ArrayItemType::Integer
| ArrayItemType::Number
| ArrayItemType::Identifier
| ArrayItemType::Date => {}
// Boolean arrays don't make sense for indexing
ArrayItemType::Boolean => {
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexPropertyTypeError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"array of boolean".to_string(),
)
.into(),
)));
}
}

// Check if we already have an array property in this index
if array_property_position.is_some() {
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
index_property.name.to_owned(),
"array".to_string(),
"only one array property is allowed per index".to_string(),
)
.into(),
)));
}

// Record the position of the array property
array_property_position = Some(position);

Ok(())
}
// Objects and variable type arrays aren't supported for indexing
DocumentPropertyType::Object(_)
| DocumentPropertyType::VariableTypeArray(_) => {
Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexPropertyTypeError::new(
Expand Down Expand Up @@ -526,6 +614,23 @@ impl DocumentTypeV1 {
Ok(())
}
})?;

// If there's an array property, it must be at the last position
if let Some(pos) = array_property_position {
if pos != index.properties.len() - 1 {
let array_prop_name = &index.properties[pos].name;
return Err(ProtocolError::ConsensusError(Box::new(
InvalidIndexedPropertyConstraintError::new(
name.to_owned(),
index.name.to_owned(),
array_prop_name.to_owned(),
"position".to_string(),
"array property must be the last property in a compound index".to_string(),
)
.into(),
)));
}
}
}

Ok((index.name.clone(), index))
Expand Down
1 change: 1 addition & 0 deletions packages/rs-dpp/src/data_contract/document_type/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ pub(crate) mod property_names {
pub const MINIMUM: &str = "minimum";
pub const ENUM: &str = "enum";
pub const MAXIMUM: &str = "maximum";
pub const ITEMS: &str = "items";
pub const MIN_ITEMS: &str = "minItems";
pub const MAX_ITEMS: &str = "maxItems";
pub const MIN_LENGTH: &str = "minLength";
Expand Down
Loading
Loading