WalletAdapterHd

Defined in: packages/iso-filecoin-wallets/src/hd.js:33

HD wallet implementation

Implements

WalletAdapter

Extends

TypedEventTarget

Constructors

Constructor

new WalletAdapterHd(config): WalletAdapterHd

Defined in: packages/iso-filecoin-wallets/src/hd.js:59

Parameters

Parameter	Type
`config`	`WalletHDConfig`

Returns

WalletAdapterHd

Overrides

TypedEventTarget.constructor

Properties

[symbol]

[symbol]: boolean = true

Defined in: packages/iso-filecoin-wallets/src/hd.js:35

account

account: IAccount | undefined = undefined

Defined in: packages/iso-filecoin-wallets/src/hd.js:41

id

id: string = 'hd'

Defined in: packages/iso-filecoin-wallets/src/hd.js:37

Wallet adapter identifier (e.g. ‘filsnap’, ‘ledger’, ‘hd’, ‘raw’)

name

name: string = 'Burner Wallet'

Defined in: packages/iso-filecoin-wallets/src/hd.js:38

Human readable wallet name

network

network: Network

Defined in: packages/iso-filecoin-wallets/src/hd.js:66

signatureType

signatureType: "SECP256K1" | "BLS"

Defined in: packages/iso-filecoin-wallets/src/hd.js:67

uid

uid: string

Defined in: packages/iso-filecoin-wallets/src/hd.js:36

Unique identifier for this wallet instance

url

url: string = 'https://filecoin.io'

Defined in: packages/iso-filecoin-wallets/src/hd.js:39

Wallet homepage URL

Accessors

connected

Get Signature

get connected(): boolean

Defined in: packages/iso-filecoin-wallets/src/hd.js:99

Whether the wallet is currently connected

Returns

boolean

connecting

Get Signature

get connecting(): boolean

Defined in: packages/iso-filecoin-wallets/src/hd.js:95

Whether the wallet is in the process of connecting

Returns

boolean

support

Get Signature

get support(): "NotChecked" | "Detected" | "NotDetected" | "NotSupported"

Defined in: packages/iso-filecoin-wallets/src/hd.js:103

Wallet support status (NotChecked, Detected, NotDetected, NotSupported)

Returns

"NotChecked" | "Detected" | "NotDetected" | "NotSupported"

Methods

addEventListener()

addEventListener<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/[email protected]/node_modules/iso-web/dist/src/event-target/index.d.ts:29

Type Parameters

Type Parameter
`T` extends `"accountChanged"` \| `"networkChanged"` \| `"disconnect"` \| `"connect"` \| `"error"` \| `"stateChanged"`

Parameters

Parameter	Type
`type`	`T`
`callback`	`TypedEventListenerOrEventListenerObject`<`WalletEvents`, `T`> \| `null`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherit Doc

Inherited from

TypedEventTarget.addEventListener

changeNetwork()

changeNetwork(network): Promise<{ account: IAccount; network: Network; }>

Defined in: packages/iso-filecoin-wallets/src/hd.js:160

Parameters

Parameter	Type
`network`	`Network`

Returns

Promise<{ account: IAccount; network: Network; }>

checkSupport()

checkSupport(): Promise<void>

Defined in: packages/iso-filecoin-wallets/src/hd.js:107

Check if this wallet adapter is supported in the current environment

Returns

Promise<void>

connect()

connect(params?): Promise<{ account: IAccount; network: Network; }>

Defined in: packages/iso-filecoin-wallets/src/hd.js:124

Parameters

Parameter	Type
`params?`	{ `network?`: `Network`; }
`params.network?`	`Network`

Returns

Promise<{ account: IAccount; network: Network; }>

deriveAccount()

deriveAccount(index): Promise<IAccount>

Defined in: packages/iso-filecoin-wallets/src/hd.js:187

Parameters

Parameter	Type
`index`	`number`

Returns

Promise<IAccount>

disconnect()

disconnect(): Promise<void>

Defined in: packages/iso-filecoin-wallets/src/hd.js:152

Disconnect from the wallet

Returns

Promise<void>

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.dom.d.ts:11575

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters

Parameter	Type
`event`	`Event`

Returns

boolean

Inherited from

TypedEventTarget.dispatchEvent

dispatchTypedEvent()

dispatchTypedEvent<T>(_type, event): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/iso-web/dist/src/event-target/index.d.ts:20

Dispatches a synthetic event to target and returns true if either event’s cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Type Parameters

Type Parameter
`T` extends keyof `WalletEvents`

Parameters

Parameter	Type
`_type`	`T`
`event`	`WalletEvents`[`T`]

Returns

boolean

Inherited from

TypedEventTarget.dispatchTypedEvent

emit()

emit<T>(…args): boolean

Defined in: node_modules/.pnpm/[email protected]/node_modules/iso-web/dist/src/event-target/index.d.ts:21

Type Parameters

Type Parameter
`T` extends keyof `WalletEvents`

Parameters

Parameter	Type
…`args`	`WalletEvents`[`T`][`"detail"`] extends `IsAny`<`WalletEvents`[`T`][`"detail"`]> ? [`T`, `unknown`] : [`T`, `WalletEvents`[`T`][`"detail"`]]

Returns

boolean

Inherited from

TypedEventTarget.emit

off()

off<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/[email protected]/node_modules/iso-web/dist/src/event-target/index.d.ts:55

Alias for TypedEventTarget.removeEventListener

Type Parameters

Type Parameter
`T` extends `"accountChanged"` \| `"networkChanged"` \| `"disconnect"` \| `"connect"` \| `"error"` \| `"stateChanged"`

Parameters

Parameter	Type
`type`	`T`
`callback`	`TypedEventListenerOrEventListenerObject`<`WalletEvents`, `T`> \| `null`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

TypedEventTarget.off

on()

on<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/[email protected]/node_modules/iso-web/dist/src/event-target/index.d.ts:38

Alias for TypedEventTarget.addEventListener

Type Parameters

Type Parameter
`T` extends `"accountChanged"` \| `"networkChanged"` \| `"disconnect"` \| `"connect"` \| `"error"` \| `"stateChanged"`

Parameters

Parameter	Type
`type`	`T`
`callback`	`TypedEventListenerOrEventListenerObject`<`WalletEvents`, `T`> \| `null`
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

TypedEventTarget.on

personalSign()

personalSign(data): Promise<Signature>

Defined in: packages/iso-filecoin-wallets/src/hd.js:222

Parameters

Parameter	Type
`data`	`Uint8Array`

Returns

Promise<Signature>

removeEventListener()

removeEventListener<T>(type, callback, options?): void

Defined in: node_modules/.pnpm/[email protected]/node_modules/iso-web/dist/src/event-target/index.d.ts:46

Type Parameters

Type Parameter
`T` extends `"accountChanged"` \| `"networkChanged"` \| `"disconnect"` \| `"connect"` \| `"error"` \| `"stateChanged"`

Parameters

Parameter	Type
`type`	`T`
`callback`	`TypedEventListenerOrEventListenerObject`<`WalletEvents`, `T`> \| `null`
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

Inherit Doc

Inherited from

TypedEventTarget.removeEventListener

setup()

setup(config): void

Defined in: packages/iso-filecoin-wallets/src/hd.js:116

Setup the wallet from a mnemonic

Parameters

Parameter	Type
`config`	`WalletHDMnemonicConfig` & `object`

Returns

void

sign()

sign(data): Promise<Signature>

Defined in: packages/iso-filecoin-wallets/src/hd.js:207

Parameters

Parameter	Type	Description
`data`	`Uint8Array`<`ArrayBufferLike`>	Data to sign

Returns

Promise<Signature>

signMessage()

signMessage(message): Promise<Signature>

Defined in: packages/iso-filecoin-wallets/src/hd.js:237

Parameters

Parameter	Type	Description
`message`	{ `from`: `string`; `gasFeeCap`: `string`; `gasLimit`: `number`; `gasPremium`: `string`; `method`: `number`; `nonce`: `number`; `params`: `string`; `to`: `string`; `value`: `string`; `version`: `0`; }	Filecoin message to sign
`message.from`	`string`	-
`message.gasFeeCap`	`string`	-
`message.gasLimit`	`number`	-
`message.gasPremium`	`string`	-
`message.method`	`number`	-
`message.nonce`	`number`	-
`message.params`	`string`	-
`message.to`	`string`	-
`message.value`	`string`	-
`message.version`	`0`	-

Returns

Promise<Signature>

fromMnemonic()

static fromMnemonic(config): WalletAdapterHd

Defined in: packages/iso-filecoin-wallets/src/hd.js:84

HD wallet from mnemonic

Parameters

Parameter	Type
`config`	`WalletHDMnemonicConfig`

Returns

WalletAdapterHd

is()

static is(value): value is WalletAdapterHd

Defined in: packages/iso-filecoin-wallets/src/hd.js:74

Parameters

Parameter	Type
`value`	`WalletAdapter`

Returns

value is WalletAdapterHd