@arbiwallet/contracts 1.0.10 → 1.0.12

package/gen/kyc.ts

@@ -0,0 +1,144 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.4
+//   protoc               v7.34.0
+// source: kyc.proto
+
+/* eslint-disable */
+import { GrpcMethod, GrpcStreamMethod } from "@nestjs/microservices";
+import { Observable } from "rxjs";
+
+export const protobufPackage = "kyc";
+
+export enum KycStatus {
+  KYC_STATUS_UNSPECIFIED = 0,
+  KYC_STATUS_NOT_STARTED = 1,
+  KYC_STATUS_IN_PROGRESS = 2,
+  KYC_STATUS_PENDING_REVIEW = 3,
+  KYC_STATUS_APPROVED = 4,
+  KYC_STATUS_RETRY_REQUIRED = 5,
+  KYC_STATUS_REJECTED = 6,
+  UNRECOGNIZED = -1,
+}
+
+export interface StartVerificationRequest {
+  userId: string;
+}
+
+export interface StartVerificationResponse {
+  accessToken: string;
+  expiresInSec: number;
+  applicantId: string;
+  kycStatus: KycStatus;
+  userId: string;
+}
+
+export interface RefreshAccessTokenRequest {
+  userId: string;
+}
+
+export interface RefreshAccessTokenResponse {
+  accessToken: string;
+  expiresInSec: number;
+}
+
+export interface GetVerificationStatusRequest {
+  userId: string;
+}
+
+export interface GetVerificationStatusResponse {
+  userId: string;
+  applicantId: string;
+  kycStatus: KycStatus;
+  reviewAnswer: string;
+  rejectionLabels: string[];
+  moderationComment: string;
+  createdAtMs: number;
+  updatedAtMs: number;
+}
+
+export interface WebhookReviewResultMessage {
+  reviewAnswer: string;
+  rejectLabels: string[];
+  reviewRejectType: string;
+  moderationComment: string;
+  clientComment: string;
+}
+
+export interface SumsubWebhookPayload {
+  applicantId: string;
+  externalUserId: string;
+  webhookType: string;
+  correlationId: string;
+  reviewStatus: string;
+  reviewResult: WebhookReviewResultMessage | undefined;
+  createdAtMs: number;
+  inspectionId: string;
+}
+
+export interface SumsubWebhookVerification {
+  payloadDigest: string;
+  payloadDigestAlg: string;
+  rawBody: Uint8Array;
+}
+
+export interface ApplySumsubWebhookRequest {
+  payload: SumsubWebhookPayload | undefined;
+  verification: SumsubWebhookVerification | undefined;
+}
+
+export interface ApplySumsubWebhookResponse {
+  ok: boolean;
+}
+
+export const KYC_PACKAGE_NAME = "kyc";
+
+export interface KycVerificationClient {
+  startVerification(request: StartVerificationRequest): Observable<StartVerificationResponse>;
+
+  refreshAccessToken(request: RefreshAccessTokenRequest): Observable<RefreshAccessTokenResponse>;
+
+  getVerificationStatus(request: GetVerificationStatusRequest): Observable<GetVerificationStatusResponse>;
+
+  applySumsubWebhook(request: ApplySumsubWebhookRequest): Observable<ApplySumsubWebhookResponse>;
+}
+
+export interface KycVerificationController {
+  startVerification(
+    request: StartVerificationRequest,
+  ): Promise<StartVerificationResponse> | Observable<StartVerificationResponse> | StartVerificationResponse;
+
+  refreshAccessToken(
+    request: RefreshAccessTokenRequest,
+  ): Promise<RefreshAccessTokenResponse> | Observable<RefreshAccessTokenResponse> | RefreshAccessTokenResponse;
+
+  getVerificationStatus(
+    request: GetVerificationStatusRequest,
+  ): Promise<GetVerificationStatusResponse> | Observable<GetVerificationStatusResponse> | GetVerificationStatusResponse;
+
+  applySumsubWebhook(
+    request: ApplySumsubWebhookRequest,
+  ): Promise<ApplySumsubWebhookResponse> | Observable<ApplySumsubWebhookResponse> | ApplySumsubWebhookResponse;
+}
+
+export function KycVerificationControllerMethods() {
+  return function (constructor: Function) {
+    const grpcMethods: string[] = [
+      "startVerification",
+      "refreshAccessToken",
+      "getVerificationStatus",
+      "applySumsubWebhook",
+    ];
+    for (const method of grpcMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcMethod("KycVerification", method)(constructor.prototype[method], method, descriptor);
+    }
+    const grpcStreamMethods: string[] = [];
+    for (const method of grpcStreamMethods) {
+      const descriptor: any = Reflect.getOwnPropertyDescriptor(constructor.prototype, method);
+      GrpcStreamMethod("KycVerification", method)(constructor.prototype[method], method, descriptor);
+    }
+  };
+}
+
+export const KYC_VERIFICATION_SERVICE_NAME = "KycVerification";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arbiwallet/contracts",
   "descriptions": "Generate and manage smart contracts for ArbiWallet",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "scripts": {
     "generate": "protoc -I ./proto ./proto/*.proto --ts_proto_out=./gen --ts_proto_opt=nestJs=true,package=omit"
   },

package/proto/kyc.proto

@@ -0,0 +1,92 @@
+syntax = "proto3";
+
+package kyc;
+
+service KycVerification {
+  rpc StartVerification (StartVerificationRequest) returns (StartVerificationResponse);
+  rpc RefreshAccessToken (RefreshAccessTokenRequest) returns (RefreshAccessTokenResponse);
+  rpc GetVerificationStatus (GetVerificationStatusRequest) returns (GetVerificationStatusResponse);
+  rpc ApplySumsubWebhook (ApplySumsubWebhookRequest) returns (ApplySumsubWebhookResponse);
+}
+
+enum KycStatus {
+  KYC_STATUS_UNSPECIFIED = 0;
+  KYC_STATUS_NOT_STARTED = 1;
+  KYC_STATUS_IN_PROGRESS = 2;
+  KYC_STATUS_PENDING_REVIEW = 3;
+  KYC_STATUS_APPROVED = 4;
+  KYC_STATUS_RETRY_REQUIRED = 5;
+  KYC_STATUS_REJECTED = 6;
+}
+
+message StartVerificationRequest {
+  string user_id = 1;
+}
+
+message StartVerificationResponse {
+  string access_token = 1;
+  int32 expires_in_sec = 2;
+  string applicant_id = 3;
+  KycStatus kyc_status = 4;
+  string user_id = 5;
+}
+
+message RefreshAccessTokenRequest {
+  string user_id = 1;
+}
+
+message RefreshAccessTokenResponse {
+  string access_token = 1;
+  int32 expires_in_sec = 2;
+}
+
+message GetVerificationStatusRequest {
+  string user_id = 1;
+}
+
+message GetVerificationStatusResponse {
+  string user_id = 1;
+  reserved 2;
+  reserved "external_user_id";
+  string applicant_id = 3;
+  KycStatus kyc_status = 4;
+  string review_answer = 5;
+  repeated string rejection_labels = 6;
+  string moderation_comment = 7;
+  int64 created_at_ms = 8;
+  int64 updated_at_ms = 9;
+}
+
+message WebhookReviewResultMessage {
+  string review_answer = 1;
+  repeated string reject_labels = 2;
+  string review_reject_type = 3;
+  string moderation_comment = 4;
+  string client_comment = 5;
+}
+
+message SumsubWebhookPayload {
+  string applicant_id = 1;
+  string external_user_id = 2;
+  string webhook_type = 3;
+  string correlation_id = 4;
+  string review_status = 5;
+  WebhookReviewResultMessage review_result = 6;
+  int64 created_at_ms = 7;
+  string inspection_id = 8;
+}
+
+message SumsubWebhookVerification {
+  string payload_digest = 1;
+  string payload_digest_alg = 2;
+  bytes raw_body = 3;
+}
+
+message ApplySumsubWebhookRequest {
+  SumsubWebhookPayload payload = 1;
+  SumsubWebhookVerification verification = 2;
+}
+
+message ApplySumsubWebhookResponse {
+  bool ok = 1;
+}