Class WalletConnectorFrame

Connect to wallet as iframe/web-extension

Hierarchy (View Summary)

default<EventsNetworkId>
- WalletConnectorFrame

Index

Constructors

Accessors

accounts isConnected networkId

Methods

_updateNetwork askToSelectNetwork disconnect getAccounts subscribeAccounts _connect connect

Constructors

`Protected`constructor

new WalletConnectorFrame(): WalletConnectorFrame
Returns WalletConnectorFrame
Inherited from default.constructor
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:49

Accessors

accounts

get accounts(): default[]
Accounts provided by wallet over subscription

Returns default[]
Inherited from WalletConnectorFrameBase.accounts
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:45

isConnected

get isConnected(): boolean
Is connected to wallet

Returns boolean
Inherited from WalletConnectorFrameBase.isConnected
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:36

networkId

get networkId(): string
The last network id reported by wallet

Returns string
- Defined in aepp-wallet-communication/WalletConnectorFrame.ts:19

Methods

`Protected`_updateNetwork

_updateNetwork(params: Network): void
Parameters
- params: Network
Returns void
Overrides default._updateNetwork
- Defined in aepp-wallet-communication/WalletConnectorFrame.ts:23

askToSelectNetwork

askToSelectNetwork(network: NetworkToSelect): Promise<void>
Ask wallet to select a network
Parameters
- network: NetworkToSelect
Returns Promise<void>
Inherited from default.askToSelectNetwork
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:133

disconnect

disconnect(): void
Disconnect from wallet

Returns void
Inherited from default.disconnect
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:100

getAccounts

getAccounts(): Promise<default[]>
Request accounts from wallet

Returns Promise<default[]>
Inherited from default.getAccounts
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:109

subscribeAccounts

subscribeAccounts(
type: SUBSCRIPTION_TYPES,
value: "connected" | "current",
): Promise<default[]>
Subscribe for wallet accounts, get account updates adding handler to accountsChange event
Parameters
- type: SUBSCRIPTION_TYPES
  Subscription type
- value: "connected" | "current"
  Should be one of 'current' (the selected account), 'connected' (all)
Returns Promise<default[]>
Accounts from wallet
Inherited from default.subscribeAccounts
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:121

`Static`_connect

_connect(
    name: string,
    connection: default,
    connector: default<any>,
    connectNode: boolean,
): Promise<void>
Parameters
- name: string
- connection: default
- connector: default<any>
- connectNode: boolean
Returns Promise<void>
Inherited from default._connect
- Defined in aepp-wallet-communication/WalletConnectorFrameBase.ts:63

`Static`connect

connect(name: string, connection: default): Promise<WalletConnectorFrame>
Connect to wallet
Parameters
- name: string
  Aepp name
- connection: default
  Wallet connection object
Returns Promise<WalletConnectorFrame>
- Defined in aepp-wallet-communication/WalletConnectorFrame.ts:33