@dashevo/dapi-grpc 4.2.0-dev.10 → 4.2.0-dev.11

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

@@ -121,6 +121,15 @@ type PlatformgetDataContractHistory = {
   readonly responseType: typeof platform_pb.GetDataContractHistoryResponse;
 };
 
+type PlatformgetDataContractsLatestVersions = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetDataContractsLatestVersionsRequest;
+  readonly responseType: typeof platform_pb.GetDataContractsLatestVersionsResponse;
+};
+
 type PlatformgetDataContracts = {
   readonly methodName: string;
   readonly service: typeof Platform;
@@ -130,6 +139,15 @@ type PlatformgetDataContracts = {
   readonly responseType: typeof platform_pb.GetDataContractsResponse;
 };
 
+type PlatformgetDataContractsByRange = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetDataContractsByRangeRequest;
+  readonly responseType: typeof platform_pb.GetDataContractsResponse;
+};
+
 type PlatformgetDocumentHistory = {
   readonly methodName: string;
   readonly service: typeof Platform;
@@ -559,7 +577,9 @@ export class Platform {
   static readonly getEvonodesProposedEpochBlocksByRange: PlatformgetEvonodesProposedEpochBlocksByRange;
   static readonly getDataContract: PlatformgetDataContract;
   static readonly getDataContractHistory: PlatformgetDataContractHistory;
+  static readonly getDataContractsLatestVersions: PlatformgetDataContractsLatestVersions;
   static readonly getDataContracts: PlatformgetDataContracts;
+  static readonly getDataContractsByRange: PlatformgetDataContractsByRange;
   static readonly getDocumentHistory: PlatformgetDocumentHistory;
   static readonly getDocuments: PlatformgetDocuments;
   static readonly getIdentityByPublicKeyHash: PlatformgetIdentityByPublicKeyHash;
@@ -757,6 +777,15 @@ export class PlatformClient {
     requestMessage: platform_pb.GetDataContractHistoryRequest,
     callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractHistoryResponse|null) => void
   ): UnaryResponse;
+  getDataContractsLatestVersions(
+    requestMessage: platform_pb.GetDataContractsLatestVersionsRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractsLatestVersionsResponse|null) => void
+  ): UnaryResponse;
+  getDataContractsLatestVersions(
+    requestMessage: platform_pb.GetDataContractsLatestVersionsRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractsLatestVersionsResponse|null) => void
+  ): UnaryResponse;
   getDataContracts(
     requestMessage: platform_pb.GetDataContractsRequest,
     metadata: grpc.Metadata,
@@ -766,6 +795,15 @@ export class PlatformClient {
     requestMessage: platform_pb.GetDataContractsRequest,
     callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractsResponse|null) => void
   ): UnaryResponse;
+  getDataContractsByRange(
+    requestMessage: platform_pb.GetDataContractsByRangeRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractsResponse|null) => void
+  ): UnaryResponse;
+  getDataContractsByRange(
+    requestMessage: platform_pb.GetDataContractsByRangeRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetDataContractsResponse|null) => void
+  ): UnaryResponse;
   getDocumentHistory(
     requestMessage: platform_pb.GetDocumentHistoryRequest,
     metadata: grpc.Metadata,

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

@@ -127,6 +127,15 @@ Platform.getDataContractHistory = {
   responseType: platform_pb.GetDataContractHistoryResponse
 };
 
+Platform.getDataContractsLatestVersions = {
+  methodName: "getDataContractsLatestVersions",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetDataContractsLatestVersionsRequest,
+  responseType: platform_pb.GetDataContractsLatestVersionsResponse
+};
+
 Platform.getDataContracts = {
   methodName: "getDataContracts",
   service: Platform,
@@ -136,6 +145,15 @@ Platform.getDataContracts = {
   responseType: platform_pb.GetDataContractsResponse
 };
 
+Platform.getDataContractsByRange = {
+  methodName: "getDataContractsByRange",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetDataContractsByRangeRequest,
+  responseType: platform_pb.GetDataContractsResponse
+};
+
 Platform.getDocumentHistory = {
   methodName: "getDocumentHistory",
   service: Platform,
@@ -960,6 +978,37 @@ PlatformClient.prototype.getDataContractHistory = function getDataContractHistor
   };
 };
 
+PlatformClient.prototype.getDataContractsLatestVersions = function getDataContractsLatestVersions(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getDataContractsLatestVersions, {
+    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.getDataContracts = function getDataContracts(requestMessage, metadata, callback) {
   if (arguments.length === 2) {
     callback = arguments[1];
@@ -991,6 +1040,37 @@ PlatformClient.prototype.getDataContracts = function getDataContracts(requestMes
   };
 };
 
+PlatformClient.prototype.getDataContractsByRange = function getDataContractsByRange(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getDataContractsByRange, {
+    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.getDocumentHistory = function getDocumentHistory(requestMessage, metadata, callback) {
   if (arguments.length === 2) {
     callback = arguments[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-grpc",
-  "version": "4.2.0-dev.10",
+  "version": "4.2.0-dev.11",
   "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": "4.2.0-dev.10",
+    "@dashevo/grpc-common": "4.2.0-dev.11",
     "@dashevo/protobufjs": "6.10.5",
     "@grpc/grpc-js": "^1.14.3",
     "@improbable-eng/grpc-web": "^0.15.0",

package/protos/platform/v0/platform.proto

@@ -33,8 +33,12 @@ service Platform {
   rpc getDataContract(GetDataContractRequest) returns (GetDataContractResponse);
   rpc getDataContractHistory(GetDataContractHistoryRequest)
       returns (GetDataContractHistoryResponse);
+  rpc getDataContractsLatestVersions(GetDataContractsLatestVersionsRequest)
+      returns (GetDataContractsLatestVersionsResponse);
   rpc getDataContracts(GetDataContractsRequest)
       returns (GetDataContractsResponse);
+  rpc getDataContractsByRange(GetDataContractsByRangeRequest)
+      returns (GetDataContractsResponse);
   rpc getDocumentHistory(GetDocumentHistoryRequest)
       returns (GetDocumentHistoryResponse);
   rpc getDocuments(GetDocumentsRequest) returns (GetDocumentsResponse);
@@ -497,6 +501,57 @@ message GetDataContractResponse {
   oneof version { GetDataContractResponseV0 v0 = 1; }
 }
 
+// Returns the current version number of each requested data contract: the
+// cheap way for a client to check that the contracts it already holds are
+// still current. Every distinct requested id gets an entry; an id no contract has gets
+// an entry without `version`. Serialized contracts are added only when
+// `include_contracts` is set.
+//
+// From protocol version 14 every contract carries a four-byte version item
+// beside it in state. Without `include_contracts`, the unproved form answers
+// from Drive's contract cache or that item without loading a contract, and
+// the proof covers the items, a few hundred bytes of hash path per contract.
+// With `include_contracts`, and on earlier protocol versions, the unproved
+// form reads the contracts through the cache and the proof is the
+// multi-contract proof `getDataContracts` returns, which carries the
+// contracts.
+message GetDataContractsLatestVersionsRequest {
+  message GetDataContractsLatestVersionsRequestV0 {
+    repeated bytes ids =
+        1; // The IDs of the data contracts, at least one and at most 100
+    bool include_contracts =
+        2; // When set, found entries also carry the serialized contract
+    bool prove = 3; // Flag to request a proof as the response
+  }
+  oneof version { GetDataContractsLatestVersionsRequestV0 v0 = 1; }
+}
+
+message GetDataContractsLatestVersionsResponse {
+  message DataContractLatestVersionEntry {
+    bytes identifier = 1; // The requested contract id
+    optional uint32 version =
+        2; // The contract's current version number; absent when no contract has this id
+    optional bytes data_contract =
+        3; // The serialized contract, only when `include_contracts` was set and the contract exists
+  }
+
+  message DataContractsLatestVersions {
+    repeated DataContractLatestVersionEntry entries =
+        1; // One entry per requested contract id
+  }
+
+  message GetDataContractsLatestVersionsResponseV0 {
+    oneof result {
+      DataContractsLatestVersions data_contracts_latest_versions =
+          1; // The current versions, and the contracts if requested
+      Proof proof =
+          2; // Cryptographic proof of the data contracts, if requested
+    }
+    ResponseMetadata metadata = 3; // Metadata about the blockchain state
+  }
+  oneof version { GetDataContractsLatestVersionsResponseV0 v0 = 1; }
+}
+
 message GetDataContractsRequest {
   message GetDataContractsRequestV0 {
     repeated bytes ids =
@@ -506,6 +561,28 @@ message GetDataContractsRequest {
   oneof version { GetDataContractsRequestV0 v0 = 1; }
 }
 
+// Enumerates every data contract on Platform, one page at a time, in
+// ascending contract id order. Answered with `GetDataContractsResponse`:
+// each `DataContractEntry` carries the contract id and, unless `ids_only`
+// is set, the serialized contract. An empty page (no more contracts) is an
+// empty `data_contract_entries` list, never NotFound. A page shorter than
+// `limit` is the last page; otherwise pass the last entry's identifier as
+// `start_after` to fetch the next one.
+message GetDataContractsByRangeRequest {
+  message GetDataContractsByRangeRequestV0 {
+    optional uint32 limit =
+        1; // Maximum number of contracts to return, 1..=100; absent means 100
+    oneof start {
+      bytes start_after = 2; // 32-byte contract id; the page starts after it
+      bytes start_at = 3;    // 32-byte contract id; the page starts at it
+    }
+    bool ids_only =
+        4; // When set, entries carry only `identifier`; `data_contract` is unset
+    bool prove = 5; // Flag to request a proof as the response
+  }
+  oneof version { GetDataContractsByRangeRequestV0 v0 = 1; }
+}
+
 message GetDataContractsResponse {
   message DataContractEntry {
     bytes identifier = 1; // The unique identifier of the data contract