@dashevo/dapi-grpc 4.2.0-beta.1 → 4.2.0-beta.3

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

@@ -184,6 +184,42 @@ type PlatformgetContractGroupsForContract = {
   readonly responseType: typeof platform_pb.GetContractGroupsForContractResponse;
 };
 
+type PlatformgetContractModerationStatus = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetContractModerationStatusRequest;
+  readonly responseType: typeof platform_pb.GetContractModerationStatusResponse;
+};
+
+type PlatformgetContractModerationEntries = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetContractModerationEntriesRequest;
+  readonly responseType: typeof platform_pb.GetContractModerationEntriesResponse;
+};
+
+type PlatformgetContractDocumentRemovals = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetContractDocumentRemovalsRequest;
+  readonly responseType: typeof platform_pb.GetContractDocumentRemovalsResponse;
+};
+
+type PlatformgetContractFeePots = {
+  readonly methodName: string;
+  readonly service: typeof Platform;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof platform_pb.GetContractFeePotsRequest;
+  readonly responseType: typeof platform_pb.GetContractFeePotsResponse;
+};
+
 type PlatformgetDocumentHistory = {
   readonly methodName: string;
   readonly service: typeof Platform;
@@ -620,6 +656,10 @@ export class Platform {
   static readonly getContractGroupInfo: PlatformgetContractGroupInfo;
   static readonly getContractGroupMembers: PlatformgetContractGroupMembers;
   static readonly getContractGroupsForContract: PlatformgetContractGroupsForContract;
+  static readonly getContractModerationStatus: PlatformgetContractModerationStatus;
+  static readonly getContractModerationEntries: PlatformgetContractModerationEntries;
+  static readonly getContractDocumentRemovals: PlatformgetContractDocumentRemovals;
+  static readonly getContractFeePots: PlatformgetContractFeePots;
   static readonly getDocumentHistory: PlatformgetDocumentHistory;
   static readonly getDocuments: PlatformgetDocuments;
   static readonly getIdentityByPublicKeyHash: PlatformgetIdentityByPublicKeyHash;
@@ -880,6 +920,42 @@ export class PlatformClient {
     requestMessage: platform_pb.GetContractGroupsForContractRequest,
     callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractGroupsForContractResponse|null) => void
   ): UnaryResponse;
+  getContractModerationStatus(
+    requestMessage: platform_pb.GetContractModerationStatusRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractModerationStatusResponse|null) => void
+  ): UnaryResponse;
+  getContractModerationStatus(
+    requestMessage: platform_pb.GetContractModerationStatusRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractModerationStatusResponse|null) => void
+  ): UnaryResponse;
+  getContractModerationEntries(
+    requestMessage: platform_pb.GetContractModerationEntriesRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractModerationEntriesResponse|null) => void
+  ): UnaryResponse;
+  getContractModerationEntries(
+    requestMessage: platform_pb.GetContractModerationEntriesRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractModerationEntriesResponse|null) => void
+  ): UnaryResponse;
+  getContractDocumentRemovals(
+    requestMessage: platform_pb.GetContractDocumentRemovalsRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractDocumentRemovalsResponse|null) => void
+  ): UnaryResponse;
+  getContractDocumentRemovals(
+    requestMessage: platform_pb.GetContractDocumentRemovalsRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractDocumentRemovalsResponse|null) => void
+  ): UnaryResponse;
+  getContractFeePots(
+    requestMessage: platform_pb.GetContractFeePotsRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractFeePotsResponse|null) => void
+  ): UnaryResponse;
+  getContractFeePots(
+    requestMessage: platform_pb.GetContractFeePotsRequest,
+    callback: (error: ServiceError|null, responseMessage: platform_pb.GetContractFeePotsResponse|null) => void
+  ): UnaryResponse;
   getDocumentHistory(
     requestMessage: platform_pb.GetDocumentHistoryRequest,
     metadata: grpc.Metadata,

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

@@ -190,6 +190,42 @@ Platform.getContractGroupsForContract = {
   responseType: platform_pb.GetContractGroupsForContractResponse
 };
 
+Platform.getContractModerationStatus = {
+  methodName: "getContractModerationStatus",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetContractModerationStatusRequest,
+  responseType: platform_pb.GetContractModerationStatusResponse
+};
+
+Platform.getContractModerationEntries = {
+  methodName: "getContractModerationEntries",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetContractModerationEntriesRequest,
+  responseType: platform_pb.GetContractModerationEntriesResponse
+};
+
+Platform.getContractDocumentRemovals = {
+  methodName: "getContractDocumentRemovals",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetContractDocumentRemovalsRequest,
+  responseType: platform_pb.GetContractDocumentRemovalsResponse
+};
+
+Platform.getContractFeePots = {
+  methodName: "getContractFeePots",
+  service: Platform,
+  requestStream: false,
+  responseStream: false,
+  requestType: platform_pb.GetContractFeePotsRequest,
+  responseType: platform_pb.GetContractFeePotsResponse
+};
+
 Platform.getDocumentHistory = {
   methodName: "getDocumentHistory",
   service: Platform,
@@ -1231,6 +1267,130 @@ PlatformClient.prototype.getContractGroupsForContract = function getContractGrou
   };
 };
 
+PlatformClient.prototype.getContractModerationStatus = function getContractModerationStatus(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getContractModerationStatus, {
+    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.getContractModerationEntries = function getContractModerationEntries(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getContractModerationEntries, {
+    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.getContractDocumentRemovals = function getContractDocumentRemovals(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getContractDocumentRemovals, {
+    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.getContractFeePots = function getContractFeePots(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Platform.getContractFeePots, {
+    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-beta.1",
+  "version": "4.2.0-beta.3",
   "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-beta.1",
+    "@dashevo/grpc-common": "4.2.0-beta.3",
     "@dashevo/protobufjs": "6.10.5",
     "@grpc/grpc-js": "^1.14.3",
     "@improbable-eng/grpc-web": "^0.15.0",

package/protos/platform/v0/platform.proto

@@ -47,6 +47,14 @@ service Platform {
       returns (GetContractGroupMembersResponse);
   rpc getContractGroupsForContract(GetContractGroupsForContractRequest)
       returns (GetContractGroupsForContractResponse);
+  rpc getContractModerationStatus(GetContractModerationStatusRequest)
+      returns (GetContractModerationStatusResponse);
+  rpc getContractModerationEntries(GetContractModerationEntriesRequest)
+      returns (GetContractModerationEntriesResponse);
+  rpc getContractDocumentRemovals(GetContractDocumentRemovalsRequest)
+      returns (GetContractDocumentRemovalsResponse);
+  rpc getContractFeePots(GetContractFeePotsRequest)
+      returns (GetContractFeePotsResponse);
   rpc getDocumentHistory(GetDocumentHistoryRequest)
       returns (GetDocumentHistoryResponse);
   rpc getDocuments(GetDocumentsRequest) returns (GetDocumentsResponse);
@@ -698,6 +706,198 @@ message GetContractGroupMembersResponse {
   oneof version { GetContractGroupMembersResponseV0 v0 = 1; }
 }
 
+// One of the two moderation lists a moderated data contract may keep (protocol version 14).
+enum ContractModerationList {
+  CONTRACT_MODERATION_LIST_UNSPECIFIED = 0; // Not a list: a request that leaves the field out is refused
+  CONTRACT_MODERATION_LIST_BANLIST = 1;     // Identities barred until an unban
+  CONTRACT_MODERATION_LIST_SUSPENSIONS = 2; // Identities barred until a block time
+}
+
+// Why a moderator banned or suspended an identity. Nothing checks what a
+// moderator writes.
+message ContractModerationReason {
+  optional uint32 code =
+      1; // Reserved for the ban codes a contract may declare in a later
+         // protocol version; a u16, expected unset today, never checked
+  string text = 2; // Free text, at most 1024 bytes of UTF-8, may be empty
+}
+
+message GetContractModerationStatusRequest {
+  message GetContractModerationStatusRequestV0 {
+    bytes contract_id = 1; // The 32-byte id of the moderated contract
+    bytes identity_id = 2; // The 32-byte id of the identity
+    repeated ContractModerationList lists =
+        3; // The lists to read, which the contract's config must declare; at
+           // least one, no repeats
+    bool prove = 4; // Flag to request a proof as the response
+  }
+  oneof version { GetContractModerationStatusRequestV0 v0 = 1; }
+}
+
+message GetContractModerationStatusResponse {
+  // The identity's status on the lists the request named, and on no other: a
+  // list that was not read says nothing, so its field is left unset.
+  message ContractModerationStatus {
+    optional bool banned =
+        1; // Set only when the banlist was read: the identity is on it
+    optional uint64 suspended_until =
+        2; // The block time, in milliseconds, until which the identity is
+           // suspended; a lapsed suspension stays until it is swept. Unset
+           // when the identity is not suspended or the list was not read
+    repeated ContractModerationList lists =
+        3; // The lists this status covers, as the request named them
+    optional ContractModerationReason ban_reason =
+        4; // Set when the identity is banned: why
+    optional ContractModerationReason suspension_reason =
+        5; // Set when the identity is suspended: why
+  }
+
+  message GetContractModerationStatusResponseV0 {
+    oneof result {
+      ContractModerationStatus status = 1; // The identity's status on the lists read
+      Proof proof = 2;                     // Cryptographic proof of the status, if requested
+    }
+    ResponseMetadata metadata = 3; // Metadata about the blockchain state
+  }
+  oneof version { GetContractModerationStatusResponseV0 v0 = 1; }
+}
+
+message GetContractModerationEntriesRequest {
+  message GetContractModerationEntriesRequestV0 {
+    bytes contract_id = 1;           // The 32-byte id of the moderated contract
+    ContractModerationList list = 2; // The list to read, which the contract's config must declare
+    optional bytes start_after =
+        3; // 32-byte identity id; the page starts after it
+    optional uint32 limit =
+        4; // Maximum number of entries to return, from 1 to the protocol's
+           // max_returned_elements (100); absent means that maximum
+    bool prove = 5; // Flag to request a proof as the response
+  }
+  oneof version { GetContractModerationEntriesRequestV0 v0 = 1; }
+}
+
+message GetContractModerationEntriesResponse {
+  message ContractModerationEntry {
+    bytes identity_id = 1; // The barred identity
+    optional uint64 until =
+        2; // For a suspension list entry: the block time, in milliseconds, at
+           // which it lapses
+    ContractModerationReason reason = 3; // Why the identity is on the list
+  }
+
+  message ContractModerationEntries {
+    repeated ContractModerationEntry entries = 1; // The page, in identity id order
+  }
+
+  message GetContractModerationEntriesResponseV0 {
+    oneof result {
+      ContractModerationEntries entries = 1; // One page of the list
+      Proof proof = 2;                       // Cryptographic proof of the page, if requested
+    }
+    ResponseMetadata metadata = 3; // Metadata about the blockchain state
+  }
+  oneof version { GetContractModerationEntriesResponseV0 v0 = 1; }
+}
+
+// The records of the documents a contract's moderators deleted, within one
+// document type whose documents they may delete (`canBeDeletedByModerators`):
+// the ones of the document ids named, or one page in document id order.
+message GetContractDocumentRemovalsRequest {
+  message DocumentIds {
+    repeated bytes document_ids =
+        1; // 32-byte document ids, from 1 to the protocol's
+           // max_returned_elements (100), none twice; an id with no record is
+           // left out of the response, and proved absent when a proof is asked
+  }
+
+  message Page {
+    optional bytes start_after =
+        1; // 32-byte document id; the page starts after it
+    optional uint32 limit =
+        2; // Maximum number of records to return, from 1 to the protocol's
+           // max_returned_elements (100); absent means that maximum
+  }
+
+  message GetContractDocumentRemovalsRequestV0 {
+    bytes contract_id = 1; // The 32-byte id of the moderated contract
+    string document_type_name =
+        2; // The document type, which must let moderators delete its documents
+    oneof selection {
+      DocumentIds document_ids = 3; // The records of these documents
+      Page page = 4;                // One page of the type's records
+    }
+    bool prove = 5; // Flag to request a proof as the response
+  }
+  oneof version { GetContractDocumentRemovalsRequestV0 v0 = 1; }
+}
+
+message GetContractDocumentRemovalsResponse {
+  message ContractDocumentRemoval {
+    bytes document_id = 1;       // The id the removed document had
+    bytes document_owner_id = 2; // The identity that owned it
+    bytes moderator_id = 3; // The contract owner or moderator that removed it
+    uint64 removed_at =
+        4; // The time of the block that removed it, in milliseconds
+    ContractModerationReason reason = 5; // Why the moderator removed it
+  }
+
+  message ContractDocumentRemovals {
+    repeated ContractDocumentRemoval removals =
+        1; // The records, in document id order
+  }
+
+  message GetContractDocumentRemovalsResponseV0 {
+    oneof result {
+      ContractDocumentRemovals removals = 1; // The records read
+      Proof proof = 2; // Cryptographic proof of the records, if requested
+    }
+    ResponseMetadata metadata = 3; // Metadata about the blockchain state
+  }
+  oneof version { GetContractDocumentRemovalsResponseV0 v0 = 1; }
+}
+
+message GetContractFeePotsRequest {
+  message GetContractFeePotsRequestV0 {
+    bytes contract_id = 1; // The 32-byte id of the data contract
+    bool prove = 2;        // Flag to request a proof as the response
+  }
+  oneof version { GetContractFeePotsRequestV0 v0 = 1; }
+}
+
+message GetContractFeePotsResponse {
+  // The last payout of a pot, which the claim that made it left in state
+  message ContractFeePotLastClaim {
+    uint32 epoch = 1; // The epoch (u16) the pot was paid out in; a pot is paid
+                      // out at most once per epoch
+    uint64 time_ms = 2
+        [ jstype = JS_STRING ]; // The time of the block that paid the pot out
+    bytes claimant_id = 3; // The identity that signed the claim: the contract
+                           // owner for the owner pot, the member of the
+                           // moderation team that claimed for the moderators pot
+  }
+
+  // One of the two pots a contract's document action fees collect in
+  message ContractFeePot {
+    uint64 credits = 1 [ jstype = JS_STRING ]; // What the pot holds
+    ContractFeePotLastClaim last_claim =
+        2; // Unset when the pot was never paid out
+  }
+
+  message ContractFeePots {
+    ContractFeePot owner = 1;      // The pot the contract owner claims
+    ContractFeePot moderators = 2; // The pot the moderation team shares
+  }
+
+  message GetContractFeePotsResponseV0 {
+    oneof result {
+      ContractFeePots pots = 1; // Both pots of the contract
+      Proof proof = 2;          // Cryptographic proof of the pots, if requested
+    }
+    ResponseMetadata metadata = 3; // Metadata about the blockchain state
+  }
+  oneof version { GetContractFeePotsResponseV0 v0 = 1; }
+}
+
 message GetContractGroupsForContractRequest {
   message GetContractGroupsForContractRequestV0 {
     bytes contract_id = 1; // The 32-byte id of the contract
@@ -1960,6 +2160,13 @@ message GetDocumentsResponse {
     message ChainedDocuments {
       repeated bytes inner_documents = 1;
       repeated bytes outer_documents = 2;
+      // The join values that have NO outer document, in first
+      // appearance order: referenced documents deleted after the
+      // inner document was written. Only a join property declaring
+      // `refersTo: deletableDocument` can report any; under
+      // `refersTo: permanentDocument` a missing document fails the
+      // query instead.
+      repeated bytes missing_outer_ids = 3;
     }
 
     // A composite query's page and per-sub-query results, documents
@@ -1977,6 +2184,11 @@ message GetDocumentsResponse {
           // value's index-key bytes.
           CountEntries counts = 2;
         }
+        // DOCUMENTS by-id join only: the derived ids that have NO
+        // document, in first appearance order (referenced documents
+        // deleted since). Only a source property declaring
+        // `refersTo: deletableDocument` can report any.
+        repeated bytes missing_ids = 3;
       }
       repeated SubQueryResult sub_results = 2;
     }