MVP of assurance contract contracts + tests #44

owocki · 2024-10-18T18:05:06Z

An assurance contract is a type of agreement in which participants commit to funding a public good or project only if a threshold of contributions is met. If the total pledged contributions reach the predetermined amount, the project moves forward, and participants fulfill their financial commitments. If the threshold isn't met, no one is obligated to contribute, and the project does not proceed.

This mechanism reduces the free-rider problem in public goods funding by ensuring that participants only pay if the project can be fully funded and implemented. It provides a way to align the interests of contributors, ensuring that everyone’s contributions are contingent on the collective success of the funding effort.

This PR adds an assurance contract and passing tests to the allo 2.1 repo

Features

[PASS] testClaimFundsBeforeDeadline() (gas: 173184)
[PASS] testClaimFundsERC20() (gas: 268169)
[PASS] testClaimFundsETH() (gas: 213334)
[PASS] testInitializeERC20() (gas: 142273)
[PASS] testInitializeETH() (gas: 119991)
[PASS] testPledgeAfterDeadline() (gas: 125953)
[PASS] testPledgeERC20() (gas: 255340)
[PASS] testPledgeETH() (gas: 173698)
[PASS] testRefundBeforeDeadline() (gas: 171858)
[PASS] testRefundERC20() (gas: 256284)
[PASS] testRefundETH() (gas: 190767)
Suite result: ok. 11 passed; 0 failed; 0 skipped; finished in 842.63µs (850.83µs CPU time)

Run it yourself with

bun run test AssuranceContractStrategy

owocki · 2024-10-18T18:23:25Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+    }
+
+    function _allocate(address[] memory, uint256[] memory, bytes memory, address) internal virtual override {
+        revert("AssuranceContract: Allocate not implemented");


need to integrate the payout/refund txns here.

why? Isnt allocate in this case the pledge logic?

owocki · 2024-10-18T18:23:52Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+        revert("AssuranceContract: Allocate not implemented");
+    }
+
+    function _distribute(address[] memory, bytes memory, address) internal virtual override {


would be nice if i just got a distribute function that could natively handle any type of distribution (merkle, drips, or otherwise)...

I agree. In this example however what would distribute do? like allocate - pledge, I think distribute should hold the logic of claimFunds

owocki · 2024-10-18T18:25:54Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+    }
+
+    function _register(address[] memory, bytes memory, address) internal virtual override returns (address[] memory) {
+        revert("AssuranceContract: Register not implemented");


i think the current allo pool uses just naked addresses. need to use allo registry items per https://github.com/allo-protocol/allo-v2.1/blob/dev/contracts/core/Allo.md#register-recipient.

would be nice if this could be inherited from an upstream contract..

You could make use of the RecipientsExtension. Using the _register from the extensions includes this check

allo-v2.1/contracts/strategies/extensions/register/RecipientsExtension.sol

Lines 293 to 296 in c583e0e

if (_recipientIdOrRegistryAnchor != address(0)) {

if (!_isProfileMember(_recipientIdOrRegistryAnchor, _sender)) {

revert UNAUTHORIZED();

}

0xOneTony

Took a peek, great effort! 🔥
I left a couple of comments when it comes to the logic for allocate and distribute. An improved design could be, having an extension AssuranceExtensions handling the logic for pledging and refunding along with some hooks, for added flexibility for custom code, and having a strategy CrowdFundAssuranceStrategy that uses this extension and integrates pledge into allocate (from extension) and claim funds for distribute to beneficiary.

0xOneTony · 2024-10-23T14:04:26Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+    }
+
+    /// @notice Mapping of pool IDs to Campaign structs
+    mapping(uint256 => Campaign) public campaigns;


I see you have this mapping here, does this mean the strategy would be re-usable for multiple campaigns after each one finishes? If so it would be cleaner to also include a createCampaign function for pool managers that will basically create the campaign like you do in initialize

i believe pool ID here is also reffering to the ID of the campaign, this might confuse people with Allo's pool IDs

0xOneTony · 2024-10-23T14:07:49Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+    }
+
+    function _allocate(address[] memory, uint256[] memory, bytes memory, address) internal virtual override {
+        revert("AssuranceContract: Allocate not implemented");


why? Isnt allocate in this case the pledge logic?

0xOneTony · 2024-10-23T14:10:10Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+        revert("AssuranceContract: Allocate not implemented");
+    }
+
+    function _distribute(address[] memory, bytes memory, address) internal virtual override {


I agree. In this example however what would distribute do? like allocate - pledge, I think distribute should hold the logic of claimFunds

0xOneTony · 2024-10-23T14:12:58Z

contracts/strategies/examples/assurance-contract/AssuranceContract.sol

+    }
+
+    function _register(address[] memory, bytes memory, address) internal virtual override returns (address[] memory) {
+        revert("AssuranceContract: Register not implemented");


You could make use of the RecipientsExtension. Using the _register from the extensions includes this check

allo-v2.1/contracts/strategies/extensions/register/RecipientsExtension.sol

Lines 293 to 296 in c583e0e

if (_recipientIdOrRegistryAnchor != address(0)) {

if (!_isProfileMember(_recipientIdOrRegistryAnchor, _sender)) {

revert UNAUTHORIZED();

}

owocki added 3 commits October 18, 2024 12:04

MVP assurance contract

fe7b3a4

adds docs

0754c3f

erc20 support

adcdb93

owocki commented Oct 18, 2024

View reviewed changes

owocki added 3 commits October 18, 2024 12:30

more docs

320ed84

allow contributions AFTER deadline, but as long as not finalized

316f035

allow contributions AFTER deadline, but as long as not finalized

a02e655

0xOneTony reviewed Oct 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MVP of assurance contract contracts + tests #44

MVP of assurance contract contracts + tests #44

owocki commented Oct 18, 2024 •

edited

Loading

owocki Oct 18, 2024

0xOneTony Oct 23, 2024

owocki Oct 18, 2024

0xOneTony Oct 23, 2024

owocki Oct 18, 2024

0xOneTony Oct 23, 2024

0xOneTony left a comment

0xOneTony Oct 23, 2024

0xOneTony Oct 23, 2024

0xOneTony Oct 23, 2024

0xOneTony Oct 23, 2024

0xOneTony Oct 23, 2024

	if (_recipientIdOrRegistryAnchor != address(0)) {
	if (!_isProfileMember(_recipientIdOrRegistryAnchor, _sender)) {
	revert UNAUTHORIZED();
	}

MVP of assurance contract contracts + tests #44

Are you sure you want to change the base?

MVP of assurance contract contracts + tests #44

Conversation

owocki commented Oct 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xOneTony left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

owocki commented Oct 18, 2024 •

edited

Loading