Struct SafeTypeChip

pub struct SafeTypeChip<'a, F: ScalarField> { /* private fields */ }

Chip for SafeType

Implementations

impl<'a, F: ScalarField> SafeTypeChip<'a, F>

pub fn new(range_chip: &'a RangeChip<F>) -> Self

Construct a SafeTypeChip.

pub fn raw_bytes_to<const BYTES_PER_ELE: usize, const TOTAL_BITS: usize>( &self, ctx: &mut Context<F>, inputs: Vec<AssignedValue<F>>, ) -> SafeType<F, BYTES_PER_ELE, TOTAL_BITS>

Convert a vector of AssignedValue (treated as little-endian) to a SafeType. The number of bytes of inputs must equal to the number of bytes of outputs. This function also add contraints that a AssignedValue in inputs must be in the range of a byte.

pub fn unsafe_to_safe_type<const BYTES_PER_ELE: usize, const TOTAL_BITS: usize>( inputs: Vec<AssignedValue<F>>, ) -> SafeType<F, BYTES_PER_ELE, TOTAL_BITS>

Unsafe method that directly converts input to SafeType without any checks. This should only be used if an external library needs to convert their types to SafeType.

pub fn assert_bool( &self, ctx: &mut Context<F>, input: AssignedValue<F>, ) -> SafeBool<F>

Constrains that the input is a boolean value (either 0 or 1) and wraps it in SafeBool.

pub fn load_bool(&self, ctx: &mut Context<F>, input: bool) -> SafeBool<F>

Load a boolean value as witness and constrain it is either 0 or 1.

pub fn unsafe_to_bool(input: AssignedValue<F>) -> SafeBool<F>

Unsafe method that directly converts input to SafeBool without any checks. This should only be used if an external library needs to convert their types to SafeBool.

pub fn assert_byte( &self, ctx: &mut Context<F>, input: AssignedValue<F>, ) -> SafeByte<F>

Constrains that the input is a byte value and wraps it in SafeByte.

pub fn load_byte(&self, ctx: &mut Context<F>, input: u8) -> SafeByte<F>

Load a boolean value as witness and constrain it is either 0 or 1.

pub fn unsafe_to_byte(input: AssignedValue<F>) -> SafeByte<F>

Unsafe method that directly converts input to SafeByte without any checks. This should only be used if an external library needs to convert their types to SafeByte.

pub fn unsafe_to_var_len_bytes<const MAX_LEN: usize>( inputs: [AssignedValue<F>; MAX_LEN], len: AssignedValue<F>, ) -> VarLenBytes<F, MAX_LEN>

Unsafe method that directly converts inputs to VarLenBytes without any checks. This should only be used if an external library needs to convert their types to SafeByte.

pub fn unsafe_to_var_len_bytes_vec( inputs: Vec<AssignedValue<F>>, len: AssignedValue<F>, max_len: usize, ) -> VarLenBytesVec<F>

Unsafe method that directly converts inputs to VarLenBytesVec without any checks. This should only be used if an external library needs to convert their types to SafeByte.

pub fn unsafe_to_fix_len_bytes<const MAX_LEN: usize>( inputs: [AssignedValue<F>; MAX_LEN], ) -> FixLenBytes<F, MAX_LEN>

Unsafe method that directly converts inputs to FixLenBytes without any checks. This should only be used if an external library needs to convert their types to SafeByte.

pub fn unsafe_to_fix_len_bytes_vec( inputs: Vec<AssignedValue<F>>, len: usize, ) -> FixLenBytesVec<F>

Unsafe method that directly converts inputs to FixLenBytesVec without any checks. This should only be used if an external library needs to convert their types to SafeByte.

pub fn raw_to_var_len_bytes<const MAX_LEN: usize>( &self, ctx: &mut Context<F>, inputs: [AssignedValue<F>; MAX_LEN], len: AssignedValue<F>, ) -> VarLenBytes<F, MAX_LEN>

Converts a slice of AssignedValue(treated as little-endian) to VarLenBytes.

• inputs: Slice representing the byte array.
• len: AssignedValue<F> witness representing the variable length of the byte array. Constrained to be <= MAX_LEN.
• MAX_LEN: usize representing the maximum length of the byte array and the number of elements it must contain.

Assumptions

• MAX_LEN < u64::MAX to prevent overflow (but you should never make an array this large)
• ceil((MAX_LEN + 1).bits() / lookup_bits) * lookup_bits <= F::CAPACITY where lookup_bits = self.range_chip.lookup_bits

pub fn raw_to_var_len_bytes_vec( &self, ctx: &mut Context<F>, inputs: Vec<AssignedValue<F>>, len: AssignedValue<F>, max_len: usize, ) -> VarLenBytesVec<F>

Converts a vector of AssignedValue to VarLenBytesVec. Not encouraged to use because MAX_LEN cannot be verified at compile time.

• inputs: Vector representing the byte array, right padded to max_len. See VarLenBytesVec for details about padding.
• len: AssignedValue<F> witness representing the variable length of the byte array. Constrained to be <= max_len.
• max_len: usize representing the maximum length of the byte array and the number of elements it must contain. We enforce this to be provided explictly to make sure length of inputs is determinstic.

Assumptions

• max_len < u64::MAX to prevent overflow (but you should never make an array this large)
• ceil((max_len + 1).bits() / lookup_bits) * lookup_bits <= F::CAPACITY where lookup_bits = self.range_chip.lookup_bits

pub fn raw_to_fix_len_bytes<const LEN: usize>( &self, ctx: &mut Context<F>, inputs: [AssignedValue<F>; LEN], ) -> FixLenBytes<F, LEN>

Converts a slice of AssignedValue(treated as little-endian) to FixLenBytes.

• inputs: Slice representing the byte array.
• LEN: length of the byte array.

pub fn raw_to_fix_len_bytes_vec( &self, ctx: &mut Context<F>, inputs: Vec<AssignedValue<F>>, len: usize, ) -> FixLenBytesVec<F>

Converts a slice of AssignedValue(treated as little-endian) to FixLenBytesVec.

• inputs: Slice representing the byte array.
• len: length of the byte array. We enforce this to be provided explictly to make sure length of inputs is determinstic.