fedimint / fedimint-web-sdk

Tools for developing Fedimint web clients
https://web.fedimint.org
MIT License
18 stars 8 forks source link
bitcoin ecash fedimint library react typescript web

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`](https://npmjs.com/package/fedimint/core-web) | ![NPM Version (latest)]() | Typescript interface for the Fedimint client wasm | | [`@fedimint/react`](https://web.fedimint.org/docs/core/getting-started) | TBD | React components and hooks for interacting with the Fedimint client | | [`@fedimint/wasm-web`](../packages/wasm-web/README.md) | ![NPM Version (latest)]() | Not intended for direct use. Contains the wasm pack output (target web) for the Fedimint client wasm. | | [`@fedimint/wasm-bundler`](../packages/wasm-bundler/README.md) | ![NPM Version (latest)]() | Not intended for direct use. Contains the wasm pack output (target bundler) for the Fedimint client wasm. | ## Structure 🛠️ This monorepo is structured as a pnpm workspace. There are some helpful scripts in the root `package.json` to help manage the workspace. ```bash fedimint-web-sdk ├── README.md ├── examples │ ├── vite-core │ └── bare-js └── packages ├── core-web ├── react ├── wasm-web └── wasm-bundler ``` ### Examples - [`vite-core`](../examples/vite-core/README.md): Simple example of how to use the `core-web` package within a React app bundled with Vite. - [`bare-js`](../examples/bare-js/README.md): Simple example of how to use the `core-web` package in a bare javascript environment (no bundler) ### Credit Used the [wagmi](https://github.com/wevm/wagmi) library as a reference for the repo's structure.