Rahul/ifl 1603 make asset response consistent across all endpoints

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

@@ -74,6 +74,10 @@ describe('Route wallet/burnAsset', () => {
       })
       jest.spyOn(wallet, 'burn').mockResolvedValueOnce(burnTransaction)
 
+      const accountAsset = await account.getAsset(assetId)
+
+      expect(accountAsset).toBeDefined()
+
       const response = await routeTest.client.wallet.burnAsset({
         account: account.name,
         assetId: assetId.toString('hex'),
@@ -82,6 +86,13 @@ describe('Route wallet/burnAsset', () => {
       })
 
       expect(response.content).toEqual({
+        asset: {
+          id: asset.id().toString('hex'),
+          metadata: asset.metadata().toString('hex'),
+          name: asset.name().toString('hex'),
+          creator: asset.creator().toString('hex'),
+          nonce: accountAsset?.nonce ?? null,
+        },
         assetId: asset.id().toString('hex'),
         name: asset.name().toString('hex'),
         hash: burnTransaction.hash().toString('hex'),

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

@@ -4,6 +4,7 @@
 import * as yup from 'yup'
 import { Assert } from '../../../assert'
 import { CurrencyUtils, YupUtils } from '../../../utils'
+import { constructRpcAsset, RpcAsset, RpcAssetSchema } from '../../types'
 import { ApiNamespace, routes } from '../router'
 import { getAccount } from './utils'
 
@@ -18,8 +19,15 @@ export interface BurnAssetRequest {
 }
 
 export interface BurnAssetResponse {
+  asset: RpcAsset
+  /**
+   * @deprecated Please use `asset.id` instead
+   */
   assetId: string
   hash: string
+  /**
+   * @deprecated Please use `asset.name` instead
+   */
   name: string
   value: string
 }
@@ -38,6 +46,7 @@ export const BurnAssetRequestSchema: yup.ObjectSchema<BurnAssetRequest> = yup
 
 export const BurnAssetResponseSchema: yup.ObjectSchema<BurnAssetResponse> = yup
   .object({
+    asset: RpcAssetSchema.required(),
     assetId: yup.string().required(),
     hash: yup.string().required(),
     name: yup.string().required(),
@@ -71,6 +80,7 @@ routes.register<typeof BurnAssetRequestSchema, BurnAssetResponse>(
     const burn = transaction.burns[0]
 
     request.end({
+      asset: constructRpcAsset(asset),
       assetId: burn.assetId.toString('hex'),
       hash: transaction.hash().toString('hex'),
       name: asset.name.toString('hex'),

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

@@ -5,7 +5,12 @@ import * as yup from 'yup'
 import { TransactionStatus, TransactionType } from '../../../wallet'
 import { RpcSpend, RpcSpendSchema } from '../chain'
 import { ApiNamespace, routes } from '../router'
-import { RpcWalletNote, RpcWalletNoteSchema } from './types'
+import {
+  RcpAccountAssetBalanceDelta,
+  RcpAccountAssetBalanceDeltaSchema,
+  RpcWalletNote,
+  RpcWalletNoteSchema,
+} from './types'
 import {
   getAccount,
   getAccountDecryptedNotes,
@@ -35,7 +40,7 @@ export type GetAccountTransactionResponse = {
     burnsCount: number
     timestamp: number
     submittedSequence: number
-    assetBalanceDeltas: Array<{ assetId: string; assetName: string; delta: string }>
+    assetBalanceDeltas: RcpAccountAssetBalanceDelta[]
     notes: RpcWalletNote[]
     spends: RpcSpend[]
   } | null
@@ -69,17 +74,7 @@ export const GetAccountTransactionResponseSchema: yup.ObjectSchema<GetAccountTra
           burnsCount: yup.number().defined(),
           timestamp: yup.number().defined(),
           submittedSequence: yup.number().defined(),
-          assetBalanceDeltas: yup
-            .array(
-              yup
-                .object({
-                  assetId: yup.string().defined(),
-                  assetName: yup.string().defined(),
-                  delta: yup.string().defined(),
-                })
-                .defined(),
-            )
-            .defined(),
+          assetBalanceDeltas: yup.array(RcpAccountAssetBalanceDeltaSchema).defined(),
           notes: yup.array(RpcWalletNoteSchema).defined(),
           spends: yup.array(RpcSpendSchema).defined(),
         })

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

@@ -9,7 +9,12 @@ import { TransactionValue } from '../../../wallet/walletdb/transactionValue'
 import { RpcRequest } from '../../request'
 import { RpcSpend, RpcSpendSchema } from '../chain'
 import { ApiNamespace, routes } from '../router'
-import { RpcWalletNote, RpcWalletNoteSchema } from './types'
+import {
+  RcpAccountAssetBalanceDelta,
+  RcpAccountAssetBalanceDeltaSchema,
+  RpcWalletNote,
+  RpcWalletNoteSchema,
+} from './types'
 import {
   getAccount,
   getAccountDecryptedNotes,
@@ -43,7 +48,7 @@ export type GetAccountTransactionsResponse = {
   expiration: number
   timestamp: number
   submittedSequence: number
-  assetBalanceDeltas: Array<{ assetId: string; assetName: string; delta: string }>
+  assetBalanceDeltas: RcpAccountAssetBalanceDelta[]
   notes?: RpcWalletNote[]
   spends?: RpcSpend[]
 }
@@ -79,17 +84,7 @@ export const GetAccountTransactionsResponseSchema: yup.ObjectSchema<GetAccountTr
       expiration: yup.number().defined(),
       timestamp: yup.number().defined(),
       submittedSequence: yup.number().defined(),
-      assetBalanceDeltas: yup
-        .array(
-          yup
-            .object({
-              assetId: yup.string().defined(),
-              assetName: yup.string().defined(),
-              delta: yup.string().defined(),
-            })
-            .defined(),
-        )
-        .defined(),
+      assetBalanceDeltas: yup.array(RcpAccountAssetBalanceDeltaSchema).defined(),
       notes: yup.array(RpcWalletNoteSchema).defined(),
       spends: yup.array(RpcSpendSchema).defined(),
     })

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

@@ -4,6 +4,7 @@
 import { Asset } from '@ironfish/rust-nodejs'
 import * as yup from 'yup'
 import { AssetVerification } from '../../../assets'
+import { constructRpcAsset, RpcAsset, RpcAssetSchema } from '../../types'
 import { ApiNamespace, routes } from '../router'
 import { getAccount } from './utils'
 
@@ -18,6 +19,10 @@ export type GetBalanceRequest =
 export type GetBalanceResponse = {
   account: string
   assetId: string
+  asset?: RpcAsset
+  /**
+   * @deprecated Please use getAsset endpoint to get this information
+   * */
   assetVerification: AssetVerification
   confirmed: string
   unconfirmed: string
@@ -42,6 +47,7 @@ export const GetBalanceResponseSchema: yup.ObjectSchema<GetBalanceResponse> = yu
   .object({
     account: yup.string().defined(),
     assetId: yup.string().defined(),
+    asset: RpcAssetSchema.optional(),
     assetVerification: yup
       .object({ status: yup.string().oneOf(['verified', 'unverified', 'unknown']).defined() })
       .defined(),
@@ -74,9 +80,12 @@ routes.register<typeof GetBalanceRequestSchema, GetBalanceResponse>(
       confirmations,
     })
 
+    const asset = await account.getAsset(assetId)
+
     request.end({
       account: account.name,
       assetId: assetId.toString('hex'),
+      asset: asset ? constructRpcAsset(asset) : undefined,
       assetVerification: node.assetsVerifier.verify(assetId),
       confirmed: balance.confirmed.toString(),
       unconfirmed: balance.unconfirmed.toString(),

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

@@ -4,6 +4,7 @@
 import * as yup from 'yup'
 import { AssetVerification } from '../../../assets'
 import { CurrencyUtils } from '../../../utils'
+import { constructRpcAsset, RpcAsset, RpcAssetSchema } from '../../types'
 import { ApiNamespace, routes } from '../router'
 import { getAccount } from './utils'
 
@@ -15,10 +16,23 @@ export interface GetBalancesRequest {
 export interface GetBalancesResponse {
   account: string
   balances: {
+    asset?: RpcAsset
     assetId: string
+    /**
+     * @deprecated Please use `asset.name` instead
+     */
     assetName: string
+    /**
+     * @deprecated Please use `asset.creator` instead
+     */
     assetCreator: string
+    /**
+     * @deprecated Please use getAsset endpoint to get this information
+     * */
     assetOwner: string
+    /**
+     * @deprecated Please use getAsset endpoint to get this information
+     * */
     assetVerification: AssetVerification
     confirmed: string
     unconfirmed: string
@@ -47,6 +61,7 @@ export const GetBalancesResponseSchema: yup.ObjectSchema<GetBalancesResponse> =
         yup
           .object()
           .shape({
+            asset: RpcAssetSchema.defined(),
             assetId: yup.string().defined(),
             assetName: yup.string().defined(),
             assetCreator: yup.string().defined(),
@@ -86,6 +101,7 @@ routes.register<typeof GetBalancesRequestSchema, GetBalancesResponse>(
       const asset = await account.getAsset(balance.assetId)
 
       balances.push({
+        asset: asset ? constructRpcAsset(asset) : undefined,
         assetId: balance.assetId.toString('hex'),
         assetName: asset?.name.toString('hex') ?? '',
         assetCreator: asset?.creator.toString('hex') ?? '',

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

@@ -89,6 +89,13 @@ describe('Route wallet/mintAsset', () => {
       })
 
       expect(response.content).toEqual({
+        asset: {
+          id: asset.id().toString('hex'),
+          metadata: asset.metadata().toString('hex'),
+          name: asset.name().toString('hex'),
+          creator: asset.creator().toString('hex'),
+          nonce: asset.nonce() ?? null,
+        },
         assetId: asset.id().toString('hex'),
         hash: mintTransaction.hash().toString('hex'),
         name: asset.name().toString('hex'),

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

@@ -6,6 +6,7 @@ import * as yup from 'yup'
 import { Assert } from '../../../assert'
 import { CurrencyUtils, YupUtils } from '../../../utils'
 import { MintAssetOptions } from '../../../wallet/interfaces/mintAssetOptions'
+import { constructRpcAssetFromAsset, RpcAsset, RpcAssetSchema } from '../../types'
 import { ApiNamespace, routes } from '../router'
 import { getAccount } from './utils'
 
@@ -22,8 +23,15 @@ export interface MintAssetRequest {
 }
 
 export interface MintAssetResponse {
+  asset: RpcAsset
+  /**
+   * @deprecated Please use `asset.id` instead
+   */
   assetId: string
   hash: string
+  /**
+   * @deprecated Please use `asset.name` instead
+   */
   name: string
   value: string
 }
@@ -44,6 +52,7 @@ export const MintAssetRequestSchema: yup.ObjectSchema<MintAssetRequest> = yup
 
 export const MintAssetResponseSchema: yup.ObjectSchema<MintAssetResponse> = yup
   .object({
+    asset: RpcAssetSchema.defined(),
     assetId: yup.string().required(),
     hash: yup.string().required(),
     name: yup.string().required(),
@@ -94,6 +103,7 @@ routes.register<typeof MintAssetRequestSchema, MintAssetResponse>(
     const mint = transaction.mints[0]
 
     request.end({
+      asset: constructRpcAssetFromAsset(mint.asset),
       assetId: mint.asset.id().toString('hex'),
       hash: transaction.hash().toString('hex'),
       name: mint.asset.name().toString('hex'),

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

@@ -4,6 +4,7 @@
 
 import * as yup from 'yup'
 import { AccountImport } from '../../../wallet/walletdb/accountValue'
+import { RpcAsset, RpcAssetSchema } from '../../types'
 
 export type RpcAccountTransaction = {
   hash: string
@@ -21,13 +22,29 @@ export type RpcAccountTransaction = {
 
 export type RcpAccountAssetBalanceDelta = {
   assetId: string
+  /**
+   * @deprecated Please use the getAsset RPC to fetch additional asset details
+   */
   assetName: string
   delta: string
 }
 
+export const RcpAccountAssetBalanceDeltaSchema: yup.ObjectSchema<RcpAccountAssetBalanceDelta> =
+  yup
+    .object({
+      assetId: yup.string().defined(),
+      assetName: yup.string().defined(),
+      delta: yup.string().defined(),
+    })
+    .defined()
+
 export type RpcWalletNote = {
   value: string
   assetId: string
+  asset?: RpcAsset
+  /**
+   * @deprecated Please use `asset.name` instead
+   */
   assetName: string
   memo: string
   sender: string
@@ -51,6 +68,7 @@ export const RpcWalletNoteSchema: yup.ObjectSchema<RpcWalletNote> = yup
   .object({
     value: yup.string().defined(),
     assetId: yup.string().defined(),
+    asset: RpcAssetSchema.optional(),
     assetName: yup.string().defined(),
     memo: yup.string().defined(),
     sender: yup.string().defined(),

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

@@ -10,6 +10,7 @@ import { DecryptedNoteValue } from '../../../wallet/walletdb/decryptedNoteValue'
 import { TransactionValue } from '../../../wallet/walletdb/transactionValue'
 import { WorkerPool } from '../../../workerPool'
 import { ValidationError } from '../../adapters'
+import { constructRpcAsset } from '../../types'
 import {
   RcpAccountAssetBalanceDelta,
   RpcAccountImport,
@@ -173,6 +174,7 @@ export function serializeRpcWalletNote(
   return {
     value: CurrencyUtils.encode(note.note.value()),
     assetId: note.note.assetId().toString('hex'),
+    asset: asset ? constructRpcAsset(asset) : undefined,
     assetName: asset?.name.toString('hex') || '',
     memo: note.note.memo(),
     owner: note.note.owner(),