BaseRewardEscrowV2

Description

Source: contracts/BaseRewardEscrowV2.sol

Variables

accountMergingDuration

_Source

Type: uint256

accountMergingStartTime

_Source

Type: uint256

maxAccountMergingDuration

_Source

Type: uint256

max_duration

_Source

Type: uint256

nominatedReceiver

_Source

Type: mapping(address => address)

permittedEscrowCreators

_Source

Type: mapping(address => bool)

Constructor

constructor

_Source

Details

Signature

constructor(address _owner, address _resolver)

Visibility

public

State Mutability

``

Views

accountMergingIsOpen

_Source

Details

Signature

accountMergingIsOpen() view returns (bool)

Visibility

public

State Mutability

view

accountVestingEntryIDs

_Source

Type: mapping(address => uint256[])

Details

Signature

accountVestingEntryIDs(address account, uint256 index) view returns (uint256)

Visibility

public

State Mutability

view

balanceOf

_Source

Details

Signature

balanceOf(address account) view returns (uint256)

Visibility

public

State Mutability

view

getAccountVestingEntryIDs

_Source

Details

Signature

getAccountVestingEntryIDs(address account, uint256 index, uint256 pageSize) view returns (uint256[])

Visibility

external

State Mutability

view

getVestingEntry

_Source

Details

Signature

getVestingEntry(address account, uint256 entryID) view returns (uint64 endTime, uint256 escrowAmount)

Visibility

external

State Mutability

view

getVestingEntryClaimable

_Source

Details

Signature

getVestingEntryClaimable(address account, uint256 entryID) view returns (uint256)

Visibility

external

State Mutability

view

getVestingQuantity

_Source

Details

Signature

getVestingQuantity(address account, uint256[] entryIDs) view returns (uint256 total)

Visibility

external

State Mutability

view

getVestingSchedules

_Source

Details

Signature

getVestingSchedules(address account, uint256 index, uint256 pageSize) view returns (struct VestingEntries.VestingEntryWithID[])

Visibility

external

State Mutability

view

nextEntryId

_Source

Type: uint256

Details

Signature

nextEntryId() view returns (uint256)

Visibility

external

State Mutability

view

numVestingEntries

_Source

Details

Signature

numVestingEntries(address account) view returns (uint256)

Visibility

public

State Mutability

view

resolverAddressesRequired

_Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

totalEscrowedAccountBalance

_Source

Type: mapping(address => uint256)

Details

Signature

totalEscrowedAccountBalance(address account) view returns (uint256)

Visibility

public

State Mutability

view

totalEscrowedBalance

_Source

Type: uint256

Details

Signature

totalEscrowedBalance() view returns (uint256)

Visibility

public

State Mutability

view

totalVestedAccountBalance

_Source

Type: mapping(address => uint256)

Details

Signature

totalVestedAccountBalance(address account) view returns (uint256)

Visibility

external

State Mutability

view

vestingSchedules

_Source

Type: mapping(address => mapping(uint256 => struct VestingEntries.VestingEntry))

Details

Signature

vestingSchedules(address account, uint256 entryId) view returns (struct VestingEntries.VestingEntry)

Visibility

public

State Mutability

view

Restricted Functions

appendVestingEntry

_Source

Details

Signature

appendVestingEntry(address account, uint256 quantity, uint256 duration)

Visibility

external

State Mutability

``

Modifiers

• onlyFeePool

revokeFrom

_Source

Details

Signature

revokeFrom(address account, address recipient, uint256 targetAmount, uint256 startIndex)

Visibility

external

State Mutability

``

Requires

• require(..., "account not set")

• require(..., "recipient not set")

• require(..., "entries sum less than target")

Modifiers

• onlySynthetix

Emits

• Revoked

setAccountMergingDuration

_Source

Details

Signature

setAccountMergingDuration(uint256 duration)

Visibility

external

State Mutability

``

Requires

• require(..., "exceeds max merging duration")

Modifiers

• onlyOwner

Emits

• AccountMergingDurationUpdated

setMaxAccountMergingWindow

_Source

Details

Signature

setMaxAccountMergingWindow(uint256 duration)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• MaxAccountMergingDurationUpdated

setMaxEscrowDuration

_Source

Details

Signature

setMaxEscrowDuration(uint256 duration)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• MaxEscrowDurationUpdated

setPermittedEscrowCreator

_Source

Details

Signature

setPermittedEscrowCreator(address creator, bool permitted)

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

startMergingWindow

_Source

Details

Signature

startMergingWindow()

Visibility

external

State Mutability

``

Modifiers

• onlyOwner

Emits

• AccountMergingStarted

Internal Functions

_appendVestingEntry

_Source

Details

Signature

_appendVestingEntry(address account, uint256 quantity, uint256 duration)

Visibility

internal

State Mutability

``

Requires

• require(..., "Quantity cannot be zero")

• require(..., "Cannot escrow with 0 duration OR above max_duration")

• require(..., "Must be enough balance in the contract to provide for the vesting entry")

Emits

• VestingEntryCreated

_claimableAmount

_Source

Details

Signature

_claimableAmount(struct VestingEntries.VestingEntry _entry) view returns (uint256)

Visibility

internal

State Mutability

view

_notImplemented

_Source

Details

Signature

_notImplemented() pure

Visibility

internal

State Mutability

pure

_subtractAndTransfer

_Source

Details

Signature

_subtractAndTransfer(address subtractFrom, address transferTo, uint256 amount)

Visibility

internal

State Mutability

``

feePool

_Source

Details

Signature

feePool() view returns (contract IFeePool)

Visibility

internal

State Mutability

view

issuer

_Source

Details

Signature

issuer() view returns (contract IIssuer)

Visibility

internal

State Mutability

view

state

_Source

Details

Signature

state() view returns (contract IRewardEscrowV2Storage)

Visibility

internal

State Mutability

view

synthetixERC20

_Source

Details

Signature

synthetixERC20() view returns (contract IERC20)

Visibility

internal

State Mutability

view

External Functions

burnForMigration

_Source

Details

Signature

burnForMigration(address, uint256[]) returns (uint256, struct VestingEntries.VestingEntry[])

Visibility

external

State Mutability

``

createEscrowEntry

_Source

Details

Signature

createEscrowEntry(address beneficiary, uint256 deposit, uint256 duration)

Visibility

external

State Mutability

``

Requires

• require(..., "Cannot create escrow with address(0)")

• require(..., "Only permitted escrow creators can create escrow entries")

• require(..., "token transfer failed")

importVestingEntries

_Source

Details

Signature

importVestingEntries(address, uint256, struct VestingEntries.VestingEntry[])

Visibility

external

State Mutability

``

mergeAccount

_Source

Details

Signature

mergeAccount(address from, uint256[] entryIDs)

Visibility

external

State Mutability

``

Requires

• require(..., "Account merging has ended")

• require(..., "Cannot merge accounts with debt")

• require(..., "Address is not nominated to merge")

Emits

• AccountMerged

migrateAccountEscrowBalances

_Source

Details

Signature

migrateAccountEscrowBalances(address[], uint256[], uint256[])

Visibility

external

State Mutability

``

migrateVestingSchedule

_Source

Details

Signature

migrateVestingSchedule(address)

Visibility

external

State Mutability

``

nominateAccountToMerge

_Source

Details

Signature

nominateAccountToMerge(address account)

Visibility

external

State Mutability

``

Requires

• require(..., "Cannot nominate own account to merge")

• require(..., "Account merging has ended")

• require(..., "Cannot merge accounts with debt")

Emits

• NominateAccountToMerge

vest

_Source

Details

Signature

vest(uint256[] entryIDs)

Visibility

external

State Mutability

``

Modifiers

onlyFeePool

_Source

onlySynthetix

_Source

Events

AccountMerged

_Source

Signature: AccountMerged(address accountToMerge, address destinationAddress, uint256 escrowAmountMerged, uint256[] entryIDs, uint256 time)

AccountMergingDurationUpdated

_Source

Signature: AccountMergingDurationUpdated(uint256 newDuration)

AccountMergingStarted

_Source

Signature: AccountMergingStarted(uint256 time, uint256 endTime)

MaxAccountMergingDurationUpdated

_Source

Signature: MaxAccountMergingDurationUpdated(uint256 newDuration)

MaxEscrowDurationUpdated

_Source

Signature: MaxEscrowDurationUpdated(uint256 newDuration)

NominateAccountToMerge

_Source

Signature: NominateAccountToMerge(address account, address destination)

Revoked

_Source

Signature: Revoked(address account, address recipient, uint256 targetAmount, uint256 startIndex, uint256 endIndex)

Vested

_Source

Signature: Vested(address beneficiary, uint256 time, uint256 value)

VestingEntryCreated

_Source

Signature: VestingEntryCreated(address beneficiary, uint256 time, uint256 value, uint256 duration, uint256 entryID)