From 51351d0a4f4672cf0bde4ac262933d4dc77299fc Mon Sep 17 00:00:00 2001 From: Aaron Blankstein Date: Wed, 19 Jul 2023 08:46:01 -0500 Subject: [PATCH] docs: add module documentation to pox-locking --- pox-locking/src/lib.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/pox-locking/src/lib.rs b/pox-locking/src/lib.rs index 17d921fa3..9d8da8148 100644 --- a/pox-locking/src/lib.rs +++ b/pox-locking/src/lib.rs @@ -14,6 +14,17 @@ // You should have received a copy of the GNU General Public License // along with this program. If not, see . +//! Special contract-call handling for updating PoX locks on user +//! accounts. +//! +//! This library provides a contract-call special case handler +//! `crate::handle_contract_call_special_cases()` which matches a +//! contract-call result against zero-address published contracts +//! `pox`, `pox-2`, and `pox-3`. For each of those contracts, it +//! checks if the function called requires applying or updating the +//! `STXBalance` struct's locks, and if the function was successfully +//! invoked. If so, it updates the PoX lock. + use clarity::boot_util::boot_code_id; use clarity::vm::contexts::GlobalContext; use clarity::vm::errors::{Error as ClarityError, RuntimeErrorType};