Create new index for tracking Asset metadata

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 
 ### Added
+- [2445](https://github.com/FuelLabs/fuel-core/pull/2445): Added GQL endpoint for querying asset details.
 - [2442](https://github.com/FuelLabs/fuel-core/pull/2442): Add uninitialized task for V1 gas price service
 - [2154](https://github.com/FuelLabs/fuel-core/pull/2154): Added `Unknown` variant to `ConsensusParameters` graphql queries
 - [2154](https://github.com/FuelLabs/fuel-core/pull/2154): Added `Unknown` variant to `Block` graphql queries

crates/client/assets/schema.sdl

@@ -2,6 +2,12 @@ scalar Address
 
 scalar AssetId
 
+type AssetInfoDetails {
+	contractId: ContractId!
+	subId: SubId!
+	totalSupply: U128!
+}
+
 type Balance {
 	owner: Address!
 	amount: U64!
@@ -853,6 +859,12 @@ type ProgramState {
 }
 
 type Query {
+	assetDetails(
+		"""
+		ID of the Asset
+		"""
+		id: AssetId!
+	): AssetInfoDetails!
 	"""
 	Read register value by index.
 	"""
@@ -1121,6 +1133,8 @@ type StateTransitionPurpose {
 }
 
 
+scalar SubId
+
 type SubmittedStatus {
 	time: Tai64Timestamp!
 }

crates/client/src/client.rs

@@ -16,6 +16,7 @@ use crate::client::{
         TransactionId,
     },
     types::{
+        asset::AssetDetail,
         gas_price::LatestGasPrice,
         message::MessageStatus,
         primitives::{
@@ -78,6 +79,7 @@ use pagination::{
     PaginationRequest,
 };
 use schema::{
+    assets::AssetInfoArg,
     balance::BalanceArgs,
     blob::BlobByIdArgs,
     block::BlockByIdArgs,
@@ -1191,6 +1193,14 @@ impl FuelClient {
             .transpose()?;
         Ok(status)
     }
+
+    pub async fn asset_info(&self, asset_id: &AssetId) -> io::Result<AssetDetail> {
+        let query = schema::assets::AssetInfoQuery::build(AssetInfoArg {
+            id: (*asset_id).into(),
+        });
+        let asset_info = self.query(query).await?.asset_details.into();
+        Ok(asset_info)
+    }
 }
 
 #[cfg(any(test, feature = "test-helpers"))]

crates/client/src/client/schema.rs

@@ -26,6 +26,7 @@ use crate::client::pagination::{
 };
 pub use primitives::*;
 
+pub mod assets;
 pub mod balance;
 pub mod blob;
 pub mod block;

crates/client/src/client/schema/assets.rs

@@ -0,0 +1,31 @@
+use crate::client::schema::{
+    schema,
+    AssetId,
+    ContractId,
+    SubId,
+    U128,
+};
+
+#[derive(cynic::QueryVariables, Debug)]
+pub struct AssetInfoArg {
+    pub id: AssetId,
+}
+
+#[derive(cynic::QueryFragment, Clone, Debug)]
+#[cynic(
+    schema_path = "./assets/schema.sdl",
+    graphql_type = "Query",
+    variables = "AssetInfoArg"
+)]
+pub struct AssetInfoQuery {
+    #[arguments(id: $id)]
+    pub asset_details: AssetInfoDetails,
+}
+
+#[derive(cynic::QueryFragment, Clone, Debug)]
+#[cynic(schema_path = "./assets/schema.sdl")]
+pub struct AssetInfoDetails {
+    pub sub_id: SubId,
+    pub contract_id: ContractId,
+    pub total_supply: U128,
+}

crates/client/src/client/schema/primitives.rs

@@ -111,6 +111,7 @@ fuel_type_scalar!(BlockId, Bytes32);
 fuel_type_scalar!(AssetId, AssetId);
 fuel_type_scalar!(BlobId, BlobId);
 fuel_type_scalar!(ContractId, ContractId);
+fuel_type_scalar!(SubId, Bytes32);
 fuel_type_scalar!(Salt, Salt);
 fuel_type_scalar!(TransactionId, Bytes32);
 fuel_type_scalar!(RelayedTransactionId, Bytes32);

crates/client/src/client/types.rs

@@ -7,6 +7,7 @@ pub mod contract;
 pub mod gas_costs;
 pub mod upgrades;
 
+pub mod asset;
 pub mod gas_price;
 pub mod merkle_proof;
 pub mod message;

crates/client/src/client/types/asset.rs

@@ -0,0 +1,24 @@
+use crate::client::schema;
+use fuel_core_types::{
+    fuel_tx::Bytes32,
+    fuel_types::ContractId,
+};
+
+#[derive(Clone, Copy, Debug, PartialEq)]
+pub struct AssetDetail {
+    pub contract_id: ContractId,
+    pub sub_id: Bytes32,
+    pub total_supply: u128,
+}
+
+// GraphQL Translation
+
+impl From<schema::assets::AssetInfoDetails> for AssetDetail {
+    fn from(value: schema::assets::AssetInfoDetails) -> Self {
+        AssetDetail {
+            contract_id: value.contract_id.into(),
+            sub_id: value.sub_id.into(),
+            total_supply: value.total_supply.into(),
+        }
+    }
+}

crates/fuel-core/src/graphql_api/ports.rs

@@ -64,7 +64,10 @@ use fuel_core_types::{
 };
 use std::sync::Arc;
 
-use super::storage::balances::TotalBalanceAmount;
+use super::storage::{
+    assets::AssetDetails,
+    balances::TotalBalanceAmount,
+};
 
 pub trait OffChainDatabase: Send + Sync {
     fn block_height(&self, block_id: &BlockId) -> StorageResult<BlockHeight>;
@@ -128,6 +131,8 @@ pub trait OffChainDatabase: Send + Sync {
     ) -> StorageResult<Option<RelayedTransactionStatus>>;
 
     fn message_is_spent(&self, nonce: &Nonce) -> StorageResult<bool>;
+
+    fn asset_info(&self, asset_id: &AssetId) -> StorageResult<Option<AssetDetails>>;
 }
 
 /// The on chain database port expected by GraphQL API service.
@@ -289,6 +294,7 @@ pub mod worker {
             },
         },
         graphql_api::storage::{
+            assets::AssetsInfo,
             balances::{
                 CoinBalances,
                 MessageBalances,
@@ -371,6 +377,7 @@ pub mod worker {
         + StorageMutate<DaCompressionTemporalRegistryIndex, Error = StorageError>
         + StorageMutate<DaCompressionTemporalRegistryTimestamps, Error = StorageError>
         + StorageMutate<DaCompressionTemporalRegistryEvictorCache, Error = StorageError>
+        + StorageMutate<AssetsInfo, Error = StorageError>
     {
         fn record_tx_id_owner(
             &mut self,

crates/fuel-core/src/graphql_api/storage.rs

@@ -36,6 +36,7 @@ use fuel_core_types::{
 };
 use statistic::StatisticTable;
 
+pub mod assets;
 pub mod balances;
 pub mod blocks;
 pub mod coins;
@@ -118,6 +119,8 @@ pub enum Column {
     CoinBalances = 23,
     /// Message balances per account.
     MessageBalances = 24,
+    /// See [`AssetsInfo`](assets::AssetsInfo)
+    AssetsInfo = 25,
 }
 
 impl Column {

crates/fuel-core/src/graphql_api/storage/assets.rs

@@ -0,0 +1,52 @@
+use fuel_core_storage::{
+    blueprint::plain::Plain,
+    codec::{
+        postcard::Postcard,
+        raw::Raw,
+    },
+    structured_storage::TableWithBlueprint,
+    Mappable,
+};
+use fuel_core_types::fuel_tx::{
+    AssetId,
+    Bytes32,
+    ContractId,
+};
+
+/// Asset info table to store information about the asset like total minted amounts,
+/// source contract, original sub id, etc.
+pub struct AssetsInfo;
+
+#[derive(Default, Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+pub struct AssetDetails {
+    pub contract_id: ContractId,
+    pub sub_id: Bytes32,
+    pub total_supply: u128,
+}
+
+impl Mappable for AssetsInfo {
+    type Key = AssetId;
+    type OwnedKey = Self::Key;
+    type Value = Self::OwnedValue;
+    type OwnedValue = AssetDetails;
+}
+
+impl TableWithBlueprint for AssetsInfo {
+    type Blueprint = Plain<Raw, Postcard>;
+    type Column = super::Column;
+
+    fn column() -> Self::Column {
+        Self::Column::AssetsInfo
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    fuel_core_storage::basic_storage_tests!(
+        AssetsInfo,
+        <AssetsInfo as Mappable>::Key::default(),
+        <AssetsInfo as Mappable>::Value::default()
+    );
+}

crates/fuel-core/src/graphql_api/worker_service.rs

@@ -3,10 +3,13 @@ use self::indexation::IndexationError;
 use super::{
     da_compression::da_compress_block,
     indexation,
-    storage::old::{
-        OldFuelBlockConsensus,
-        OldFuelBlocks,
-        OldTransactions,
+    storage::{
+        assets::AssetsInfo,
+        old::{
+            OldFuelBlockConsensus,
+            OldFuelBlocks,
+            OldTransactions,
+        },
     },
 };
 use crate::{
@@ -19,6 +22,7 @@ use crate::{
             },
         },
         storage::{
+            assets::AssetDetails,
             blocks::FuelBlockIdsToHeights,
             coins::{
                 owner_coin_id_key,
@@ -70,8 +74,10 @@ use fuel_core_types::{
             CoinSigned,
         },
         Contract,
+        ContractIdExt,
         Input,
         Output,
+        Receipt,
         Transaction,
         TxId,
         UniqueIdentifier,
@@ -88,6 +94,7 @@ use fuel_core_types::{
         },
         executor::{
             Event,
+            TransactionExecutionResult,
             TransactionExecutionStatus,
         },
         txpool::from_executor_to_status,
@@ -381,6 +388,57 @@ where
             )
             .into());
         }
+
+        // TODO: Do Asset indexation only if it is enabled.
+        //  Enable the indexation only in the case of empty database
+
+        let TransactionExecutionResult::Success { receipts, .. } = result else {
+            continue
+        };
+
+        for receipt in receipts {
+            match receipt {
+                Receipt::Mint {
+                    sub_id,
+                    contract_id,
+                    ..
+                }
+                | Receipt::Burn {
+                    sub_id,
+                    contract_id,
+                    ..
+                } => {
+                    let asset_id = contract_id.asset_id(sub_id);
+                    let current_supply = db
+                        .storage::<AssetsInfo>()
+                        .get(&asset_id)?
+                        .map(|info| info.total_supply)
+                        .unwrap_or_default();
+
+                    let new_supply = match receipt {
+                        Receipt::Mint { val, .. } => current_supply
+                            .checked_add(*val as u128)
+                            .expect("Impossible to overflow, because `val` is `u64`"),
+                        Receipt::Burn { val, .. } => {
+                            current_supply.checked_sub(*val as u128).ok_or(
+                                anyhow::anyhow!("Burned more than available amount"),
+                            )?
+                        }
+                        _ => unreachable!(),
+                    };
+
+                    db.storage::<AssetsInfo>().insert(
+                        &asset_id,
+                        &AssetDetails {
+                            contract_id: *contract_id,
+                            sub_id: *sub_id,
+                            total_supply: new_supply,
+                        },
+                    )?;
+                }
+                _ => {}
+            }
+        }
     }
     Ok(())
 }

crates/fuel-core/src/query.rs

@@ -1,3 +1,4 @@
+mod assets;
 mod balance;
 mod blob;
 mod block;

crates/fuel-core/src/query/assets.rs

@@ -0,0 +1,19 @@
+use crate::{
+    fuel_core_graphql_api::database::ReadView,
+    graphql_api::storage::assets::AssetDetails,
+};
+use fuel_core_storage::{
+    not_found,
+    Result as StorageResult,
+};
+use fuel_core_types::fuel_tx::AssetId;
+
+impl ReadView {
+    pub fn get_asset_details(&self, id: &AssetId) -> StorageResult<AssetDetails> {
+        let asset = self
+            .off_chain
+            .asset_info(id)?
+            .ok_or(not_found!(AssetDetails))?;
+        Ok(asset)
+    }
+}