⚠️ Deprecation Notice

ModuleSDK was developed by Rhinestone and is no longer actively supported. For new projects, we recommend using the Rhinestone SDK instead.

→ Rhinestone SDK Documentation (opens in a new tab)

getAccountLockerHook

Get the module installation data for the account locker hook. This hook enforces the resource locks on the account.

Usage

const module = getAccountLockerHook({
  isOmniMode: true,
})

Parameters

isOmniMode

• Type: boolean

Whether the account locker is in omni mode, meaning that the entire user balance is locked.

hook (optional)

• Type: Address (opens in a new tab)

The address of the hook module to associate with. This is only required for the Kernel account.

Returns

module

• Type: Module (opens in a new tab)

The account locker hook module object.