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.
 - [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
 - [2154](https://github.com/FuelLabs/fuel-core/pull/2154): Added `TransactionType` type in `fuel-client`

crates/client/assets/schema.sdl

@@ -2,6 +2,12 @@ scalar Address
 
 scalar AssetId
 
+type AssetInfoDetails {
+	contractId: HexString!
+	subId: HexString!
+	totalSupply: U64!
+}
+
 type Balance {
 	owner: Address!
 	amount: U128!
@@ -850,6 +856,12 @@ type ProgramState {
 }
 
 type Query {
+	assetDetails(
+		"""
+		ID of the Asset
+		"""
+		id: AssetId!
+	): AssetInfoDetails
 	"""
 	Read register value by index.
 	"""

crates/client/src/client.rs

@@ -78,6 +78,10 @@ use pagination::{
     PaginationRequest,
 };
 use schema::{
+    assets::{
+        AssetInfoArg,
+        AssetInfoDetails,
+    },
     balance::BalanceArgs,
     blob::BlobByIdArgs,
     block::BlockByIdArgs,
@@ -1191,6 +1195,17 @@ impl FuelClient {
             .transpose()?;
         Ok(status)
     }
+
+    pub async fn asset_info(
+        &self,
+        asset_id: &AssetId,
+    ) -> io::Result<Option<AssetInfoDetails>> {
+        let query = schema::assets::AssetInfoQuery::build(AssetInfoArg {
+            id: (*asset_id).into(),
+        });
+        let asset_info = self.query(query).await?.asset_details.map(Into::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,30 @@
+use crate::client::schema::{
+    schema,
+    AssetId,
+    HexString,
+    U64,
+};
+
+#[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: Option<AssetInfoDetails>,
+}
+
+#[derive(cynic::QueryFragment, Clone, Debug)]
+#[cynic(schema_path = "./assets/schema.sdl")]
+pub struct AssetInfoDetails {
+    pub sub_id: HexString,
+    pub contract_id: HexString,
+    pub total_supply: U64,
+}

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,10 @@ 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>>;
+
+    fn asset_exists(&self, asset_id: &AssetId) -> StorageResult<bool>;
 }
 
 /// The on chain database port expected by GraphQL API service.
@@ -289,6 +296,7 @@ pub mod worker {
             },
         },
         graphql_api::storage::{
+            assets::AssetsInfo,
             balances::{
                 CoinBalances,
                 MessageBalances,
@@ -371,6 +379,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,48 @@
+use fuel_core_storage::{
+    blueprint::plain::Plain,
+    codec::{
+        postcard::Postcard,
+        raw::Raw,
+    },
+    structured_storage::TableWithBlueprint,
+    Mappable,
+};
+use fuel_core_types::{
+    fuel_merkle::common::Bytes32,
+    fuel_tx::{
+        AssetId,
+        ContractId,
+    },
+};
+
+/// Contract info
+pub struct AssetsInfo;
+
+pub type AssetDetails = (ContractId, Bytes32, u64); // (contract_id, sub_id, total_amount)
+
+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::{
@@ -70,8 +73,10 @@ use fuel_core_types::{
             CoinSigned,
         },
         Contract,
+        ContractIdExt,
         Input,
         Output,
+        Receipt,
         Transaction,
         TxId,
         UniqueIdentifier,
@@ -381,6 +386,64 @@ where
             )
             .into());
         }
+
+        for receipt in result.receipts() {
+            match receipt {
+                Receipt::Mint {
+                    sub_id,
+                    contract_id,
+                    val,
+                    ..
+                } => {
+                    let asset_id = contract_id.asset_id(sub_id);
+                    let current_count = match db.storage::<AssetsInfo>().get(&asset_id) {
+                        Ok(count) => count,
+                        Err(_) => {
+                            // If asset doesn't exist yet, create it with 0 count
+                            db.storage::<AssetsInfo>()
+                                .insert(&asset_id, &(*contract_id, **sub_id, 0))?;
+                            Some(Cow::Owned((*contract_id, **sub_id, 0)))
+                        }
+                    }
+                    .map(|info| {
+                        info.2
+                            .checked_add(*val)
+                            .ok_or(anyhow::anyhow!("Asset count overflow"))
+                    })
+                    .transpose()?
+                    .unwrap_or(*val);
+
+                    db.storage::<AssetsInfo>()
+                        .insert(&asset_id, &(*contract_id, **sub_id, current_count))?;
+                }
+                Receipt::Burn {
+                    sub_id,
+                    contract_id,
+                    val,
+                    ..
+                } => {
+                    let asset_id = contract_id.asset_id(sub_id);
+                    let current_count = db
+                        .storage::<AssetsInfo>()
+                        .get(&asset_id)
+                        .unwrap_or_else(|_| {
+                            tracing::warn!("Asset {} is not currently indexed", asset_id);
+                            None
+                        })
+                        .map(|info| {
+                            info.2
+                                .checked_sub(*val)
+                                .ok_or(anyhow::anyhow!("Asset count overflow"))
+                        })
+                        .transpose()?
+                        .unwrap_or(*val);
+
+                    db.storage::<AssetsInfo>()
+                        .insert(&asset_id, &(*contract_id, **sub_id, current_count))?;
+                }
+                _ => {}
+            }
+        }
     }
     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)
+    }
+}

crates/fuel-core/src/schema.rs

@@ -30,6 +30,7 @@ use futures::{
 use std::borrow::Cow;
 use tokio_stream::StreamExt;
 
+pub mod assets;
 pub mod balance;
 pub mod blob;
 pub mod block;
@@ -51,6 +52,7 @@ pub mod relayed_tx;
 
 #[derive(MergedObject, Default)]
 pub struct Query(
+    assets::AssetInfoQuery,
     dap::DapQuery,
     balance::BalanceQuery,
     blob::BlobQuery,
@@ -142,7 +144,7 @@ where
             } else if let Some(last) = last {
                 (last, IterDirection::Reverse)
             } else {
-                return Err(anyhow!("Either `first` or `last` should be provided"))
+                return Err(anyhow!("Either `first` or `last` should be provided"));
             };
 
             let start;
@@ -170,7 +172,7 @@ where
                         // Skip until start + 1
                         if key == start {
                             has_previous_page = true;
-                            return true
+                            return true;
                         }
                     }
                 }
@@ -184,7 +186,7 @@ where
                         // take until we've reached the end
                         if key == end {
                             has_next_page = true;
-                            return false
+                            return false;
                         }
                     }
                     count = count.saturating_sub(1);