@kagamidigital/salt-sdk-mirror
    Preparing search index...

    Type Alias Robos

    The public robos record belonging to an organisation — the encrypted seed (not included) is a secret restricted to organisation owners operating in privileged sessions (use Salt.getRoboHost).

    type Robos = {
        active: boolean;
        id: string;
        name: string | null;
        organisationId: string;
        otp?: string;
        ownerAddress: string | null;
        provider: string | null;
        signers: string[];
        version?: string | null;
    }
    Index

    Properties

    active id name organisationId otp? ownerAddress provider signers version?

    Properties

    active: boolean

    Whether the robo has completed 2FA activation. A robo is created inactive and only becomes usable once the owner activates it via Salt.activateRoboHost.

    id: string

    The robo ID

    name: string | null

    The robo name

    organisationId: string

    The ID of the organisation the robos belong to

    otp?: string

    The setup OTP shown during robo-guardian setup. Present until 2FA activation consumes it..

    ownerAddress: string | null

    The owner's address

    provider: string | null

    The hosting provider, if any

    signers: string[]

    The robo signers' addresses (empty until the host is provisioned)

    version?: string | null

    The salt-sdk version the host reported on its last guardian boot, or null if it has never reported one — either because it has not been provisioned, or because it is running a build predating Salt.reportRoboHostVersion.

    Settings

    Member Visibility

    On This Page

    Properties