Skip to content

USER_GUIDE.md

Latest commit

 

History

History
132 lines (92 loc) · 3.9 KB

USER_GUIDE.md

File metadata and controls

132 lines (92 loc) · 3.9 KB
Raw

User Guide

This guide explains how to use WrapHub from a connected wallet.

1. Browse The Registry

Open /registry.

You can browse without connecting a wallet. WrapHub shows:

  • official Zama registry pairs
  • local/custom pairs
  • network
  • underlying ERC-20 address
  • ERC-7984 wrapper address
  • wrapper rate
  • source
  • health status
  • explorer links

Use the Official tab for Zama registry pairs. Use the Custom tab for browser-local or repo-local pairs.

2. Connect A Wallet

Click Connect Wallet.

WrapHub supports Sepolia for live wallet actions. Registry browsing remains available without a wallet, but wrap, unwrap, faucet, and decrypt flows run on Sepolia.

3. Open A Pair Workspace

Click a pair row or open the pair workspace.

The pair page shows:

  • network
  • source
  • status
  • underlying token
  • wrapper token
  • rate
  • decimals
  • wrap/unwrap/decrypt actions
  • token metrics
  • activity table
  • explorer links

4. Wrap ERC-20 To ERC-7984

  1. Select Wrap.
  2. Enter an amount.
  3. WrapHub reads your public ERC-20 balance.
  4. WrapHub reads allowance for the wrapper.
  5. If allowance is missing, the button asks you to approve and wrap.
  6. Confirm the wallet transaction.
  7. Wait for confirmation.

After confirmation, the ERC-20 token has moved into the confidential ERC-7984 wrapper.

5. Decrypt A Confidential Balance

  1. Select Decrypt.
  2. Click Decrypt balance.
  3. Sign the EIP-712 authorization in your wallet.
  4. WrapHub requests user decryption through the Zama relayer flow.
  5. Your decrypted balance appears in the UI.
  6. Click Hide balance to mask it again.

Only the connected wallet's own balance is decrypted. WrapHub does not decrypt other users' balances.

6. Unwrap ERC-7984 To ERC-20

  1. Select Unwrap.
  2. Enter an amount.
  3. Click Request unwrap.
  4. Confirm the wallet transaction.
  5. WrapHub completes the required unwrap/finalize flow.
  6. Your public ERC-20 balance updates after confirmation.

You do not need to decrypt your balance before unwrapping. Decrypt is only for viewing your private balance in the UI.

7. Claim Sepolia Test Tokens

Open /faucet.

The faucet is Sepolia-only. If your wallet is on another network, WrapHub asks you to switch to Sepolia.

Flow:

  1. Connect a wallet.
  2. Switch to Sepolia.
  3. Pick an official mock token.
  4. Click Claim.
  5. WrapHub submits the faucet claim for you.
  6. Return to the pair workspace and wrap the claimed ERC-20 mock token.

Each wallet can claim each configured token once per cooldown period.

8. Decrypt Any ERC-7984 Token

Open /decrypt.

Use this when the token is not in the registry or when you want a direct balance check.

  1. Paste an ERC-7984 token address.
  2. Connect a wallet on the token's network.
  3. Click Decrypt balance.
  4. Sign the EIP-712 authorization.
  5. View the connected wallet's balance.

9. Add A Custom Pair

Open /registry, then click Add custom pair.

You can add:

  • Sepolia custom pairs
  • local Hardhat pairs

WrapHub saves browser custom pairs locally and marks them as Local config. They are not official Zama registry pairs.

For committed development use, copy the generated snippet into frontend/src/features/registry/config/local-pairs.ts.

Common States

State Meaning
Official Pair was read from the Zama Wrappers Registry
Local config Pair was added for development or testing
Valid Pair is active according to available registry/metadata checks
Review Pair is usable, but metadata or registry status should be reviewed
Approval required The wrapper needs ERC-20 allowance before wrapping
Decrypt to view Confidential balance is hidden until user decryption succeeds