[ABW-3465] Decode deep link and download metadata

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "sargon"
-version = "1.0.22"
+version = "1.0.23"
 edition = "2021"
 build = "build.rs"
 

fixtures/models/gateway/state/response_entity_details__single_account_no_assets.json

@@ -25,83 +25,9 @@
 			},
 			"metadata":
 			{
-				"total_count": 2,
+				"total_count": 0,
 				"items":
-				[
-					{
-						"key": "owner_keys",
-						"value":
-						{
-							"raw_hex": "5c228f01202201010120071d3ecafcab915867ec8446550f6c5b44c52dd8a947237f29b3d2a07697f8",
-							"programmatic_json":
-							{
-								"variant_id": 143,
-								"fields":
-								[
-									{
-										"element_kind": "Enum",
-										"elements":
-										[
-											{
-												"variant_id": 1,
-												"fields":
-												[
-													{
-														"element_kind": "U8",
-														"hex": "3ecafcab915867ec8446550f6c5b44c52dd8a947237f29b3d2a07697f8",
-														"kind": "Bytes"
-													}
-												],
-												"kind": "Enum"
-											}
-										],
-										"kind": "Array"
-									}
-								],
-								"kind": "Enum"
-							},
-							"typed":
-							{
-								"values":
-								[
-									{
-										"hash_hex": "3ecafcab915867ec8446550f6c5b44c52dd8a947237f29b3d2a07697f8",
-										"key_hash_type": "EddsaEd25519"
-									}
-								],
-								"type": "PublicKeyHashArray"
-							}
-						},
-						"is_locked": false,
-						"last_updated_at_state_version": 0
-					},
-					{
-						"key": "owner_badge",
-						"value":
-						{
-							"raw_hex": "5c220b01c0021e513ecafcab915867ec8446550f6c5b44c52dd8a947237f29b3d2a07697f8",
-							"programmatic_json":
-							{
-								"variant_id": 11,
-								"fields":
-								[
-									{
-										"value": "[513ecafcab915867ec8446550f6c5b44c52dd8a947237f29b3d2a07697f8]",
-										"kind": "NonFungibleLocalId"
-									}
-								],
-								"kind": "Enum"
-							},
-							"typed":
-							{
-								"value": "[513ecafcab915867ec8446550f6c5b44c52dd8a947237f29b3d2a07697f8]",
-								"type": "NonFungibleLocalId"
-							}
-						},
-						"is_locked": true,
-						"last_updated_at_state_version": 0
-					}
-				]
+				[]
 			},
 			"explicit_metadata":
 			{

fixtures/models/gateway/state/response_entity_details__single_resource.json

@@ -25,50 +25,9 @@
 			},
 			"metadata":
 			{
-				"total_count": 5,
+				"total_count": 4,
 				"items":
 				[
-					{
-						"key": "tags",
-						"value":
-						{
-							"raw_hex": "5c228001200c0206536172676f6e055275737479",
-							"programmatic_json":
-							{
-								"variant_id": 128,
-								"fields":
-								[
-									{
-										"element_kind": "String",
-										"elements":
-										[
-											{
-												"value": "Sargon",
-												"kind": "String"
-											},
-											{
-												"value": "Rusty",
-												"kind": "String"
-											}
-										],
-										"kind": "Array"
-									}
-								],
-								"kind": "Enum"
-							},
-							"typed":
-							{
-								"values":
-								[
-									"Sargon",
-									"Rusty"
-								],
-								"type": "StringArray"
-							}
-						},
-						"is_locked": false,
-						"last_updated_at_state_version": 73654060
-					},
 					{
 						"key": "icon_url",
 						"value":

src/core/error/common_error.rs

@@ -544,6 +544,21 @@ pub enum CommonError {
 
     #[error("Radix Connect Mobile failed to create new in flight session")]
     RadixConnectMobileFailedToCreateNewSession = 10151,
+
+    #[error("Deferred Deep Link invalid deep link value format")]
+    DeferredDeepLinkInvalidValueFormat = 10152,
+
+    #[error("Deferred Deep Link decoding failed")]
+    DeferredDeepLinkDecodingFailed = 10153,
+
+    #[error("Failed updating home cards from deferred deep link")]
+    FailedUpdatingHomeCardsFromDeferredDeepLink = 10154,
+
+    #[error("Home cards not found")]
+    HomeCardsNotFound = 10155,
+
+    #[error("Invalid Metadata format")]
+    InvalidMetadataFormat = 10156,
 }
 
 #[uniffi::export]

src/gateway_api/methods/state_methods.rs

@@ -9,9 +9,9 @@
         address: AccountAddress,
     ) -> Result<Option<Decimal192>> {
         let response: StateEntityDetailsResponse = self
-            .state_entity_details(StateEntityDetailsRequest {
-                addresses: vec![address.into()],
-            })
+            .state_entity_details(StateEntityDetailsRequest::new(vec![
+                address.address()
+            ]))
             .await?;
 
         let Some(response_item) = response
@@ -54,3 +54,40 @@
             .map(|x| x.unwrap_or(Decimal192::zero()))
     }
 }
+
+impl GatewayClient {
+    /// Fetches the metadata for the given address and returns the `icon_url` value.
+    pub async fn icon_url_of_address(
+        &self,
+        address: String,
+    ) -> Result<Option<Url>> {
+        let response: StateEntityDetailsResponse = self
+            .state_entity_details(StateEntityDetailsRequest::address(
+                address.clone(),
+                vec![MetadataKey::IconUrl],
+            ))
+            .await?;
+
+        let Some(response_item) = response
+            .items
+            .into_iter()
+            .find(|x| x.address.to_string() == address)
+        else {
+            return Ok(None);
+        };
+
+        let Some(item) = response_item
+            .metadata
+            .items
+            .into_iter()
+            .find(|x| x.key == MetadataKey::IconUrl.to_string())
+        else {
+            return Ok(None);
+        };
+
+        match item.value.typed {
+            MetadataTypedValue::MetadataUrlValue { value } => Ok(Some(value)),
+            _ => Err(CommonError::InvalidMetadataFormat),
+        }
+    }
+}

src/gateway_api/models/types/request/state/entity/mod.rs

@@ -1,3 +1,5 @@
-mod state_entity_details;
+mod opt_ins;
+mod request;
 
-pub use state_entity_details::*;
+pub use opt_ins::*;
+pub use request::*;

src/gateway_api/models/types/request/state/entity/opt_ins.rs

@@ -0,0 +1,25 @@
+use crate::prelude::*;
+
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    Serialize,
+    Deserialize, /* Deserialize so we can test roundtrip of JSON vectors */
+)]
+pub struct StateEntityDetailsOptIns {
+    #[serde(
+        rename = "explicit_metadata",
+        skip_serializing_if = "Option::is_none"
+    )]
+    pub explicit_metadata: Option<Vec<MetadataKey>>,
+}
+
+impl StateEntityDetailsOptIns {
+    pub fn new(
+        explicit_metadata: Option<Vec<MetadataKey>>,
+    ) -> StateEntityDetailsOptIns {
+        StateEntityDetailsOptIns { explicit_metadata }
+    }
+}

src/gateway_api/models/types/request/state/entity/request.rs

@@ -0,0 +1,36 @@
+use crate::prelude::*;
+
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    Serialize,
+    Deserialize, /* Deserialize so we can test roundtrip of JSON vectors */
+)]
+pub struct StateEntityDetailsRequest {
+    pub(crate) addresses: Vec<String>,
+    #[serde(rename = "opt_ins", skip_serializing_if = "Option::is_none")]
+    pub(crate) opt_ins: Option<StateEntityDetailsOptIns>,
+}
+
+impl StateEntityDetailsRequest {
+    pub fn new(addresses: Vec<String>) -> StateEntityDetailsRequest {
+        StateEntityDetailsRequest {
+            addresses,
+            opt_ins: None,
+        }
+    }
+
+    pub fn address(
+        address: String,
+        explicit_metadata: Vec<MetadataKey>,
+    ) -> StateEntityDetailsRequest {
+        StateEntityDetailsRequest {
+            addresses: vec![address],
+            opt_ins: Some(StateEntityDetailsOptIns::new(Some(
+                explicit_metadata,
+            ))),
+        }
+    }
+}

src/gateway_api/models/types/response/state/entity/details/metadata/collection.rs

@@ -0,0 +1,8 @@
+use crate::prelude::*;
+
+#[derive(
+    Deserialize, Serialize, Clone, PartialEq, Eq, Debug, uniffi::Record,
+)]
+pub struct EntityMetadataCollection {
+    pub items: Vec<EntityMetadataItem>,
+}

src/gateway_api/models/types/response/state/entity/details/metadata/item.rs

@@ -0,0 +1,9 @@
+use crate::prelude::*;
+
+#[derive(
+    Deserialize, Serialize, Clone, PartialEq, Eq, Debug, uniffi::Record,
+)]
+pub struct EntityMetadataItem {
+    pub key: String,
+    pub value: EntityMetadataItemValue,
+}

src/gateway_api/models/types/response/state/entity/details/metadata/item_value.rs

@@ -0,0 +1,8 @@
+use crate::prelude::*;
+
+#[derive(
+    Deserialize, Serialize, Clone, PartialEq, Eq, Debug, uniffi::Record,
+)]
+pub struct EntityMetadataItemValue {
+    pub typed: MetadataTypedValue,
+}

src/gateway_api/models/types/response/state/entity/details/metadata/mod.rs

@@ -0,0 +1,9 @@
+mod collection;
+mod item;
+mod item_value;
+mod typed_value;
+
+pub use collection::*;
+pub use item::*;
+pub use item_value::*;
+pub use typed_value::*;