feat: add protocolFee to getJoinSpacePriceDetails response (#4269)

### Description

Added protocol fee to the `getJoinSpacePriceDetails` method to properly
account for the total cost when joining a space.

### Changes

- Added `protocolFee` property to the return type of
`getJoinSpacePriceDetails`
- Updated the method to fetch protocol fee data via multicall
- Modified the method to decode and return the protocol fee value
- Updated tests to verify that the price includes the protocol fee

### Checklist

- [x] Tests added where required
- [x] Documentation updated where applicable
- [x] Changes adhere to the repository's contribution guidelines

Author: giuseppecrj

packages/sdk/src/tests/multi/spaceWithVariousPriceConfigurations.test.ts

@@ -155,9 +155,12 @@ describe('spaceWithVariousPriceConfigurations', () => {
             membershipRequirements,
         )
 
-        const { price: joinPrice } = await bobSpaceDapp.getJoinSpacePriceDetails(spaceId)
+        const { price: joinPrice, protocolFee } =
+            await bobSpaceDapp.getJoinSpacePriceDetails(spaceId)
 
-        expect(joinPrice.toBigInt()).toBe(ethers.utils.parseEther('1').toBigInt())
+        expect(joinPrice.toBigInt()).toBe(
+            ethers.utils.parseEther('1').toBigInt() + protocolFee.toBigInt(),
+        )
 
         log('Alice should be able to join space')
 

packages/web3/src/space-dapp/SpaceDapp.ts

@@ -1525,6 +1525,7 @@ export class SpaceDapp<TProvider extends ethers.providers.Provider = ethers.prov
         price: ethers.BigNumber
         prepaidSupply: ethers.BigNumber
         remainingFreeSupply: ethers.BigNumber
+        protocolFee: ethers.BigNumber
     }> {
         const space = this.getSpace(spaceId)
         if (!space) {
@@ -1548,16 +1549,20 @@ export class SpaceDapp<TProvider extends ethers.providers.Provider = ethers.prov
         const prepaidSupplyEncoded =
             space.Prepay.interface.encodeFunctionData('prepaidMembershipSupply')
 
+        const protocolFeeEncoded = space.Membership.interface.encodeFunctionData('getProtocolFee')
+
         const [
             membershipPriceResult,
             totalSupplyResult,
             freeAllocationResult,
             prepaidSupplyResult,
+            protocolFeeResult,
         ] = await space.Multicall.read.callStatic.multicall([
             membershipPriceEncoded,
             totalSupplyEncoded,
             freeAllocationEncoded,
             prepaidSupplyEncoded,
+            protocolFeeEncoded,
         ])
 
         try {
@@ -1577,7 +1582,10 @@ export class SpaceDapp<TProvider extends ethers.providers.Provider = ethers.prov
                 'prepaidMembershipSupply',
                 prepaidSupplyResult,
             )[0] as BigNumber
-
+            const protocolFee = space.Membership.interface.decodeFunctionResult(
+                'getProtocolFee',
+                protocolFeeResult,
+            )[0] as BigNumber
             // remainingFreeSupply
             // if totalSupply < freeAllocation, freeAllocation + prepaid - minted memberships
             // else the remaining prepaidSupply if any
@@ -1589,6 +1597,7 @@ export class SpaceDapp<TProvider extends ethers.providers.Provider = ethers.prov
                 price: remainingFreeSupply.gt(0) ? ethers.BigNumber.from(0) : membershipPrice,
                 prepaidSupply,
                 remainingFreeSupply,
+                protocolFee,
             }
         } catch (error) {
             logger.error('getJoinSpacePriceDetails: Error decoding membership price', error)

packages/web3/tests/getJoinSpacePriceDetails.test.ts

@@ -70,8 +70,10 @@ describe('getJoinSpacePriceDetails', () => {
         const spaceId = SpaceIdFromSpaceAddress(spaceAddress)
 
         const priceDetails = await spaceDapp.getJoinSpacePriceDetails(spaceAddress)
+        const protocolFee = priceDetails.protocolFee
+        const totalPrice = price.add(protocolFee)
 
-        expect(priceDetails.price.toBigInt()).toBe(price.toBigInt())
+        expect(priceDetails.price.toBigInt()).toBe(totalPrice.toBigInt())
         expect(priceDetails.prepaidSupply.toBigInt()).toBe(0n)
         expect(priceDetails.remainingFreeSupply.toBigInt()).toBe(0n)