AuthorizedCallers API Reference

Summary

AuthorizedCallers is an owner-managed access control helper contract.

It maintains a storage-backed allowlist of authorized addresses and provides:

Owner-controlled updates to the allowlist.
A reusable internal validation helper (_validateCaller).
A modifier (onlyAuthorizedCallers) to restrict functions to authorized callers.

This contract is designed to be inherited by other contracts requiring restricted execution paths.

@chainlink/contracts/src/v0.8/shared/access/AuthorizedCallers.sol

import {AuthorizedCallers} from "@chainlink/contracts/src/v0.8/shared/access/AuthorizedCallers.sol";

EnumerableSet.AddressSet internal s_authorizedCallers;

Maintains the set of authorized caller addresses.

constructor(address[] memory authorizedCallers)

Initializes the authorized caller set by internally applying:

AuthorizedCallerArgs({
  addedCallers: authorizedCallers,
  removedCallers: new address
})

function getAllAuthorizedCallers()
  external
  view
  returns (address[] memory)

Returns the full set of authorized callers.

function applyAuthorizedCallerUpdates(
  AuthorizedCallerArgs memory authorizedCallerArgs
) external virtual onlyOwner

Owner-only update function.

Processing order:

Internally calls _applyAuthorizedCallerUpdates.

modifier onlyAuthorizedCallers()

Restricts function execution to addresses in s_authorizedCallers.

Internally calls _validateCaller().

event AuthorizedCallerAdded(address caller);
event AuthorizedCallerRemoved(address caller);

error UnauthorizedCaller(address caller);
error ZeroAddressNotAllowed();

struct AuthorizedCallerArgs {
  address[] addedCallers;
  address[] removedCallers;
}

Used when updating the allowlist.

function _applyAuthorizedCallerUpdates(
  AuthorizedCallerArgs memory authorizedCallerArgs
) internal

Behavior:

Iterates over removedCallers:
- If removal succeeds, emits AuthorizedCallerRemoved.
Iterates over addedCallers:
- Reverts ZeroAddressNotAllowed() if caller == address(0).
- Adds to set and emits AuthorizedCallerAdded.

function _validateCaller() internal view

Reverts:

UnauthorizedCaller(msg.sender)

If msg.sender is not present in s_authorizedCallers.