Create a wallet

Once you have an instance of Portal, you can add logic to create web3 wallets.

The onReady hook

The Portal class dynamically loads a number of resources behind the scenes to enable MPC directly in the browser. For this reason, some functionality is not immediately available after initialization. We have include an onReady function to enable you to write your application logic in a more linear manner without having to explicitly poll the ready state of your Portal instance.

portal.onReady(() => {
    // Your code
})

Wallet Creation

The createWallet function initiates the MPC process to create a set of shares. The user’s share and the wallet address is automatically stored in the browser’s local storage, but hidden from the main browser context of your web application.

Safari’s ITP can clear localStorage after periods of inactivity, removing the signing share from the device. Use onWalletNotOnDevice to detect this and prompt recovery.

portal.onReady(async () => {
    const walletExists = await portal.doesWalletExist()

    if (!walletExists) {
        await portal.createWallet()
    }

    const ethAddress = await portal.getEip155Address()
    const solAddress = await portal.getSolanaAddress()
    const tronAddress = await portal.getTronAddress()
})

Be sure to use a Production API key when creating clients for production. Read more details about going to production here.

Want faster wallet creation? Enable the usePreGeneratedWallet feature flag—no changes to the code above are needed.

Reading every address

The per-chain getters above cover EVM, Solana and TRON. To get every address Portal has for the client — including Bitcoin, Stellar and XRP Ledger — use portal.getAddresses(). Like those getters, it requires an initialized Portal session, so call it once Portal is ready.

portal.onReady(async () => {
    const addresses = await portal.getAddresses()

    const ethAddress = addresses.eip155?.address
    const solAddress = addresses.solana?.address
    const tronAddress = addresses.tron?.address
    const stellarAddress = addresses.stellar?.address
    const xrplAddress = addresses.xrpl?.address

    // Bitcoin addresses live under `bitcoin.p2wpkh`, not `address`.
    const btcMainnetAddress = addresses.bip122?.bitcoin?.p2wpkh?.mainnet
    const btcTestnetAddress = addresses.bip122?.bitcoin?.p2wpkh?.testnet
})

A namespace is omitted from the response when the client has no wallet for it, so read each one optionally. See the getAddresses reference for the full response shape. getAddresses() types the XRP Ledger address (xrpl) starting from SDK version 4.1.0. Version 4.0.x already returns it at runtime but doesn’t type it, so read it there with the cast shown under AddressesByNamespace. The SDK only reads this address: signing on the XRP Ledger isn’t supported, even when this device holds the client’s SECP256K1 shares.

A returned address only means the client has a wallet — it does not mean the signing shares are on this device. Use isWalletOnDevice to check whether this device can sign.

That’s it! You now have an MPC Wallet built into your web application.

Getting Started

SDKs

APIs

Integrations

Resources

Create a wallet

The onReady hook

Wallet Creation

Reading every address

​The onReady hook

​Wallet Creation

​Reading every address

The onReady hook

Wallet Creation

Reading every address