A Web3 wallet and agent platform for the Unicity network — crypto wallet, DMs, group chat, and marketplace.

Unicity state transitions:

• Fast, low-cost token transfers
• Token management and balance tracking
• Incoming payment notifications
• Nametag system (@username)

Common: QR codes, wallet switching, seed phrase management, real-time market data.

Sphere implements ConnectHost — the wallet side of the Sphere Connect protocol. External dApps can connect to Sphere and request wallet operations:

• Iframe mode — dApp embedded inside Sphere as an iframe connects via PostMessageTransport
• Popup mode — dApp opens Sphere as a popup window, user approves the connection
• Permission-based access — dApp requests specific scopes; user approves or rejects
• Intent handling — dApp triggers send/sign/DM flows in the wallet UI

Key components: ConnectPage (/connect route), ConnectProvider, ConnectionApprovalModal.

Sphere supports a custom URL protocol for inter-app linking within DMs. When a dApp sends a unicity-connect:// URL in a DM, Sphere renders it as an interactive button with two options: Open in Sphere (loads the URL as an iframe agent) or Open in browser (opens in a new tab).

Protocol format:

unicity-connect://host/path?query=params

When opened, the protocol is resolved to https:// (or http:// for localhost/127.0.0.1).

How it works:

1. Sending — a dApp builds a URL and replaces https:// with unicity-connect:// before sending it as a DM message
2. Rendering — Sphere's markdown parser detects unicity-connect:// in plain text, [text](unicity-connect://...), and <a href="unicity-connect://..."> formats, rendering a DeepLinkButton dropdown
3. Opening in Sphere — a global handler (registered by useDeepLinkNavigation in DashboardLayout) navigates to /agents/custom?url=<httpsUrl>, loading the target as an iframe agent
4. Opening in browser — the resolved http(s):// URL is opened in a new tab via window.open

Key files:

• src/utils/deepLinkHandler.ts — protocol conversion (deepLinkToHttps), global click handler registry
• src/utils/markdown.tsx — DeepLinkButton component, deep link detection in all link formats
• src/hooks/useDeepLinkNavigation.ts — registers the Sphere-side navigation handler

Agents are specialized interfaces loaded as tabs. Currently active:

• Messages (DM) — private conversations via Nostr
• Group Chat — public group channels via NIP-29
• Sphere Agents — load any external dApp via iframe (custom URL)

Additional agent types can be added in src/config/activities.ts.

Relay-based group messaging via NIP-29:

• Public and private groups with invite codes
• Real-time messaging via WebSocket
• Group discovery, join/leave, unread tracking
• Dedicated Zooid relay at wss://sphere-relay.unicity.network

• Node.js 20+

npm install
cp .env.example .env    # Configure environment variables
npm run dev              # Start dev server at http://localhost:5173

npm run dev          # Development server
npm run build        # TypeScript compile + Vite production build
npm run preview      # Preview production build
npm run lint         # ESLint
npm run test         # Vitest watch mode
npm run test:run     # Vitest single run

Copy .env.example to .env. Key variables:

VITE_WELCOME_AGENT_NAMETAG=kbbot # Welcome DM agent nametag
VITE_WELCOME_DELAY_MS=4000       # Delay before welcome DM (ms)
SSL_CERT_PATH=                   # Dev server HTTPS (optional)
HMR_HOST=                        # Remote HMR host (optional)
BASE_PATH=/                      # Deployment base path

• React 19 + TypeScript, Vite 7
• TanStack Query v5 — server state
• Tailwind CSS 4 — styling
• Framer Motion — animations
• React Router DOM v7 — routing
• @unicitylabs/sphere-sdk — all wallet operations (L3, Nostr, IPFS)
• Vitest + jsdom — testing

src/
├── index.html           # HTML entry point
├── main.tsx             # App bootstrap, provider tree
├── App.tsx              # Route definitions
├── sdk/                 # React adapter layer over sphere-sdk (24 files)
│   ├── hooks/core/      # useSphere, useWalletStatus, useIdentity, useNametag, useSphereEvents, useIpfsSync
│   ├── hooks/payments/  # useTokens, useBalance, useAssets, useTransfer, useTransactionHistory
│   ├── hooks/comms/     # useSendDM, usePaymentRequests
│   └── utils/           # format utilities
├── components/
│   ├── activity/        # Activity ticker, market feed display
│   ├── agents/          # Agent cards and selection
│   ├── chat/            # DM, group chat, mini chat, hooks
│   ├── wallet/          # L3, onboarding, shared, ui components
│   ├── layout/          # DashboardLayout, Header
│   ├── desktop/         # Desktop layout, TabBar, Taskbar
│   ├── connect/         # Wallet connection flow
│   └── ...              # splash, theme, tutorial, ui
├── pages/               # IntroPage, AgentPage, MarketsPage, + lazy-loaded pages
├── hooks/               # 9 app-level hooks
├── contexts/            # ServicesProvider (GroupChat)
├── services/            # FaucetService
├── config/              # activities, localStorage keys
├── lib/                 # TanStack Query client config
├── utils/               # markdown, mentions, retry
└── types/               # TypeScript type definitions
tests/
└── unit/                # Vitest tests (jsdom)

docker compose up        # Runs on port 3010

Private project — Unicity Labs