feat: add NIM - CRC swap

nimiq · Jun 19, 2024 · f483994 · f483994
1 parent 060e94a
commit f483994
Show file tree

Hide file tree

Showing 14 changed files with 245 additions and 34 deletions.
diff --git a/client/src/PublicRequest.ts b/client/src/PublicRequest.ts
@@ -257,7 +257,13 @@ export type SepaSettlementInstruction = {
     },
 };
 
-export type SettlementInstruction = MockSettlementInstruction | SepaSettlementInstruction;
+export type SinpeMovilSettlementInstruction = {
+    type: 'sinpemovil',
+    contractId: string,
+    phoneNumber: string,
+}
+
+export type SettlementInstruction = MockSettlementInstruction | SepaSettlementInstruction | SinpeMovilSettlementInstruction;
 
 export type SignSwapRequestLayout = 'standard' | 'slider';
 
@@ -299,6 +305,13 @@ export type SignSwapRequestCommon = SimpleRequest & {
             // bankLogoUrl?: string,
             // bankColor?: string,
         }
+    ) | (
+        {type: 'CRC'}
+        & {
+            amount: number,
+            fee: number,
+            recipientLabel?: string,
+        }
     ),
     redeem: (
         {type: 'NIM'}
@@ -345,6 +358,17 @@ export type SignSwapRequestCommon = SimpleRequest & {
             // bankLogoUrl?: string,
             // bankColor?: string,
         }
+    ) | (
+        { type: 'CRC' }
+        & {
+            keyPath: string,
+            // A SettlementInstruction contains a `type`, so cannot be in the
+            // root of the object (it conflicts with the 'CRC' type).
+            settlement: Omit<SettlementInstruction, 'contractId'>,
+            amount: number,
+            fee: number,
+            recipientLabel?: string,
+        }
     ),
 
     // Data needed for display
@@ -394,7 +418,7 @@ export type SignSwapRequestSlider = SignSwapRequestCommon & {
 export type SignSwapRequest = SignSwapRequestStandard | SignSwapRequestSlider;
 
 export type SignSwapResult = SimpleResult & {
-    eurPubKey?: string,
+    fiatPubKey?: string,
     tmpCookieEncryptionKey?: Uint8Array;
 };
 
@@ -411,7 +435,7 @@ export type SignSwapTransactionsRequest = {
         type: 'USDC_MATIC',
         htlcData: string,
     } | {
-        type: 'EUR',
+        type: 'EUR' | 'CRC',
         hash: string,
         timeout: number,
         htlcId: string,
@@ -431,7 +455,7 @@ export type SignSwapTransactionsRequest = {
         timeout: number,
         htlcId: string,
     } | {
-        type: 'EUR',
+        type: 'EUR' | 'CRC',
         hash: string,
         timeout: number,
         htlcId: string,
@@ -531,6 +555,7 @@ export type SignSwapTransactionsResult = {
     btc?: SignedBitcoinTransaction,
     usdc?: SignedPolygonTransaction,
     eur?: string, // When funding EUR: empty string, when redeeming EUR: JWS of the settlement instructions
+    crc?: string, // When funding CRC: empty string, when redeeming CRC: JWS of the settlement instructions
     refundTx?: string,
 };
 

diff --git a/src/common.css b/src/common.css
@@ -349,6 +349,10 @@ body.loading .page:target .page-footer > .loading-spinner {
     content: "EUR";
 }
 
+.crc-symbol::before {
+    content: "CRC";
+}
+
 .address {
     font-family: "Fira Mono", "Andale Mono", monospace;
     font-size: 1.625rem;

diff --git a/src/components/BalanceDistributionBar.js b/src/components/BalanceDistributionBar.js
@@ -3,7 +3,7 @@
 /* global CryptoUtils */
 
 /** @typedef {{address: string, balance: number, active: boolean, newBalance: number}} Segment */
-/** @typedef {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR'} Asset */
+/** @typedef {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR' | 'CRC'} Asset */
 
 class BalanceDistributionBar { // eslint-disable-line no-unused-vars
     /**

diff --git a/src/components/SwapFeesTooltip.js b/src/components/SwapFeesTooltip.js
@@ -75,22 +75,25 @@ class SwapFeesTooltip { // eslint-disable-line no-unused-vars
         }
 
         // Show OASIS fees next
-        if (fundTx.type === 'EUR' || redeemTx.type === 'EUR') {
-            const myFee = fundTx.type === 'EUR'
+        if (fundTx.type === 'EUR' || fundTx.type === 'CRC' || redeemTx.type === 'EUR' || redeemTx.type === 'CRC') {
+            const myFee = fundTx.type === 'EUR' || fundTx.type === 'CRC'
                 ? fundTx.fee
-                : redeemTx.type === 'EUR'
+                : redeemTx.type === 'EUR' || redeemTx.type === 'CRC'
                     ? redeemTx.fee
                     : 0;
 
-            const theirFee = fundTx.type === 'EUR' ? fundFees.processing : redeemFees.processing;
+            const theirFee = fundTx.type === 'EUR' || fundTx.type === 'CRC'
+                ? fundFees.processing : redeemFees.processing;
 
-            const fiatRate = fundTx.type === 'EUR' ? fundingFiatRate : redeemingFiatRate;
-            const fiatFee = CryptoUtils.unitsToCoins('EUR', myFee + theirFee) * fiatRate;
+            const fiatRate = fundTx.type === 'EUR' || fundTx.type === 'CRC' ? fundingFiatRate : redeemingFiatRate;
+            const fiatSwapAsset = (fundTx.type === 'EUR' || fundTx.type === 'CRC' ? fundTx.type : redeemTx.type);
+            const fiatFee = CryptoUtils.unitsToCoins(fiatSwapAsset, myFee + theirFee) * fiatRate;
 
             const rows = this._createOasisLine(
                 fiatFee,
                 fiatCurrency,
-                (myFee + theirFee) / (fundTx.type === 'EUR' ? exchangeFromAmount : exchangeToAmount),
+                (myFee + theirFee) / (fundTx.type === 'EUR' || fundTx.type === 'CRC'
+                    ? exchangeFromAmount : exchangeToAmount),
             );
             this.$tooltip.appendChild(rows[0]);
             this.$tooltip.appendChild(rows[1]);

diff --git a/src/lib/NumberFormatting.js b/src/lib/NumberFormatting.js
@@ -105,6 +105,7 @@ class NumberFormatting { // eslint-disable-line no-unused-vars
             case 'eur':
             case 'chf':
                 return 'de';
+            case 'crc':
             case 'gbp':
             case 'usd':
                 return 'en';

diff --git a/src/lib/crc/CrcConstants.js b/src/lib/crc/CrcConstants.js
@@ -0,0 +1,3 @@
+const CrcConstants = { // eslint-disable-line no-unused-vars
+    CENTS_PER_COIN: 100,
+};
diff --git a/src/lib/crc/CrcUtils.js b/src/lib/crc/CrcUtils.js
@@ -0,0 +1,19 @@
+/* global CrcConstants */
+
+class CrcUtils { // eslint-disable-line no-unused-vars
+    /**
+     * @param {number} coins CRC amount in decimal
+     * @returns {number} Number of CRC cents
+     */
+    static coinsToCents(coins) {
+        return Math.round(coins * CrcConstants.CENTS_PER_COIN);
+    }
+
+    /**
+     * @param {number} cents Number of CRC cents
+     * @returns {number} CRC count in decimal
+     */
+    static centsToCoins(cents) {
+        return cents / CrcConstants.CENTS_PER_COIN;
+    }
+}
diff --git a/src/lib/swap/CryptoUtils.js b/src/lib/swap/CryptoUtils.js
@@ -5,10 +5,12 @@
 /* global PolygonUtils */
 /* global EuroConstants */
 /* global EuroUtils */
+/* global CrcConstants */
+/* global CrcUtils */
 
 class CryptoUtils { // eslint-disable-line no-unused-vars
     /**
-     * @param {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR'} asset
+     * @param {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR' | 'CRC'} asset
      * @param {number} units
      * @returns {number}
      */
@@ -18,12 +20,13 @@ class CryptoUtils { // eslint-disable-line no-unused-vars
             case 'BTC': return BitcoinUtils.satoshisToCoins(units);
             case 'USDC_MATIC': return PolygonUtils.unitsToCoins(units);
             case 'EUR': return EuroUtils.centsToCoins(units);
+            case 'CRC': return CrcUtils.centsToCoins(units);
             default: throw new Error(`Invalid asset ${asset}`);
         }
     }
 
     /**
-     * @param {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR'} asset
+     * @param {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR' | 'CRC'} asset
      * @returns {number}
      */
     static assetDecimals(asset) {
@@ -32,20 +35,22 @@ class CryptoUtils { // eslint-disable-line no-unused-vars
             case 'BTC': return Math.log10(BitcoinConstants.SATOSHIS_PER_COIN);
             case 'USDC_MATIC': return Math.log10(PolygonConstants.UNITS_PER_COIN);
             case 'EUR': return Math.log10(EuroConstants.CENTS_PER_COIN);
+            case 'CRC': return Math.log10(CrcConstants.CENTS_PER_COIN);
             default: throw new Error(`Invalid asset ${asset}`);
         }
     }
 
     /**
-     * @param {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR'} asset
-     * @returns {'nim' | 'btc' | 'usdc' | 'eur'}
+     * @param {'NIM' | 'BTC' | 'USDC_MATIC' | 'EUR' | 'CRC'} asset
+     * @returns {'nim' | 'btc' | 'usdc' | 'eur' | 'crc'}
      */
     static assetToCurrency(asset) {
         switch (asset) {
             case 'NIM': return 'nim';
             case 'BTC': return 'btc';
             case 'USDC_MATIC': return 'usdc';
             case 'EUR': return 'eur';
+            case 'CRC': return 'crc';
             default: throw new Error(`Invalid asset ${asset}`);
         }
     }

diff --git a/src/request/sign-swap/SignSwap.css b/src/request/sign-swap/SignSwap.css
@@ -5,7 +5,8 @@
 .nim-symbol,
 .btc-symbol,
 .usdc-symbol,
-.eur-symbol {
+.eur-symbol,
+.crc-symbol {
     margin-left: 0.25em;
 }
 
@@ -101,6 +102,7 @@
 }
 
 .layout-standard .account.eur .identicon,
+.layout-standard .account.crc .identicon,
 .layout-standard .account.btc .identicon {
     padding: .25rem;
 }