IAllowlistV1

Kiln

Allowlist Interface (v1)

This interface exposes methods to handle the list of allowed recipients.

Methods

allow

function allow(address[] _accounts, uint256[] _permissions) external nonpayable

Sets the allowlisting status for one or more accounts

The permission value is overridden and not updated

Parameters

getAllower

function getAllower() external view returns (address)

Retrieves the allower address

Returns

getPermissions

function getPermissions(address _account) external view returns (uint256)

This method retrieves the raw permission value

Parameters

Returns

hasPermission

function hasPermission(address _account, uint256 _mask) external view returns (bool)

This method returns true if the user has the expected permission ignoring any deny list membership

Parameters

Returns

initAllowlistV1

function initAllowlistV1(address _admin, address _allower) external nonpayable

Initializes the allowlist

Parameters

isAllowed

function isAllowed(address _account, uint256 _mask) external view returns (bool)

This method returns true if the user has the expected permission and is not in the deny list

Parameters

Returns

isDenied

function isDenied(address _account) external view returns (bool)

This method returns true if the user is in the deny list

Parameters

Returns

onlyAllowed

function onlyAllowed(address _account, uint256 _mask) external view

This method should be used as a modifier and is expected to revert if the user hasn't got the required permission or if the user is in the deny list.

Parameters

setAllower

function setAllower(address _newAllowerAddress) external nonpayable

Changes the allower address

Parameters

Events

SetAllower

event SetAllower(address indexed allower)

The stored allower address has been changed

Parameters

SetAllowlistPermissions

event SetAllowlistPermissions(address[] accounts, uint256[] permissions)

The permissions of several accounts have changed

Parameters

Errors

Denied

error Denied(address _account)

The account is denied access

Parameters

InvalidAlloweeCount

error InvalidAlloweeCount()

The provided accounts list is empty

MismatchedAlloweeAndStatusCount

error MismatchedAlloweeAndStatusCount()

The provided accounts and permissions list have different lengths