Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chmm195 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions contracts/escrow/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
//! MergeFi Escrow Contract
//!
//! Holds sponsor-funded bounty escrows for individual GitHub issues and
//! Holds crowdfunded bounty escrows for individual GitHub issues and
//! releases them (in full or split across a team) once the mergefi-backend
//! oracle reports that the underlying work has been merged/accepted, or
//! refunds them back to the sponsor if the issue is cancelled / its deadline
//! passes unresolved.
//! oracle reports that the underlying work has been merged/accepted. One or
//! more sponsors co-fund a single issue: the first opens the escrow with
//! `fund`, any number of others add to it with `contribute`. If the issue is
//! cancelled or its deadline passes unresolved, `refund` walks the
//! contribution ledger and returns each contributor the exact amount they
//! put in.
#![no_std]

mod error;
Expand Down