Ownable2StepMsgSender API Reference

Ownable2StepMsgSender is a convenience wrapper around Ownable2Step that initializes ownership to msg.sender.

Use this contract when the deployer should be the initial owner, without explicitly specifying the owner address.

Usage Boundary

You use this contract when deploying contracts that should be owned by the deployer.

Contracts inherit this implementation to initialize ownership automatically.
Use this variant when deployment is performed directly by the intended owner.
Use Ownable2Step instead if ownership must be assigned to a different address at deployment.
You are responsible for ensuring the deployer address is the correct initial owner.

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

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

If you have not installed the package:

npm install @chainlink/contracts@latest

contract Ownable2StepMsgSender is Ownable2Step

constructor()
  Ownable2Step(msg.sender, address(0))
{}

Initializes ownership with msg.sender as the owner.

All other functions are inherited from Ownable2Step.

No new events declared.

For a cross-contract event index, see Events.

No new custom errors declared.

For a cross-contract error index, see Errors.

Ownership is assigned to the deployer (msg.sender) at deployment time.
If deployed through a factory or proxy, the factory or proxy may become the owner instead of the intended user.
Ownership transfer follows the two-step acceptance process inherited from Ownable2Step.

This contract simplifies ownership initialization for common deployment patterns.
This contract relies on msg.sender at deployment time to determine the initial owner.
If deployed via a factory, the factory contract becomes the owner unless ownership is reassigned.
When used behind a proxy, ownership may be assigned during proxy initialization rather than contract deployment.
It should not be used when ownership needs to be assigned to a different address at deployment.
Ensure deployment is executed from the correct address to avoid unintended ownership assignment.