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:
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:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
account String.<EthAddress>
time BigNumber
quantity BigNumber
txParams TxParams

balanceOf(account)

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

getNextVestingEntry(account)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
account String.<EthAddress>
Returns:
uint256[2]

getNextVestingIndex(account)

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

getNextVestingQuantity(account)

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

getNextVestingTime(account)

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

getVestingQuantity(account, index)

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

getVestingScheduleEntry(account, index)

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

getVestingTime(account, index)

Source:
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:
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:
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:
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:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
quantity BigNumber
txParams TxParams