IFundLockEvents.sol

View Source: contracts/fund-lock/IFundLockEvents.sol

↘ Derived Contracts: FundLockMock, IElektroEvents, IFundLockStorage

IFundLockEvents

FundLockDeposit

Event fired after successful deposit to {FundLock}.

Parameters

Name	Type	Description
depositor	address	- address of the depositor (can be contract or user)
token	address	- address of the token deposited
amount	uint256	- amount of the token deposited See {FundLockBase._deposit()}

FundsToBeWithdrawn

Event fired with user's {withdraw()} request, which marks funds for release from FundLock.Do not confuse with {release()}!

Parameters

Name	Type	Description
beneficiary	address	- address of a user withdrawing
token	address	- address of the token to be marked for release
amount	uint256	- amount of token to be marked for release
totalSlotsUsed	uint256	- the amount of withdrawal requests (slots) used (out of 5 max) Each user is only allowed to make 5 withdrawal requests at once. See {FundLockUser.withdraw()}

FundsReleased

Event fired upon releasing funds (tokens) from FundLock to a user's wallet.

Parameters

Name	Type	Description
beneficiary	address	- address of the user to whom funds are released
token	address	- address of the token released
amount	uint256	- amount of token released
withdrawTimestamp	uint256	- time in seconds at which {withdraw()} request has been made See {FundLockUser.release()}

ReleaseLockSet

Event fired upod setting the {ReleaseLock} interval.

Parameters

Name	Type	Description
interval	uint256	- the amount of time in seconds which user has to wait between {withdraw()} and {release()}

TradeLockSet

Event fired upod setting the {TradeLock} interval.

Parameters

Name	Type	Description
interval	uint256	- the amount of time in seconds during which user's funds can still be used for trading after {withdraw()} request

BalanceUpdated

Event fired upon successful client balance update, which signifies the end of the settlement transaction.

Parameters

Name	Type	Description
user	address	- client's address for which balance has been updated
amount	int256	- amount by which balance has been updated
token	address	- token address for which balance has been updated
backendId	uint64	- Java Backend batch ID used for tracking

Functions