Class RoboHost

Readonlyactive

Readonlyid

Readonlyname

ReadonlyorganisationId

Readonlyotp

ReadonlyownerAddress

Readonlysigners

Readonlyversion

activate

• activate(walletClient: ViemWalletClientLike): Promise<RoboHost>

  Complete 2FA activation for this host, flipping it from inactive to active. This is what makes a robo host usable, and it consumes the setup OTP.

  The natural next step once waitUntilOnline resolves. Signed by the owner, whose signed message must carry this host's OTP verbatim — so activation is a deliberate confirmation that the code the owner is looking at matches the one the host was provisioned with.

  Parameters

  • walletClient: ViemWalletClientLike

    The owner's wallet, used to sign the activation

  Returns Promise<RoboHost>

  A fresh RoboHost, now active and with its OTP consumed

  Throws

  ValidationError if this host record carries no setup OTP (otp is null) — activation has already consumed it

  Example

  const onlineHost = await onlineHost.waitUntilOnline();
  const activeHost = await activeHost.activate(wallet);
  console.log(activeHost.active); // true
  Copy

generateCloudFormationUrl

• generateCloudFormationUrl(
      params: Omit<RoboCloudFormationUrlParams, "otp">,
  ): string

  Build an AWS CloudFormation quick-create console URL that provisions a robo host from Salt's launch template, pre-filled with the robo's setup OTP and the owner's public key. Opening it in a browser signed in to AWS launches the stack; the host then runs the same setup as generateSetupScript.

  Parameters

  • params: Omit<RoboCloudFormationUrlParams, "otp">

    The owner's public key and stack name

  Returns string

  The CloudFormation quick-create URL

  Throws

  ValidationError if this host record carries no setup OTP (otp is null). Hosts returned by Salt.createRoboHost always carry it; hosts fetched with Salt.getRoboHost carry it until activation consumes it

  Example

  const url = host.generateCloudFormationUrl({
    publicKey: ownerPublicKey,
    stackName: 'my-org-robos',
  });
  console.log(`Open to launch: ${url}`);
  Copy

generateSetupScript

• generateSetupScript(params: Omit<RoboSetupScriptParams, "otp">): string

  Build the install-robos.sh setup script for a self-hosted robo, targeting this instance's environment. Run as root on an Ubuntu/Debian host, the script installs Docker, generates a seed on the host, encrypts it to the owner's public key, uploads the encrypted backup to Salt, and starts the robo container with an automatic updater. The plaintext seed never leaves the host.

  Parameters

  • params: Omit<RoboSetupScriptParams, "otp">

    The owner's public key

  Returns string

  The setup script contents

  Throws

  ValidationError if this host record carries no setup OTP (otp is null). Hosts returned by Salt.createRoboHost always carry it; hosts fetched with Salt.getRoboHost carry it until activation consumes it

  Example

  const script = host.generateSetupScript({ publicKey: ownerPublicKey });
  fs.writeFileSync('install-robos.sh', script);
  Copy

listenToSetup

• listenToSetup(): Promise<RoboSetupListener>

  Start listening for this host's setup-progress updates. Connects the session's websocket if it is not already up, so there is no need to call Salt.connect first.

  Progress is advisory — see RoboSetupListener. Nothing it emits establishes that the host is ready; waitUntilOnline does that.

  Returns Promise<RoboSetupListener>

  A listener that is already subscribed. Call disableSetupListener() when you are done listening.

  Throws

  SocketError if the socket cannot be opened

  Example

  const setup = await host.listenToSetup();
  setup.on('setupUpdate', ({ step, description }) => {
    console.log(`${step}: ${description}`);
  });
  Copy

waitUntilOnline

• waitUntilOnline(options?: WaitUntilOnlineOptions): Promise<RoboHost>

  Wait until every one of this host's robo guardians has connected to Salt, then return a freshly fetched host record.

  The only truthful measure that provisioning completed successfully.

  activate is the owner's next step after this resolves.

  Parameters

  • options: WaitUntilOnlineOptions = {}

    Timeout and poll interval; see WaitUntilOnlineOptions

  Returns Promise<RoboHost>

  A fresh RoboHost whose signers are all online

  Throws

  RoboHostTimeoutError if they are not all online in time. The error carries the last presence snapshot, which distinguishes "the script never registered its signers" from "some guardians connected and others did not"

  Example

  const online = await host.waitUntilOnline({ timeoutMs: 20 * 60_000 });
  const active = await online.activate(wallet);
  Copy