Implement settlement net off with off-chain hints #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
marcello-pv01
commented
Oct 1, 2025
| } | ||
|
|
||
| // Additional Step: For fungible assets, enforce debtor→creditor-only transfers with gross == net per party | ||
| // TODO: evaluate whether this is too restrictive, this would possibly prevent partial netting arrangements, write tests for this in case we decide to keep it |
Contributor
Author
There was a problem hiding this comment.
Let's review this together
marcello-pv01
commented
Oct 1, 2025
| uint256 go = grossOut[base]; | ||
| uint256 gi = grossIn[base]; | ||
| if (d < 0) { | ||
| require(gi == 0, "Fungible: debtor must not receive"); |
Contributor
Author
There was a problem hiding this comment.
I need to write tests and possibly convert to exceptions for these guys
Signed-off-by: marcello-pv01 <marcello@pv0.one>
marcello-pv01
force-pushed
the
implement-settlement-net-off-hint
branch
from
ddd2c42 to
0150525
Compare
marcello-pv01
commented
Oct 2, 2025
| uint256 cutoffDate, | ||
| bool isAutoSettled | ||
| ) external returns (uint256 id) { | ||
| return _createSettlement(flows, nettedFlows,settlementReference, cutoffDate, isAutoSettled, true); |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| return _createSettlement(flows, nettedFlows,settlementReference, cutoffDate, isAutoSettled, true); | |
| return _createSettlement(flows, nettedFlows, settlementReference, cutoffDate, isAutoSettled, true); |
marcello-pv01
commented
Oct 2, 2025
| * @param nettedFlows The flows that will be used to process the settlement, used to provide optimised settlement solutions. | ||
| * @param settlementReference A free text reference for the settlement. | ||
| * @param cutoffDate The deadline for approvals and execution. | ||
| * @param isAutoSettled If true, the settlement will be executed automatically after all approvals are in place. |
Contributor
Author
There was a problem hiding this comment.
missing useNettingOff parameter
marcello-pv01
commented
Oct 2, 2025
| if (block.timestamp > cutoffDate) revert CutoffDatePassed(); | ||
| uint256 lengthFlows = flows.length; | ||
| if (lengthFlows == 0) revert NoFlowsProvided(); | ||
| // no need to check for nettedFlows being not empty if useNettingOff is false at runtime |
Contributor
Author
There was a problem hiding this comment.
also empty nettedFlows is a valid optimisation.
marcello-pv01
commented
Oct 2, 2025
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
marcello-pv01
force-pushed
the
implement-settlement-net-off-hint
branch
from
33ae549 to
306c4c0
Compare
marcello-pv01
commented
Oct 2, 2025
Comment on lines
208
to
209
| uint256 idxA = k * partyCount + pFrom; | ||
| uint256 idxB = k * partyCount + pTo; |
Contributor
Author
There was a problem hiding this comment.
Suggested change
| uint256 idxA = k * partyCount + pFrom; | |
| uint256 idxB = k * partyCount + pTo; | |
| uint256 idxFrom = k * partyCount + pFrom; | |
| uint256 idxTo = k * partyCount + pTo; |
Signed-off-by: marcello-pv01 <marcello@pv0.one>
marcello-pv01
commented
Oct 2, 2025
| * @param party Address of the party to compute requirements for. | ||
| * @return result NetRequirement data struct with ETH and ERC20 requirements. | ||
| */ | ||
| function _computeNetRequirementsForParty(IDeliveryVersusPaymentV1.Flow[] memory flows, address party) internal pure returns ( |
Contributor
Author
There was a problem hiding this comment.
move this function where "private" ones live
marcello-pv01
commented
Oct 2, 2025
| if (f.token == address(0)) { | ||
| // ETH leg | ||
| result.ethRequiredNet += f.amountOrId; | ||
| } else if (!f.isNFT) { |
Contributor
Author
There was a problem hiding this comment.
we should probably add nft as well for completeness
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Signed-off-by: marcello-pv01 <marcello@pv0.one>
Contributor
Author
|
Agreed with Kevin to release the version without netting off to the public as that's the one audited by ShadowyCreators. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
We want to allow executing a settlement in the most efficient way as possible while keeping the same trace of the settlement on the smart contract.
This means that we want to allow the user to define a settlement as the explicit set of cashflows, but we want to let them settle it in the most capital/gas efficient way possible, i.e. netting off transfers where applicable.
This PR adds an additional functionality upon settlement creation, where the caller could send an additional array of netted flows which will be used for the settlement when it gets executed.
The idea is that those netted flows are computed off-chain, where the computation is cheaper and easier to run and implement, but on-chain we still verify that the netted flows provided are equivalent to the explicit flows.
In order to simplify the life for devs that want to achieve trivial optimisations, I added an helper function to the helper contract which greedily computes those optimisations.
This is not as efficient as using MILP approaches but for simple scenarios they are equivalent, and it's still better than nothing.
I implemented tests for both functionalities and they are passing.
Considerations
This solution will cost extra gas to store the netted off flows and the
useNettingOffflag.If no netted flows are provided useNettingOff will be set to false automatically, if they are, even if it's an empty array, then useNettingOff will be set to true. The reason for this is that no flows is an optimisation, think of
A -> B: 10 USDC, B -> A: 10 USDC.Changes
Checklist