Skip to content

docs: add the Zcash provider to the README (JUMEMB-113) #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chybisov merged 1 commit into from
Oct 7, 2026
Merged

docs: add the Zcash provider to the README (JUMEMB-113) #898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

## Repository Overview

LI.FI Widget monorepo — a cross-chain DeFi swap/bridge widget supporting Ethereum, Solana, Bitcoin, Sui, and Tron ecosystems. Managed with pnpm workspaces, Changesets (independent versioning), and TypeScript composite builds.
LI.FI Widget monorepo — a cross-chain DeFi swap/bridge widget supporting Ethereum, Solana, Bitcoin, Sui, Tron, and Stellar ecosystems, plus Zcash as a destination-only chain. Managed with pnpm workspaces, Changesets (independent versioning), and TypeScript composite builds.

## Commands

Expand Down
29 changes: 26 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

[**LI.FI Widget**](https://docs.li.fi/widget/overview) features include:

- **Provider-based architecture** - Modular blockchain support with separate packages for Ethereum, Bitcoin, Solana, Sui, Tron, and Stellar
- **Provider-based architecture** - Modular blockchain support with separate packages for Ethereum, Bitcoin, Solana, Sui, Tron, and Stellar, plus Zcash as a destination
- All ecosystems, chains, bridges, exchanges, and solvers that [LI.FI](https://docs.li.fi/introduction/chains) supports
- Embeddable variants - compact, wide, and drawer
- Options to allow or deny certain chains, tokens, bridges, and exchanges
Expand Down Expand Up @@ -179,6 +179,26 @@ npm install @lifi/widget-provider-stellar
yarn add @lifi/widget-provider-stellar
```

**Zcash (destination only):**

**pnpm:**

```sh
pnpm add @lifi/widget-provider-zcash
```

**npm:**

```sh
npm install @lifi/widget-provider-zcash
```

**yarn:**

```sh
yarn add @lifi/widget-provider-zcash
```

**Note:** You only need to install the provider packages for the blockchains you want to support. Each provider package includes its required peer dependencies.

### LI.FI Wallet Management
Expand Down Expand Up @@ -225,7 +245,7 @@ npm install @lifi/widget-light
yarn add @lifi/widget-light
```

Ecosystem handlers are available as subpath imports (`@lifi/widget-light/ethereum`, `@lifi/widget-light/solana`, `@lifi/widget-light/bitcoin`, `@lifi/widget-light/sui`, `@lifi/widget-light/tron`) — install the corresponding peer dependencies only for the chains you need. See the [widget-light integration guide](/packages/widget-embedded/README.md) for full setup instructions.
Ecosystem handlers are available as subpath imports (`@lifi/widget-light/ethereum`, `@lifi/widget-light/solana`, `@lifi/widget-light/bitcoin`, `@lifi/widget-light/sui`, `@lifi/widget-light/tron`) — install the corresponding peer dependencies only for the chains you need. Zcash is not available in widget-light yet. See the [widget-light integration guide](/packages/widget-embedded/README.md) for full setup instructions.

## Architecture

Expand All @@ -239,6 +259,7 @@ The LI.FI Widget uses a **provider-based architecture** that allows you to selec
- **`@lifi/widget-provider-sui`** - Sui support (requires [@mysten/dapp-kit-react](https://sdk.mystenlabs.com/dapp-kit))
- **`@lifi/widget-provider-tron`** - Tron support (requires [@tronweb3/tronwallet-adapter-react-hooks](https://github.com/tronweb3/tronwallet-adapter))
- **`@lifi/widget-provider-stellar`** - Stellar support (bundles [Stellar Wallets Kit](https://github.com/Creit-Tech/Stellar-Wallets-Kit); no extra install)
- **`@lifi/widget-provider-zcash`** - Zcash as a destination chain: validates transparent (`t1`/`t3`) receivers and unified (`u1`) receivers that carry an Orchard receiver; no wallet connection and no extra install. Without it the widget offers no ZEC
- **`@lifi/wallet-management`** - Wallet management UI components
- **`@lifi/widget-light`** - Lightweight iframe-based integration ([docs](https://docs.li.fi/widget/widget-light-overview))

Expand Down Expand Up @@ -275,7 +296,7 @@ export const WidgetPage = () => {
};
```

**Multi-chain example** (Ethereum, Solana, Bitcoin, Sui, Tron, and Stellar):
**Multi-chain example** (Ethereum, Solana, Bitcoin, Sui, Tron, and Stellar, plus Zcash as a destination):

```tsx
import { LiFiWidget, WidgetConfig } from '@lifi/widget';
Expand All @@ -285,12 +306,14 @@ import { SolanaProvider } from '@lifi/widget-provider-solana';
import { StellarProvider } from '@lifi/widget-provider-stellar';
import { SuiProvider } from '@lifi/widget-provider-sui';
import { TronProvider } from '@lifi/widget-provider-tron';
import { ZcashProvider } from '@lifi/widget-provider-zcash';

const widgetConfig: WidgetConfig = {
providers: [
EthereumProvider(),
SolanaProvider(),
BitcoinProvider(),
ZcashProvider(),
SuiProvider(),
TronProvider(),
StellarProvider(),
Expand Down
Loading