fix: whitelist for get[Taking/Making]Amount (#126)

Co-authored-by: CI/CD Bot <[email protected]>

Author: vbrvk

contracts/lib/limit-order-protocol

@@ -1,6 +1,6 @@
 {
     "name": "@1inch/fusion-sdk",
-    "version": "2.1.10",
+    "version": "2.1.11-rc.1",
     "description": "1inch Fusion SDK",
     "author": "@1inch",
     "private": false,

contracts/lib/limit-order-settlement

@@ -0,0 +1,63 @@
+import {
+    FeeCalculator,
+    Fees,
+    IntegratorFee
+} from '@1inch/limit-order-sdk/extensions/fee-taker'
+import {Address, Bps} from '@1inch/limit-order-sdk'
+import {AmountCalculator} from './amount-calculator'
+import {AuctionCalculator} from './auction-calculator'
+import {Whitelist} from '../fusion-order'
+import {now} from '../utils/time'
+
+describe('AmountCalculator', () => {
+    it('should correct extract fee', () => {
+        const integratorFeeBps = new Bps(6n) // 60% from 10bps
+        const calculator = new AmountCalculator(
+            new AuctionCalculator(
+                1738650250n,
+                180n,
+                1218519n,
+                [{coefficient: 609353, delay: 180}],
+                {gasBumpEstimate: 609353n, gasPriceEstimate: 1526n}
+            ),
+            new FeeCalculator(
+                Fees.integratorFee(
+                    new IntegratorFee(
+                        new Address(
+                            '0x8e097e5e0493de033270a01b324caf31f464dc67'
+                        ),
+                        new Address(
+                            '0x90cbe4bdd538d6e9b379bff5fe72c3d67a521de5'
+                        ),
+                        new Bps(10n),
+                        new Bps(6000n)
+                    )
+                ),
+                Whitelist.new(1738650226n, [
+                    {address: Address.fromBigInt(1n), allowFrom: 0n}
+                ])
+            )
+        )
+        const takingAmount = 100000n
+        const requiredTakingAmount = calculator.getRequiredTakingAmount(
+            Address.ZERO_ADDRESS,
+            takingAmount,
+            now(),
+            10n
+        )
+
+        const integratorFee = calculator.getIntegratorFee(
+            Address.ZERO_ADDRESS,
+            takingAmount,
+            now(),
+            10n
+        )
+
+        expect(
+            AmountCalculator.extractFeeAmount(
+                requiredTakingAmount,
+                integratorFeeBps
+            )
+        ).toEqual(integratorFee)
+    })
+})

package.json

@@ -1,4 +1,10 @@
-import {Address, Bps, FeeTakerExt} from '@1inch/limit-order-sdk'
+import {
+    Address,
+    Bps,
+    FeeTakerExt,
+    mulDiv,
+    Rounding
+} from '@1inch/limit-order-sdk'
 import {FeeCalculator, Fees} from '@1inch/limit-order-sdk/extensions/fee-taker'
 import {AuctionCalculator} from './auction-calculator'
 import {FusionExtension} from '../fusion-order'
@@ -51,6 +57,27 @@ export class AmountCalculator {
         return (withoutFee * numerator) / Fees.BASE_1E5
     }
 
+    /**
+     * Return fee amount in taker asset which is included in `requiredTakingAmount`
+     *
+     * @param requiredTakingAmount must already contain fee
+     * @param fee to extract
+     */
+    public static extractFeeAmount(
+        requiredTakingAmount: bigint,
+        fee: Bps
+    ): bigint {
+        return (
+            requiredTakingAmount -
+            mulDiv(
+                requiredTakingAmount,
+                Fees.BASE_1E5,
+                Fees.BASE_1E5 + BigInt(fee.toFraction(Fees.BASE_1E5)),
+                Rounding.Ceil
+            )
+        )
+    }
+
     /**
      * Returns adjusted taking amount with included fees and auction bump
      *

src/amount-calculator/amount-calculator.spec.ts

@@ -13,6 +13,7 @@ import {BN, BytesBuilder, BytesIter} from '@1inch/byte-utils'
 import assert from 'assert'
 import {AuctionDetails} from './auction-details'
 import {Whitelist} from './whitelist/whitelist'
+import {add0x} from '../utils'
 
 export class FusionExtension {
     /**
@@ -82,6 +83,8 @@ export class FusionExtension {
             : undefined
 
         const interactionData = parseAmountData(interactionBytes)
+        const whitelist = Whitelist.decodeFrom(interactionBytes)
+
         //endregion Parse postInteraction data
 
         //region Parse amount data
@@ -90,6 +93,20 @@ export class FusionExtension {
 
         const auctionDetails = AuctionDetails.decodeFrom(amountBytes)
         const amountData = parseAmountData(amountBytes)
+        const whitelistAddressLength = Number(amountBytes.nextUint8())
+
+        assert(
+            whitelist.length === whitelistAddressLength,
+            'whitelist addresses must be same in interaction data and in amount data'
+        )
+
+        const whitelistAddressesFromAmount: string[] = []
+
+        for (let i = 0; i < whitelistAddressLength; i++) {
+            whitelistAddressesFromAmount.push(
+                BigInt(amountBytes.nextBytes(10)).toString(16).padStart(20, '0')
+            )
+        }
 
         //endregion Parse amount data
 
@@ -122,8 +139,11 @@ export class FusionExtension {
         )
 
         assert(
-            interactionData.whitelist.equal(amountData.whitelist),
-            'whitelist must be same in interaction data and in amount data'
+            whitelist.whitelist.every(
+                ({addressHalf}, i) =>
+                    whitelistAddressesFromAmount[i] === addressHalf
+            ),
+            'whitelist addresses must be same in interaction data and in amount data'
         )
 
         const hasFees =
@@ -133,10 +153,11 @@ export class FusionExtension {
             return new FusionExtension(
                 settlementContract,
                 auctionDetails,
-                interactionData.whitelist,
+                whitelist,
                 {
                     makerPermit,
-                    customReceiver
+                    customReceiver,
+                    fees: undefined
                 }
             )
         }
@@ -162,7 +183,7 @@ export class FusionExtension {
         return new FusionExtension(
             settlementContract,
             auctionDetails,
-            interactionData.whitelist,
+            whitelist,
             {
                 makerPermit,
                 fees,
@@ -244,10 +265,10 @@ export class FusionExtension {
      *
      * @see https://github.com/1inch/limit-order-settlement/blob/82f0a25c969170f710825ce6aa6920062adbde88/contracts/SimpleSettlement.sol#L34
      */
-    private buildAmountGetterData(withAuction: boolean): string {
+    private buildAmountGetterData(forAmountGetters: boolean): string {
         const builder = new BytesBuilder()
 
-        if (withAuction) {
+        if (forAmountGetters) {
             // auction data required only for `getMakingAmount/getTakingAmount` and not for `postInteraction`
             this.auctionDetails.encodeInto(builder)
         }
@@ -282,7 +303,15 @@ export class FusionExtension {
                 )
             )
 
-        this.whitelist.encodeInto(builder)
+        if (forAmountGetters) {
+            // amount getters need only addresses, without delays
+            builder.addUint8(BigInt(this.whitelist.whitelist.length))
+            this.whitelist.whitelist.forEach((i) => {
+                builder.addBytes(add0x(i.addressHalf))
+            })
+        } else {
+            this.whitelist.encodeInto(builder)
+        }
 
         return builder.asHex()
     }
@@ -348,7 +377,6 @@ function parseAmountData(iter: BytesIter<string>): {
         resolverFee: Bps
         whitelistDiscount: Bps
     }
-    whitelist: Whitelist
 } {
     const fees = {
         integratorFee: Bps.fromFraction(
@@ -369,10 +397,7 @@ function parseAmountData(iter: BytesIter<string>): {
         )
     }
 
-    const whitelist = Whitelist.decodeFrom(iter)
-
     return {
-        fees,
-        whitelist
+        fees
     }
 }

src/amount-calculator/amount-calculator.ts

@@ -1,4 +1,10 @@
-import {Address, Bps, MakerTraits, FeeTakerExt} from '@1inch/limit-order-sdk'
+import {
+    Address,
+    Bps,
+    MakerTraits,
+    FeeTakerExt,
+    Extension
+} from '@1inch/limit-order-sdk'
 import {parseUnits} from 'ethers'
 import {FusionOrder} from './fusion-order'
 import {AuctionDetails} from './auction-details'
@@ -59,7 +65,7 @@ describe('Fusion Order', () => {
             takingAmount: '1420000000',
             makerTraits:
                 '33471150795161712739625987854073848363835856965607525350783622537007396290560',
-            salt: '15150891855335877009553113668813008135841821470374'
+            salt: '15154917212229274031775300768002549554250257257796'
         })
 
         const makerTraits = new MakerTraits(BigInt(builtOrder.makerTraits))
@@ -131,7 +137,7 @@ describe('Fusion Order', () => {
             takingAmount: '1420000000',
             makerTraits:
                 '33471150795161712739625987854073848363835856965607525350783622537007396290560',
-            salt: '15927625895819333064650069072431807310373701948678'
+            salt: '14784889872407883648102551457165962490230021209460'
         })
 
         const makerTraits = new MakerTraits(BigInt(builtOrder.makerTraits))
@@ -286,4 +292,50 @@ describe('Fusion Order', () => {
             2n * order.takingAmount // because init rate bump is 100%
         )
     })
+
+    it.skip('Should calculate total fee', () => {
+        // https://etherscan.io/tx/0x8f95dc0e6e836ca0abdad88e20cf61b0caf7c5463d67b577740f3084d428e56e
+        const data = [
+            {
+                order: '{"salt": "88244613754032523633323406132962387804442696513566413874801304436628426636029", "maker": "0x6edc317f3208b10c46f4ff97faa04dd632487408", "receiver": "0xabd4e5fb590aa132749bbf2a04ea57efbaac399e", "makerAsset": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2", "takerAsset": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48", "makerTraits": "62419173104490761595518734106935910747442209877250655105498008304728645042176", "makingAmount": "7340000000000000", "takingAmount": "17733698"}',
+                extension:
+                    '0x000000ec0000008c0000008c0000008c0000008c000000460000000000000000abd4e5fb590aa132749bbf2a04ea57efbaac399e094c49000005f667a1b28a0000b41297d701094c4900b400643c00006402d1a23c3abeed63c51b86b5636af8f99b8e85dc9fabd4e5fb590aa132749bbf2a04ea57efbaac399e094c49000005f667a1b28a0000b41297d701094c4900b400643c00006402d1a23c3abeed63c51b86b5636af8f99b8e85dc9fabd4e5fb590aa132749bbf2a04ea57efbaac399e008e097e5e0493de033270a01b324caf31f464dc6790cbe4bdd538d6e9b379bff5fe72c3d67a521de500643c00006467a1b27202d1a23c3abeed63c51b860000b5636af8f99b8e85dc9f0000'
+            }
+        ]
+
+        const order = FusionOrder.fromDataAndExtension(
+            JSON.parse(data[0].order),
+            Extension.decode(data[0].extension)
+        )
+
+        const userAmount = order
+            .getAmountCalculator()
+            .getUserTakingAmountAmount(
+                Address.ZERO_ADDRESS,
+                order.takingAmount,
+                1738650311n,
+                1533984564n
+            )
+
+        const integratorFee = order
+            .getAmountCalculator()
+            .getIntegratorFee(
+                Address.ZERO_ADDRESS,
+                order.takingAmount,
+                1738650311n,
+                1533984564n
+            )
+        const protocolFee = order
+            .getAmountCalculator()
+            .getProtocolFee(
+                Address.ZERO_ADDRESS,
+                order.takingAmount,
+                1738650311n,
+                1533984564n
+            )
+
+        expect(userAmount).toEqual(18442228n)
+        expect(integratorFee).toEqual(11065n)
+        expect(protocolFee).toEqual(7377n)
+    })
 })

src/fusion-order/fusion-extension.ts

@@ -19,6 +19,10 @@ export class Whitelist {
         })
     }
 
+    public get length(): number {
+        return this.whitelist.length
+    }
+
     /**
      * Construct `Whitelist` from BytesIter
      *