Skip to content

0xflair/contracts-typescript

Repository files navigation

Flair Typescript SDK

A complete suite of Flair reusable components and clients for frontend and backend development.

Packages

Name Description
@flair‑sdk/connectors Ready-made wagmi.sh connectors for various wallet providers.
@flair‑sdk/react React hooks and components for features like Wallet, NFT Collections, Token Streams, etc. (browser only)
@flair‑sdk/metatx Extension to ether.js Contract class to make all functions compatible with native meta transactions standard (ERC 2771). (node.js and browser)
@flair‑sdk/ipfs Utility functions to interact with IPFS, useful for NFT metadata storage. (node.js and browser)

Examples

Explore all the examples using the Flair SDK in the flair-sdk/examples repo:

Documentation

Visit docs.flair.dev for the full SDK documentation.

Development

This repository is equipped with Storybook for ease of development and manual testing.

  1. Clone this repo:

    git clone https://github.com/flair-sdk/typescript.git
  2. Install dependencies:

    npm install

Peer Dependencies

Due to breaking change in NPM you might need to enable legacy peer dependency resolution:

# Globally:
npm config set legacy-peer-deps true

# Or add --legacy-peer-deps to your npm install command