@tdxvolt/volt-client-grpc 0.16.0-beta.10 → 0.16.0-beta.13

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.16.0-beta.10",
+  "version": "0.16.0-beta.13",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {
@@ -37,15 +37,13 @@
   "license": "ISC",
   "dependencies": {
     "@grpc/proto-loader": "^0.6.4",
+    "@tdxvolt/volt-client-web": "^0.16.0-beta.11",
     "bent": "^7.3.12",
-    "bs58": "^4.0.1",
     "builtin-modules": "^3.3.0",
     "debug": "^4.1.1",
     "ip": "^1.1.5",
     "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.15",
-    "minimist": "^1.2.0",
-    "node-forge": "^1.3.1",
     "uuid": "^8.1.0"
   }
 }

package/protobuf/tdx/volt_api/data/v1/sqlite_database_api.proto

@@ -38,23 +38,53 @@ message SqlBulkUpdateResponse {
   tdx.volt_api.volt.v1.Status status = 1;
 }
 
-// The initial request should include the `database_id` and `statement` fields and an optional `page_size` for SELECT statements.
-// To retrieve subsequent pages, send another request with just the `page_size` field set.
-message SqlExecuteRequest {
-  // The id of the database to execute the statement on, only necessary on the first request message.
+message SqlExecuteStart {
+  // The id of the database to execute on.
   string database_id = 1;
 
-  // The SQL statement to execute, only necessary on the first request message.
-  string statement = 2;
+  // Set to start a transaction. If not set, each statement will be executed in its own transaction.
+  bool transaction = 2;
+
+  // The SQL statement to execute.
+  string statement = 3;
 
   // This can be used to limit the number of rows returned by `SELECT` statements to avoid overloading a client. It is similar to using 'LIMIT/OFFSET' clauses on the 'SELECT' statement, but this method is easier to manage and the entire result set will be prepared on the Volt, and the client can then page through it by sending successive messages.
-  uint32 page_size = 3;
+  uint32 page_size = 4;
 
-  // The values to set for each parameter defined in a database query.
-  // This field is only relevant to 'query' databases, i.e. those with kind `tdx:sqlite-query`.
-  // The values in the map should be keyed by parameter name.
+  // Set to indicate that the query will be cancelled if the client disconnects.
+  // This is useful for long running queries, where it might be desirable for the client to be able to cancel the request before all the data is received. However this requires a worker thread to be allocated to the query until it completes, which may affect performance and limit the number of concurrent queries that can be executed due to file handle limitations.
+  // Only applicable to `SELECT` statements, ignored otherwise.
+  bool can_cancel = 5;
+
+  //The values to set for each parameter defined in a database view.
+  //This field is only relevant to 'query' databases, i.e. those with kind `tdx:sqlite-view`.
+  //The values in the map should be keyed by parameter name.
   // A query may have no parameters defined, in which case leave this field empty.
-  map<string, tdx.volt_api.volt.v1.AttributeValue> parameter = 4;
+  map<string, tdx.volt_api.volt.v1.AttributeValue> parameter = 6;
+}
+
+// Intentionally empty.
+message SqlExecuteNext {
+}
+
+// Ends the call.
+message SqlExecuteEnd {
+  // Set to commit the transaction. If not set, the transaction will be rolled back.
+  bool commit_transaction = 1;
+}
+
+message SqlExecuteRequest {
+  oneof payload {
+    // Initialise the request with the database id and whether to execute within a transaction.
+    // Also includes the SQL statement to execute.
+    SqlExecuteStart start = 2;
+
+    // To retrieve subsequent pages, send a `next` request.
+    SqlExecuteNext next = 3;
+
+    // To end the call, send an `end` request. Only really necessary for transaction-based calls, otherwise clients can just close the stream.
+    SqlExecuteEnd end = 4;
+  }
 }
 
 // One of the following fields will be present in any given message.
@@ -89,6 +119,9 @@ message SqlImportCSVConfiguration {
 
   // Optional - the interval to receive progress updates, in number of rows. E.g. set to 1000 to receive progress updates every 1000 rows. Set to 0 to disable progress updates.
   uint32 progress_interval = 5;
+
+  // The number of rows scanned to infer the schema. Set to 0 to scan the entire file.
+  uint32 schema_scan_limit = 6;
 }
 
 // Each message must contain one and only one of the following fields.
@@ -97,11 +130,14 @@ message SqlImportCSVRequest {
     // The initial request must contain the configuration parameters for the import.
     SqlImportCSVConfiguration configuration = 1;
 
+    // Set to indicate that the upload is complete.
+    bool upload_complete = 2;
+
     // Subsequent requests may contain the data to be imported, unless importing from an existing resource that contains the CSV data. It is recommended that the block size is less than 1MB.
-    bytes block = 2;
+    bytes block = 3;
 
     // Set to abort the import.
-    bool abort = 3;
+    bool abort = 4;
   }
 }
 

package/protobuf/tdx/volt_api/data/v1/sqlite_server_api.proto

@@ -35,6 +35,9 @@ message CreateDatabaseRequest {
   // Each alias must be unique to the Volt, this is enforced by the API.
   // No format restrictions are currently applied to alias, but this may change in future, for the time being it makes sense to stick to alphanumeric characters and '_' or '-'.
   repeated string alias = 7;
+
+  // Optional description of the database.
+  string description = 8;
 }
 
 message CreateDatabaseResponse {

package/protobuf/tdx/volt_api/volt/v1/discovery_api.proto

@@ -25,10 +25,6 @@ message SignedEndpoint {
   // The discovered Volt's challenge code, signed by the Volt private key and base64 encoded.
   // If a client knows the Volt challenge code by some out-of-band means, it can use the Volt public key (contained in the endpoint information above) to determine that the discovered Volt also knows the same challenge code.
   string challenge_signature = 2;
-
-  // The discovered Volt's owner credential, signed by the Volt private key and base64 encoded.
-  // A client can use this to discover all Volts owned by a specific user.
-  string owner_credential_signature = 4;
 }
 
 message DiscoverResponse {

package/protobuf/tdx/volt_api/volt/v1/ssi.proto

@@ -4,37 +4,63 @@ package tdx.volt_api.volt.v1;
 
 message DIDRegistryUpdate {
   // The id of the update.
-  // This is populated and maintained by the Volt.
+  // Reserved for internal use.
   uint64 id = 1;
 
   // The id of the identity.
   string did = 2;
 
-  // The type of update.
+  // The type of update, either "add", "update" or "delete".
   string operation = 3;
 
   // The DID document contained in the update.
   string document = 4;
 
-  // The signature extracted from the DID document.
-  string signature = 5;
+  // The hash of DID document.
+  // This is for internal use in comparisons.
+  string hash = 5;
 
   // The signature of the update.
   string update_signature = 6;
 
+  // The timestamp of this update.
   uint64 timestamp = 7;
 
   // The vector clocks for this DID.
   // The vector clocks are a map of the peer ID to the id of the last update received for this DID.
   map<string, uint64> vector_clock = 8;
 
+  // The id of the Volt that first created this DID.
   string origin_volt = 9;
 
+  // Optional description of this document, this is not part of the DID document or signature.
   string description = 10;
 }
 
 message VerifiablePresentation {
-  string credential = 1;
+  // The credential JSON.
+  string credential_json = 1;
+
+  // A signature of the credential JSON. The signature should usually be that of the credential subject.
   string signature = 2;
 }
 
+message VerifiableCredential {
+  // The credential id. Leave empty when creating a new credential.
+  string id = 1;
+
+  // The credential status, either "pending", "verified", or "revoked".
+  string status = 2;
+
+  // The credential types.
+  repeated string type = 3;
+
+  // The DID of the issuer.
+  string issuer_id = 4;
+
+  // The JSON of the credential subject.
+  string subject_json = 5;
+
+  // The full JSON of the credential.
+  string json = 6;
+}

package/protobuf/tdx/volt_api/volt/v1/ssi_api.proto

@@ -6,37 +6,51 @@ import "tdx/volt_api/volt/v1/ssi.proto";
 import "tdx/volt_api/volt/v1/status.proto";
 
 service SsiAPI {
+  // Delete a DID document or all DID documents originating from a given Volt.
+  // Requires 'volt:delete-did' API privilege.
   rpc DeleteDID(DeleteDIDRequest) returns (DeleteDIDResponse);
-  rpc GetDIDDocument(GetDIDDocumentRequest) returns (GetDIDDocumentResponse);
+
+  // Get all updates to the DID registry since the specified timestamp.
+  // Internal use only.
   rpc GetDIDRegistryUpdates(GetDIDRegistryUpdatesRequest) returns (GetDIDRegistryUpdatesResponse);
+
+  rpc ImportCredential(ImportCredentialRequest) returns (ImportCredentialResponse);
+
+  // Parse a verifiable credential from a URL or a verifiable presentation.
   rpc ParseCredential(ParseCredentialRequest) returns (ParseCredentialResponse);
+
+  // Resolve a DID to a DID document.
   rpc ResolveDID(ResolveDIDRequest) returns (ResolveDIDResponse);
+
+  // Register a DID document.
+  // This is currently reserved for use by the DID registry when synchronising with other registries.
+  // To register a new DID document, use the VoltAPI Authenticate method.
   rpc RegisterDIDDocument(RegisterDIDDocumentRequest) returns (RegisterDIDDocumentResponse);
-}
 
-message DeleteDIDRequest {
-  // The id of the identity to delete.
-  string did = 1;
-}
+  // Save a verifiable credential.
+  rpc SaveCredential(SaveCredentialRequest) returns (SaveCredentialResponse);
 
-message DeleteDIDResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
+  // Search the DID registry.
+  rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
 }
 
-message GetDIDDocumentRequest {
-  // The id of the identity to retrieve.
-  string did = 1;
+message DeleteDIDRequest {
+  // Specify an individual DID as the target of the delete operation, or a Volt to delete all DIDs owned by that Volt.
+  oneof target {
+    // The id of the identity to delete.
+    string did = 1;
+
+    // Force delete of all DIDs owned by the specified Volt.
+    string origin_volt = 2;
+  }
 
-  // If set, the search is restricted to the local registry only, otherwise all configured registries are searched.
-  bool local_only = 2;
+  // Optional passphrase of the DID controller key. Required if the key is encrypted.
+  string key_passphrase = 3;
 }
 
-message GetDIDDocumentResponse {
+message DeleteDIDResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
-
-  DIDRegistryUpdate did_document = 2;
 }
 
 message GetDIDRegistryUpdatesRequest {
@@ -49,6 +63,7 @@ message GetDIDRegistryUpdatesRequest {
   // The maximum number of updates to return, defaults to 1000.
   uint32 max_updates = 2;
 
+  // Filter by origin volt.
   string origin_volt = 3;
 }
 
@@ -60,6 +75,52 @@ message GetDIDRegistryUpdatesResponse {
   repeated DIDRegistryUpdate update = 2;
 }
 
+message ImportCredentialRequest {
+  // Optional id of existing credential to import into. If not specified, a new credential will be created.
+  string id = 1;
+
+  // The JSON representation of the credential.
+  string json = 2;
+
+  // Optional id of the folder resource to save the credential in. This is ignored if the id field is specified.
+  string create_in_parent_id = 3;
+
+  // Optional description of the credential.
+  string description = 4;
+}
+
+message ImportCredentialResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // The id assigned to the credential.
+  string id = 2;
+}
+
+message ParseCredentialRequest {
+  // Details of the credential to parse.
+  oneof credential {
+    // A presentation of the verifiable credential.
+    // The presentation doesn't need to be signed, but if it is, the signature will be verified using the public key provided in the request.
+    VerifiablePresentation verifiable_presentation = 1;
+
+    // A URL to a verifiable credential.
+    // Not yet implemented.
+    string url = 2;
+  }
+
+  // Optional public key to use to verify the presentation signature.
+  string presentation_public_key = 3;
+}
+
+message ParseCredentialResponse {
+  // Details of any error that occurred on the call.
+  tdx.volt_api.volt.v1.Status status = 1;
+
+  // The parsed credential details.
+  VerifiableCredential verifiable_credential = 2;
+}
+
 message ResolveDIDRequest {
   // The DID to resolve.
   string did = 1;
@@ -69,6 +130,7 @@ message ResolveDIDRequest {
 }
 
 message ResolveDIDResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
   // The JSON representation of the DID document.
@@ -79,6 +141,9 @@ message ResolveDIDResponse {
 
   // The DID of the Volt that saved this version of the DID document.
   string origin_volt = 4;
+
+  // Optional description associated with the DID document.
+  string description = 5;
 }
 
 message RegisterDIDDocumentRequest {
@@ -99,28 +164,51 @@ message RegisterDIDDocumentResponse {
   DIDRegistryUpdate did_document = 2;
 }
 
+message SaveCredentialRequest {
+  // A human-readable description of the credential.
+  string description = 1;
+
+  // Details of the credential to save.
+  VerifiableCredential verifiable_credential = 2;
 
-// Empty ATM - a VC is issued for the authenticated identity.
-message TrustVerifiableCredentialRequest {
+  // Optional id of the folder resource to save the credential in.
+  string create_in_parent_id = 3;
 }
 
-message TrustVerifiableCredentialResponse {
+message SaveCredentialResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
-  string verifiable_credential_json = 2;
+
+  // The id assigned to the credential.
+  string id = 2;
+
+  // The JSON representation of the credential.
+  string json = 3;
 }
 
-message ParseCredentialRequest {
-  oneof credential {
-    VerifiablePresentation verifiable_presentation = 1;
-    string url = 2;
+message SearchDIDRegistryRequest {
+  oneof filter {
+    // Filter by DID itself. This is a prefix match, so searching for 'did:volt:123' will match 'did:volt:1234'. You can also exclude the 'did:volt:' prefix.
+    string did_filter = 1;
+
+    // Filter by the (optional) description attached to the DID document. This will match any DID document whose description contains the specified string, for example 'John' will match 'John Smith', 'Elton John' and 'Jasper Johns-Frederick'.
+    string description_filter = 2;
+
+    // Filter by the origin Volt. This will match any DID document whose origin Volt matches exactly the given DID.
+    string origin_filter = 3;
   }
-  string public_key = 3;
+
+  // The page number to retrieve, defaults to 1.
+  uint32 page_number = 4;
+
+  // The number of results per page, defaults to 100.
+  uint32 page_size = 5;
 }
 
-message ParseCredentialResponse {
+message SearchDIDRegistryResponse {
+  // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
-  string id = 2;
-  string issuer_id = 3;
-  string subject_id = 4;
-  string claim_json = 5;
+
+  // The DID documents that matched the search criteria.
+  repeated DIDRegistryUpdate did_document = 2;
 }

package/protobuf/tdx/volt_api/volt/v1/terminal_api.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+package tdx.volt_api.volt.v1;
+
+import "tdx/volt_api/volt/v1/status.proto";
+
+service TerminalAPI {
+  rpc CommandStream(stream CommandStreamRequest) returns (stream CommandStreamResponse);
+}
+
+message TerminalSize {
+  int32 rows = 1;
+  int32 cols = 2;
+}
+
+message Control {
+  string command = 1;
+  repeated string arg = 2;
+  string stop = 3;
+  string pause = 4;
+  string resume = 5;
+  string reset = 6;
+  TerminalSize terminal_size = 7;
+  int32 interrupt = 8;
+}
+
+message Input {
+  bytes data = 1;
+}
+
+message CommandStreamRequest {
+  oneof payload {
+    Control control = 1;
+    Input input = 2;
+  }
+}
+
+message CommandStreamResponse {
+  tdx.volt_api.volt.v1.Status status = 1;
+  bytes data = 2;
+}
+