stoffel-vm 0.1.0

Register-based virtual machine runtime and MPC execution engine for Stoffel programs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

//! MPC Builtin Functions for StoffelVM
//!
//! This module provides object-oriented MPC operations as foreign functions.
//! It exposes secret sharing and RBC (Reliable Broadcast) primitives as
//! builtins.
//!
//! # API Pattern
//!
//! Functions use a module-prefixed pattern with object-as-first-argument:
//! ```text
//! let share = Share.from_clear(42)
//! let result = Share.multiply(share1, share2)
//! let value = Share.open(share)
//! ```
//!
//! # Share Object Structure
//!
//! Share objects are regular VM tables stored through the configured
//! [`stoffel_vm_types::core_types::TableMemory`] backend. Builtins use
//! semantic table reads so memory implementations such as Path-ORAM can update
//! access metadata during logical reads.
//!
//! Share tables use the following fields:
//! - `__type`: "Share"
//! - `__share_type`: "SecretInt" or "SecretFixedPoint"
//! - `__data`: Value::Share(ty, bytes) containing the raw share data
//! - `__party_id`: Party ID that created this share
//! - `__bit_length`: For SecretInt, the bit length
//! - `__precision_k`: For SecretFixedPoint, total bits
//! - `__precision_f`: For SecretFixedPoint, fractional bits

use crate::core_vm::VirtualMachine;
use crate::VirtualMachineResult;

mod avss;
mod bytes;
mod consensus;
mod crypto;
mod field;
mod info;
mod share;

pub use crate::mpc_values::{avss_fields, avss_object};
pub use crate::mpc_values::{
    rbc_fields, share_fields, share_object, MpcValueError, MpcValueResult,
};

const MPC_BUILTIN_FUNCTIONS: &[&str] = &[
    "Share.from_clear",
    "Share.from_clear_int",
    "Share.from_clear_uint",
    "Share.from_clear_fixed",
    "Share.add",
    "Share.sub",
    "Share.neg",
    "Share.add_scalar",
    "Share.mul_scalar",
    "Share.mul",
    "Share.open",
    "Share.batch_open",
    "Share.send_to_client",
    "Share.interpolate_local",
    "Share.get_type",
    "Share.get_party_id",
    "Share.open_exp",
    "Share.random",
    "Share.random_field",
    "Share.random_int",
    "Share.get_commitment",
    "Share.commitment_count",
    "Share.has_commitments",
    "Share.mul_field",
    "Share.add_field",
    "Share.retag",
    "Share.open_field",
    "Share.open_exp_custom",
    "Bytes.concat",
    "Bytes.from_string",
    "Crypto.sha256",
    "Crypto.sha512",
    "Crypto.hash_to_field",
    "Crypto.field_inv",
    "Crypto.point_x_to_field",
    "Crypto.field_to_scalar_bytes",
    "Crypto.point_to_sec1",
    "Crypto.hash_to_g1",
    "Field.from_int",
    "Field.zero",
    "Field.one",
    "Field.is_zero",
    "Field.eq",
    "Field.add",
    "Field.sub",
    "Field.mul",
    "Field.neg",
    "Field.inverse",
    "Field.sqrt",
    "Mpc.party_id",
    "Mpc.n_parties",
    "Mpc.threshold",
    "Mpc.is_ready",
    "Mpc.instance_id",
    "Mpc.protocol_name",
    "Mpc.curve",
    "Mpc.field",
    "Mpc.has_capability",
    "Mpc.capabilities",
    "Mpc.rand",
    "Mpc.rand_int",
    "Rbc.broadcast",
    "Rbc.receive",
    "Rbc.receive_any",
];

const AVSS_BUILTIN_FUNCTIONS: &[&str] = &[
    "Avss.get_commitment",
    "Avss.get_key_name",
    "Avss.commitment_count",
    "Avss.is_avss_share",
];

/// Try to register all MPC builtin functions with the VM.
pub fn try_register_mpc_builtins(vm: &mut VirtualMachine) -> VirtualMachineResult<()> {
    vm.ensure_function_names_available(MPC_BUILTIN_FUNCTIONS, "MPC builtins")?;
    vm.ensure_function_names_available(AVSS_BUILTIN_FUNCTIONS, "AVSS builtins")?;
    register_mpc_builtins_unchecked(vm)
}

/// Register all MPC builtin functions with the VM
#[track_caller]
pub fn register_mpc_builtins(vm: &mut VirtualMachine) {
    try_register_mpc_builtins(vm).expect("invalid MPC builtin registration");
}

fn register_mpc_builtins_unchecked(vm: &mut VirtualMachine) -> VirtualMachineResult<()> {
    share::register(vm)?;
    info::register(vm)?;
    consensus::register_rbc(vm)?;
    crypto::register(vm)?;
    field::register(vm)?;
    bytes::register(vm)?;
    avss::register(vm)?;
    Ok(())
}

#[cfg(test)]
mod tests;