Skip to content

docs(escrow): update the module doc comment for crowdfunding - #194

Open
chmm195 wants to merge 1 commit into
MergeFi:mainfrom
chmm195:docs/escrow-module-doc-crowdfunding
Open

docs(escrow): update the module doc comment for crowdfunding#194
chmm195 wants to merge 1 commit into
MergeFi:mainfrom
chmm195:docs/escrow-module-doc-crowdfunding

Conversation

@chmm195

@chmm195 chmm195 commented Aug 24, 2026

Copy link
Copy Markdown

Closes #157.

Comment-only change to contracts/escrow/src/lib.rs; no code touched.

One note on the wording. #157 suggests matching milestones's comment, but the two contracts refund differently, so I did not copy it across:

  • milestones refunds the unallocated remainder "in proportion to what they put in" — proportional, because the budget is allocated to issues in slices over time, so there may be less left than was contributed.

  • escrow has no partial allocation. refund iterates 0..contributor_count and transfers each Contribution its own stored amount:

    token_client.transfer(
        &contract_address,
        &contribution.sponsor,
        &contribution.amount,
    );

    So every contributor gets back exactly what they put in. Saying "in proportion" here would be true but weaker than the guarantee the code actually makes, so the comment says "the exact amount they put in".

I also reworded the opening line: "sponsor-funded" read as one sponsor per issue, so it now names the fund / contribute split explicitly.

Left release's and fund's own doc comments alone — fund's was already updated in 4279873.

The top-of-file comment still described a single sponsor being refunded,
which predates the contribution ledger added in MergeFi#57. refund() iterates
every contribution and transfers each contributor their own amount.

Describes the fund/contribute split as well, since 'sponsor-funded' read
as one sponsor per issue.

Closes MergeFi#157
@vercel

vercel Bot commented Aug 24, 2026

Copy link
Copy Markdown

@chmm195 is attempting to deploy a commit to the chonilius' projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

escrow's module-level doc comment still says "refunds them back to the sponsor" (singular), stale since crowdfunding landed

1 participant