Frontend: simplify custom predicates interfaces (#83)
* add comments detailing logic, migrate middleware::custom::tests to frontend::custom
* simplify custom predicate's frontend interfaces, making it less verbose to define Statement Template arguments
The main idea is that when defining the arguments at a statement
template, it can be done from 3 different inputs:
i. `(&str, literal)`: this is to set a POD and a field, ie. `(POD, literal("field")`)
ii. `(&str, &str)`: this is to define a origin-key wildcard pair, ie. `(src_origin, src_dest)`
iii. `Value`: this is to define a literal value, ie. `0`
This commit is contained in:
parent
d3bc892906
commit
538353a701
5 changed files with 351 additions and 273 deletions
|
|
@ -51,7 +51,7 @@ impl fmt::Display for StatementTmplArg {
|
|||
|
||||
/// Statement Template for a Custom Predicate
|
||||
#[derive(Debug)]
|
||||
pub struct StatementTmpl(Predicate, Vec<StatementTmplArg>);
|
||||
pub struct StatementTmpl(pub Predicate, pub Vec<StatementTmplArg>);
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct CustomPredicate {
|
||||
|
|
@ -63,6 +63,14 @@ pub struct CustomPredicate {
|
|||
// TODO: Add args type information?
|
||||
}
|
||||
|
||||
impl ToFields for CustomPredicate {
|
||||
fn to_fields(self) -> (Vec<F>, usize) {
|
||||
todo!()
|
||||
// let f: Vec<F> = Vec::new();
|
||||
// (self.conjunction.to_f(), 1)
|
||||
}
|
||||
}
|
||||
|
||||
impl fmt::Display for CustomPredicate {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
writeln!(f, "{}<", if self.conjunction { "and" } else { "or" })?;
|
||||
|
|
@ -90,7 +98,8 @@ impl fmt::Display for CustomPredicate {
|
|||
|
||||
#[derive(Debug)]
|
||||
pub struct CustomPredicateBatch {
|
||||
predicates: Vec<CustomPredicate>,
|
||||
pub name: String,
|
||||
pub predicates: Vec<CustomPredicate>,
|
||||
}
|
||||
|
||||
impl CustomPredicateBatch {
|
||||
|
|
@ -115,7 +124,11 @@ impl From<NativePredicate> for Predicate {
|
|||
|
||||
impl ToFields for Predicate {
|
||||
fn to_fields(self) -> (Vec<F>, usize) {
|
||||
todo!()
|
||||
match self {
|
||||
Self::Native(p) => p.to_fields(),
|
||||
Self::BatchSelf(i) => Value::from(i as i64).to_fields(),
|
||||
Self::Custom(_pb, _i) => todo!(), // TODO
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -124,274 +137,7 @@ impl fmt::Display for Predicate {
|
|||
match self {
|
||||
Self::Native(p) => write!(f, "{:?}", p),
|
||||
Self::BatchSelf(i) => write!(f, "self.{}", i),
|
||||
Self::Custom(pb, i) => write!(f, "{}.{}", pb.hash(), i),
|
||||
Self::Custom(pb, i) => write!(f, "{}.{}", pb.name, i),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::middleware::PodType;
|
||||
|
||||
enum HashOrWildcardStr {
|
||||
Hash(Hash),
|
||||
Wildcard(String),
|
||||
}
|
||||
|
||||
fn l(s: &str) -> HashOrWildcardStr {
|
||||
HashOrWildcardStr::Hash(hash_str(s))
|
||||
}
|
||||
|
||||
fn w(s: &str) -> HashOrWildcardStr {
|
||||
HashOrWildcardStr::Wildcard(s.to_string())
|
||||
}
|
||||
|
||||
enum BuilderArg {
|
||||
Literal(Value),
|
||||
Key(HashOrWildcardStr, HashOrWildcardStr),
|
||||
}
|
||||
|
||||
impl From<(HashOrWildcardStr, HashOrWildcardStr)> for BuilderArg {
|
||||
fn from((pod_id, key): (HashOrWildcardStr, HashOrWildcardStr)) -> Self {
|
||||
Self::Key(pod_id, key)
|
||||
}
|
||||
}
|
||||
|
||||
impl<V> From<V> for BuilderArg
|
||||
where
|
||||
V: Into<Value>,
|
||||
{
|
||||
fn from(v: V) -> Self {
|
||||
Self::Literal(v.into())
|
||||
}
|
||||
}
|
||||
|
||||
struct StatementTmplBuilder {
|
||||
predicate: Predicate,
|
||||
args: Vec<BuilderArg>,
|
||||
}
|
||||
|
||||
fn st_tmpl(p: impl Into<Predicate>) -> StatementTmplBuilder {
|
||||
StatementTmplBuilder {
|
||||
predicate: p.into(),
|
||||
args: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
impl StatementTmplBuilder {
|
||||
fn arg(mut self, a: impl Into<BuilderArg>) -> Self {
|
||||
self.args.push(a.into());
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
struct CustomPredicateBatchBuilder {
|
||||
predicates: Vec<CustomPredicate>,
|
||||
}
|
||||
|
||||
impl CustomPredicateBatchBuilder {
|
||||
fn new() -> Self {
|
||||
Self {
|
||||
predicates: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
fn predicate_and(
|
||||
&mut self,
|
||||
args: &[&str],
|
||||
priv_args: &[&str],
|
||||
sts: &[StatementTmplBuilder],
|
||||
) -> Predicate {
|
||||
self.predicate(true, args, priv_args, sts)
|
||||
}
|
||||
|
||||
fn predicate_or(
|
||||
&mut self,
|
||||
args: &[&str],
|
||||
priv_args: &[&str],
|
||||
sts: &[StatementTmplBuilder],
|
||||
) -> Predicate {
|
||||
self.predicate(false, args, priv_args, sts)
|
||||
}
|
||||
|
||||
fn predicate(
|
||||
&mut self,
|
||||
conjunction: bool,
|
||||
args: &[&str],
|
||||
priv_args: &[&str],
|
||||
sts: &[StatementTmplBuilder],
|
||||
) -> Predicate {
|
||||
use BuilderArg as BA;
|
||||
let statements = sts
|
||||
.iter()
|
||||
.map(|sb| {
|
||||
let args = sb
|
||||
.args
|
||||
.iter()
|
||||
.map(|a| match a {
|
||||
BA::Literal(v) => StatementTmplArg::Literal(*v),
|
||||
BA::Key(pod_id, key) => StatementTmplArg::Key(
|
||||
resolve_wildcard(args, priv_args, pod_id),
|
||||
resolve_wildcard(args, priv_args, key),
|
||||
),
|
||||
})
|
||||
.collect();
|
||||
StatementTmpl(sb.predicate.clone(), args)
|
||||
})
|
||||
.collect();
|
||||
let custom_predicate = CustomPredicate {
|
||||
conjunction,
|
||||
statements,
|
||||
args_len: args.len(),
|
||||
};
|
||||
self.predicates.push(custom_predicate);
|
||||
Predicate::BatchSelf(self.predicates.len() - 1)
|
||||
}
|
||||
|
||||
fn finish(self) -> Arc<CustomPredicateBatch> {
|
||||
Arc::new(CustomPredicateBatch {
|
||||
predicates: self.predicates,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
fn resolve_wildcard(
|
||||
args: &[&str],
|
||||
priv_args: &[&str],
|
||||
v: &HashOrWildcardStr,
|
||||
) -> HashOrWildcard {
|
||||
match v {
|
||||
HashOrWildcardStr::Hash(h) => HashOrWildcard::Hash(*h),
|
||||
HashOrWildcardStr::Wildcard(s) => HashOrWildcard::Wildcard(
|
||||
args.iter()
|
||||
.chain(priv_args.iter())
|
||||
.enumerate()
|
||||
.find_map(|(i, name)| (&s == name).then_some(i))
|
||||
.unwrap(),
|
||||
),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_custom_pred() {
|
||||
use NativePredicate as NP;
|
||||
|
||||
let mut builder = CustomPredicateBatchBuilder::new();
|
||||
let _eth_friend = builder.predicate_and(
|
||||
&["src_or", "src_key", "dst_or", "dst_key"],
|
||||
&["attestation_pod"],
|
||||
&[
|
||||
st_tmpl(NP::ValueOf)
|
||||
.arg((w("attestation_pod"), l("type")))
|
||||
.arg(PodType::Signed),
|
||||
st_tmpl(NP::Equal)
|
||||
.arg((w("attestation_pod"), l("signer")))
|
||||
.arg((w("src_or"), w("src_key"))),
|
||||
st_tmpl(NP::Equal)
|
||||
.arg((w("attestation_pod"), l("attestation")))
|
||||
.arg((w("dst_or"), w("dst_key"))),
|
||||
],
|
||||
);
|
||||
|
||||
println!("a.0. eth_friend = {}", builder.predicates.last().unwrap());
|
||||
let eth_friend = builder.finish();
|
||||
// This batch only has 1 predicate, so we pick it already for convenience
|
||||
let eth_friend = Predicate::Custom(eth_friend, 0);
|
||||
|
||||
let mut builder = CustomPredicateBatchBuilder::new();
|
||||
let eth_dos_distance_base = builder.predicate_and(
|
||||
&[
|
||||
"src_or",
|
||||
"src_key",
|
||||
"dst_or",
|
||||
"dst_key",
|
||||
"distance_or",
|
||||
"distance_key",
|
||||
],
|
||||
&[],
|
||||
&[
|
||||
st_tmpl(NP::Equal)
|
||||
.arg((w("src_or"), l("src_key")))
|
||||
.arg((w("dst_or"), w("dst_key"))),
|
||||
st_tmpl(NP::ValueOf)
|
||||
.arg((w("distance_or"), w("distance_key")))
|
||||
.arg(0),
|
||||
],
|
||||
);
|
||||
|
||||
println!(
|
||||
"b.0. eth_dos_distance_base = {}",
|
||||
builder.predicates.last().unwrap()
|
||||
);
|
||||
|
||||
let eth_dos_distance = Predicate::BatchSelf(3);
|
||||
|
||||
let eth_dos_distance_ind = builder.predicate_and(
|
||||
&[
|
||||
"src_or",
|
||||
"src_key",
|
||||
"dst_or",
|
||||
"dst_key",
|
||||
"distance_or",
|
||||
"distance_key",
|
||||
],
|
||||
&[
|
||||
"one_or",
|
||||
"one_key",
|
||||
"shorter_distance_or",
|
||||
"shorter_distance_key",
|
||||
"intermed_or",
|
||||
"intermed_key",
|
||||
],
|
||||
&[
|
||||
st_tmpl(eth_dos_distance)
|
||||
.arg((w("src_or"), w("src_key")))
|
||||
.arg((w("intermed_or"), w("intermed_key")))
|
||||
.arg((w("shorter_distance_or"), w("shorter_distance_key"))),
|
||||
// distance == shorter_distance + 1
|
||||
st_tmpl(NP::ValueOf).arg((w("one_or"), w("one_key"))).arg(1),
|
||||
st_tmpl(NP::SumOf)
|
||||
.arg((w("distance_or"), w("distance_key")))
|
||||
.arg((w("shorter_distance_or"), w("shorter_distance_key")))
|
||||
.arg((w("one_or"), w("one_key"))),
|
||||
// intermed is a friend of dst
|
||||
st_tmpl(eth_friend)
|
||||
.arg((w("intermed_or"), w("intermed_key")))
|
||||
.arg((w("dst_or"), w("dst_key"))),
|
||||
],
|
||||
);
|
||||
|
||||
println!(
|
||||
"b.1. eth_dos_distance_ind = {}",
|
||||
builder.predicates.last().unwrap()
|
||||
);
|
||||
|
||||
let _eth_dos_distance = builder.predicate_or(
|
||||
&[
|
||||
"src_or",
|
||||
"src_key",
|
||||
"dst_or",
|
||||
"dst_key",
|
||||
"distance_or",
|
||||
"distance_key",
|
||||
],
|
||||
&[],
|
||||
&[
|
||||
st_tmpl(eth_dos_distance_base)
|
||||
.arg((w("src_or"), w("src_key")))
|
||||
.arg((w("dst_or"), w("dst_key")))
|
||||
.arg((w("distance_or"), w("distance_key"))),
|
||||
st_tmpl(eth_dos_distance_ind)
|
||||
.arg((w("src_or"), w("src_key")))
|
||||
.arg((w("dst_or"), w("dst_key")))
|
||||
.arg((w("distance_or"), w("distance_key"))),
|
||||
],
|
||||
);
|
||||
|
||||
println!(
|
||||
"b.2. eth_dos_distance = {}",
|
||||
builder.predicates.last().unwrap()
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue