fault_proving(storage_traits): refactor to allow usage of arbitrary TableColumn (#2793)

## Linked Issues/PRs
<!-- List of related issues/PRs -->
- part of #2775

## Description
<!-- List of detailed changes -->
- instead of tying `MerkleizedTableColumn` to the `TableColumn` variant
only in use by the global state root service, this refactors the trait
to accept an arbitrary `TableColumn` that is returned when
`table_column` is called.

we've copied all the common functionality required by both destinations
(`fuel-core-global-merkle-root-storage` and
`fuel-core-compression-service`), you may see that we haven't deleted
the implementations from the `fuel-core-global-merkle-root-storage`
crate yet, because that crate doesn't use newtypes and we have an orphan
rule error. will be addressed in follow up. For the person implementing
the follow up, you can remove -

- `fuel-core-global-merkle-root/src/merkle.rs`
- `fuel-core-global-merkle-root/src/merkle/smt.rs`

and reuse the traits & types from `fuel-core-storage` instead

## Checklist
- [x] Breaking changes are clearly marked as such in the PR description
and changelog
- [x] New behavior is reflected in tests
- [x] [The specification](https://github.com/FuelLabs/fuel-specs/)
matches the implemented behavior (link update PR if changes are needed)

### Before requesting review
- [x] I have reviewed the code myself
- [x] I have created follow-up issues caused by this PR and linked them
here

### After merging, notify other teams

[Add or remove entries as needed]

- [ ] [Rust SDK](https://github.com/FuelLabs/fuels-rs/)
- [ ] [Sway compiler](https://github.com/FuelLabs/sway/)
- [ ] [Platform
documentation](https://github.com/FuelLabs/devrel-requests/issues/new?assignees=&labels=new+request&projects=&template=NEW-REQUEST.yml&title=%5BRequest%5D%3A+)
(for out-of-organization contributors, the person merging the PR will do
this)
- [ ] Someone else?

Author: rymnc

.changes/changed/2793.md

@@ -0,0 +1 @@
+Moved common merkle storage trait implementations to `fuel-core-storage` and made it easier to setup a set of columns that need merkleization.

crates/proof_system/global_merkle_root/service/src/ports.rs

@@ -1,8 +1,9 @@
 use std::future::Future;
 
-use fuel_core_global_merkle_root_storage::column::Column;
+use fuel_core_global_merkle_root_storage::column::TableColumn;
 use fuel_core_storage::{
     kv_store::KeyValueInspect,
+    merkle::column::MerkleizedColumn,
     transactional::Modifiable,
 };
 use fuel_core_types::blockchain::block::Block;
@@ -17,6 +18,12 @@ pub trait BlockStream {
 }
 
 /// The storage requirements for the merkle root service
-pub trait ServiceStorage: KeyValueInspect<Column = Column> + Modifiable {}
+pub trait ServiceStorage:
+    KeyValueInspect<Column = MerkleizedColumn<TableColumn>> + Modifiable
+{
+}
 
-impl<T> ServiceStorage for T where T: KeyValueInspect<Column = Column> + Modifiable {}
+impl<T> ServiceStorage for T where
+    T: KeyValueInspect<Column = MerkleizedColumn<TableColumn>> + Modifiable
+{
+}

crates/proof_system/global_merkle_root/storage/src/column.rs

@@ -1,12 +1,3 @@
-use alloc::{
-    format,
-    string::{
-        String,
-        ToString,
-    },
-};
-use fuel_core_storage::kv_store::StorageColumn;
-
 /// Almost in the case of all tables we need to prove exclusion of entries,
 /// in the case of malicious block.
 #[repr(u32)]
@@ -47,62 +38,11 @@ pub enum TableColumn {
 
 impl TableColumn {
     /// The total count of variants in the enum.
-    const COUNT: usize = <Self as strum::EnumCount>::COUNT;
-
-    /// Returns the `usize` representation of the `Column`.
-    pub fn as_u32(&self) -> u32 {
-        *self as u32
-    }
-}
-
-/// Almost in the case of all tables we need to prove exclusion of entries,
-/// in the case of malicious block.
-#[repr(u32)]
-#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
-pub enum Column {
-    /// The column with the specific data.
-    TableColumn(TableColumn),
-    /// The column with the merkle tree nodes.
-    MerkleDataColumn(TableColumn),
-    /// The merkle metadata column.
-    MerkleMetadataColumn,
-}
-
-impl Column {
-    /// The total count of variants in the enum.
-    pub const COUNT: usize = TableColumn::COUNT + TableColumn::COUNT + 1;
-
-    /// The start of the merkle data columns.
-    pub const MERKLE_DATA_COLUMNS_START: u32 = u16::MAX as u32;
-
-    /// Returns the `usize` representation of the `Column`.
-    pub fn as_u32(&self) -> u32 {
-        match self {
-            Self::TableColumn(column) => column.as_u32(),
-            Self::MerkleDataColumn(column) => {
-                Self::MERKLE_DATA_COLUMNS_START.wrapping_add(column.as_u32())
-            }
-            Self::MerkleMetadataColumn => u32::MAX,
-        }
-    }
+    pub const COUNT: usize = <Self as strum::EnumCount>::COUNT;
 }
 
-impl StorageColumn for Column {
-    fn name(&self) -> String {
-        match self {
-            Self::TableColumn(column) => {
-                let str: &str = column.into();
-                str.to_string()
-            }
-            Self::MerkleDataColumn(column) => {
-                let str: &str = column.into();
-                format!("Merkle{}", str)
-            }
-            Column::MerkleMetadataColumn => "MerkleMetadata".to_string(),
-        }
-    }
-
-    fn id(&self) -> u32 {
-        self.as_u32()
+impl fuel_core_storage::merkle::column::AsU32 for TableColumn {
+    fn as_u32(&self) -> u32 {
+        *self as u32
     }
 }

crates/proof_system/global_merkle_root/storage/src/compute.rs

@@ -4,6 +4,7 @@ use fuel_core_storage::{
         KeyValueInspect,
         StorageColumn,
     },
+    merkle::column::MerkleizedColumn,
     structured_storage::TableWithBlueprint,
     tables::{
         BlobData,
@@ -28,7 +29,7 @@ use fuel_core_types::{
 };
 
 use crate::{
-    column::Column,
+    column::TableColumn,
     merkle::{
         DummyStorage,
         Merkleized,
@@ -44,14 +45,15 @@ pub trait ComputeStateRoot {
     /// Compute the merkle root of the specific table
     fn merkle_root<Table>(&self) -> Result<MerkleRoot, StorageError>
     where
-        Table: Mappable + MerkleizedTableColumn,
+        Table: Mappable + MerkleizedTableColumn<TableColumn = TableColumn>,
         Table: TableWithBlueprint,
-        Table::Blueprint: BlueprintInspect<Table, DummyStorage<Column>>;
+        Table::Blueprint:
+            BlueprintInspect<Table, DummyStorage<MerkleizedColumn<TableColumn>>>;
 }
 
 impl<Storage> ComputeStateRoot for StorageTransaction<Storage>
 where
-    Storage: KeyValueInspect<Column = Column>,
+    Storage: KeyValueInspect<Column = MerkleizedColumn<TableColumn>>,
 {
     fn state_root(&self) -> Result<Bytes32, StorageError> {
         let roots = [
@@ -77,9 +79,10 @@ where
 
     fn merkle_root<Table>(&self) -> Result<MerkleRoot, StorageError>
     where
-        Table: Mappable + MerkleizedTableColumn,
+        Table: Mappable + MerkleizedTableColumn<TableColumn = TableColumn>,
         Table: TableWithBlueprint,
-        Table::Blueprint: BlueprintInspect<Table, DummyStorage<Column>>,
+        Table::Blueprint:
+            BlueprintInspect<Table, DummyStorage<MerkleizedColumn<TableColumn>>>,
     {
         <Self as MerkleRootStorage<u32, Merkleized<Table>>>::root(
             self,

crates/proof_system/global_merkle_root/storage/src/merkle.rs

@@ -1,7 +1,3 @@
-use crate::column::{
-    Column,
-    TableColumn,
-};
 use alloc::borrow::Cow;
 use fuel_core_storage::{
     blueprint::{
@@ -16,6 +12,10 @@ use fuel_core_storage::{
         StorageColumn,
         Value,
     },
+    merkle::column::{
+        AsU32,
+        MerkleizedColumn,
+    },
     structured_storage::TableWithBlueprint,
     Mappable,
     Result as StorageResult,
@@ -50,47 +50,52 @@ pub struct Merkleized<Table>(core::marker::PhantomData<Table>);
 /// Implementation of this trait for the table, inherits
 /// the Merkle implementation for the [`Merkleized`] table.
 pub trait MerkleizedTableColumn {
+    /// The table column type
+    type TableColumn;
     /// Get the table column
-    fn table_column() -> TableColumn;
+    fn table_column() -> Self::TableColumn;
 }
 
-impl<Table> Mappable for Merkleized<Table>
+impl<Table, TC> Mappable for Merkleized<Table>
 where
-    Table: Mappable + MerkleizedTableColumn,
+    Table: Mappable + MerkleizedTableColumn<TableColumn = TC>,
 {
     type Key = <Table as Mappable>::Key;
     type OwnedKey = <Table as Mappable>::OwnedKey;
     type Value = <Table as Mappable>::Value;
     type OwnedValue = <Table as Mappable>::OwnedValue;
 }
 
-type KeyCodec<Table> = <<Table as TableWithBlueprint>::Blueprint as BlueprintInspect<
-    Table,
-    DummyStorage<Column>,
->>::KeyCodec;
+type KeyCodec<Table, TC> =
+    <<Table as TableWithBlueprint>::Blueprint as BlueprintInspect<
+        Table,
+        DummyStorage<MerkleizedColumn<TC>>,
+    >>::KeyCodec;
 
-type ValueCodec<Table> = <<Table as TableWithBlueprint>::Blueprint as BlueprintInspect<
-    Table,
-    DummyStorage<Column>,
->>::ValueCodec;
+type ValueCodec<Table, TC> =
+    <<Table as TableWithBlueprint>::Blueprint as BlueprintInspect<
+        Table,
+        DummyStorage<MerkleizedColumn<TC>>,
+    >>::ValueCodec;
 
-impl<Table> TableWithBlueprint for Merkleized<Table>
+impl<Table, TC> TableWithBlueprint for Merkleized<Table>
 where
-    Table: Mappable + MerkleizedTableColumn,
+    Table: Mappable + MerkleizedTableColumn<TableColumn = TC>,
     Table: TableWithBlueprint,
-    Table::Blueprint: BlueprintInspect<Table, DummyStorage<Column>>,
+    TC: core::fmt::Debug + Copy + strum::EnumCount + AsU32,
+    Table::Blueprint: BlueprintInspect<Table, DummyStorage<MerkleizedColumn<TC>>>,
 {
     type Blueprint = Sparse<
-        KeyCodec<Table>,
-        ValueCodec<Table>,
+        KeyCodec<Table, TC>,
+        ValueCodec<Table, TC>,
         MerkleMetadata,
         MerkleData<Table>,
         KeyConverter<Table>,
     >;
-    type Column = Column;
+    type Column = MerkleizedColumn<TC>;
 
     fn column() -> Self::Column {
-        Column::TableColumn(Table::table_column())
+        Self::Column::TableColumn(Table::table_column())
     }
 }
 

crates/proof_system/global_merkle_root/storage/src/merkle/smt.rs

@@ -1,5 +1,5 @@
 use crate::{
-    column::Column,
+    column::TableColumn,
     merkle::MerkleizedTableColumn,
 };
 use fuel_core_storage::{
@@ -9,6 +9,10 @@ use fuel_core_storage::{
         primitive::Primitive,
         raw::Raw,
     },
+    merkle::column::{
+        AsU32,
+        MerkleizedColumn,
+    },
     structured_storage::TableWithBlueprint,
     tables::merkle::SparseMerkleMetadata,
     Mappable,
@@ -25,15 +29,16 @@ impl<Table> Mappable for MerkleData<Table> {
     type OwnedValue = Self::Value;
 }
 
-impl<Table> TableWithBlueprint for MerkleData<Table>
+impl<Table, TC> TableWithBlueprint for MerkleData<Table>
 where
-    Table: MerkleizedTableColumn,
+    Table: MerkleizedTableColumn<TableColumn = TC>,
+    TC: core::fmt::Debug + Copy + strum::EnumCount + AsU32,
 {
     type Blueprint = Plain<Raw, Postcard>;
-    type Column = Column;
+    type Column = MerkleizedColumn<TC>;
 
-    fn column() -> Column {
-        Column::MerkleDataColumn(Table::table_column())
+    fn column() -> Self::Column {
+        Self::Column::MerkleDataColumn(Table::table_column())
     }
 }
 
@@ -49,9 +54,9 @@ impl Mappable for MerkleMetadata {
 
 impl TableWithBlueprint for MerkleMetadata {
     type Blueprint = Plain<Primitive<4>, Postcard>;
-    type Column = Column;
+    type Column = MerkleizedColumn<TableColumn>;
 
-    fn column() -> Column {
-        Column::MerkleMetadataColumn
+    fn column() -> Self::Column {
+        Self::Column::MerkleMetadataColumn
     }
 }

crates/proof_system/global_merkle_root/storage/src/structured_storage/blobs.rs

@@ -5,6 +5,8 @@ use crate::{
 use fuel_core_storage::tables::BlobData;
 
 impl MerkleizedTableColumn for BlobData {
+    type TableColumn = TableColumn;
+
     fn table_column() -> TableColumn {
         TableColumn::Blobs
     }

crates/proof_system/global_merkle_root/storage/src/structured_storage/coins.rs

@@ -5,6 +5,8 @@ use crate::{
 use fuel_core_storage::tables::Coins;
 
 impl MerkleizedTableColumn for Coins {
+    type TableColumn = TableColumn;
+
     fn table_column() -> TableColumn {
         TableColumn::Coins
     }

crates/proof_system/global_merkle_root/storage/src/structured_storage/contracts.rs

@@ -8,12 +8,16 @@ use fuel_core_storage::tables::{
 };
 
 impl MerkleizedTableColumn for ContractsRawCode {
+    type TableColumn = TableColumn;
+
     fn table_column() -> TableColumn {
         TableColumn::ContractsRawCode
     }
 }
 
 impl MerkleizedTableColumn for ContractsLatestUtxo {
+    type TableColumn = TableColumn;
+
     fn table_column() -> TableColumn {
         TableColumn::ContractsLatestUtxo
     }

crates/proof_system/global_merkle_root/storage/src/structured_storage/messages.rs

@@ -5,6 +5,8 @@ use crate::{
 use fuel_core_storage::tables::Messages;
 
 impl MerkleizedTableColumn for Messages {
+    type TableColumn = TableColumn;
+
     fn table_column() -> TableColumn {
         TableColumn::Messages
     }