Portal
instance to connect your Portal MPC Wallet to dApps via WalletConnect. When connecting via Portal Connect, a few things happen in the background:
- You provide a WalletConnect
uri
for Portal Connect to connect with - Portal Connect opens a WebSocket connection to the WalletConnect
uri
- All requests received over the WebSocket are routed to
portal.provider
to perform the request like normal
Installing
In order to use Portal Connect, you’ll need to install the@portal-hq/connect
package in your project.
This package does not negate the need to install other Portal dependencies, namely
@portal-hq/core
. Portal Connect depends on an existing Portal
instance to operate properly.Initializing
To initialize Portal Connect, import and create an instance ofPortalConnect
. The PortalConnect
class takes one argument, the Portal
instance you’d like it to use under the hood.
Connecting via WalletConnect
To connect to a WalletConnect URI, using the mechanism that makes the most sense for your app, capture the WalletConnect URI. The most common practice is to use a QR Code scanner for this. Once you’ve captured the URI, you can call theconnect(uri)
function on your PortalConnect
instance. This will initialize the WebSocket session with the WalletConnect relay and begin passing messages to your Portal Provider using your Portal MPC Wallet.
connect
and disconnect
events to get confirmation of connecting and disconnecting.
Wallet Connect’s Auth API is not currently supported. We have it on our roadmap. Please reach out if this is an urgent feature request.
Handling Session Requests
Session Requests
represent the initial connection request from the dApp to create a new session. These are triggered when Portal responds to the dApp after the connect(uri)
function is called. These events will be triggered with a SessionProposal
object. These objects can be used to display information about the dApp the user is connecting to and the specific permissions being requested by the dApp.
Accepting the dApps proposal
We have a helper methodaddChainsToProposal
. This can be used to add all the chains in your gateway config to the proposal object.
Binding to Session Requests
In order to bind to Session Requests, add an event handler to yourPortalConnect
instance.
Handle Signing
Each portal connect instance gets created with its own instance of the Portal Provider. This allows users to connect with different chains to different dApps.Listen for signing events
Handle signing approval. This is only required ifautoApprove
is turned off.
Handle Warnings and Errors
Set up a listener forportal_connectError
in order to handle specific errors and warnings from Portal Connect. Check out our Portal Connect Error Codes here.
Switching Chains
In order to switch the active chain for a portal connect instance use thesetChainId
method.
You must include that
chainId
in the gateway config with a gateway url on initialization of your Portal Object, otherwise, you can not switch chains.