sp1-core-machine 6.0.0-beta.1

SP1 is a performant, 100% open-source, contributor-friendly zkVM.
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

use slop_air::AirBuilder;
use sp1_hypercube::{
    air::{AirInteraction, BaseAirBuilder, InteractionScope},
    InteractionKind,
};

use crate::program::instruction::InstructionCols;

/// A trait which contains methods related to program interactions in an AIR.
pub trait ProgramAirBuilder: BaseAirBuilder {
    /// Sends an instruction.
    fn send_program(
        &mut self,
        pc: [impl Into<Self::Expr>; 3],
        instruction: InstructionCols<impl Into<Self::Expr>>,
        multiplicity: impl Into<Self::Expr>,
    ) {
        let values = pc
            .map(Into::into)
            .into_iter()
            .chain(instruction.into_iter().map(|x| x.into()))
            .collect();
        self.send(
            AirInteraction::new(values, multiplicity.into(), InteractionKind::Program),
            InteractionScope::Local,
        );
    }

    /// Receives an instruction.
    fn receive_program(
        &mut self,
        pc: [impl Into<Self::Expr>; 3],
        instruction: InstructionCols<impl Into<Self::Expr>>,
        multiplicity: impl Into<Self::Expr>,
    ) {
        let values: Vec<<Self as AirBuilder>::Expr> = pc
            .map(Into::into)
            .into_iter()
            .chain(instruction.into_iter().map(|x| x.into()))
            .collect();
        self.receive(
            AirInteraction::new(values, multiplicity.into(), InteractionKind::Program),
            InteractionScope::Local,
        );
    }

    fn send_instruction_fetch(
        &mut self,
        pc: [impl Into<Self::Expr>; 3],
        instruction: InstructionCols<impl Into<Self::Expr>>,
        instruction_field_consts: [Self::Expr; 4],
        clk: [impl Into<Self::Expr>; 2],
        multiplicity: impl Into<Self::Expr>,
    ) {
        let values = pc
            .map(Into::into)
            .into_iter()
            .chain(instruction.into_iter().map(|x| x.into()))
            .chain(instruction_field_consts)
            .chain(clk.map(Into::into))
            .collect();

        self.send(
            AirInteraction::new(values, multiplicity.into(), InteractionKind::InstructionFetch),
            InteractionScope::Local,
        );
    }

    fn receive_instruction_fetch(
        &mut self,
        pc: [impl Into<Self::Expr>; 3],
        instruction: InstructionCols<impl Into<Self::Expr>>,
        instruction_field_consts: [Self::Expr; 4],
        clk: [impl Into<Self::Expr>; 2],
        multiplicity: impl Into<Self::Expr>,
    ) {
        let values: Vec<<Self as AirBuilder>::Expr> = pc
            .map(Into::into)
            .into_iter()
            .chain(instruction.into_iter().map(|x| x.into()))
            .chain(instruction_field_consts)
            .chain(clk.map(Into::into))
            .collect();

        self.receive(
            AirInteraction::new(values, multiplicity.into(), InteractionKind::InstructionFetch),
            InteractionScope::Local,
        );
    }

    fn send_instruction_decode(
        &mut self,
        word: [impl Into<Self::Expr>; 2],
        instruction: InstructionCols<impl Into<Self::Expr>>,
        instruction_field_consts: [Self::Expr; 4],
        multiplicity: impl Into<Self::Expr>,
    ) {
        let values = word
            .map(Into::into)
            .into_iter()
            .chain(instruction.into_iter().map(|x| x.into()))
            .chain(instruction_field_consts)
            .collect();

        self.send(
            AirInteraction::new(values, multiplicity.into(), InteractionKind::InstructionDecode),
            InteractionScope::Local,
        );
    }

    fn receive_instruction_decode(
        &mut self,
        word: [impl Into<Self::Expr>; 2],
        instruction: InstructionCols<impl Into<Self::Expr>>,
        instruction_field_consts: [Self::Expr; 4],
        multiplicity: impl Into<Self::Expr>,
    ) {
        let values = word
            .map(Into::into)
            .into_iter()
            .chain(instruction.into_iter().map(|x| x.into()))
            .chain(instruction_field_consts)
            .collect();
        self.receive(
            AirInteraction::new(values, multiplicity.into(), InteractionKind::InstructionDecode),
            InteractionScope::Local,
        );
    }
}