@riocrypto/common-server 1.0.622 → 1.0.624

package/build/common/src/types/business-user.d.ts

@@ -0,0 +1,30 @@
+import { Country } from "./country";
+import { KYCStatus } from "./kyc-status";
+import { Language } from "./language";
+import { PlatformFeeRange } from "./platform-fee-range";
+import { USState } from "./us-state";
+import { UserAttribute } from "./user-attribute";
+import { UserType } from "./user-type";
+export interface BusinessUser {
+    id: string;
+    authId?: string;
+    type: UserType;
+    companyName: string;
+    legalRepresentative: string;
+    phoneNumber: string;
+    email: string;
+    street1: string;
+    street2?: string;
+    city: string;
+    state: USState | string;
+    postalCode: string;
+    country: Country;
+    kycStatus: KYCStatus;
+    cpf?: string;
+    language?: Language;
+    COIFile?: string;
+    KYCReportFile?: string;
+    attributes?: UserAttribute[];
+    brokerId?: string;
+    platformFeeRanges?: PlatformFeeRange[];
+}

package/build/common/src/types/business-user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/common/src/types/country.d.ts

@@ -0,0 +1,57 @@
+export declare enum Country {
+    Algeria = "DZ",
+    Argentina = "AR",
+    Australia = "AU",
+    Austria = "AT",
+    Belgium = "BE",
+    Bolivia = "BO",
+    Brazil = "BR",
+    Canada = "CA",
+    Chile = "CL",
+    Colombia = "CO",
+    CostaRica = "CR",
+    Cyprus = "CY",
+    CzechRepublic = "CZ",
+    Denmark = "DK",
+    DominicanRepublic = "DO",
+    Estonia = "EE",
+    Fiji = "FJ",
+    France = "FR",
+    Germany = "DE",
+    Greece = "GR",
+    HongKong = "HK",
+    Iceland = "IS",
+    India = "IN",
+    Indonesia = "ID",
+    Ireland = "IE",
+    Israel = "IL",
+    Italy = "IT",
+    Japan = "JP",
+    Korea = "KR",
+    Latvia = "LV",
+    Lithuania = "LT",
+    Luxembourg = "LU",
+    Malaysia = "MY",
+    Mexico = "MX",
+    Nepal = "NP",
+    Netherlands = "NL",
+    NewZealand = "NZ",
+    Norway = "NO",
+    Paraguay = "PY",
+    Peru = "PE",
+    Philippines = "PH",
+    Poland = "PL",
+    Portugal = "PT",
+    Singapore = "SG",
+    Slovakia = "SK",
+    Slovenia = "SI",
+    SouthAfrica = "ZA",
+    Spain = "ES",
+    Sweden = "SE",
+    Switzerland = "CH",
+    Tanzania = "TZ",
+    Thailand = "TH",
+    Turkey = "TR",
+    UnitedKingdom = "GB",
+    Vietnam = "VN"
+}

package/build/common/src/types/country.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Country = void 0;
+var Country;
+(function (Country) {
+    Country["Algeria"] = "DZ";
+    Country["Argentina"] = "AR";
+    Country["Australia"] = "AU";
+    Country["Austria"] = "AT";
+    Country["Belgium"] = "BE";
+    Country["Bolivia"] = "BO";
+    Country["Brazil"] = "BR";
+    Country["Canada"] = "CA";
+    Country["Chile"] = "CL";
+    Country["Colombia"] = "CO";
+    Country["CostaRica"] = "CR";
+    Country["Cyprus"] = "CY";
+    Country["CzechRepublic"] = "CZ";
+    Country["Denmark"] = "DK";
+    Country["DominicanRepublic"] = "DO";
+    Country["Estonia"] = "EE";
+    Country["Fiji"] = "FJ";
+    Country["France"] = "FR";
+    Country["Germany"] = "DE";
+    Country["Greece"] = "GR";
+    Country["HongKong"] = "HK";
+    Country["Iceland"] = "IS";
+    Country["India"] = "IN";
+    Country["Indonesia"] = "ID";
+    Country["Ireland"] = "IE";
+    Country["Israel"] = "IL";
+    Country["Italy"] = "IT";
+    Country["Japan"] = "JP";
+    Country["Korea"] = "KR";
+    Country["Latvia"] = "LV";
+    Country["Lithuania"] = "LT";
+    Country["Luxembourg"] = "LU";
+    Country["Malaysia"] = "MY";
+    Country["Mexico"] = "MX";
+    Country["Nepal"] = "NP";
+    Country["Netherlands"] = "NL";
+    Country["NewZealand"] = "NZ";
+    Country["Norway"] = "NO";
+    Country["Paraguay"] = "PY";
+    Country["Peru"] = "PE";
+    Country["Philippines"] = "PH";
+    Country["Poland"] = "PL";
+    Country["Portugal"] = "PT";
+    Country["Singapore"] = "SG";
+    Country["Slovakia"] = "SK";
+    Country["Slovenia"] = "SI";
+    Country["SouthAfrica"] = "ZA";
+    Country["Spain"] = "ES";
+    Country["Sweden"] = "SE";
+    Country["Switzerland"] = "CH";
+    Country["Tanzania"] = "TZ";
+    Country["Thailand"] = "TH";
+    Country["Turkey"] = "TR";
+    Country["UnitedKingdom"] = "GB";
+    Country["Vietnam"] = "VN";
+})(Country = exports.Country || (exports.Country = {}));

package/build/common/src/types/kyc-status.d.ts

@@ -0,0 +1,7 @@
+export declare enum KYCStatus {
+    Passed = "passed",
+    Failed = "failed",
+    Review = "review",
+    businessApproved = "businessApproved",
+    None = "none"
+}

package/build/common/src/types/kyc-status.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KYCStatus = void 0;
+var KYCStatus;
+(function (KYCStatus) {
+    KYCStatus["Passed"] = "passed";
+    KYCStatus["Failed"] = "failed";
+    KYCStatus["Review"] = "review";
+    KYCStatus["businessApproved"] = "businessApproved";
+    KYCStatus["None"] = "none";
+})(KYCStatus = exports.KYCStatus || (exports.KYCStatus = {}));

package/build/common/src/types/language.d.ts

@@ -0,0 +1,6 @@
+export declare enum Language {
+    EN = "en",
+    ES = "es",
+    FR = "fr",
+    PT = "pt"
+}

package/build/common/src/types/language.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Language = void 0;
+var Language;
+(function (Language) {
+    Language["EN"] = "en";
+    Language["ES"] = "es";
+    Language["FR"] = "fr";
+    Language["PT"] = "pt";
+})(Language = exports.Language || (exports.Language = {}));

package/build/common/src/types/platform-fee-range.d.ts

@@ -0,0 +1,5 @@
+export interface PlatformFeeRange {
+    min: number;
+    max: number;
+    fee: number;
+}

package/build/common/src/types/platform-fee-range.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/common/src/types/us-state.d.ts

@@ -0,0 +1,61 @@
+export declare enum USState {
+    "AL" = "AL",
+    "AK" = "AK",
+    "AS" = "AS",
+    "AZ" = "AZ",
+    "AR" = "AR",
+    "CA" = "CA",
+    "CO" = "CO",
+    "CT" = "CT",
+    "DE" = "DE",
+    "DC" = "DC",
+    "FM" = "FM",
+    "FL" = "FL",
+    "GA" = "GA",
+    "GU" = "GU",
+    "HI" = "HI",
+    "ID" = "ID",
+    "IL" = "IL",
+    "IN" = "IN",
+    "IA" = "IA",
+    "KS" = "KS",
+    "KY" = "KY",
+    "LA" = "LA",
+    "ME" = "ME",
+    "MH" = "MH",
+    "MD" = "MD",
+    "MA" = "MA",
+    "MI" = "MI",
+    "MN" = "MN",
+    "MS" = "MS",
+    "MO" = "MO",
+    "MT" = "MT",
+    "NE" = "NE",
+    "NV" = "NV",
+    "NH" = "NH",
+    "NJ" = "NJ",
+    "NM" = "NM",
+    "NY" = "NY",
+    "NC" = "NC",
+    "ND" = "ND",
+    "MP" = "MP",
+    "OH" = "OH",
+    "OK" = "OK",
+    "OR" = "OR",
+    "PW" = "PW",
+    "PA" = "PA",
+    "PR" = "PR",
+    "RI" = "RI",
+    "SC" = "SC",
+    "SD" = "SD",
+    "TN" = "TN",
+    "TX" = "TX",
+    "UT" = "UT",
+    "VT" = "VT",
+    "VI" = "VI",
+    "VA" = "VA",
+    "WA" = "WA",
+    "WV" = "WV",
+    "WI" = "WI",
+    "WY" = "WY"
+}

package/build/common/src/types/us-state.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USState = void 0;
+var USState;
+(function (USState) {
+    USState["AL"] = "AL";
+    USState["AK"] = "AK";
+    USState["AS"] = "AS";
+    USState["AZ"] = "AZ";
+    USState["AR"] = "AR";
+    USState["CA"] = "CA";
+    USState["CO"] = "CO";
+    USState["CT"] = "CT";
+    USState["DE"] = "DE";
+    USState["DC"] = "DC";
+    USState["FM"] = "FM";
+    USState["FL"] = "FL";
+    USState["GA"] = "GA";
+    USState["GU"] = "GU";
+    USState["HI"] = "HI";
+    USState["ID"] = "ID";
+    USState["IL"] = "IL";
+    USState["IN"] = "IN";
+    USState["IA"] = "IA";
+    USState["KS"] = "KS";
+    USState["KY"] = "KY";
+    USState["LA"] = "LA";
+    USState["ME"] = "ME";
+    USState["MH"] = "MH";
+    USState["MD"] = "MD";
+    USState["MA"] = "MA";
+    USState["MI"] = "MI";
+    USState["MN"] = "MN";
+    USState["MS"] = "MS";
+    USState["MO"] = "MO";
+    USState["MT"] = "MT";
+    USState["NE"] = "NE";
+    USState["NV"] = "NV";
+    USState["NH"] = "NH";
+    USState["NJ"] = "NJ";
+    USState["NM"] = "NM";
+    USState["NY"] = "NY";
+    USState["NC"] = "NC";
+    USState["ND"] = "ND";
+    USState["MP"] = "MP";
+    USState["OH"] = "OH";
+    USState["OK"] = "OK";
+    USState["OR"] = "OR";
+    USState["PW"] = "PW";
+    USState["PA"] = "PA";
+    USState["PR"] = "PR";
+    USState["RI"] = "RI";
+    USState["SC"] = "SC";
+    USState["SD"] = "SD";
+    USState["TN"] = "TN";
+    USState["TX"] = "TX";
+    USState["UT"] = "UT";
+    USState["VT"] = "VT";
+    USState["VI"] = "VI";
+    USState["VA"] = "VA";
+    USState["WA"] = "WA";
+    USState["WV"] = "WV";
+    USState["WI"] = "WI";
+    USState["WY"] = "WY";
+})(USState = exports.USState || (exports.USState = {}));

package/build/common/src/types/user-attribute.d.ts

@@ -0,0 +1,10 @@
+export declare enum UserAttribute {
+    deleted = "deleted",
+    disabled = "disabled",
+    banned = "banned",
+    beta = "beta",
+    alpha = "alpha",
+    gamma = "gamma",
+    broker = "broker",
+    brokerCustomer = "brokerCustomer"
+}

package/build/common/src/types/user-attribute.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserAttribute = void 0;
+var UserAttribute;
+(function (UserAttribute) {
+    UserAttribute["deleted"] = "deleted";
+    UserAttribute["disabled"] = "disabled";
+    UserAttribute["banned"] = "banned";
+    UserAttribute["beta"] = "beta";
+    UserAttribute["alpha"] = "alpha";
+    UserAttribute["gamma"] = "gamma";
+    UserAttribute["broker"] = "broker";
+    UserAttribute["brokerCustomer"] = "brokerCustomer";
+})(UserAttribute = exports.UserAttribute || (exports.UserAttribute = {}));

package/build/common/src/types/user-type.d.ts

@@ -0,0 +1,4 @@
+export declare enum UserType {
+    Business = "business",
+    Individual = "individual"
+}

package/build/common/src/types/user-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserType = void 0;
+var UserType;
+(function (UserType) {
+    UserType["Business"] = "business";
+    UserType["Individual"] = "individual";
+})(UserType = exports.UserType || (exports.UserType = {}));

package/build/common/src/types/user.d.ts

@@ -0,0 +1,30 @@
+import { Country } from "./country";
+import { KYCStatus } from "./kyc-status";
+import { Language } from "./language";
+import { PlatformFeeRange } from "./platform-fee-range";
+import { USState } from "./us-state";
+import { UserAttribute } from "./user-attribute";
+import { UserType } from "./user-type";
+export interface User {
+    authId: string;
+    id: string;
+    type: UserType;
+    firstName: string;
+    lastName: string;
+    phoneNumber: string;
+    birthday: Date;
+    email: string;
+    street1: string;
+    street2?: string;
+    city: string;
+    state: USState | string;
+    postalCode: string;
+    country: Country;
+    kycStatus: KYCStatus;
+    cpf?: string;
+    language?: Language;
+    partnerId?: string;
+    attributes?: UserAttribute[];
+    brokerId?: string;
+    platformFeeRanges?: PlatformFeeRange[];
+}

package/build/common/src/types/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/common-server/src/helpers/get-platform-fee.d.ts

@@ -0,0 +1,8 @@
+import { BusinessUser } from "../../../common/src/types/business-user";
+import { User } from "../../../common/src/types/user";
+import { Order } from "@riocrypto/common";
+export declare const getPlatformFee: (amountFiat: number, order: Order, user: User | BusinessUser) => Promise<{
+    platformFeeFiat: number;
+    plafformFeeFiatTax: number;
+    partnerFeeFiat: number;
+}>;

package/build/common-server/src/helpers/get-platform-fee.js

@@ -0,0 +1,107 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPlatformFee = void 0;
+const rio_settings_1 = require("../models/rio-settings");
+const mongoose_1 = __importDefault(require("mongoose"));
+const common_1 = require("@riocrypto/common");
+const kapstar_client_1 = require("../clients/kapstar-client");
+const currency_api_client_1 = require("../clients/currency-api-client");
+const partner_1 = require("../models/partner");
+const business_user_1 = require("../models/business-user");
+const getPlatformFee = (amountFiat, order, user) => __awaiter(void 0, void 0, void 0, function* () {
+    let platformFeeFiat = 0;
+    let plafformFeeFiatTax = 0;
+    let partnerFeeFiat = 0;
+    let amountUSD;
+    let conversionRateToUSD = 0;
+    const RioSettings = yield (0, rio_settings_1.buildRioSettings)(mongoose_1.default);
+    const rioSettings = yield RioSettings.findOne();
+    if (!rioSettings) {
+        throw new common_1.RioSettingsNotFoundError();
+    }
+    if (order.processor === common_1.Processor.Kapstar) {
+        const kapstarClient = yield (0, kapstar_client_1.buildKapstarClient)();
+        conversionRateToUSD = yield kapstarClient.getBRLExchangeRateUSD();
+    }
+    else if (order.fiat !== common_1.Fiat.USD) {
+        const currencyAPIClient = yield (0, currency_api_client_1.buildCurrencyAPIClient)();
+        conversionRateToUSD = yield currencyAPIClient.convert(order.fiat, common_1.Fiat.USD);
+    }
+    else if (order.fiat === common_1.Fiat.USD) {
+        conversionRateToUSD = 1;
+    }
+    amountUSD = amountFiat * conversionRateToUSD;
+    if (!amountUSD) {
+        throw new Error("Could not convert amount to USD");
+    }
+    if (order.partnerId) {
+        const Partner = (0, partner_1.buildPartner)(mongoose_1.default);
+        const partner = yield Partner.findById(order.partnerId);
+        if (!partner) {
+            throw new common_1.PartnerNotFoundError();
+        }
+        platformFeeFiat = amountFiat * partner.platformFee;
+        partnerFeeFiat = amountFiat * partner.partnerFee;
+    }
+    else if (user === null || user === void 0 ? void 0 : user.platformFeeRanges) {
+        for (const range of user.platformFeeRanges) {
+            if (range.min <= Number(amountUSD) && range.max >= Number(amountUSD)) {
+                platformFeeFiat = amountFiat * range.fee;
+                break;
+            }
+        }
+        // @ts-ignore
+        if (platformFeeFiat === undefined) {
+            platformFeeFiat = amountFiat * rioSettings.platformFee;
+        }
+        partnerFeeFiat = 0;
+    }
+    else {
+        platformFeeFiat = amountFiat * rioSettings.platformFee;
+        partnerFeeFiat = 0;
+    }
+    if (order.brokerCustomerId) {
+        const BusinessUser = (0, business_user_1.buildBusinessUser)(mongoose_1.default);
+        const brokerCustomer = yield BusinessUser.findById(order.brokerCustomerId);
+        if (!brokerCustomer) {
+            throw new Error("Business user not found");
+        }
+        if (brokerCustomer === null || brokerCustomer === void 0 ? void 0 : brokerCustomer.platformFeeRanges) {
+            for (const range of brokerCustomer.platformFeeRanges) {
+                if (range.min <= Number(amountUSD) && range.max >= Number(amountUSD)) {
+                    platformFeeFiat = amountFiat * range.fee;
+                    break;
+                }
+            }
+        }
+    }
+    if ((order.fiat === common_1.Fiat.MXN && order.processor === common_1.Processor.SPEI) ||
+        (order.fiat === common_1.Fiat.USD && order.processor === common_1.Processor.SPID)) {
+        if (user.country === common_1.Country.Mexico) {
+            plafformFeeFiatTax = platformFeeFiat * 0.16;
+        }
+    }
+    if (order.fiat === common_1.Fiat.PEN && order.processor === common_1.Processor.Interbank) {
+        if (user.country === common_1.Country.Peru) {
+            plafformFeeFiatTax = platformFeeFiat * 0.18;
+        }
+    }
+    return {
+        platformFeeFiat,
+        plafformFeeFiatTax,
+        partnerFeeFiat,
+    };
+});
+exports.getPlatformFee = getPlatformFee;

package/build/{models → common-server/src/models}/order.js

@@ -71,15 +71,6 @@ const buildOrder = (mongoose) => {
             type: String,
         },
         fees: {
-            processingFeeCrypto: {
-                type: Number,
-            },
-            transferFeeCrypto: {
-                type: Number,
-            },
-            platformFeeCrypto: {
-                type: Number,
-            },
             processingFeeFiat: {
                 type: Number,
             },
@@ -92,6 +83,9 @@ const buildOrder = (mongoose) => {
             partnerFeeFiat: {
                 type: Number,
             },
+            platformFeeFiatTax: {
+                type: Number,
+            },
         },
         price: {
             type: Number,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riocrypto/common-server",
-  "version": "1.0.622",
+  "version": "1.0.624",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -24,7 +24,7 @@
     "@aws-sdk/client-s3": "^3.297.0",
     "@everapi/currencyapi-js": "^1.0.6",
     "@google-cloud/storage": "^6.9.5",
-    "@riocrypto/common": "^1.0.585",
+    "@riocrypto/common": "^1.0.586",
     "@types/express": "^4.17.13",
     "axios": "^0.27.2",
     "ccxt": "^3.0.30",