Type alias ConnectOptions

ConnectOptions: Omit<WalletConnectOptions, "permissionRequests"> & {
    displayName: string;
    permissionRequests: ConnectPermissionRequest[];
}

Options for connecting to a Web5 agent. This includes the ability to connect to an external wallet.

NOTE: the returned ConnectPermissionRequest type is different to the ConnectPermissionRequest type in the @web5/agent package.

Type declaration

  • displayName: string

    The user friendly name of the client/app to be displayed when prompting end-user with permission requests.

  • permissionRequests: ConnectPermissionRequest[]

    The permissions that are being requested for the connected DID. This is used to create the ConnectPermissionRequest for the wallet connect flow.