kylefang/stacks-puppet-node
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-puppet-node.git synced 2026-01-12 22:43:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add module documentation to pox-locking

Browse Source
This commit is contained in:
Aaron Blankstein
2023-07-19 08:46:01 -05:00
committed by Aaron Blankstein
parent 18f4555b60
commit 51351d0a4f
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pox-locking/src/lib.rs
View File

@@ -14,6 +14,17 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! 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};