Bug/bbnd 1127 coupon rate decimals (#642)

Signed-off-by: Alberto Molina <[email protected]>
Signed-off-by: Luigi Navarro <[email protected]>
Co-authored-by: Luigi Navarro <[email protected]>
Signed-off-by: Mario Francia <[email protected]>

Author: AlbertoMolinaIoBuilders

apps/ats/web/src/utils/format.ts

@@ -207,7 +207,7 @@ import _capitalize from 'lodash/capitalize';
 import _formatDate from 'date-fns/format';
 import { TimeUnit } from './types';
 import i18n from '../i18n';
-import { LOCALE } from './constants';
+import { LOCALE, TIME_PERIODS_S } from './constants';
 
 export const formatAddressAccount = (address: string) => `${_capitalize(
   address.slice(0, 2),
@@ -296,8 +296,6 @@ export const formatPeriod = ({
  * Formats a period in seconds to human-readable format
  */
 export const formatCouponPeriod = (periodInSeconds: number): string => {
-  const { TIME_PERIODS_S } = require('./constants');
-
   if (periodInSeconds >= TIME_PERIODS_S.YEAR) {
     const years = Math.floor(periodInSeconds / TIME_PERIODS_S.YEAR);
     return `${years} ${years === 1 ? 'Year' : 'Years'}`;

apps/ats/web/src/utils/rules.ts

@@ -208,7 +208,7 @@ import isBefore from 'date-fns/isBefore';
 import isToday from 'date-fns/isToday';
 import isEqual from 'date-fns/isEqual';
 import i18n from '../i18n';
-import { formatDate, toDate } from './format';
+import { formatDate, toDate, validateCouponPeriod } from './format';
 
 const t = (key: string, options?: Record<string, unknown>) => {
   return i18n.t(`rules:${key}`, options);
@@ -334,7 +334,6 @@ export const isValidCouponPeriod = (val: string) => {
       return 'Coupon period must be a valid positive number';
     }
 
-    const { validateCouponPeriod } = require('./format');
     const validation = validateCouponPeriod(periodValue);
     return validation === true || validation;
   } catch (error) {

apps/ats/web/src/views/DigitalSecurityDetails/Components/Coupons/CouponsList.tsx

@@ -7,8 +7,12 @@ import { useParams } from 'react-router-dom';
 import { createColumnHelper } from '@tanstack/table-core';
 import { Table, Text } from 'io-bricks-ui';
 import { useTranslation } from 'react-i18next';
-import { COUPONS_FACTOR, DATE_TIME_FORMAT } from '../../../../utils/constants';
-import { formatDate, formatCouponPeriod } from '../../../../utils/format';
+import { DATE_TIME_FORMAT } from '../../../../utils/constants';
+import {
+  formatDate,
+  formatCouponPeriod,
+  formatNumberLocale,
+} from '../../../../utils/format';
 
 export const CouponsList = () => {
   const { id } = useParams();
@@ -46,7 +50,8 @@ export const CouponsList = () => {
     }),
     columnHelper.accessor('rate', {
       header: t('columns.rate'),
-      cell: (row) => `${parseInt(row.getValue()) / COUPONS_FACTOR}%`,
+      cell: (row) =>
+        `${formatNumberLocale(row.getValue(), row.row.original.rateDecimals ?? 0)}%`,
       enableSorting: false,
     }),
     columnHelper.accessor('period', {

apps/ats/web/src/views/DigitalSecurityDetails/Components/Coupons/ProgramCoupon.tsx

@@ -227,11 +227,7 @@ import {
   dateToUnixTimestamp,
   validateCouponPeriod,
 } from '../../../../utils/format';
-import {
-  COUPONS_FACTOR,
-  DATE_TIME_FORMAT,
-  TIME_PERIODS_S,
-} from '../../../../utils/constants';
+import { DATE_TIME_FORMAT, TIME_PERIODS_S } from '../../../../utils/constants';
 import { isBeforeDate } from '../../../../utils/helpers';
 
 interface ProgramCouponFormValues {
@@ -263,7 +259,7 @@ export const ProgramCoupon = () => {
   const submit: SubmitHandler<ProgramCouponFormValues> = (params) => {
     const request = new SetCouponRequest({
       securityId: id ?? '',
-      rate: (params.rate * COUPONS_FACTOR).toString(),
+      rate: params.rate.toString(),
       recordTimestamp: dateToUnixTimestamp(params.recordTimestamp),
       executionTimestamp: dateToUnixTimestamp(params.executionTimestamp),
       period: params.period,

packages/ats/contracts/contracts/factory/ERC3643/interfaces/IBondRead.sol

@@ -218,6 +218,7 @@ interface TRexIBondRead {
         uint256 recordDate;
         uint256 executionDate;
         uint256 rate;
+        uint8 rateDecimals;
         uint256 period;
     }
 
@@ -229,6 +230,7 @@ interface TRexIBondRead {
     struct CouponFor {
         uint256 tokenBalance;
         uint256 rate;
+        uint8 rateDecimals;
         uint256 recordDate;
         uint256 executionDate;
         uint256 period;

packages/ats/contracts/contracts/layer_0/bond/BondStorageWrapper.sol

@@ -314,6 +314,7 @@ abstract contract BondStorageWrapper is
         );
 
         couponFor_.rate = registeredCoupon.coupon.rate;
+        couponFor_.rateDecimals = registeredCoupon.coupon.rateDecimals;
         couponFor_.recordDate = registeredCoupon.coupon.recordDate;
         couponFor_.executionDate = registeredCoupon.coupon.executionDate;
         couponFor_.period = registeredCoupon.coupon.period;

packages/ats/contracts/contracts/layer_2/bond/Bond.sol

@@ -265,6 +265,7 @@ abstract contract Bond is IBond, Common {
             _newCoupon.recordDate,
             _newCoupon.executionDate,
             _newCoupon.rate,
+            _newCoupon.rateDecimals,
             _newCoupon.period
         );
     }

packages/ats/contracts/contracts/layer_2/interfaces/bond/IBondRead.sol

@@ -218,6 +218,7 @@ interface IBondRead {
         uint256 recordDate;
         uint256 executionDate;
         uint256 rate;
+        uint8 rateDecimals;
         uint256 period;
     }
 
@@ -229,6 +230,7 @@ interface IBondRead {
     struct CouponFor {
         uint256 tokenBalance;
         uint256 rate;
+        uint8 rateDecimals;
         uint256 recordDate;
         uint256 executionDate;
         uint256 period;

packages/ats/contracts/contracts/layer_2/interfaces/bond/IBondStorageWrapper.sol

@@ -224,6 +224,7 @@ interface IBondStorageWrapper {
         uint256 indexed recordDate,
         uint256 indexed executionDate,
         uint256 rate,
+        uint256 rateDecimals,
         uint256 period
     );
 

packages/ats/contracts/scripts/factory.ts

@@ -270,13 +270,15 @@ export interface BondDetailsData {
 export interface CouponDetailsData {
     couponFrequency: number
     couponRate: number
+    couponRateDecimals: number
     firstCouponDate: number
 }
 
 export interface CouponData {
     recordDate: number
     executionDate: number
     rate: number
+    rateDecimals: number
     period: number
 }
 
@@ -509,6 +511,7 @@ export async function setBondData({
     maturityDate,
     couponFrequency,
     couponRate,
+    couponRateDecimals,
     firstCouponDate,
     init_rbacs,
     addAdmin = true,
@@ -538,6 +541,7 @@ export async function setBondData({
     maturityDate: number
     couponFrequency: number
     couponRate: number
+    couponRateDecimals: number
     firstCouponDate: number
     init_rbacs?: Rbac[]
     addAdmin: boolean
@@ -604,6 +608,7 @@ export async function setBondData({
     const couponDetails: CouponDetailsData = {
         couponFrequency: couponFrequency,
         couponRate: couponRate,
+        couponRateDecimals: couponRateDecimals,
         firstCouponDate: firstCouponDate,
     }
 
@@ -762,6 +767,7 @@ export async function deployBondFromFactory({
     maturityDate,
     couponFrequency,
     couponRate,
+    couponRateDecimals,
     firstCouponDate,
     regulationType,
     regulationSubType,
@@ -794,6 +800,7 @@ export async function deployBondFromFactory({
     maturityDate: number
     couponFrequency: number
     couponRate: number
+    couponRateDecimals: number
     firstCouponDate: number
     regulationType: number
     regulationSubType: number
@@ -827,6 +834,7 @@ export async function deployBondFromFactory({
         maturityDate,
         couponFrequency,
         couponRate,
+        couponRateDecimals,
         firstCouponDate,
         init_rbacs,
         addAdmin,