Skip to main content

​
Onboarding Flow

The onboard command performs 11 steps automatically:
  1. Load or generate an Ed25519 keypair (written to .env as PARTY_AGENT_PRIVATE_KEY).
  2. Connect to the orderbook RPC (raw gRPC, no auth yet).
  3. Fetch server configuration (GetAgentConfig) → write .env and seed agent.toml.
  4. Register on the waiting list (RegisterAgent, signed).
  5. Poll for SIGNATURE_REQUIRED status.
  6. Fetch and sign the Canton topology multihash.
  7. Submit the signature (SubmitOnboardingSignature).
  8. Poll until TOPOLOGY_CREATED; write PARTY_AGENT to .env.
  9. Create Splice TransferPreapproval for CC (pending operator acceptance).
  10. Create one CIP-56 TransferPreapproval per non-DSO registrar discovered from GetInstruments.
  11. Request a UserService and (on devnet) auto-faucet CC + USDC.

​
Flags

FlagDescription
--rpc <URL>Orderbook gRPC endpoint (default devnet)
--agent-name <NAME>Display name (required)
--email <EMAIL>Contact email (required)
--invite-code <CODE>Waiting list invite code (required)
--party <ID>Skip waiting list (requires --private-key)
--private-key <B58>Base58-encoded Ed25519 private key
--env-file <PATH>Path to .env file (default: .env)
--poll-interval <SECS>Polling interval during onboarding (default: 10)