ghost-keychain/packages/extension-dapp/README.md

@polkadot/extension-dapp

A basic extractor that manipulates the window.injectedWeb3 to retrieve all the providers added to the page. It has a number of utilities -

• web3Enable(dappName: string): Promise<Array<InjectedExtension>> - to be called before anything else, retrieves the list of all injected extensions/providers
• web3Accounts(): Promise<Array<InjectedAccountWithMeta>> - returns a list of all the injected accounts, accross all extensions (source in meta)
• web3AccountsSubscribe(cb: (accounts: Array<InjectedAccountWithMeta>) => any): Promise<Unsubcall> - subscribes to the accounts accross all extensions, returning a full list as changes are made
• web3FromAddress(address: string): Promise<InjectedExtension> - Retrieves a provider for a specific address
• web3FromSource(name: string): Promise<InjectedExtension> - Retrieves a provider identified by the name
• isWeb3Injected: boolean - boolean to indicate if injectedWeb3 was found on the page
• web3EnablePromise: Promise<Array<InjectedExtension>> | null - null or the promise as a result of the last call to web3Enable

Usage

import { web3Accounts, web3Enable, web3FromAddress } from '@polkadot/extension-dapp';

// returns an array of all the injected sources
// (this needs to be called first, before other requests)
const allInjected = await web3Enable('my cool dapp');

// returns an array of { address, meta: { name, source } }
// meta.source contains the name of the extension that provides this account
const allAccounts = await web3Accounts();

// finds an injector for an address
const injector = await web3FromAddress('5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFabHE');

// sets the signer for the address on the @polkadot/api
api.setSigner(injector.signer);