@dashevo/dapi-grpc 3.1.0-dev.8 → 4.0.0-beta.1

package/clients/platform/v0/web/platform_pb_service.d.ts

@@ -130,6 +130,15 @@ type PlatformgetDataContracts = {
   readonly responseType: typeof platform_pb.GetDataContractsResponse;
 };
 
+type PlatformgetDocumentHistory = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetDocumentHistoryRequest;
+  readonly responseType: typeof platform_pb.GetDocumentHistoryResponse;
+};
+
 type PlatformgetDocuments = {
   readonly methodName: string;
   readonly service: typeof Platform;
@@ -517,6 +526,15 @@ type PlatformgetShieldedPoolState = {
   readonly responseType: typeof platform_pb.GetShieldedPoolStateResponse;
 };
 
+type PlatformgetShieldedNotesCount = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetShieldedNotesCountRequest;
+  readonly responseType: typeof platform_pb.GetShieldedNotesCountResponse;
+};
+
 type PlatformgetShieldedNullifiers = {
   readonly methodName: string;
   readonly service: typeof Platform;
@@ -578,6 +596,7 @@ export class Platform {
   static readonly getDataContract: PlatformgetDataContract;
   static readonly getDataContractHistory: PlatformgetDataContractHistory;
   static readonly getDataContracts: PlatformgetDataContracts;
+  static readonly getDocumentHistory: PlatformgetDocumentHistory;
   static readonly getDocuments: PlatformgetDocuments;
   static readonly getIdentityByPublicKeyHash: PlatformgetIdentityByPublicKeyHash;
   static readonly getIdentityByNonUniquePublicKeyHash: PlatformgetIdentityByNonUniquePublicKeyHash;
@@ -621,6 +640,7 @@ export class Platform {
   static readonly getShieldedAnchors: PlatformgetShieldedAnchors;
   static readonly getMostRecentShieldedAnchor: PlatformgetMostRecentShieldedAnchor;
   static readonly getShieldedPoolState: PlatformgetShieldedPoolState;
+  static readonly getShieldedNotesCount: PlatformgetShieldedNotesCount;
   static readonly getShieldedNullifiers: PlatformgetShieldedNullifiers;
   static readonly getNullifiersTrunkState: PlatformgetNullifiersTrunkState;
   static readonly getNullifiersBranchState: PlatformgetNullifiersBranchState;
@@ -786,6 +806,15 @@ export class PlatformClient {
     requestMessage: platform_pb.GetDataContractsRequest,
     callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractsResponse|null) => void
   ): UnaryResponse;
+  getDocumentHistory(
+    requestMessage: platform_pb.GetDocumentHistoryRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetDocumentHistoryResponse|null) => void
+  ): UnaryResponse;
+  getDocumentHistory(
+    requestMessage: platform_pb.GetDocumentHistoryRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetDocumentHistoryResponse|null) => void
+  ): UnaryResponse;
   getDocuments(
     requestMessage: platform_pb.GetDocumentsRequest,
     metadata: grpc.Metadata,
@@ -1173,6 +1202,15 @@ export class PlatformClient {
     requestMessage: platform_pb.GetShieldedPoolStateRequest,
     callback: (error: ServiceError|null, responseMessage: platform_pb.GetShieldedPoolStateResponse|null) => void
   ): UnaryResponse;
+  getShieldedNotesCount(
+    requestMessage: platform_pb.GetShieldedNotesCountRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetShieldedNotesCountResponse|null) => void
+  ): UnaryResponse;
+  getShieldedNotesCount(
+    requestMessage: platform_pb.GetShieldedNotesCountRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetShieldedNotesCountResponse|null) => void
+  ): UnaryResponse;
   getShieldedNullifiers(
     requestMessage: platform_pb.GetShieldedNullifiersRequest,
     metadata: grpc.Metadata,

package/clients/platform/v0/web/platform_pb_service.js

@@ -136,6 +136,15 @@ Platform.getDataContracts = {
   responseType: platform_pb.GetDataContractsResponse
 };
 
+Platform.getDocumentHistory = {
+  methodName: "getDocumentHistory",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetDocumentHistoryRequest,
+  responseType: platform_pb.GetDocumentHistoryResponse
+};
+
 Platform.getDocuments = {
   methodName: "getDocuments",
   service: Platform,
@@ -523,6 +532,15 @@ Platform.getShieldedPoolState = {
   responseType: platform_pb.GetShieldedPoolStateResponse
 };
 
+Platform.getShieldedNotesCount = {
+  methodName: "getShieldedNotesCount",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetShieldedNotesCountRequest,
+  responseType: platform_pb.GetShieldedNotesCountResponse
+};
+
 Platform.getShieldedNullifiers = {
   methodName: "getShieldedNullifiers",
   service: Platform,
@@ -1009,6 +1027,37 @@ PlatformClient.prototype.getDataContracts = function getDataContracts(requestMes
   };
 };
 
+PlatformClient.prototype.getDocumentHistory = function getDocumentHistory(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getDocumentHistory, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
 PlatformClient.prototype.getDocuments = function getDocuments(requestMessage, metadata, callback) {
   if (arguments.length === 2) {
     callback = arguments[1];
@@ -2342,6 +2391,37 @@ PlatformClient.prototype.getShieldedPoolState = function getShieldedPoolState(re
   };
 };
 
+PlatformClient.prototype.getShieldedNotesCount = function getShieldedNotesCount(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getShieldedNotesCount, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
 PlatformClient.prototype.getShieldedNullifiers = function getShieldedNullifiers(requestMessage, metadata, callback) {
   if (arguments.length === 2) {
     callback = arguments[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-grpc",
-  "version": "3.1.0-dev.8",
+  "version": "4.0.0-beta.1",
   "description": "DAPI GRPC definition file and generated clients",
   "browser": "browser.js",
   "main": "node.js",
@@ -45,7 +45,7 @@
   },
   "homepage": "https://github.com/dashevo/dapi-grpc#readme",
   "dependencies": {
-    "@dashevo/grpc-common": "3.1.0-dev.8",
+    "@dashevo/grpc-common": "4.0.0-beta.1",
     "@dashevo/protobufjs": "6.10.5",
     "@grpc/grpc-js": "^1.14.3",
     "@improbable-eng/grpc-web": "^0.15.0",

package/protos/platform/v0/platform.proto

@@ -35,6 +35,8 @@ service Platform {
       returns (GetDataContractHistoryResponse);
   rpc getDataContracts(GetDataContractsRequest)
       returns (GetDataContractsResponse);
+  rpc getDocumentHistory(GetDocumentHistoryRequest)
+      returns (GetDocumentHistoryResponse);
   rpc getDocuments(GetDocumentsRequest) returns (GetDocumentsResponse);
   rpc getIdentityByPublicKeyHash(GetIdentityByPublicKeyHashRequest)
       returns (GetIdentityByPublicKeyHashResponse);
@@ -126,6 +128,8 @@ service Platform {
       returns (GetMostRecentShieldedAnchorResponse);
   rpc getShieldedPoolState(GetShieldedPoolStateRequest)
       returns (GetShieldedPoolStateResponse);
+  rpc getShieldedNotesCount(GetShieldedNotesCountRequest)
+      returns (GetShieldedNotesCountResponse);
   rpc getShieldedNullifiers(GetShieldedNullifiersRequest)
       returns (GetShieldedNullifiersResponse);
   rpc getNullifiersTrunkState(GetNullifiersTrunkStateRequest)
@@ -1300,6 +1304,49 @@ message GetDocumentsResponse {
   }
 }
 
+message GetDocumentHistoryRequest {
+  message GetDocumentHistoryRequestV0 {
+    bytes data_contract_id = 1; // The ID of the data contract
+    string document_type_name = 2; // The document type name
+    bytes document_id = 3; // The document ID
+    google.protobuf.UInt32Value limit =
+        4; // The maximum number of history entries to return
+    google.protobuf.UInt32Value offset =
+        5; // The offset for pagination through the document history
+    uint64 start_at_ms = 6 [
+      jstype = JS_STRING
+    ];              // Only return results after this time in milliseconds
+    bool prove = 7; // Flag to request a proof as the response
+  }
+  oneof version { GetDocumentHistoryRequestV0 v0 = 1; }
+}
+
+message GetDocumentHistoryResponse {
+  message GetDocumentHistoryResponseV0 {
+    // Represents a single entry in a document's history
+    message DocumentHistoryEntry {
+      uint64 date = 1 [ jstype = JS_STRING ]; // The date of the history entry
+      bytes value = 2; // The value of the document at this point in history
+    }
+
+    // Collection of document history entries
+    message DocumentHistory {
+      repeated DocumentHistoryEntry document_entries =
+          1; // List of history entries
+    }
+
+    oneof result {
+      DocumentHistory document_history =
+          1; // The actual history of the document
+      Proof proof =
+          2; // Cryptographic proof of the document history, if requested
+    }
+
+    ResponseMetadata metadata = 3; // Metadata about the blockchain state
+  }
+  oneof version { GetDocumentHistoryResponseV0 v0 = 1; }
+}
+
 message GetIdentityByPublicKeyHashRequest {
   message GetIdentityByPublicKeyHashRequestV0 {
     bytes public_key_hash =
@@ -2927,6 +2974,31 @@ message GetShieldedPoolStateResponse {
   oneof version { GetShieldedPoolStateResponseV0 v0 = 1; }
 }
 
+// Count of leaves in the shielded notes commitment tree.
+// Used by wallets at the start of a shielded sync to seed a
+// determinate progress-bar denominator. The count IS bound by the
+// Merk value hash: it is the first field (`total_count`) of the
+// serialized `CommitmentTree` element whose bytes are hashed into the
+// app/root hash, so it is provable via a PathQuery proof of that
+// element (set `prove = true`).
+message GetShieldedNotesCountRequest {
+  message GetShieldedNotesCountRequestV0 {
+    bool prove = 1;
+  }
+  oneof version { GetShieldedNotesCountRequestV0 v0 = 1; }
+}
+
+message GetShieldedNotesCountResponse {
+  message GetShieldedNotesCountResponseV0 {
+    oneof result {
+      uint64 total_notes_count = 1 [jstype = JS_STRING];
+      Proof proof = 2;
+    }
+    ResponseMetadata metadata = 3;
+  }
+  oneof version { GetShieldedNotesCountResponseV0 v0 = 1; }
+}
+
 message GetShieldedNullifiersRequest {
   message GetShieldedNullifiersRequestV0 {
     repeated bytes nullifiers = 1;