Skip to content

Commit

Permalink
docs(market-pallets): fix on_sectors_terminate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmg-duarte committed Jul 4, 2024
1 parent 945fe6f commit 24a7f2c
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions primitives/proofs/src/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,14 @@ pub trait Market<AccountId, BlockNumber> {
compute_cid: bool,
) -> Result<BoundedVec<ActiveSector<AccountId>, ConstU32<MAX_SECTORS_PER_CALL>>, DispatchError>;

/// Activate a set of deals grouped by sector, returning the size and
/// extra info about verified deals.
/// Sectors' deals are activated in parameter-defined order.
/// Each sector's deals are activated or fail as a group, but independently of other sectors.
/// Note that confirming all deals fit within a sector is the caller's responsibility
/// (and is implied by confirming the sector's data commitment is derived from the deal pieces).
/// Terminate a set of deals in response to their sector being terminated.
///
/// Slashes the provider collateral, refunds the partial unpaid escrow amount to the client.
///
/// A sector can be terminated voluntarily — the storage provider terminates the sector —
/// or involuntarily — the sector has been faulty for more than 42 consecutive days.
///
/// Source: <https://github.com/filecoin-project/builtin-actors/blob/54236ae89880bf4aa89b0dba6d9060c3fd2aacee/actors/market/src/lib.rs#L786-L876>
fn on_sectors_terminate(
storage_provider: &AccountId,
sector_ids: BoundedVec<SectorId, ConstU32<MAX_DEALS_PER_SECTOR>>,
Expand Down

0 comments on commit 24a7f2c

Please sign in to comment.