Class WalletManager<WalletMetadata, AccountMetadata>

Helper class for background scripts using wallet manager. Uses wallet and store factories to create wallets. Keeps track of created stores and reuses them when a wallet is reactivated.

Type Parameters

WalletMetadata extends {
name: string;
}
AccountMetadata extends {
name: string;
}

Hierarchy

WalletManager

Implements

WalletManagerApi

Constructors

constructor

new WalletManager<WalletMetadata, AccountMetadata>(__namedParameters: WalletManagerProps, __namedParameters: MessengerDependencies & WalletManagerDependencies<WalletMetadata, AccountMetadata>): WalletManager<WalletMetadata, AccountMetadata>
Type Parameters
- WalletMetadata extends {
  name: string;
  }
- AccountMetadata extends {
  name: string;
  }
Parameters
- __namedParameters: WalletManagerProps
- __namedParameters: MessengerDependencies & WalletManagerDependencies<WalletMetadata, AccountMetadata>
Returns WalletManager<WalletMetadata, AccountMetadata>
- Defined in packages/web-extension/src/walletManager/walletManager.ts:76

Properties

`Private` #activeWalletProps

#activeWalletProps: null | WalletManagerActivateProps<string, unknown> = null

`Private` #logger

#logger: Logger

`Private` #managerStorage

#managerStorage: StorageArea

`Private` #managerStorageKey

#managerStorageKey: string

`Private` #signingCoordinatorApi

#signingCoordinatorApi: SigningCoordinatorSignApi<WalletMetadata, AccountMetadata>

`Private` #storesFactory

#storesFactory: StoresFactory

`Private` #walletFactory

#walletFactory: WalletFactory<WalletMetadata, AccountMetadata>

`Private` #walletRepository

#walletRepository: WalletRepository<WalletMetadata, AccountMetadata>

`Private` #walletStores

#walletStores: Map<string, WalletStores> = ...

activeWallet$

activeWallet$: BehaviorSubject<null | ActiveWallet> = ...

activeWalletId$

activeWalletId$: ReplaySubject<null | WalletManagerActivateProps<string, unknown>> = ...

Methods

`Private` #buildWitnesser

#buildWitnesser(wallet: AnyWallet<WalletMetadata, AccountMetadata>, _walletId: string, chainId: ChainId, accountIndex?: number): Witnesser
Private
Builds the witnesser for the given wallet.
Parameters
- wallet: AnyWallet<WalletMetadata, AccountMetadata>
  
  The wallet to build the witnesser for.
- _walletId: string
  
  The wallet id to build the witnesser for.
- chainId: ChainId
  
  The chain id to build the witnesser for.
- Optional accountIndex: number
  
  The account index to build the witnesser for.
Returns Witnesser
- Defined in packages/web-extension/src/walletManager/walletManager.ts:293

`Private` #deactivateWallet

#deactivateWallet(): void
Private
Deactivates the active wallet.

Returns void
- Defined in packages/web-extension/src/walletManager/walletManager.ts:256

`Private` #destroyWalletStores

#destroyWalletStores(walletId: string, chainId: ChainId): Promise<void>
Private
Destroys all stores for the given wallet id.
Parameters
- walletId: string
  
  The wallet id to destroy.
- chainId: ChainId
  
  The chain id to destroy.
Returns Promise<void>
- Defined in packages/web-extension/src/walletManager/walletManager.ts:221

`Private` #getStores

#getStores(walletStoreName: string): Promise<WalletStores>
Gets store if wallet was activated previously or creates one when wallet is activated for the first time.
Parameters
- walletStoreName: string
Returns Promise<WalletStores>
- Defined in packages/web-extension/src/walletManager/walletManager.ts:205

`Private` #hasActiveWallet

#hasActiveWallet(): boolean
Private
Checks if the wallet is active.

Returns boolean
- Defined in packages/web-extension/src/walletManager/walletManager.ts:271

`Private` #isActive

#isActive(walletProps: WalletManagerActivateProps<string, unknown>): boolean
Private
Checks if the wallet is active.
Parameters
- walletProps: WalletManagerActivateProps<string, unknown>
  
  The wallet properties to check.
Returns boolean
- Defined in packages/web-extension/src/walletManager/walletManager.ts:194

`Private` #stopEmittingFromActiveWallet

#stopEmittingFromActiveWallet(): void
Private
Stops emitting from the active wallet.

Returns void
- Defined in packages/web-extension/src/walletManager/walletManager.ts:280

activate

activate(props: WalletManagerActivateProps<string, unknown>, force?: boolean): Promise<void>
Create and activate a new ObservableWallet.

Returns
A Promise that resolves once the wallet has been successfully activated.
Parameters
- props: WalletManagerActivateProps<string, unknown>
  
  An object containing the necessary properties and configurations to activate the wallet.
- Optional force: boolean
  
  Optional. A boolean flag that determines the activation behavior. If set to true, the wallet will be activated regardless of whether its properties have changed since the last activation. This is useful for scenarios where reinitialization is needed without changes to the properties. Defaults to false, meaning the wallet will only be activated if there have been changes in the props.
Returns Promise<void>
Implementation of WalletManagerApi.activate
- Defined in packages/web-extension/src/walletManager/walletManager.ts:132

deactivate

deactivate(): Promise<void>
Deactivate wallet. Wallet observable properties will emit only after a new wallet is activateed.

Returns Promise<void>
Implementation of WalletManagerApi.deactivate
- Defined in packages/web-extension/src/walletManager/walletManager.ts:167

destroyData

destroyData(walletId: string, chainId: ChainId): Promise<void>
Deactivates the active wallet and destroy its existing store.
Parameters
- walletId: string
  
  The walletId of the wallet to destroy.
- chainId: ChainId
  
  The chainId of the wallet to destroy.
Returns Promise<void>
Implementation of WalletManagerApi.destroyData
- Defined in packages/web-extension/src/walletManager/walletManager.ts:184

initialize

initialize(): Promise<void>
activate the wallet with props of last activated wallet (load from managerStorage)

Returns Promise<void>
- Defined in packages/web-extension/src/walletManager/walletManager.ts:110

shutdown

shutdown(): void
Deactivates the active.

Returns void
- Defined in packages/web-extension/src/walletManager/walletManager.ts:174

switchNetwork

switchNetwork(id: ChainId): Promise<void>
Switches the network of the active wallet.
Parameters
- id: ChainId
  
  The network id to switch to.
Returns Promise<void>
Implementation of WalletManagerApi.switchNetwork
- Defined in packages/web-extension/src/walletManager/walletManager.ts:102

Class WalletManager<WalletMetadata, AccountMetadata>

Type Parameters

WalletMetadata extends { name: string; }

AccountMetadata extends { name: string; }

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

WalletMetadata extends { name: string; }

AccountMetadata extends { name: string; }

Parameters

__namedParameters: WalletManagerProps

__namedParameters: MessengerDependencies & WalletManagerDependencies<WalletMetadata, AccountMetadata>

Returns WalletManager<WalletMetadata, AccountMetadata>

Properties

Private #activeWalletProps

Private #logger

Private #managerStorage

Private #managerStorageKey

Private #signingCoordinatorApi

Private #storesFactory

Private #walletFactory

Private #walletRepository

Private #walletStores

activeWallet$

activeWalletId$

Methods

Private #buildWitnesser

Parameters

wallet: AnyWallet<WalletMetadata, AccountMetadata>

_walletId: string

chainId: ChainId

Optional accountIndex: number

Returns Witnesser

Private #deactivateWallet

Returns void

Private #destroyWalletStores

Parameters

walletId: string

chainId: ChainId

Returns Promise<void>

Private #getStores

Parameters

walletStoreName: string

Returns Promise<WalletStores>

Private #hasActiveWallet

Returns boolean

Private #isActive

Parameters

walletProps: WalletManagerActivateProps<string, unknown>

Returns boolean

Private #stopEmittingFromActiveWallet

Returns void

activate

Returns

Parameters

props: WalletManagerActivateProps<string, unknown>

Optional force: boolean

Returns Promise<void>

deactivate

Returns Promise<void>

destroyData

Parameters

walletId: string

chainId: ChainId

Returns Promise<void>

initialize

Returns Promise<void>

shutdown

Returns void

switchNetwork

Parameters

id: ChainId

Returns Promise<void>

Settings

WalletMetadata extends {
name: string;
}

AccountMetadata extends {
name: string;
}

WalletMetadata extends {
name: string;
}

AccountMetadata extends {
name: string;
}

`Private` #activeWalletProps

`Private` #logger

`Private` #managerStorage

`Private` #managerStorageKey

`Private` #signingCoordinatorApi

`Private` #storesFactory

`Private` #walletFactory

`Private` #walletRepository

`Private` #walletStores

`Private` #buildWitnesser

`Optional` accountIndex: number

`Private` #deactivateWallet

`Private` #destroyWalletStores

`Private` #getStores

`Private` #hasActiveWallet

`Private` #isActive

`Private` #stopEmittingFromActiveWallet

`Optional` force: boolean