Synthetix

Synthetix

new Synthetix(contractSettings)

Source:
Parameters:
Name Type Description
contractSettings ContractSettings

Methods

acceptOwnership(txParams)

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

addSynth(synth, txParams)

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

allowance(owner, spender)

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

approve(spender, value, txParams)

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

availableSynthCount()

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

availableSynths(uint256)

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

balanceOf(account)

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

burnSynths(currencyKey, amount, txParams)

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

collateral(account)

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

collateralisationRatio(issuer)

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

debtBalanceOf(issuer, currencyKey)

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

decimals()

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

effectiveValue(sourceCurrencyKey, sourceAmount, destinationCurrencyKey)

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

escrow()

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

exchange(sourceCurrencyKey, sourceAmount, destinationCurrencyKey, destinationAddress, txParams)

Source:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
sourceCurrencyKey bytes4
sourceAmount BigNumber
destinationCurrencyKey bytes4
destinationAddress String.<EthAddress>
txParams TxParams
Returns:
boolean

exchangeRates()

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

feePool()

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

issueMaxSynths(currencyKey, txParams)

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

issueSynths(currencyKey, amount, txParams)

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

maxIssuableSynths(issuer, currencyKey)

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

name()

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

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

owner()

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

proxy()

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

remainingIssuableSynths(issuer, currencyKey)

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

removeSynth(currencyKey, txParams)

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

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

setEscrow(_escrow, txParams)

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

setExchangeRates(_exchangeRates, txParams)

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

setMessageSender(sender, txParams)

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

setPreferredCurrency(currencyKey, txParams)

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

setProxy(_proxy, txParams)

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

setSelfDestructBeneficiary(_beneficiary, txParams)

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

setSynthetixState(_synthetixState, txParams)

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

setTokenState(_tokenState, txParams)

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

symbol()

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

synthetixState()

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

synthInitiatedExchange(from, sourceCurrencyKey, sourceAmount, destinationCurrencyKey, destinationAddress, txParams)

Source:
Transaction (consumes gas, requires signer)
Parameters:
Name Type Description
from String.<EthAddress>
sourceCurrencyKey bytes4
sourceAmount BigNumber
destinationCurrencyKey bytes4
destinationAddress String.<EthAddress>
txParams TxParams
Returns:
boolean

synthInitiatedFeePayment(from, sourceCurrencyKey, sourceAmount, txParams)

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

synths(bytes4)

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

terminateSelfDestruct(txParams)

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

tokenState()

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

totalIssuedSynths(currencyKey)

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

totalSupply()

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

transfer(to, value, data, txParams)

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

transfer(to, value, txParams)

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

transferableSynthetix(account)

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

transferFrom(from, to, value, data, txParams)

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

transferFrom(from, to, value, txParams)

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