Class MetamaskProvider

Description

Represents a Metamask wallet.

Example

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

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

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

Hierarchy

BaseEVMProvider
- MetamaskProvider

Implements

ProviderProxy

Index

Constructors

constructor

new MetamaskProvider(provider: RawProvider): MetamaskProvider
Parameters
- provider: RawProvider
Returns MetamaskProvider
Overrides BaseEVMProvider.constructor
- Defined in packages/w3p/src/providers/wrapped/metamask.ts:24

Properties

`Optional` address

address?: string

`Optional` chainId

chainId?: ChainId

`Readonly` emitter

emitter: EventEmitter<ProviderEventMap> = ...

`Readonly` provider

provider: Web3Provider

rawProvider

rawProvider: RawProvider

Accessors

chainType

get chainType(): CHAIN_TYPES
Returns CHAIN_TYPES
Implementation of ProviderProxy.chainType

Inherited from BaseEVMProvider.chainType
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:49

defaultEventPayload

get defaultEventPayload(): {
    address: undefined | string;
    chainId: undefined | ChainId;
    isConnected: boolean;
}
Returns {
    address: undefined | string;
    chainId: undefined | ChainId;
    isConnected: boolean;
}
- address: undefined | string
- chainId: undefined | ChainId
- isConnected: boolean
Inherited from BaseEVMProvider.defaultEventPayload
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:57

isConnected

get isConnected(): boolean
Returns boolean
Implementation of ProviderProxy.isConnected

Inherited from BaseEVMProvider.isConnected
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:53

`Static` providerType

get providerType(): PROVIDERS
Returns PROVIDERS
- Defined in packages/w3p/src/providers/wrapped/metamask.ts:28

Methods

addChain

addChain(chain: Chain): Promise<void>
Parameters
- chain: Chain
Returns Promise<void>
Implementation of ProviderProxy.addChain

Inherited from BaseEVMProvider.addChain
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:80

clearHandlers

clearHandlers(): void
Returns void
Implementation of ProviderProxy.clearHandlers

Inherited from BaseEVMProvider.clearHandlers
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:48

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of ProviderProxy.connect

Inherited from BaseEVMProvider.connect
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:84

emit

emit(event: PROVIDER_EVENT_BUS_EVENTS, payload: ProviderEventPayload): void
Parameters
- event: PROVIDER_EVENT_BUS_EVENTS
- payload: ProviderEventPayload
Returns void
Inherited from BaseEVMProvider.emit
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:9

getAddressUrl

getAddressUrl(chain: Chain, address: string): string
Parameters
- chain: Chain
- address: string
Returns string
Implementation of ProviderProxy.getAddressUrl

Inherited from BaseEVMProvider.getAddressUrl
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:88

getHashFromTx

getHashFromTx(txResponse: TransactionResponse): string
Parameters
- txResponse: TransactionResponse
Returns string
Implementation of ProviderProxy.getHashFromTx

Inherited from BaseEVMProvider.getHashFromTx
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:96

getTxUrl

getTxUrl(chain: Chain, txHash: string): string
Parameters
- chain: Chain
- txHash: string
Returns string
Implementation of ProviderProxy.getTxUrl

Inherited from BaseEVMProvider.getTxUrl
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:92

init

init(): Promise<void>
Returns Promise<void>
Implementation of ProviderProxy.init

Inherited from BaseEVMProvider.init
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:65

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 ProviderProxy.onAccountChanged

Inherited from BaseEVMProvider.onAccountChanged
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:40

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 ProviderProxy.onBeforeTxSent

Inherited from BaseEVMProvider.onBeforeTxSent
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:16

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 ProviderProxy.onChainChanged

Inherited from BaseEVMProvider.onChainChanged
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:44

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 ProviderProxy.onConnect

Inherited from BaseEVMProvider.onConnect
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:32

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 ProviderProxy.onDisconnect

Inherited from BaseEVMProvider.onDisconnect
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:36

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 ProviderProxy.onInitiated

Inherited from BaseEVMProvider.onInitiated
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:28

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 ProviderProxy.onTxConfirmed

Inherited from BaseEVMProvider.onTxConfirmed
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:24

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 ProviderProxy.onTxSent

Inherited from BaseEVMProvider.onTxSent
- Defined in packages/w3p/src/providers/wrapped/_event-bus.ts:20

setListeners

setListeners(): Promise<void>
Returns Promise<void>
Inherited from BaseEVMProvider.setListeners
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:126

signAndSendTx

signAndSendTx(tx: TxRequestBody): Promise<TransactionResponse>
Parameters
- tx: TxRequestBody
Returns Promise<TransactionResponse>
Implementation of ProviderProxy.signAndSendTx

Inherited from BaseEVMProvider.signAndSendTx
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:101

signMessage

signMessage(message: string): Promise<string>
Parameters
- message: string
Returns Promise<string>
Implementation of ProviderProxy.signMessage

Inherited from BaseEVMProvider.signMessage
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:122

switchChain

switchChain(chainId: ChainId): Promise<void>
Parameters
- chainId: ChainId
Returns Promise<void>
Implementation of ProviderProxy.switchChain

Inherited from BaseEVMProvider.switchChain
- Defined in packages/w3p/src/providers/wrapped/_base-evm.ts:76

Class MetamaskProvider

Description

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

provider: RawProvider

Returns MetamaskProvider

Properties

Optional address

Optional chainId

Readonly emitter

Readonly provider

rawProvider

Accessors

chainType

Returns CHAIN_TYPES

defaultEventPayload

Returns { address: undefined | string; chainId: undefined | ChainId; isConnected: boolean; }

address: undefined | string

chainId: undefined | ChainId

isConnected: boolean

isConnected

Returns boolean

Static providerType

Returns PROVIDERS

Methods

addChain

Parameters

chain: Chain

Returns Promise<void>

clearHandlers

Returns void

connect

Returns Promise<void>

emit

Parameters

event: PROVIDER_EVENT_BUS_EVENTS

payload: ProviderEventPayload

Returns void

getAddressUrl

Parameters

chain: Chain

address: string

Returns string

getHashFromTx

Parameters

txResponse: TransactionResponse

Returns string

getTxUrl

Parameters

chain: Chain

txHash: string

Returns string

init

Returns Promise<void>

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

Parameters

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

`Optional` address

`Optional` chainId

`Readonly` emitter

`Readonly` provider

Returns {
address: undefined | string;
chainId: undefined | ChainId;
isConnected: boolean;
}

`Static` providerType

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload

`Optional` e: ProviderEventPayload