@dxos/protocols 2.28.0

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@dxos/protocols",
+  "version": "2.28.0",
+  "description": "Protobuf definitions for DXOS protocols.",
+  "bugs": {
+    "url": "'https://github.com/dxos/protocols/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dxos/protocols.git"
+  },
+  "license": "MIT",
+  "author": "DXOS.org",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@dxos/codec-protobuf": "2.28.0"
+  },
+  "devDependencies": {
+    "@dxos/toolchain-node-library": "2.28.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "toolchain build",
+    "build:test": "toolchain build:test",
+    "lint": "toolchain lint",
+    "test": "toolchain test"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+//
+// Copyright 2021 DXOS.org
+//

package/src/proto/dxos/bot.proto

@@ -0,0 +1,120 @@
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+import "./client.proto";
+import "./config.proto";
+import "./echo/invitation.proto";
+
+package dxos.bot;
+
+message BotPackageSpecifier {
+  oneof kind {
+    string dxn = 1;
+    string ipfs_cid = 2;
+    string local_path = 3;
+  }
+}
+
+message Bot {
+  enum Status {
+    STOPPED = 0;
+    STARTING = 1;
+    RUNNING = 2;
+    STOPPING = 3;
+  }
+
+  string id = 1;
+  Status status = 2;
+  BotPackageSpecifier package_specifier = 3;
+  Timestamp last_start = 4;
+  dxos.halo.keys.PubKey party_key = 5;
+
+  message Runtime {
+    int32 exit_code = 1;
+    string exit_signal = 2;
+    string error = 3;
+  }
+
+  Runtime runtime = 6;
+}
+
+message GetBotsResponse {
+  repeated Bot bots = 1;
+}
+
+message SpawnBotRequest {
+  BotPackageSpecifier package = 1;
+
+  /// Invitation for the bot to join the target party.
+  dxos.echo.InvitationDescriptor invitation = 2;
+
+  /// Key of the party bot is invited to.
+  dxos.halo.keys.PubKey party_key = 3;
+}
+
+message SendCommandRequest {
+  string bot_id = 1;
+
+  bytes command = 2;
+}
+
+message SendCommandResponse {
+  bytes response = 1;
+}
+
+message GetLogsResponse {
+  bytes chunk = 1;
+}
+
+message GetLogsRequest {
+  string bot_id = 1;
+}
+
+
+/// Service that is used by clients to communicate with bot factory.
+service BotFactoryService {
+  rpc GetBots(google.protobuf.Empty) returns (GetBotsResponse);
+
+  rpc SpawnBot(SpawnBotRequest) returns (Bot);
+ 
+  // TODO(dmaretskyi): Invitations.
+
+  rpc Start(Bot) returns (Bot);
+  rpc Stop(Bot) returns (Bot);
+  rpc Remove(Bot) returns (google.protobuf.Empty);
+  rpc GetLogs(GetLogsRequest) returns (stream GetLogsResponse);
+ 
+  // TODO(dmaretskyi): querying metrics/state.
+ 
+  rpc SendCommand(SendCommandRequest) returns (SendCommandResponse);
+
+  rpc RemoveAll(google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+message InitializeRequest {
+  /// Bot runtime configuration.
+  dxos.config.Config config = 1;
+
+  /// Invitation for the bot to join the target party.
+  dxos.echo.InvitationDescriptor invitation = 2;
+}
+
+message StartRequest {
+  /// Bot runtime configuration.
+  dxos.config.Config config = 1;
+}
+
+/// Service that is used by bots communicating with bot factory.
+service BotService {
+  /// Initialize Client, create profile, and join a party.
+  rpc Initialize(InitializeRequest) returns (google.protobuf.Empty);
+
+  /// Initialize Client.
+  rpc Start(StartRequest) returns (google.protobuf.Empty);
+
+  /// Custom commands sent to the bot factory.
+  rpc Command(SendCommandRequest) returns (SendCommandResponse);
+
+  /// Stop the bot.
+  rpc Stop(google.protobuf.Empty) returns (google.protobuf.Empty);
+}

package/src/proto/dxos/client.proto

@@ -0,0 +1,237 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+import "config.proto";
+import "./echo/invitation.proto";
+import "./echo/snapshot.proto";
+import "./halo/keys.proto";
+
+package dxos.client;
+
+//
+// SYSTEM
+//
+
+service SystemService {
+  rpc GetConfig(google.protobuf.Empty) returns (Config);
+  rpc Reset (google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+//
+// Invitations shared across HALO and ECHO
+//
+
+enum InvitationState {
+  WAITING_FOR_CONNECTION = 1;
+  CONNECTED = 2;
+  SUCCESS = 3;
+  ERROR = 4;
+}
+
+/// Invitation process created by sender.
+message InvitationRequest {
+  InvitationDescriptor descriptor = 1;
+
+  InvitationState state = 2;
+
+  /// Only if state == ERROR.
+  string error = 3;
+}
+
+/// Invitation that is being redeemed.
+message RedeemedInvitation {
+  string id = 1;
+
+  InvitationState state = 2;
+
+  /// Only if state == ERROR.
+  string error = 3;
+
+  /// Only on party invitations that are finished.
+  dxos.halo.keys.PubKey partyKey = 4;
+}
+
+message AuthenticateInvitationRequest {
+  /// Id from corresponding RedeemedInvitation.
+  string processId = 1;
+  bytes secret = 2;
+}
+
+//
+// HALO
+//
+
+message Profile {
+  required dxos.halo.keys.PubKey publicKey = 1; 
+  string username = 2;
+}
+
+message SubscribeProfileResponse {
+  Profile profile = 1;
+}
+
+message CreateProfileRequest {
+  string username = 1;
+  bytes publicKey = 2;
+  bytes secretKey = 3;
+}
+
+message RecoverProfileRequest { 
+  string seedPhrase = 1;
+}
+
+message Contact {
+  dxos.halo.keys.PubKey publicKey = 1;
+  string displayName = 2;
+}
+
+message Contacts {
+  repeated Contact contacts = 1;
+}
+
+service ProfileService {
+  rpc SubscribeProfile (google.protobuf.Empty) returns (stream SubscribeProfileResponse);
+  rpc CreateProfile(CreateProfileRequest) returns (Profile);
+  rpc RecoverProfile(RecoverProfileRequest) returns (Profile);
+    
+  rpc CreateInvitation(google.protobuf.Empty) returns (stream InvitationRequest);
+  rpc AcceptInvitation(InvitationDescriptor) returns (stream RedeemedInvitation);
+  rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
+}
+
+message AddKeyRecordRequest { 
+  KeyRecord keyRecord = 1;
+}
+
+message SignRequest { 
+  /**
+   * - The public key of the key that is supposed to be used for signing.
+   */
+  PubKey publicKey = 1;
+
+  bytes payload = 2;
+}
+
+message SignResponse { 
+  bytes signed = 2;
+}
+
+message SetPreferenceRequest {
+  string key = 1;
+  string value = 2;
+}
+
+message GetPreferenceRequest {
+  string key = 1;
+}
+
+message GetPreferenceResponse {
+  string value = 1;
+}
+
+service HaloService {
+  rpc SubscribeContacts(google.protobuf.Empty) returns (stream Contacts);
+
+  rpc AddKeyRecord(AddKeyRecordRequest) returns (google.protobuf.Empty);
+  rpc Sign(SignRequest) returns (SignResponse);
+
+  rpc SetGlobalPreference(SetPreferenceRequest) returns (google.protobuf.Empty);
+  rpc GetGlobalPreference(GetPreferenceRequest) returns (GetPreferenceResponse);
+
+  rpc SetDevicePreference(SetPreferenceRequest) returns (google.protobuf.Empty);
+  rpc GetDevicePreference(GetPreferenceRequest) returns (GetPreferenceResponse);
+}
+
+//
+// ECHO
+//
+
+message Party {
+  message Member {
+    required dxos.halo.keys.PubKey publicKey = 1;
+    string displayName = 2;
+  }
+
+  required dxos.halo.keys.PubKey publicKey = 1;
+  required bool isOpen = 2;
+  required bool isActive = 3;
+
+  repeated Member members = 4;
+}
+
+message SubscribePartyRequest {
+  required dxos.halo.keys.PubKey partyKey = 1;
+}
+
+message SubscribePartyResponse {
+  Party party = 1;
+}
+
+
+message SubscribePartiesResponse {
+  repeated Party parties = 1;
+}
+
+message CreateInvitationRequest {
+  required dxos.halo.keys.PubKey partyKey = 1;
+
+  /// When specified the invitation will be of OFFLINE type, not requiring secret exchange.
+  dxos.halo.keys.PubKey inviteeKey = 2;
+}
+
+message PartyActivationOptions {
+  bool global = 1;
+  bool device = 2;
+}
+
+message SetPartyStateRequest {
+  required dxos.halo.keys.PubKey partyKey = 1;
+
+  bool open = 2;
+  bool activeGlobal = 3;
+  bool activeDevice = 4;
+}
+
+message SubscribeMembersRequest {
+  required dxos.halo.keys.PubKey partyKey = 1;
+}
+
+message SubscribeMembersResponse {
+  message PartyMember {
+    required dxos.halo.keys.PubKey publicKey = 1;
+    string displayName = 2;
+  }
+
+  repeated PartyMember members = 1;
+}
+
+message CreateSnaspotRequest {
+  dxos.halo.keys.PubKey partyKey = 1;
+}
+
+
+service PartyService {
+  // TODO(rzadp): Combine the two into one?
+  rpc SubscribeToParty (SubscribePartyRequest) returns (stream SubscribePartyResponse);
+  rpc SubscribeParties (google.protobuf.Empty) returns (stream SubscribePartiesResponse);
+
+  rpc CreateParty(google.protobuf.Empty) returns(Party);
+  rpc CloneParty(PartySnapshot) returns(Party);
+
+  /// Open and close or activate and deactivate a party.
+  rpc SetPartyState(SetPartyStateRequest) returns(Party);
+
+  rpc CreateInvitation(CreateInvitationRequest) returns (stream InvitationRequest);
+  rpc AcceptInvitation(InvitationDescriptor) returns (stream RedeemedInvitation);
+  rpc AuthenticateInvitation(AuthenticateInvitationRequest) returns (google.protobuf.Empty);
+
+  // TODO(rzadp): Remove and join with Subscribing to Party.
+  rpc SubscribeMembers (SubscribeMembersRequest) returns (stream SubscribeMembersResponse);
+
+  rpc CreateSnapshot(CreateSnaspotRequest) returns (PartySnapshot);
+}
+

package/src/proto/dxos/config.proto

@@ -0,0 +1,254 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+syntax = "proto3";
+
+package dxos.config;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/descriptor.proto";
+
+message Config {
+  int32 version = 1;
+
+  //
+  // Deploy configuration.
+  //
+
+  Module module = 2;
+
+  //
+  // Build configuration.
+  //
+
+  Build build = 3;
+
+  //
+  // Runtime configuration.
+  //
+
+  Runtime runtime = 4;
+}
+
+message Module {
+  // Specific to record type.
+  message Record {
+    message App {
+      repeated string content_type = 1;
+    }
+
+    App app = 1;
+  }
+
+  // Current build.
+  message Build {
+    string version = 1;
+    string commit_hash = 2;
+    google.protobuf.Timestamp timestamp = 3;
+  }
+
+  string name = 1;
+  string type = 2;
+  string version = 3;
+
+  string author = 4;
+  string license = 5;
+  string description = 6;
+  string repository = 7;
+  string repository_version = 8;
+  repeated string keywords = 9;
+  string display_name = 10;
+  string npm_url = 11;
+
+  Build build = 101;
+  Record record = 102;
+}
+
+message Build {
+  string command = 1;
+  string out = 2;
+}
+
+message Runtime {
+  message Client {
+    /// Whether the client services are local with ClientServiceHost or remote and need to be accessed via ClientServiceProxy. Defaults to AUTOMATIC.
+    enum Mode {
+      /// Connects to the browser wallet if avialable, otherwise runs services in the local mode.
+      AUTOMATIC = 0;
+
+      /// Run services in the local mode.
+      LOCAL = 1;
+
+      /// Connect to the browser wallet or to the remote services through the RPC port.
+      REMOTE = 2;
+    }
+
+    message Storage {
+      enum StorageDriver {
+        RAM = 0;
+        IDB = 1;
+        CHROME = 2;
+        FIREFOX = 3;
+        NODE = 4;
+        
+        // Only for key storage:
+
+        LEVELJS = 11;
+        JSONDOWN = 12;
+      }
+
+      bool persistent = 1;
+      StorageDriver storage_type = 2;
+      StorageDriver key_storage = 3;
+      string path = 4;
+    }
+
+    string debug = 1 [(env) = "DEBUG"];
+    Storage storage = 2;
+    bool enable_snapshots = 3;
+
+    /// Milliseconds
+    int32 snapshot_interval = 4;
+
+    /// Milliseconds
+    int32 invitation_expiration = 5;
+
+    Mode mode = 6;
+  }
+
+  message App {
+    string org = 1;
+    string theme = 2;
+    string website = 3;
+    string publicUrl = 4 [(env) = "PUBLIC_URL"];
+  }
+
+  // CLI configuration
+  message CLI {
+    message AppServe {
+      message Serve {
+        string config = 1;
+        string login_app = 2;
+        string key_phrase = 3;
+      }
+
+      Serve serve = 1;
+    }
+
+    message Package {
+      string package = 1;
+      string channel = 2;
+      string bin = 3;
+      string config = 4;
+    }
+
+    string node_path = 1;
+    AppServe app = 2;
+    Package console = 3;
+    Package mdns = 4;
+    Package signal = 5;
+    string npm_client = 6;
+    string channel = 7;
+  }
+
+  message Props {
+    string title = 1;
+  }
+
+  message System {
+    string debug = 1;
+  }
+
+  //
+  // DXOS Services.
+  //
+  message Services {
+    message Kube {
+
+      message Endpoints {
+        string logs = 1;
+        string services = 2;
+        string cert = 3;
+      }
+    
+      Endpoints endpoints = 1;
+      string public_url = 2;
+    }
+
+    message AppServer {
+      string prefix = 1;
+      string server = 2;
+    }
+
+    message Dxns {
+      /// DXNS endpoint.
+      string server = 1;
+
+      /**
+      * Substrate account URI. This is a secret.
+      * KUBEs do not serve this with the config but we store it in profile.yml.
+      *
+      * TODO(dmaretskyi): Deprecate this and move it to keyring.
+      */
+      string accountUri = 2;
+
+      /**
+       * Public Polkadot Address.
+      */
+      string address = 3;
+
+      /**
+       * Public address of a DXNS Account.
+      */
+      string account = 4;
+
+      string faucet = 5;
+    }
+
+    message Ipfs {
+      string server = 1;
+      string gateway = 2;
+    }
+
+    message Signal {
+      string server = 1;
+      string api = 2;
+      string status = 3;
+    }
+
+    message Ice {
+      string urls = 1;
+      string username = 2;
+      string credential = 3;
+    }
+
+    message Machine {
+      string do_access_token = 1;
+      string github_access_token = 2;
+      string github_username = 3;
+      string dns_domain = 4;
+      string npm_access_token = 5;
+    }
+
+    message BotFactory {
+      string topic = 1;
+    }
+
+    Kube kube = 1;
+    AppServer app = 2;
+    Dxns dxns = 3;
+    Ipfs ipfs = 4;
+    Signal signal = 5;
+    repeated Ice ice = 6;
+    Machine machine = 7;
+    BotFactory bot = 8;
+  }
+
+  Client client = 1;
+  App app = 2;
+  CLI cli = 3;
+  Props props = 4;
+  Services services = 5;
+  System system = 6;
+}