Class RoboHost

Readonlyactive

Readonlyid

Readonlyname

Readonlyotp

ReadonlyownerAddress

Readonlysigners

provisioned

• get provisioned(): boolean

  Whether this host has at least one connected signer. false after setup has started (script run or CloudFormation stack launched) means no robo has connected yet — generateSetupScript / generateCloudFormationUrl are still safe to re-run in that case, since no account has enrolled a signer yet.

  Returns boolean

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