Class Web3ModalV2Connector

Hierarchy

Web3ModalV2Connector

Implements

ArnConnector

Constructors

constructor

new Web3ModalV2Connector(options: Web3ModalV2ConnectorOpts): Web3ModalV2Connector
Parameters
- options: Web3ModalV2ConnectorOpts
Returns Web3ModalV2Connector
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:77

Properties

`Private` `Readonly` desktopBehaviorOpts

desktopBehaviorOpts: Web3ModalV2DesktopBehaviorOpts

`Private` desktopWalletsInjectorInt

desktopWalletsInjectorInt: null | Timeout = null

`Protected` `Readonly` ethereumClient

ethereumClient: EthereumClient

isConnected

isConnected: boolean = false

`Private` modalInjectorInt

modalInjectorInt: null | Timeout = null

`Optional` provider

provider?: Web3Provider

`Private` qrInjectorInt

qrInjectorInt: null | Timeout = null

`Private` `Readonly` removeDesktopWallets

removeDesktopWallets: boolean = false

`Private` updateQR

updateQR: UpdateQrFunction = ...

`Private` updateQRChoice

updateQRChoice: UpdateQrFunction = ...

`Private` userChoice

userChoice: null | Web3ModalV2DesktopBehaviorMode = null

`Protected` uuid

uuid: undefined | string

`Protected` `Readonly` wagmiClient

wagmiClient: Client<Object, WebSocketProvider>

`Protected` wagmiPrefixKey

wagmiPrefixKey: string

`Protected` `Readonly` web3Modal

web3Modal: Web3Modal

`Static` `Readonly` DEFAULT_WAGMI_PREFIX_KEY

DEFAULT_WAGMI_PREFIX_KEY: "wagmi" = 'wagmi'

`Static` `Readonly` W3M_RECENT_WALLET

W3M_RECENT_WALLET: "W3M_RECENT_WALLET" = 'W3M_RECENT_WALLET'

`Static` `Readonly` WALLETCONNECT_DEEPLINK_CHOICE_KEY

WALLETCONNECT_DEEPLINK_CHOICE_KEY: "WALLETCONNECT_DEEPLINK_CHOICE" = 'WALLETCONNECT_DEEPLINK_CHOICE'

`Static` `Readonly` WALLETCONNECT_KEY

WALLETCONNECT_KEY: "walletconnect" = 'walletconnect'

`Static` `Private` `Readonly` qrChoiceStyle

qrChoiceStyle: "\n .arn-wc-button {\n width: 100%;\n appearance: none;\n background-color: inherit;\n border-radius: 0.5em;\n border: 1.5px solid var(--w3m-color-fg-3);\n cursor: pointer;\n display: block;\n }\n .arn-wc-button:hover {\n background-color: var(--w3m-color-bg-2);\n }\n .arn-wc-primary {\n margin-bottom: 0.5em;\n font-weight: 600;\n padding: 2em;\n }\n .arn-wc-secondary {\n margin-top: 0.5em;\n padding: 1em;\n }\n .arn-wc-text {\n color: var(--w3m-color-fg-1);\n display: block;\n margin-top: 0.5em;\n }\n .arn-wc-content {\n --contentMargin: 0;\n --contentMaxWidth: 100%;\n --imageMaxWidth: 120px;\n width: 100%;\n padding: var(--contentMargin);\n background-color: var(--w3m-color-bg-1);\n display: flex;\n flex-wrap: wrap;\n align-items: center;\n align-content: space-around;\n justify-content: space-evenly;\n }\n .arn-wc-content {\n max-width: var(--contentMaxWidth);\n }\n .arn-wc-image {\n max-width: var(--imageMaxWidth);\n display: flex;\n justify-content: space-evenly;\n align-items: center;\n border-radius: 0.5em;\n margin: auto;\n }\n .arn-wc-image img,\n .arn-wc-image picture {\n border-radius: 0.5em;\n width: 100%;\n }\n .arn-wc-secondary .arn-wc-image {\n width: 60px;\n padding: 8px;\n height: 60px;\n background-color: rgb(88,132,233);\n }\n " = ...

Methods

`Private` attachDesktopWalletInjector

attachDesktopWalletInjector(ms?: number): Timeout
Create an interval to remove the w3m-modal-footer element

Returns
Interval id to be cleared if needed
Parameters
- ms: number = 200
  
  Optional interval time in ms (default: 200)
Returns Timeout
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:684

`Private` attachModalInjector

attachModalInjector(ms?: number): Timeout
Create an interval to alter the w3m-modal-toast open attribute

Returns
Interval id to be cleared if needed
Parameters
- ms: number = 100
  
  Optional interval time in ms (default: 100)
Returns Timeout
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:708

`Private` attachQRInjector

attachQRInjector(universalLink: string, updateQrFn: UpdateQrFunction, logoSrc?: string, logoSrc_dark?: undefined | string, autoClear?: boolean, ms?: number): Timeout
Create an interval to alter the w3m-qrcode uri and logoSrc attributes

Returns
Interval id to be cleared if needed
Parameters
- universalLink: string
  
  Universal link to append before the wc uri (e.g. https://arian.ee/wc?uri=)
- updateQrFn: UpdateQrFunction
- Optional logoSrc: string
  
  Logo to set
- logoSrc_dark: undefined | string = logoSrc
  
  Optional dark logo to set (default: fallback to logoSrc)
- autoClear: boolean = false
  
  If true, the interval will be cleared when the uri attribute is set
- ms: number = 200
  
  Optional interval time in ms (default: 200)
Returns Timeout
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:538

`Protected` checkConnected

checkConnected(): Promise<void>
Returns Promise<void>
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:374

`Private` clearIntervals

clearIntervals(): void
Returns void
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:357

connect

connect(): Promise<string>
Returns Promise<string>
Implementation of ArnConnector.connect
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:213

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of ArnConnector.disconnect
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:474

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Implementation of ArnConnector.getAddress
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:455

getAuthMessage

getAuthMessage(): Promise<string>
Returns Promise<string>
Implementation of ArnConnector.getAuthMessage
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:451

getChainId

getChainId(): Promise<number>
Returns Promise<number>
Implementation of ArnConnector.getChainId
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:460

`Private` getRelativeQuerySelector

getRelativeQuerySelector(query?: string): string
Parameters
- Optional query: string
Returns string
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:675

`Private` getWeb3Provider

getWeb3Provider(data: any): Web3Provider
Extract the Web3Provider from the client data

Returns
Web3Provider
Parameters
- data: any
  
  Wagmi client data
Returns Web3Provider
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:519

`Protected` log

log(...data: any[]): void
Parameters
- Rest ...data: any[]
Returns void
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:73

onConnectFromCache

onConnectFromCache(): Promise<void>
Returns Promise<void>
Implementation of ArnConnector.onConnectFromCache
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:348

`Private` `Readonly` qrChoiceHtml

qrChoiceHtml(primaryText?: string, secondaryText?: string, primaryLogoUrl?: string, primaryLogoUrl_dark?: string): string
Parameters
- Optional primaryText: string
- Optional secondaryText: string
- Optional primaryLogoUrl: string
- Optional primaryLogoUrl_dark: string
Returns string
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:894

`Protected` removeWeb3ModalUI

removeWeb3ModalUI(querySelector?: string): void
Remove the current Web3Modal UI from the DOM
Parameters
- querySelector: string = ...
Returns void
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:496

sendTransaction

sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>
Parameters
- transaction: Deferrable<TransactionRequest>
Returns Promise<TransactionResponse>
Implementation of ArnConnector.sendTransaction
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:425

sendUncheckedTransaction

sendUncheckedTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>
Parameters
- transaction: Deferrable<TransactionRequest>
Returns Promise<string>
Implementation of ArnConnector.sendUncheckedTransaction
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:437

signMessage

signMessage(message: string): Promise<string>
Parameters
- message: string
Returns Promise<string>
Implementation of ArnConnector.signMessage
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:381

signTransaction

signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>
Parameters
- transaction: Deferrable<TransactionRequest>
Returns Promise<string>
Implementation of ArnConnector.signTransaction
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:411

signTypedData

signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>): Promise<string>
Parameters
- domain: TypedDataDomain
- types: Record<string, TypedDataField[]>
- value: Record<string, any>
Returns Promise<string>
Implementation of ArnConnector.signTypedData
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:393

switchChain

switchChain(chainId: number): Promise<void>
Parameters
- chainId: number
Returns Promise<void>
Implementation of ArnConnector.switchChain
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:465

`Static` clearCache

clearCache(wagmiPrefixKey: string): void
Override the window.open function to intercept all universal links opening and force them to be opened in a new window After some time, the window is closed if still open (to prevent user misundertanding)
Parameters
- wagmiPrefixKey: string
Returns void
- Defined in packages/arn-client/src/auth/connector/web3modal-v2/Web3ModalV2Connector.ts:814

Class Web3ModalV2Connector

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Web3ModalV2ConnectorOpts

Returns Web3ModalV2Connector

Properties

Private Readonly desktopBehaviorOpts

Private desktopWalletsInjectorInt

Protected Readonly ethereumClient

isConnected

Private modalInjectorInt

Optional provider

Private qrInjectorInt

Private Readonly removeDesktopWallets

Private updateQR

Private updateQRChoice

Private userChoice

Protected uuid

Protected Readonly wagmiClient

Protected wagmiPrefixKey

Protected Readonly web3Modal

Static Readonly DEFAULT_WAGMI_PREFIX_KEY

Static Readonly W3M_RECENT_WALLET

Static Readonly WALLETCONNECT_DEEPLINK_CHOICE_KEY

Static Readonly WALLETCONNECT_KEY

Static Private Readonly qrChoiceStyle

Methods

Private attachDesktopWalletInjector

Returns

Parameters

ms: number = 200

Returns Timeout

Private attachModalInjector

Returns

Parameters

ms: number = 100

Returns Timeout

Private attachQRInjector

Returns

Parameters

universalLink: string

updateQrFn: UpdateQrFunction

Optional logoSrc: string

logoSrc_dark: undefined | string = logoSrc

autoClear: boolean = false

ms: number = 200

Returns Timeout

Protected checkConnected

Returns Promise<void>

Private clearIntervals

Returns void

connect

Returns Promise<string>

disconnect

Returns Promise<void>

getAddress

Returns Promise<string>

getAuthMessage

Returns Promise<string>

getChainId

Returns Promise<number>

Private getRelativeQuerySelector

Parameters

Optional query: string

Returns string

Private getWeb3Provider

Returns

Parameters

data: any

Returns Web3Provider

Protected log

Parameters

Rest ...data: any[]

`Private` `Readonly` desktopBehaviorOpts

`Private` desktopWalletsInjectorInt

`Protected` `Readonly` ethereumClient

`Private` modalInjectorInt

`Optional` provider

`Private` qrInjectorInt

`Private` `Readonly` removeDesktopWallets

`Private` updateQR

`Private` updateQRChoice

`Private` userChoice

`Protected` uuid

`Protected` `Readonly` wagmiClient

`Protected` wagmiPrefixKey

`Protected` `Readonly` web3Modal

`Static` `Readonly` DEFAULT_WAGMI_PREFIX_KEY

`Static` `Readonly` W3M_RECENT_WALLET

`Static` `Readonly` WALLETCONNECT_DEEPLINK_CHOICE_KEY

`Static` `Readonly` WALLETCONNECT_KEY

`Static` `Private` `Readonly` qrChoiceStyle

`Private` attachDesktopWalletInjector

`Private` attachModalInjector

`Private` attachQRInjector

`Optional` logoSrc: string

`Protected` checkConnected

`Private` clearIntervals

`Private` getRelativeQuerySelector

`Optional` query: string

`Private` getWeb3Provider

`Protected` log

`Rest` ...data: any[]

`Private` `Readonly` qrChoiceHtml

`Optional` primaryText: string

`Optional` secondaryText: string

`Optional` primaryLogoUrl: string

`Optional` primaryLogoUrl_dark: string

`Protected` removeWeb3ModalUI

`Static` clearCache