Add new verified asset metadata fields to RpcAsset

ironfish/src/assets/assetsVerificationApi.ts

@@ -5,17 +5,18 @@ import axios, { AxiosAdapter, AxiosError, AxiosRequestConfig, AxiosResponse } fr
 import url, { URL } from 'url'
 import { FileSystem } from '../fileSystems'
 
-type AssetData = {
-  identifier: string
+export type AdditionalAssetData = {
   symbol: string
   decimals?: number
   logoURI?: string
   website?: string
 }
 
+export type VerifiedAssetMetadata = { identifier: string } & AdditionalAssetData
+
 type GetAssetDataResponse = {
   version?: number
-  assets: AssetData[]
+  assets: VerifiedAssetMetadata[]
 }
 
 type GetVerifiedAssetsRequestHeaders = {
@@ -27,7 +28,7 @@ type GetVerifiedAssetsResponseHeaders = {
 }
 
 export class VerifiedAssets {
-  private readonly assets: Map<string, AssetData> = new Map()
+  private readonly assets: Map<string, VerifiedAssetMetadata> = new Map()
   private lastModified?: string
 
   export(): ExportedVerifiedAssets {
@@ -52,6 +53,13 @@ export class VerifiedAssets {
     }
     return this.assets.has(assetId)
   }
+
+  getAssetData(assetId: Buffer | string): VerifiedAssetMetadata | undefined {
+    if (!(typeof assetId === 'string')) {
+      assetId = assetId.toString('hex')
+    }
+    return this.assets.get(assetId)
+  }
 }
 
 // `ExportedVerifiedAssets` may seem redundant, given that it duplicates the
@@ -63,7 +71,7 @@ export class VerifiedAssets {
 // - The `assets` field from `VerifiedAssets` is a `Map`, which is not
 //   properly supported by the cache serializer.
 export type ExportedVerifiedAssets = {
-  assets: AssetData[]
+  assets: VerifiedAssetMetadata[]
   lastModified?: string
 }
 
@@ -153,7 +161,7 @@ const axiosFileAdapter =
       }))
   }
 
-const sanitizedAssetData = (assetData: AssetData): AssetData => {
+const sanitizedAssetData = (assetData: VerifiedAssetMetadata): VerifiedAssetMetadata => {
   return {
     identifier: assetData.identifier,
     symbol: assetData.symbol,

ironfish/src/assets/assetsVerifier.ts

@@ -7,7 +7,12 @@ import { createRootLogger, Logger } from '../logger'
 import { ErrorUtils } from '../utils'
 import { SetIntervalToken } from '../utils'
 import { Retry } from '../utils'
-import { AssetsVerificationApi, VerifiedAssets } from './assetsVerificationApi'
+import {
+  AdditionalAssetData,
+  AssetsVerificationApi,
+  VerifiedAssetMetadata,
+  VerifiedAssets,
+} from './assetsVerificationApi'
 
 export type AssetVerification = {
   status: 'verified' | 'unverified' | 'unknown'
@@ -114,4 +119,32 @@ export class AssetsVerifier {
       return { status: 'unverified' }
     }
   }
+
+  getAssetData(assetId: Buffer | string): VerifiedAssetMetadata | undefined {
+    return this.verifiedAssets?.getAssetData(assetId)
+  }
+
+  verifyWithMetadata(
+    assetId: Buffer | string,
+  ):
+    | { verification: AssetVerification }
+    | ({ verification: AssetVerification } & AdditionalAssetData) {
+    const verification = this.verify(assetId)
+    if (verification.status === 'verified') {
+      const assetData = this.getAssetData(assetId)
+      if (assetData) {
+        return {
+          verification,
+          symbol: assetData.symbol,
+          decimals: assetData.decimals,
+          logoURI: assetData.logoURI,
+          website: assetData.website,
+        }
+      }
+    }
+
+    return {
+      verification,
+    }
+  }
 }

ironfish/src/rpc/routes/chain/getAsset.ts

@@ -83,7 +83,7 @@ routes.register<typeof GetAssetRequestSchema, GetAssetResponse>(
       owner: asset.owner.toString('hex'),
       supply: CurrencyUtils.encode(asset.supply),
       status: await getAssetStatus(node, asset),
-      verification: node.assetsVerifier.verify(asset.id),
+      ...node.assetsVerifier.verifyWithMetadata(asset.id),
     })
   },
 )

ironfish/src/rpc/routes/types.ts

@@ -79,6 +79,10 @@ export type RpcAsset = {
   metadata: string
   createdTransactionHash: string
   verification: AssetVerification
+  symbol?: string
+  decimals?: number
+  logoURI?: string
+  website?: string
   supply?: string
   /**
    * @deprecated query for the transaction to find it's status
@@ -100,6 +104,10 @@ export const RpcAssetSchema: yup.ObjectSchema<RpcAsset> = yup
     supply: yup.string().optional(),
     owner: yup.string().defined(),
     createdTransactionHash: yup.string().defined(),
+    symbol: yup.string().optional(),
+    decimals: yup.number().optional(),
+    logoURI: yup.string().optional(),
+    website: yup.string().optional(),
   })
   .defined()
 

ironfish/src/rpc/routes/wallet/burnAsset.ts

@@ -105,11 +105,11 @@ routes.register<typeof BurnAssetRequestSchema, BurnAssetResponse>(
         nonce: asset.nonce,
         creator: asset.creator.toString('hex'),
         owner: asset.owner.toString('hex'),
-        verification: context.assetsVerifier.verify(asset.id),
         status: await context.wallet.getAssetStatus(account, asset, {
           confirmations: request.data.confirmations,
         }),
         createdTransactionHash: asset.createdTransactionHash.toString('hex'),
+        ...context.assetsVerifier.verifyWithMetadata(asset.id),
       },
       transaction: await serializeRpcWalletTransaction(
         context.config,

ironfish/src/rpc/routes/wallet/getAsset.ts

@@ -63,7 +63,7 @@ routes.register<typeof GetWalletAssetRequestSchema, GetWalletAssetResponse>(
         confirmations: request.data.confirmations,
       }),
       supply: asset.supply ? CurrencyUtils.encode(asset.supply) : undefined,
-      verification: node.assetsVerifier.verify(asset.id),
+      ...node.assetsVerifier.verifyWithMetadata(asset.id),
     })
   },
 )

ironfish/src/rpc/routes/wallet/getAssets.ts

@@ -51,8 +51,8 @@ routes.register<typeof GetAssetsRequestSchema, GetAssetsResponse>(
           confirmations: request.data.confirmations,
         }),
         supply: asset.supply !== null ? CurrencyUtils.encode(asset.supply) : undefined,
-        verification: node.assetsVerifier.verify(asset.id),
         createdTransactionHash: asset.createdTransactionHash.toString('hex'),
+        ...node.assetsVerifier.verifyWithMetadata(asset.id),
       })
     }
 

ironfish/src/rpc/routes/wallet/mintAsset.ts

@@ -143,11 +143,11 @@ routes.register<typeof MintAssetRequestSchema, MintAssetResponse>(
         nonce: asset.nonce,
         creator: asset.creator.toString('hex'),
         owner: asset.owner.toString('hex'),
-        verification: context.assetsVerifier.verify(mint.asset.id()),
         status: await context.wallet.getAssetStatus(account, asset, {
           confirmations: request.data.confirmations,
         }),
         createdTransactionHash: asset.createdTransactionHash.toString('hex'),
+        ...context.assetsVerifier.verifyWithMetadata(mint.asset.id()),
       },
       transaction: await serializeRpcWalletTransaction(
         context.config,