FilecoinAppKitAdapter

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

TODO:

auth provider for SIWX

Description

Filecoin adapter for AppKit

Extends

AdapterBlueprint

Constructors

Constructor

new FilecoinAppKitAdapter(params): FilecoinAppKitAdapter

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

Parameters

Parameter	Type
`params`	{ `adapters`: `WalletAdapter`[]; }
`params.adapters`	`WalletAdapter`[]

Returns

FilecoinAppKitAdapter

Overrides

AdapterBlueprint.constructor

Properties

adapters

adapters: WalletAdapter[]

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

adapterType

adapterType: string | undefined

Defined in: node_modules/.pnpm/@[email protected]_@[email protected]_bufferutil@[email protected]_type_732bf6e1de1eb68be1ccb0e2f713f747/node_modules/@reown/appkit-controllers/dist/types/src/controllers/AdapterController/ChainAdapterBlueprint.d.ts:32

Inherited from

AdapterBlueprint.adapterType

availableConnections

protected availableConnections: Connection[]

Inherited from

AdapterBlueprint.availableConnections

availableConnectors

protected availableConnectors: FilecoinConnector[]

Inherited from

AdapterBlueprint.availableConnectors

caipNetworks

caipNetworks: CaipNetwork[] | undefined

Defined in: packages/iso-filecoin-wallets/src/appkit.js:61

connector?

protected optional connector: FilecoinConnector

Inherited from

AdapterBlueprint.connector

getCaipNetworks()

getCaipNetworks: (namespace?) => CaipNetwork[]

Parameters

Parameter	Type
`namespace?`	`ChainNamespace`

Returns

CaipNetwork[]

Inherited from

AdapterBlueprint.getCaipNetworks

getConnectorId()

getConnectorId: (namespace) => string | undefined

Parameters

Parameter	Type
`namespace`	`ChainNamespace`

Returns

string | undefined

Inherited from

AdapterBlueprint.getConnectorId

namespace

namespace: ChainNamespace | undefined

Inherited from

AdapterBlueprint.namespace

projectId?

optional projectId: string

Inherited from

AdapterBlueprint.projectId

provider?

protected optional provider: Provider

Inherited from

AdapterBlueprint.provider

providerHandlers

protected providerHandlers: Record<string, { accountsChanged: (accounts) => void; chainChanged: (chainId) => void; disconnect: () => void; provider: Provider | CombinedProvider; } | null>

Inherited from

AdapterBlueprint.providerHandlers

Accessors

connections

Get Signature

get connections(): Connection[]

Gets the available connections.

Returns

Connection[]

An array of available connections

Inherited from

AdapterBlueprint.connections

connectors

Get Signature

get connectors(): Connector[]

Gets the available connectors.

Returns

Connector[]

An array of available connectors

Inherited from

AdapterBlueprint.connectors

networks

Get Signature

get networks(): CaipNetwork[]

Gets the supported networks.

Returns

CaipNetwork[]

An array of supported networks

Inherited from

AdapterBlueprint.networks

Methods

addConnection()

protected addConnection(…connections): void

Adds connections to the available connections list

Parameters

Parameter	Type	Description
…`connections`	`Connection`[]	The connections to add

Returns

void

Inherited from

AdapterBlueprint.addConnection

addConnector()

protected addConnector(…connectors): void

Adds one or more connectors to the available connectors list.

Parameters

Parameter	Type	Description
…`connectors`	`FilecoinConnector`[]	The connectors to add

Returns

void

Inherited from

AdapterBlueprint.addConnector

clearConnections()

protected clearConnections(emit?): void

Clears all connections from the available connections list

Parameters

Parameter	Type	Description
`emit?`	`boolean`	Whether to emit the connections event

Returns

void

Inherited from

AdapterBlueprint.clearConnections

connect()

connect(params): Promise<ConnectResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:128

Connect

Parameters

Parameter	Type
`params`	`ConnectParams`

Returns

Promise<ConnectResult>

Overrides

AdapterBlueprint.connect

connectWalletConnect()

connectWalletConnect(_chainId?): Promise<{ clientId: string; } | undefined>

Connects to WalletConnect.

Parameters

Parameter	Type	Description
`_chainId?`	`string` \| `number`	Optional chain ID to connect to

Returns

Promise<{ clientId: string; } | undefined>

Inherited from

AdapterBlueprint.connectWalletConnect

construct()

construct(params): void

Defined in: packages/iso-filecoin-wallets/src/appkit.js:53

Parameters

Parameter	Type
`params`	`Params`

Returns

void

Overrides

AdapterBlueprint.construct

deleteConnection()

protected deleteConnection(connectorId): void

Deletes a connection from the available connections list

Parameters

Parameter	Type	Description
`connectorId`	`string`	The connector ID of the connection to delete

Returns

void

Inherited from

AdapterBlueprint.deleteConnection

disconnect()

disconnect(_params): Promise<DisconnectResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:203

Disconnect

Parameters

Parameter	Type
`_params`	`DisconnectParams`

Returns

Promise<DisconnectResult>

Overrides

AdapterBlueprint.disconnect

emit()

protected emit<T>(eventName, data?): void

Emits an event with the given name and optional data.

Type Parameters

Type Parameter
`T` extends `EventName`

Parameters

Parameter	Type	Description
`eventName`	`T`	The name of the event to emit
`data?`	`EventData`[`T`]	The optional data to be passed to the event listeners

Returns

void

Inherited from

AdapterBlueprint.emit

emitFirstAvailableConnection()

protected emitFirstAvailableConnection(): void

Emits the first available connection.

Returns

void

Inherited from

AdapterBlueprint.emitFirstAvailableConnection

estimateGas()

estimateGas(_params): Promise<EstimateGasTransactionResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:312

Estimate gas

Parameters

Parameter	Type
`_params`	`EstimateGasTransactionArgs`

Returns

Promise<EstimateGasTransactionResult>

Overrides

AdapterBlueprint.estimateGas

formatUnits()

formatUnits(_params): string

Defined in: packages/iso-filecoin-wallets/src/appkit.js:346

Format units

Parameters

Parameter	Type
`_params`	`FormatUnitsParams`

Returns

string

Overrides

AdapterBlueprint.formatUnits

getAccounts()

getAccounts(params): Promise<GetAccountsResult>

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

Get accounts

Parameters

Parameter	Type
`params`	`GetAccountsParams`

Returns

Promise<GetAccountsResult>

Overrides

AdapterBlueprint.getAccounts

getBalance()

getBalance(params): Promise<GetBalanceResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:236

Get balance

Parameters

Parameter	Type
`params`	`GetBalanceParams`

Returns

Promise<GetBalanceResult>

Overrides

AdapterBlueprint.getBalance

getCapabilities()

getCapabilities(): Promise<{ }>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:356

Returns

Promise<{ }>

Overrides

AdapterBlueprint.getCapabilities

getConnection()

getConnection(params): { account: { address: string; publicKey?: string; type?: string; } | undefined; accounts: object[]; auth?: { name: string | undefined; username: string | undefined; }; caipNetwork?: CaipNetwork; connector: ChainAdapterConnector | undefined; connectorId: string; icon?: string; name?: string; networkIcon?: string; } | null

Gets a connection based on provided parameters. If connectorId is provided, returns connection for that specific connector. Otherwise, returns the first available valid connection.

Parameters

Parameter	Type	Description
`params`	`GetConnectionParams`	Connection parameters

Returns

{ account: { address: string; publicKey?: string; type?: string; } | undefined; accounts: object[]; auth?: { name: string | undefined; username: string | undefined; }; caipNetwork?: CaipNetwork; connector: ChainAdapterConnector | undefined; connectorId: string; icon?: string; name?: string; networkIcon?: string; } | null

Connection or null if none found

Inherited from

AdapterBlueprint.getConnection

getProfile()

getProfile(): Promise<{ profileImage: undefined; profileName: undefined; }>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:350

Returns

Promise<{ profileImage: undefined; profileName: undefined; }>

getWalletConnectConnector()

protected getWalletConnectConnector(): WalletConnectConnector

Returns

WalletConnectConnector

Inherited from

AdapterBlueprint.getWalletConnectConnector

getWalletConnectProvider()

getWalletConnectProvider(params): any

Defined in: packages/iso-filecoin-wallets/src/appkit.js:386

Parameters

Parameter	Type
`params`	{ `provider`: `any`; }
`params.provider`	`any`

Returns

any

Overrides

AdapterBlueprint.getWalletConnectProvider

grantPermissions()

grantPermissions(): Promise<{ }>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:359

Returns

Promise<{ }>

Overrides

AdapterBlueprint.grantPermissions

listenProviderEvents()

protected listenProviderEvents(connectorId, provider): void

Listens to provider events for a specific connector.

Parameters

Parameter	Type	Description
`connectorId`	`string`	The ID of the connector
`provider`	`Provider` \| `CombinedProvider`	The provider to listen to

Returns

void

Inherited from

AdapterBlueprint.listenProviderEvents

off()

off<T>(eventName, callback): void

Removes an event listener for a specific event.

Type Parameters

Type Parameter
`T` extends `EventName`

Parameters

Parameter	Type	Description
`eventName`	`T`	The name of the event
`callback`	`EventCallback`<`T`>	The callback function to be removed

Returns

void

Inherited from

AdapterBlueprint.off

on()

on<T>(eventName, callback): void

Adds an event listener for a specific event.

Type Parameters

Type Parameter
`T` extends `EventName`

Parameters

Parameter	Type	Description
`eventName`	`T`	The name of the event
`callback`	`EventCallback`<`T`>	The callback function to be called when the event is emitted

Returns

void

Inherited from

AdapterBlueprint.on

onAccountsChanged()

protected onAccountsChanged(accounts, connectorId, disconnectIfNoAccounts?): void

Handles accounts changed event for a specific connector.

Parameters

Parameter	Type	Description
`accounts`	(`string` \| `ParsedCaipAddress`)[]	The accounts that changed
`connectorId`	`string`	The ID of the connector
`disconnectIfNoAccounts?`	`boolean`	-

Returns

void

Inherited from

AdapterBlueprint.onAccountsChanged

onChainChanged()

protected onChainChanged(chainId, connectorId): void

Handles chain changed event for a specific connector.

Parameters

Parameter	Type	Description
`chainId`	`string` \| `number`	The ID of the chain that changed
`connectorId`	`string`	The ID of the connector

Returns

void

Inherited from

AdapterBlueprint.onChainChanged

onConnect()

protected onConnect(accounts, connectorId): void

Handles connect event for a specific connector.

Parameters

Parameter	Type	Description
`accounts`	(`string` \| `ParsedCaipAddress`)[]	The accounts that changed
`connectorId`	`string`	The ID of the connector

Returns

void

Inherited from

AdapterBlueprint.onConnect

onDisconnect()

protected onDisconnect(connectorId): void

Handles disconnect event for a specific connector.

Parameters

Parameter	Type	Description
`connectorId`	`string`	The ID of the connector

Returns

void

Inherited from

AdapterBlueprint.onDisconnect

parseUnits()

parseUnits(_params): bigint

Defined in: packages/iso-filecoin-wallets/src/appkit.js:336

Parse units

Parameters

Parameter	Type
`_params`	`ParseUnitsParams`

Returns

bigint

Overrides

AdapterBlueprint.parseUnits

reconnect()?

optional reconnect(params): Promise<void>

Reconnects to a wallet.

Parameters

Parameter	Type	Description
`params`	`ConnectParams`	Reconnection parameters

Returns

Promise<void>

Inherited from

AdapterBlueprint.reconnect

removeAllEventListeners()

removeAllEventListeners(): void

Removes all event listeners.

Returns

void

Inherited from

AdapterBlueprint.removeAllEventListeners

removeProviderListeners()

protected removeProviderListeners(connectorId): void

Removes provider listeners for a specific connector.

Parameters

Parameter	Type	Description
`connectorId`	`string`	The ID of the connector

Returns

void

Inherited from

AdapterBlueprint.removeProviderListeners

revokePermissions()

revokePermissions(): Promise<`0x${string}`>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:362

Returns

Promise<`0x${string}`>

Overrides

AdapterBlueprint.revokePermissions

sendTransaction()

sendTransaction(_params): Promise<SendTransactionResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:324

Send transaction

Parameters

Parameter	Type
`_params`	`SendTransactionParams`

Returns

Promise<SendTransactionResult>

Overrides

AdapterBlueprint.sendTransaction

setAuthProvider()

setAuthProvider(authProvider): void

Sets the auth provider.

Parameters

Parameter	Type	Description
`authProvider`	`W3mFrameProvider`	The auth provider instance

Returns

void

Inherited from

AdapterBlueprint.setAuthProvider

setStatus()

protected setStatus(status, chainNamespace?): void

Parameters

Parameter	Type
`status`	`"reconnecting"` \| `"connected"` \| `"disconnected"` \| `"connecting"` \| `undefined`
`chainNamespace?`	`ChainNamespace`

Returns

void

Inherited from

AdapterBlueprint.setStatus

setUniversalProvider()

setUniversalProvider(): Promise<void>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:380

Sets the universal provider for WalletConnect.

Returns

Promise<void>

Overrides

AdapterBlueprint.setUniversalProvider

signMessage()

signMessage(_params): Promise<SignMessageResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:300

Sign message

Parameters

Parameter	Type
`_params`	`SignMessageParams`

Returns

Promise<SignMessageResult>

Overrides

AdapterBlueprint.signMessage

switchNetwork()

switchNetwork(params): Promise<void>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:220

Switch network

Parameters

Parameter	Type
`params`	`SwitchNetworkParams`

Returns

Promise<void>

Overrides

AdapterBlueprint.switchNetwork

syncConnection()

syncConnection(params): Promise<ConnectResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:190

Sync connection

Parameters

Parameter	Type
`params`	`SyncConnectionParams`

Returns

Promise<ConnectResult>

Overrides

AdapterBlueprint.syncConnection

syncConnections()

syncConnections(_params): void | Promise<void>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:118

Sync connections

Parameters

Parameter	Type
`_params`	`SyncConnectionsParams`

Returns

void | Promise<void>

Overrides

AdapterBlueprint.syncConnections

syncConnectors()

syncConnectors(): void | Promise<void>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:106

Sync connectors

Returns

void | Promise<void>

Overrides

AdapterBlueprint.syncConnectors

walletGetAssets()

walletGetAssets(): Promise<{ }>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:365

Returns

Promise<{ }>

Overrides

AdapterBlueprint.walletGetAssets

writeContract()

writeContract(): Promise<WriteContractResult>

Defined in: packages/iso-filecoin-wallets/src/appkit.js:374

Write contract

Returns

Promise<WriteContractResult>

Overrides

AdapterBlueprint.writeContract