v2: ci updates

Signed-off-by: nfel <nfilsaraee@gmail.com>

.gitea/workflows/buf-ci.yaml

@@ -0,0 +1,75 @@
+name: Buf CI
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read
+  pull-requests: write
+  packages: write
+
+jobs:
+  buf:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ">=1.23.0"
+      - uses: bufbuild/buf-setup-action@v1.47.2
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ gitea.token }}
+          path: ./
+
+      - name: install tea cli and init 
+        run: |
+          mkdir tmp && cd tmp
+          curl -SsOL https://dl.gitea.com/tea/main/tea-main-linux-amd64.xz
+          apt install xz-utils -y
+          xz -d tea-main-linux-amd64.xz
+          ls -ahl
+          mv tea-main-linux-amd64 /usr/bin/tea
+          cd ..
+          tea --version
+          tea login \
+            --name ${{ gitea.server_url }} \
+            --token ${{ secrets.PROD_REG_TOKEN }} \
+            --url ${{ gitea.server_url }}
+      - run: go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+      - run: go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+      - run: go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
+      - run: npm install --save @bufbuild/protobuf @bufbuild/protoc-gen-es @bufbuild/buf
+      - run: buf --version
+      - run: "export PATH=$PATH:./node_modules/.bin\nbuf generate \n"
+      - name: tar files
+        run: |
+            for out in go ts doc; do
+              tar czf .res/${out}.tar.gz ./stub/${out}/
+            done
+            tar czf ./.res/src.tar.gz $(find -type f -name "*.proto")
+            tea r c \
+              --title "${{ gitea.ref_name }}" \
+              --tag "${{ gitea.ref_name }}" \
+              -a ./.res/src.tar.gz \
+              -a ./.res/go.tar.gz \
+              -a ./.res/doc.tar.gz \
+              -a ./.res/ts.tar.gz \
+
+      # - run: |
+      #     if [ -n ${{ gitea.ref_name }} ]; then
+      #       mkdir .res
+      #       for out in go ts doc; do
+      #         echo releasing ${out} ...
+      #         tar czf .res/${out}.tar.gz ./stub/${out}/
+      #         curl -Ss --user nfel:${{ secrets.PROD_REG_TOKEN }}\
+      #           --upload-file .res/${out}.tar.gz \
+      #           ${{ gitea.server_url }}/api/packages/Kahroba/generic/proto/${{ gitea.ref_name }}/${out}.tar.gz
+      #       done
+      #         echo releasing proto ...
+      #         tar czf ./.res/src.tar.gz $(find -type f -name "*.proto")
+      #         curl -Ss --user nfel:${{ secrets.PROD_REG_TOKEN }}\
+      #           --upload-file ./.res/src.tar.gz \
+      #           ${{ gitea.server_url }}/api/packages/Kahroba/generic/proto/${{ gitea.ref_name }}/src.tar.gz
+      #     fi
+      # - run: | 

.gitignore

@@ -0,0 +1,6 @@
+.idea
+gen/go
+stub
+node_modules
+yarn.lock
+package-lock.json

README.md

@@ -0,0 +1,3 @@
+# Protobuf with fangs
+
+![Build Status](https://git.kahrobatoken.com/Kahroba/proto/actions/workflows/buf-ci.yaml/badge.svg?branch=v2)

alert/v1/msg.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package alert.v1;
+
+enum Importance {
+  LOW = 0;
+  MEDIUM = 1;
+  HIGH = 2;
+  CRITICAL = 3;
+}
+
+enum LogSource {
+  UNKNOWN = 0;
+  USER = 1;
+  SYSTEM = 2;
+  WALLET = 3;
+}
+
+message Meta {
+  uint32 created_at_ts = 1;
+  uint32 updated_at_ts = 2;
+  uint32 blamer_id = 3; // User ID of person who made the change
+}
+
+message LogEvent {
+  optional uint64 id = 1; // Record Id of Log stored in db
+  string content = 2;
+  string effective_user = 3;
+  optional LogEvent prev_cause = 4;
+  optional LogSource source = 5;
+  Importance importance = 6;
+  Meta meta = 7;
+}
+
+message LogEventList {
+  repeated LogEvent events = 1;
+}
+/*
+   Internal Msg
+*/
+message SMS {
+  string recipient = 1; //recipient
+  string text = 2;
+  optional string sender = 3;
+  Meta meta = 4;
+}

alert/v1/srv.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package alert.v1;
+
+import "alert/v1/msg.proto";
+import "base/v1/msg.proto";
+
+service AlertSrv {
+  rpc Log(LogEvent) returns (base.v1.StatusRes) {}
+  rpc LogHistory(base.v1.IdReq)  returns(LogEventList) {}
+  rpc StatusChange(LogEvent) returns (base.v1.StatusRes) {}
+}

auth/v1/msg.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-package authorization;
+package auth.v1;
 
 /*
    Internal
@@ -19,7 +19,7 @@ message InternalRoute {
 message Role {
   int64 id = 1;
   string title = 2;
-  string Key = 3;
+  string key = 3;
   string type = 4;
 }
 message Permission {

auth/v1/srv.proto

@@ -1,13 +1,13 @@
 syntax = "proto3";
 
-package authorization;
+package auth.v1;
 
-import "authorization_message.proto";
-import "base_message.proto";
+import "auth/v1/msg.proto";
+import "base/v1/msg.proto";
 
 service AuthorizationService {
-  rpc InternalAuthorizationDeleteCache(base.Empty) returns (base.StatusRes);
-  rpc InternalInitRoutes(InternalInitRoutesReq) returns (base.StatusRes) {}
+  rpc InternalAuthorizationDeleteCache(base.v1.Empty) returns (base.v1.StatusRes);
+  rpc InternalInitRoutes(InternalInitRoutesReq) returns (base.v1.StatusRes) {}
   rpc InternalGetUserIdentityBasic(GetUserReq) returns (UserIdentityBasic) {}
   rpc InternalGetUserIAM(GetUserReq) returns (InternalIAM) {}
   rpc CheckIAM(CheckIAMReq) returns (InternalIAM) {}
@@ -20,19 +20,19 @@ service AuthorizationService {
   rpc UserGetUserPermission(InternalIAM) returns (PermissionList) {}
 
   rpc UserGetIdentity(InternalIAM) returns (Identity) {}
-  rpc UserUpdateIdentity(UserUpdateIdentityReq) returns (base.StatusRes) {}
+  rpc UserUpdateIdentity(UserUpdateIdentityReq) returns (base.v1.StatusRes) {}
 
   rpc UserGetBankInfoList(ReqWithIAMAndParams) returns (BankInfoList) {}
-  rpc UserUpdateBankInfo(UserUpdateBankInfoReq) returns (base.StatusRes) {}
-  rpc UserRemoveBankInfo(IdReqWithIAM) returns (base.StatusRes) {}
+  rpc UserUpdateBankInfo(UserUpdateBankInfoReq) returns (base.v1.StatusRes) {}
+  rpc UserRemoveBankInfo(IdReqWithIAM) returns (base.v1.StatusRes) {}
 
   rpc GetUser(GetUserReq) returns (User) {}
 
   // Two Factor Authentication
   // For now it's only SMS-OTP - later will be Email-OTP or other methods can be
   // added For HMAC-OTP there won't be a need to call this api
-  rpc SendTFAReq(TFAReq) returns (base.StatusRes) {}
+  rpc SendTFAReq(TFAReq) returns (base.v1.StatusRes) {}
   // For HMAC-OTP an initialization step must be added to exchange keys
   rpc InitTFAReq(InternalIAM) returns (TFAExRes) {}
-  rpc CheckTFACode(CheckTFAReq) returns (base.StatusRes) {}
+  rpc CheckTFACode(CheckTFAReq) returns (base.v1.StatusRes) {}
 }

base/v1/msg.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package base.v1;
+
+message Empty {}
+
+message StatusRes {
+  bool success = 1;
+}
+message IdRes {
+  int64 id = 1;
+}
+message IdReq {
+  int64 id = 1;
+}
+message Pagination{
+  uint32 page = 1; // in query param it will be p 
+  uint32 page_size = 2; // in query param it will be pz
+}
+message Filter {
+  string query = 1; // q
+  string sort = 2; // s
+  optional Pagination page = 3; 
+}

base_message.proto

@@ -1,15 +0,0 @@
-syntax = "proto3";
-
-package base;
-
-message Empty {}
-
-message StatusRes {
-  bool success = 1;
-}
-message IdRes {
-  int64 id = 1;
-}
-message IdReq {
-  int64 id = 1;
-}

buf.gen.yaml

@@ -0,0 +1,59 @@
+---
+version: v2
+clean: true
+managed:
+  enabled: true
+  override:
+    - file_option: go_package_prefix
+      # FIXME: Change this to you're go.mod package name
+      value: github.com/nfel 
+plugins:
+  # NOTE: golang 
+  # - remote: buf.build/grpc/go
+  # NOTE: grpc 
+  # go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+  - local: protoc-gen-go-grpc
+    out: stub/go
+  # NOTE: PB files
+  # go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
+  - local: protoc-gen-go
+  # - remote: buf.build/protocolbuffers/go:v1.30.0
+    out: stub/go
+  # NOTE: doc
+  - local: protoc-gen-doc
+    opt: html,index.html,source_relative
+    out: stub/doc/html
+  - local: protoc-gen-doc
+    opt: markdown,index.md,source_relative
+    out: stub/doc/md
+  # # NOTE: Gateway
+  # # - remote: buf.build/grpc-ecosystem/gateway:v2.16.2
+  # - local: protoc-gen-grpc-gateway
+  #   out: stub/go
+  # # NOTE: SWAGGER json files
+  # # - remote: buf.build/grpc-ecosystem/openapiv2:v2.16.2
+  # - local: protoc-gen-openapiv2
+  #   opt: import_prefix=github.com/nfel 
+  #   out: stub/go
+  # - local: protoc-gen-go-gin
+  #   opt: 
+  #     # - plugin=handler
+  #     # - plugin=service
+  #     # - plugin=mix
+  #   out: stub/go
+    # NOTE: Typescript
+  # - remote: buf.build/bufbuild/es:v2.2.2
+  #   # opt: import_prefix=github.com/nfel 
+  #   out: stub/ts
+  - local: protoc-gen-es
+    out: stub/ts
+    opt: target=ts
+
+  # - local: protobuf-ts
+  #   # opt: import_prefix=github.com/nfel 
+  #   out: stub/ts
+inputs:
+  - directory: ./
+  # - git_repo: ssh://git@5.34.204.11/Kahroba/proto
+  #   branch: v2
+      

buf.yaml

@@ -1,12 +1,14 @@
 ---
-version: v1
+version: v2
+breaking:
+  use:
+    - FILE
+    - PACKAGE
 lint:
   use:
-    - DEFAULT
-# disallow_comment_ignores: false
-# # The default behavior of this key has changed from v1
-# enum_zero_value_suffix: _UNSPECIFIED
-# rpc_allow_same_request_response: true
-# rpc_allow_google_protobuf_empty_requests: false
-# rpc_allow_google_protobuf_empty_responses: false
-# service_suffix: Service
+    - BASIC
+    - PACKAGE_SAME_GO_PACKAGE
+    - PACKAGE_NO_IMPORT_CYCLE
+    - IMPORT_USED
+modules:
+  - path: ./

package.json

@@ -0,0 +1,7 @@
+{
+  "devDependencies": {
+    "@bufbuild/buf": "^1.47.2",
+    "@bufbuild/protobuf": "^2.2.2",
+    "@bufbuild/protoc-gen-es": "^2.2.2"
+  }
+}

template.buf.gen.yaml

@@ -0,0 +1,24 @@
+---
+version: v2
+clean: true
+managed:
+  enabled: true
+  override:
+    - file_option: go_package_prefix
+      value: <pkg_name>
+plugins:
+  - remote: buf.build/grpc/go
+    out: stub/go
+  - remote: buf.build/protocolbuffers/go:v1.30.0
+    out: stub/go
+  - local: protoc-gen-doc
+    opt: html,index.html,source_relative
+    out: stub/doc
+  - local: protoc-gen-grpc-gateway
+    out: stub/go
+  - local: protoc-gen-openapiv2
+    out: stub/go
+inputs:
+  - git_repo: ssh://git@5.34.204.11/Kahroba/proto
+    branch: v2
+      

wallet.proto

@@ -1,42 +0,0 @@
-syntax = "proto3";
-
-package wallet;
-
-import "authorization_message.proto";
-import "base_message.proto";
-import "wallet_message.proto";
-
-service WalletService {
-  rpc InternalWalletDeleteCache(base.Empty) returns (base.StatusRes);
-  rpc InternalCreateFederation(authorization.InternalIAM) returns (base.StatusRes);
-
-  rpc AdminGetFederation(GetFederationReq) returns (Federation);
-  rpc UserGetFederation(authorization.InternalIAM) returns (Federation);
-
-  rpc UserGetAssetList(base.Empty) returns (AssetList);
-  rpc AdminGetAssetList(base.Empty) returns (AssetList);
-  rpc GetAsset(GetAssetReq) returns (Asset);
-
-  rpc UserInitWallet(UserInitWalletReq) returns (base.StatusRes);
-  rpc UserGetWalletList(authorization.InternalIAM) returns (WalletList);
-  rpc UserTransferAsset(UserTransferAssetReq) returns (UserTransferRes);
-
-  rpc UserGetTransactionList(UserGetTransactionListReq) returns (TransactionList);
-
-  rpc SaleGetToken(SaleGetTokenReq) returns (SaleGetTokenRes);
-  rpc SaleConfirm(SaleConfirmReq) returns (SaleConfirmRes);
-  rpc AdminManualSaleDeposit(SaleManualReq) returns (base.StatusRes);
-
-  // BNPL
-  rpc GetBNPLList(base.Empty) returns (BNPLList);
-  rpc GetBNPLInfo(base.IdReq) returns (BNPLInfo);
-  rpc GetUserBNPLInfo(GetUserBNPLInfoReq) returns (UserBNPLResp);
-  rpc SubmitBNPLForm(UserBNPLReq) returns (base.StatusRes);
-  rpc UpdateBNPL(UserBNPLReq) returns (base.StatusRes);
-  rpc CancleBNPL(authorization.IdReqWithIAM) returns (base.StatusRes);
-
-  // Redeem Token
-  rpc CalculateRedeemToken(RedeemTokenReq) returns (CalculateRedeemTokenRes);
-  rpc RedeemToken(RedeemTokenReq) returns (base.StatusRes);
-  rpc RedeemTokenList(authorization.ReqWithIAMAndParams) returns (RedeemTokenResList);
-}

wallet/v1/msg.proto

@@ -1,9 +1,9 @@
 syntax = "proto3";
 
-package wallet;
+package wallet.v1;
 
-import "authorization_message.proto";
-import "base_message.proto";
+import "auth/v1/msg.proto";
+import "base/v1/msg.proto";
 
 /*
    INTERNAL DATA
@@ -109,17 +109,17 @@ message PropertyMeta {
 // }
 
 message GetUserBNPLInfoReq {
-  authorization.InternalIAM iam = 1;
-  base.IdReq id = 2;
+  auth.v1.InternalIAM iam = 1;
+  base.v1.IdReq id = 2;
 }
 
 enum BNPLPaymentsStatus {
-  PENDING = 0;
+  PENDING_PAYMENT = 0;
   PAYED = 1;
   OVER_DUE = 2;
   NOT_STARTED = 3;
   NOT_YET_DUE = 4;
-  CANCLED = 5;
+  CANCELED = 5;
 }
 message BNPLPayments {
   uint64 id = 1;
@@ -140,8 +140,8 @@ message UserBNPLResp {
   optional bool accepted_terms = 6;
   repeated BNPLPayments payments = 7;
   optional string employee_id = 8;
-  optional authorization.Company company = 10;
-  authorization.InternalIAM iam = 11;
+  optional auth.v1.Company company = 10;
+  auth.v1.InternalIAM iam = 11;
   optional string updated_at = 12;
   optional string created_at = 13;
   Asset selected_asset = 14;
@@ -150,7 +150,7 @@ message UserBNPLResp {
 message UserBNPLReq {
   uint64 id = 1;
   int64 bnpl_id = 2;
-  authorization.InternalIAM iam = 6;
+  auth.v1.InternalIAM iam = 6;
   optional string created_at = 3;
   optional string employee_id = 4;
   optional int64 company_id = 5;
@@ -175,7 +175,7 @@ message BNPLInfo {
   float amount_end = 6;
   float amount_steps = 7;
   repeated PaymentPeriodInfo payment_period = 8;
-  repeated authorization.Company possible_companies = 11;
+  repeated auth.v1.Company possible_companies = 11;
   string updated_at = 12;
   string created_at = 13;
   string expires_at = 14;
@@ -206,7 +206,7 @@ message Wallet {
 }
 
 message UserInitWalletReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   int64 asset_id = 2;
 }
 
@@ -220,19 +220,19 @@ message TransactionList {
 }
 
 enum TransactionType {
-  Unknown = 0;
-  Buy = 1;
-  Sell = 2;
-  Transfer = 3;
-  Redeem = 4;
+  UNKNOWN = 0;
+  BUY = 1;
+  SELL = 2;
+  TRANSFER = 3;
+  REDEEM = 4;
 }
 enum TransactionStatus {
-  Undetermined = 0;
-  Failed = -10;
-  Suspended = -9;
-  Created = -1;
-  Pending = 1;
-  Successful = 2;
+  UNDETERMINED = 0;
+  FAILED = -10;
+  SUSPENDED = -9;
+  CREATED = -1;
+  PENDING_TRX = 1;
+  SUCCESSFUL = 2;
 }
 
 message Transaction {
@@ -240,11 +240,11 @@ message Transaction {
   int64 asset_id = 2;
   // Asset asset_info = 3; //Causing network overloading
   optional int64 from_user_id = 4;
-  optional authorization.UserIdentityBasic from_user_info = 5;
+  optional auth.v1.UserIdentityBasic from_user_info = 5;
   optional int64 from_federation_id = 6;
   optional Federation from_federation_info = 7;
   optional int64 to_user_id = 8;
-  optional authorization.UserIdentityBasic to_user_info = 9;
+  optional auth.v1.UserIdentityBasic to_user_info = 9;
   optional int64 to_federation_id = 10;
   optional Federation to_federation_info = 11;
   double amount = 12;
@@ -256,7 +256,7 @@ message Transaction {
 }
 
 message UserGetTransactionListReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   optional int32 page_index = 2;
   optional int32 page_size = 3;
   optional int64 id = 4;
@@ -276,7 +276,7 @@ message UserGetTransactionListReq {
 */
 
 message UserBuyAssetReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   int64 asset_id = 2;
   double amount = 3;
 }
@@ -290,7 +290,7 @@ message UserBuyAssetReq {
 */
 
 message UserTransferAssetReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   int64 asset_id = 2;
   double amount = 3;
   string to_wallet_address = 4;
@@ -304,7 +304,7 @@ message UserTransferRes {
 
 // represent the information regarding the sale of the token
 message SaleGetTokenReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   int64 asset_id = 2;
   double amount = 3;
 }
@@ -319,21 +319,21 @@ message SaleGetTokenRes {
 }
 
 message SaleConfirmReq {
-  string RefId = 1;
-  string ResCode = 2;
-  string SaleOrderId = 3;
-  string SaleReferenceId = 4;
-  string CardHolderInfo = 5;
-  string CardHolderPan = 6;
-  string FinalAmount = 7;
+  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;
 }
 
 message SaleConfirmRes {
-  string receiptLink = 1;
+  string receipt_link = 1;
 }
 
 message SaleManualReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   int64 asset_id = 2;
   double amount = 3;
   string paid_at = 4;
@@ -345,7 +345,7 @@ message SaleManualReq {
    Redeem Token
 */
 message RedeemTokenReq {
-  authorization.InternalIAM iam = 1;
+  auth.v1.InternalIAM iam = 1;
   int64 asset_id = 2;
   uint64 bank_info_id = 3;
   double amount = 4;
@@ -358,7 +358,7 @@ message CalculateRedeemTokenRes {
   double request_amount = 4;
   double profit_capital = 5;
   double user_capital = 6;
-  optional authorization.BankInfo bank_info = 7;
+  optional auth.v1.BankInfo bank_info = 7;
 }
 message RedeemTokenRes {
   uint64 id = 1;
@@ -371,7 +371,7 @@ message RedeemTokenRes {
   bool is_paied = 8;
   // receipt.Receipt receipt = 8;
   double calculated_profit = 9;
-  optional authorization.BankInfo bank_info = 10;
+  optional auth.v1.BankInfo bank_info = 10;
   optional string receipt = 11;
 }
 message RedeemTokenResList {

wallet/v1/srv.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+package wallet.v1;
+
+import "auth/v1/msg.proto";
+import "base/v1/msg.proto";
+import "wallet/v1/msg.proto";
+
+service WalletService {
+  rpc InternalWalletDeleteCache(base.v1.Empty) returns (base.v1.StatusRes);
+  rpc InternalCreateFederation(auth.v1.InternalIAM) returns (base.v1.StatusRes);
+
+  rpc AdminGetFederation(GetFederationReq) returns (Federation);
+  rpc UserGetFederation(auth.v1.InternalIAM) returns (Federation);
+
+  rpc UserGetAssetList(base.v1.Empty) returns (AssetList);
+  rpc AdminGetAssetList(base.v1.Empty) returns (AssetList);
+  rpc GetAsset(GetAssetReq) returns (Asset);
+
+  rpc UserInitWallet(UserInitWalletReq) returns (base.v1.StatusRes);
+  rpc UserGetWalletList(auth.v1.InternalIAM) returns (WalletList);
+  rpc UserTransferAsset(UserTransferAssetReq) returns (UserTransferRes);
+
+  rpc UserGetTransactionList(UserGetTransactionListReq) returns (TransactionList);
+
+  rpc SaleGetToken(SaleGetTokenReq) returns (SaleGetTokenRes);
+  rpc SaleConfirm(SaleConfirmReq) returns (SaleConfirmRes);
+  rpc AdminManualSaleDeposit(SaleManualReq) returns (base.v1.StatusRes);
+
+  // BNPL
+  rpc GetBNPLList(base.v1.Empty) returns (BNPLList);
+  rpc GetBNPLInfo(base.v1.IdReq) returns (BNPLInfo);
+  rpc GetUserBNPLInfo(GetUserBNPLInfoReq) returns (UserBNPLResp);
+  rpc SubmitBNPLForm(UserBNPLReq) returns (base.v1.StatusRes);
+  rpc UpdateBNPL(UserBNPLReq) returns (base.v1.StatusRes);
+  rpc CancleBNPL(auth.v1.IdReqWithIAM) returns (base.v1.StatusRes);
+
+  // Redeem Token
+  rpc CalculateRedeemToken(RedeemTokenReq) returns (CalculateRedeemTokenRes);
+  rpc RedeemToken(RedeemTokenReq) returns (base.v1.StatusRes);
+  rpc RedeemTokenList(auth.v1.ReqWithIAMAndParams) returns (RedeemTokenResList);
+}