@disco3/react | v0.0.16

Index

Modules

"eth-provider"

Classes

Interfaces

Type aliases

Variables

useStore

Functions

Object literals

DEFAULT_STATE

Type aliases

Account

Account: string

ConnectWallet

ConnectWallet: (opts?: Partial<ICoreOptions>) => Promise<State>

Type declaration

- (opts?: Partial<ICoreOptions>): Promise<State>
- Parameters
  - Optional opts: Partial<ICoreOptions>
  Returns Promise<State>

DisconnectWallet

DisconnectWallet: () => void

Type declaration

- (): void
- Returns void

FrameProvider

FrameProvider: (a: "frame", b?: FrameConnectorArguments) => Provider

Type declaration

- (a: "frame", b?: FrameConnectorArguments): Provider
- Parameters
  - a: "frame"
  - Optional b: FrameConnectorArguments
  Returns Provider

State

State: { account: Account; network: Network; provider: Web3Provider; web3Modal: Web3Modal }

Type declaration

account: Account
network: Network
provider: Web3Provider
web3Modal: Web3Modal

UseWallet

UseWallet: () => Partial<State> & { connect: ConnectWallet; disconnect: DisconnectWallet }

Type declaration

- (): Partial<State> & { connect: ConnectWallet; disconnect: DisconnectWallet }
- Returns Partial<State> & { connect: ConnectWallet; disconnect: DisconnectWallet }

Web3ReactHooks

Web3ReactHooks: ReturnType<typeof getStateHooks> & ReturnType<typeof getDerivedHooks> & ReturnType<typeof getAugmentedHooks>

Web3ReactPriorityHooks

Web3ReactPriorityHooks: ReturnType<typeof getPriorityConnector>

Web3ReactSelectedHooks

Web3ReactSelectedHooks: ReturnType<typeof getSelectedConnector>

Web3ReactStateUpdate

Web3ReactStateUpdate: { accounts: string[]; chainId: number } | { accounts?: undefined; chainId: number } | { accounts: string[]; chainId?: undefined }

Web3ReactStore

Web3ReactStore: StoreApi<Web3ReactState>

url

url: string | ConnectionInfo

Variables

Const useStore

useStore: UseBoundStore<Partial<State>, StoreApi<Partial<State>>> = create<Partial<State>>((_set) => ({web3Modal: typeof window !== 'undefined' ? new Web3Modal() : undefined,}))

Functions

Const ACCOUNTS

ACCOUNTS(state: Web3ReactState): undefined | string[]

- Defined in packages/core/src/index.ts:245
Parameters
- state: Web3ReactState
Returns undefined | string[]

Const ACCOUNTS_EQUALITY_CHECKER

ACCOUNTS_EQUALITY_CHECKER(oldAccounts: undefined | string[], newAccounts: undefined | string[]): boolean

- Defined in packages/core/src/index.ts:246
Parameters
- oldAccounts: undefined | string[]
- newAccounts: undefined | string[]
Returns boolean

Const ACTIVATING

ACTIVATING(state: Web3ReactState): boolean

- Defined in packages/core/src/index.ts:251
Parameters
- state: Web3ReactState
Returns boolean

Const CHAIN_ID

CHAIN_ID(state: Web3ReactState): undefined | number

- Defined in packages/core/src/index.ts:244
Parameters
- state: Web3ReactState
Returns undefined | number

Const ERROR

ERROR(state: Web3ReactState): undefined | Error

- Defined in packages/core/src/index.ts:252
Parameters
- state: Web3ReactState
Returns undefined | Error

computeIsActive

computeIsActive(__namedParameters: { accounts: undefined | string[]; activating: boolean; chainId: undefined | number; error: undefined | Error }): boolean

- Defined in packages/core/src/index.ts:50
Parameters
- __namedParameters: { accounts: undefined | string[]; activating: boolean; chainId: undefined | number; error: undefined | Error }
  - accounts: undefined | string[]
  - activating: boolean
  - chainId: undefined | number
  - error: undefined | Error
Returns boolean

createWeb3ReactStoreAndActions

createWeb3ReactStoreAndActions(allowedChainIds?: number[]): [Web3ReactStore, Actions]

- Defined in packages/store/src/index.ts:51
Parameters
- Optional allowedChainIds: number[]
Returns [Web3ReactStore, Actions]

ensureChainIdIsAllowed

ensureChainIdIsAllowed(chainId: number, allowedChainIds: number[]): ChainIdNotAllowedError | undefined

- Defined in packages/store/src/index.ts:31
Parameters
- chainId: number
- allowedChainIds: number[]
Returns ChainIdNotAllowedError | undefined

getAugmentedHooks

getAugmentedHooks<T>(connector: T, __namedParameters: { useAccounts: useAccounts; useChainId: useChainId; useError: useError }, __namedParameters: { useAccount: useAccount; useIsActive: useIsActive }): { useENSName: useENSName; useENSNames: useENSNames; useProvider: useProvider; useWeb3React: useWeb3React }

- Defined in packages/core/src/index.ts:323
Type parameters
- T: Connector
Parameters
- connector: T
- __namedParameters: { useAccounts: useAccounts; useChainId: useChainId; useError: useError }
  - useAccounts: useAccounts
  - useChainId: useChainId
  - useError: useError
- __namedParameters: { useAccount: useAccount; useIsActive: useIsActive }
  - useAccount: useAccount
  - useIsActive: useIsActive
Returns { useENSName: useENSName; useENSNames: useENSNames; useProvider: useProvider; useWeb3React: useWeb3React }
- useENSName: useENSName
- useENSNames: useENSNames
- useProvider: useProvider
- useWeb3React: useWeb3React

getDerivedHooks

getDerivedHooks(__namedParameters: { useAccounts: useAccounts; useChainId: useChainId; useError: useError; useIsActivating: useIsActivating }): { useAccount: useAccount; useIsActive: useIsActive }

- Defined in packages/core/src/index.ts:274
Parameters
- __namedParameters: { useAccounts: useAccounts; useChainId: useChainId; useError: useError; useIsActivating: useIsActivating }
  - useAccounts: useAccounts
  - useChainId: useChainId
  - useError: useError
  - useIsActivating: useIsActivating
Returns { useAccount: useAccount; useIsActive: useIsActive }
- useAccount: useAccount
- useIsActive: useIsActive

getPriorityConnector

getPriorityConnector(...initializedConnectors: [Connector, Web3ReactHooks][]): { usePriorityAccount: usePriorityAccount; usePriorityAccounts: usePriorityAccounts; usePriorityChainId: usePriorityChainId; usePriorityConnector: usePriorityConnector; usePriorityENSName: usePriorityENSName; usePriorityENSNames: usePriorityENSNames; usePriorityError: usePriorityError; usePriorityIsActivating: usePriorityIsActivating; usePriorityIsActive: usePriorityIsActive; usePriorityProvider: usePriorityProvider; usePriorityWeb3React: usePriorityWeb3React; useSelectedAccount: useSelectedAccount; useSelectedAccounts: useSelectedAccounts; useSelectedChainId: useSelectedChainId; useSelectedENSName: useSelectedENSName; useSelectedENSNames: useSelectedENSNames; useSelectedError: useSelectedError; useSelectedIsActivating: useSelectedIsActivating; useSelectedIsActive: useSelectedIsActive; useSelectedProvider: useSelectedProvider; useSelectedWeb3React: useSelectedWeb3React }

- Defined in packages/core/src/index.ts:158
Creates a variety of convenience hooks that return data associated with the first of the initializedConnectors that is active.

Parameters
- Rest ...initializedConnectors: [Connector, Web3ReactHooks][]
  
  Two or more [connector, hooks] arrays, as returned from initializeConnector.
Returns { usePriorityAccount: usePriorityAccount; usePriorityAccounts: usePriorityAccounts; usePriorityChainId: usePriorityChainId; usePriorityConnector: usePriorityConnector; usePriorityENSName: usePriorityENSName; usePriorityENSNames: usePriorityENSNames; usePriorityError: usePriorityError; usePriorityIsActivating: usePriorityIsActivating; usePriorityIsActive: usePriorityIsActive; usePriorityProvider: usePriorityProvider; usePriorityWeb3React: usePriorityWeb3React; useSelectedAccount: useSelectedAccount; useSelectedAccounts: useSelectedAccounts; useSelectedChainId: useSelectedChainId; useSelectedENSName: useSelectedENSName; useSelectedENSNames: useSelectedENSNames; useSelectedError: useSelectedError; useSelectedIsActivating: useSelectedIsActivating; useSelectedIsActive: useSelectedIsActive; useSelectedProvider: useSelectedProvider; useSelectedWeb3React: useSelectedWeb3React }

hooks - A variety of convenience hooks that wrap the hooks returned from initializeConnector.
- usePriorityAccount: usePriorityAccount
- usePriorityAccounts: usePriorityAccounts
- usePriorityChainId: usePriorityChainId
- usePriorityConnector: usePriorityConnector
- usePriorityENSName: usePriorityENSName
- usePriorityENSNames: usePriorityENSNames
- usePriorityError: usePriorityError
- usePriorityIsActivating: usePriorityIsActivating
- usePriorityIsActive: usePriorityIsActive
- usePriorityProvider: usePriorityProvider
- usePriorityWeb3React: usePriorityWeb3React
- useSelectedAccount: useSelectedAccount
- useSelectedAccounts: useSelectedAccounts
- useSelectedChainId: useSelectedChainId
- useSelectedENSName: useSelectedENSName
- useSelectedENSNames: useSelectedENSNames
- useSelectedError: useSelectedError
- useSelectedIsActivating: useSelectedIsActivating
- useSelectedIsActive: useSelectedIsActive
- useSelectedProvider: useSelectedProvider
- useSelectedWeb3React: useSelectedWeb3React

getSelectedConnector

getSelectedConnector(...initializedConnectors: [Connector, Web3ReactHooks][]): { useSelectedAccount: useSelectedAccount; useSelectedAccounts: useSelectedAccounts; useSelectedChainId: useSelectedChainId; useSelectedENSName: useSelectedENSName; useSelectedENSNames: useSelectedENSNames; useSelectedError: useSelectedError; useSelectedIsActivating: useSelectedIsActivating; useSelectedIsActive: useSelectedIsActive; useSelectedProvider: useSelectedProvider; useSelectedWeb3React: useSelectedWeb3React }

- Defined in packages/core/src/index.ts:60
Creates a variety of convenience hooks that return data associated with a particular passed connector.

Parameters
- Rest ...initializedConnectors: [Connector, Web3ReactHooks][]
  
  Two or more [connector, hooks] arrays, as returned from initializeConnector.
Returns { useSelectedAccount: useSelectedAccount; useSelectedAccounts: useSelectedAccounts; useSelectedChainId: useSelectedChainId; useSelectedENSName: useSelectedENSName; useSelectedENSNames: useSelectedENSNames; useSelectedError: useSelectedError; useSelectedIsActivating: useSelectedIsActivating; useSelectedIsActive: useSelectedIsActive; useSelectedProvider: useSelectedProvider; useSelectedWeb3React: useSelectedWeb3React }

hooks - A variety of convenience hooks that wrap the hooks returned from initializeConnector.
- useSelectedAccount: useSelectedAccount
- useSelectedAccounts: useSelectedAccounts
- useSelectedChainId: useSelectedChainId
- useSelectedENSName: useSelectedENSName
- useSelectedENSNames: useSelectedENSNames
- useSelectedError: useSelectedError
- useSelectedIsActivating: useSelectedIsActivating
- useSelectedIsActive: useSelectedIsActive
- useSelectedProvider: useSelectedProvider
- useSelectedWeb3React: useSelectedWeb3React

getStateHooks

getStateHooks(useConnector: UseBoundStore<Web3ReactState>): { useAccounts: useAccounts; useChainId: useChainId; useError: useError; useIsActivating: useIsActivating }

- Defined in packages/core/src/index.ts:254
Parameters
- useConnector: UseBoundStore<Web3ReactState>
Returns { useAccounts: useAccounts; useChainId: useChainId; useError: useError; useIsActivating: useIsActivating }
- useAccounts: useAccounts
- useChainId: useChainId
- useError: useError
- useIsActivating: useIsActivating

initializeConnector

initializeConnector<T>(f: (actions: Actions) => T, allowedChainIds?: number[]): [T, Web3ReactHooks, Web3ReactStore]

- Defined in packages/core/src/index.ts:34
Wraps the initialization of a connector. Creates a zustand store with actions bound to it, and then passes these to the connector as specified in f. Also creates a variety of hooks bound to this store.

Type parameters
- T: Connector
  
  The type of the connector returned from f.
Parameters
- f: (actions: Actions) => T
  
  A function which is called with actions bound to the returned store.
  - - (actions: Actions): T
    - Parameters
      - actions: Actions
      Returns T
- Optional allowedChainIds: number[]
  
  An optional array of chainIds which the connector may connect to. If the connector is connected to a chainId which is not allowed, a ChainIdNotAllowedError error will be reported. If this argument is unspecified, the connector may connect to any chainId.
Returns [T, Web3ReactHooks, Web3ReactStore]
- The initialized connector, a variety of hooks, and a zustand store.

parseChainId

parseChainId(chainId: string): number

- Defined in packages/eip1193/src/index.ts:9
Parameters
- chainId: string
Returns number

useENS

useENS(provider?: Web3Provider, accounts?: string[]): (string | null)[] | undefined

- Defined in packages/core/src/index.ts:296
Parameters
- Optional provider: Web3Provider
- Optional accounts: string[]
Returns (string | null)[] | undefined

Const useWallet

useWallet(): { account: undefined | string; connect: ConnectWallet; disconnect: DisconnectWallet; network: undefined | Network; provider: undefined | Web3Provider; web3Modal: undefined | Core }

- Defined in packages/connect-wallet/src/index.ts:26
Returns { account: undefined | string; connect: ConnectWallet; disconnect: DisconnectWallet; network: undefined | Network; provider: undefined | Web3Provider; web3Modal: undefined | Core }
- account: undefined | string
- connect: ConnectWallet
- disconnect: DisconnectWallet
- network: undefined | Network
- provider: undefined | Web3Provider
- web3Modal: undefined | Core

validateAccount

validateAccount(account: string): string

- Defined in packages/store/src/index.ts:40
Parameters
- account: string
Returns string

validateChainId

validateChainId(chainId: number): void

- Defined in packages/store/src/index.ts:10
Parameters
- chainId: number
Returns void

Object literals

Const DEFAULT_STATE

DEFAULT_STATE: object

accounts

accounts: undefined = undefined

activating

activating: boolean = false

chainId

chainId: undefined = undefined

error

error: undefined = undefined

Generated using TypeDoc

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Account

ConnectWallet

Type declaration

Parameters

Optional opts: Partial<ICoreOptions>

Returns Promise<State>

DisconnectWallet

Type declaration

Returns void

FrameProvider

Type declaration

Parameters

a: "frame"

Optional b: FrameConnectorArguments

Returns Provider

State

Type declaration

account: Account

network: Network

provider: Web3Provider

web3Modal: Web3Modal

UseWallet

Type declaration

Returns Partial<State> & { connect: ConnectWallet; disconnect: DisconnectWallet }

Web3ReactHooks

Web3ReactPriorityHooks

Web3ReactSelectedHooks

Web3ReactStateUpdate

Web3ReactStore

url

Variables

Const useStore

Functions

Const ACCOUNTS

Parameters

state: Web3ReactState

Returns undefined | string[]

Const ACCOUNTS_EQUALITY_CHECKER

Parameters

oldAccounts: undefined | string[]

newAccounts: undefined | string[]

Returns boolean

Const ACTIVATING

Parameters

state: Web3ReactState

Returns boolean

Const CHAIN_ID

Parameters

state: Web3ReactState

Returns undefined | number

Const ERROR

Parameters

state: Web3ReactState

Returns undefined | Error

computeIsActive

Parameters

__namedParameters: { accounts: undefined | string[]; activating: boolean; chainId: undefined | number; error: undefined | Error }

accounts: undefined | string[]

activating: boolean

chainId: undefined | number

error: undefined | Error

Returns boolean

createWeb3ReactStoreAndActions

Parameters

Optional allowedChainIds: number[]

Returns [Web3ReactStore, Actions]

ensureChainIdIsAllowed

Parameters

chainId: number

allowedChainIds: number[]

Returns ChainIdNotAllowedError | undefined