Class: Web3AuthPrivateKeyProvider
Class capable of providing a private key received through web3auth.
Hierarchy
PrivateKeyProvider↳
Web3AuthPrivateKeyProvider
Constructors
constructor
• new Web3AuthPrivateKeyProvider(web3auth, options?): Web3AuthPrivateKeyProvider
Parameters
| Name | Type |
|---|---|
web3auth | Web3Auth |
options? | Web3AuthPrivateKeyProviderOptions |
Returns
Overrides
PrivateKeyProvider.constructor
Defined in
web3auth-web/src/privatekeyprovider.ts:66
Properties
keyProviderStatus
• Protected keyProviderStatus: PrivateKeyProviderStatus
Inherited from
PrivateKeyProvider.keyProviderStatus
Defined in
core/build/signers/privatekey.d.ts:33
logoutOptions
• Private Optional Readonly logoutOptions: Web3AuthLogoutOptions
Defined in
web3auth-web/src/privatekeyprovider.ts:44
modalConfig
• Private Optional Readonly modalConfig: Record<string, ModalConfig>
Defined in
web3auth-web/src/privatekeyprovider.ts:42
we3auth
• Private Readonly we3auth: Web3Auth
Defined in
web3auth-web/src/privatekeyprovider.ts:40
Accessors
status
• get status(): PrivateKeyProviderStatus
Returns
PrivateKeyProviderStatus
Inherited from
PrivateKeyProvider.status
Defined in
core/build/signers/privatekey.d.ts:38
Methods
addStatusListener
▸ addStatusListener(observer): void
Parameters
| Name | Type |
|---|---|
observer | Observer<PrivateKeyProviderStatus> |
Returns
void
Inherited from
PrivateKeyProvider.addStatusListener
Defined in
core/build/signers/privatekey.d.ts:34
assertConnected
▸ assertConnected(): void
Returns
void
Inherited from
PrivateKeyProvider.assertConnected
Defined in
core/build/signers/privatekey.d.ts:37
connect
▸ connect(): Promise<void>
Returns
Promise<void>
Overrides
PrivateKeyProvider.connect
Defined in
web3auth-web/src/privatekeyprovider.ts:85
disconnect
▸ disconnect(): Promise<void>
Returns
Promise<void>
Overrides
PrivateKeyProvider.disconnect
Defined in
web3auth-web/src/privatekeyprovider.ts:99
getPrivateKey
▸ getPrivateKey(): Promise<PrivateKey>
Returns
Promise<PrivateKey>
Overrides
PrivateKeyProvider.getPrivateKey
Defined in
web3auth-web/src/privatekeyprovider.ts:74
removeStatusListener
▸ removeStatusListener(observer): void
Parameters
| Name | Type |
|---|---|
observer | Observer<PrivateKeyProviderStatus> |
Returns
void
Inherited from
PrivateKeyProvider.removeStatusListener
Defined in
core/build/signers/privatekey.d.ts:35
subscribeToEvents
▸ subscribeToEvents(web3auth): void
Parameters
| Name | Type |
|---|---|
web3auth | Web3Auth |
Returns
void
Defined in
web3auth-web/src/privatekeyprovider.ts:46
updateStatus
▸ updateStatus(newStatus): void
Parameters
| Name | Type |
|---|---|
newStatus | PrivateKeyProviderStatus |
Returns
void
Inherited from
PrivateKeyProvider.updateStatus
Defined in
core/build/signers/privatekey.d.ts:36