linkWallets

Link a user wallet to your application

This function will allow users to link their existing wallets with your application.

venlyConnect.flows.linkWallets();

The difference with manageWallets:

  • A user can only link wallets, it is not possible to create or import a wallet
  • A list of all wallets is returned for any chain (it is possible to filter this).

Use case: a portfolio app where a user wants to quickly link all his wallets to get an overview of his complete portfolio.

Signature:

venlyConnect.flows.linkWallets(options?: {
    redirectUri?: string,
    correlationID?: string
}): Promise<PopupResult | void>

Returns:

Promise<PopupResult | void>

Parameters:

ParameterRequiredDescription
optionsFalseOptions you want to provide
options.redirectUriFalseURI you want users to be redirected to after linking their wallets. Defaults to current URI.
options.correlationIDFalseUnique correlationID allowing you to identify this specific transaction. It will be appended as a request parameter to the redirectUri upon return.

Example:

// redirects the user to the link wallets screen
// + redirects the user to https://wallet.venly.io once he's done
// + appends the correlationID as a request parameter when being redirected back
venlyConnect.flows.linkWallets({
    redirectUri: 'https://wallet.venly.io',
    correlationID: 'f173a18d-7a75-4429-9df4-25153d64a921'
});

Object Types

📘