Add BorshSchema implementation for hash types and enable ABI generation (#945)

r-near · karim-en · web-flow · commit 15926dd82074 · 2025-05-06T13:51:04.000+01:00
* Add BorshSchema implementation for hash types and enable ABI generation

* Change to `reproducible-wasm`

---------

Co-authored-by: karim-en &lt;karim.alabtakh@nearone.org&gt;
diff --git a/contracts/near/Cargo.lock b/contracts/near/Cargo.lock
diff --git a/contracts/near/Cargo.toml b/contracts/near/Cargo.toml
@@ -20,7 +20,7 @@ overflow-checks = true
 
 [workspace.dependencies]
 near-sdk = { version = "5.12", features = ["legacy", "unit-testing"] }
-borsh = "1"
+borsh = { version = "1.5.7", features = ["unstable__schema"] }
 rlp = "0.5.2"
 rlp-derive = "0.1.0"
 ethereum-types = "0.14.1"
diff --git a/contracts/near/Makefile b/contracts/near/Makefile
@@ -3,7 +3,7 @@ MAKEFILE_DIR :=  $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 MANIFEST := $(MAKEFILE_DIR)/Cargo.toml
 
 build-eth2-client:
-	cargo near build non-reproducible-wasm --manifest-path $(MAKEFILE_DIR)/eth2-client/Cargo.toml --out-dir $(MAKEFILE_DIR)/res --no-abi
+	cargo near build reproducible-wasm --manifest-path $(MAKEFILE_DIR)/eth2-client/Cargo.toml --out-dir $(MAKEFILE_DIR)/res
 
 build-prover:
 	cargo near build non-reproducible-wasm --manifest-path $(MAKEFILE_DIR)/eth-prover/Cargo.toml --out-dir $(MAKEFILE_DIR)/res --no-abi
diff --git a/contracts/near/eth-types/src/eth2.rs b/contracts/near/eth-types/src/eth2.rs
@@ -18,18 +18,20 @@ pub type Epoch = u64;
 pub type ForkVersion = [u8; 4];
 pub type DomainType = [u8; 4];
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, BorshSchema)]
 pub struct PublicKeyBytes(pub [u8; PUBLIC_KEY_BYTES_LEN]);
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, BorshSchema)]
 pub struct SignatureBytes(pub [u8; SIGNATURE_BYTES_LEN]);
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, BorshSchema)]
 pub struct SyncCommitteeBits(pub [u8; SYNC_COMMITTEE_BITS_SIZE_IN_BYTES]);
 
 arr_wrapper_impl_tree_hash_and_borsh!(PublicKeyBytes, PUBLIC_KEY_BYTES_LEN);
 arr_wrapper_impl_tree_hash_and_borsh!(SignatureBytes, SIGNATURE_BYTES_LEN);
 arr_wrapper_impl_tree_hash_and_borsh!(SyncCommitteeBits, SYNC_COMMITTEE_BITS_SIZE_IN_BYTES);
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize, tree_hash_derive::TreeHash)]
+#[derive(
+    Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize, tree_hash_derive::TreeHash,
+)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct BeaconBlockHeader {
     #[cfg_attr(not(target_arch = "wasm32"), serde(with = "serde_utils::quoted_u64"))]
@@ -53,7 +55,7 @@ pub struct SigningData {
     pub domain: H256,
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct ExtendedBeaconBlockHeader {
     pub header: BeaconBlockHeader,
@@ -72,48 +74,50 @@ impl From<HeaderUpdate> for ExtendedBeaconBlockHeader {
     }
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct SyncCommitteePublicKeys(pub Vec<PublicKeyBytes>);
 vec_wrapper_impl_tree_hash!(SyncCommitteePublicKeys);
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize, tree_hash_derive::TreeHash)]
+#[derive(
+    Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize, tree_hash_derive::TreeHash,
+)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct SyncCommittee {
     pub pubkeys: SyncCommitteePublicKeys,
     pub aggregate_pubkey: PublicKeyBytes,
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct SyncAggregate {
     pub sync_committee_bits: SyncCommitteeBits,
     pub sync_committee_signature: SignatureBytes,
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct SyncCommitteeUpdate {
     pub next_sync_committee: SyncCommittee,
     pub next_sync_committee_branch: Vec<H256>,
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct HeaderUpdate {
     pub beacon_header: BeaconBlockHeader,
     pub execution_block_hash: H256,
     pub execution_hash_branch: Vec<H256>,
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct FinalizedHeaderUpdate {
     pub header_update: HeaderUpdate,
     pub finality_branch: Vec<H256>,
 }
 
-#[derive(Debug, Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Debug, Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct LightClientUpdate {
     pub attested_beacon_header: BeaconBlockHeader,
@@ -124,7 +128,7 @@ pub struct LightClientUpdate {
     pub sync_committee_update: Option<SyncCommitteeUpdate>,
 }
 
-#[derive(Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Clone, BorshDeserialize, BorshSchema, BorshSerialize)]
 pub struct LightClientState {
     pub finalized_beacon_header: ExtendedBeaconBlockHeader,
     pub current_sync_committee: SyncCommittee,
diff --git a/contracts/near/eth-types/src/lib.rs b/contracts/near/eth-types/src/lib.rs
@@ -1,5 +1,5 @@
 use borsh::io::Read;
-use borsh::{BorshDeserialize, BorshSerialize};
+use borsh::{BorshDeserialize, BorshSchema, BorshSerialize};
 use derive_more::{
     Add, AddAssign, Display, Div, DivAssign, From, Into, Mul, MulAssign, Rem, RemAssign, Sub,
     SubAssign,
@@ -78,6 +78,27 @@ macro_rules! uint_declare_wrapper_and_serde {
         #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
         pub struct $name(pub ethereum_types::$name);
 
+        // For uint types (U64, U128, U256)
+        impl borsh::BorshSchema for $name {
+            fn declaration() -> String {
+                stringify!($name).to_string()
+            }
+
+            fn add_definitions_recursively(
+                definitions: &mut std::collections::BTreeMap<String, borsh::schema::Definition>,
+            ) {
+                // Define as a sequence of u64 values
+                let definition = borsh::schema::Definition::Sequence {
+                    length_width: borsh::schema::Definition::ARRAY_LENGTH_WIDTH, // 0 for fixed-size
+                    length_range: $len as u64..=$len as u64,                     // Fixed length
+                    elements: u64::declaration(),
+                };
+
+                borsh::schema::add_definition(Self::declaration(), definition, definitions);
+                u64::add_definitions_recursively(definitions);
+            }
+        }
+
         impl BorshSerialize for $name {
             #[inline]
             fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error> {
@@ -124,7 +145,7 @@ pub type Signature = H520;
 
 // Block Header
 
-#[derive(Debug, Clone, BorshSerialize, BorshDeserialize)]
+#[derive(Debug, Clone, BorshSerialize, BorshDeserialize, BorshSchema)]
 #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
 pub struct BlockHeader {
     pub parent_hash: H256,
diff --git a/contracts/near/eth-types/src/macros.rs b/contracts/near/eth-types/src/macros.rs
@@ -127,6 +127,27 @@ macro_rules! arr_ethereum_types_wrapper_impl_borsh_serde_ssz {
         #[cfg_attr(not(target_arch = "wasm32"), derive(Serialize, Deserialize))]
         pub struct $name(pub ethereum_types::$name);
 
+        // For hash types (H64, H128, H160, etc.)
+        impl borsh::BorshSchema for $name {
+            fn declaration() -> String {
+                stringify!($name).to_string()
+            }
+
+            fn add_definitions_recursively(
+                definitions: &mut std::collections::BTreeMap<String, borsh::schema::Definition>,
+            ) {
+                // Define as a fixed-length byte array
+                let definition = borsh::schema::Definition::Sequence {
+                    length_width: borsh::schema::Definition::ARRAY_LENGTH_WIDTH, // 0 for fixed-size arrays
+                    length_range: $len as u64..=$len as u64,                     // Fixed length
+                    elements: u8::declaration(),
+                };
+
+                borsh::schema::add_definition(Self::declaration(), definition, definitions);
+                u8::add_definitions_recursively(definitions);
+            }
+        }
+
         impl From<&[u8; $len]> for $name {
             fn from(item: &[u8; $len]) -> Self {
                 $name(item.into())
diff --git a/contracts/near/eth2-client/Cargo.toml b/contracts/near/eth2-client/Cargo.toml
@@ -35,6 +35,8 @@ near-sdk.workspace = true
 borsh.workspace = true
 bitvec.workspace = true
 near-plugins.workspace = true
+near-abi = "0.4.3"
+schemars = "0.8.22"
 
 [dev-dependencies]
 ethereum_serde_utils.workspace = true
diff --git a/contracts/near/eth2-utility/src/consensus.rs b/contracts/near/eth2-utility/src/consensus.rs
@@ -2,7 +2,7 @@ use std::str::FromStr;
 
 use bitvec::order::Lsb0;
 use bitvec::prelude::BitVec;
-use borsh::{BorshDeserialize, BorshSerialize};
+use borsh::{BorshDeserialize, BorshSchema, BorshSerialize};
 use eth_types::eth2::*;
 use eth_types::H256;
 use tree_hash::TreeHash;
@@ -28,7 +28,7 @@ pub struct GeneralizedIndex {
     pub sync_committee_tree_index: u32,
 }
 
-#[derive(PartialEq, BorshSerialize, BorshDeserialize)]
+#[derive(PartialEq, BorshSerialize, BorshDeserialize, BorshSchema)]
 pub enum Network {
     Mainnet,
     Goerli,
diff --git a/contracts/near/eth2-utility/src/types.rs b/contracts/near/eth2-utility/src/types.rs
@@ -1,17 +1,20 @@
-use borsh::{BorshDeserialize, BorshSerialize};
+use borsh::{BorshDeserialize, BorshSchema, BorshSerialize};
 use eth_types::eth2::*;
 use eth_types::H256;
+use near_sdk::near;
 use near_sdk::AccountId;
 
 /// Minimal information about a header.
-#[derive(Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Clone)]
+#[near(serializers=[borsh])]
 pub struct ExecutionHeaderInfo {
     pub parent_hash: H256,
     pub block_number: u64,
     pub submitter: AccountId,
 }
 
-#[derive(Clone, BorshDeserialize, BorshSerialize)]
+#[derive(Clone)]
+#[near(serializers=[borsh])]
 pub struct InitInput {
     pub network: String,
     pub finalized_execution_header: eth_types::BlockHeader,
@@ -24,7 +27,7 @@ pub struct InitInput {
     pub trusted_signer: Option<AccountId>,
 }
 
-#[derive(Clone, BorshDeserialize, BorshSerialize, PartialEq)]
+#[derive(Clone, BorshDeserialize, BorshSerialize, PartialEq, BorshSchema)]
 pub enum ClientMode {
     SubmitLightClientUpdate,
     SubmitHeader,
diff --git a/eth2near/Cargo.lock b/eth2near/Cargo.lock
diff --git a/eth2near/Cargo.toml b/eth2near/Cargo.toml
@@ -26,7 +26,7 @@ near-primitives = "0.29.1"
 near-chain-configs = "0.29.1"
 near-jsonrpc-primitives = "0.29.1"
 near-sdk = "5.12"
-borsh = "1"
+borsh = { version = "1.5.7", features = ["unstable__schema"] }
 
 [patch]
 [patch.crates-io]
