refactor: remove ApprovalReceivedAndMatched event and related references

gfournierPro · gfournierPro · commit be654350beac · 2025-11-06T17:08:21.000+01:00
diff --git a/abis/contracts/IexecInterfaceToken.json b/abis/contracts/IexecInterfaceToken.json
@@ -54,31 +54,6 @@
     "name": "Approval",
     "type": "event"
   },
-  {
-    "anonymous": false,
-    "inputs": [
-      {
-        "indexed": true,
-        "internalType": "address",
-        "name": "sender",
-        "type": "address"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount",
-        "type": "uint256"
-      },
-      {
-        "indexed": true,
-        "internalType": "bytes32",
-        "name": "dealId",
-        "type": "bytes32"
-      }
-    ],
-    "name": "ApprovalReceivedAndMatched",
-    "type": "event"
-  },
   {
     "anonymous": false,
     "inputs": [
diff --git a/abis/contracts/facets/IexecEscrowTokenFacet.json b/abis/contracts/facets/IexecEscrowTokenFacet.json
@@ -24,31 +24,6 @@
     "name": "Approval",
     "type": "event"
   },
-  {
-    "anonymous": false,
-    "inputs": [
-      {
-        "indexed": true,
-        "internalType": "address",
-        "name": "sender",
-        "type": "address"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount",
-        "type": "uint256"
-      },
-      {
-        "indexed": true,
-        "internalType": "bytes32",
-        "name": "dealId",
-        "type": "bytes32"
-      }
-    ],
-    "name": "ApprovalReceivedAndMatched",
-    "type": "event"
-  },
   {
     "anonymous": false,
     "inputs": [
diff --git a/abis/contracts/interfaces/IexecEscrowToken.json b/abis/contracts/interfaces/IexecEscrowToken.json
@@ -1,29 +1,4 @@
 [
-  {
-    "anonymous": false,
-    "inputs": [
-      {
-        "indexed": true,
-        "internalType": "address",
-        "name": "sender",
-        "type": "address"
-      },
-      {
-        "indexed": false,
-        "internalType": "uint256",
-        "name": "amount",
-        "type": "uint256"
-      },
-      {
-        "indexed": true,
-        "internalType": "bytes32",
-        "name": "dealId",
-        "type": "bytes32"
-      }
-    ],
-    "name": "ApprovalReceivedAndMatched",
-    "type": "event"
-  },
   {
     "stateMutability": "payable",
     "type": "fallback"
diff --git a/abis/human-readable-abis/contracts/IexecInterfaceToken.sol/IexecInterfaceToken.json b/abis/human-readable-abis/contracts/IexecInterfaceToken.sol/IexecInterfaceToken.json
@@ -2,7 +2,6 @@
   "error IncompatibleDatasetOrder(string)",
   "event AccurateContribution(address indexed,bytes32 indexed)",
   "event Approval(address indexed,address indexed,uint256)",
-  "event ApprovalReceivedAndMatched(address indexed,uint256,bytes32 indexed)",
   "event BroadcastAppOrder(tuple(address,uint256,uint256,bytes32,address,address,address,bytes32,bytes))",
   "event BroadcastDatasetOrder(tuple(address,uint256,uint256,bytes32,address,address,address,bytes32,bytes))",
   "event BroadcastRequestOrder(tuple(address,uint256,address,uint256,address,uint256,address,uint256,bytes32,uint256,uint256,address,address,string,bytes32,bytes))",
diff --git a/abis/human-readable-abis/contracts/facets/IexecEscrowTokenFacet.sol/IexecEscrowTokenFacet.json b/abis/human-readable-abis/contracts/facets/IexecEscrowTokenFacet.sol/IexecEscrowTokenFacet.json
@@ -1,6 +1,5 @@
 [
   "event Approval(address indexed,address indexed,uint256)",
-  "event ApprovalReceivedAndMatched(address indexed,uint256,bytes32 indexed)",
   "event Lock(address,uint256)",
   "event Reward(address,uint256,bytes32)",
   "event Seize(address,uint256,bytes32)",
diff --git a/abis/human-readable-abis/contracts/interfaces/IexecEscrowToken.sol/IexecEscrowToken.json b/abis/human-readable-abis/contracts/interfaces/IexecEscrowToken.sol/IexecEscrowToken.json
@@ -1,5 +1,4 @@
 [
-  "event ApprovalReceivedAndMatched(address indexed,uint256,bytes32 indexed)",
   "function deposit(uint256) returns (bool)",
   "function depositFor(uint256,address) returns (bool)",
   "function depositForArray(uint256[],address[]) returns (bool)",
diff --git a/contracts/facets/IexecEscrowTokenFacet.sol b/contracts/facets/IexecEscrowTokenFacet.sol
@@ -111,7 +111,6 @@ contract IexecEscrowTokenFacet is IexecEscrowToken, IexecTokenSpender, FacetBase
         if (data.length > 0) {
             dealId = _matchOrdersAfterDeposit(sender, data);
         }
-        emit ApprovalReceivedAndMatched(sender, amount, dealId);
         return true;
     }
 
diff --git a/contracts/interfaces/IexecEscrowToken.sol b/contracts/interfaces/IexecEscrowToken.sol
@@ -6,11 +6,6 @@ pragma solidity ^0.8.0;
 interface IexecEscrowToken {
     receive() external payable;
     fallback() external payable;
-    event ApprovalReceivedAndMatched(
-        address indexed sender,
-        uint256 amount,
-        bytes32 indexed dealId
-    );
     function deposit(uint256) external returns (bool);
     function depositFor(uint256, address) external returns (bool);
     function depositForArray(uint256[] calldata, address[] calldata) external returns (bool);
diff --git a/docs/solidity/index.md b/docs/solidity/index.md
@@ -1,13 +1,5 @@
 # Solidity API
 
-## IexecInterfaceToken
-
-A global interface that aggregates all the interfaces needed to interact with
-the PoCo contracts in token mode.
-
-_Referenced in the SDK with the current path `contracts/IexecInterfaceToken.sol`.
-Changing the name or the path would cause a breaking change in the SDK._
-
 ## IexecERC20Core
 
 ## IexecEscrowTokenFacet
@@ -68,14 +60,12 @@ function receiveApproval(address sender, uint256 amount, address token, bytes da
 
 Receives approval and optionally matches orders in one transaction
 
-_This is the magic function that enables approve+deposit+match atomicity
-
 Usage patterns:
 1. Simple deposit: RLC.approveAndCall(escrow, amount, "")
 2. Deposit + match: RLC.approveAndCall(escrow, amount, encodedOrders)
 
 The `data` parameter should be ABI-encoded orders if matching is desired:
-abi.encode(appOrder, datasetOrder, workerpoolOrder, requestOrder)_
+abi.encode(appOrder, datasetOrder, workerpoolOrder, requestOrder)
 
 #### Parameters
 
@@ -90,7 +80,7 @@ abi.encode(appOrder, datasetOrder, workerpoolOrder, requestOrder)_
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| [0] | bool | success True if operation succeeded @custom:example ```solidity // Encode orders bytes memory data = abi.encode(appOrder, datasetOrder, workerpoolOrder, requestOrder); // One transaction does it all RLC.approveAndCall(iexecProxy, dealCost, data); ``` |
+| [0] | bool | success True if operation succeeded @custom:example ```solidity // Encode orders bytes memory data = abi.encode(appOrder, datasetOrder, workerpoolOrder, requestOrder); // One transaction does it all RLC(token).approveAndCall(iexecProxy, dealCost, data); ``` |
 
 ## IexecLibCore_v5
 
@@ -565,6 +555,14 @@ struct PocoStorage {
 function isRegistered(address _entry) external view returns (bool)
 ```
 
+## IexecInterfaceToken
+
+A global interface that aggregates all the interfaces needed to interact with
+the PoCo contracts in token mode.
+
+_Referenced in the SDK with the current path `contracts/IexecInterfaceToken.sol`.
+Changing the name or the path would cause a breaking change in the SDK._
+
 ## IexecInterfaceNative
 
 A global interface that aggregates all the interfaces needed to interact with
diff --git a/test/byContract/IexecEscrow/IexecEscrowToken.receiveApproval.test.ts b/test/byContract/IexecEscrow/IexecEscrowToken.receiveApproval.test.ts
@@ -250,10 +250,6 @@ describe('IexecEscrowToken-receiveApproval', () => {
                 .to.emit(iexecPoco, 'Transfer')
                 .withArgs(AddressZero, requester.address, dealCost);
 
-            await expect(tx)
-                .to.emit(iexecPoco, 'ApprovalReceivedAndMatched')
-                .withArgs(requester.address, dealCost, dealId);
-
             await expect(tx)
                 .to.emit(iexecPoco, 'OrdersMatched')
                 .withArgs(
@@ -298,10 +294,6 @@ describe('IexecEscrowToken-receiveApproval', () => {
 
             const tx = rlcInstanceAsRequester.approveAndCall(proxyAddress, dealCost, encodedOrders);
 
-            await expect(tx)
-                .to.emit(iexecPoco, 'ApprovalReceivedAndMatched')
-                .withArgs(requester.address, dealCost, dealId);
-
             // Total balance should be existing + new deposit - frozen
             expect(await iexecPoco.balanceOf(requester.address)).to.equal(
                 initialBalance + dealCost - dealCost,
@@ -454,10 +446,6 @@ describe('IexecEscrowToken-receiveApproval', () => {
                 .to.emit(iexecPoco, 'Transfer')
                 .withArgs(AddressZero, requester.address, dealCost);
 
-            await expect(tx)
-                .to.emit(iexecPoco, 'ApprovalReceivedAndMatched')
-                .withArgs(requester.address, dealCost, dealId);
-
             expect(await iexecPoco.frozenOf(requester.address)).to.equal(0n);
         });
     });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`[`
`2`	`2`	`"event Approval(address indexed,address indexed,uint256)",`
`3`		`- "event ApprovalReceivedAndMatched(address indexed,uint256,bytes32 indexed)",`
`4`	`3`	`"event Lock(address,uint256)",`
`5`	`4`	`"event Reward(address,uint256,bytes32)",`
`6`	`5`	`"event Seize(address,uint256,bytes32)",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`[`
`2`		`- "event ApprovalReceivedAndMatched(address indexed,uint256,bytes32 indexed)",`
`3`	`2`	`"function deposit(uint256) returns (bool)",`
`4`	`3`	`"function depositFor(uint256,address) returns (bool)",`
`5`	`4`	`"function depositForArray(uint256[],address[]) returns (bool)",`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,6 @@ contract IexecEscrowTokenFacet is IexecEscrowToken, IexecTokenSpender, FacetBase`
`111`	`111`	`if (data.length > 0) {`
`112`	`112`	`dealId = _matchOrdersAfterDeposit(sender, data);`
`113`	`113`	`}`
`114`		`- emit ApprovalReceivedAndMatched(sender, amount, dealId);`
`115`	`114`	`return true;`
`116`	`115`	`}`
`117`	`116`