Returns a list of wallets available on user's device. Each wallet is an object with the following properties:

• A name is provided to display wallet's name on the user interface.
• A version is provided to display wallet's version on the user interface.
• An icon is provided to display wallet's icon on the user interface.

Example:

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 app to use.

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

You can also provide an extensions object to enable specific CIPs. For example, to enable CIP95, you would pass:

This API retrieves a list of all assets in the connected wallet. Each asset is represented as an object containing the following properties:

• Unit: A unique identifier for the asset, which can be used to display its name in the user interface.
• Quantity: The amount of the asset held in the wallet.

This information is useful for applications that need to display wallet balances or perform operations involving specific assets.

Example:

This API returns an address owned by the wallet that should be used as a change address. A change address is where leftover assets from a transaction are returned during its creation. This ensures that any unspent assets are sent back to the connected wallet.

Applications can use this API to manage transaction outputs effectively, ensuring proper handling of change during transactions.

This API retrieves a list of UTXOs (unspent transaction outputs) controlled by the wallet that can be used as collateral inputs for transactions involving Plutus scripts. The returned UTXOs must meet or exceed the specified ADA value target.

If the target cannot be met, an error message will be returned explaining the issue. Wallets may return UTXOs with a greater total ADA value than requested but must never return UTXOs with a smaller total value.

This functionality is essential for applications that need to create transactions requiring collateral inputs.

Example response:

This API retrieves the network ID of the currently connected account. The network ID indicates the blockchain network the wallet is connected to. For example:

• 0: Testnet
• 1: Mainnet

Other network IDs may be returned by wallets, but these are not governed by CIP-30. The network ID remains consistent unless the connected account changes.

Applications can use this information to ensure compatibility with the connected network.

Returns a list of reward addresses owned by the wallet. A reward address is a stake address that is used to receive rewards from staking, generally starts from `stake` prefix. Example:

Returns a list of unused addresses controlled by the wallet. For example:

Returns a list of used addresses controlled by the wallet. For example:

Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet. For example:

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.

signData takes two arguments, the first one is the payload to sign and the second one is the address (optional).

By default, we get the first wallet's address with wallet.getRewardAddresses(), alternativelly you can specify the address to use.

Example of a response from the endpoint:

Continue reading this guide to learn how to verify the signature.

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.

Wallets inherently have the ability to submit transactions. This API allows applications to request the wallet to send a transaction. If the wallet accepts the transaction and successfully sends it, it will return the transaction ID, enabling the application to track its status. In case of errors during submission, the wallet will provide error messages or failure details.

This functionality is useful for applications that need to interact with the blockchain by submitting signed transactions through the user's wallet.

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

This API retrieves the Lovelace balance in the connected wallet. Lovelace is the smallest denomination of ADA, where 1 ADA equals 1,000,000 Lovelace.

Applications can use this information to display the wallet's balance or perform operations involving ADA.

This API retrieves a list of policy IDs for all assets in the connected wallet. A policy ID is a unique identifier for a group of assets, often used to manage collections or verify asset ownership.

Applications can use this information to query assets belonging to specific policy IDs or display asset details to the user.

Example response:

This API retrieves a list of assets associated with a specific policy ID. If no assets in the wallet belong to the specified policy ID, an empty list is returned.

Applications can use this API to query assets belonging to a particular policy ID, which is useful for managing collections of assets or verifying ownership.

To obtain a list of all policy IDs in the wallet, use wallet.getPolicyIds().

getSupportedExtensions is a static function that returns a list of CIPs that are supported by a wallet. You can query this function without connecting to a wallet, by providing the wallet name.

You can get the list of wallet on user's device with await BrowserWallet.getAvailableWallets().

This API retrieves a list of CIP-30 extensions enabled by the connected wallet. CIP-30 extensions define additional capabilities that wallets can support, enhancing their functionality.

Applications can use this information to determine the features supported by the wallet and adapt their behavior accordingly.

Example response:

This API retrieves the key, hash, and bech32 encoding of the DRep ID associated with the wallet. The DRep ID is a unique identifier used for delegation representation in the Cardano blockchain.

Applications can use this information to interact with delegation-related features or display the DRep ID details to the user.

Example response:

Get a list of registered public stake keys.

Example:

Get a list of unregistered public stake keys.