BaseSynthetix¶
Description¶
Source: contracts/BaseSynthetix.sol
Variables¶
DECIMALS
¶
Type: uint8
TOKEN_NAME
¶
Type: string
TOKEN_SYMBOL
¶
Type: string
sUSD
¶
Type: bytes32
Constructor¶
constructor
¶
Details
Signature
constructor(address payable _proxy, contract TokenState _tokenState, address _owner, uint256 _totalSupply, address _resolver)
Visibility
public
State Mutability
``
Views¶
anySynthOrSNXRateIsInvalid
¶
Details
Signature
anySynthOrSNXRateIsInvalid() view returns (bool anyRateInvalid)
Visibility
external
State Mutability
view
availableCurrencyKeys
¶
Details
Signature
availableCurrencyKeys() view returns (bytes32[])
Visibility
external
State Mutability
view
availableSynthCount
¶
Details
Signature
availableSynthCount() view returns (uint256)
Visibility
external
State Mutability
view
availableSynths
¶
Details
Signature
availableSynths(uint256 index) view returns (contract ISynth)
Visibility
external
State Mutability
view
collateral
¶
Details
Signature
collateral(address account) view returns (uint256)
Visibility
external
State Mutability
view
collateralisationRatio
¶
Details
Signature
collateralisationRatio(address _issuer) view returns (uint256)
Visibility
external
State Mutability
view
debtBalanceOf
¶
Details
Signature
debtBalanceOf(address account, bytes32 currencyKey) view returns (uint256)
Visibility
external
State Mutability
view
getFirstNonZeroEscrowIndex
¶
Details
Signature
getFirstNonZeroEscrowIndex(address account) view returns (uint256)
Visibility
external
State Mutability
view
isWaitingPeriod
¶
Details
Signature
isWaitingPeriod(bytes32 currencyKey) view returns (bool)
Visibility
external
State Mutability
view
maxIssuableSynths
¶
Details
Signature
maxIssuableSynths(address account) view returns (uint256 maxIssuable)
Visibility
external
State Mutability
view
remainingIssuableSynths
¶
Details
Signature
remainingIssuableSynths(address account) view returns (uint256 maxIssuable, uint256 alreadyIssued, uint256 totalSystemDebt)
Visibility
external
State Mutability
view
resolverAddressesRequired
¶
Details
Signature
resolverAddressesRequired() view returns (bytes32[] addresses)
Visibility
public
State Mutability
view
synths
¶
Details
Signature
synths(bytes32 currencyKey) view returns (contract ISynth)
Visibility
external
State Mutability
view
synthsByAddress
¶
Details
Signature
synthsByAddress(address synthAddress) view returns (bytes32)
Visibility
external
State Mutability
view
totalIssuedSynths
¶
Details
Signature
totalIssuedSynths(bytes32 currencyKey) view returns (uint256)
Visibility
external
State Mutability
view
totalIssuedSynthsExcludeOtherCollateral
¶
Details
Signature
totalIssuedSynthsExcludeOtherCollateral(bytes32 currencyKey) view returns (uint256)
Visibility
external
State Mutability
view
transferableSynthetix
¶
Details
Signature
transferableSynthetix(address account) view returns (uint256 transferable)
Visibility
external
State Mutability
view
Restricted Functions¶
emitExchangeRebate
¶
Details
Signature
emitExchangeRebate(address account, bytes32 currencyKey, uint256 amount)
Visibility
external
State Mutability
``
Modifiers
emitExchangeReclaim
¶
Details
Signature
emitExchangeReclaim(address account, bytes32 currencyKey, uint256 amount)
Visibility
external
State Mutability
``
Modifiers
emitExchangeTracking
¶
Details
Signature
emitExchangeTracking(bytes32 trackingCode, bytes32 toCurrencyKey, uint256 toAmount, uint256 fee)
Visibility
external
State Mutability
``
Modifiers
emitSynthExchange
¶
Details
Signature
emitSynthExchange(address account, bytes32 fromCurrencyKey, uint256 fromAmount, bytes32 toCurrencyKey, uint256 toAmount, address toAddress)
Visibility
external
State Mutability
``
Modifiers
migrateEscrowContractBalance
¶
Details
Signature
migrateEscrowContractBalance()
Visibility
external
State Mutability
``
Requires
Modifiers
transfer
¶
Details
Signature
transfer(address to, uint256 value) returns (bool)
Visibility
external
State Mutability
``
Modifiers
transferFrom
¶
Details
Signature
transferFrom(address from, address to, uint256 value) returns (bool)
Visibility
external
State Mutability
``
Modifiers
Internal Functions¶
_canTransfer
¶
Details
Signature
_canTransfer(address account, uint256 value) view returns (bool)
Visibility
internal
State Mutability
view
_isInternalTransferCaller
¶
Details
Signature
_isInternalTransferCaller(address caller) view returns (bool)
Visibility
internal
State Mutability
view
_liquidateDelinquentAccount
¶
Details
Signature
_liquidateDelinquentAccount(address account, uint256 escrowStartIndex, address liquidatorAccount) returns (bool)
Visibility
internal
State Mutability
``
Requires
_notImplemented
¶
Details
Signature
_notImplemented() pure
Visibility
internal
State Mutability
pure
_onlyProxyOrInternal
¶
Details
Signature
_onlyProxyOrInternal()
Visibility
internal
State Mutability
``
emitAccountLiquidated
¶
Details
Signature
emitAccountLiquidated(address account, uint256 snxRedeemed, uint256 amountLiquidated, address liquidator)
Visibility
internal
State Mutability
``
exchanger
¶
Details
Signature
exchanger() view returns (contract IExchanger)
Visibility
internal
State Mutability
view
issuer
¶
Details
Signature
issuer() view returns (contract IIssuer)
Visibility
internal
State Mutability
view
liquidator
¶
Details
Signature
liquidator() view returns (contract ILiquidator)
Visibility
internal
State Mutability
view
liquidatorRewards
¶
Details
Signature
liquidatorRewards() view returns (contract ILiquidatorRewards)
Visibility
internal
State Mutability
view
rewardEscrowV2
¶
Details
Signature
rewardEscrowV2() view returns (contract IRewardEscrowV2)
Visibility
internal
State Mutability
view
rewardsDistribution
¶
Details
Signature
rewardsDistribution() view returns (contract IRewardsDistribution)
Visibility
internal
State Mutability
view
systemStatus
¶
Details
Signature
systemStatus() view returns (contract ISystemStatus)
Visibility
internal
State Mutability
view
External Functions¶
burnSecondary
¶
Details
Signature
burnSecondary(address, uint256)
Visibility
external
State Mutability
``
burnSynths
¶
Details
Signature
burnSynths(uint256 amount)
Visibility
external
State Mutability
``
Modifiers
burnSynthsOnBehalf
¶
Details
Signature
burnSynthsOnBehalf(address burnForAddress, uint256 amount)
Visibility
external
State Mutability
``
Modifiers
burnSynthsToTarget
¶
Details
Signature
burnSynthsToTarget()
Visibility
external
State Mutability
``
Modifiers
burnSynthsToTargetOnBehalf
¶
Details
Signature
burnSynthsToTargetOnBehalf(address burnForAddress)
Visibility
external
State Mutability
``
Modifiers
exchange
¶
Details
Signature
exchange(bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey) returns (uint256 amountReceived)
Visibility
external
State Mutability
``
Modifiers
exchangeAtomically
¶
Details
Signature
exchangeAtomically(bytes32, uint256, bytes32, bytes32, uint256) returns (uint256)
Visibility
external
State Mutability
``
exchangeOnBehalf
¶
Details
Signature
exchangeOnBehalf(address exchangeForAddress, bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey) returns (uint256 amountReceived)
Visibility
external
State Mutability
``
Modifiers
exchangeOnBehalfWithTracking
¶
Details
Signature
exchangeOnBehalfWithTracking(address exchangeForAddress, bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey, address rewardAddress, bytes32 trackingCode) returns (uint256 amountReceived)
Visibility
external
State Mutability
``
Modifiers
exchangeWithTracking
¶
Details
Signature
exchangeWithTracking(bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey, address rewardAddress, bytes32 trackingCode) returns (uint256 amountReceived)
Visibility
external
State Mutability
``
Modifiers
exchangeWithTrackingForInitiator
¶
Details
Signature
exchangeWithTrackingForInitiator(bytes32, uint256, bytes32, address, bytes32) returns (uint256)
Visibility
external
State Mutability
``
exchangeWithVirtual
¶
Details
Signature
exchangeWithVirtual(bytes32, uint256, bytes32, bytes32) returns (uint256, contract IVirtualSynth)
Visibility
external
State Mutability
``
issueMaxSynths
¶
Details
Signature
issueMaxSynths()
Visibility
external
State Mutability
``
Modifiers
issueMaxSynthsOnBehalf
¶
Details
Signature
issueMaxSynthsOnBehalf(address issueForAddress)
Visibility
external
State Mutability
``
Modifiers
issueSynths
¶
Details
Signature
issueSynths(uint256 amount)
Visibility
external
State Mutability
``
Modifiers
issueSynthsOnBehalf
¶
Details
Signature
issueSynthsOnBehalf(address issueForAddress, uint256 amount)
Visibility
external
State Mutability
``
Modifiers
liquidateDelinquentAccount
¶
Details
Signature
liquidateDelinquentAccount(address account) returns (bool)
Visibility
external
State Mutability
``
Modifiers
liquidateDelinquentAccountEscrowIndex
¶
Details
Signature
liquidateDelinquentAccountEscrowIndex(address account, uint256 escrowStartIndex) returns (bool)
Visibility
external
State Mutability
``
Modifiers
liquidateSelf
¶
Details
Signature
liquidateSelf() returns (bool)
Visibility
external
State Mutability
``
Requires
Modifiers
migrateAccountBalances
¶
Details
Signature
migrateAccountBalances(address account) returns (uint256 totalEscrowRevoked, uint256 totalLiquidBalance)
Visibility
external
State Mutability
``
Requires
Modifiers
mint
¶
Details
Signature
mint() returns (bool)
Visibility
external
State Mutability
``
mintSecondary
¶
Details
Signature
mintSecondary(address, uint256)
Visibility
external
State Mutability
``
mintSecondaryRewards
¶
Details
Signature
mintSecondaryRewards(uint256)
Visibility
external
State Mutability
``
revokeAllEscrow
¶
Details
Signature
revokeAllEscrow(address account)
Visibility
external
State Mutability
``
Requires
Modifiers
settle
¶
Details
Signature
settle(bytes32 currencyKey) returns (uint256 reclaimed, uint256 refunded, uint256 numEntriesSettled)
Visibility
external
State Mutability
``
Modifiers
Modifiers¶
exchangeActive
¶
Signature: exchangeActive(bytes32 src, bytes32 dest)
issuanceActive
¶
onlyExchanger
¶
onlyProxyOrInternal
¶
systemActive
¶
Events¶
AccountLiquidated
¶
Signature: AccountLiquidated(address account, uint256 snxRedeemed, uint256 amountLiquidated, address liquidator)
ExchangeRebate
¶
Signature: ExchangeRebate(address account, bytes32 currencyKey, uint256 amount)
ExchangeReclaim
¶
Signature: ExchangeReclaim(address account, bytes32 currencyKey, uint256 amount)
ExchangeTracking
¶
Signature: ExchangeTracking(bytes32 trackingCode, bytes32 toCurrencyKey, uint256 toAmount, uint256 fee)
SynthExchange
¶
Signature: SynthExchange(address account, bytes32 fromCurrencyKey, uint256 fromAmount, bytes32 toCurrencyKey, uint256 toAmount, address toAddress)