mSpellSender

Contract pulling MIM from the Withdrawer and distributing it.

mSPELL sender is responsible from claiming the fees in the Withdrawer (it is the owner of the withdrawer and can access funds this way) and distributing it to the 3 recipients:

• the Treasury (based on the treasuryPercentage value)

• Staking contracts, divided into:

  • sSPELL (based on the amount of SPELL staked)

  • mSPELL (based on the total amount of SPELL staked on all chains)

For mSPELL specifically, the sender will bridge the funds to the mSpellStaking contracts in the right amount (based on the amount of SPELL staked) on all chains.

Constructor​

nonpayable​

Parameters

No parameters found in the constructor.

Functions​

• addMSpellRecipient

• addReporter

• bridgeMim

• changePurchaser

• checker

• claimOwnership

• isActiveChain

• isOperator

• lzReceive

• mSpellReporter

• owner

• pendingOwner

• recipients

• setOperator

• sspellBuyBack

• transferOwnership

• transferWithdrawer

• treasury

• treasuryPercentage

---

addMSpellRecipientnonpayable​

Parameters

Name	Type
recipient	address
chainId	uint256
chainIdLZ	uint256

Return values

No return values for this function.

addReporternonpayable​

Parameters

Name	Type
reporter	bytes
chainIdLZ	uint256

Return values

No return values for this function.

bridgeMimnonpayable​

Parameters

No parameters for this function.

Return values

No return values for this function.

changePurchasernonpayable​

Parameters

Name	Type
_purchaser	address
_treasury	address
_treasuryPercentage	uint256

Return values

No return values for this function.

checkerview​

Parameters

No parameters for this function.

Return values

Name	Type
canExec	bool
execPayload	bytes

claimOwnershipnonpayable​

Parameters

No parameters for this function.

Return values

No return values for this function.

isActiveChainview​

Parameters

Name	Type
/	uint256

Return values

Name	Type
isActive	uint8
position	uint32

isOperatorview​

Parameters

Name	Type
/	address

Return values

Name	Type
/	bool

lzReceivenonpayable​

Parameters

Name	Type
_srcChainId	uint16
_srcAddress	bytes
/	uint64
_payload	bytes

Return values

No return values for this function.

mSpellReporterview​

Parameters

Name	Type
/	uint256

Return values

Name	Type
/	bytes

ownerview​

Parameters

No parameters for this function.

Return values

Name	Type
/	address

pendingOwnerview​

Parameters

No parameters for this function.

Return values

Name	Type
/	address

recipientsview​

Parameters

Name	Type
/	uint256

Return values

Name	Type
recipient	address
chainId	uint32
chainIdLZ	uint32
lastUpdated	uint32
amountStaked	uint128

setOperatornonpayable​

Parameters

Name	Type
operator	address
status	bool

Return values

No return values for this function.

sspellBuyBackview​

Parameters

No parameters for this function.

Return values

Name	Type
/	address

transferOwnershipnonpayable​

Parameters

Name	Type
newOwner	address
direct	bool
renounce	bool

Return values

No return values for this function.

transferWithdrawernonpayable​

Parameters

Name	Type
newOwner	address

Return values

No return values for this function.

treasuryview​

Parameters

No parameters for this function.

Return values

Name	Type
/	address

treasuryPercentageview​

Parameters

No parameters for this function.

Return values

Name	Type
/	uint256

Events (for EVM logging)​

• LogAddRecipient

• LogBridgeToRecipient

• LogChangePurchaser

• LogSetOperator

• LogSetReporter

• LogSpellStakedReceived

• OwnershipTransferred

---

LogAddRecipient​

Parameters

Name	Type	Indexed
recipient	address	true
chainId	uint256	false
chainIdLZ	uint256	false

LogBridgeToRecipient​

Parameters

Name	Type	Indexed
recipient	address	true
amount	uint256	false
chainId	uint256	false

LogChangePurchaser​

Parameters

Name	Type	Indexed
_purchaser	address	false
_treasury	address	false
_treasuryPercentage	uint256	false

LogSetOperator​

Parameters

Name	Type	Indexed
operator	address	true
status	bool	false

LogSetReporter​

Parameters

Name	Type	Indexed
chainIdLZ	uint256	true
reporter	bytes	false

LogSpellStakedReceived​

Parameters

Name	Type	Indexed
srcChainId	uint16	false
timestamp	uint32	false
amount	uint128	false

OwnershipTransferred​

Parameters

Name	Type	Indexed
previousOwner	address	true
newOwner	address	true