Getting started

Detecting the provider

The Oyl Connect Provider can be accessed by every new browser tab after the extension is running.

You can verify whether your browser is running Oyl by checking for window.oyl:

if (typeof window.oyl !== 'undefined') {
  console.log('Oyl is installed!');
}

In the event it can’t be found, likely possible reasons are:

• You are running an older version (< v1.8)

• You are trying to access the object in the context of an old browser tab (opened before installing the extension)

Connecting to your wallet

The Oyl Connect Provider uses an authorization-based model, meaning that any method requesting account information, signing, or broadcasting will trigger the Oyl Connect Flow.

Oyl Connect Flow

This flow is rendered as a single window popup instance.

1. Unlock: prompts the user to unlock their wallet ⎯ wallet is locked

2. Connect: prompts the user to approve connecting the current site origin to the wallet ⎯ wallet has not been connected in the last day

3. Approve: prompts the user to approve the request (e.g. sign a PSBT, sign a message, etc)

This makes integrating with dApps a lot easier since there's no need to explicitly make a connection request or a call to requestAccounts. Just invoke the method you need and it will handle the rest.

Checkout the Oyl Connect Provider API methods here.