Skip to content

fedimint/fedimint-web-sdk

Repository files navigation

Fedimint Logo

    Fedimint Web SDK

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

GitHub License Build Status Docs Workflow

Packages 📦

Package Version Description
@fedimint/core-web NPM Version (latest) Typescript interface for the Fedimint client wasm
@fedimint/react NPM Version (latest) React components and hooks for interacting with the Fedimint client
@fedimint/wasm-web NPM Version (latest) Not intended for direct use. Contains the wasm pack output (target web) for the Fedimint client wasm.
@fedimint/wasm-bundler NPM Version (latest) Not intended for direct use. Contains the wasm pack output (target bundler) for the Fedimint client wasm.
create-fedimint-app NPM Version (latest) Scaffold a new Fedimint app with Vite, React, and TypeScript.

Structure 🛠️

This monorepo is structured as a pnpm workspace. There are some helpful scripts in the root package.json to help manage the workspace.

fedimint-web-sdk
├── README.md
├── examples
│   ├── vite-core
│   └── bare-js
└── packages
    ├── core-web
    ├── react
    ├── wasm-web
    ├── wasm-bundler
    └── create-fedimint-app

Examples

  • vite-core: Simple example of how to use the core-web package within a React app bundled with Vite.
  • bare-js: Simple example of how to use the core-web package in a bare javascript environment (no bundler)

Credit

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