Function redeem::pallet::dispatchables::cancel_redeem
source · pub fn cancel_redeem<T: Config>(redeem_id: H256, reimburse: bool)
Expand description
If a redeem request is not completed on time, the redeem request can be cancelled. The user that initially requested the redeem process calls this function to obtain the Vault’s collateral as compensation for not transferring the BTC back to their address.
Arguments
origin
- sender of the transactionredeem_id
- identifier of redeem request as output from request_redeemreimburse
- specifying if the user wishes to be reimbursed in collateral and slash the Vault, or wishes to keep the tokens (and retry Redeem with another Vault)
Warning: Doc-Only
This function is an automatically generated, and is doc-only, uncallable
stub. See the real version in
Pallet::cancel_redeem
.