Add new precompile (#986)

* add blake2f precompile * add bn128 precompile * delete add conflict precompile * fix build --------- Co-authored-by: harry <[email protected]> Co-authored-by: shaorongqiang <[email protected]>
FindoraNetwork · Jul 10, 2023 · cef7f28 · cef7f28
1 parent 4a37d0a
commit cef7f28
Show file tree

Hide file tree

Showing 12 changed files with 624 additions and 10 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -15,6 +15,8 @@ members = [
     "src/components/contracts/modules/evm/precompile/modexp",
     "src/components/contracts/modules/evm/precompile/sha3fips",
     "src/components/contracts/modules/evm/precompile/anemoi",
+    "src/components/contracts/modules/evm/precompile/blake2",
+    "src/components/contracts/modules/evm/precompile/bn128",
     "src/components/contracts/modules/evm/precompile/utils",
     "src/components/contracts/modules/evm/precompile/utils/macro",
     "src/components/contracts/modules/xhub",

diff --git a/src/components/contracts/modules/evm/precompile/Cargo.toml b/src/components/contracts/modules/evm/precompile/Cargo.toml
@@ -16,6 +16,8 @@ evm-precompile-frc20 = {path = "./frc20"}
 evm-precompile-modexp = {path = "./modexp"}
 evm-precompile-sha3fips = {path = "./sha3fips"}
 evm-precompile-anemoi = {path = "./anemoi"}
+evm-precompile-blake2 = {path = "./blake2"}
+evm-precompile-bn128 = {path = "./bn128"}
 fp-core = {path = "../../../primitives/core"}
 module-evm = {path = "../../../modules/evm"}
 parking_lot = "0.12"
diff --git a/src/components/contracts/modules/evm/precompile/blake2/Cargo.toml b/src/components/contracts/modules/evm/precompile/blake2/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "evm-precompile-blake2"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+evm = { version = "0.35.0", default-features = false, features = ["with-serde"] }
+evm-precompile-utils = { path = "../utils"}
+tracing = "0.1"
+module-evm = { path = "../../../../modules/evm"}
+num_enum = { version = "0.5.4", default-features = false }
+
+[dev-dependencies]
+baseapp = { path = "../../../../baseapp" }
+fp-mocks = { path = "../../../../primitives/mocks" }
+ethereum-types = { version = "0.13.1", default-features = false }
+hex = "0.4"
+
diff --git a/src/components/contracts/modules/evm/precompile/blake2/src/eip_152.rs b/src/components/contracts/modules/evm/precompile/blake2/src/eip_152.rs
@@ -0,0 +1,92 @@
+// SPDX-License-Identifier: Apache-2.0
+// This file is part of Findora.
+//
+// Copyright (c) 2020-2022 Parity Technologies (UK) Ltd.
+//
+// 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.
+
+/// The precomputed values for BLAKE2b [from the spec](https://tools.ietf.org/html/rfc7693#section-2.7)
+/// There are 10 16-byte arrays - one for each round
+/// the entries are calculated from the sigma constants.
+const SIGMA: [[usize; 16]; 10] = [
+    [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
+    [14, 10, 4, 8, 9, 15, 13, 6, 1, 12, 0, 2, 11, 7, 5, 3],
+    [11, 8, 12, 0, 5, 2, 15, 13, 10, 14, 3, 6, 7, 1, 9, 4],
+    [7, 9, 3, 1, 13, 12, 11, 14, 2, 6, 5, 10, 4, 0, 15, 8],
+    [9, 0, 5, 7, 2, 4, 10, 15, 14, 1, 11, 12, 6, 8, 3, 13],
+    [2, 12, 6, 10, 0, 11, 8, 3, 4, 13, 7, 5, 15, 14, 1, 9],
+    [12, 5, 1, 15, 14, 13, 4, 10, 0, 7, 6, 3, 9, 2, 8, 11],
+    [13, 11, 7, 14, 12, 1, 3, 9, 5, 0, 15, 4, 8, 6, 2, 10],
+    [6, 15, 14, 9, 11, 3, 0, 8, 12, 2, 13, 7, 1, 4, 10, 5],
+    [10, 2, 8, 4, 7, 6, 1, 5, 15, 11, 9, 14, 3, 12, 13, 0],
+];
+
+/// IV is the initialization vector for BLAKE2b. See https://tools.ietf.org/html/rfc7693#section-2.6
+/// for details.
+const IV: [u64; 8] = [
+    0x6a09e667f3bcc908,
+    0xbb67ae8584caa73b,
+    0x3c6ef372fe94f82b,
+    0xa54ff53a5f1d36f1,
+    0x510e527fade682d1,
+    0x9b05688c2b3e6c1f,
+    0x1f83d9abfb41bd6b,
+    0x5be0cd19137e2179,
+];
+
+#[inline(always)]
+/// The G mixing function. See https://tools.ietf.org/html/rfc7693#section-3.1
+fn g(v: &mut [u64], a: usize, b: usize, c: usize, d: usize, x: u64, y: u64) {
+    v[a] = v[a].wrapping_add(v[b]).wrapping_add(x);
+    v[d] = (v[d] ^ v[a]).rotate_right(32);
+    v[c] = v[c].wrapping_add(v[d]);
+    v[b] = (v[b] ^ v[c]).rotate_right(24);
+    v[a] = v[a].wrapping_add(v[b]).wrapping_add(y);
+    v[d] = (v[d] ^ v[a]).rotate_right(16);
+    v[c] = v[c].wrapping_add(v[d]);
+    v[b] = (v[b] ^ v[c]).rotate_right(63);
+}
+
+/// The Blake2 compression function F. See https://tools.ietf.org/html/rfc7693#section-3.2
+/// Takes as an argument the state vector `h`, message block vector `m`, offset counter `t`, final
+/// block indicator flag `f`, and number of rounds `rounds`. The state vector provided as the first
+/// parameter is modified by the function.
+pub fn compress(h: &mut [u64; 8], m: [u64; 16], t: [u64; 2], f: bool, rounds: usize) {
+    let mut v = [0u64; 16];
+    v[..h.len()].copy_from_slice(h); // First half from state.
+    v[h.len()..].copy_from_slice(&IV); // Second half from IV.
+
+    v[12] ^= t[0];
+    v[13] ^= t[1];
+
+    if f {
+        v[14] = !v[14] // Invert all bits if the last-block-flag is set.
+    }
+    for i in 0..rounds {
+        // Message word selection permutation for this round.
+        let s = &SIGMA[i % 10];
+        g(&mut v, 0, 4, 8, 12, m[s[0]], m[s[1]]);
+        g(&mut v, 1, 5, 9, 13, m[s[2]], m[s[3]]);
+        g(&mut v, 2, 6, 10, 14, m[s[4]], m[s[5]]);
+        g(&mut v, 3, 7, 11, 15, m[s[6]], m[s[7]]);
+
+        g(&mut v, 0, 5, 10, 15, m[s[8]], m[s[9]]);
+        g(&mut v, 1, 6, 11, 12, m[s[10]], m[s[11]]);
+        g(&mut v, 2, 7, 8, 13, m[s[12]], m[s[13]]);
+        g(&mut v, 3, 4, 9, 14, m[s[14]], m[s[15]]);
+    }
+
+    for i in 0..8 {
+        h[i] ^= v[i] ^ v[i + 8];
+    }
+}
diff --git a/src/components/contracts/modules/evm/precompile/blake2/src/lib.rs b/src/components/contracts/modules/evm/precompile/blake2/src/lib.rs
@@ -0,0 +1,127 @@
+// SPDX-License-Identifier: Apache-2.0
+// This file is part of Findora.
+//
+// Copyright (c) 2020-2022 Parity Technologies (UK) Ltd.
+//
+// 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.
+
+mod eip_152;
+
+use evm::executor::stack::{PrecompileFailure, PrecompileOutput};
+use evm::{Context, ExitError, ExitSucceed};
+use module_evm::precompile::{FinState, Precompile, PrecompileId, PrecompileResult};
+
+pub struct Blake2F;
+
+impl PrecompileId for Blake2F {
+    fn contract_id() -> u64 {
+        0x09
+    }
+}
+
+impl Blake2F {
+    const GAS_COST_PER_ROUND: u64 = 1; // https://eips.ethereum.org/EIPS/eip-152#gas-costs-and-benchmarks
+}
+
+impl Precompile for Blake2F {
+    /// Format of `input`:
+    /// [4 bytes for rounds][64 bytes for h][128 bytes for m][8 bytes for t_0][8 bytes for t_1][1 byte for f]
+    fn execute(
+        input: &[u8],
+        target_gas: Option<u64>,
+        _context: &Context,
+        _state: &FinState,
+    ) -> PrecompileResult {
+        const BLAKE2_F_ARG_LEN: usize = 213;
+
+        if input.len() != BLAKE2_F_ARG_LEN {
+            return Err(PrecompileFailure::Error {
+                exit_status: ExitError::Other(
+                    "input length for Blake2 F precompile should be exactly 213 bytes"
+                        .into(),
+                ),
+            });
+        }
+
+        let mut rounds_buf: [u8; 4] = [0; 4];
+        rounds_buf.copy_from_slice(&input[0..4]);
+        let rounds: u32 = u32::from_be_bytes(rounds_buf);
+
+        let gas_cost: u64 = (rounds as u64) * Blake2F::GAS_COST_PER_ROUND;
+        if let Some(gas_left) = target_gas {
+            if gas_left < gas_cost {
+                return Err(PrecompileFailure::Error {
+                    exit_status: ExitError::OutOfGas,
+                });
+            }
+        }
+
+        // we use from_le_bytes below to effectively swap byte order to LE if architecture is BE
+
+        let mut h_buf: [u8; 64] = [0; 64];
+        h_buf.copy_from_slice(&input[4..68]);
+        let mut h = [0u64; 8];
+        let mut ctr = 0;
+        for state_word in &mut h {
+            let mut temp: [u8; 8] = Default::default();
+            temp.copy_from_slice(&h_buf[(ctr * 8)..(ctr + 1) * 8]);
+            *state_word = u64::from_le_bytes(temp);
+            ctr += 1;
+        }
+
+        let mut m_buf: [u8; 128] = [0; 128];
+        m_buf.copy_from_slice(&input[68..196]);
+        let mut m = [0u64; 16];
+        ctr = 0;
+        for msg_word in &mut m {
+            let mut temp: [u8; 8] = Default::default();
+            temp.copy_from_slice(&m_buf[(ctr * 8)..(ctr + 1) * 8]);
+            *msg_word = u64::from_le_bytes(temp);
+            ctr += 1;
+        }
+
+        let mut t_0_buf: [u8; 8] = [0; 8];
+        t_0_buf.copy_from_slice(&input[196..204]);
+        let t_0 = u64::from_le_bytes(t_0_buf);
+
+        let mut t_1_buf: [u8; 8] = [0; 8];
+        t_1_buf.copy_from_slice(&input[204..212]);
+        let t_1 = u64::from_le_bytes(t_1_buf);
+
+        let f = if input[212] == 1 {
+            true
+        } else if input[212] == 0 {
+            false
+        } else {
+            return Err(PrecompileFailure::Error {
+                exit_status: ExitError::Other(
+                    "incorrect final block indicator flag".into(),
+                ),
+            });
+        };
+
+        crate::eip_152::compress(&mut h, m, [t_0, t_1], f, rounds as usize);
+
+        let mut output_buf = [0u8; u64::BITS as usize];
+        for (i, state_word) in h.iter().enumerate() {
+            output_buf[i * 8..(i + 1) * 8].copy_from_slice(&state_word.to_le_bytes());
+        }
+
+        Ok(PrecompileOutput {
+            exit_status: ExitSucceed::Returned,
+            cost: gas_cost,
+            output: output_buf.to_vec(),
+            logs: Default::default(),
+        })
+    }
+}
diff --git a/src/components/contracts/modules/evm/precompile/bn128/Cargo.toml b/src/components/contracts/modules/evm/precompile/bn128/Cargo.toml
@@ -0,0 +1,21 @@
+[package]
+name = "evm-precompile-bn128"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+evm = { version = "0.35.0", default-features = false, features = ["with-serde"] }
+evm-precompile-utils = { path = "../utils"}
+tracing = "0.1"
+module-evm = { path = "../../../../modules/evm"}
+num_enum = { version = "0.5.4", default-features = false }
+fp-types = {path = "../../../../primitives/types"}
+bn = { package = "findora-bn", git = "https://github.com/FindoraNetwork/findora-bn.git", default-features = false }
+
+[dev-dependencies]
+baseapp = { path = "../../../../baseapp" }
+fp-mocks = { path = "../../../../primitives/mocks" }
+ethereum-types = { version = "0.13.1", default-features = false }
+hex = "0.4"