feat: deposit and match orders #293

gfournieriExec · 2025-10-17T11:13:49Z

No description provided.

…ond proxy

…ive facet and updating imports

…atch interfaces

…cense year

… IexecPocoDepositAndMatchTokenFacet

…ade process

Copilot

Pull Request Overview

This PR introduces a new depositAndMatchOrders function that combines token deposit and order matching operations into a single atomic transaction, improving the user experience for builders by eliminating separate approve, deposit, and match steps.

Key changes:

Added IexecPocoDepositAndMatchTokenFacet contract with the combined deposit and match functionality
Created interface IexecPocoDepositAndMatch to define the new API
Integrated the new facet into the diamond proxy deployment and upgrade scripts

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol`	Core implementation of the deposit and match functionality with balance checking and atomic execution
`contracts/interfaces/IexecPocoDepositAndMatchToken.sol`	Interface definition for the new `depositAndMatchOrders` function and `DepositAndMatch` event
`contracts/IexecInterfaceToken.sol`	Integration of the new interface into the main token interface
`test/byContract/IexecPocoDepositAndMatch/IexecPocoDepositAndMatchTokenFacet.test.ts`	Comprehensive test suite covering various scenarios including partial balances, error cases, and event verification
`scripts/upgrades/apply-deposit-match-upgrade.ts`	Deployment script for adding the new facet to the diamond proxy
`deploy/0_deploy.ts`	Updated deployment configuration to include the new facet
`abis/contracts/interfaces/IexecPocoDepositAndMatch.json`	Generated ABI for the interface
`abis/contracts/facets/IexecPocoDepositAndMatchTokenFacet.json`	Generated ABI for the facet implementation
`abis/contracts/IexecInterfaceToken.json`	Updated ABI including the new deposit and match function

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

deploy/0_deploy.ts

contracts/IexecInterfaceToken.sol

codecov · 2025-10-17T11:20:31Z

Codecov Report

❌ Patch coverage is 95.45455% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 85.03%. Comparing base (015adb2) to head (afdc4ee).
⚠️ Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
contracts/facets/IexecPoco1Facet.sol	95.45%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #293      +/-   ##
==========================================
+ Coverage   84.85%   85.03%   +0.18%     
==========================================
  Files          37       37              
  Lines        1241     1263      +22     
  Branches      235      238       +3     
==========================================
+ Hits         1053     1074      +21     
- Misses        188      189       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Le-Caignec

Personally, I would have chosen to add this function to the Poco1 facet, so that it would be at the same level as matchOrder.
But I don’t have a strong opinion on this — maybe it will make our deployments easier if we don’t have too many facets to manage.

contracts/interfaces/IexecPocoDepositAndMatchToken.sol

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol

Le-Caignec · 2025-10-17T16:02:43Z

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol

+        uint256 depositedAmount = 0;
+        if (currentBalance < dealCost) {
+            uint256 requiredDeposit = dealCost - currentBalance;
+            _depositTokens(msg.sender, requiredDeposit);


by using this internal function we read the storage twice time (PocoStorageLib.getPocoStorage())

gas reduction of 10, idk if it's worth it

buy puttin the $ as an input of the internal function
but reductin off 156 by removing the internal fct

Solution in mind

if (currentBalance < dealCost) { unchecked { // Safe: currentBalance < dealCost, so dealCost - currentBalance cannot underflow depositedAmount = dealCost - currentBalance; } if (!$.m_baseToken.transferFrom(msg.sender, address(this), depositedAmount)) { revert DepositAndMatch_TokenTransferFailed(); } // Safe: adding to balance cannot realistically overflow unchecked { $.m_balances[msg.sender] = currentBalance + depositedAmount; $.m_totalSupply += depositedAmount; } emit Transfer(address(0), msg.sender, depositedAmount); }

gas max : 879232 => 878754 = - 478

https://github.com/iExecBlockchainComputing/PoCo/compare/feature/deposit-matchOrders...feat/optimize-deposit-tokens?expand=1

Co-authored-by: Robin Le Caignec <[email protected]>

Co-authored-by: Copilot <[email protected]>

…cBlockchainComputing/PoCo into feature/deposit-matchOrders

Copilot

Pull Request Overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

contracts/IexecInterfaceToken.sol

scripts/upgrades/v6.2.0-deposit-and-match.ts

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol

contracts/interfaces/IexecDepositAndMatchOrders.sol

…acy interface

…chOrdersFacet and update related references

…dersFacet

…ted facets

… and streamline proxy linking

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol

scripts/upgrades/v6.2.0-deposit-and-match.md

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol

…acet

contracts/facets/IexecPoco1Facet.sol

…s interface and IexecPoco1Facet

…date documentation

…etails and standardizing action run links

…ction

…umentation

…lementation and internal deposit handling

… deployment in upgrade script

contracts/facets/IexecPoco1Facet.sol

zguesmi · 2025-10-29T14:13:26Z

contracts/interfaces/IexecDepositAndMatchOrders.sol

+
+import {IexecLibOrders_v5} from "../libs/IexecLibOrders_v5.sol";
+
+interface IexecDepositAndMatchOrders {


Why not in IexecPoco1 ?

refactor: Consolidate depositAndMatchOrders functionality and remove …

zguesmi · 2025-10-29T14:15:09Z

contracts/facets/IexecPoco1Facet.sol

+        }
+
+        // Match the orders with the requester as sponsor
+        dealId = this.matchOrders(_apporder, _datasetorder, _workerpoolorder, _requestorder);


This is doing an external call, make matchOrders public and call it without this.

refactor: Change matchOrders function visibility from external to public

zguesmi · 2025-10-29T14:18:50Z

contracts/facets/IexecPoco1Facet.sol

+     * @param depositor The account making the deposit
+     * @param amount The amount to deposit
+     */
+    function _depositTokens(address depositor, uint256 amount) private {


Refactor and use existing functions:

IexecEscrowTokenFacet._deposit() IexecERC20Core._mint()

Will do that when we upgrade to solidity ^0.8.0

contracts/facets/IexecPoco1Facet.sol

zguesmi · 2025-10-29T14:21:38Z

scripts/upgrades/v6.2.0-deposit-and-match.md

+
+## Summary of changes
+
+- Add `IexecDepositAndMatchOrdersFacet` to optimize deposit and order matching operations


Suggested change

- Add `IexecDepositAndMatchOrdersFacet` to optimize deposit and order matching operations

zguesmi · 2025-10-29T14:21:52Z

scripts/upgrades/v6.2.0-deposit-and-match.md

+
+- Add `IexecDepositAndMatchOrdersFacet` to optimize deposit and order matching operations
+- Introduce functions to handle deposit and match orders in a single transaction
+- Improve gas efficiency for token-based operations


What do you mean?

zguesmi · 2025-10-29T14:22:30Z

scripts/upgrades/v6.2.0-deposit-and-match.ts

+import { tryVerify } from '../verify';
+
+async function main() {
+    console.log('Deploying and adding DepositAndMatchOrders facet to diamond proxy...');


Not up to date.

zguesmi · 2025-10-29T14:22:50Z

scripts/upgrades/v6.2.0-deposit-and-match.ts

+        '421614': {
+            IexecPoco1Facet: '0xC8dE3913fcdBC576970dCe24eE416CA25681f65f',
+        },
+        // Arbitrum mainnet
+        '42161': {
+            IexecPoco1Facet: '0x46b555fE117DFd8D4eAC2470FA2d739c6c3a0152',
+        },


We should read addresses from deployments.

zguesmi · 2025-10-29T14:26:32Z

test/byContract/IexecPoco/IexecPoco1-depositAndMatchOrders.test.ts

+                orders.workerpool,
+                orders.requester,
+            ),
+        ).to.be.reverted;


Specify the reason or without reason.

…deprecated interface

gfournieriExec · 2025-11-06T15:24:50Z

Closed in flavor of #316

gfournieriExec added 10 commits September 16, 2025 16:17

feat: Add support for Arbitrum fork configuration in Hardhat

ce0077c

feat: draft Add DepositAndMatchOrders modules and integrate with diam…

6863e62

…ond proxy

Merge branch 'main' into feature/deposit-matchOrders

c4ce955

Merge branch 'main' into feature/deposit-matchOrders

8d20181

feat: refactor deposit and match functionality by removing legacy nat…

8be5fa9

…ive facet and updating imports

feat: add IexecPocoDepositAndMatchTokenFacet and IexecPocoDepositAndM…

5b60f68

…atch interfaces

feat: remove depositAndSponsorMatchOrders function and update SPDX li…

8016518

…cense year

feat: add DepositAndMatch event and depositAndMatchOrders function to…

e53b883

… IexecPocoDepositAndMatchTokenFacet

feat: remove DepositAndMatchOrders deployment scripts and update upgr…

620617b

…ade process

feat: remove redundant comments for order hash verification in tests

bc3f563

gfournieriExec requested review from Le-Caignec and Copilot October 17, 2025 11:13

gfournieriExec self-assigned this Oct 17, 2025

Copilot AI reviewed Oct 17, 2025

View reviewed changes

deploy/0_deploy.ts Outdated Show resolved Hide resolved

contracts/IexecInterfaceToken.sol Outdated Show resolved Hide resolved

gfournieriExec requested a review from zguesmi October 17, 2025 11:17

gfournieriExec marked this pull request as draft October 17, 2025 12:53

Le-Caignec reviewed Oct 17, 2025

View reviewed changes

gfournieriExec and others added 9 commits October 20, 2025 11:11

fix: update contracts/interfaces/IexecPocoDepositAndMatchToken.sol

1dc0f62

Co-authored-by: Robin Le Caignec <[email protected]>

feat: implement custom errors for deposit and match operations

1922fd7

feat: add custom error types for Deposit and Match operations

85de82e

Merge branch 'main' into feature/deposit-matchOrders

2d14cfb

feat: add upgrade script for Deposit and Match Orders (v6.2.0)

bb6cc04

fix: Apply suggestion from @Copilot

4b6c800

Co-authored-by: Copilot <[email protected]>

refactor: remove apply-deposit-match-upgrade script

2229484

Merge branch 'feature/deposit-matchOrders' of https://github.com/iExe…

7d9d6e2

…cBlockchainComputing/PoCo into feature/deposit-matchOrders

Merge branch 'main' into feature/deposit-matchOrders

3d55cbe

Copilot AI review requested due to automatic review settings October 21, 2025 13:19

Copilot AI reviewed Oct 21, 2025

View reviewed changes

zguesmi reviewed Oct 24, 2025

View reviewed changes

gfournieriExec added 5 commits October 27, 2025 14:19

Merge branch 'main' into feature/deposit-matchOrders

f91ae5b

chore: Update TODO comment to clarify removal of IexecAccessorsABILeg…

a7ca176

…acy interface

feat: Rename IexecPocoDepositAndMatchTokenFacet to IexecDepositAndMat…

70261be

…chOrdersFacet and update related references

refactor: Rename error messages for clarity in IexecDepositAndMatchOr…

0905534

…dersFacet

refactor: Simplify error names in IexecDepositAndMatchOrders and rela…

dd6bfaa

…ted facets

gfournieriExec marked this pull request as ready for review October 27, 2025 15:52

feat: Update deployment script to add IexecDepositAndMatchOrdersFacet…

1c58747

… and streamline proxy linking

zguesmi reviewed Oct 28, 2025

View reviewed changes

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol Outdated Show resolved Hide resolved

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol Outdated Show resolved Hide resolved

zguesmi reviewed Oct 28, 2025

View reviewed changes

scripts/upgrades/v6.2.0-deposit-and-match.md Outdated Show resolved Hide resolved

contracts/facets/IexecPocoDepositAndMatchTokenFacet.sol Outdated Show resolved Hide resolved

feat: Implement deposit and match orders functionality in IexecPoco1F…

e7849bd

…acet

github-advanced-security bot found potential problems Oct 28, 2025

View reviewed changes

contracts/facets/IexecPoco1Facet.sol Fixed Show fixed Hide fixed

contracts/facets/IexecPoco1Facet.sol Fixed Show fixed Hide fixed

gfournieriExec added 9 commits October 28, 2025 17:51

refactor: Remove DepositAndMatch event from IexecDepositAndMatchOrder…

236b948

…s interface and IexecPoco1Facet

refactor: Remove DepositAndMatch event from various interfaces and up…

48f6482

…date documentation

refactor: Update upgrade documentation by removing transaction hash d…

ef6e44d

…etails and standardizing action run links

refactor: Simplify deal cost calculation in depositAndMatchOrders fun…

fddbb4b

…ction

refactor: Reorganize IexecInterfaceNative and IexecInterfaceToken doc…

9cec46b

…umentation

Merge branch 'main' into feature/deposit-matchOrders

78a8e8b

refactor: Remove DepositAndMatch event assertions from tests

9f98f94

refactor: Reintroduce depositAndMatchOrders function with updated imp…

1e24cb8

…lementation and internal deposit handling

refactor: Update depositAndMatchOrders documentation and adjust facet…

277c605

… deployment in upgrade script

github-advanced-security bot found potential problems Oct 29, 2025

View reviewed changes

contracts/facets/IexecPoco1Facet.sol Dismissed Show dismissed Hide dismissed

zguesmi requested changes Oct 29, 2025

View reviewed changes

gfournieriExec added 2 commits October 30, 2025 09:14

refactor: Consolidate depositAndMatchOrders functionality and remove …

cb9898e

…deprecated interface

refactor: Change matchOrders function visibility from external to public

afdc4ee

gfournieriExec marked this pull request as draft October 30, 2025 10:20

gfournieriExec closed this Nov 6, 2025


		import {IexecLibOrders_v5} from "../libs/IexecLibOrders_v5.sol";

		interface IexecDepositAndMatchOrders {


		## Summary of changes

		- Add `IexecDepositAndMatchOrdersFacet` to optimize deposit and order matching operations

feat: deposit and match orders #293

feat: deposit and match orders #293

Conversation

gfournieriExec commented Oct 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Le-Caignec left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gfournieriExec commented Nov 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

codecov bot commented Oct 17, 2025 •

edited

Loading