Feat/cardano get balance

src/cardano/available-wallets.ts

@@ -0,0 +1,16 @@
+// TODO: Add klever mobile app source name
+export const availableWallets = ['begin', 'eternl', 'flint', 'gerowallet', 'lace', 'nami', 'nufi', 'raywallet', 'yoroi'] as const
+
+export type AvailableWallet = typeof availableWallets[number]
+
+export enum CardanoWallet {
+  BEGIN = 'begin',
+  ETERNL = 'eternl',
+  FLINT = 'flint',
+  GERO_WALLET = 'gerowallet',
+  LACE = 'lace',
+  NAMI = 'nami',
+  NUFI = 'nufi',
+  RAY_WALLET = 'raywallet',
+  YOROI = 'yoroi',
+}

src/ada/connect.ts → src/cardano/connect.ts

@@ -20,9 +20,9 @@ export async function connect(wallet?: string): Promise<CardanoUsedAddress[]> {
   if (typeof injectedWallet === 'undefined')
     throw new NoProviderAvailableError()
 
-  await web3Window.cardano[injectedWallet].enable()
+  const api = await web3Window.cardano[injectedWallet].enable()
 
-  const usedAddresses: CardanoUsedAddress[] = await web3Window.cardano.getUsedAddresses()
+  const usedAddresses: CardanoUsedAddress[] = await api.getUsedAddresses()
   if (usedAddresses.length === 0)
     throw new NoAvailableAccountsError()
 

src/cardano/get-balance.spec.ts

@@ -0,0 +1,28 @@
+import { BalanceFetchError } from '@/errors/balance-fetch-error';
+import { describe, expect, it, vi } from 'vitest';
+import { getBalance } from './getBalance';
+
+describe('Get balance use case', () => {
+  const cardanoMockedAPI = {
+    getBalance: vi.fn().mockResolvedValue('00'),
+    getUsedAddresses: vi.fn(),
+    getUnusedAddresses: vi.fn(),
+  }
+
+  const cardanoMockedInvalidAPI = {
+    getBalance: async () => {
+      throw new Error('unknown error')
+    },
+    getUsedAddresses: vi.fn(),
+    getUnusedAddresses: vi.fn(),
+  }
+
+  it('should be able to throw error when api throws error', async () => {
+    await expect(getBalance(cardanoMockedInvalidAPI)).rejects.toThrow(BalanceFetchError)
+  })
+
+  it('should be able to return mocked free balance', async () => {
+    const balance = await getBalance(cardanoMockedAPI)
+    expect(balance.free).toEqual('00')
+  })
+})

src/cardano/getBalance.ts

@@ -0,0 +1,16 @@
+import { BalanceFetchError } from '@/errors/balance-fetch-error';
+import type { ApiPromise } from './types';
+import type { Balance } from '@/types';
+
+export async function getBalance(api: ApiPromise): Promise<Balance> {
+  try {
+    const accountBalance = await api.getBalance()
+    return {
+      free: accountBalance,
+      frozen: '00', // asset staking never gets "frozen" or "locked" in Cardano Network
+    }
+  }
+  catch (error) {
+    throw new BalanceFetchError(error as Error)
+  }
+}

src/ada/types.ts → src/cardano/types.ts

@@ -5,3 +5,9 @@ export interface CardanoProviderProps {
 }
 
 export type CardanoUsedAddress = string
+
+export interface ApiPromise {
+  getBalance: () => Promise<string>
+  getUsedAddresses: () => Promise<string[]>
+  getUnusedAddresses: () => Promise<string[]>
+}

src/entities/provider-entity.ts

@@ -2,8 +2,8 @@ import type { Account, Address, Balance, Hash } from '@/types'
 
 export interface ProviderEntity {
   connect(): Promise<Account[]>
-  getBalance(address: Address): Promise<Balance>
-  signMessage(address: Address, message: string): Promise<string>
+  getBalance(address?: string): Promise<Balance>
+  signMessage(address: string, message: string): Promise<string>
   signatureVerify(message: string, signature: string, address: Address): boolean
   joinPool(address: Address, poolId: number, amount: number): Promise<Hash>
   bondExtra(address: Address, amount: number): Promise<Hash>

src/index.ts

@@ -1,4 +1,4 @@
-export * from './ada/index'
+export * from './cardano/index'
 export * from './icp/index'
 export * from './networks'
 export * from './substrate/dot/index'

src/types.ts

@@ -1,4 +1,4 @@
-import type { CardanoProviderProps } from './ada/types'
+import type { CardanoProviderProps } from './cardano/types'
 import type { NetworkKey } from './networks'
 import type { SubstrateProviderProps } from './substrate/types'
 
@@ -19,9 +19,9 @@ export type ProviderBuilderProps<T extends NetworkKey> = T extends 'dot' | 'ksm'
 
 // TODO: Add type and functions of injected providers
 export type Web3Window = {
-  injectedWeb3: any
-  cardano: any
-  ic: any
+  injectedWeb3?: any
+  cardano?: any
+  ic?: any
 } & Window & typeof globalThis
 
 export const web3Window = (window as Web3Window)

src/web3-provider.ts

@@ -1,5 +1,5 @@
-import { CardanoProvider } from './ada';
-import type { CardanoProviderProps } from './ada/types';
+import { CardanoProvider } from './cardano';
+import type { CardanoProviderProps } from './cardano/types';
 import type { ProviderEntity } from './entities/provider-entity';
 import { InvalidNetworkError } from './errors/invalid-network-error';
 import { InternetComputerProvider } from './icp';