enh(lib/*.d.ts): update package definitions

Author: D3Portillo

lib/index.d.ts

@@ -1,4 +1,5 @@
 import {
+  FIATCurrencies,
   Metamask,
   OnRequest,
   SendMethodProps,
@@ -31,11 +32,20 @@ interface Parse {
   txWeiToEth: (s: string) => number
 }
 
-type CleanerFn = () => void
+type VoidCallback = () => void
 
 export function useMetamask(
-  metamask?: (metamask: Metamask) => void | CleanerFn
+  metamask?: (metamask: Metamask) => void | VoidCallback
 ): UseMatamaskAPI
+/**
+ * Fetch token price in USD,JPY & EUR from CoinGecko public api
+ * @param coinGeckoID API ID, like `bitcoin`
+ * @returns [{ usd, jpy, eur }, triggerReFetchFn]
+ */
+export function useTokenPrice(
+  coinGeckoID: string,
+  refreshInternvalInSecs?: number
+): [FIATCurrencies, /** Triggers a re-fetch to the API */ VoidCallback]
 export function addEtherNetwork(props: AddEtherNetwork): Promise<null>
 export function addEtherToken(props: AddEtherToken): Promise<null>
 export function getMetamaskProvider(): Metamask | null
@@ -47,5 +57,10 @@ export function switchOrAppendNetwork(props: AddEtherNetwork): Promise<null>
  */
 export function sendEther(props: SendMethodProps): Promise<string>
 export function connectToMetamask(): Promise<string>
+export function formatEther(balance: number): string
+export function getFIATBalance(
+  tokenBalance: number | string,
+  tokenPrice: number
+): number
 export const metamaskRequest: OnRequest["request"]
 export const parse: Parse

lib/shared.d.ts

@@ -104,6 +104,12 @@ interface OnEvent {
 }
 
 // * Exported types
+export type FIATCurrencies = {
+  usd: number
+  jpy: number
+  eur: number
+}
+
 export interface Metamask extends OnEvent, OnRequest {
   isConnected(): boolean
   /**
@@ -126,7 +132,8 @@ export interface UseMatamaskAPI {
   resetError: () => void
   account: string
   accounts: string[]
-  balance: string
+  balance: number
+  formattedBalance: string
   chainId: string
   chainIdDecimal: number
   error?: ErrorState