Merge pull request #53 from pragma-org/cip-153-value-type

Implements Value builtins and Value type

Author: jonathanlim222

crates/uplc/src/builtin/default_function.rs

@@ -123,6 +123,15 @@ pub enum DefaultFunction {
     // BLS Multi-Scalar Multiplication
     Bls12_381_G1_MultiScalarMul = 92,
     Bls12_381_G2_MultiScalarMul = 93,
+
+    // Value builtins
+    InsertCoin = 94,
+    LookupCoin = 95,
+    UnionValue = 96,
+    ValueContains = 97,
+    ValueData = 98,
+    UnValueData = 99,
+    ScaleValue = 100,
 }
 
 impl DefaultFunction {
@@ -222,6 +231,13 @@ impl DefaultFunction {
             DefaultFunction::IndexArray => 1,
             DefaultFunction::Bls12_381_G1_MultiScalarMul => 0,
             DefaultFunction::Bls12_381_G2_MultiScalarMul => 0,
+            DefaultFunction::InsertCoin => 0,
+            DefaultFunction::LookupCoin => 0,
+            DefaultFunction::UnionValue => 0,
+            DefaultFunction::ValueContains => 0,
+            DefaultFunction::ValueData => 0,
+            DefaultFunction::UnValueData => 0,
+            DefaultFunction::ScaleValue => 0,
         }
     }
 
@@ -321,6 +337,13 @@ impl DefaultFunction {
             DefaultFunction::IndexArray => 2,
             DefaultFunction::Bls12_381_G1_MultiScalarMul => 2,
             DefaultFunction::Bls12_381_G2_MultiScalarMul => 2,
+            DefaultFunction::InsertCoin => 4,
+            DefaultFunction::LookupCoin => 3,
+            DefaultFunction::UnionValue => 2,
+            DefaultFunction::ValueContains => 2,
+            DefaultFunction::ValueData => 1,
+            DefaultFunction::UnValueData => 1,
+            DefaultFunction::ScaleValue => 2,
         }
     }
 
@@ -441,30 +464,17 @@ impl DefaultFunction {
                 | Ripemd_160
         );
 
-        // batch6: van Rossem (PV 11) — ExpModInteger, DropList, LengthOfArray, ListToArray,
-        // IndexArray, BLS MSM, and Value builtins (once added).
-        let batch6 = matches!(
-            self,
-            ExpModInteger
-                | DropList
-                | LengthOfArray
-                | ListToArray
-                | IndexArray
-                | Bls12_381_G1_MultiScalarMul
-                | Bls12_381_G2_MultiScalarMul
-        );
-
         match plutus_version {
             PlutusVersion::V1 => {
                 if pv >= 11 {
-                    batch1 || batch2 || batch3 || batch4a || batch4b || batch5 || batch6
+                    true
                 } else {
                     batch1
                 }
             }
             PlutusVersion::V2 => {
                 if pv >= 11 {
-                    batch1 || batch2 || batch3 || batch4a || batch4b || batch5 || batch6
+                    true
                 } else if pv >= 10 {
                     batch1 || batch2 || batch3 || batch4b
                 } else if pv >= 8 {
@@ -476,7 +486,7 @@ impl DefaultFunction {
             }
             PlutusVersion::V3 => {
                 if pv >= 11 {
-                    batch1 || batch2 || batch3 || batch4a || batch4b || batch5 || batch6
+                    true
                 } else if pv >= 10 {
                     batch1 || batch2 || batch3 || batch4a || batch4b || batch5
                 } else {

crates/uplc/src/constant.rs

@@ -1,4 +1,7 @@
-use crate::{arena::Arena, binder::Eval, data::PlutusData, machine::MachineError, typ::Type};
+use crate::{
+    arena::Arena, binder::Eval, data::PlutusData, ledger_value::LedgerValue, machine::MachineError,
+    typ::Type,
+};
 
 #[derive(Debug, PartialEq)]
 pub enum Constant<'a> {
@@ -19,6 +22,7 @@ pub enum Constant<'a> {
     Bls12_381G1Element(&'a blst::blst_p1),
     Bls12_381G2Element(&'a blst::blst_p2),
     Bls12_381MlResult(&'a blst::blst_fp12),
+    Value(&'a LedgerValue<'a>),
 }
 
 pub type Integer = num::BigInt;
@@ -103,6 +107,10 @@ impl<'a> Constant<'a> {
         arena.alloc(Constant::Bls12_381MlResult(ml_res))
     }
 
+    pub fn ledger_value(arena: &'a Arena, v: &'a LedgerValue<'a>) -> &'a Constant<'a> {
+        arena.alloc(Constant::Value(v))
+    }
+
     pub fn unwrap_data<V>(&'a self) -> Result<&'a PlutusData<'a>, MachineError<'a, V>>
     where
         V: Eval<'a>,
@@ -127,6 +135,7 @@ impl<'a> Constant<'a> {
             Constant::Bls12_381G1Element(_) => Type::g1(arena),
             Constant::Bls12_381G2Element(_) => Type::g2(arena),
             Constant::Bls12_381MlResult(_) => Type::ml_result(arena),
+            Constant::Value(_) => Type::value(arena),
         }
     }
 }

crates/uplc/src/data.rs

@@ -54,7 +54,15 @@ impl<'a> PlutusData<'a> {
         arena: &'a Arena,
         cbor: &'_ [u8],
     ) -> Result<&'a PlutusData<'a>, minicbor::decode::Error> {
-        minicbor::decode_with(cbor, &mut Ctx { arena })
+        minicbor::decode_with(
+            cbor,
+            &mut Ctx {
+                arena,
+                version: None,
+                plutus_version: None,
+                protocol_version: None,
+            },
+        )
     }
 
     pub fn unwrap_constr<V>(

crates/uplc/src/flat/builtin.rs

@@ -238,6 +238,19 @@ pub fn try_from_tag(arena: &Arena, v: u8) -> Result<&DefaultFunction, FlatDecode
             Ok(arena.alloc(DefaultFunction::Bls12_381_G2_MultiScalarMul))
         }
 
+        // Value builtins
+        v if v == DefaultFunction::InsertCoin as u8 => Ok(arena.alloc(DefaultFunction::InsertCoin)),
+        v if v == DefaultFunction::LookupCoin as u8 => Ok(arena.alloc(DefaultFunction::LookupCoin)),
+        v if v == DefaultFunction::UnionValue as u8 => Ok(arena.alloc(DefaultFunction::UnionValue)),
+        v if v == DefaultFunction::ValueContains as u8 => {
+            Ok(arena.alloc(DefaultFunction::ValueContains))
+        }
+        v if v == DefaultFunction::ValueData as u8 => Ok(arena.alloc(DefaultFunction::ValueData)),
+        v if v == DefaultFunction::UnValueData as u8 => {
+            Ok(arena.alloc(DefaultFunction::UnValueData))
+        }
+        v if v == DefaultFunction::ScaleValue as u8 => Ok(arena.alloc(DefaultFunction::ScaleValue)),
+
         _ => Err(FlatDecodeError::DefaultFunctionNotFound(v)),
     }
 }

crates/uplc/src/flat/decode/decoder.rs

@@ -1,6 +1,9 @@
 use bumpalo::collections::{String as BumpString, Vec as BumpVec};
 
-use crate::{arena::Arena, constant::Integer, flat::zigzag::ZigZag};
+use crate::{
+    arena::Arena, builtin::DefaultFunction, constant::Integer, flat::zigzag::ZigZag,
+    machine::PlutusVersion, program::Version,
+};
 
 use super::FlatDecodeError;
 
@@ -12,6 +15,28 @@ pub struct Decoder<'b> {
 
 pub struct Ctx<'a> {
     pub arena: &'a Arena,
+    pub version: Option<&'a Version<'a>>,
+    pub plutus_version: Option<PlutusVersion>,
+    pub protocol_version: Option<u32>,
+}
+
+impl<'a> Ctx<'a> {
+    /// Returns true if gating is active and the program version is pre-1.1.0.
+    pub fn program_is_pre_1_1_0(&self) -> bool {
+        match self.version {
+            Some(v) => v.is_less_than_1_1_0(),
+            None => false,
+        }
+    }
+
+    /// Returns true if the given builtin is NOT available under the current
+    /// plutus_version / protocol_version combination.
+    pub fn is_builtin_gated(&self, func: &DefaultFunction) -> bool {
+        match (self.plutus_version, self.protocol_version) {
+            (Some(pv), Some(proto)) => !func.is_available_in(pv, proto),
+            _ => false,
+        }
+    }
 }
 
 impl<'b> Decoder<'b> {

crates/uplc/src/flat/decode/error.rs

@@ -36,4 +36,6 @@ pub enum FlatDecodeError {
     TrailingBytes(usize),
     #[error("Builtin function {1} (tag {0}) is not available in the given language version")]
     BuiltinNotAvailable(u8, String),
+    #[error("Constant type {1} (tag {0}) is not available before UPLC version 1.1.0")]
+    ConstantTypeNotAvailable(u8, &'static str),
 }