create-shield-unshield-dapp 1.0.3 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-shield-unshield-dapp",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Scaffold a Shield/Unshield dApp for USDC/cUSDC and USDT/cUSDT (wrap, unwrap, confidential transfer)",
   "type": "commonjs",
   "bin": {

package/template/README.md

@@ -154,6 +154,24 @@ Obtain the USDC, cUSDC, USDT, and cUSDT contract addresses from your deployment
 
 ---
 
+## Contract structure (`contracts/` folder)
+
+When you scaffold or clone this project, the **contracts/** folder contains a Hardhat project so you can deploy your own ERC-7984 wrappers and test tokens. Layout:
+
+| Path | Description |
+|------|--------------|
+| `contracts/contracts/ConfidentialTokenWrapper.sol` | ERC-7984 wrapper (same pattern as Zama payroll). Wraps any ERC-20 into a confidential token with `wrap`, `unwrap`, `finalizeUnwrap`, `confidentialTransfer`. |
+| `contracts/contracts/test/MockUSDC.sol` | Mock ERC-20 (6 decimals, `mint`) for **local testing only**. |
+| `contracts/contracts/test/MockUSDT.sol` | Mock ERC-20 (6 decimals, `mint`) for **local testing only**. |
+| `contracts/scripts/deploy-local.ts` | Deploys mocks + two wrappers (cUSDC, cUSDT) on Hardhat network, mints test tokens, prints `.env` lines. |
+| `contracts/scripts/deploy-sepolia.ts` | Deploys wrappers on Sepolia using real USDC (and optional USDT). Requires `PRIVATE_KEY` in `contracts/.env`. |
+| `contracts/hardhat.config.ts` | Hardhat config (networks: `hardhat`, `sepolia`). |
+| `contracts/package.json` | Run `npm install --legacy-peer-deps` then `npm run compile`, `npm run deploy:local`, or `npm run deploy:sepolia`. |
+
+Full setup and usage: **contracts/README.md**.
+
+---
+
 ## Build and preview
 
 ```bash