HushCircuits Docs

Appearance

Return to top
On this page
HUSH
CIRCUITS

Getting Started

This is the fastest safe path from first launch to first bridged call.

ONBOARDING TIERS

Mapped from `useOnboarding.ts`

LIGHT TOUR5 STEPS
  1. 1

    Welcome

    welcome

  2. 2

    Destination

    destination

  3. 3

    Voice Effects

    voice-effects

  4. 4

    Caller ID

    caller-id

  5. 5

    Settings

    settings

HEAVY TOUR8 STEPS
  1. 1

    Ready to Call

    welcome

  2. 2

    Enter Destination

    destination

  3. 3

    Mask Identity

    caller-id

  4. 4

    Lock CID

    cid-lock

  5. 5

    Choose Voice

    voice-effects

  6. 6

    Press Dial

    dial-button

  7. 7

    During Call

    status-strip

  8. 8

    Explore More

    settings

Activation rulelight -> heavy when `tokenBalance > 0`

WARNING

The guided onboarding overlay shown in the diagram is currently a design-intent flow. In this branch, onboarding steps are defined in code but not auto-mounted in the live dialer UI yet.

1. Accept Terms

On first launch, open the landing screen and select ENTER SYSTEM.

2. Create or Access Account

From the auth screen:

  • REGISTER: username, email, password, 6-digit PIN, optional Telegram ID.
  • LOGIN: email + password.
  • RESET: password reset flow via email.

3. PIN Lock (Current Runtime Behavior)

After authentication, PIN behavior is mixed between legacy local state and backend verification flows:

  • If local app_pin exists and session is locked, users are prompted for PIN unlock.
  • If local app_pin is missing, the app can currently continue without the lock screen.
  • Sensitive operations (for example in settings/security flows) still use backend verify-pin.

4. Initialize Uplink in Settings

Open Settings -> Phone & PIN and configure:

  • Uplink phone number (11-digit 1XXXXXXXXXX format)
  • Identity lock confirmation
  • Optional Persona Matrix entries

If uplink is missing, the app blocks outbound calls and shows initialization prompts.

5. Fund Wallet

Open Settings -> Wallet and add balance (crypto deposit flow and/or voucher redemption where enabled).

6. Place First Call

  1. Enter destination in the dial field.
  2. Optional: set Caller ID and lock it.
  3. Optional: choose voice effect (OFF, DEEP, ROBOT, ANON).
  4. Press INITIATE_BRIDGE.
  5. Answer your phone when your uplink rings.

7. Verify Post-Call Data

Open:

  • Call History for per-call records and status tags.
  • Call Stats for aggregate charts.
  • Call Recordings for audio vault entries (if recording exists).

Next