feat(api): add showBurnt option to GetByMethodOptions

armyhaylenko · armyhaylenko · commit 78ee67ea67fd · 2025-01-28T10:46:03.000+02:00
diff --git a/entities/src/api_req_params.rs b/entities/src/api_req_params.rs
@@ -104,6 +104,8 @@ pub struct GetByMethodsOptions {
     pub show_zero_balance: bool,
     #[serde(default)]
     pub show_fungible: bool,
+    #[serde(default)]
+    pub show_burnt: Option<bool>,
 }
 
 impl From<&SearchAssetsOptions> for Options {
@@ -591,6 +593,7 @@ impl From<SearchAssetsOptions> for GetByMethodsOptions {
             show_inscription: value.show_inscription,
             show_zero_balance: value.show_zero_balance,
             show_fungible: false,
+            show_burnt: None,
         }
     }
 }
diff --git a/nft_ingester/src/api/dapi/converters.rs b/nft_ingester/src/api/dapi/converters.rs
@@ -159,6 +159,7 @@ impl TryFrom<GetAssetsByOwner> for SearchAssetsQuery {
                 validate_pubkey(asset_owner.owner_address).map(|k| k.to_bytes().to_vec())?,
             ),
             supply: Some(AssetSupply::Greater(0)),
+            burnt: asset_owner.options.show_burnt,
             ..Default::default()
         })
     }
diff --git a/nft_ingester/tests/api_tests.rs b/nft_ingester/tests/api_tests.rs
@@ -2090,6 +2090,167 @@ mod tests {
         );
     }
 
+    #[tokio::test]
+    #[tracing_test::traced_test]
+    async fn test_get_only_non_burnt_assets_by_owner() {
+        let cnt = 20;
+        let cli = Cli::default();
+        let (env, generated_assets) =
+            setup::TestEnvironment::create_burnt(&cli, cnt, SLOT_UPDATED).await;
+        let api = nft_ingester::api::api_impl::DasApi::<
+            MaybeProofChecker,
+            JsonWorker,
+            JsonWorker,
+            MockAccountBalanceGetter,
+            RaydiumTokenPriceFetcher,
+            Storage,
+        >::new(
+            env.pg_env.client.clone(),
+            env.rocks_env.storage.clone(),
+            Arc::new(ApiMetricsConfig::new()),
+            None,
+            None,
+            50,
+            None,
+            None,
+            JsonMiddlewareConfig::default(),
+            Arc::new(MockAccountBalanceGetter::new()),
+            None,
+            Arc::new(RaydiumTokenPriceFetcher::default()),
+            NATIVE_MINT_PUBKEY.to_string(),
+        );
+        let tasks = JoinSet::new();
+        let mutexed_tasks = Arc::new(Mutex::new(tasks));
+
+        let ref_value = generated_assets.owners[8].clone();
+        let payload = GetAssetsByOwner {
+            owner_address: ref_value.owner.value.map(|owner| owner.to_string()).unwrap_or_default(),
+            sort_by: None,
+            limit: None,
+            page: None,
+            before: None,
+            after: None,
+            cursor: None,
+            options: GetByMethodsOptions {
+                show_unverified_collections: true,
+                show_burnt: Some(false),
+                ..Default::default()
+            },
+        };
+
+        let res = api.get_assets_by_owner(payload, mutexed_tasks.clone()).await.unwrap();
+        let res_obj: AssetList = serde_json::from_value(res).unwrap();
+
+        // in the setup all assets were created as burnt
+        // meaning that if we do not explicitly specify show_burnt
+        // in the options, the response will be empty
+        assert_eq!(res_obj.total, 0, "total should be 0");
+        assert_eq!(res_obj.items.len(), 0, "items length should be 0");
+    }
+
+    #[tokio::test]
+    #[tracing_test::traced_test]
+    async fn test_get_only_burnt_assets_by_owner() {
+        let cnt = 20;
+        let cli = Cli::default();
+        let (env, generated_assets) =
+            setup::TestEnvironment::create_burnt(&cli, cnt, SLOT_UPDATED).await;
+        let api = nft_ingester::api::api_impl::DasApi::<
+            MaybeProofChecker,
+            JsonWorker,
+            JsonWorker,
+            MockAccountBalanceGetter,
+            RaydiumTokenPriceFetcher,
+            Storage,
+        >::new(
+            env.pg_env.client.clone(),
+            env.rocks_env.storage.clone(),
+            Arc::new(ApiMetricsConfig::new()),
+            None,
+            None,
+            50,
+            None,
+            None,
+            JsonMiddlewareConfig::default(),
+            Arc::new(MockAccountBalanceGetter::new()),
+            None,
+            Arc::new(RaydiumTokenPriceFetcher::default()),
+            NATIVE_MINT_PUBKEY.to_string(),
+        );
+        let tasks = JoinSet::new();
+        let mutexed_tasks = Arc::new(Mutex::new(tasks));
+
+        let ref_value = generated_assets.owners[8].clone();
+        let payload = GetAssetsByOwner {
+            owner_address: ref_value.owner.value.map(|owner| owner.to_string()).unwrap_or_default(),
+            sort_by: None,
+            limit: None,
+            page: None,
+            before: None,
+            after: None,
+            cursor: None,
+            options: GetByMethodsOptions {
+                show_unverified_collections: true,
+                show_burnt: Some(true),
+                ..Default::default()
+            },
+        };
+
+        let res = api.get_assets_by_owner(payload, mutexed_tasks.clone()).await.unwrap();
+        let res_obj: AssetList = serde_json::from_value(res).unwrap();
+
+        assert_eq!(res_obj.total, 20, "total should be 20");
+        assert_eq!(res_obj.items.len(), 20, "items length should be 20");
+    }
+
+    #[tokio::test]
+    #[tracing_test::traced_test]
+    async fn test_search_assets_excluding_burnt_assets() {
+        let cnt = 20;
+        let cli = Cli::default();
+        let (env, _generated_assets) =
+            setup::TestEnvironment::create_burnt(&cli, cnt, SLOT_UPDATED).await;
+        let api = nft_ingester::api::api_impl::DasApi::<
+            MaybeProofChecker,
+            JsonWorker,
+            JsonWorker,
+            MockAccountBalanceGetter,
+            RaydiumTokenPriceFetcher,
+            Storage,
+        >::new(
+            env.pg_env.client.clone(),
+            env.rocks_env.storage.clone(),
+            Arc::new(ApiMetricsConfig::new()),
+            None,
+            None,
+            50,
+            None,
+            None,
+            JsonMiddlewareConfig::default(),
+            Arc::new(MockAccountBalanceGetter::new()),
+            None,
+            Arc::new(RaydiumTokenPriceFetcher::default()),
+            NATIVE_MINT_PUBKEY.to_string(),
+        );
+        let tasks = JoinSet::new();
+        let mutexed_tasks = Arc::new(Mutex::new(tasks));
+        let limit = 20;
+        let payload = SearchAssets {
+            burnt: Some(false),
+            limit: Some(limit),
+            options: SearchAssetsOptions {
+                show_unverified_collections: true,
+                ..Default::default()
+            },
+            ..Default::default()
+        };
+        let res = api.search_assets(payload, mutexed_tasks.clone()).await.unwrap();
+        assert!(res.is_object());
+        let res_obj: AssetList = serde_json::from_value(res).unwrap();
+        assert_eq!(res_obj.total, 0, "total should be 0");
+        assert_eq!(res_obj.items.len(), 0, "assets length should be 0");
+    }
+
     #[tokio::test]
     #[tracing_test::traced_test]
     async fn test_get_assets_by_group() {
diff --git a/postgre-client/src/model.rs b/postgre-client/src/model.rs
@@ -68,7 +68,7 @@ pub struct AssetSortedIndex {
     pub sorting_id: String,
 }
 
-#[derive(Default)]
+#[derive(Default, Debug)]
 pub struct SearchAssetsFilter {
     pub specification_version: Option<SpecificationVersions>,
     pub specification_asset_class: Option<SpecificationAssetClass>,
@@ -92,6 +92,7 @@ pub struct SearchAssetsFilter {
     pub token_type: Option<TokenType>,
 }
 
+#[derive(Debug)]
 pub enum AssetSupply {
     Greater(u64),
     Equal(u64),
diff --git a/rocks-db/benches/misc_benchmark.rs b/rocks-db/benches/misc_benchmark.rs
@@ -13,7 +13,7 @@ fn bincode_decode_benchmark(c: &mut Criterion) {
     let slot = 100;
     let assets = pubkeys
         .iter()
-        .map(|pk| setup::rocks::create_test_dynamic_data(*pk, slot, "solana".to_string()))
+        .map(|pk| setup::rocks::create_test_dynamic_data(*pk, slot, "solana".to_string(), false))
         .map(|a| serialize(&a).unwrap())
         .collect::<Vec<_>>();
 
diff --git a/tests/setup/src/lib.rs b/tests/setup/src/lib.rs
@@ -39,6 +39,24 @@ impl<'a> TestEnvironment<'a> {
         .await
     }
 
+    pub async fn create_burnt(
+        cli: &'a Cli,
+        cnt: usize,
+        slot: u64,
+    ) -> (TestEnvironment<'a>, rocks::GeneratedAssets) {
+        Self::create_and_setup_from_closures(
+            cli,
+            cnt,
+            slot,
+            RocksTestEnvironmentSetup::static_data_for_nft,
+            RocksTestEnvironmentSetup::with_authority,
+            RocksTestEnvironmentSetup::test_owner,
+            RocksTestEnvironmentSetup::dynamic_data_burnt,
+            RocksTestEnvironmentSetup::collection_without_authority,
+        )
+        .await
+    }
+
     #[allow(clippy::too_many_arguments)]
     pub async fn create_and_setup_from_closures(
         cli: &'a Cli,
diff --git a/tests/setup/src/rocks.rs b/tests/setup/src/rocks.rs
@@ -252,7 +252,18 @@ impl RocksTestEnvironmentSetup {
     pub fn dynamic_data(pubkeys: &[Pubkey], slot: u64) -> Vec<AssetDynamicDetails> {
         pubkeys
             .iter()
-            .map(|pubkey| create_test_dynamic_data(*pubkey, slot, DEFAULT_TEST_URL.to_owned()))
+            .map(|pubkey| {
+                create_test_dynamic_data(*pubkey, slot, DEFAULT_TEST_URL.to_owned(), false)
+            })
+            .collect()
+    }
+
+    pub fn dynamic_data_burnt(pubkeys: &[Pubkey], slot: u64) -> Vec<AssetDynamicDetails> {
+        pubkeys
+            .iter()
+            .map(|pubkey| {
+                create_test_dynamic_data(*pubkey, slot, DEFAULT_TEST_URL.to_owned(), true)
+            })
             .collect()
     }
 
@@ -280,15 +291,20 @@ impl RocksTestEnvironmentSetup {
 pub const DEFAULT_PUBKEY_OF_ONES: Pubkey = Pubkey::new_from_array([1u8; 32]);
 pub const PUBKEY_OF_TWOS: Pubkey = Pubkey::new_from_array([2u8; 32]);
 
-pub fn create_test_dynamic_data(pubkey: Pubkey, slot: u64, url: String) -> AssetDynamicDetails {
+pub fn create_test_dynamic_data(
+    pubkey: Pubkey,
+    slot: u64,
+    url: String,
+    is_burnt: bool,
+) -> AssetDynamicDetails {
     AssetDynamicDetails {
         pubkey,
         is_compressible: Updated::new(slot, None, false),
         is_compressed: Updated::new(slot, None, false),
         is_frozen: Updated::new(slot, None, false),
         supply: Some(Updated::new(slot, None, 1)),
         seq: None,
-        is_burnt: Updated::new(slot, None, false),
+        is_burnt: Updated::new(slot, None, is_burnt),
         was_decompressed: Some(Updated::new(slot, None, false)),
         onchain_data: None,
         creators: Updated::new(slot, None, vec![generate_test_creator()]),

Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,8 @@ pub struct GetByMethodsOptions {`
`104`	`104`	`pub show_zero_balance: bool,`
`105`	`105`	`#[serde(default)]`
`106`	`106`	`pub show_fungible: bool,`
	`107`	`+ #[serde(default)]`
	`108`	`+ pub show_burnt: Option<bool>,`
`107`	`109`	`}`
`108`	`110`
`109`	`111`	`impl From<&SearchAssetsOptions> for Options {`
`@@ -591,6 +593,7 @@ impl From<SearchAssetsOptions> for GetByMethodsOptions {`
`591`	`593`	`show_inscription: value.show_inscription,`
`592`	`594`	`show_zero_balance: value.show_zero_balance,`
`593`	`595`	`show_fungible: false,`
	`596`	`+ show_burnt: None,`
`594`	`597`	`}`
`595`	`598`	`}`
`596`	`599`	`}`
Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,7 @@ impl TryFrom<GetAssetsByOwner> for SearchAssetsQuery {`
`159`	`159`	`validate_pubkey(asset_owner.owner_address).map(\|k\| k.to_bytes().to_vec())?,`
`160`	`160`	`),`
`161`	`161`	`supply: Some(AssetSupply::Greater(0)),`
	`162`	`+ burnt: asset_owner.options.show_burnt,`
`162`	`163`	`..Default::default()`
`163`	`164`	`})`
`164`	`165`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ pub struct AssetSortedIndex {`
`68`	`68`	`pub sorting_id: String,`
`69`	`69`	`}`
`70`	`70`
`71`		`-#[derive(Default)]`
	`71`	`+#[derive(Default, Debug)]`
`72`	`72`	`pub struct SearchAssetsFilter {`
`73`	`73`	`pub specification_version: Option<SpecificationVersions>,`
`74`	`74`	`pub specification_asset_class: Option<SpecificationAssetClass>,`
`@@ -92,6 +92,7 @@ pub struct SearchAssetsFilter {`
`92`	`92`	`pub token_type: Option<TokenType>,`
`93`	`93`	`}`
`94`	`94`
	`95`	`+#[derive(Debug)]`
`95`	`96`	`pub enum AssetSupply {`
`96`	`97`	`Greater(u64),`
`97`	`98`	`Equal(u64),`