Browser Wallet

For connecting, queries and performs wallet functions in accordance to CIP-30.

These wallets APIs are in accordance to CIP-30, which defines the API for dApps to communicate with the user's wallet. Additional utility functions provided for developers that are useful for building dApps.

In this section, you can connect wallet and try APIs for dApps to communicate with your wallet. To start, import BrowserWallet:

// import BrowserWallet
import { BrowserWallet } from '@meshsdk/core';

// connect to a wallet
const wallet = await BrowserWallet.enable('eternl');

// get assets in wallet
const assets = await wallet.getAssets();

Get installed wallets

Returns a list of wallets installed on user's device. An icon is provided to display wallet's icon on the user interface.

BrowserWallet.getInstalledWallets();

Connect Wallet

This is the entrypoint to start communication with the user's wallet. The wallet should request the user's permission to connect the web page to the user's wallet, and if permission has been granted, the wallet will be returned and exposing the full API for the dApp to use.

Query BrowserWallet.getInstalledWallets() to get a list of available wallets, then provide the wallet name for which wallet the user would like to connect with.

const wallet = await BrowserWallet.enable('eternl');
No wallets installed

Get Balance

Returns a list of assets in the wallet. This API will return every assets in the wallet, example:

[
  {
    "unit": "lovelace",
    "quantity": "796105407"
  },
  {
    "unit": "0f5560dbc05282e05507aedb02d823d9d9f0e583cce579b81f9d1cd8",
    "quantity": "1"
  },
  {
    "unit": "9c8e9da7f81e3ca90485f32ebefc98137c8ac260a072a00c4aaf142d4d657368546f6b656e",
    "quantity": "2"
  },
]

const balance = await wallet.getBalance();
No wallets installed

Get Change Address

Returns an address owned by the wallet that should be used as a change address to return leftover assets during transaction creation back to the connected wallet.

const changeAddress = await wallet.getChangeAddress();
No wallets installed

Get Network ID

Returns the network ID of the currently connected account. 0 is testnet and 1 is mainnet but other networks can possibly be returned by wallets. Those other network ID values are not governed by CIP-30. This result will stay the same unless the connected account has changed.

const networkId = await wallet.getNetworkId();
No wallets installed

Get Reward Addresses

Returns a list of reward addresses owned by the wallet.

const rewardAddresses = await wallet.getRewardAddresses();
No wallets installed

Get Used Addresses

Returns a list of used addresses controlled by the wallet.

const usedAddresses = await wallet.getUsedAddresses();
No wallets installed

Get Unused Addresses

Returns a list of unused addresses controlled by the wallet.

const unusedAddresses = await wallet.getUnusedAddresses();
No wallets installed

Get UTXOs

Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet. ADA balance and multiasset value in each UTXO are specified in amount.

const utxos = await wallet.getUtxos();
No wallets installed

Sign Data

This endpoint utilizes the CIP-8 - Message Signing to sign arbitrary data, to verify the data was signed by the owner of the private key.

Here, we get the first wallet's address with wallet.getUsedAddresses(), alternativelly you can use reward addresses (getRewardAddresses) too. It's really up to you as the developer which address you want to use in your application.

const addresses = await wallet.getUsedAddresses();
const signature = await wallet.signData(addresses[0], 'mesh');
No wallets installed

Sign Transaction

Requests user to sign the provided transaction (tx). The wallet should ask the user for permission, and if given, try to sign the supplied body and return a signed transaction. partialSign should be true if the transaction provided requires multiple signatures.

const signedTx = await wallet.signTx(tx, partialSign?);

Check out Transaction to learn more on how to use this API.

Submit Transaction

As wallets should already have this ability to submit transaction, we allow dApps to request that a transaction be sent through it. If the wallet accepts the transaction and tries to send it, it shall return the transaction ID for the dApp to track. The wallet can return error messages or failure if there was an error in sending it.

const txHash = await wallet.submitTx(signedTx);

Check out Transaction to learn more on how to use this API.

Get Lovelace

Return the lovelace balance in wallet. 1 ADA = 1000000 lovelace.

const lovelace = await wallet.getLovelace();
No wallets installed

Get Assets

Returns a list of assets in wallet excluding lovelace, example:

[
  {
    "unit": "1207329a668cf5c42b80a220a8c85d5e82ac0b6f5ecedda4c07a8acc4d657368486f6e6f72546f6b656e2d3530343935",
    "policyId": "1207329a668cf5c42b80a220a8c85d5e82ac0b6f5ecedda4c07a8acc",
    "assetName": "Mesh Token Of Appreciation",
    "fingerprint": "asset1dw74h0w0meqg9cxkc9sezp8zqcxu8nl93fzfpz",
    "quantity": "1"
  }
  {
    "unit": "9c8e9da7f81e3ca90485f32ebefc98137c8ac260a072a00c4aaf142d4d657368546f6b656e",
    "policyId": "9c8e9da7f81e3ca90485f32ebefc98137c8ac260a072a00c4aaf142d",
    "assetName": "MeshToken",
    "fingerprint": "asset177e7535dclmkkph8ewt9fsghllkwmpspa3n98p",
    "quantity": "10"
  }
]

const assets = await wallet.getAssets();
No wallets installed

Get Policy IDs

Return a list of assets' policy ID.

const policyIds = await wallet.getPolicyIds();
No wallets installed

Get a Collection of Assets

Returns a list of assets from a policy ID. If no assets in wallet belongs to the policy ID, an empty list is returned. Query for a list of assets' policy ID with wallet.getPolicyIds().

const assets = await wallet.getPolicyIdAssets('64af286e2ad0df4de2e7de15f8ff5b3d27faecf4ab2757056d860a42');
No wallets installed