Skip to content

Workflow: Onboarding

Goal

Get a new user from empty account to first reliable portfolio state.

Entry point

New users start with mustOnboard = true and are guided to onboarding choices.

Primary onboarding options:

  1. Connect exchange
  2. Connect wallet
  3. Add transactions manually
  4. Upload transactions file

Connect exchange flow

  1. User selects exchange and enters API credentials
  2. Connectivity check runs before save
  3. Credential is created
  4. Credential status moves to IMPORTING when valid
  5. Record import job is queued for worker
  6. After import/activation, credential is usable in portfolio and strategy flows

Connect wallet flow

  1. User creates wallet and provides one or more public addresses
  2. Wallet is created with autoSynchronize = true by default in UI flow
  3. Wallet status is set to IMPORTING
  4. Record import job is queued
  5. Wallet contributes balances and transaction history after import

Manual transaction path

Users can also begin by creating deposits/orders directly. This is useful for historical correction and non-connected scenarios.

Onboarding completion trigger

When a user performs key setup actions (for example adding a credential, wallet, or first manual transaction), onboarding is disabled and normal navigation becomes primary.

Related: