Class BladeConnector

Hierarchy

BladeConnector

Implements

IConnector

Index

Constructors

Properties

Accessors

Methods

createSession getSigners isInitialized killSession onSessionDisconnect onSessionExpire onWalletLocked onWalletUnlocked init

Constructors

`Private` constructor

new BladeConnector(strategy): BladeConnector
Parameters
- strategy: BaseConnectorStrategy
Returns BladeConnector
- Defined in src/connector.ts:19

Properties

`Private` `Readonly` strategy

strategy: BaseConnectorStrategy

Accessors

initialized

get initialized(): boolean
Checks if the underlying strategy is initialized.

Returns boolean
Implementation of IConnector.initialized
- Defined in src/connector.ts:127

Methods

createSession

createSession(params?): Promise<string[]>
Triggers the process of pairing with the Blade Wallet. If there is the Blade Wallet extension, wallet user will be asked to select accounts to pair. If there is no extension, QR code modal will be shown.
Parameters
- Optional params: SessionParams
  
  Params to create a session with. Optional for testing
Returns Promise<string[]>
Implementation of IConnector.createSession
- Defined in src/connector.ts:111

getSigners

getSigners(): BladeSigner[]
Returns all the signers approved for the current session.

Returns BladeSigner[]
Implementation of IConnector.getSigners
- Defined in src/connector.ts:58

`Private` isInitialized

isInitialized(skipWake?): Promise<boolean>
Parameters
- Optional skipWake: boolean
Returns Promise<boolean>
- Defined in src/connector.ts:11

killSession

killSession(): Promise<void>
Closes an active session and removes all the event subscriptions.

Returns Promise<void>
Implementation of IConnector.killSession
- Defined in src/connector.ts:119

onSessionDisconnect

onSessionDisconnect(callback): void
Executes a given callback when the session has been disconnected.
Parameters
- callback: (() => void)
  
  Callback to execute
  - - (): void
    - Returns void
Returns void
Implementation of IConnector.onSessionDisconnect
- Defined in src/connector.ts:91

onSessionExpire

onSessionExpire(callback): void
Executes a given callback when the session has expired.
Parameters
- callback: (() => void)
  
  Callback to execute
  - - (): void
    - Returns void
Returns void
Implementation of IConnector.onSessionExpire
- Defined in src/connector.ts:100

onWalletLocked

onWalletLocked(callback): Promise<void>
Executes a given callback when the wallet is locked.
Parameters
- callback: (() => void)
  
  Callback to execute
  - - (): void
    - Returns void
Returns Promise<void>
Implementation of IConnector.onWalletLocked
- Defined in src/connector.ts:81

onWalletUnlocked

onWalletUnlocked(callback): Promise<void>
Executes a given callback when the wallet is unlocked.
Parameters
- callback: (() => void)
  
  Callback to execute
  - - (): void
    - Returns void
Returns Promise<void>
Implementation of IConnector.onWalletUnlocked
- Defined in src/connector.ts:71

`Static` `Private` init

init(preferredStrategy, meta?, projectId?): Promise<BladeConnector>
Private
Initializes connector with the underlying strategy with a given preferredStrategy.
Parameters
- preferredStrategy: ConnectorStrategy
  
  preferred strategy to use
- Optional meta: Metadata
  
  dApp metadata to pass to Wallet Connect
- Optional projectId: string
  
  dApp WC project ID, default one is a Blade Wallet project ID
Returns Promise<BladeConnector>
- Defined in src/connector.ts:29

Generated using TypeDoc