[feature] add support to cashout individuals

packages/api/src/controllers/v2/cico/index.ts

@@ -0,0 +1,17 @@
+import { Request, Response } from 'express';
+import { services } from '@impactmarket/core';
+
+import { ListCICOProviderRequestSchema } from '~validators/cico';
+import { ValidatedRequest } from '~utils/queryValidator';
+import { standardResponse } from '~utils/api';
+
+const { CICOProviderService } = services.app;
+
+export const getCICO = (req: Request & ValidatedRequest<ListCICOProviderRequestSchema>, res: Response) => {
+ const cicoProviderService = new CICOProviderService();
+
+ cicoProviderService
+ .get(req.query)
+ .then(r => standardResponse(res, 200, true, r, {}))
+ .catch(e => standardResponse(res, 400, false, '', { error: e.message }));
+};

packages/api/src/routes/v2/cico/index.ts

@@ -0,0 +1,48 @@
+import { Router } from 'express';
+
+import { getCICO } from '~controllers/v2/cico';
+import { listCICOProviderValidator } from '~validators/cico';
+
+export default (app: Router): void => {
+ const route = Router();
+ app.use('/cico', route);
+
+ /**
+ * @swagger
+ *
+ * /cico:
+ * get:
+ * tags:
+ * - "cico"
+ * summary: Get cash-in/cash-out providers
+ * parameters:
+ * - in: query
+ * name: country
+ * schema:
+ * type: string
+ * required: false
+ * description: filter by country
+ * - in: query
+ * name: lat
+ * schema:
+ * type: number
+ * required: false
+ * description: latitude used for nearest location
+ * - in: query
+ * name: lng
+ * schema:
+ * type: number
+ * required: false
+ * description: longitude used for nearest location
+ * - in: query
+ * name: distance
+ * schema:
+ * type: number
+ * required: false
+ * description: distance in kilometers between the user location and providers
+ * responses:
+ * "200":
+ * description: OK
+ */
+ route.get('/:query?', listCICOProviderValidator, getCICO);
+};

packages/api/src/routes/v2/index.ts

@@ -1,6 +1,7 @@
 import { Router } from 'express';
 
 import attestation from './attestation';
+import cico from './cico';
 import claimLocation from './claimLocation';
 import community from './community';
 import generic from './generic';
@@ -25,6 +26,7 @@ export default (): Router => {
  microcredit(app);
  protocol(app);
  referrals(app);
+ cico(app);
 
  return app;
 };

packages/api/src/server.ts

@@ -62,6 +62,10 @@ export default (app: express.Application): void => {
  description:
  'MicroCredit endpoints. In this section, all endpoints are protected by authentication and signature verification. Be sure to be properly authenticated!'
  },
+ {
+ name: 'learn-and-earn',
+ description: 'Learn and Earn'
+ },
  {
  name: 'referrals',
  description: 'impactMarket referral program!'

packages/api/src/validators/cico.ts

@@ -0,0 +1,28 @@
+import { Joi } from 'celebrate';
+
+import { ContainerTypes, ValidatedRequestSchema, createValidator } from '../utils/queryValidator';
+import { defaultSchema } from './defaultSchema';
+
+const validator = createValidator();
+
+type ListCICOProviderType = {
+ country?: string;
+ lat?: number;
+ lng?: number;
+ distance?: number;
+};
+
+const queryListBorrowersSchema = defaultSchema.object<ListCICOProviderType>({
+ country: Joi.string().optional(),
+ lat: Joi.number().optional(),
+ lng: Joi.number().optional(),
+ distance: Joi.number().optional()
+});
+
+interface ListCICOProviderRequestSchema extends ValidatedRequestSchema {
+ [ContainerTypes.Query]: ListCICOProviderType;
+}
+
+const listCICOProviderValidator = validator.query(queryListBorrowersSchema);
+
+export { listCICOProviderValidator, ListCICOProviderRequestSchema };

packages/core/src/database/db.ts

@@ -3,6 +3,7 @@ import { ModelStatic, Sequelize } from 'sequelize/types';
 import { AirgrabProofModel } from './models/airgrab/airgrabProof';
 import { AirgrabUserModel } from './models/airgrab/airgrabUser';
 import { AppAnonymousReportModel } from './models/app/anonymousReport';
+import { AppCICOProviderModel } from './models/cico/providers';
 import { AppClientCredentialModel } from './models/app/appClientCredential';
 import { AppExchangeRates } from './models/app/exchangeRates';
 import { AppLogModel } from './models/app/appLog';
@@ -70,6 +71,7 @@ export type DbModels = {
  appUserValidationCode: ModelStatic<AppUserValidationCodeModel>;
  ubiBeneficiarySurvey: ModelStatic<UbiBeneficiarySurveyModel>;
  appReferralCode: ModelStatic<AppReferralCodeModel>;
+ appCICOProvider: ModelStatic<AppCICOProviderModel>;
  //
  community: ModelStatic<Community>;
  ubiCommunitySuspect: ModelStatic<UbiCommunitySuspectModel>;

packages/core/src/database/migrations/z20230920145533-create-cico-provider.js

@@ -0,0 +1,48 @@
+'use strict';
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+ async up(queryInterface, Sequelize) {
+ await queryInterface.createTable('app_cico_provider', {
+ id: {
+ type: Sequelize.INTEGER,
+ autoIncrement: true,
+ primaryKey: true
+ },
+ name: {
+ type: Sequelize.STRING(64),
+ allowNull: false
+ },
+ description: {
+ type: Sequelize.STRING(256),
+ allowNull: false
+ },
+ countries: {
+ type: Sequelize.ARRAY(Sequelize.STRING(2)),
+ allowNull: false
+ },
+ type: {
+ type: Sequelize.INTEGER,
+ allowNull: false
+ },
+ isCashin: {
+ type: Sequelize.BOOLEAN,
+ allowNull: false
+ },
+ isCashout: {
+ type: Sequelize.BOOLEAN,
+ allowNull: false
+ },
+ details: {
+ type: Sequelize.JSONB,
+ allowNull: false
+ },
+ updatedAt: {
+ type: Sequelize.DATE,
+ allowNull: false
+ }
+ });
+ },
+ async down(queryInterface, Sequelize) {
+ await queryInterface.dropTable('app_cico_provider');
+ }
+};

packages/core/src/database/models/cico/providers.ts

@@ -0,0 +1,123 @@
+import { DataTypes, Model, Sequelize } from 'sequelize';
+
+type ExchangeDetails = {
+ fee: number;
+ min?: number;
+ max?: number;
+ logoUrl?: string;
+ website?: string;
+ customImplementation?: string;
+ iframeUrl?: string;
+};
+
+type MerchantDetails = {
+ category: number;
+ fee: number;
+ min?: number;
+ max?: number;
+ // it's maps address, not wallet address
+ address: string;
+ phone: string;
+ gps: {
+ latitude: number;
+ longitude: number;
+ };
+ payment: boolean;
+};
+
+type IndividualDetails = {
+ category: number;
+ fee: number;
+ min?: number;
+ max?: number;
+ phone: string;
+};
+
+export interface CICOProviderRegistry {
+ id: number;
+ name: string;
+ description: string;
+ countries: string[];
+ type: number;
+ isCashin: boolean;
+ isCashout: boolean;
+ details: ExchangeDetails | MerchantDetails | IndividualDetails;
+
+ updatedAt: Date;
+}
+
+export interface CICOProviderRegistryCreation {
+ name: string;
+ description: string;
+ countries: string[];
+ type: number;
+ isCashin: boolean;
+ isCashout: boolean;
+ details: ExchangeDetails | MerchantDetails | IndividualDetails;
+}
+
+export class AppCICOProviderModel extends Model<CICOProviderRegistry, CICOProviderRegistryCreation> {
+ public id!: number;
+ public name!: string;
+ public description!: string;
+ public countries!: string[];
+ // 0 - exchange, 1 - merchant, 2 - individual
+ public type!: number;
+ public isCashin!: boolean;
+ public isCashout!: boolean;
+ public details!: ExchangeDetails | MerchantDetails | IndividualDetails;
+
+ // timestamps!
+ public updatedAt!: Date;
+}
+
+export function initializeAppCICOProvider(sequelize: Sequelize): typeof AppCICOProviderModel {
+ AppCICOProviderModel.init(
+ {
+ id: {
+ type: DataTypes.INTEGER,
+ autoIncrement: true,
+ primaryKey: true
+ },
+ name: {
+ type: DataTypes.STRING(64),
+ allowNull: false
+ },
+ description: {
+ type: DataTypes.STRING(256),
+ allowNull: false
+ },
+ countries: {
+ type: DataTypes.ARRAY(DataTypes.STRING(2)),
+ allowNull: false
+ },
+ type: {
+ type: DataTypes.INTEGER,
+ allowNull: false
+ },
+ isCashin: {
+ type: DataTypes.BOOLEAN,
+ allowNull: false
+ },
+ isCashout: {
+ type: DataTypes.BOOLEAN,
+ allowNull: false
+ },
+ details: {
+ type: DataTypes.JSONB,
+ allowNull: false
+ },
+ updatedAt: {
+ type: DataTypes.DATE,
+ allowNull: false
+ }
+ },
+ {
+ tableName: 'app_cico_provider',
+ modelName: 'appCICOProvider',
+ sequelize,
+ createdAt: false
+ }
+ );
+ return AppCICOProviderModel;
+}

packages/core/src/database/models/index.ts

@@ -4,6 +4,7 @@ import { communityAssociation } from './associations/community';
 import { initializeAirgrabProof } from './airgrab/airgrabProof';
 import { initializeAirgrabUser } from './airgrab/airgrabUser';
 import { initializeAppAnonymousReport } from './app/anonymousReport';
+import { initializeAppCICOProvider } from './cico/providers';
 import { initializeAppClientCredential } from './app/appClientCredential';
 import { initializeAppExchangeRates } from './app/exchangeRates';
 import { initializeAppLog } from './app/appLog';
@@ -76,6 +77,7 @@ export default function initModels(sequelize: Sequelize): void {
  initializeAppLog(sequelize);
  initializeAppUserValidationCode(sequelize);
  initializeAppReferralCode(sequelize);
+ initializeAppCICOProvider(sequelize);
 
  // ubi
  initializeCommunity(sequelize);