Skip to content

feat(contract): implement bounded resumable settlement and void refunds (closes #359) #372

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
ranjeet150 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(contract): implement bounded resumable settlement and void refunds (closes #359) #372

Show file tree
Hide file tree
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
5 changes: 3 additions & 2 deletions contracts/round/ERRORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ stay in sync with `contracts/round/src/types.rs`.
| --- | --- |
| 1–4 | Initialization & state lookup |
| 10–22 | Lifecycle & timing |
| 30–39 | Cryptography & validation |
| 30–40 | Cryptography & validation |

## Initialization & state lookup (1–4)

Expand Down Expand Up @@ -56,7 +56,7 @@ stay in sync with `contracts/round/src/types.rs`.
| 21 | `NotVoidable` | `void` | Round is past the `Open` status, or `now <= reveal_deadline + VOID_GRACE` (3600 s). | The round cannot be voided from its current state, or the grace window has not elapsed yet. | Either complete the normal lifecycle, or wait until `reveal_deadline + 1 hour` and try `void` again. |
| 22 | `WrongStatus` | `commit` | `round.status != Status::Open`. | A bid can only be submitted to a round in the Open status. | Start a new round; a Revealing/Cleared/Settled/Voided round no longer accepts commits. |

## Cryptography & validation (30–39)
## Cryptography & validation (30–40)

| Code | Variant | Raised by | Trigger | User-facing message | Suggested next action |
| ---: | --- | --- | --- | --- | --- |
Expand All @@ -70,6 +70,7 @@ stay in sync with `contracts/round/src/types.rs`.
| 37 | `NoValidBids` | `settle` | `round.winner` is `None` on a round whose status is `Cleared`. | Round has no winner to settle against. | Investigate: under current behavior the contract transitions to `Voided` (with all escrow refunded) when no valid bid is revealed, so this code should not appear in normal flow. If it does, the round is in an inconsistent state and warrants a manual review. |
| 38 | `RoundFull` | `commit` | `round.bidders.len() >= MAX_BIDDERS` (500). | The round has reached its bidder cap. | Start a new round to accept further bidders. |
| 39 | `InvalidLimit` | `get_bidders_page` | `limit == 0` or `limit > 100`. | Page size must be between 1 and 100 (inclusive). | Pass a `limit` in `[1, 100]`; use `next_cursor` from the previous page to walk larger rounds. |
| 40 | `InvalidCursor` | `settle_batch`, `void_batch` | `cursor > total_bidders` or `cursor > progress.cursor`. | The pagination cursor is out of bounds or skips unconfirmed obligations. | Pass a cursor matching the current confirmed progress (read via `get_payout_progress`). |

## How to use this table

Expand Down
7 changes: 1 addition & 6 deletions contracts/round/src/drand.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,7 @@ use crate::types::GlobalConfig;
/// `signature` is the uncompressed G1 point (96 bytes) for round R. The negated
/// G2 generator and the network public key / DST come from `GlobalConfig`, set
/// at deploy from values validated against a live quicknet round.
pub fn verify_round(
env: &Env,
config: &GlobalConfig,
round: u64,
signature: &BytesN<96>,
) -> bool {
pub fn verify_round(env: &Env, config: &GlobalConfig, round: u64, signature: &BytesN<96>) -> bool {
let bls = env.crypto().bls12_381();

// message = sha256(be8(round))
Expand Down
164 changes: 140 additions & 24 deletions contracts/round/src/error_paths.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,27 @@ use crate::storage::{get_round, set_round};
use crate::types::{ClearingRule, DataKey, Error, Status};

use super::{
assert_try_create_round_err, assert_try_contract_err, b32, commit_bid, commitment,
drand_round, funded_bidder, open_round, real_sig, setup, setup_drand, Fixture, GENESIS,
PERIOD, VEC_ROUND,
assert_try_contract_err, assert_try_create_round_err, b32, commit_bid, commitment, drand_round,
funded_bidder, open_round, real_sig, setup, setup_drand, Fixture, GENESIS, PERIOD, VEC_ROUND,
};

const MAX_BIDDERS: u32 = 500;

/// Every variant must appear here exactly once with the test that triggers it.
const ERROR_PATH_REGISTRY: &[(Error, &'static str)] = &[
(Error::NotInitialized, "error_path_not_initialized"),
(Error::AlreadyInitialized, "error_path_already_initialized_constructor_boundary"),
(
Error::AlreadyInitialized,
"error_path_already_initialized_constructor_boundary",
),
(Error::RoundNotFound, "error_path_round_not_found"),
(Error::BidNotFound, "error_path_bid_not_found"),
(Error::CommitClosed, "error_path_commit_closed"),
(Error::CommitNotClosed, "error_path_commit_not_closed"),
(Error::CommitDeadlineAfterReveal, "error_path_commit_deadline_after_reveal"),
(
Error::CommitDeadlineAfterReveal,
"error_path_commit_deadline_after_reveal",
),
(Error::RevealNotOpen, "error_path_reveal_not_open"),
(Error::RevealAlreadyOpen, "error_path_reveal_already_open"),
(Error::RevealWindowClosed, "error_path_reveal_window_closed"),
Expand All @@ -35,7 +40,10 @@ const ERROR_PATH_REGISTRY: &[(Error, &'static str)] = &[
(Error::RoundVoided, "error_path_round_voided"),
(Error::NotVoidable, "error_path_not_voidable"),
(Error::WrongStatus, "error_path_wrong_status"),
(Error::InvalidDrandSignature, "error_path_invalid_drand_signature"),
(
Error::InvalidDrandSignature,
"error_path_invalid_drand_signature",
),
(Error::HashMismatch, "error_path_hash_mismatch"),
(Error::AlreadyRevealed, "error_path_already_revealed"),
(Error::PayloadTooLarge, "error_path_payload_too_large"),
Expand All @@ -45,6 +53,7 @@ const ERROR_PATH_REGISTRY: &[(Error, &'static str)] = &[
(Error::NoValidBids, "error_path_no_valid_bids"),
(Error::RoundFull, "error_path_round_full"),
(Error::InvalidLimit, "error_path_invalid_limit"),
(Error::InvalidCursor, "error_path_invalid_cursor"),
];

fn oversized_bytes(env: &Env, len: u32) -> Bytes {
Expand All @@ -63,7 +72,12 @@ fn fill_bidder_cap(f: &Fixture, round_id: u64) {
});
}

fn settle_happy_path(f: &Fixture, t_reveal: u64, commit_deadline: u64, reveal_deadline: u64) -> u64 {
fn settle_happy_path(
f: &Fixture,
t_reveal: u64,
commit_deadline: u64,
reveal_deadline: u64,
) -> u64 {
let operator = Address::generate(&f.env);
let id = drand_round(
f,
Expand All @@ -77,7 +91,9 @@ fn settle_happy_path(f: &Fixture, t_reveal: u64, commit_deadline: u64, reveal_de
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
f.client.open_reveal(&id, &real_sig(&f.env));
f.client.reveal(&id, &alice, &500, &a_nonce);
f.env.ledger().with_mut(|l| l.timestamp = reveal_deadline + 1);
f.env
.ledger()
.with_mut(|l| l.timestamp = reveal_deadline + 1);
f.client.clear(&id);
f.client.settle(&id);
id
Expand All @@ -87,7 +103,7 @@ fn settle_happy_path(f: &Fixture, t_reveal: u64, commit_deadline: u64, reveal_de
fn error_paths_registry_covers_every_variant() {
assert_eq!(
ERROR_PATH_REGISTRY.len(),
27,
28,
"update ERROR_PATH_REGISTRY when adding/removing Error variants"
);
for (variant, name) in ERROR_PATH_REGISTRY {
Expand Down Expand Up @@ -197,7 +213,13 @@ fn error_path_commit_closed() {
fn error_path_commit_not_closed() {
let (f, _t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
assert_try_contract_err(
f.client.try_open_reveal(&id, &real_sig(&f.env)),
Error::CommitNotClosed,
Expand Down Expand Up @@ -239,7 +261,13 @@ fn error_path_reveal_not_open() {
fn error_path_reveal_already_open() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
Expand All @@ -255,12 +283,20 @@ fn error_path_reveal_already_open() {
fn error_path_reveal_window_closed() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
let a_nonce = commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
f.client.open_reveal(&id, &real_sig(&f.env));
f.env.ledger().with_mut(|l| l.timestamp = reveal_deadline + 1);
f.env
.ledger()
.with_mut(|l| l.timestamp = reveal_deadline + 1);
assert_try_contract_err(
f.client.try_reveal(&id, &alice, &500, &a_nonce),
Error::RevealWindowClosed,
Expand All @@ -271,7 +307,13 @@ fn error_path_reveal_window_closed() {
fn error_path_reveal_still_open() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
Expand All @@ -284,27 +326,43 @@ fn error_path_reveal_still_open() {
fn error_path_not_cleared() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
let a_nonce = commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
f.client.open_reveal(&id, &real_sig(&f.env));
f.client.reveal(&id, &alice, &500, &a_nonce);
f.env.ledger().with_mut(|l| l.timestamp = reveal_deadline + 1);
f.env
.ledger()
.with_mut(|l| l.timestamp = reveal_deadline + 1);
assert_try_contract_err(f.client.try_settle(&id), Error::NotCleared);
}

#[test]
fn error_path_already_cleared() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
let a_nonce = commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
f.client.open_reveal(&id, &real_sig(&f.env));
f.client.reveal(&id, &alice, &500, &a_nonce);
f.env.ledger().with_mut(|l| l.timestamp = reveal_deadline + 1);
f.env
.ledger()
.with_mut(|l| l.timestamp = reveal_deadline + 1);
f.client.clear(&id);
assert_try_contract_err(f.client.try_clear(&id), Error::AlreadyCleared);
}
Expand Down Expand Up @@ -341,7 +399,13 @@ fn error_path_not_voidable() {
fn error_path_wrong_status() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
Expand Down Expand Up @@ -386,7 +450,13 @@ fn error_path_invalid_drand_signature() {
fn error_path_hash_mismatch() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
Expand All @@ -401,7 +471,13 @@ fn error_path_hash_mismatch() {
fn error_path_already_revealed() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
let a_nonce = commit_bid(&f, id, &alice, 500, 500, 0x01);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
Expand Down Expand Up @@ -454,7 +530,13 @@ fn error_path_invalid_amount() {
fn error_path_bid_exceeds_escrow() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(&f, &operator, commit_deadline, reveal_deadline, ClearingRule::HighestBid);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
// Commit H for value=600 while locking only 500 escrow.
let nonce = b32(&f.env, 0x01);
Expand Down Expand Up @@ -532,6 +614,40 @@ fn error_path_invalid_limit() {
let f = setup();
let operator = Address::generate(&f.env);
let id = open_round(&f, &operator);
assert_try_contract_err(f.client.try_get_bidders_page(&id, &0, &0), Error::InvalidLimit);
assert_try_contract_err(f.client.try_get_bidders_page(&id, &0, &101), Error::InvalidLimit);
assert_try_contract_err(
f.client.try_get_bidders_page(&id, &0, &0),
Error::InvalidLimit,
);
assert_try_contract_err(
f.client.try_get_bidders_page(&id, &0, &101),
Error::InvalidLimit,
);
}

#[test]
fn error_path_invalid_cursor() {
let (f, t_reveal, commit_deadline, reveal_deadline) = setup_drand();
let operator = Address::generate(&f.env);
let id = drand_round(
&f,
&operator,
commit_deadline,
reveal_deadline,
ClearingRule::HighestBid,
);
let alice = funded_bidder(&f, 1_000);
let a_nonce = commit_bid(&f, id, &alice, 700, 700, 0x11);
f.env.ledger().with_mut(|l| l.timestamp = t_reveal + 1);
f.client.open_reveal(&id, &real_sig(&f.env));
f.client.reveal(&id, &alice, &700, &a_nonce);
f.env
.ledger()
.with_mut(|l| l.timestamp = reveal_deadline + 1);
f.client.clear(&id);

// Cursor beyond total bidders (total = 1)
assert_try_contract_err(
f.client.try_settle_batch(&id, &5, &10),
Error::InvalidCursor,
);
}
Loading