Source – Alkane 2:89557 — SUBFROST Explorer

crates/fire-constants/src/lib.rs11,283 B

//! FIRE System Constants
//!
//! This crate defines all constants for the FIRE system including:
//! - Template IDs for deploying FIRE system contracts using CREATERESERVED
//! - Token economics (supply, emissions, multipliers)
//! - Block-based duration constants (1 block ≈ 10 min on Bitcoin mainnet)
#![no_std]
// ============================================================================
// Block Duration Constants
// Aligned with Bitcoin halving cycle (210,000 blocks):
// FIRE halving every 105,000 blocks (half of Bitcoin halving)
// Every 2nd FIRE halving coincides with a Bitcoin halving
// All series durations divide evenly into HALVING_INTERVAL
// ============================================================================
/// Bitcoin halving interval
pub const BITCOIN_HALVING: u64 = 210_000;
/// FIRE halving interval.
/// Mainnet: 105,000 (half of Bitcoin halving). Every 2nd FIRE halving aligns to a BTC halving.
/// Devnet (cfg feature "devnet"): 200 blocks — short enough to test epoch transitions on regtest
/// while keeping all derived constants (WEEK=2, MONTH=8, SIX_MONTHS=50, YEAR=100, TWO_YEARS=200)
/// integer-divisible and large enough that lock_end < expiry is achievable for short stakes.
#[cfg(not(feature = "devnet"))]
pub const HALVING_INTERVAL: u64 = BITCOIN_HALVING / 2; // 105,000
#[cfg(feature = "devnet")]
pub const HALVING_INTERVAL: u64 = 200;
/// FIRE activation block — staking and bonding both start here.
/// Mainnet: 950,420 — first epoch shortened to align with BTC halving at 1,050,000.
/// Devnet: 100 — low enough to start staking shortly after fresh-chain init.
/// Either way, factory init can override via the `activation_block` parameter.
#[cfg(not(feature = "devnet"))]
pub const ACTIVATION_BLOCK: u64 = 950_420;
#[cfg(feature = "devnet")]
pub const ACTIVATION_BLOCK: u64 = 100;
/// One year in blocks (half of halving interval)
pub const YEAR: u64 = HALVING_INTERVAL / 2; // 52,500
/// Six months in blocks
pub const SIX_MONTHS: u64 = HALVING_INTERVAL / 4; // 26,250
/// Three months in blocks
pub const THREE_MONTHS: u64 = HALVING_INTERVAL / 8; // 13,125
/// One month in blocks
pub const MONTH: u64 = HALVING_INTERVAL / 24; // 4,375
/// One week in blocks
pub const WEEK: u64 = HALVING_INTERVAL / 100; // 1,050
/// Legacy alias
pub const TWO_YEARS: u64 = HALVING_INTERVAL;
// ============================================================================
// Token Decimal Constants
// ============================================================================
/// FIRE uses 8 decimal places (like Bitcoin)
pub const DECIMALS: u32 = 8;
/// Decimal factor: 10^8 = 100,000,000
pub const DECIMAL_FACTOR: u128 = 100_000_000;
// ============================================================================
// Supply Constants (with 8 decimals)
// 0% premine — 100% emission (staking + bonding)
// ============================================================================
/// Maximum supply: 2.1M FIRE
pub const MAX_SUPPLY: u128 = 2_100_000 * DECIMAL_FACTOR;
/// Staking emission pool: 85% (1,785,000 FIRE)
pub const STAKING_EMISSION_POOL: u128 = 1_785_000 * DECIMAL_FACTOR;
/// Bonding emission pool: 15% (315,000 FIRE)
pub const BONDING_EMISSION_POOL: u128 = 315_000 * DECIMAL_FACTOR;
// ============================================================================
// Emission Constants (per block)
// ============================================================================
/// Total emission: 1,050,000 FIRE per epoch (105,000 blocks)
/// Halves each epoch. Geometric sum converges to 2,100,000 FIRE (= MAX_SUPPLY).
///
/// Staking rate (85%): 892,500 FIRE per epoch
/// = 892,500e8 / 105,000 = 850,000,000 base units/block
pub const STAKING_EMISSION_RATE: u128 = 850_000_000;
/// Bonding rate (15%): 157,500 FIRE per epoch
/// = 157,500e8 / 105,000 = 150,000,000 base units/block
pub const BONDING_EMISSION_RATE: u128 = 150_000_000;
/// Precision for reward calculations (18 decimals)
pub const PRECISION: u128 = 1_000_000_000_000_000_000; // 1e18
// ============================================================================
// Lock Multiplier Constants (basis points: 100 = 1.0x)
// ============================================================================
/// Base multiplier (1.0x) for no lock
pub const MULTIPLIER_BASE: u128 = 100;
/// Week lock multiplier (1.25x)
pub const MULTIPLIER_WEEK: u128 = 125;
/// Month lock multiplier (1.5x)
pub const MULTIPLIER_MONTH: u128 = 150;
/// Three month lock multiplier (2.0x)
pub const MULTIPLIER_THREE_MONTHS: u128 = 200;
/// Six month lock multiplier (2.5x)
pub const MULTIPLIER_SIX_MONTHS: u128 = 250;
/// Year lock multiplier (3.0x)
pub const MULTIPLIER_YEAR: u128 = 300;
// ============================================================================
// Historical Slot Constants (kept for reference / external tooling)
//
// These were the pinned proxy AlkaneIds used by the original (pre-factory)
// deploy. The current deploy assigns these as dynamic `2:N` via CREATECHILD
// — see `.deploy-ids.env` for the live values. The constants here are NOT
// read by contract logic at runtime; they remain in case external indexers
// or migration scripts need to reason about the old layout.
// ============================================================================
#[deprecated(note = "Proxy IDs are dynamic 2:N — read from .deploy-ids.env after deploy")]
pub const FIRE_TOKEN: u128 = 0x100; // 256
#[deprecated(note = "Proxy IDs are dynamic 2:N — read from .deploy-ids.env after deploy")]
pub const FIRE_STAKING: u128 = 0x101; // 257
#[deprecated(note = "Proxy IDs are dynamic 2:N — read from .deploy-ids.env after deploy")]
pub const FIRE_TREASURY: u128 = 0x102; // 258
#[deprecated(note = "Proxy IDs are dynamic 2:N — read from .deploy-ids.env after deploy")]
pub const FIRE_BONDING: u128 = 0x103; // 259
#[deprecated(note = "Proxy IDs are dynamic 2:N — read from .deploy-ids.env after deploy")]
pub const FIRE_REDEMPTION: u128 = 0x104; // 260
// ============================================================================
// FIRE Architecture IDs
//
// Implementation slots (4:512-518, 4:521) are pinned CREATERESERVED. The
// proxies and beacons that delegate to them are spawned via CREATECHILD and
// receive dynamic `2:N` IDs at deploy time (saved to `.deploy-ids.env`).
// ============================================================================
/// FIRE Token logic implementation
pub const FIRE_TOKEN_IMPL: u128 = 0x200; // 512
/// FIRE Staking Factory logic implementation
pub const FIRE_STAKING_FACTORY_IMPL: u128 = 0x201; // 513
/// FIRE Treasury logic implementation
pub const FIRE_TREASURY_IMPL: u128 = 0x202; // 514
/// FIRE Bonding logic implementation
pub const FIRE_BONDING_IMPL: u128 = 0x203; // 515
/// FIRE Redemption logic implementation
pub const FIRE_REDEMPTION_IMPL: u128 = 0x204; // 516
/// FIRE Price Oracle logic implementation
pub const FIRE_PRICE_ORACLE_IMPL: u128 = 0x205; // 517
/// FIRE Staking logic implementation (for beacon)
pub const FIRE_STAKING_IMPL: u128 = 0x206; // 518
#[deprecated(note = "Staking beacon is dynamic 2:N — read STAKING_BEACON_ID from .deploy-ids.env")]
pub const FIRE_STAKING_BEACON: u128 = 0x207; // 519
/// Shared beacon-proxy template at 4:520 — cloned per epoch (and per stake)
/// via CREATECHILD. Same bytecode is used for staking-clones AND position NFTs;
/// behaviour differs only in which beacon each clone is initialized with.
pub const FIRE_STAKING_BPROXY: u128 = 0x208; // 520
/// Upgradeable proxy opcodes (alkanes-std-upgradeable / beacon)
pub const PROXY_OPCODE_INITIALIZE: u128 = 32767; // 0x7FFF
pub const PROXY_OPCODE_UPGRADE: u128 = 32766; // 0x7FFE
pub const PROXY_OPCODE_FORWARD: u128 = 36863; // 0x8FFF
/// Beacon implementation query opcode
pub const BEACON_OPCODE_IMPLEMENTATION: u128 = 32765; // 0x7FFD
// ============================================================================
// Infrastructure Contract Template IDs
// ============================================================================
/// Auth Token Factory template ID
pub const AUTH_TOKEN_FACTORY: u128 = 0xffed; // 65517
/// AMM Pool Template ID (for factory cloning)
pub const AMM_POOL_TEMPLATE: u128 = 0xffef; // 65519
/// AMM Factory Logic Implementation template ID
pub const AMM_FACTORY_LOGIC: u128 = 0xbef0; // 48880
/// Pool Beacon Proxy template ID
pub const POOL_BEACON_PROXY: u128 = 0xbeac1; // 781001
/// Pool Upgradeable Beacon template ID
pub const POOL_UPGRADEABLE_BEACON: u128 = 0xbeac0; // 781000
// ============================================================================
// Well-Known Token IDs (Mainnet)
// ============================================================================
/// DIESEL token block
pub const DIESEL_BLOCK: u128 = 2;
/// DIESEL token tx
pub const DIESEL_TX: u128 = 0;
/// frBTC token block
pub const FRBTC_BLOCK: u128 = 32;
/// frBTC token tx
pub const FRBTC_TX: u128 = 0;
// ============================================================================
// Helper Functions
// ============================================================================
/// Returns the deployment target for a template ID
#[inline]
pub const fn deploy_target(template_id: u128) -> (u128, u128) {
(3, template_id)
}
/// Returns the deployed contract ID for a template ID
#[inline]
pub const fn deployed_id(template_id: u128) -> (u128, u128) {
(4, template_id)
}
#[cfg(test)]
#[allow(deprecated)] // historical slot constants tested for stability
mod tests {
use super::*;
#[test]
fn test_supply_constants() {
assert_eq!(
STAKING_EMISSION_POOL + BONDING_EMISSION_POOL,
MAX_SUPPLY
);
}
#[test]
fn test_fire_contract_ids_are_sequential() {
assert_eq!(FIRE_TOKEN, 0x100);
assert_eq!(FIRE_STAKING, FIRE_TOKEN + 1);
assert_eq!(FIRE_TREASURY, FIRE_STAKING + 1);
assert_eq!(FIRE_BONDING, FIRE_TREASURY + 1);
assert_eq!(FIRE_REDEMPTION, FIRE_BONDING + 1);
}
#[test]
fn test_block_constants() {
assert_eq!(HALVING_INTERVAL, 105_000);
assert_eq!(YEAR, 52_500);
assert_eq!(SIX_MONTHS, 26_250);
assert_eq!(THREE_MONTHS, 13_125);
assert_eq!(MONTH, 4_375);
assert_eq!(WEEK, 1_050);
assert_eq!(HALVING_INTERVAL, BITCOIN_HALVING / 2);
}
#[test]
fn test_series_fit_in_epoch() {
assert_eq!(HALVING_INTERVAL % YEAR, 0); // 2 per epoch
assert_eq!(HALVING_INTERVAL % SIX_MONTHS, 0); // 4 per epoch
assert_eq!(HALVING_INTERVAL % THREE_MONTHS, 0); // 8 per epoch
assert_eq!(HALVING_INTERVAL % MONTH, 0); // 24 per epoch
}
#[test]
fn test_emission_rates() {
// Staking: 892,500 FIRE per epoch
assert_eq!(STAKING_EMISSION_RATE * HALVING_INTERVAL as u128, 892_500 * DECIMAL_FACTOR);
// Bonding: 157,500 FIRE per epoch
assert_eq!(BONDING_EMISSION_RATE * HALVING_INTERVAL as u128, 157_500 * DECIMAL_FACTOR);
}
#[test]
fn test_deploy_target() {
assert_eq!(deploy_target(FIRE_TOKEN), (3, 0x100));
}
#[test]
fn test_deployed_id() {
assert_eq!(deployed_id(FIRE_TOKEN), (4, 0x100));
}
}

Verified Source