Skip to content

About

Tools for developing Fedimint clients

Topics

Resources

Contributing

Stars

39 stars

Watchers

2 watching

Forks

Latest commit

 

History

325 Commits

Folders and files

Repository files navigation

Fedimint Logo

    Fedimint Sdk

    A Robust, privacy-focused, and WebAssembly-powered fedimint client for the browser.

GitHub License Build Status Docs Workflow Ask DeepWiki

Packages 📦

Public packages

Package Version Description
@fedimint/core NPM Version (latest) Core Fedimint client for JavaScript runtimes (Wasm bindings, high-level API, testing utilities).
@fedimint/react NPM Version (latest) React hooks and context for working with Fedimint clients in React applications.
@fedimint/transport-web NPM Version (latest) Web worker transport that hosts the Wasm client and communicates with @fedimint/core.
create-fedimint-app NPM Version (latest) CLI tool for scaffolding a Fedimint starter app with Vite, React, and TypeScript.

Internal & legacy

Package Version Description
@fedimint/core-web (deprecated) NPM Version (latest) Legacy shim that re-exports @fedimint/core; new projects should depend on @fedimint/core directly.
@fedimint/fedimint-client-wasm-web NPM Version (latest) Not intended for direct use. Wasm-pack build targeting web environments; consumed by @fedimint/transport-web.
@fedimint/fedimint-client-wasm-bundler NPM Version (latest) Not intended for direct use. Wasm-pack build targeting bundler environments; used when bundling custom transports or hosts.
@fedimint/types NPM Version (latest) Shared TypeScript interfaces for transports and other Fedimint client implementations.
@fedimint/integration-tests (private) — Internal Vitest harness for exercising the SDK against embedded nodes.

Structure 🛠️

This monorepo is structured as a pnpm workspace rooted at js/, alongside the Rust crates in rust/. There are some helpful scripts in js/package.json to help manage the workspace.

fedimint-sdk
├── js
│   ├── docs
│   ├── examples
│   │   ├── vite-core
│   │   ├── bare-js
│   │   ├── next-js
│   │   └── webpack-app
│   ├── shared
│   │   ├── core
│   │   └── types
│   ├── web
│   │   ├── core-web
│   │   ├── integration-tests
│   │   ├── react
│   │   ├── transport-web
│   │   ├── wasm-bundler
│   │   └── wasm-web
│   ├── react-native
│   │   ├── react-native
│   │   └── react-native-bindings
│   └── tools
│       └── create-fedimint-app
├── rust
│   └── fedimint-client-uniffi
├── nix
└── scripts

Examples

  • vite-core: React + Vite starter focused on @fedimint/core primitives.
  • next-js: Example configuration for a Next.js application.
  • webpack-app: Demonstrates configuring webpack for Fedimint applications.
  • bare-js: Minimal usage of @fedimint/core without a bundler.

Developer Calls

  • SDK Developer Calls: We have developer calls every Wednesday at 4PM UTC to review PRs and discuss current development priorities. As a new developer, this is a great place to find good first issues and mentorship from the core team on how to get started contributing.

Credit

Used the wagmi library as a reference for the repo's structure.

Note

In October 2025, this repository was renamed from "Fedimint Web Sdk" to "Fedimint Sdk" as the react-native packages were added. See the discussion topic for details.

About

Tools for developing Fedimint clients

Topics

Resources

Contributing

Stars

39 stars

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages