SynthetixEscrow

SynthetixEscrow

new SynthetixEscrow(contractSettings)

Source:
Parameters:
Name Type Description
contractSettings ContractSettings

Methods

acceptOwnership(txParams)

Source:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
txParams TxParams

addVestingSchedule(account, times, quantities, txParams)

Source:
Assumes that the quantities are nonzero and that the sequence of timestamps is strictly increasing. This may only be called by the owner during the contract's setup period., Construct a vesting schedule to release a quantities of SNX over a series of intervals.
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
account String.<EthAddress>
times Array.<uint256>
quantities Array.<uint256>
txParams TxParams

appendVestingEntry(account, time, quantity, txParams)

Source:
A call to this should be accompanied by either enough balance already available in this contract, or a corresponding call to synthetix.endow(), to ensure that when the funds are withdrawn, there is enough balance, as well as correctly calculating the fees. This may only be called by the owner during the contract's setup period. Note; although this function could technically be used to produce unbounded arrays, it's only in the foundation's command to add to these lists., Add a new vesting entry at a given time and quantity to an account's schedule.
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
account String.<EthAddress>
time BigNumber
quantity BigNumber
txParams TxParams

balanceOf(account)

Source:
A simple alias to totalVestedAccountBalance: provides ERC20 balance integration.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
BigNumber

getNextVestingEntry(account)

Source:
Obtain the next schedule entry that will vest for a given user.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
uint256[2]

getNextVestingIndex(account)

Source:
Obtain the index of the next schedule entry that will vest for a given user.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
BigNumber

getNextVestingQuantity(account)

Source:
Obtain the quantity which the next schedule entry will vest for a given user.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
BigNumber

getNextVestingTime(account)

Source:
Obtain the time at which the next schedule entry will vest for a given user.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
BigNumber

getVestingQuantity(account, index)

Source:
Get the quantity of SNX associated with a given schedule entry.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
index BigNumber
Returns:
BigNumber

getVestingScheduleEntry(account, index)

Source:
Get a particular schedule entry for an account.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
index BigNumber
Returns:
uint256[2]

getVestingTime(account, index)

Source:
Get the time at which a given schedule entry will vest.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
index BigNumber
Returns:
BigNumber

nominatedOwner()

Source:
Call (no gas consumed, doesn't require signer)
Returns:
String

nominateNewOwner(_owner, txParams)

Source:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
_owner String.<EthAddress>
txParams TxParams

numVestingEntries(account)

Source:
The number of vesting dates in an account's schedule.
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
BigNumber

owner()

Source:
Call (no gas consumed, doesn't require signer)
Returns:
String

purgeAccount(account, txParams)

Source:
Destroy the vesting information associated with an account.
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
account String.<EthAddress>
txParams TxParams

setSynthetix(_synthetix, txParams)

Source:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
_synthetix String.<EthAddress>
txParams TxParams

synthetix()

Source:
Call (no gas consumed, doesn't require signer)
Returns:
String

totalVestedAccountBalance(address)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
address String.<EthAddress>
Returns:
BigNumber

totalVestedBalance()

Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber

vest(txParams)

Source:
Allow a user to withdraw any SNX in their schedule that have vested.
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
txParams TxParams

vestingSchedules(address, p1, p2)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
address String.<EthAddress>
p1 p1
p2 p2
Returns:
BigNumber

withdrawSynthetix(quantity, txParams)

Source:
This may only be called by the owner during the contract's setup period., Withdraws a quantity of SNX back to the synthetix contract.
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
quantity BigNumber
txParams TxParams