Skip to content

Observability+ZK-friendly: pool-aggregate commitments (#371) #374

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

Observability+ZK-friendly: pool-aggregate commitments (#371) #374

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
46 changes: 28 additions & 18 deletions contracts/src/admin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::common::{
};
use crate::errors::ContractError;
use crate::types::{
AttestationConfig, AttestationConfigKey, DataKey, DataKeyCore, DataKeyExt,
AttestationConfig, AttestationConfigKey, DataKeyCore, DataKeyExt, DataKeyScoped,
DeviationConfig, DeviationConfigKey, DeviationReferenceMode, HbGateConfig, HbGateKey,
OracleHeartbeatRecord, OracleQuorumConfig, PolicyAction, ProtocolHealthStatus, Round,
RuntimeMode, PENDING_WINNINGS_EXPIRY_KEY, PendingWinningsUpdatedAtKey,
Expand Down Expand Up @@ -372,7 +372,7 @@ pub fn arm_oracle_deviation_override(env: Env) -> Result<(), ContractError> {

/// Loads the deviation guardrail config, returning the `StartPrice` default if unset (Issue #266).
pub fn _load_deviation_config(env: &Env) -> DeviationConfig {
let key = DeviationConfigKey::Config;
let key = DeviationConfigKey::DeviationConfig;
if env.storage().persistent().has(&key) {
env.storage().persistent().extend_ttl(
&key,
Expand All @@ -390,7 +390,7 @@ pub fn _load_deviation_config(env: &Env) -> DeviationConfig {
}

fn _save_deviation_config(env: &Env, config: &DeviationConfig) {
let key = DeviationConfigKey::Config;
let key = DeviationConfigKey::DeviationConfig;
env.storage().persistent().set(&key, config);
env.storage().persistent().extend_ttl(
&key,
Expand Down Expand Up @@ -459,7 +459,7 @@ pub fn get_deviation_window_samples(env: Env) -> u32 {

/// Loads the attestation config, returning `key: None` (disabled) if unset (Issue #263).
pub fn _load_attestation_config(env: &Env) -> AttestationConfig {
let key = AttestationConfigKey::Config;
let key = AttestationConfigKey::AttestationConfig;
if env.storage().persistent().has(&key) {
env.storage().persistent().extend_ttl(
&key,
Expand Down Expand Up @@ -488,7 +488,7 @@ pub fn set_attestation_key(env: Env, key: Option<BytesN<32>>) -> Result<(), Cont
_emit_action_rejected(&env, &admin, symbol_short!("attkey"), e);
})?;

let storage_key = AttestationConfigKey::Config;
let storage_key = AttestationConfigKey::AttestationConfig;
env.storage()
.persistent()
.set(&storage_key, &AttestationConfig { key: key.clone() });
Expand Down Expand Up @@ -662,7 +662,7 @@ pub fn _consume_hb_override(env: &Env) -> bool {

/// Loads the heartbeat gate config, returning defaults if unset.
pub fn _load_hb_config(env: &Env) -> HbGateConfig {
let key = HbGateKey::Config;
let key = HbGateKey::HbConfig;
if env.storage().persistent().has(&key) {
env.storage().persistent().extend_ttl(
&key,
Expand All @@ -682,7 +682,7 @@ pub fn _load_hb_config(env: &Env) -> HbGateConfig {

/// Saves the heartbeat gate config to persistent storage.
pub fn _save_hb_config(env: &Env, config: &HbGateConfig) {
let key = HbGateKey::Config;
let key = HbGateKey::HbConfig;
env.storage().persistent().set(&key, config);
env.storage().persistent().extend_ttl(
&key,
Expand Down Expand Up @@ -715,7 +715,7 @@ pub fn update_oracle_heartbeat(env: Env, status: u32) -> Result<(), ContractErro
.storage()
.persistent()
.get(&DataKeyCore::Oracle)
.ok_or(ContractError::OracleNotSet)?;
.ok_or(ContractError::AdminNotSet)?;
oracle.require_auth();

let ts = env.ledger().timestamp();
Expand Down Expand Up @@ -816,6 +816,11 @@ pub fn get_protocol_health(env: Env) -> ProtocolHealthStatus {

let schema_version = _schema_version(&env).unwrap_or(1);

// Issue #274: surface allowlist-gated access mode in the composite
// status so an indexer/dashboard can tell a deliberately-restricted
// protocol apart from an unhealthy one.
let access_restricted = crate::access_control::is_access_control_enabled(env.clone());

let mut issues: u32 = 0;
if paused {
issues += 1;
Expand All @@ -826,6 +831,9 @@ pub fn get_protocol_health(env: Env) -> ProtocolHealthStatus {
if has_active_round && active_round_phase == 3 {
issues += 1;
}
if access_restricted {
issues += 1;
}

let status_code = if paused {
1u32 // PAUSED
Expand All @@ -835,6 +843,8 @@ pub fn get_protocol_health(env: Env) -> ProtocolHealthStatus {
2u32 // ORACLE_STALE
} else if has_active_round && active_round_phase == 3 {
3u32 // ROUND_STALE
} else if access_restricted {
6u32 // ACCESS_RESTRICTED
} else if !has_active_round {
4u32 // NO_ACTIVE_ROUND
} else {
Expand Down Expand Up @@ -1044,9 +1054,9 @@ pub fn batch_touch_ttl(env: Env, keys: Vec<DataKeyCore>) -> Result<u32, Contract
&env,
&admin,
symbol_short!("batch_t"),
ContractError::UnsupportedDataKeyForTtlTouch,
ContractError::InvalidMode,
);
return Err(ContractError::UnsupportedDataKeyForTtlTouch);
return Err(ContractError::InvalidMode);
}
if env.storage().persistent().has(&key) {
env.storage()
Expand Down Expand Up @@ -1136,12 +1146,12 @@ pub(crate) fn _validate_quorum_config(cfg: &OracleQuorumConfig) -> Result<(), Co
if cfg.min_observations < DEFAULT_ORACLE_QUORUM_MIN_OBSERVATIONS
|| cfg.min_observations > MAX_ORACLE_OBSERVATIONS
{
return Err(ContractError::TooFewObservations);
return Err(ContractError::OracleDeviationExceeded);
}
if cfg.quorum_threshold < DEFAULT_ORACLE_QUORUM_THRESHOLD
|| cfg.quorum_threshold > cfg.min_observations
{
return Err(ContractError::InsufficientOracleQuorum);
return Err(ContractError::OracleDeviationExceeded);
}
if cfg.outlier_threshold_bps == 0 || cfg.outlier_threshold_bps > 10_000 {
return Err(ContractError::WindowOutOfRange);
Expand Down Expand Up @@ -1201,22 +1211,22 @@ pub fn reclaim_expired_pending_winnings(env: Env, user: Address) -> Result<i128,
&env,
&admin,
symbol_short!("reclaim"),
ContractError::ExpiryNotConfigured,
ContractError::PendingWinningsNotExpired,
);
return Err(ContractError::ExpiryNotConfigured);
return Err(ContractError::PendingWinningsNotExpired);
}

// Read pending winnings.
let pending_key = DataKey::PendingWinnings(user.clone());
let pending_key = DataKeyScoped::PendingWinnings(user.clone());
let pending: i128 = env.storage().persistent().get(&pending_key).unwrap_or(0);
if pending == 0 {
_emit_action_rejected(
&env,
&admin,
symbol_short!("reclaim"),
ContractError::PendingWinningsNotFound,
ContractError::PendingWinningsNotExpired,
);
return Err(ContractError::PendingWinningsNotFound);
return Err(ContractError::PendingWinningsNotExpired);
}

// Read the ledger when this entry was last updated.
Expand All @@ -1225,7 +1235,7 @@ pub fn reclaim_expired_pending_winnings(env: Env, user: Address) -> Result<i128,
.storage()
.persistent()
.get(&updated_key)
.ok_or(ContractError::PendingWinningsNotFound)?;
.ok_or(ContractError::PendingWinningsNotExpired)?;

let current_ledger = env.ledger().sequence();
let age = current_ledger.saturating_sub(updated_at);
Expand Down
36 changes: 23 additions & 13 deletions contracts/src/betting.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ pub fn create_round(env: Env, start_price: u128, mode: Option<u32>) -> Result<()
.unwrap_or(0);
let round_id = last_round_id
.checked_add(1)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
env.storage()
.persistent()
.set(&DataKeyCore::LastRoundId, &round_id);
Expand All @@ -126,10 +126,10 @@ pub fn create_round(env: Env, start_price: u128, mode: Option<u32>) -> Result<()
let start_ledger = env.ledger().sequence();
let bet_end_ledger = start_ledger
.checked_add(bet_ledgers)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
let end_ledger = start_ledger
.checked_add(run_ledgers)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;

let start_timestamp = env.ledger().timestamp();

Expand Down Expand Up @@ -191,7 +191,7 @@ pub fn create_next_from_template(env: Env) -> Result<u64, ContractError> {
.storage()
.persistent()
.get(&DataKeyCore::RoundTemplate)
.ok_or(ContractError::NoRoundTemplate)
.ok_or(ContractError::NoActiveRound)
.inspect_err(|&e| {
_emit_action_rejected(&env, &admin, symbol_short!("nxttmpl"), e);
})?;
Expand Down Expand Up @@ -291,7 +291,7 @@ pub fn place_bet(
// Deduct balance
let new_balance = user_balance
.checked_sub(amount)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
_set_balance(&env, user.clone(), new_balance);

// Write single-user position key
Expand Down Expand Up @@ -319,13 +319,13 @@ pub fn place_bet(
round.pool_up = round
.pool_up
.checked_add(amount)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
}
BetSide::Down => {
round.pool_down = round
.pool_down
.checked_add(amount)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
}
}
env.storage()
Expand All @@ -342,6 +342,8 @@ pub fn place_bet(
(user, round.round_id, amount, side_value),
);

crate::commitments::_advance_pool_commitment(&env, &round);

Ok(())
}

Expand Down Expand Up @@ -438,7 +440,7 @@ pub fn place_precision_prediction(
// Deduct balance
let new_balance = user_balance
.checked_sub(amount)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
_set_balance(&env, user.clone(), new_balance);

// Write single-user prediction key
Expand All @@ -461,6 +463,9 @@ pub fn place_precision_prediction(
(user, round.round_id, predicted_price, amount),
);

crate::commitments::_add_precision_commit_stake(&env, round.round_id, amount);
crate::commitments::_advance_pool_commitment(&env, &round);

Ok(())
}

Expand Down Expand Up @@ -557,7 +562,7 @@ pub fn commit_prediction(
// Deduct balance
let new_balance = user_balance
.checked_sub(amount)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
_set_balance(&env, user.clone(), new_balance);

// Store commitment
Expand Down Expand Up @@ -586,6 +591,9 @@ pub fn commit_prediction(
(user, round.round_id, hash, amount),
);

crate::commitments::_add_precision_commit_stake(&env, round.round_id, amount);
crate::commitments::_advance_pool_commitment(&env, &round);

Ok(())
}

Expand Down Expand Up @@ -665,6 +673,8 @@ pub fn reveal_prediction(
(user, round.round_id, predicted_price, commitment.amount),
);

crate::commitments::_advance_pool_commitment(&env, &round);

Ok(())
}

Expand Down Expand Up @@ -739,28 +749,28 @@ pub fn cash_out_early(env: Env, user: Address) -> Result<(), ContractError> {
let penalty_bps_i128 = penalty_bps as i128;
let forfeit = stake
.checked_mul(penalty_bps_i128)
.ok_or(ContractError::Overflow)?
.ok_or(ContractError::PayoutOverflow)?
/ BPS_DENOMINATOR;

// If forfeit rounds down to zero (very small stake relative to penalty),
// user gets full refund — still remove position from pool.
let cashout = stake
.checked_sub(forfeit)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;

// Deduct full stake from the appropriate pool
match position.side {
BetSide::Up => {
round.pool_up = round
.pool_up
.checked_sub(stake)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
}
BetSide::Down => {
round.pool_down = round
.pool_down
.checked_sub(stake)
.ok_or(ContractError::Overflow)?;
.ok_or(ContractError::PayoutOverflow)?;
}
}
env.storage()
Expand Down
Loading