From da89bfe2bbc4f3a80dab8006ba4f3b77335a6a43 Mon Sep 17 00:00:00 2001 From: Michael Absolon Date: Tue, 19 Nov 2024 12:30:15 +0100 Subject: [PATCH] =?UTF-8?q?fix(sdk):=20Fix=20Bifrost=20balance=20fetching?= =?UTF-8?q?=20=F0=9F=94=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/sdk/src/api/IPolkadotApi.ts | 1 + .../src/nodes/supported/BifrostPolkadot.ts | 2 +- .../balance/getBalanceForeignXTokens.test.ts | 12 +++++- .../balance/getBalanceForeignXTokens.ts | 4 ++ packages/sdk/src/papi/PapiApi.test.ts | 26 ++++++++++++- packages/sdk/src/papi/PapiApi.ts | 36 +++++++++-------- packages/sdk/src/pjs/PolkadotJsApi.test.ts | 39 ++++++++++++++++++- packages/sdk/src/pjs/PolkadotJsApi.ts | 11 +++++- 8 files changed, 108 insertions(+), 23 deletions(-) diff --git a/packages/sdk/src/api/IPolkadotApi.ts b/packages/sdk/src/api/IPolkadotApi.ts index f660c8a5..426889e0 100644 --- a/packages/sdk/src/api/IPolkadotApi.ts +++ b/packages/sdk/src/api/IPolkadotApi.ts @@ -21,6 +21,7 @@ export interface IPolkadotApi { getAssetHubForeignBalance(address: string, multiLocation: TMultiLocation): Promise getForeignAssetsByIdBalance(address: string, assetId: string): Promise getBalanceForeignXTokens(address: string, asset: TAsset): Promise + getBalanceForeignBifrost(address: string, asset: TAsset): Promise getBalanceForeignAssetsAccount(address: string, assetId: bigint | number): Promise getFromStorage(key: string): Promise clone(): IPolkadotApi diff --git a/packages/sdk/src/nodes/supported/BifrostPolkadot.ts b/packages/sdk/src/nodes/supported/BifrostPolkadot.ts index 33a2ccbd..5fc82c77 100644 --- a/packages/sdk/src/nodes/supported/BifrostPolkadot.ts +++ b/packages/sdk/src/nodes/supported/BifrostPolkadot.ts @@ -25,7 +25,7 @@ export class BifrostPolkadot super('BifrostPolkadot', 'bifrost', 'polkadot', Version.V3) } - private getCurrencySelection(asset: TAsset) { + getCurrencySelection(asset: TAsset) { const nativeAssetSymbol = this.getNativeAssetSymbol() if (asset.symbol === nativeAssetSymbol) { diff --git a/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.test.ts b/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.test.ts index a6b25cc3..33d75f6a 100644 --- a/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.test.ts +++ b/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.test.ts @@ -7,7 +7,8 @@ import { getBalanceForeignXTokens } from './getBalanceForeignXTokens' const mockApi = { getBalanceForeignAssetsAccount: vi.fn(), - getBalanceForeignXTokens: vi.fn() + getBalanceForeignXTokens: vi.fn(), + getBalanceForeignBifrost: vi.fn() } as unknown as IPolkadotApi describe('getBalanceForeignXTokens', () => { @@ -45,6 +46,15 @@ describe('getBalanceForeignXTokens', () => { expect(balance).toBe(BigInt(3000)) }) + it('calls getBalanceForeignBifrost when node is BifrostPolkadot', async () => { + const spy = vi.spyOn(mockApi, 'getBalanceForeignBifrost').mockResolvedValue(BigInt(4000)) + const spy2 = vi.spyOn(mockApi, 'getBalanceForeignXTokens') + const balance = await getBalanceForeignXTokens(mockApi, 'BifrostPolkadot', address, asset) + expect(spy).toHaveBeenCalledWith(address, asset) + expect(spy2).not.toHaveBeenCalled() + expect(balance).toBe(BigInt(4000)) + }) + it('returns 0 if getBalanceForeignMoonbeam resolves with 0', async () => { vi.spyOn(mockApi, 'getBalanceForeignAssetsAccount').mockResolvedValue(BigInt(0)) const balance = await getBalanceForeignXTokens(mockApi, 'Moonbeam', address, asset) diff --git a/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.ts b/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.ts index 860ef143..2704218f 100644 --- a/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.ts +++ b/packages/sdk/src/pallets/assets/balance/getBalanceForeignXTokens.ts @@ -17,5 +17,9 @@ export const getBalanceForeignXTokens = async ( return api.getBalanceForeignAssetsAccount(address, BigInt(asset.assetId)) } + if (node === 'BifrostPolkadot' || node === 'BifrostKusama') { + return api.getBalanceForeignBifrost(address, asset) + } + return api.getBalanceForeignXTokens(address, asset) } diff --git a/packages/sdk/src/papi/PapiApi.test.ts b/packages/sdk/src/papi/PapiApi.test.ts index b0b711e3..52400f3a 100644 --- a/packages/sdk/src/papi/PapiApi.test.ts +++ b/packages/sdk/src/papi/PapiApi.test.ts @@ -28,7 +28,7 @@ vi.mock('./PapiXcmTransformer', () => ({ transform: vi.fn().mockReturnValue({ transformed: true }) })) -vi.mock('../utils', () => ({ +vi.mock('../utils/createApiInstanceForNode', () => ({ createApiInstanceForNode: vi.fn().mockResolvedValue({} as PolkadotClient) })) @@ -85,6 +85,9 @@ describe('PapiApi', () => { }, Tokens: { Accounts: { + getValue: vi.fn().mockResolvedValue({ + free: BigInt(6000) + }), getEntries: vi.fn().mockResolvedValue([ { keyArgs: [ @@ -289,9 +292,30 @@ describe('PapiApi', () => { }) }) + describe('getBalanceForeignBifrost', () => { + it('should return the balance when balance exists', async () => { + const transformedCurrencySelection = { type: 'Native', value: 'BNC' } + + vi.mocked(transform).mockReturnValue(transformedCurrencySelection) + + papiApi.setApi(mockPolkadotClient) + const balance = await papiApi.getBalanceForeignBifrost('some_address', { + symbol: 'BNC' + }) + + const unsafeApi = papiApi.getApi().getUnsafeApi() + expect(unsafeApi.query.Tokens.Accounts.getValue).toHaveBeenCalledWith( + 'some_address', + transformedCurrencySelection + ) + expect(balance).toBe(BigInt(6000)) + }) + }) + describe('getBalanceForeignXTokens', () => { it('should return the balance when asset matches symbolOrId', async () => { papiApi.setApi(mockPolkadotClient) + const balance = await papiApi.getBalanceForeignXTokens('some_address', { symbol: 'DOT', assetId: '1' diff --git a/packages/sdk/src/papi/PapiApi.ts b/packages/sdk/src/papi/PapiApi.ts index 5ca2938a..fb498781 100644 --- a/packages/sdk/src/papi/PapiApi.ts +++ b/packages/sdk/src/papi/PapiApi.ts @@ -1,3 +1,5 @@ +/* eslint-disable @typescript-eslint/no-unsafe-argument */ +/* eslint-disable @typescript-eslint/no-unsafe-assignment */ /* eslint-disable @typescript-eslint/no-unsafe-member-access */ /* eslint-disable @typescript-eslint/no-unsafe-call */ import type { @@ -8,7 +10,7 @@ import type { TNodeWithRelayChains, TSerializedApiCallV2 } from '../types' -import { createApiInstanceForNode } from '../utils' +import { createApiInstanceForNode, getNode } from '../utils' import { createClient, FixedSizeBinary } from 'polkadot-api' import type { TPapiApi, TPapiApiOrUrl, TPapiTransaction } from '../papi/types' import type { IPolkadotApi } from '../api' @@ -73,10 +75,8 @@ class PapiApi implements IPolkadotApi { } callTxMethod({ module, section, parameters }: TSerializedApiCallV2): TPapiTransaction { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const transformedParameters = transform(parameters) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument return this.api.getUnsafeApi().tx[module][section](transformedParameters) } @@ -85,53 +85,56 @@ class PapiApi implements IPolkadotApi { } async getBalanceNative(address: string): Promise { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const res = await this.api.getUnsafeApi().query.System.Account.getValue(address) return res.data.free as bigint } async getBalanceForeignPolkadotXcm(address: string, id?: string): Promise { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const res = await this.api.getUnsafeApi().query.Assets.Account.getValue(id, address) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument return res && res.balance ? BigInt(res.balance) : BigInt(0) } async getMythosForeignBalance(address: string): Promise { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const res = await this.api.getUnsafeApi().query.Balances.Account.getValue(address) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument + return res && res.free ? BigInt(res.free) : BigInt(0) } async getAssetHubForeignBalance(address: string, multiLocation: TMultiLocation): Promise { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const transformedMultiLocation = transform(multiLocation) - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const res = await this.api .getUnsafeApi() .query.ForeignAssets.Account.getValue(transformedMultiLocation, address) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument return BigInt(res === undefined ? 0 : res.balance) } async getForeignAssetsByIdBalance(address: string, assetId: string): Promise { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const res = await this.api.getUnsafeApi().query.ForeignAssets.Account.getValue(assetId, address) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument return BigInt(res === undefined ? 0 : res.balance) } + async getBalanceForeignBifrost(address: string, asset: TAsset): Promise { + const currencySelection = getNode('BifrostPolkadot').getCurrencySelection(asset) + + const transformedParameters = transform(currencySelection) + + const response = await this.api + .getUnsafeApi() + .query.Tokens.Accounts.getValue(address, transformedParameters) + + const accountData = response ? response : null + return accountData ? BigInt(accountData.free.toString()) : BigInt(0) + } + async getBalanceForeignXTokens(address: string, asset: TAsset): Promise { const response = await this.api.getUnsafeApi().query.Tokens.Accounts.getEntries(address) const entry = response.find(({ keyArgs }) => { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const [_address, assetItem] = keyArgs return ( @@ -147,14 +150,13 @@ class PapiApi implements IPolkadotApi { assetItem.value.toString().toLowerCase() === asset.assetId?.toLowerCase()) ) }) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument + return entry?.value ? BigInt(entry.value.free.toString()) : BigInt(0) } async getBalanceForeignAssetsAccount(address: string, assetId: bigint | number): Promise { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment const response = await this.api.getUnsafeApi().query.Assets.Account.getValue(assetId, address) - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument + return BigInt(response === undefined ? 0 : response.balance) } diff --git a/packages/sdk/src/pjs/PolkadotJsApi.test.ts b/packages/sdk/src/pjs/PolkadotJsApi.test.ts index 86867274..74c2a562 100644 --- a/packages/sdk/src/pjs/PolkadotJsApi.test.ts +++ b/packages/sdk/src/pjs/PolkadotJsApi.test.ts @@ -48,9 +48,9 @@ describe('PolkadotJsApi', () => { account: vi.fn() }, tokens: { - accounts: { + accounts: Object.assign(vi.fn(), { entries: vi.fn() - } + }) } } } as unknown as TPjsApi @@ -277,6 +277,41 @@ describe('PolkadotJsApi', () => { }) }) + describe('getBalanceForeignBifrost', () => { + it('should return the balance when asset matches currencySelection', async () => { + const address = 'some_address' + const mockResponse = { + free: { toString: () => '6000' } + } as unknown as VoidFn + + vi.mocked(mockApiPromise.query.tokens.accounts).mockResolvedValue(mockResponse) + + const balance = await polkadotApi.getBalanceForeignBifrost(address, { symbol: 'DOT' }) + + expect(mockApiPromise.query.tokens.accounts).toHaveBeenCalledWith(address, { + Token: 'DOT' + }) + expect(balance).toBe(BigInt(6000)) + }) + + it('should return null when no matching asset found', async () => { + const address = 'some_address' + + const mockResponse = { + free: { toString: () => '0' } + } as unknown as VoidFn + + vi.mocked(mockApiPromise.query.tokens.accounts).mockResolvedValue(mockResponse) + + const balance = await polkadotApi.getBalanceForeignBifrost(address, { symbol: 'DOT' }) + + expect(mockApiPromise.query.tokens.accounts).toHaveBeenCalledWith(address, { + Token: 'DOT' + }) + expect(balance).toBe(BigInt(0)) + }) + }) + describe('getBalanceForeignXTokens', () => { it('should return the balance when asset matches symbolOrId', async () => { const address = 'some_address' diff --git a/packages/sdk/src/pjs/PolkadotJsApi.ts b/packages/sdk/src/pjs/PolkadotJsApi.ts index 5cf4147a..4bd167d8 100644 --- a/packages/sdk/src/pjs/PolkadotJsApi.ts +++ b/packages/sdk/src/pjs/PolkadotJsApi.ts @@ -13,7 +13,7 @@ import type { StorageKey } from '@polkadot/types' import { u32, type UInt } from '@polkadot/types' import type { AnyTuple, Codec } from '@polkadot/types/types' import type { TBalanceResponse } from '../types/TBalance' -import { createApiInstanceForNode } from '../utils' +import { createApiInstanceForNode, getNode } from '../utils' import { isForeignAsset } from '../utils/assets' const lowercaseFirstLetter = (value: string) => value.charAt(0).toLowerCase() + value.slice(1) @@ -99,6 +99,15 @@ class PolkadotJsApi implements IPolkadotApi { return BigInt(obj === null || !obj.balance ? 0 : obj.balance) } + async getBalanceForeignBifrost(address: string, asset: TAsset): Promise { + const currencySelection = getNode('BifrostPolkadot').getCurrencySelection(asset) + + const response: Codec = await this.api.query.tokens.accounts(address, currencySelection) + + const accountData = response ? (response as AccountData) : null + return accountData ? BigInt(accountData.free.toString()) : BigInt(0) + } + async getBalanceForeignXTokens(address: string, asset: TAsset): Promise { const response: Array<[StorageKey, Codec]> = await this.api.query.tokens.accounts.entries(address)