Skip to content
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

Jump to bottom

Type validation for contract state against strict encoding type system #108

Merged
merged 2 commits into from
Jun 21, 2022
Merged

Type validation for contract state against strict encoding type system #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bb1741
Validate strict encoding schema
dr-orlovsky Jun 21, 2022
47ad311
Complete type validation
dr-orlovsky Jun 21, 2022
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
12 changes: 6 additions & 6 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ path = "src/lib.rs"
amplify = { version = "~3.12.0", features = ["apfloat"] }
bp-core = { version = "~0.7.0" }
lnpbp = { version = "~0.7.0", features = ["zip"] }
stens = "~0.3.2"
stens = "~0.4.0"
strict_encoding = { version = "~1.8.8", features = ["crypto", "chrono", "bitcoin", "float"] }
commit_verify = { version = "~0.7.0", features = ["rand", "bulletproofs"] }
descriptor-wallet = "~0.7.1"
Expand Down
21 changes: 14 additions & 7 deletions src/schema/schema.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ mod _validation {
use commit_verify::CommitConceal;

use super::*;
use crate::schema::state::StenValidate;
use crate::schema::{
MetadataStructure, OwnedRightsStructure, PublicRightsStructure, SchemaVerify,
};
Expand Down Expand Up @@ -446,14 +447,16 @@ mod _validation {
for data in set {
let schema_type = data.schema_type();
if &schema_type != field
&& !matches!((data, field), (data::Revealed::Bytes(_), TypeRef::Named(_)))
&& !matches!(
(&data, field),
(data::Revealed::Bytes(_), TypeRef::Named(_))
)
{
status.add_failure(validation::Failure::SchemaMismatchedDataType(
*field_type_id,
));
}
// TODO: [validation] validate type serialization for structured types
// status += field.validate(&data);
status += field.validate(&self.type_system, node_id, *field_type_id, &data);
}
}

Expand Down Expand Up @@ -562,16 +565,20 @@ mod _validation {
match owned_rights.get(owned_type_id) {
None => {}
Some(AssignmentVec::Declarative(set)) => set.iter().for_each(|data| {
status += assignment.validate(&node_id, *owned_type_id, data)
status +=
assignment.validate(&self.type_system, &node_id, *owned_type_id, data)
}),
Some(AssignmentVec::Fungible(set)) => set.iter().for_each(|data| {
status += assignment.validate(&node_id, *owned_type_id, data)
status +=
assignment.validate(&self.type_system, &node_id, *owned_type_id, data)
}),
Some(AssignmentVec::NonFungible(set)) => set.iter().for_each(|data| {
status += assignment.validate(&node_id, *owned_type_id, data)
status +=
assignment.validate(&self.type_system, &node_id, *owned_type_id, data)
}),
Some(AssignmentVec::Attachment(set)) => set.iter().for_each(|data| {
status += assignment.validate(&node_id, *owned_type_id, data)
status +=
assignment.validate(&self.type_system, &node_id, *owned_type_id, data)
}),
};
}
Expand Down
136 changes: 121 additions & 15 deletions src/schema/state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,20 +64,118 @@ pub enum DiscreteFiniteFieldFormat {

mod _validation {
use core::any::Any;
use std::io;

use amplify::AsAny;
use commit_verify::CommitConceal;
use stens::{PrimitiveType, TypeConstr, TypeSystem, Validate};

use super::*;
use crate::contract::AttachmentStrategy;
use crate::schema::OwnedRightType;
use crate::{
validation, Assignment, DeclarativeStrategy, HashStrategy, NodeId, PedersenStrategy, State,
data, validation, Assignment, DeclarativeStrategy, HashStrategy, NodeId, PedersenStrategy,
State,
};

pub trait StenValidate {
fn validate(
&self,
type_system: &TypeSystem,
node_id: NodeId,
schema_type_id: u16,
data: &data::Revealed,
) -> validation::Status;
}

impl StenValidate for PrimitiveType {
fn validate(
&self,
_: &TypeSystem,
node_id: NodeId,
schema_type_id: u16,
data: &data::Revealed,
) -> validation::Status {
let mut status = validation::Status::new();
match (self, data) {
(PrimitiveType::U8, data::Revealed::U8(_))
| (PrimitiveType::U16, data::Revealed::U16(_))
| (PrimitiveType::U32, data::Revealed::U32(_))
| (PrimitiveType::U64, data::Revealed::U64(_))
| (PrimitiveType::U128, data::Revealed::U128(_))
| (PrimitiveType::U256, data::Revealed::U256(_))
| (PrimitiveType::U512, data::Revealed::U512(_))
| (PrimitiveType::U1024, data::Revealed::U1024(_))
| (PrimitiveType::I8, data::Revealed::I8(_))
| (PrimitiveType::I16, data::Revealed::I16(_))
| (PrimitiveType::I32, data::Revealed::I32(_))
| (PrimitiveType::I64, data::Revealed::I64(_))
| (PrimitiveType::I128, data::Revealed::I128(_))
| (PrimitiveType::I256, data::Revealed::I256(_))
| (PrimitiveType::I512, data::Revealed::I512(_))
| (PrimitiveType::I1024, data::Revealed::I1024(_))
| (PrimitiveType::F16b, data::Revealed::F16B(_))
| (PrimitiveType::F16, data::Revealed::F16(_))
| (PrimitiveType::F32, data::Revealed::F32(_))
| (PrimitiveType::F64, data::Revealed::F64(_))
| (PrimitiveType::F80, data::Revealed::F80(_))
| (PrimitiveType::F128, data::Revealed::F128(_))
| (PrimitiveType::F256, data::Revealed::F256(_)) => {}
_ => {
status.add_failure(validation::Failure::InvalidStateDataType(
node_id,
schema_type_id,
TypeRef::Primitive(TypeConstr::Plain(self.clone())),
data.clone(),
));
}
}
status
}
}

impl StenValidate for TypeRef {
fn validate(
&self,
type_system: &TypeSystem,
node_id: NodeId,
schema_type_id: u16,
data: &data::Revealed,
) -> validation::Status {
let mut status = validation::Status::new();
match (self, data) {
(TypeRef::Primitive(TypeConstr::Plain(ty)), _) => {
status +=
StenValidate::validate(ty, type_system, node_id, schema_type_id, data);
}
(TypeRef::Named(ty), data::Revealed::Bytes(bytes)) => {
let mut cursor = io::Cursor::new(bytes.as_slice());
if !ty.validate(type_system, &mut cursor) {
status.add_failure(validation::Failure::InvalidStateDataValue(
node_id,
schema_type_id,
self.clone(),
bytes.clone(),
));
}
}
_ => {
status.add_failure(validation::Failure::InvalidStateDataType(
node_id,
schema_type_id,
self.clone(),
data.clone(),
));
}
}
status
}
}

impl StateSchema {
pub fn validate<STATE>(
&self,
type_system: &TypeSystem,
node_id: &NodeId,
assignment_id: OwnedRightType,
data: &Assignment<STATE>,
Expand Down Expand Up @@ -188,8 +286,13 @@ mod _validation {
);
}
Some(data) => {
// TODO: [validation] validate type schema
// status += format.validate(assignment_id, data);
status += StenValidate::validate(
format,
type_system,
*node_id,
assignment_id,
data,
);
}
}
}
Expand All @@ -209,6 +312,7 @@ mod _validation {
}
}
}
pub(super) use _validation::StenValidate;

#[cfg(test)]
mod test {
Expand All @@ -217,6 +321,7 @@ mod test {
use bitcoin::hashes::sha256;
use commit_verify::{CommitConceal, TaggedHash};
use secp256k1zkp::rand::thread_rng;
use stens::TypeSystem;
use strict_encoding::StrictDecode;

use super::*;
Expand Down Expand Up @@ -307,77 +412,78 @@ mod test {
let hash_format = StateSchema::CustomData(TypeRef::bytes());

// Assert different failure combinations
let ts = TypeSystem::default();
assert_eq!(
dec_format
.validate(&node_id, 3u16, &assignment_ped_rev)
.validate(&ts, &node_id, 3u16, &assignment_ped_rev)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
dec_format
.validate(&node_id, 3u16, &assignment_ped_conf)
.validate(&ts, &node_id, 3u16, &assignment_ped_conf)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
dec_format
.validate(&node_id, 3u16, &assignment_hash_rev)
.validate(&ts, &node_id, 3u16, &assignment_hash_rev)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
dec_format
.validate(&node_id, 3u16, &assignment_hash_conf)
.validate(&ts, &node_id, 3u16, &assignment_hash_conf)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);

assert_eq!(
ped_format
.validate(&node_id, 3u16, &assignment_dec_rev)
.validate(&ts, &node_id, 3u16, &assignment_dec_rev)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
ped_format
.validate(&node_id, 3u16, &assignment_dec_conf)
.validate(&ts, &node_id, 3u16, &assignment_dec_conf)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
ped_format
.validate(&node_id, 3u16, &assignment_hash_rev)
.validate(&ts, &node_id, 3u16, &assignment_hash_rev)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
ped_format
.validate(&node_id, 3u16, &assignment_hash_conf)
.validate(&ts, &node_id, 3u16, &assignment_hash_conf)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);

assert_eq!(
hash_format
.validate(&node_id, 3u16, &assignment_dec_rev)
.validate(&ts, &node_id, 3u16, &assignment_dec_rev)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
hash_format
.validate(&node_id, 3u16, &assignment_dec_conf)
.validate(&ts, &node_id, 3u16, &assignment_dec_conf)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
hash_format
.validate(&node_id, 3u16, &assignment_ped_rev)
.validate(&ts, &node_id, 3u16, &assignment_ped_rev)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
assert_eq!(
hash_format
.validate(&node_id, 3u16, &assignment_ped_conf)
.validate(&ts, &node_id, 3u16, &assignment_ped_conf)
.failures[0],
Failure::SchemaMismatchedStateType(3)
);
Expand Down
6 changes: 5 additions & 1 deletion src/validation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ use bitcoin::{Transaction, Txid};
use bp::dbc::Anchor;
use bp::seals::txout::TxoSeal;
use commit_verify::{lnpbp4, CommitConceal};
use stens::TypeRef;
use wallet::onchain::ResolveTx;

use super::schema::{NodeType, OccurrencesError};
use super::{schema, seal, AssignmentVec, ContractId, Node, NodeId, Schema, SchemaId};
use crate::schema::SchemaVerify;
use crate::stash::Consignment;
use crate::{BundleId, Extension, SealEndpoint, TransitionBundle};
use crate::{data, BundleId, Extension, SealEndpoint, TransitionBundle};

#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Display)]
#[display(Debug)]
Expand Down Expand Up @@ -207,6 +208,9 @@ pub enum Failure {

EndpointTransitionNotFound(NodeId),

InvalidStateDataType(NodeId, u16, TypeRef, data::Revealed),
InvalidStateDataValue(NodeId, u16, TypeRef, Vec<u8>),

/// invalid bulletproofs in {0}:{1}: {2}
InvalidBulletproofs(NodeId, u16, secp256k1zkp::Error),

Expand Down