Class Provider

Description

Represents a browser-based wallet.

To connect to a wallet, create an object to represent the wallet to access with the createProvider() method. These wallet objects implement the Provider interface so you can access different types of wallets in a consistent way.

Example

import { createProvider, MetamaskProvider } from '@rarimo/provider'

const getMetamaskWalletAddress = async () => {
  // Connect to the Metamask wallet in the browser using ethers.js, using the MetamaskProvider interface to limit bundle size.
  const provider = await createProvider(MetamaskProvider)

  // Get the address of the wallet
  console.log(provider.address)
}

Hierarchy

Provider

Implements

IProvider

Constructors

constructor

new Provider(proxyConstructor: ProviderProxyConstructor): Provider
Parameters
- proxyConstructor: ProviderProxyConstructor
Returns Provider
- Defined in packages/w3p/src/provider.ts:49

Properties

`Optional` proxy

proxy?: ProviderProxy

`Readonly` proxyConstructor

proxyConstructor: ProviderProxyConstructor

`Optional` selectedProvider

selectedProvider?: PROVIDERS

`Static` `Optional` chainsDetails

chainsDetails?: Record<ChainId, Chain>

Accessors

address

get address(): undefined | string
Returns undefined | string
Implementation of IProvider.address
- Defined in packages/w3p/src/provider.ts:71

chainDetails

get chainDetails(): undefined | Chain
Returns undefined | Chain
Implementation of IProvider.chainDetails
- Defined in packages/w3p/src/provider.ts:79

chainId

get chainId(): undefined | ChainId
Returns undefined | ChainId
Implementation of IProvider.chainId
- Defined in packages/w3p/src/provider.ts:75

chainType

get chainType(): undefined | CHAIN_TYPES
Returns undefined | CHAIN_TYPES
Implementation of IProvider.chainType
- Defined in packages/w3p/src/provider.ts:59

isConnected

get isConnected(): boolean
Returns boolean
Implementation of IProvider.isConnected
- Defined in packages/w3p/src/provider.ts:67

providerType

get providerType(): undefined | PROVIDERS
Returns undefined | PROVIDERS
Implementation of IProvider.providerType
- Defined in packages/w3p/src/provider.ts:63

rawProvider

get rawProvider(): undefined | RawProvider
Returns undefined | RawProvider
Implementation of IProvider.rawProvider
- Defined in packages/w3p/src/provider.ts:55

Methods

addChain

addChain(chain: Chain): Promise<void>
Parameters
- chain: Chain
Returns Promise<void>
Implementation of IProvider.addChain
- Defined in packages/w3p/src/provider.ts:110

clearHandlers

clearHandlers(): void
Returns void
Implementation of IProvider.clearHandlers
- Defined in packages/w3p/src/provider.ts:164

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of IProvider.connect
- Defined in packages/w3p/src/provider.ts:100

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of IProvider.disconnect
- Defined in packages/w3p/src/provider.ts:180

getAddressUrl

getAddressUrl(chain: Chain, address: string): string
Parameters
- chain: Chain
- address: string
Returns string
Implementation of IProvider.getAddressUrl
- Defined in packages/w3p/src/provider.ts:136

getHashFromTx

getHashFromTx(txResponse: TransactionResponse): string
Parameters
- txResponse: TransactionResponse
Returns string
Implementation of IProvider.getHashFromTx
- Defined in packages/w3p/src/provider.ts:128

getTxUrl

getTxUrl(chain: Chain, txHash: string): string
Parameters
- chain: Chain
- txHash: string
Returns string
Implementation of IProvider.getTxUrl
- Defined in packages/w3p/src/provider.ts:132

init

init(provider: ProviderInstance, listeners?: ProviderListeners): Promise<Provider>
Parameters
- provider: ProviderInstance
- Optional listeners: ProviderListeners
Returns Promise<Provider>
Implementation of IProvider.init
- Defined in packages/w3p/src/provider.ts:83

onAccountChanged

onAccountChanged(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onAccountChanged
- Defined in packages/w3p/src/provider.ts:144

onBeforeTxSent

onBeforeTxSent(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onBeforeTxSent
- Defined in packages/w3p/src/provider.ts:168

onChainChanged

onChainChanged(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onChainChanged
- Defined in packages/w3p/src/provider.ts:148

onConnect

onConnect(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onConnect
- Defined in packages/w3p/src/provider.ts:152

onDisconnect

onDisconnect(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onDisconnect
- Defined in packages/w3p/src/provider.ts:156

onInitiated

onInitiated(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onInitiated
- Defined in packages/w3p/src/provider.ts:160

onTxConfirmed

onTxConfirmed(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onTxConfirmed
- Defined in packages/w3p/src/provider.ts:176

onTxSent

onTxSent(cb: ((e?: ProviderEventPayload) => void)): void
Parameters
- cb: ((e?: ProviderEventPayload) => void)
  - - (e?: ProviderEventPayload): void
    - Parameters
      
      Optional e: ProviderEventPayload
      
      Returns void
Returns void
Implementation of IProvider.onTxSent
- Defined in packages/w3p/src/provider.ts:172

signAndSendTx

signAndSendTx(txRequestBody: TxRequestBody): Promise<TransactionResponse>
Parameters
- txRequestBody: TxRequestBody
Returns Promise<TransactionResponse>
Implementation of IProvider.signAndSendTx
- Defined in packages/w3p/src/provider.ts:118

signMessage

signMessage(message: string): Promise<string>
Parameters
- message: string
Returns Promise<string>
Implementation of IProvider.signMessage
- Defined in packages/w3p/src/provider.ts:140

switchChain

switchChain(chainId: ChainId): Promise<void>
Parameters
- chainId: ChainId
Returns Promise<void>
Implementation of IProvider.switchChain
- Defined in packages/w3p/src/provider.ts:106

`Static` setChainsDetails

setChainsDetails(chains: Record<ChainId, Chain>): void
Parameters
- chains: Record<ChainId, Chain>
Returns void
- Defined in packages/w3p/src/provider.ts:114

Class Provider

Description

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

proxyConstructor: ProviderProxyConstructor

Returns Provider

Properties

Optional proxy

Readonly proxyConstructor

Optional selectedProvider

Static Optional chainsDetails

Accessors

address

Returns undefined | string

chainDetails

Returns undefined | Chain

chainId

Returns undefined | ChainId

chainType

Returns undefined | CHAIN_TYPES

isConnected

Returns boolean

providerType

Returns undefined | PROVIDERS

rawProvider

Returns undefined | RawProvider

Methods

addChain

Parameters

chain: Chain

Returns Promise<void>

clearHandlers

Returns void

connect

Returns Promise<void>

disconnect

Returns Promise<void>

getAddressUrl

Parameters

chain: Chain

address: string

Returns string

getHashFromTx

Parameters

txResponse: TransactionResponse

Returns string

getTxUrl

Parameters

chain: Chain

txHash: string

Returns string

init

Parameters

provider: ProviderInstance

Optional listeners: ProviderListeners

Returns Promise<Provider>

onAccountChanged

Parameters

cb: ((e?: ProviderEventPayload) => void)

Parameters

Optional e: ProviderEventPayload

Returns void

Returns void

onBeforeTxSent

Parameters

cb: ((e?: ProviderEventPayload) => void)

Parameters

Optional e: ProviderEventPayload

Returns void

Returns void

onChainChanged

`Optional` proxy

`Readonly` proxyConstructor

`Optional` selectedProvider

`Static` `Optional` chainsDetails

`Optional` listeners: ProviderListeners

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Static` setChainsDetails