Module filsnap-adapter - v1.0.0

Filsnap adapter

NPM Version License: MIT License Adapter

Adapter for Filsnap

Exposes a simple API to interact with the snap from a dapp and also Fil Forwarder contract metadata.

Installation

pnpm install filsnap-adapter

Usage

This adapter interacts directly with the snap, so Metamask with support for Snaps needs to be installed and unlocked in the browser.

import { FilsnapAdapter } from 'filsnap-adapter'

const hasSnaps = await FilsnapAdapter.hasSnaps()
if (!hasSnaps) {
console.error('Metamask with Snaps support is not installed')
return
}

const snap = await FilsnapAdapter.connect({ network: 'testnet' }, 'npm:filsnap')

const { error, result } = await snap.getAddress()
if (error) {
console.error(error)
} else {
console.log(result)
// t1d2xrzcslx7xlbbylc5c3d5lvandqw4iwl6epxba
}

const isAvailable = await FilsnapAdapter.isAvailable()
// true

Check out the demo for a working example and the API for more details.

Contributing

Read contributing guidelines here.

Open in GitHub Codespaces

License

Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.

Index

Modules

Classes

Interfaces

Type Aliases

Variables

Generated using TypeDoc