WalletAdapter

Defined in: packages/iso-filecoin-wallets/src/types.ts:76

Wallet adapter interface

Extends

• TypedEventTarget<WalletEvents>

Methods

addEventListener()

addEventListener<T>(
   type: T,
   callback:
  | null
  | TypedEventListenerOrEventListenerObject<WalletEvents, T>,
   options?: boolean | AddEventListenerOptions): 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	| null | TypedEventListenerOrEventListenerObject<WalletEvents, T>
options?	boolean | AddEventListenerOptions

Returns

void

Inherit Doc

Inherited from

TypedEventTarget.addEventListener

---

dispatchEvent()

dispatchEvent(event: Event): boolean;

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

Dispatches a synthetic event 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.

MDN Reference

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

TypedEventTarget.dispatchEvent

---

dispatchTypedEvent()

dispatchTypedEvent<T>(_type: T, event: WalletEvents[T]): 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: WalletEvents[T]["detail"] extends IsAny<WalletEvents[T]["detail"]> ? [T, unknown] : [T, WalletEvents[T]["detail"]]): 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: T,
   callback:
  | null
  | TypedEventListenerOrEventListenerObject<WalletEvents, T>,
   options?: boolean | EventListenerOptions): 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	| null | TypedEventListenerOrEventListenerObject<WalletEvents, T>
options?	boolean | EventListenerOptions

Returns

void

Inherited from

TypedEventTarget.off

---

on()

on<T>(
   type: T,
   callback:
  | null
  | TypedEventListenerOrEventListenerObject<WalletEvents, T>,
   options?: boolean | AddEventListenerOptions): 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	| null | TypedEventListenerOrEventListenerObject<WalletEvents, T>
options?	boolean | AddEventListenerOptions

Returns

void

Inherited from

TypedEventTarget.on

---

removeEventListener()

removeEventListener<T>(
   type: T,
   callback:
  | null
  | TypedEventListenerOrEventListenerObject<WalletEvents, T>,
   options?: boolean | EventListenerOptions): 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	| null | TypedEventListenerOrEventListenerObject<WalletEvents, T>
options?	boolean | EventListenerOptions

Returns

void

Inherit Doc

Inherited from

TypedEventTarget.removeEventListener

---

sign()

sign(data: Uint8Array): Promise<Signature>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:153

Sign raw bytes

Parameters

Parameter	Type	Description
data	Uint8Array	raw bytes to sign

Returns

Promise<Signature>

Properties

account

readonly account:
  | undefined
  | IAccount;

Defined in: packages/iso-filecoin-wallets/src/types.ts:120

Currently active account, if connected

---

changeNetwork()

changeNetwork: (network: Network) => Promise<AccountNetwork>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:146

Change the network and derive a new account

Parameters

Parameter	Type	Description
network	Network	The network to change to

Returns

Promise<AccountNetwork>

---

checkSupport()

checkSupport: () => Promise<void>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:125

Check if this wallet adapter is supported in the current environment

Returns

Promise<void>

---

connect()

connect: (params: {
  network: Network;
}) => Promise<AccountNetwork>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:130

Connect to the wallet

Parameters

Parameter	Type	Description
params	{ network: Network; }	Connect params
params.network?	Network	-

Returns

Promise<AccountNetwork>

---

connected

readonly connected: boolean;

Defined in: packages/iso-filecoin-wallets/src/types.ts:115

Whether the wallet is currently connected

---

connecting

readonly connecting: boolean;

Defined in: packages/iso-filecoin-wallets/src/types.ts:110

Whether the wallet is in the process of connecting

---

deriveAccount()

deriveAccount: (index: number) => Promise<IAccount>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:140

Derive a new account at the given index

Parameters

Parameter	Type	Description
index	number	The derivation path index

Returns

Promise<IAccount>

---

disconnect()

disconnect: () => Promise<void>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:134

Disconnect from the wallet

Returns

Promise<void>

---

id

readonly id: string;

Defined in: packages/iso-filecoin-wallets/src/types.ts:85

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

---

name

name: string;

Defined in: packages/iso-filecoin-wallets/src/types.ts:90

Human readable wallet name

---

network

readonly network: Network;

Defined in: packages/iso-filecoin-wallets/src/types.ts:100

Current network (mainnet or testnet)

---

signMessage()

signMessage: (message: {
  from: string;
  gasFeeCap: string;
  gasLimit: number;
  gasPremium: string;
  method: number;
  nonce: number;
  params: string;
  to: string;
  value: string;
  version: 0;
}) => Promise<Signature>;

Defined in: packages/iso-filecoin-wallets/src/types.ts:160

Sign filecoin message

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>

---

support

readonly support: "NotChecked" | "Detected" | "NotDetected" | "NotSupported";

Defined in: packages/iso-filecoin-wallets/src/types.ts:105

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

---

uid

readonly uid: string;

Defined in: packages/iso-filecoin-wallets/src/types.ts:80

Unique identifier for this wallet instance

---

url

url: string;

Defined in: packages/iso-filecoin-wallets/src/types.ts:95

Wallet homepage URL