Use Vault in Marketplace #223

markspanbroek · 2025-02-27T08:41:05Z

Uses the vault for all token transfers in the marketplace. The marketplace now no longer keeps any funds itself.

This has impact on the following as well:

clients and hosts can no longer specify a different address to receive payouts
when storage request fails (too many slots freed) then the funds are frozen
- client gets a refund for the remaining time
- client gets the repair rewards for the freed slots
validators need to withdraw their rewards at the end of the storage request
we now use storage optimized types Timestamp, Duration and TokensPerSecond on the API
collateral calculations are moved to a separate module
fuzzing is removed (it only tested accounting of funds in the marketplace itself, which is now removed)
RequestCancelled event is removed, which was not great anyway because it is not emitted at the moment that the request is cancelled
repair reward is now a bonus paid out at the end, no longer a discount on the collateral

AuHau

Great work, big effort! 👏

Generally LGTM, but there are a few critical points that need clarification or addressing, so I will go for the "Request changes" here.

I have gone over the contract changes, still need to see the testing of this, but that will be in round two 😅

contracts/marketplace/VaultHelpers.sol

contracts/Requests.sol

contracts/marketplace/Collateral.sol

contracts/Marketplace.sol

AuHau

Nice! Generally LGTM! Just few comment here and there, but nothing blocking ;-)

Thanks again for such a big chunk of work 👏

test/Marketplace.test.js

contracts/Marketplace.sol

test/Marketplace.test.js

AuHau · 2025-06-09T13:37:11Z

test/Marketplace.test.js

+      await waitUntilStarted(marketplace, request, proof, token)
+      await waitUntilFinished(marketplace, requestId(request))
+      await marketplace.freeSlot(slotId(slot))
+      expect(await marketplace.currentCollateral(slotId(slot))).to.equal(0)


Maybe add balances checks that verify what happens to the collateral? Eq. burned vs. transfered back? Also for the tests bellow?

Maybe I'm missing the point, but the balances are checked in the tests right above these tests ("pays out finished request base on time hosted", "pays the host when contract was cancelled" and "pays the host when contract fails and then finishes")

contracts/Marketplace.sol

test/Marketplace.test.js

Vault stores balances as uint128

replaced by formal verification with certora

- removes RequestCancelled event, which was not great anyway because it is not emitted at the moment that the request is cancelled

- move all collateral calculatons to separate library

so that they can no longer be transfered within the vault

This state is no longer necessary, vault ensures that payouts happen only once. Hosts could bypass this state anyway by withdrawing from the vault directly.

- changes to marketplace constructor - we no longer have _marketplaceTotals - timestamps have their own type now - freeSlot no longer takes payout addresses - slot state 'Paid' no longer exists - freeSlot can be invoked more than once now - a failed request no longer ends immediately

No need to test the token itself

It is no longer a discount on the collateral, to simplify reasoning about collateral in the sales module of the codex node

So that a storage provider can know how much collateral is returned when it calls freeSlot()

Because a client might still need to call withdraw()

reason: freeSlot() will call forciblyFreeSlot when contract is not finished, so we can use that instead

reason: hosts are paid for the time that they hosted the slot up until the time that the request failed Co-Authored-By: Adam Uhlíř <[email protected]>

Co-Authored-By: Adam Uhlíř <[email protected]>

reason: the function only depends on the request, and it is similar to the pricePerSlotPerSecond function Co-Authored-By: Adam Uhlíř <[email protected]>

Co-Authored-By: Adam Uhlíř <[email protected]>

markspanbroek force-pushed the vault-integration branch from b9689f1 to 0f0f830 Compare February 27, 2025 09:46

markspanbroek force-pushed the vault branch from d80b1bf to 9b42a46 Compare March 4, 2025 10:29

markspanbroek force-pushed the vault-integration branch 4 times, most recently from 32d0dbd to 095e90f Compare March 6, 2025 14:24

markspanbroek force-pushed the vault-integration branch 2 times, most recently from 53679b4 to cfd30bf Compare March 25, 2025 14:32

markspanbroek mentioned this pull request Apr 15, 2025

Marketplace vault codex-storage/nim-codex#1196

Open

markspanbroek force-pushed the vault branch 2 times, most recently from 6a7d559 to 957f6ec Compare April 16, 2025 09:06

Base automatically changed from vault to master April 16, 2025 09:57

markspanbroek force-pushed the vault-integration branch from cfd30bf to 8a11e87 Compare April 16, 2025 11:19

markspanbroek marked this pull request as ready for review April 16, 2025 11:31

markspanbroek force-pushed the vault-integration branch from 15d50c7 to 55fb29f Compare April 16, 2025 11:59

AuHau mentioned this pull request Apr 17, 2025

feat: protocol fee #228

Open

markspanbroek force-pushed the vault-integration branch from 55fb29f to 0bdefa7 Compare May 19, 2025 10:43

AuHau requested changes May 21, 2025

View reviewed changes

AuHau reviewed May 22, 2025

View reviewed changes

contracts/Marketplace.sol Outdated Show resolved Hide resolved

AuHau approved these changes Jun 9, 2025

View reviewed changes

markspanbroek added 10 commits June 11, 2025 16:29

marketplace: use SafeERC20 for transfers

341b303

marketplace: deploy vault and set it in the marketplace

aee61bd

marketplace: remove support for changing payout addresses

6ebed47

marketplace: use vault in marketplace

0910c83

vault: move Timestamp and TokensPerSecond libraries one level up

ccf9107

marketplace: use Timestamp, Duration and TokensPerSecond types

4f45856

marketplace: collateral is uint128

761fbd4

Vault stores balances as uint128

marketplace: remove fuzzing

15c58e1

replaced by formal verification with certora

marketplace: remove accounting that is now done by vault

9570404

marketplace: simplify withdrawing by client

3ea0291

- removes RequestCancelled event, which was not great anyway because it is not emitted at the moment that the request is cancelled

markspanbroek and others added 26 commits June 11, 2025 16:29

marketplace: burn tokens in vault when slashing

c626372

- move all collateral calculatons to separate library

marketplace: remove accounting that is now done by vault

5e8031e

marketplace: optimize storage reads and writes

5c9910d

marketplace: transfer repair reward in vault

b6f5d65

marketplace: designate validator rewards

17646f1

so that they can no longer be transfered within the vault

marketplace: formatting

e60ff36

marketplace: remove accounting that is now done by vault

06a9e41

marketplace: cleanup

5fb63c4

marketplace: remove 'Paid' state

468bc2e

This state is no longer necessary, vault ensures that payouts happen only once. Hosts could bypass this state anyway by withdrawing from the vault directly.

proofs: use Timestamp instead of uint64

52cf227

certora: remove check on ERC20 token

51862f6

No need to test the token itself

certora: update state changes spec now that we have vault

e4348de

marketplace: repair reward is paid out at the end

6bd4144

It is no longer a discount on the collateral, to simplify reasoning about collateral in the sales module of the codex node

marketplace: cleanup tests

6971766

marketplace: re-instate currentCollateral()

7a56618

So that a storage provider can know how much collateral is returned when it calls freeSlot()

marketplace: simplify requestEnd()

9603025

marketplace: keep request in myRequests when freeing slot

47f3c1e

Because a client might still need to call withdraw()

marketplace: no longer expose forciblyFreeSlot in tests

2cd4521

reason: freeSlot() will call forciblyFreeSlot when contract is not finished, so we can use that instead

marketplace: allow slot payout for failed requests

724344c

reason: hosts are paid for the time that they hosted the slot up until the time that the request failed Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: cleanup

1fb3d21

Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: move collateralPerSlot() to Requests.sol

bdee8de

reason: the function only depends on the request, and it is similar to the pricePerSlotPerSecond function Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: clarify why we flow funds from client to itself

895e36f

Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: clarify why we flow & transfer funds before burning

075d97e

Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: fix test

cd8b657

Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: add test for hosts that makes request fail

4410941

Co-Authored-By: Adam Uhlíř <[email protected]>

markspanbroek force-pushed the vault-integration branch from 1ca2091 to 4410941 Compare June 11, 2025 15:01

markspanbroek and others added 2 commits June 12, 2025 08:05

marketplace: improve withdraw test

d7554ce

Co-Authored-By: Adam Uhlíř <[email protected]>

marketplace: better tests for repair

b5ab386

Co-Authored-By: Adam Uhlíř <[email protected]>

Use Vault in Marketplace #223

Are you sure you want to change the base?

Use Vault in Marketplace #223

Conversation

markspanbroek commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AuHau left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AuHau left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AuHau Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

markspanbroek Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

markspanbroek commented Feb 27, 2025 •

edited

Loading

AuHau left a comment •

edited

Loading