Skip to main content

ILockKeyCancelHook

Functions to be implemented by a keyCancelHook.

Lock hooks are configured by calling setEventHooks on the lock.

Methods​

onKeyCancel​

function onKeyCancel(address operator, address to, uint256 refund) external nonpayable

If the lock owner has registered an implementer then this hook is called with every key cancel.

Parameters​

NameTypeDescription
operatoraddressthe msg.sender issuing the cancel
toaddressthe account which had the key canceled
refunduint256the amount sent to the to account (ETH or a ERC-20 token)