@yoroi/dapp-connector

Yoroi Dapp Connector Module

The Yoroi Dapp Connector package is a utility for interacting with dApps on the Cardano Blockchain.

Development

The package is 100% covered by unit tests which need to pass before merging any changes. To run the tests, use the following command:

yarn workspace @yoroi/dapp-connector test

To extend the Dapp Connector API by new methods, you will need to update the connector.js file, which is directly inserted into the WebView. In the same file you can already find implemented methods such as getExtensions, getBalance, or getUtxos. The same methods will later need to be implemented in the resolver.ts file as well and a mapping needs to be added to the methods variable.

DApp List

DApps in the Yoroi application are fetched from the endpoints defined in the src/adapters/api.ts file. Adding, changing, or removing a dApp from the list needs to be done on the server side. No new app nor package release is needed to update the list of dApps.

Installation

Install the package using npm or yarn :

npm install @yoroi/dapp-connector --save
npm install @yoroi/types --save-dev

yarn add @yoroi/dapp-connector --save
yarn add @yoroi/types --save-dev

Usage

Integrating a wallet with a WebView

import {useAsyncStorage} from '@yoroi/common'
import {connectionStorageMaker, DappConnector, dappConnectorMaker} from '@yoroi/dapp-connector'
import {useSelectedWallet} from "../../useSelectedWallet";

const createDappConnector = (appStorage: App.Storage, wallet: YoroiWallet) => {
  const storage = connectionStorageMaker(appStorage.join('dapp-connections/'))
  const api: Api = {
    getDApps: async () => fetchDapps(),
  }
  return dappConnectorMaker(storage, wallet, api)
}

const useDappConnector = () => {
  const appStorage = useAsyncStorage()
  const {wallet} = useSelectedWallet()
  return useMemo(() => createDappConnector(appStorage, wallet), [appStorage])
}

export const useConnectWalletToWebView = (
  wallet: YoroiWallet,
  webViewRef: RefObject<WebView | null>,
  sessionId: string,
) => {
  const dappConnector = useDappConnector()

  const sendMessageToWebView = (event: string) => (id: string, result: unknown, error?: Error) => {
    if (error) {
      console.log('DappConnector', 'sending error to webview', error, 'as a response to', event)
    } else {
      console.log('DappConnector', 'sending result to webview', result, 'as a response to', event)
    }

    webViewRef.current?.injectJavaScript(getInjectableMessage({id, result, error: error?.message || null}))
  }

  const handleWebViewEvent = async (e: WebViewMessageEvent) => {
    const {data} = e.nativeEvent
    const webViewUrl = e.nativeEvent.url

    const handlerWallet = {
      id: wallet.id,
      networkId: wallet.networkId,
      confirmConnection: async (origin: string) => {
        return new Promise<boolean>((resolve) => {
          Alert.alert('Confirm connection', `Do you want to connect to ${origin}?`, [
            {text: 'Cancel', style: 'cancel', onPress: () => resolve(false)},
            {text: 'OK', onPress: () => resolve(true)},
          ])
        })
      },
    }

    try {
      await dappConnector.handleEvent(data, webViewUrl, handlerWallet, sendMessageToWebView(data))
    } catch (e) {
      console.log('DappConnector', 'handleWebViewEvent::error', e)
    }
  }

  useEffect(() => {
    webViewRef.current?.injectJavaScript(getInitScript(sessionId, dappConnector))
  }, [wallet, webViewRef, sessionId, dappConnector])

  return {handleEvent: handleWebViewEvent, initScript: getInitScript(sessionId, dappConnector)}
}

const getInjectableMessage = (message: unknown) => {
  return `(() => window.dispatchEvent(new MessageEvent('message', {data: ${JSON.stringify(message)}})))()`
}

const WALLET_NAME = 'wallet-name'
const API_VERSION = '1.0.0'
const ICON_URL = 'data:image/svg+xml;base64,...'

const getInitScript = (sessionId: string, dappConnector: DappConnector) => {
  return dappConnector.getWalletConnectorScript({
    iconUrl: ICON_URL,
    apiVersion: API_VERSION,
    walletName: WALLET_NAME,
    sessionId,
  })
}