rgb-consensus 0.11.1-rc.11

RGB Consensus Library: confidential & scalable smart contracts on Bitcoin & Lightning (consensus layer)
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

// RGB Consensus Library: consensus layer for RGB smart contracts.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2019-2024 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2019-2024 LNP/BP Standards Association. All rights reserved.
// Copyright (C) 2019-2024 Dr Maxim Orlovsky. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::collections::BTreeSet;
use std::ops::RangeInclusive;

use aluvm::isa;
use aluvm::isa::{Bytecode, BytecodeError, ExecStep, InstructionSet};
use aluvm::library::{CodeEofError, IsaSeg, LibSite, Read, Write};
use aluvm::reg::{CoreRegs, Reg};

use super::opcodes::{INSTR_RGBISA_FROM, INSTR_RGBISA_TO};
use super::{ContractOp, ContractStateAccess, VmContext};

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
#[display(inner)]
#[non_exhaustive]
pub enum RgbIsa<S: ContractStateAccess> {
    Contract(ContractOp<S>),

    /// All other future unsupported operations, which must set `st0` to
    /// `false`.
    Fail(u8),
}

impl<S: ContractStateAccess> InstructionSet for RgbIsa<S> {
    type Context<'ctx> = VmContext<'ctx, S>;

    fn isa_ids() -> IsaSeg { IsaSeg::with("RGB") }

    fn src_regs(&self) -> BTreeSet<Reg> {
        match self {
            RgbIsa::Contract(op) => op.src_regs(),
            RgbIsa::Fail(_) => bset![],
        }
    }

    fn dst_regs(&self) -> BTreeSet<Reg> {
        match self {
            RgbIsa::Contract(op) => op.dst_regs(),
            RgbIsa::Fail(_) => bset![],
        }
    }

    fn complexity(&self) -> u64 {
        match self {
            RgbIsa::Contract(op) => op.complexity(),
            RgbIsa::Fail(_) => u64::MAX,
        }
    }

    fn exec(&self, regs: &mut CoreRegs, site: LibSite, context: &Self::Context<'_>) -> ExecStep {
        match self {
            RgbIsa::Contract(op) => op.exec(regs, site, context),
            RgbIsa::Fail(_) => isa::ControlFlowOp::Fail.exec(regs, site, &()),
        }
    }
}

impl<S: ContractStateAccess> Bytecode for RgbIsa<S> {
    fn instr_range() -> RangeInclusive<u8> { INSTR_RGBISA_FROM..=INSTR_RGBISA_TO }

    fn instr_byte(&self) -> u8 {
        match self {
            RgbIsa::Contract(op) => op.instr_byte(),
            RgbIsa::Fail(code) => *code,
        }
    }

    fn encode_args<W>(&self, writer: &mut W) -> Result<(), BytecodeError>
    where W: Write {
        match self {
            RgbIsa::Contract(op) => op.encode_args(writer),
            RgbIsa::Fail(_) => Ok(()),
        }
    }

    fn decode<R>(reader: &mut R) -> Result<Self, CodeEofError>
    where
        Self: Sized,
        R: Read,
    {
        let instr = reader.peek_u8()?;
        Ok(match instr {
            instr if ContractOp::<S>::instr_range().contains(&instr) => {
                RgbIsa::Contract(ContractOp::decode(reader)?)
            }
            x => RgbIsa::Fail(x),
        })
    }
}