feat: getSignaturesForAsset endpoint on top of new cl_audits_v2 t…

…able (#155) * add migration files for cl_audits_v2 * add types * ingester * add getSignaturesForAsset endpoint * refactor to resolve merge conflict related bugs * address clippy error * rename to get_asset_signatures * add instruction type update_metadata * add error log if instruction is unknown * add sort order changes --------- Co-authored-by: Nicolas Pennie <[email protected]>
metaplex-foundation · Jan 20, 2024 · 9d6ef66 · 9d6ef66
1 parent 82a8d2a
commit 9d6ef66
Show file tree

Hide file tree

Showing 28 changed files with 695 additions and 50 deletions.
diff --git a/das_api/src/api/api_impl.rs b/das_api/src/api/api_impl.rs
@@ -7,8 +7,9 @@ use digital_asset_types::{
         Cursor, PageOptions, SearchAssetsQuery,
     },
     dapi::{
-        get_asset, get_asset_proofs, get_assets, get_assets_by_authority, get_assets_by_creator,
-        get_assets_by_group, get_assets_by_owner, get_proof_for_asset, search_assets,
+        get_asset, get_asset_proofs, get_asset_signatures, get_assets, get_assets_by_authority,
+        get_assets_by_creator, get_assets_by_group, get_assets_by_owner, get_proof_for_asset,
+        search_assets,
     },
     rpc::{
         filter::{AssetSortBy, SearchConditionType},
@@ -461,6 +462,45 @@ impl ApiContract for DasApi {
             .map_err(Into::into)
     }
 
+    async fn get_asset_signatures(
+        self: &DasApi,
+        payload: GetAssetSignatures,
+    ) -> Result<TransactionSignatureList, DasApiError> {
+        let GetAssetSignatures {
+            id,
+            limit,
+            page,
+            before,
+            after,
+            tree,
+            leaf_index,
+            cursor,
+            sort_direction,
+        } = payload;
+
+        if !((id.is_some() && tree.is_none() && leaf_index.is_none())
+            || (id.is_none() && tree.is_some() && leaf_index.is_some()))
+        {
+            return Err(DasApiError::ValidationError(
+                "Must provide either 'id' or both 'tree' and 'leafIndex'".to_string(),
+            ));
+        }
+        let id = validate_opt_pubkey(&id)?;
+        let tree = validate_opt_pubkey(&tree)?;
+
+        let page_options = self.validate_pagination(limit, page, &before, &after, &cursor, None)?;
+
+        get_asset_signatures(
+            &self.db_connection,
+            id,
+            tree,
+            leaf_index,
+            page_options,
+            sort_direction,
+        )
+        .await
+        .map_err(Into::into)
+    }
     async fn get_grouping(
         self: &DasApi,
         payload: GetGrouping,

diff --git a/das_api/src/api/mod.rs b/das_api/src/api/mod.rs
@@ -1,8 +1,8 @@
 use crate::DasApiError;
 use async_trait::async_trait;
-use digital_asset_types::rpc::filter::SearchConditionType;
+use digital_asset_types::rpc::filter::{AssetSortDirection, SearchConditionType};
 use digital_asset_types::rpc::options::Options;
-use digital_asset_types::rpc::response::AssetList;
+use digital_asset_types::rpc::response::{AssetList, TransactionSignatureList};
 use digital_asset_types::rpc::{filter::AssetSorting, response::GetGroupingResponse};
 use digital_asset_types::rpc::{Asset, AssetProof, Interface, OwnershipModel, RoyaltyModel};
 use open_rpc_derive::{document_rpc, rpc};
@@ -147,6 +147,22 @@ pub struct GetGrouping {
     pub group_value: String,
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Default)]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
+pub struct GetAssetSignatures {
+    pub id: Option<String>,
+    pub limit: Option<u32>,
+    pub page: Option<u32>,
+    pub before: Option<String>,
+    pub after: Option<String>,
+    pub tree: Option<String>,
+    pub leaf_index: Option<i64>,
+    #[serde(default)]
+    pub cursor: Option<String>,
+    #[serde(default)]
+    pub sort_direction: Option<AssetSortDirection>,
+}
+
 #[document_rpc]
 #[async_trait]
 pub trait ApiContract: Send + Sync + 'static {
@@ -220,6 +236,15 @@ pub trait ApiContract: Send + Sync + 'static {
         summary = "Search for assets by a variety of parameters"
     )]
     async fn search_assets(&self, payload: SearchAssets) -> Result<AssetList, DasApiError>;
+    #[rpc(
+        name = "getAssetSignatures",
+        params = "named",
+        summary = "Get transaction signatures for an asset"
+    )]
+    async fn get_asset_signatures(
+        &self,
+        payload: GetAssetSignatures,
+    ) -> Result<TransactionSignatureList, DasApiError>;
     #[rpc(
         name = "getGrouping",
         params = "named",

diff --git a/das_api/src/builder.rs b/das_api/src/builder.rs
@@ -94,6 +94,18 @@ impl RpcApiBuilder {
         )?;
         module.register_alias("getAssetsByGroup", "get_assets_by_group")?;
 
+        module.register_async_method(
+            "getAssetSignatures",
+            |rpc_params, rpc_context| async move {
+                let payload = rpc_params.parse::<GetAssetSignatures>()?;
+                rpc_context
+                    .get_asset_signatures(payload)
+                    .await
+                    .map_err(Into::into)
+            },
+        )?;
+        module.register_alias("getSignaturesForAsset", "getAssetSignatures")?;
+
         module.register_async_method("search_assets", |rpc_params, rpc_context| async move {
             let payload = rpc_params.parse::<SearchAssets>()?;
             rpc_context.search_assets(payload).await.map_err(Into::into)

diff --git a/digital_asset_types/src/dao/generated/cl_audits_v2.rs b/digital_asset_types/src/dao/generated/cl_audits_v2.rs
@@ -0,0 +1,74 @@
+//! SeaORM Entity. Generated by sea-orm-codegen 0.9.3
+
+use super::sea_orm_active_enums::Instruction;
+use sea_orm::entity::prelude::*;
+use serde::{Deserialize, Serialize};
+
+#[derive(Copy, Clone, Default, Debug, DeriveEntity)]
+pub struct Entity;
+
+impl EntityName for Entity {
+    fn table_name(&self) -> &str {
+        "cl_audits_v2"
+    }
+}
+
+#[derive(Clone, Debug, PartialEq, DeriveModel, DeriveActiveModel, Serialize, Deserialize)]
+pub struct Model {
+    pub id: i64,
+    pub tree: Vec<u8>,
+    pub leaf_idx: i64,
+    pub seq: i64,
+    pub created_at: DateTime,
+    pub tx: Vec<u8>,
+    pub instruction: Instruction,
+}
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveColumn)]
+pub enum Column {
+    Id,
+    Tree,
+    LeafIdx,
+    Seq,
+    CreatedAt,
+    Tx,
+    Instruction,
+}
+
+#[derive(Copy, Clone, Debug, EnumIter, DerivePrimaryKey)]
+pub enum PrimaryKey {
+    Id,
+}
+
+impl PrimaryKeyTrait for PrimaryKey {
+    type ValueType = i64;
+    fn auto_increment() -> bool {
+        true
+    }
+}
+
+#[derive(Copy, Clone, Debug, EnumIter)]
+pub enum Relation {}
+
+impl ColumnTrait for Column {
+    type EntityName = Entity;
+    fn def(&self) -> ColumnDef {
+        match self {
+            Self::Id => ColumnType::BigInteger.def(),
+            Self::Tree => ColumnType::Binary.def(),
+            Self::LeafIdx => ColumnType::BigInteger.def(),
+            Self::Seq => ColumnType::BigInteger.def(),
+            Self::CreatedAt => ColumnType::DateTime.def(),
+            Self::Tx => ColumnType::Binary.def(),
+            Self::Instruction => Instruction::db_type(),
+        }
+    }
+}
+
+impl RelationTrait for Relation {
+    fn def(&self) -> RelationDef {
+        panic!("No RelationDef")
+    }
+}
+
+impl ActiveModelBehavior for ActiveModel {}
diff --git a/digital_asset_types/src/dao/generated/mod.rs b/digital_asset_types/src/dao/generated/mod.rs
@@ -1,4 +1,4 @@
-//! SeaORM Entity. Generated by sea-orm-codegen 0.9.3
+//! `SeaORM` Entity. Generated by sea-orm-codegen 0.11.3
 
 pub mod prelude;
 
@@ -10,6 +10,7 @@ pub mod asset_grouping;
 pub mod asset_v1_account_attachments;
 pub mod backfill_items;
 pub mod cl_audits;
+pub mod cl_audits_v2;
 pub mod cl_items;
 pub mod raw_txn;
 pub mod sea_orm_active_enums;

diff --git a/digital_asset_types/src/dao/generated/prelude.rs b/digital_asset_types/src/dao/generated/prelude.rs
@@ -1,4 +1,4 @@
-//! SeaORM Entity. Generated by sea-orm-codegen 0.9.3
+//! `SeaORM` Entity. Generated by sea-orm-codegen 0.11.3
 
 #![allow(unused_imports)]
 pub use super::asset::Entity as Asset;
@@ -8,7 +8,7 @@ pub use super::asset_data::Entity as AssetData;
 pub use super::asset_grouping::Entity as AssetGrouping;
 pub use super::asset_v1_account_attachments::Entity as AssetV1AccountAttachments;
 pub use super::backfill_items::Entity as BackfillItems;
-pub use super::cl_audits::Entity as ClAudits;
+pub use super::cl_audits_v2::Entity as ClAuditsV2;
 pub use super::cl_items::Entity as ClItems;
 pub use super::raw_txn::Entity as RawTxn;
 pub use super::tasks::Entity as Tasks;

diff --git a/digital_asset_types/src/dao/generated/sea_orm_active_enums.rs b/digital_asset_types/src/dao/generated/sea_orm_active_enums.rs
@@ -123,3 +123,84 @@ pub enum V1AccountAttachments {
     #[sea_orm(string_value = "unknown")]
     Unknown,
 }
+
+#[derive(Debug, Clone, PartialEq, EnumIter, DeriveActiveEnum, Serialize, Deserialize)]
+#[sea_orm(rs_type = "String", db_type = "Enum", enum_name = "instruction")]
+pub enum Instruction {
+    #[sea_orm(string_value = "burn")]
+    Burn,
+    #[sea_orm(string_value = "cancel_redeem")]
+    CancelRedeem,
+    #[sea_orm(string_value = "compress")]
+    Compress,
+    #[sea_orm(string_value = "decompress_v1")]
+    DecompressV1,
+    #[sea_orm(string_value = "delegate")]
+    Delegate,
+    #[sea_orm(string_value = "mint_to_collection_v1")]
+    MintToCollectionV1,
+    #[sea_orm(string_value = "mint_v1")]
+    MintV1,
+    #[sea_orm(string_value = "redeem")]
+    Redeem,
+    #[sea_orm(string_value = "set_and_verify_collection")]
+    SetAndVerifyCollection,
+    #[sea_orm(string_value = "transfer")]
+    Transfer,
+    #[sea_orm(string_value = "unknown")]
+    Unknown,
+    #[sea_orm(string_value = "unverify_collection")]
+    UnverifyCollection,
+    #[sea_orm(string_value = "unverify_creator")]
+    UnverifyCreator,
+    #[sea_orm(string_value = "verify_collection")]
+    VerifyCollection,
+    #[sea_orm(string_value = "verify_creator")]
+    VerifyCreator,
+    #[sea_orm(string_value = "update_metadata")]
+    UpdateMetadata,
+}
+// Added manually for convenience.
+impl Instruction {
+    pub fn from_str(s: &str) -> Self {
+        match s {
+            "Burn" => Instruction::Burn,
+            "CancelRedeem" => Instruction::CancelRedeem,
+            "Compress" => Instruction::Compress,
+            "DecompressV1" => Instruction::DecompressV1,
+            "Delegate" => Instruction::Delegate,
+            "MintToCollectionV1" => Instruction::MintToCollectionV1,
+            "MintV1" => Instruction::MintV1,
+            "Redeem" => Instruction::Redeem,
+            "SetAndVerifyCollection" => Instruction::SetAndVerifyCollection,
+            "Transfer" => Instruction::Transfer,
+            "UnverifyCollection" => Instruction::UnverifyCollection,
+            "UnverifyCreator" => Instruction::UnverifyCreator,
+            "VerifyCollection" => Instruction::VerifyCollection,
+            "VerifyCreator" => Instruction::VerifyCreator,
+            "UpdateMetadata" => Instruction::UpdateMetadata,
+            _ => Instruction::Unknown,
+        }
+    }
+
+    pub const fn to_str(s: &Self) -> &str {
+        match s {
+            Instruction::Burn => "Burn",
+            Instruction::CancelRedeem => "CancelReddem",
+            Instruction::Compress => "Compress",
+            Instruction::DecompressV1 => "DecompressV1",
+            Instruction::Delegate => "Delegate",
+            Instruction::MintToCollectionV1 => "MintToCollectionV1",
+            Instruction::MintV1 => "MintV1",
+            Instruction::Redeem => "Redeem",
+            Instruction::SetAndVerifyCollection => "SetAndVerifyCollection",
+            Instruction::Transfer => "Transfer",
+            Instruction::UnverifyCollection => "UnverifyCollection",
+            Instruction::UnverifyCreator => "UnverifyCreator",
+            Instruction::VerifyCollection => "VerifyCollection",
+            Instruction::VerifyCreator => "VerifyCreator",
+            Instruction::UpdateMetadata => "UpdateMetadata",
+            _ => "Unknown",
+        }
+    }
+}