feat: add pallets/foreign-assets endpoint #1314

Imod7 · 2023-08-15T13:21:14Z

Relates to: #1287

Description

Adds the endpoint /pallets/foreign-assets/ which returns an array with the available foreign assets and their corresponding AssetDetails and AssetMetadata.

Query Params

at: Which block to query, it will default to the latest finalized block. Accepts a hash or blocknumber

Sample Response

While connected to Kusama Asset Hub and requesting /pallets/foreign-assets/, the return result is/should be the following :

{
  "at": {
    "hash": "0xd890d7d27083b67d447406b55fb6bb07b382900d1643ce4343520b94e92055a0",
    "height": "5311742"
  },
  "items": [
    {
      "foreignAssetInfo": {
        "owner": "FxqimVubBRPqJ8kTwb3wL7G4q645hEkBEnXPyttLsTrFc5Q",
        "issuer": "FxqimVubBRPqJ8kTwb3wL7G4q645hEkBEnXPyttLsTrFc5Q",
        "admin": "FxqimVubBRPqJ8kTwb3wL7G4q645hEkBEnXPyttLsTrFc5Q",
        "freezer": "FxqimVubBRPqJ8kTwb3wL7G4q645hEkBEnXPyttLsTrFc5Q",
        "supply": "0",
        "deposit": "0",
        "minBalance": "100000000",
        "isSufficient": true,
        "accounts": "0",
        "sufficients": "0",
        "approvals": "0",
        "status": "Live"
      },
      "foreignAssetMetadata": {
        "deposit": "0",
        "name": "0x",
        "symbol": "0x",
        "decimals": "0",
        "isFrozen": false
      }
    },
    {
      "foreignAssetInfo": {
        "owner": "FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9",
        "issuer": "FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9",
        "admin": "FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9",
        "freezer": "FBeL7DiQ6JkoypYATheXhH3GQr5de2L3hL444TP6qQr3yA9",
        "supply": "0",
        "deposit": "100000000000",
        "minBalance": "1000000000",
        "isSufficient": false,
        "accounts": "0",
        "sufficients": "0",
        "approvals": "0",
        "status": "Live"
      },
      "foreignAssetMetadata": {
        "deposit": "6693666633",
        "name": "0x54696e6b65726e6574",
        "symbol": "0x544e4b52",
        "decimals": "12",
        "isFrozen": false
      }
    }
  ]
}

Todos

Add tests

- add controller, service & reponse type for foreign assets - update chain-config - update docs

- In /pallets/foreign-assets/ endpoint removed `asset-info` since it is not necessary. - In the docs removed the array notation from the `200` response of multiple endpoints (including foreign assets) since there is no outer array in the result.

- Added in the response the asset's name & symbol in human readable format.

- Retrieved metadata based on MultiLocation key obtained by asset info entries - Changed types in IForeignAssetInfo

- Added a test (tinkernet) for foreign asset - Added metadata & registry for Asset Hub Kusama

TarikGul · 2023-09-05T12:54:15Z

Gitlab test should be fixed now, just need to fix the merge conflict, and pull from master.

- Resolved conflicts by keeping both changes - Reordered the pallets endpoints in docs so they are in alphabetical order (almost) - Rebuilt docs

marshacb · 2023-09-05T15:30:18Z

src/services/test-helpers/mock/data/foreignAssets.ts

@@ -0,0 +1,12 @@
+// '{"parents":"1","interior":{"X2":[{"Parachain":"2125"},{"GeneralIndex":"0"}]}}';


Do we still need this comment? Also, Im thinking we should add the copyright to this file. I see a few other mock data files that we missed the copyright for as well that we can update at some point.

removed the comment and added the copyright text

in some other files that it was missing, I added the copyright text

in some other files that the copyright was with hear 2017-2022 I updated it to 2017-2023 but not all.

in some other files that the copyright was with hear 2017-2022 I updated it to 2017-2023 but not all.

Yea lets try to save the rest for a seperate PR, it just adds a lot of bloat to the review.

marshacb

Awesome PR!! Just one small question/nit.

src/controllers/pallets/PalletsForeignAssetsController.ts

src/services/pallets/PalletsForeignAssetsService.ts

TarikGul · 2023-09-05T18:47:45Z

src/types/responses/ForeignAssets.ts

+import { IAt } from '.';
+
+export interface IForeignAssetInfo {
+	foreignAssetInfo: PalletAssetsAssetDetails | AnyJson;


These types should have AnyJson removed from them

~~I replaced with T/Codec like I had it in the beginning. If I remove completely and only leave types PalletAssetsAssetDetails and AssetMetadata it does not work.~~
I am now reading the next comment so I will change again.

TarikGul · 2023-09-05T18:48:57Z

src/services/pallets/PalletsForeignAssetsService.ts

+
+		const [{ number }, foreignAssetInfo] = await Promise.all([
+			api.rpc.chain.getHeader(hash),
+			api.query.foreignAssets.asset.entries(),


Similar to above we need to correctly type the entries method. This is because both assetStorageKeyData, and assetInfo will have there own specific types.

assetStorageKeyData: StorageKey<AnyTuple>
assetInfo: Option<PalletAssetsAssetDetails>

// Incorrect: api.query.foreignAssets.asset.entries(); // Correct: api.query.foreignAssets.asset.entries<Option<PalletAssetsAssetDetails>>() // This is a little tricky but the above will map out to Promise<[StorageKey<AnyTuple>, Option<PalletAssetsAssetDetails>][]> once we input the correct type.

This will all ensure that the above is typed correctly so we wont need to type cast anymore and we can clean up all the types within the service.

That is amazing!!! Thank you so much @TarikGul for spending the time to explain and showcase this. I was fighting with the types quite a bit and now I get the logic! 🙏 🙏 🙏

TarikGul · 2023-09-05T18:53:41Z

src/services/pallets/PalletsForeignAssetsService.ts

+					foreignAssetMultiLocation
+				);
+
+				if (assetMetadata) {


I dont think it's assetMetadata we need to check here, but instead if (assetInfo.isSome), and then we need to unwrap the value when we key it into foreignAssetInfo: assetInfo.unwrap().

But then we need to handle the case where the info is not available in an else statement. Such that if it doesn't exist we return an empty object.

TarikGul

Left some notes on how we can update the type accuracy so we dont need to type cast or have Union types with AnyJson. I think it should make our testing and endpoint a bit more accurate.

Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>

- Replaced types to avoid type casts based on Tarik's suggestion - Added the copyright in some files that was missing - Updated the copyright year in some of the files

TarikGul · 2023-09-06T12:34:17Z

src/services/pallets/PalletsForeignAssetsService.ts

+					JSON.parse(foreignAssetMultiLocationStr)
+				);
+
+				const assetMetadata = await api.query.foreignAssets.metadata<


assetMetadata is not an Option it's just AssetMetadata, assetInfo in the only type that is going to be wrapped in an option.

TarikGul · 2023-09-06T12:39:33Z

src/types/responses/ForeignAssets.ts

+
+export interface IForeignAssetInfo {
+	foreignAssetInfo: Option<PalletAssetsAssetDetails>;
+	foreignAssetMetadata: Option<PalletAssetsAssetMetadata>;


This needs to be changed to just AssetMetadata, I would actually also prefer if we also just use AssetMetadata here because its the generic type for an Asset where as PalletAssetsAssetMetadata is referring to the Asset Pallet.

Edit: I know we talked and said either was fine, but I think its more clear to just use the AssetsMetadata here.

- Changed the copyright year in the files related to this PR

- Added the DOT asset in the test file (.spec) - Added the AssetInfo and AssetMetadata for the DOT asset in the mock data (metadata currently have empty & zero values because those are the values in Asset Hub right now - to be changed) - Added again the storageKeyMultilocation in TypeFactory since indexType is not included in InterfaceTypes (as defined in storageKey)

- Replaced PalletAssetsAssetMetadata with AssetMetadata - Removed also Option from assetMetadata

TarikGul · 2023-09-08T16:11:03Z

src/services/pallets/PalletsForeignAssetsService.ts

+		 * https://github.com/paritytech/asset-transfer-api-registry/blob/main/src/createRegistry.ts#L193-L238
+		 */
+		for (const [assetStorageKeyData, assetInfo] of foreignAssetInfo) {
+			console.log(assetInfo.toRawType());


Ahh this was my bad, but lets remove the console.log here

TarikGul

Just one tiny little nit with removing the console.log I pushed up by accident. Other than that, really great job!! LGTM

feat: add pallets/foreign-assets endpoint

e1aa255

- add controller, service & reponse type for foreign assets - update chain-config - update docs

Imod7 requested a review from a team as a code owner August 15, 2023 13:21

Imod7 added 4 commits August 21, 2023 11:55

add name & symbol in human readable format

e9ca2e4

- Added in the response the asset's name & symbol in human readable format.

Refactored the code that retrieves the metadata of the foreign asset

eb9628e

- Retrieved metadata based on MultiLocation key obtained by asset info entries - Changed types in IForeignAssetInfo

test: added test & mock data

0683642

- Added a test (tinkernet) for foreign asset - Added metadata & registry for Asset Hub Kusama

Merge branch 'master' into domi-foreign-assets

07fddc4

- Resolved conflicts by keeping both changes - Reordered the pallets endpoints in docs so they are in alphabetical order (almost) - Rebuilt docs

marshacb reviewed Sep 5, 2023

View reviewed changes

marshacb approved these changes Sep 5, 2023

View reviewed changes