Merge pull request 'Feat: Add Referral Code System' (#35) from feat-referral-code into v2

Reviewed-on: #35

auth/v1/msg.proto

@@ -43,6 +43,7 @@ message PermissionList {
 
 message UserSendOtpReq {
   string mobile = 1;
+  string referral_code = 2;
 }
 message UserSendOtpRes {
   int64 expired_at = 1;
@@ -55,6 +56,7 @@ message UserSendOtpRes {
 message UserLoginReq {
   string mobile = 1;
   string otp_code = 2;
+  string referral_code = 3;
 }
 message UserRefreshTokenReq {
   string refresh_token = 1;
@@ -128,6 +130,7 @@ message User {
   string email = 4;
   UserStatus status = 5;
   repeated int64 roles = 6;
+  int64 referrer_user_id = 7;
 }
 
 message UserAddress {
@@ -185,6 +188,7 @@ message UserIdentityBasic {
   string first_name = 4;
   string last_name = 5;
   string wallet_address = 6;
+  bool is_identity_verified = 7;
 }
 
 message UserUpdateIdentityReq {

errors/v1/msg.proto

@@ -39,6 +39,7 @@ enum ErrCode {
   INVALID_BUY_AMOUNT = 2015;
   INVALID_BUY_AMOUNT_MAX = 2016;
   INVALID_BUY_AMOUNT_MIN = 2017;
+  INVALID_ARGUMENT_TFA_REQUIRED = 2018;
 
   // Resource errors
   NOT_FOUND = 3000;
@@ -50,6 +51,8 @@ enum ErrCode {
   BANK_INFO_NOT_FOUND = 3007;
   RECIPIENT_NOT_FOUND = 3008;
   USER_NOT_FOUND = 3009;
+  INVALID_REFERRAL_CODE = 3011;
+  MARKET_AGREEMENT_ALREADY_ACCEPTED = 3010;
 
   // Resource state errors
   ASSET_NOT_ACTIVE = 4000;
@@ -103,6 +106,7 @@ enum ErrCode {
   LOW_REQUEST_AMOUNT = 7014;
   AGREEMENT_ALREADY_ACCEPTED = 7015;
   CONTRACT_ALREADY_GENERATED = 7016;
+  CONTRACT_NOT_FOUND = 7080;
   NIL_AUTH = 7017;
   CAN_NOT_BUY_AND_DEPOSIT = 7018;
   WHITELIST_ALREADY_USED = 7027;
@@ -114,6 +118,8 @@ enum ErrCode {
   MOBILE_NATIONAL_ID_MISS_MATCH = 7033;
   NOT_ENOUGH_LOCKED_BALANCE = 7034;
   NOT_ENOUGH_BALANCE_TO_LOCK = 7035;
+  IPG_GEN_TOKEN_FAILED = 7036;
+  USER_INFO_NATIONAL_ID_BIRTHDATE_MISS_MATCH = 7037;
 
 
   // Server errors

market/v1/srv.proto

@@ -22,5 +22,4 @@ service MarketplaceSrv {
   rpc NewMarketOrder(NewMarketReq) returns (MarketOrder); // insert new buy order to market
   rpc GenerateMarketContract(MarketContractReq) returns (ContractMarketRes);
   rpc ConfirmMarketContract(ConfirmMarketContractReq) returns (base.v1.StatusRes);
-  rpc DeclineMarketContract(DeclineMarketContractReq) returns (base.v1.StatusRes);
 }

wallet/v1/internal_srv.proto

@@ -7,10 +7,17 @@ import "wallet/v1/msg.proto";
 
 service InternalWalletSrv {
   rpc InternalWalletSrvHealth(base.v1.Empty) returns (base.v1.StatusRes);
+
   // Lock And Release Assets
   rpc LockAsset(LockAssetReq) returns (base.v1.StatusRes);
   rpc ReleaseAsset(LockAssetReq) returns (base.v1.StatusRes);
 
   rpc CollectCommission(CommissionReq) returns (CommissionRes);
-  rpc RefundCommission(CommissionReq) returns (CommissionRes);
+  rpc RefundCommission(RefundCommissionReq) returns (CommissionRes);
+
+  // Calculate stellar pub-priv key based on national id
+  rpc GetPublicKeyByNationalID(NationalIDReq) returns (PubKeyRes);
+
+    // Commission Logs
+  rpc InitReferrerCommissionLog(InitReferrerCommissionLogIn) returns (base.v1.Empty);
 }

wallet/v1/msg.proto

@@ -6,7 +6,7 @@ import "auth/v1/msg.proto";
 import "base/v1/msg.proto";
 
 /*
-   INTERNAL DATA
+   INTERNAL DATA;
 */
 
 message InternalTransactionData {
@@ -192,6 +192,7 @@ message AssetPrice {
   string updated_at = 1;
   double market_price = 2;
   double ico_price = 3;
+  double current_price = 4;
 }
 
 message GetAssetReq {
@@ -354,6 +355,7 @@ enum TransactionType {
   IRT_DEPOSIT = 13;
   IRT_WITHDRAWAL = 14;
   COMMISSION = 15;
+  REFERRAL_COMMISSION = 16;
 }
 
 enum TransactionStatus {
@@ -363,6 +365,7 @@ enum TransactionStatus {
   CREATED = -1;
   PENDING_TRX = 1;
   SUCCESSFUL = 2;
+  PENDING_ADMIN = 3;
 }
 
 message Transaction {
@@ -388,6 +391,13 @@ message Transaction {
   optional string from_public_key = 19;
   optional string to_public_key = 20;
   double token_price = 21;
+  BalanceChange balance_change = 22;
+}
+
+enum BalanceChange{
+  NO_CHANGE = 0;
+  INCREASE = 1;
+  DECREASE = 2;
 }
 
 message TransactionListFilter {
@@ -433,7 +443,7 @@ message TransferAssetRes {
 }
 
 /*
-   Redeem Token
+   Redeem Token;
 */
 message RedeemTokenReq {
   auth.v1.InternalIAM iam = 1;
@@ -488,7 +498,7 @@ message PubKeyRes {
 }
 
 /*
-   Network Details
+   Network Details;
 */
 enum NetworkType {
   UNKNOWN_NETWORK_TYPE = 0;
@@ -558,12 +568,51 @@ message EffectiveCommission {
   double total = 3;
 }
 
+message RefundCommissionReq {
+  auth.v1.UserIdentityBasic user = 3;
+  uint64 commission_log_id = 1;
+}
 message CommissionReq {
   uint64 commission_id = 1;
   double amount = 2;
   auth.v1.UserIdentityBasic user = 3;
 }
-message CommissionRes {}
+
+message CommissionRes {
+  uint64 commission_log_id = 1;
+}
+
+message InitReferrerCommissionLogIn {
+  int64 referrer_id = 1;
+  int64 user_id = 2;
+  double amount = 3;
+}
+
+message ReferrerCommissionLogOut {
+  double amount = 1;
+  string mobile = 2;
+  bool is_identity_verified = 3;
+  double commission_percentage = 4;
+}
+message ReferrerCommissionLogsList {
+  repeated ReferrerCommissionLogOut list = 1;
+  uint32 page_no = 2;
+  uint32 page_size = 3;
+  uint32 total_count = 4;
+}
+
+message TotalReferralCommissionIn {
+  int64 referrer_id = 1;
+}
+
+message TotalReferralCommissionOut {
+  double claimed = 1;
+  double unclaimed = 2;
+}
+
+message ClaimReferralCommissionIn {
+  auth.v1.User user = 1;
+}
 
 /*
  * IPG - Internet Payment Gateway
@@ -579,6 +628,34 @@ message CommissionRes {}
 //   auth.v1.BankInfo bank_info = 2; // BankInfo
 // }
 
+enum AccountingType {
+  ACCOUNTING_TYPE_WITHDRAW = 0;
+
+  // Deposits
+  ACCOUNTING_TYPE_DEPOSIT_IPG = 10;
+  ACCOUNTING_TYPE_DEPOSIT_BANK_ACCOUNT = 11;
+  ACCOUNTING_TYPE_DEPOSIT_IBAN = 12;
+  ACCOUNTING_TYPE_DEPOSIT_CARD = 13;
+  ACCOUNTING_TYPE_DEPOSIT_DIRECT_DEBIT = 14;
+
+  // Withdraw
+  ACCOUNTING_TYPE_WITHDRAW_IBAN = 20; // User request to receive irt via iban
+  ACCOUNTING_TYPE_WITHDRAW_CARD = 21; // User request to receive irt via card no
+  ACCOUNTING_TYPE_WITHDRAW_BANK_ACCOUNT = 22; // User request to receive irt via bank
+  ACCOUNTING_TYPE_WITHDRAW_IPG_REFUND = 23;
+
+  // ???
+}
+enum AccountingStatus {
+  ACCOUNTING_STATUS_UNKNOWN = 0;
+  ACCOUNTING_STATUS_CREATED = 1;
+  ACCOUNTING_STATUS_PENDING = 2;
+  ACCOUNTING_STATUS_SUCCESS = 3;
+  ACCOUNTING_STATUS_FAILED = 4;
+  ACCOUNTING_STATUS_CANCELLED = 5;
+  ACCOUNTING_STATUS_REJECTED = 6;
+}
+
 enum IPGStatus {
   IPG_SUCCESS = 0;
   IPG_FAILED = -1;
@@ -588,33 +665,89 @@ enum IPGStatus {
 // represent the information regarding the sale of the token
 message IPGGetTokenReq {
   auth.v1.InternalIAM iam = 1;
-  int64 asset_id = 2;
-  double amount = 3;
-  optional uint64 discount_code = 4;
+  double amount = 2;
+  repeated string allowed_card_numbers = 3;
 }
 
 // represent the information regarding the ipg gateway
 message IPGGetTokenRes {
   string url = 1;
-  int64 unit_price = 2;
-  int64 total_price = 3;
-  double amount = 4;
-  string asset = 5;
-  optional uint64 discount_code = 6;
+  int64 amount = 2;
 }
 
 message IPGConfirmReq {
+  string redirected_url = 1; // This field includes all of ipg's query params
+  // string ref_id = 1;
+  // string res_code = 2;
+  // string sale_order_id = 3;
+  // string sale_reference_id = 4;
+  // string card_holder_info = 5;
+  // string card_holder_pan = 6;
+  // string amount = 7;
+}
+
+
+message WithdrawLog {
+  uint64 id = 1;
+  Accounting accounting = 2;
+  string rrn = 3;
+  int64 amount = 4;
+  AccountingStatus status = 5;
+  string created_at = 6;
+  string updated_at = 7;
+  optional Transaction transaction = 8;
+  optional auth.v1.BankInfo bankinfo_id = 10;
+  optional bool accepted_by_admin = 11;
+}
+
+enum PSP {
+  PSP_UNKNOWN = 0;
+
+  PSP_VANDAR_BP_MELLAT = 10;
+  PSP_VANDAR_SEP = 11;
+  PSP_VANDAR = 12;
+
+  PSP_BP_MELLAT = 20;
+}
+
+message Accounting {
+  uint64 id = 1;
+  int64 user_id = 2;
+  int64 balance = 3;
+  auth.v1.UserIdentityBasic user = 4;
+}
+
+message IPGGenTokenPayload {
+  int64 amount = 2;
+  string payer_id = 3;
+  string mobile = 4;
+  string national_id = 5;
+  int64 order_id = 6;
+  string callback_url = 7;
+  repeated string bank_cards = 8;
+}
+
+message IPGLog {
   string ref_id = 1;
-  string res_code = 2;
-  string sale_order_id = 3;
-  string sale_reference_id = 4;
-  string card_holder_info = 5;
-  string card_holder_pan = 6;
-  string final_amount = 7;
+  Accounting accounting = 2;
+  int64 amount = 4;
+  AccountingStatus status = 5;
+  string created_at = 6;
+  string updated_at = 7;
+  string token = 8;
+  PSP psp = 9;
+  optional int64 transaction_id = 10;
+  optional Transaction transaction = 11;
+}
+
+message IPGLogReq {
+  auth.v1.InternalIAM iam = 1;
+  string ref_id = 2;
 }
 
 message IPGConfirmRes {
-  string receipt_link = 1;
+  string ref_id = 1;
+  optional string error = 2;
 }
 
 message SaleManualReq {
@@ -640,12 +773,14 @@ message WithdrawIRTReq {
   auth.v1.InternalIAM iam = 1;
   double amount = 2;
   int64 bank_info_id = 3;
+  auth.v1.TFA tfa = 4; 
 }
 
 message WithdrawIRTRes {
-  int64 transaction_id = 1;
+  uint64 id = 1;
   int64 amount = 2;
   string transaction_hash = 3;
+  auth.v1.BankInfo bank_info = 4;
 }
 
 message BuyAssetReq {
@@ -690,7 +825,7 @@ message BuyAssetRes {
 /* Contract */
 enum ContractType {
   CONTRACT_TYPE_ICO = 0;
-  CONTRACT_TYPE_MARKET = 1; //FIXME: Please remove this :)
+  CONTRACT_TYPE_MARKET = 1; // FIXME: Please remove this :)
   CONTRACT_TYPE_BNPL = 2;
   CONTRACT_TYPE_REDEEM = 3;
   CONTRACT_TYPE_MARKET_MAKER = 4;

wallet/v1/srv.proto

@@ -9,19 +9,13 @@ import "wallet/v1/msg.proto";
 service WalletService {
   rpc WalletSrvHealth(base.v1.Empty) returns (base.v1.StatusRes);
 
-  // Internal rpc
-  rpc InternalWalletDeleteCache(base.v1.Empty) returns (base.v1.StatusRes);
-  rpc InternalCreateFederation(auth.v1.InternalIAM) returns (base.v1.StatusRes);
-  rpc GetPublicKeyByNationalID(NationalIDReq) returns (PubKeyRes);
-
-  rpc UserGetFederation(auth.v1.InternalIAM) returns (Federation);
-
   rpc GetNetworkList(base.v1.Empty) returns (NetworkList);
 
   rpc GetAssetList(AssetFilter) returns (AssetList);
   rpc GetAsset(GetAssetReq) returns (Asset);
   rpc GetAssetCommissions(base.v1.IdReq) returns (CommissionList);
   rpc GetAssetPrice(base.v1.IdReq) returns (AssetPrice);
+  rpc AssetDiscount(AssetDiscountReq) returns (AssetDiscountRes);
 
   rpc UserInitWallet(UserInitWalletReq) returns (base.v1.StatusRes);
   rpc UserGetWalletList(auth.v1.InternalIAM) returns (WalletList);
@@ -30,12 +24,19 @@ service WalletService {
 
   rpc UserGetTransactionList(TransactionListFilter) returns (TransactionList);
 
+  // Commission Logs
+  rpc GetReferrerCommissionLogsList(auth.v1.InternalIAM) returns (ReferrerCommissionLogsList);
+  rpc GetTotalReferralCommission(TotalReferralCommissionIn) returns (TotalReferralCommissionOut);
+  rpc ClaimReferralCommission(ClaimReferralCommissionIn) returns (base.v1.StatusRes);
+
   // Get Token from IPG is and internal api
   rpc IPGGetToken(IPGGetTokenReq) returns (IPGGetTokenRes);
   // IPG Confirm is a public api
   rpc IPGConfirm(IPGConfirmReq) returns (IPGConfirmRes);
+  rpc GetIPGLog(IPGLogReq) returns (IPGLog);
+
   // Admin can increase user's balance as wish
-  rpc AdminManualSaleDeposit(SaleManualReq) returns (base.v1.StatusRes);
+  // rpc AdminManualSaleDeposit(SaleManualReq) returns (base.v1.StatusRes);
 
   // BNPL
   rpc GetBNPLList(base.v1.Empty) returns (BNPLList);
@@ -54,8 +55,6 @@ service WalletService {
   rpc InternalTransferAsset(TransferAssetReq) returns (TransferAssetRes);
   rpc ExternalTransferAsset(TransferAssetReq) returns (TransferAssetRes);
 
-  rpc AssetDiscount(AssetDiscountReq) returns (AssetDiscountRes);
-
   //  --- IRT ---
   rpc WithdrawIRT(WithdrawIRTReq) returns (WithdrawIRTRes);
   rpc DepositIRT(DepositIRTReq) returns (IPGGetTokenRes);