starkzap-starter 0.1.0

package/.env.example

@@ -0,0 +1,23 @@
+# ─────────────────────────────────────────────────────────────
+# Starkzap Starter — Environment Variables
+# Copy this file to .env.local and fill in your values.
+# NEVER commit .env.local to version control.
+# ─────────────────────────────────────────────────────────────
+
+# Network: "sepolia" for testnet, "mainnet" for production
+NEXT_PUBLIC_STARKNET_NETWORK=sepolia
+
+# Your Starknet RPC endpoint (get a free one from Blast, Infura, or Alchemy)
+NEXT_PUBLIC_STARKNET_RPC_URL=https://starknet-sepolia.public.blastapi.io
+
+# ── Privy (Social/Email Login) ────────────────────────────────
+# Get your App ID from https://privy.io — required for social login wallet
+NEXT_PUBLIC_PRIVY_APP_ID=
+
+# ── AVNU Paymaster (Gasless Transactions) ────────────────────
+# Optional: leave blank to skip gas sponsorship (users pay their own gas)
+NEXT_PUBLIC_AVNU_API_KEY=
+
+# ── App Config ────────────────────────────────────────────────
+NEXT_PUBLIC_APP_NAME=Starkzap Starter
+NEXT_PUBLIC_APP_URL=http://localhost:3000

package/README.md

@@ -0,0 +1,164 @@
+# create-starkzap-app
+
+A CLI scaffold for production-ready Starknet applications. Choose your framework, pick your wallet strategy, and get a fully wired app in seconds — gasless transactions, token balances, and wallet connect included.
+
+```bash
+npx create-starkzap-app
+```
+
+---
+
+## Frameworks
+
+Pick your stack when scaffolding. All three share the same Starkzap SDK core.
+
+|  | Next.js 14 | Vite + React | Expo (Mobile) |
+|---|---|---|---|
+| **Best for** | Production web apps, SEO, SSR | SPAs, dashboards, lightweight | iOS & Android |
+| **Router** | App Router | React Router / file-based | Expo Router |
+| **Wallet** | Argent X, Braavos, Privy | Argent X, Braavos, Privy | Privy (email/social) |
+| **Bundle** | Next.js optimized | Vite | Metro |
+
+---
+
+## What's Included
+
+Every scaffold comes with the following out of the box:
+
+| Feature | Details |
+|---|---|
+| 🔑 Wallet Connect | Argent X + Braavos via injected provider. Privy social login supported. |
+| ⛽ Gasless Transactions | AVNU paymaster covers gas — users pay nothing. |
+| 💰 Token Balances | Live STRK, ETH, USDC balance cards with refresh. |
+| 💸 Payment UI | Send form with pending / success / error states. |
+| 🔗 Explorer Links | Auto-links transactions and addresses to Starkscan. |
+| 🎨 Design System | Dark theme, DM Sans + IBM Plex Mono, Tailwind CSS. |
+
+**Stack:** Next.js 14 · Vite 5 · Expo 51 · TypeScript · Starkzap SDK · Tailwind CSS · starknet.js
+
+---
+
+## Quickstart
+
+### 1. Scaffold
+
+Run the CLI and follow the prompts — choose your project name, framework, and wallet strategy:
+
+```bash
+npx create-starkzap-app
+```
+
+### 2. Configure
+
+```bash
+cp .env.example .env.local
+```
+
+Open `.env.local` and fill in:
+
+```env
+# "sepolia" for testnet, "mainnet" for production
+NEXT_PUBLIC_STARKNET_NETWORK=sepolia
+
+# Free RPC endpoints:
+# Blast:  https://starknet-sepolia.public.blastapi.io
+# Infura: https://starknet-sepolia.infura.io/v3/YOUR_KEY
+NEXT_PUBLIC_STARKNET_RPC_URL=https://starknet-sepolia.public.blastapi.io
+
+# Optional — Privy app ID for social/email login (https://privy.io)
+NEXT_PUBLIC_PRIVY_APP_ID=
+
+# Optional — AVNU API key for gasless transactions (leave blank to skip)
+NEXT_PUBLIC_AVNU_API_KEY=
+```
+
+### 3. Run
+
+```bash
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) and connect your wallet.
+
+---
+
+## Extending the Kit
+
+### Token Swaps via AVNU
+
+```ts
+import { StarkZap, AvnuSwapProvider, getPresets, Amount } from "starkzap";
+
+const sdk = new StarkZap({ network: "mainnet" });
+const wallet = await sdk.connectWallet({
+  account: { signer },
+  swapProviders: [new AvnuSwapProvider()],
+  defaultSwapProviderId: "avnu",
+});
+
+const { STRK, USDC } = getPresets(wallet.getChainId());
+const tx = await wallet.swap({
+  tokenIn: STRK,
+  tokenOut: USDC,
+  amountIn: Amount.parse("10", STRK),
+  slippageBps: 50n,
+});
+await tx.wait();
+```
+
+### STRK Staking
+
+```ts
+const stakingPools = await wallet.staking().getPools();
+const tx = await wallet.staking().stake({
+  pool: stakingPools[0],
+  amount: Amount.parse("100", STRK),
+});
+await tx.wait();
+```
+
+### Batch Multiple Transactions
+
+```ts
+const tx = await wallet
+  .tx()
+  .transfer({ to: addr1, token: STRK, amount: Amount.parse("5", STRK) })
+  .transfer({ to: addr2, token: USDC, amount: Amount.parse("10", USDC) })
+  .execute({ feeMode: "sponsored" });
+await tx.wait();
+```
+
+---
+
+## Deployment
+
+### Vercel (Recommended)
+
+```bash
+npm install -g vercel
+vercel
+```
+
+Set your environment variables in the Vercel dashboard. Switch `NEXT_PUBLIC_STARKNET_NETWORK` to `mainnet` for production.
+
+### Manual Build
+
+```bash
+npm run build
+npm start
+```
+
+---
+
+## Resources
+
+- [Starkzap Documentation](https://docs.starknet.io/build/starkzap/overview)
+- [Starkzap GitHub](https://github.com/keep-starknet-strange/starkzap)
+- [AVNU Paymaster](https://www.avnu.fi)
+- [Privy Docs](https://docs.privy.io)
+- [Starkscan — Sepolia](https://sepolia.starkscan.co)
+- [Starkscan — Mainnet](https://starkscan.co)
+
+---
+
+MIT License · Built on [Starknet](https://starknet.io)

package/cli-package.json

@@ -0,0 +1,31 @@
+{
+  "name": "create-starkzap-app",
+  "version": "0.1.0",
+  "description": "Interactive CLI to scaffold a Starkzap + Starknet app — Next.js or Vite, Privy or Cartridge",
+  "type": "module",
+  "bin": {
+    "create-starkzap-app": "./scripts/create-starkzap-app.mjs"
+  },
+  "files": [
+    "scripts/"
+  ],
+  "keywords": [
+    "starknet",
+    "starkzap",
+    "create-app",
+    "web3",
+    "scaffold",
+    "cli",
+    "nextjs",
+    "privy",
+    "cartridge"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fati-Onchain/starkzap-starter"
+  },
+  "license": "MIT"
+}

package/next.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  // Starkzap uses ESM — transpile it so Next.js can bundle it correctly
+  transpilePackages: ["starkzap"],
+};
+
+export default nextConfig;

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "starkzap-starter",
+  "version": "0.1.0",
+  "private": false,
+  "description": "Next.js 14 App Router starter kit for building on Starknet with the Starkzap SDK",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "next": "^14.2.0",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
+    "starkzap": "latest",
+    "starknet": "^6.11.0",
+    "clsx": "^2.1.1",
+    "tailwind-merge": "^2.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "typescript": "^5",
+    "tailwindcss": "^3.4.0",
+    "autoprefixer": "^10.4.0",
+    "postcss": "^8.4.0",
+    "eslint": "^8",
+    "eslint-config-next": "14.2.0"
+  }
+}

package/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};