WalletAdapterFilsnap

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:28

Filsnap wallet implementation

Implements

• WalletAdapter

Extends

• TypedEventTarget

Constructors

Constructor

new WalletAdapterFilsnap(config): WalletAdapterFilsnap

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:64

Parameters

Parameter	Type
config	WalletConfig & object

Returns

WalletAdapterFilsnap

Overrides

TypedEventTarget.constructor

Properties

[symbol]

[symbol]: boolean = true

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:30

---

account

account: { address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; } | undefined = undefined

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

Type Declaration

{ address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }

address

address: IAddress

path

path: string

Derivation path - only for HD wallets

privateKey?

optional privateKey: Uint8Array<ArrayBufferLike>

Private key - only for RAW and HD wallets

publicKey

publicKey: Uint8Array

type

type: "SECP256K1" | "BLS"

undefined

---

filsnap

filsnap: FilsnapAdapter | undefined

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:43

---

id

id: string = 'filsnap'

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:32

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

---

name

name: string = 'Filsnap'

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

Human readable wallet name

---

network

network: Network

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:70

---

signatureType

signatureType: "SECP256K1" | "BLS"

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:71

---

syncWithProvider

syncWithProvider: boolean

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:72

---

uid

uid: string

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:31

Unique identifier for this wallet instance

---

url

url: string = 'https://snaps.metamask.io/snap/npm/filsnap/'

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:34

Wallet homepage URL

---

version

version: string | undefined

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:69

Accessors

connected

Get Signature

get connected(): boolean

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:148

Whether the wallet is currently connected

Returns

boolean

---

connecting

Get Signature

get connecting(): boolean

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:144

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/filsnap.js:152

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: { address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }; network: Network; }>

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:159

Parameters

Parameter	Type
network	Network

Returns

Promise<{ account: { address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }; network: Network; }>

---

checkSupport()

checkSupport(): Promise<void>

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:283

Check if this wallet adapter is supported in the current environment

Returns

Promise<void>

---

connect()

connect(params?): Promise<{ account: { address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }; network: Network; }>

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:86

Parameters

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

Returns

Promise<{ account: { address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }; network: Network; }>

---

deriveAccount()

deriveAccount(_index): Promise<{ address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }>

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:199

Parameters

Parameter	Type
_index	number

Returns

Promise<{ address: IAddress; path: string; privateKey?: Uint8Array<ArrayBufferLike>; publicKey: Uint8Array; type: "SECP256K1" | "BLS"; }>

---

disconnect()

disconnect(): Promise<void>

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:295

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/filsnap.js:246

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

---

sign()

sign(data): Promise<Signature>

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:228

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/filsnap.js:264

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>

---

is()

static is(value): value is WalletAdapterFilsnap

Defined in: packages/iso-filecoin-wallets/src/filsnap.js:79

Parameters

Parameter	Type
value	WalletAdapter

Returns

value is WalletAdapterFilsnap