WalletAdapterFilsnap

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

Filsnap wallet implementation

Implements

Extends

TypedEventTarget

Accessors

connected

Get Signature

get connected(): boolean;

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

Whether the wallet is currently connected

Returns

boolean

connecting

Get Signature

get connecting(): boolean;

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

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:148

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

Returns

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

Constructors

Constructor

new WalletAdapterFilsnap(config: WalletConfig & {
  index: number;
  version: string;
}): WalletAdapterFilsnap;

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

Parameters

Parameter	Type
`config`	`WalletConfig` & { `index`: `number`; `version`: `string`; }

Returns

WalletAdapterFilsnap

Overrides

TypedEventTarget.constructor

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

changeNetwork()

changeNetwork(network: 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:155

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:257

Check if this wallet adapter is supported in the current environment

Returns

Promise<void>

connect()

connect(params?: {
  network: 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:84

Parameters

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

Returns

deriveAccount()

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

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

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:269

Disconnect from the wallet

Returns

Promise<void>

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<ArrayBufferLike>): Promise<Signature>;

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

Parameters

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

Returns

Promise<Signature>

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

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: WalletAdapter): value is WalletAdapterFilsnap;

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

Parameters

Parameter	Type
`value`	`WalletAdapter`

Returns

value is WalletAdapterFilsnap

Properties

[symbol]

[symbol]: boolean = true;

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

account

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

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

Type declaration

undefined

{ 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";

filsnap

filsnap: undefined | FilsnapAdapter;

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

id

id: string = 'filsnap';

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

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

name

name: string = 'Filsnap';

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

Human readable wallet name

network

network: Network;

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

signatureType

signatureType: "SECP256K1" | "BLS";

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

uid

uid: string;

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

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:33

Wallet homepage URL

version

version: string;

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