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:
- Connect exchange
- Connect wallet
- Add transactions manually
- Upload transactions file
Connect exchange flow
- User selects exchange and enters API credentials
- Connectivity check runs before save
- Credential is created
- Credential status moves to
IMPORTINGwhen valid - Record import job is queued for worker
- After import/activation, credential is usable in portfolio and strategy flows
Connect wallet flow
- User creates wallet and provides one or more public addresses
- Wallet is created with
autoSynchronize = trueby default in UI flow - Wallet status is set to
IMPORTING - Record import job is queued
- 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: