Feat/coupon interest rates

apps/ats/web/src/i18n/en/security/coupons.ts

@@ -36,17 +36,20 @@ export default {
         placeholder: "0,123%",
         tooltip: "Interest rate for the coupon.",
       },
-      period: {
-        label: "Coupon period",
-        placeholder: "Select coupon period",
-        tooltip: "The period between coupon payments. This field is required for all coupon operations.",
-        options: {
-          day: "1 Day",
-          week: "1 Week",
-          month: "1 Month",
-          quarter: "3 Months",
-          year: "1 Year",
-        },
+      startDate: {
+        label: "Start date",
+        placeholder: "Select start date",
+        tooltip: "Coupon’s start date, must occur before the end date.",
+      },
+      endDate: {
+        label: "End date",
+        placeholder: "Select end date",
+        tooltip: "Coupon’s end date, Accrual period correspond to the period between start and end date.",
+      },
+      fixingDate: {
+        label: "Fixing date",
+        placeholder: "Select fixing date",
+        tooltip: "Coupon’s fixing date, floating rate coupons only.",
       },
     },
   },
@@ -69,6 +72,9 @@ export default {
     details: {
       title: "Detail",
       paymentDay: "Payment day",
+      startDay: "start day",
+      endDay: "end day",
+      fixingDay: "fixing day",
       balance: "Balance",
       amount: "Amount",
       recordDateReached: "Record Date Reached",

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

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

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

@@ -208,7 +208,6 @@ import {
   CalendarInputController,
   InputNumberController,
   PhosphorIcon,
-  SelectController,
   Text,
   Tooltip,
 } from 'io-bricks-ui';
@@ -223,18 +222,17 @@ import {
 import { useParams } from 'react-router-dom';
 import { useCoupons } from '../../../../hooks/queries/useCoupons';
 import { useGetBondDetails } from '../../../../hooks/queries/useGetSecurityDetails';
-import {
-  dateToUnixTimestamp,
-  validateCouponPeriod,
-} from '../../../../utils/format';
-import { DATE_TIME_FORMAT, TIME_PERIODS_S } from '../../../../utils/constants';
+import { dateToUnixTimestamp } from '../../../../utils/format';
+import { DATE_TIME_FORMAT } from '../../../../utils/constants';
 import { isBeforeDate } from '../../../../utils/helpers';
 
 interface ProgramCouponFormValues {
   rate: number;
   recordTimestamp: string;
   executionTimestamp: string;
-  period: string;
+  startTimestamp: string;
+  endTimestamp: string;
+  fixingTimestamp: string;
 }
 
 export const ProgramCoupon = () => {
@@ -249,6 +247,8 @@ export const ProgramCoupon = () => {
   const { t: tGlobal } = useTranslation('globals');
   const { id = '' } = useParams();
   const recordTimestamp = watch('recordTimestamp');
+  const startTimestamp = watch('startTimestamp');
+  const fixingTimestamp = watch('fixingTimestamp');
 
   const { data: bondDetails } = useGetBondDetails(
     new GetBondDetailsRequest({
@@ -262,7 +262,10 @@ export const ProgramCoupon = () => {
       rate: params.rate.toString(),
       recordTimestamp: dateToUnixTimestamp(params.recordTimestamp),
       executionTimestamp: dateToUnixTimestamp(params.executionTimestamp),
-      period: params.period,
+      startTimestamp: dateToUnixTimestamp(params.startTimestamp),
+      endTimestamp: dateToUnixTimestamp(params.endTimestamp),
+      fixingTimestamp: dateToUnixTimestamp(params.fixingTimestamp),
+      rateStatus: 1
     });
 
     createCoupon(request, {
@@ -321,7 +324,9 @@ export const ProgramCoupon = () => {
                 id="executionTimestamp"
                 rules={{
                   required,
-                  validate: isAfterDate(new Date(recordTimestamp)),
+                  validate:
+                    isAfterDate(new Date(recordTimestamp)) &&
+                    isAfterDate(new Date(fixingTimestamp)),
                 }}
                 fromDate={new Date()}
                 toDate={new Date(bondDetails.maturityDate)}
@@ -331,6 +336,77 @@ export const ProgramCoupon = () => {
               />
             )}
           </Stack>
+          <Stack w="full">
+            <HStack justifySelf="flex-start">
+              <Text textStyle="BodyTextRegularSM">
+                {tForm('startDate.label')}*
+              </Text>
+              <Tooltip label={tForm('startDate.tooltip')} placement="right">
+                <PhosphorIcon as={Info} />
+              </Tooltip>
+            </HStack>
+            {bondDetails && (
+              <CalendarInputController
+                control={control}
+                id="startTimestamp"
+                rules={{ required }}
+                fromDate={new Date()}
+                toDate={new Date(bondDetails.maturityDate)}
+                placeholder={tForm('startDate.placeholder')}
+                withTimeInput
+                format={DATE_TIME_FORMAT}
+              />
+            )}
+          </Stack>
+          <Stack w="full">
+            <HStack justifySelf="flex-start">
+              <Text textStyle="BodyTextRegularSM">
+                {tForm('endDate.label')}*
+              </Text>
+              <Tooltip label={tForm('endDate.tooltip')} placement="right">
+                <PhosphorIcon as={Info} />
+              </Tooltip>
+            </HStack>
+            {bondDetails && (
+              <CalendarInputController
+                control={control}
+                id="endTimestamp"
+                rules={{
+                  required,
+                  validate: isAfterDate(new Date(startTimestamp)),
+                }}
+                fromDate={new Date()}
+                toDate={new Date(bondDetails.maturityDate)}
+                placeholder={tForm('endDate.placeholder')}
+                withTimeInput
+                format={DATE_TIME_FORMAT}
+              />
+            )}
+          </Stack>
+          <Stack w="full">
+            <HStack justifySelf="flex-start">
+              <Text textStyle="BodyTextRegularSM">
+                {tForm('fixingDate.label')}*
+              </Text>
+              <Tooltip label={tForm('fixingDate.tooltip')} placement="right">
+                <PhosphorIcon as={Info} />
+              </Tooltip>
+            </HStack>
+            {bondDetails && (
+              <CalendarInputController
+                control={control}
+                id="fixingTimestamp"
+                rules={{
+                  required,
+                }}
+                fromDate={new Date()}
+                toDate={new Date(bondDetails.maturityDate)}
+                placeholder={tForm('fixingDate.placeholder')}
+                withTimeInput
+                format={DATE_TIME_FORMAT}
+              />
+            )}
+          </Stack>
           <Stack w="full">
             <HStack justifySelf="flex-start">
               <Text textStyle="BodyTextRegularSM">{tForm('rate.label')}*</Text>
@@ -351,50 +427,6 @@ export const ProgramCoupon = () => {
               decimalSeparator="."
             />
           </Stack>
-          <Stack w="full">
-            <HStack justifySelf="flex-start">
-              <Text textStyle="BodyTextRegularSM">
-                {tForm('period.label')}*
-              </Text>
-              <Tooltip label={tForm('period.tooltip')} placement="right">
-                <PhosphorIcon as={Info} />
-              </Tooltip>
-            </HStack>
-            <SelectController
-              control={control}
-              id="period"
-              rules={{
-                required,
-                validate: (value: string) => {
-                  const validation = validateCouponPeriod(parseInt(value));
-                  return validation === true || validation;
-                },
-              }}
-              placeholder={tForm('period.placeholder')}
-              options={[
-                {
-                  label: tForm('period.options.day'),
-                  value: TIME_PERIODS_S.DAY.toString(),
-                },
-                {
-                  label: tForm('period.options.week'),
-                  value: TIME_PERIODS_S.WEEK.toString(),
-                },
-                {
-                  label: tForm('period.options.month'),
-                  value: TIME_PERIODS_S.MONTH.toString(),
-                },
-                {
-                  label: tForm('period.options.quarter'),
-                  value: TIME_PERIODS_S.QUARTER.toString(),
-                },
-                {
-                  label: tForm('period.options.year'),
-                  value: TIME_PERIODS_S.YEAR.toString(),
-                },
-              ]}
-            />
-          </Stack>
           <Button
             data-testid="create-coupon-button"
             alignSelf="flex-end"

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

@@ -226,6 +226,24 @@ export const SeeCoupon = () => {
                 canCopy: true,
                 valueToCopy: coupons.executionDate.toDateString(),
               },
+              {
+                title: tDetail("startDay"),
+                description: formatDate(coupons.startDate, DATE_TIME_FORMAT),
+                canCopy: true,
+                valueToCopy: coupons.startDate.toDateString(),
+              },
+              {
+                title: tDetail("endDay"),
+                description: formatDate(coupons.endDate, DATE_TIME_FORMAT),
+                canCopy: true,
+                valueToCopy: coupons.endDate.toDateString(),
+              },
+              {
+                title: tDetail("fixingDay"),
+                description: formatDate(coupons.fixingDate, DATE_TIME_FORMAT),
+                canCopy: true,
+                valueToCopy: coupons.fixingDate.toDateString(),
+              },
               {
                 title: tDetail("balance"),
                 description: formatNumberLocale(couponsFor.tokenBalance, parseFloat(couponsFor.decimals)),

packages/ats/contracts/Configuration.ts

@@ -297,7 +297,8 @@ export const CONTRACT_NAMES = [
   "BondUSARead", //TODO
   "ScheduledSnapshotsFacet",
   "ScheduledBalanceAdjustmentsFacet",
-  "scheduledCrossOrderedTasksFacet",
+  "ScheduledCrossOrderedTasksFacet",
+  "ScheduledCouponListingFacet",
   "SnapshotsFacet",
   "CorporateActionsFacet",
   "TransferAndLockFacet",

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

@@ -2,6 +2,11 @@
 pragma solidity ^0.8.17;
 
 interface TRexIBondRead {
+    enum RateCalculationStatus {
+        PENDING,
+        SET
+    }
+
     struct BondDetailsData {
         bytes3 currency;
         uint256 nominalValue;
@@ -13,9 +18,12 @@ interface TRexIBondRead {
     struct Coupon {
         uint256 recordDate;
         uint256 executionDate;
+        uint256 startDate;
+        uint256 endDate;
+        uint256 fixingDate;
         uint256 rate;
         uint8 rateDecimals;
-        uint256 period;
+        RateCalculationStatus rateStatus;
     }
 
     struct RegisteredCoupon {
@@ -25,13 +33,9 @@ interface TRexIBondRead {
 
     struct CouponFor {
         uint256 tokenBalance;
-        uint256 rate;
-        uint8 rateDecimals;
-        uint256 recordDate;
-        uint256 executionDate;
-        uint256 period;
         uint8 decimals;
         bool recordDateReached;
+        Coupon coupon;
     }
 
     struct CouponAmountFor {
@@ -93,4 +97,13 @@ interface TRexIBondRead {
      * @dev It is the list of token holders at the snapshot taken at the record date
      */
     function getTotalCouponHolders(uint256 _couponID) external view returns (uint256);
+
+    function getCouponFromOrderedListAt(uint256 _pos) external view returns (uint256 couponID_);
+
+    function getCouponsOrderedList(
+        uint256 _pageIndex,
+        uint256 _pageLength
+    ) external view returns (uint256[] memory couponIDs_);
+
+    function getCouponsOrderedListTotal() external view returns (uint256 total_);
 }

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

@@ -78,21 +78,21 @@ interface TRexIEquity {
      * @notice Sets a new dividend
      * @dev Can only be called by an account with the corporate actions role
      */
-    function setDividends(Dividend calldata _newDividend) external returns (bool success_, uint256 dividendID_);
+    function setDividends(Dividend calldata _newDividend) external returns (uint256 dividendID_);
 
     /**
      * @notice Sets a new voting
      * @dev Can only be called by an account with the corporate actions role
      */
-    function setVoting(Voting calldata _newVoting) external returns (bool success_, uint256 voteID_);
+    function setVoting(Voting calldata _newVoting) external returns (uint256 voteID_);
 
     /**
      * @notice Sets a new scheduled balance adjustment
      * @dev The task is added to the queue and executed when the execution date is reached
      */
     function setScheduledBalanceAdjustment(
         ScheduledBalanceAdjustment calldata _newBalanceAdjustment
-    ) external returns (bool success_, uint256 balanceAdjustmentID_);
+    ) external returns (uint256 balanceAdjustmentID_);
 
     function getEquityDetails() external view returns (EquityDetailsData memory equityDetailsData_);