Comment on page

BaseWalletAdapter

​@demox-labs/aleo-wallet-adapter-base / Exports / BaseWalletAdapter
Class: BaseWalletAdapter<Name>
Minimal EventEmitter interface that is molded against the Node.js EventEmitter interface.
Type parameters
Name
Type
Name
extends string = string
Hierarchy
​EventEmitter<WalletAdapterEvents>
↳ BaseWalletAdapter
↳↳ BaseSignerWalletAdapter​
Implements
​WalletAdapter<Name>
Table of contents
Constructors
​constructor​
Properties
​connecting​
​icon​
​name​
​publicKey​
​readyState​
​supportedTransactionVersions​
​url​
​prefixed​
Accessors
​connected​
Methods
​addListener​
​connect​
​disconnect​
​emit​
​eventNames​
​listenerCount​
​listeners​
​off​
​on​
​once​
​removeAllListeners​
​removeListener​
Constructors
constructor
• new BaseWalletAdapter<Name>()
Type parameters
Name
Type
Name
extends string = string
Inherited from
​EventEmitter.constructor​
Properties
connecting
• Abstract connecting: boolean
Implementation of
WalletAdapter.connecting
Defined in
​adapter.ts:72​
icon
• Abstract icon: string
Implementation of
WalletAdapter.icon
Defined in
​adapter.ts:69​
name
• Abstract name: WalletName<Name>
Implementation of
WalletAdapter.name
Defined in
​adapter.ts:67​
publicKey
• Abstract publicKey: string
Implementation of
WalletAdapter.publicKey
Defined in
​adapter.ts:71​
readyState
• Abstract readyState: WalletReadyState​
Implementation of
WalletAdapter.readyState
Defined in
​adapter.ts:70​
supportedTransactionVersions
• Abstract supportedTransactionVersions: ReadonlySet<any>
Implementation of
WalletAdapter.supportedTransactionVersions
Defined in
​adapter.ts:73​
url
• Abstract url: string
Implementation of
WalletAdapter.url
Defined in
​adapter.ts:68​
prefixed
▪ Static prefixed: string | boolean
Inherited from
​EventEmitter.prefixed​
Defined in
node_modules/eventemitter3/index.d.ts:9
Accessors
connected
• get connected(): boolean
Returns
boolean
Implementation of
WalletAdapter.connected
Defined in
​adapter.ts:75​
Methods
addListener
▸ addListener<T>(event, fn, context?): BaseWalletAdapter<Name>
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
fn
(...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void
context?
any
Returns
​BaseWalletAdapter<Name>
Implementation of
WalletAdapter.addListener
Inherited from
​EventEmitter.addListener​
Defined in
node_modules/eventemitter3/index.d.ts:45
connect
▸ Abstract connect(decryptPermission, network, programs?): Promise<void>
Parameters
Name
Type
decryptPermission
​DecryptPermission​
network
​Testnet​
programs?
string[]
Returns
Promise<void>
Implementation of
WalletAdapter.connect
Defined in
​adapter.ts:79​
disconnect
▸ Abstract disconnect(): Promise<void>
Returns
Promise<void>
Implementation of
WalletAdapter.disconnect
Defined in
​adapter.ts:80​
emit
▸ emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
...args
​ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]
Returns
boolean
Implementation of
WalletAdapter.emit
Inherited from
​EventEmitter.emit​
Defined in
node_modules/eventemitter3/index.d.ts:32
eventNames
▸ eventNames(): keyof WalletAdapterEvents[]
Return an array listing the events for which the emitter has registered listeners.
Returns
keyof WalletAdapterEvents[]
Implementation of
WalletAdapter.eventNames
Inherited from
​EventEmitter.eventNames​
Defined in
node_modules/eventemitter3/index.d.ts:15
listenerCount
▸ listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
Name
Type
event
keyof WalletAdapterEvents​
Returns
number
Implementation of
WalletAdapter.listenerCount
Inherited from
​EventEmitter.listenerCount​
Defined in
node_modules/eventemitter3/index.d.ts:27
listeners
▸ listeners<T>(event): (...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void[]
Return the listeners registered for a given event.
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
Returns
(...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void[]
Implementation of
WalletAdapter.listeners
Inherited from
​EventEmitter.listeners​
Defined in
node_modules/eventemitter3/index.d.ts:20
off
▸ off<T>(event, fn?, context?, once?): BaseWalletAdapter<Name>
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
fn?
(...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void
context?
any
once?
boolean
Returns
​BaseWalletAdapter<Name>
Implementation of
WalletAdapter.off
Inherited from
​EventEmitter.off​
Defined in
node_modules/eventemitter3/index.d.ts:69
on
▸ on<T>(event, fn, context?): BaseWalletAdapter<Name>
Add a listener for a given event.
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
fn
(...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void
context?
any
Returns
​BaseWalletAdapter<Name>
Implementation of
WalletAdapter.on
Inherited from
​EventEmitter.on​
Defined in
node_modules/eventemitter3/index.d.ts:40
once
▸ once<T>(event, fn, context?): BaseWalletAdapter<Name>
Add a one-time listener for a given event.
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
fn
(...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void
context?
any
Returns
​BaseWalletAdapter<Name>
Implementation of
WalletAdapter.once
Inherited from
​EventEmitter.once​
Defined in
node_modules/eventemitter3/index.d.ts:54
removeAllListeners
▸ removeAllListeners(event?): BaseWalletAdapter<Name>
Remove all listeners, or those of the specified event.
Parameters
Name
Type
event?
keyof WalletAdapterEvents​
Returns
​BaseWalletAdapter<Name>
Implementation of
WalletAdapter.removeAllListeners
Inherited from
​EventEmitter.removeAllListeners​
Defined in
node_modules/eventemitter3/index.d.ts:79
removeListener
▸ removeListener<T>(event, fn?, context?, once?): BaseWalletAdapter<Name>
Remove the listeners of a given event.
Type parameters
Name
Type
T
extends keyof WalletAdapterEvents​
Parameters
Name
Type
event
T
fn?
(...args: ArgumentMap<WalletAdapterEvents>[Extract<T, keyof WalletAdapterEvents>]) => void
context?
any
once?
boolean
Returns
​BaseWalletAdapter<Name>
Implementation of
WalletAdapter.removeListener
Inherited from
​EventEmitter.removeListener​
Defined in
node_modules/eventemitter3/index.d.ts:63

Name	Type
`Name`	extends `string` = `string`

Name	Type
`Name`	extends `string` = `string`

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`
`fn`	(...`args`: `ArgumentMap`<`WalletAdapterEvents`>[`Extract`<`T`, keyof `WalletAdapterEvents`>]) => `void`
`context?`	`any`

Name	Type
`decryptPermission`	`DecryptPermission`
`network`	`Testnet`
`programs?`	`string`[]

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`
`...args`	`ArgumentMap`<`WalletAdapterEvents`>[`Extract`<`T`, keyof `WalletAdapterEvents`>]

Name	Type
`event`	keyof `WalletAdapterEvents`

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`
`fn?`	(...`args`: `ArgumentMap`<`WalletAdapterEvents`>[`Extract`<`T`, keyof `WalletAdapterEvents`>]) => `void`
`context?`	`any`
`once?`	`boolean`

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`
`fn`	(...`args`: `ArgumentMap`<`WalletAdapterEvents`>[`Extract`<`T`, keyof `WalletAdapterEvents`>]) => `void`
`context?`	`any`

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`
`fn`	(...`args`: `ArgumentMap`<`WalletAdapterEvents`>[`Extract`<`T`, keyof `WalletAdapterEvents`>]) => `void`
`context?`	`any`

Name	Type
`event?`	keyof `WalletAdapterEvents`

Name	Type
`T`	extends keyof `WalletAdapterEvents`

Name	Type
`event`	`T`
`fn?`	(...`args`: `ArgumentMap`<`WalletAdapterEvents`>[`Extract`<`T`, keyof `WalletAdapterEvents`>]) => `void`
`context?`	`any`
`once?`	`boolean`

BaseSignerWalletAdapter

Deployment

Last modified 1mo ago