@tdxvolt/volt-client-grpc 0.18.3 → 0.18.4

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

@@ -1,93 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-message HttpInvoke {
-  string host = 1;
-  int32 port = 2;
-  string method = 3;
-  string url = 4;
-  string version = 5;
-  map <string, string> headers = 6;
-  bytes body = 7;
-}
-
-message HttpPayload {
-  bytes chunk = 1;
-  oneof end_ {
-    bool end = 2;
-  }
-  oneof error_ {
-    int32 error = 3;
-  }
-}
-
-message HttpRequest {
-  uint64 id = 1;
-  oneof payload {
-    HttpInvoke http_invoke = 2;
-    HttpPayload http_payload = 3;
-  }
-}
-
-message HttpResponse {
-  uint64 id = 1;
-  HttpPayload http_payload = 7;
-}
-
-enum MethodType {
-  METHOD_TYPE_UNKNOWN = 0;
-  METHOD_TYPE_UNARY = 1;
-  METHOD_TYPE_CLIENT_STREAM = 2;
-  METHOD_TYPE_SERVER_STREAM = 3;
-  METHOD_TYPE_BIDI = 4;
-}
-
-message MethodInvoke {
-  uint64 id = 1;
-  string service_id = 2;
-  string method_name = 3;
-  MethodType method_type = 4;
-  oneof invoke_request {
-    bytes request = 6;
-    string json_request = 7;
-  }
-}
-
-message MethodPayload {
-  uint64 id = 1;
-  oneof method_payload {
-    bytes payload = 2;
-    string json_payload = 3;
-  }
-}
-
-message MethodEnd {
-  uint64 id = 1;
-  bool ended = 4;
-  string error = 5;
-  int32 error_code = 6;
-}
-
-message RemotePing {
-  uint64 timestamp = 1;
-}
-
-message RemoteRequest {
-  oneof payload {
-    RemotePing ping = 1;
-    MethodPayload method_payload = 3;
-    MethodEnd method_end = 4;
-    HttpResponse http_response = 5;
-  }
-}
-
-message RemoteResponse {
-  oneof payload {
-    RemotePing ping = 1;
-    MethodInvoke method_invoke = 2;
-    MethodPayload method_payload = 3;
-    MethodEnd method_end = 4;
-    HttpRequest http_request = 5;
-  }
-}

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

@@ -1,121 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-
-// The Spark API allows clients to start and communicate with Spark VMs.
-service SparkAPI {
-  // Start or connect to a spark VM and establish a long-lived communication channel.
-  rpc Spark(stream SparkRequest) returns (stream SparkResponse);
-
-  // Get details of running spark VMs.
-  rpc GetSpark(GetSparkRequest) returns (GetSparkResponse);
-}
-
-// Start a resource-hosted spark.
-// Provenance is determined from the resource owner.
-message StartSparkResource {
-  // The id of the resource containing the VM byte code.
-  string resource_id = 1;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 2;
-
-  // Envelope signature.
-  string signature = 3;
-}
-
-// Start a spark from byte code included in the payload, along with issuer/developer claims and signature.
-message StartSparkAdhoc {
-  // Ad-hoc byte code of VM to run.
-  bytes byte_code = 1;
-
-  // Verifiable credentials associated with this spark.
-  repeated string credential = 2;
-
-  // Envelope signature.
-  string signature = 3;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 4;
-}
-
-// Send commands and payloads to communicate with a running spark.
-message SparkCommand {
-  // Optional id to associate with this command.
-  // If this is omitted, an id will be assigned and returned in the command acknowledgement.
-  string command_id = 1;
-
-  // The command to send to the spark.
-  string command = 2;
-
-  // The command payload.
-  string payload = 3;
-
-  // Command verifiable credential.
-  string credential = 4;
-
-  // Command signature.
-  string signature = 5;
-}
-
-// The request must contain one of the messages indicated below.
-message SparkRequest {
-  oneof payload {
-    StartSparkResource start_resource = 1;
-    StartSparkAdhoc start_adhoc = 2;
-    SparkCommand command = 3;
-  }
-}
-
-// Receive events and payload from a running spark.
-message SparkData {
-  // The command id to which this data corresponds.
-  string command_id = 1;
-
-  oneof payload {
-    // Acknowledges receipt of a spark command.
-    bool acknowledge = 2;
-
-    // Indicates the command has completed.
-    bool ended = 3;
-
-    // Will contain error details on command failure.
-    string error = 4;
-
-    // Data emitted by a command, usually in stringified JSON format.
-    string data = 5;
-  }
-}
-
-// Details of a spark instance.
-message SparkInstance {
-  // The UUID assigned to the spark instance.
-  string spark_id = 1;
-}
-
-// The response will contain one of the messages indicated below.
-message SparkResponse {
-  oneof payload {
-    // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status status = 1;
-
-    // Details of the spark instance, sent in response to a start command.
-    SparkInstance spark_instance = 2;
-
-    // Payload data emitted by the spark.
-    SparkData spark_data = 3;
-  }
-}
-
-message GetSparkRequest {
-  string spark_id = 1;
-}
-
-// One of the following fields will be present in the response.
-message GetSparkResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-

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

@@ -1,66 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-message DIDRegistryUpdate {
-  // The id of the update.
-  // Reserved for internal use.
-  uint64 id = 1;
-
-  // The id of the identity.
-  string did = 2;
-
-  // The type of update, either "add", "update" or "delete".
-  string operation = 3;
-
-  // The DID document contained in the update.
-  string document = 4;
-
-  // 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 {
-  // 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

@@ -1,214 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-import "tdx/volt_api/volt/v1/ssi.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);
-
-  // Get all updates to the DID registry since the specified timestamp.
-  // Internal use only.
-  rpc GetDIDRegistryUpdates(GetDIDRegistryUpdatesRequest) returns (GetDIDRegistryUpdatesResponse);
-
-  // Import a verifiable credential.
-  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 intended for use by the DID registry when synchronising with other registries.
-  // To register a new DID document, it is recommended to use the VoltAPI Authenticate method.
-  rpc RegisterDIDDocument(RegisterDIDDocumentRequest) returns (RegisterDIDDocumentResponse);
-
-  // Save a verifiable credential.
-  rpc SaveCredential(SaveCredentialRequest) returns (SaveCredentialResponse);
-
-  // Search the DID registry.
-  rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
-}
-
-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;
-  }
-
-  // Optional passphrase of the DID controller key. Required if the key is encrypted.
-  string key_passphrase = 3;
-}
-
-message DeleteDIDResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
-message GetDIDRegistryUpdatesRequest {
-  // The id of the last update received.
-  // All updates since this id will be returned, limited to the maximum number of updates specified in the request.
-  // To fully synchronise, clients should continue calling this method until the response contains no updates.
-  // If this is the first call, then this should be set to 0.
-  uint64 since_id = 1;
-
-  // The maximum number of updates to return, defaults to 1000.
-  uint32 max_updates = 2;
-
-  // Filter by origin volt.
-  string origin_volt = 3;
-}
-
-message GetDIDRegistryUpdatesResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The updates.
-  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;
-
-  // Set to search all known registries rather than just the local registry.
-  bool include_registries = 2;
-}
-
-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.
-  string did_document = 2;
-
-  // The signature used to save this version of the DID document.
-  string update_signature = 3;
-
-  // 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 {
-  bool create = 1;
-
-  // The DID document to save.
-  DIDRegistryUpdate did_update = 2;
-
-  // When updating an existing DID document, it is necessary to include a signature of the document JSON, signed by the DID document's current owner.
-  string update_signature = 3;
-}
-
-message RegisterDIDDocumentResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  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;
-
-  // Optional id of the folder resource to save the credential in.
-  string create_in_parent_id = 3;
-}
-
-message SaveCredentialResponse {
-  // 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;
-
-  // The JSON representation of the credential.
-  string json = 3;
-}
-
-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;
-  }
-
-  // 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 SearchDIDRegistryResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-
-  // The DID documents that matched the search criteria.
-  repeated DIDRegistryUpdate did_document = 2;
-}

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

@@ -1,15 +0,0 @@
-syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-message Status {
-  // A simple error code that can be easily handled by the client.
-  // Mirrors the grpc StatusCode enum, 0 => OK
-  int32 code = 1;
-
-  // A developer-facing human-readable error message in English. It should both explain the error and offer an actionable resolution to it.
-  string message = 2;
-
-  // Long form error description.
-  string description = 3;
-}

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

@@ -1,42 +0,0 @@
-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;
-}
-