Skip to content

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)

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

revokeFrom

Source

Details

Signature

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

Visibility

external

State Mutability

``

Requires

Modifiers

Emits

setAccountMergingDuration

Source

Details

Signature

setAccountMergingDuration(uint256 duration)

Visibility

external

State Mutability

``

Requires

Modifiers

Emits

setMaxAccountMergingWindow

Source

Details

Signature

setMaxAccountMergingWindow(uint256 duration)

Visibility

external

State Mutability

``

Modifiers

Emits

setMaxEscrowDuration

Source

Details

Signature

setMaxEscrowDuration(uint256 duration)

Visibility

external

State Mutability

``

Modifiers

Emits

startMergingWindow

Source

Details

Signature

startMergingWindow()

Visibility

external

State Mutability

``

Modifiers

Emits

Internal Functions

_appendVestingEntry

Source

Details

Signature

_appendVestingEntry(address account, uint256 quantity, uint256 duration)

Visibility

internal

State Mutability

``

Requires

Emits

_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

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

Emits

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

Emits

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)