Depot

Depot

new Depot(contractSettings)

Source:
Parameters:
Name Type Description
contractSettings ContractSettings

Methods

acceptOwnership(txParams)

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

depositEndIndex()

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

deposits(uint256)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
uint256 BigNumber
Returns:
Object

depositStartIndex()

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

depositSynths(amount, txParams)

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

exchangeEtherForSynthetix(txParams)

Source:
Transaction (consumes gas, requires signer)
Payable (to enter ETH amount set txParams.value)
Parameters:
Name Type Description
txParams TxParams
Returns:
BigNumber

exchangeEtherForSynthetixAtRate(guaranteedEtherRate, guaranteedSynthetixRate, txParams)

Source:
Transaction (consumes gas, requires signer)
Payable (to enter ETH amount set txParams.value)
Parameters:
Name Type Description
guaranteedEtherRate BigNumber
guaranteedSynthetixRate BigNumber
txParams TxParams
Returns:
BigNumber

exchangeEtherForSynths(txParams)

Source:
Transaction (consumes gas, requires signer)
Payable (to enter ETH amount set txParams.value)
Parameters:
Name Type Description
txParams TxParams
Returns:
BigNumber

exchangeEtherForSynthsAtRate(guaranteedRate, txParams)

Source:
Transaction (consumes gas, requires signer)
Payable (to enter ETH amount set txParams.value)
Parameters:
Name Type Description
guaranteedRate BigNumber
txParams TxParams
Returns:
BigNumber

exchangeSynthsForSynthetix(synthAmount, txParams)

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

exchangeSynthsForSynthetixAtRate(synthAmount, guaranteedRate, txParams)

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

feePool()

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

fundsWallet()

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

initiateSelfDestruct(txParams)

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

initiationTime()

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

lastPauseTime()

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

lastPriceUpdateTime()

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

minimumDepositAmount()

Source:
Call (no gas consumed, doesn't require signer)
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

oracle()

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

ORACLE_FUTURE_LIMIT()

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

owner()

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

paused()

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

pricesAreStale()

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

priceStalePeriod()

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

selfDestruct(txParams)

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

SELFDESTRUCT_DELAY()

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

selfDestructBeneficiary()

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

selfDestructInitiated()

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

setFundsWallet(_fundsWallet, txParams)

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

setMinimumDepositAmount(_amount, txParams)

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

setOracle(_oracle, txParams)

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

setPaused(_paused, txParams)

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

setPriceStalePeriod(_time, txParams)

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

setSelfDestructBeneficiary(_beneficiary, txParams)

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

setSynth(_synth, txParams)

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

setSynthetix(_synthetix, txParams)

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

smallDeposits(address)

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

synth()

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

synthetix()

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

synthetixReceivedForEther(amount)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
amount BigNumber
Returns:
BigNumber

synthetixReceivedForSynths(amount)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
amount BigNumber
Returns:
BigNumber

synthsReceivedForEther(amount)

Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name Type Description
amount BigNumber
Returns:
BigNumber

terminateSelfDestruct(txParams)

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

tokenFallback(from, amount, data, txParams)

Source:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
from String.<EthAddress>
amount BigNumber
data bytes
txParams TxParams
Returns:
boolean

totalSellableDeposits()

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

updatePrices(newEthPrice, newSynthetixPrice, timeSent, txParams)

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

usdToEthPrice()

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

usdToSnxPrice()

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

withdrawMyDepositedSynths(txParams)

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

withdrawSynthetix(amount, txParams)

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