@funkit/connect/README.md

Funkit Connect SDK elevates DeFi apps via web2 sign-ins and one-click checkouts.

## FunkitConnect

The `@funkit/connect` package elevates decentralize applications via web2 & web3 sign-ins together with one-click onramps & checkouts.

### Version Information

- Package versions `< 1.x.x` support wagmi v1 only.
- Package versions `>= 1.x.x` support wagmi v2 only.

### 📝 Note

This package is currently in closed beta. To learn more, reach out to [developers@fun.xyz](mailto:developers@fun.xyz).

## Development

### Running tests

From the monorepo root:

```bash
# Run all connect tests once
pnpm --filter=@funkit/connect test

# Run with coverage (terminal summary + lcov + HTML report)
pnpm --filter=@funkit/connect test:coverage

# Open the Vitest UI (interactive dashboard with live coverage heatmap)
pnpm --filter=@funkit/connect test:ui
```

After `test:coverage`, open `packages/connect/coverage/index.html` to browse the HTML report. The `coverage/` directory is gitignored.

Coverage is collected by [`@vitest/coverage-v8`](https://vitest.dev/guide/coverage) and excludes generated files, Storybook stories, vanilla-extract style files (`*.css.ts`), and translation JSON. Update the `coverage` block in `vitest.config.ts` to tweak include/exclude patterns.