Skip to content

BaseSynthetix

Description

Source: contracts/BaseSynthetix.sol

Variables

DECIMALS

Source

Type: uint8

TOKEN_NAME

Source

Type: string

TOKEN_SYMBOL

Source

Type: string

sUSD

Source

Type: bytes32

Constructor

constructor

Source

Details

Signature

constructor(address payable _proxy, contract TokenState _tokenState, address _owner, uint256 _totalSupply, address _resolver)

Visibility

public

State Mutability

``

Views

anySynthOrSNXRateIsInvalid

Source

Details

Signature

anySynthOrSNXRateIsInvalid() view returns (bool anyRateInvalid)

Visibility

external

State Mutability

view

availableCurrencyKeys

Source

Details

Signature

availableCurrencyKeys() view returns (bytes32[])

Visibility

external

State Mutability

view

availableSynthCount

Source

Details

Signature

availableSynthCount() view returns (uint256)

Visibility

external

State Mutability

view

availableSynths

Source

Details

Signature

availableSynths(uint256 index) view returns (contract ISynth)

Visibility

external

State Mutability

view

collateral

Source

Details

Signature

collateral(address account) view returns (uint256)

Visibility

external

State Mutability

view

collateralisationRatio

Source

Details

Signature

collateralisationRatio(address _issuer) view returns (uint256)

Visibility

external

State Mutability

view

debtBalanceOf

Source

Details

Signature

debtBalanceOf(address account, bytes32 currencyKey) view returns (uint256)

Visibility

external

State Mutability

view

getFirstNonZeroEscrowIndex

Source

Details

Signature

getFirstNonZeroEscrowIndex(address account) view returns (uint256)

Visibility

external

State Mutability

view

isWaitingPeriod

Source

Details

Signature

isWaitingPeriod(bytes32 currencyKey) view returns (bool)

Visibility

external

State Mutability

view

maxIssuableSynths

Source

Details

Signature

maxIssuableSynths(address account) view returns (uint256 maxIssuable)

Visibility

external

State Mutability

view

remainingIssuableSynths

Source

Details

Signature

remainingIssuableSynths(address account) view returns (uint256 maxIssuable, uint256 alreadyIssued, uint256 totalSystemDebt)

Visibility

external

State Mutability

view

resolverAddressesRequired

Source

Details

Signature

resolverAddressesRequired() view returns (bytes32[] addresses)

Visibility

public

State Mutability

view

synths

Source

Details

Signature

synths(bytes32 currencyKey) view returns (contract ISynth)

Visibility

external

State Mutability

view

synthsByAddress

Source

Details

Signature

synthsByAddress(address synthAddress) view returns (bytes32)

Visibility

external

State Mutability

view

totalIssuedSynths

Source

Details

Signature

totalIssuedSynths(bytes32 currencyKey) view returns (uint256)

Visibility

external

State Mutability

view

totalIssuedSynthsExcludeOtherCollateral

Source

Details

Signature

totalIssuedSynthsExcludeOtherCollateral(bytes32 currencyKey) view returns (uint256)

Visibility

external

State Mutability

view

transferableSynthetix

Source

Details

Signature

transferableSynthetix(address account) view returns (uint256 transferable)

Visibility

external

State Mutability

view

Restricted Functions

emitExchangeRebate

Source

Details

Signature

emitExchangeRebate(address account, bytes32 currencyKey, uint256 amount)

Visibility

external

State Mutability

``

Modifiers

emitExchangeReclaim

Source

Details

Signature

emitExchangeReclaim(address account, bytes32 currencyKey, uint256 amount)

Visibility

external

State Mutability

``

Modifiers

emitExchangeTracking

Source

Details

Signature

emitExchangeTracking(bytes32 trackingCode, bytes32 toCurrencyKey, uint256 toAmount, uint256 fee)

Visibility

external

State Mutability

``

Modifiers

emitSynthExchange

Source

Details

Signature

emitSynthExchange(address account, bytes32 fromCurrencyKey, uint256 fromAmount, bytes32 toCurrencyKey, uint256 toAmount, address toAddress)

Visibility

external

State Mutability

``

Modifiers

migrateEscrowContractBalance

Source

Details

Signature

migrateEscrowContractBalance()

Visibility

external

State Mutability

``

Requires

Modifiers

transfer

Source

Details

Signature

transfer(address to, uint256 value) returns (bool)

Visibility

external

State Mutability

``

Modifiers

transferFrom

Source

Details

Signature

transferFrom(address from, address to, uint256 value) returns (bool)

Visibility

external

State Mutability

``

Modifiers

Internal Functions

_canTransfer

Source

Details

Signature

_canTransfer(address account, uint256 value) view returns (bool)

Visibility

internal

State Mutability

view

_isInternalTransferCaller

Source

Details

Signature

_isInternalTransferCaller(address caller) view returns (bool)

Visibility

internal

State Mutability

view

_liquidateDelinquentAccount

Source

Details

Signature

_liquidateDelinquentAccount(address account, uint256 escrowStartIndex, address liquidatorAccount) returns (bool)

Visibility

internal

State Mutability

``

Requires

_notImplemented

Source

Details

Signature

_notImplemented() pure

Visibility

internal

State Mutability

pure

_onlyProxyOrInternal

Source

Details

Signature

_onlyProxyOrInternal()

Visibility

internal

State Mutability

``

emitAccountLiquidated

Source

Details

Signature

emitAccountLiquidated(address account, uint256 snxRedeemed, uint256 amountLiquidated, address liquidator)

Visibility

internal

State Mutability

``

exchanger

Source

Details

Signature

exchanger() view returns (contract IExchanger)

Visibility

internal

State Mutability

view

issuer

Source

Details

Signature

issuer() view returns (contract IIssuer)

Visibility

internal

State Mutability

view

liquidator

Source

Details

Signature

liquidator() view returns (contract ILiquidator)

Visibility

internal

State Mutability

view

liquidatorRewards

Source

Details

Signature

liquidatorRewards() view returns (contract ILiquidatorRewards)

Visibility

internal

State Mutability

view

rewardEscrowV2

Source

Details

Signature

rewardEscrowV2() view returns (contract IRewardEscrowV2)

Visibility

internal

State Mutability

view

rewardsDistribution

Source

Details

Signature

rewardsDistribution() view returns (contract IRewardsDistribution)

Visibility

internal

State Mutability

view

systemStatus

Source

Details

Signature

systemStatus() view returns (contract ISystemStatus)

Visibility

internal

State Mutability

view

External Functions

burnSecondary

Source

Details

Signature

burnSecondary(address, uint256)

Visibility

external

State Mutability

``

burnSynths

Source

Details

Signature

burnSynths(uint256 amount)

Visibility

external

State Mutability

``

Modifiers

burnSynthsOnBehalf

Source

Details

Signature

burnSynthsOnBehalf(address burnForAddress, uint256 amount)

Visibility

external

State Mutability

``

Modifiers

burnSynthsToTarget

Source

Details

Signature

burnSynthsToTarget()

Visibility

external

State Mutability

``

Modifiers

burnSynthsToTargetOnBehalf

Source

Details

Signature

burnSynthsToTargetOnBehalf(address burnForAddress)

Visibility

external

State Mutability

``

Modifiers

exchange

Source

Details

Signature

exchange(bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey) returns (uint256 amountReceived)

Visibility

external

State Mutability

``

Modifiers

exchangeAtomically

Source

Details

Signature

exchangeAtomically(bytes32, uint256, bytes32, bytes32, uint256) returns (uint256)

Visibility

external

State Mutability

``

exchangeOnBehalf

Source

Details

Signature

exchangeOnBehalf(address exchangeForAddress, bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey) returns (uint256 amountReceived)

Visibility

external

State Mutability

``

Modifiers

exchangeOnBehalfWithTracking

Source

Details

Signature

exchangeOnBehalfWithTracking(address exchangeForAddress, bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey, address rewardAddress, bytes32 trackingCode) returns (uint256 amountReceived)

Visibility

external

State Mutability

``

Modifiers

exchangeWithTracking

Source

Details

Signature

exchangeWithTracking(bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey, address rewardAddress, bytes32 trackingCode) returns (uint256 amountReceived)

Visibility

external

State Mutability

``

Modifiers

exchangeWithTrackingForInitiator

Source

Details

Signature

exchangeWithTrackingForInitiator(bytes32, uint256, bytes32, address, bytes32) returns (uint256)

Visibility

external

State Mutability

``

exchangeWithVirtual

Source

Details

Signature

exchangeWithVirtual(bytes32, uint256, bytes32, bytes32) returns (uint256, contract IVirtualSynth)

Visibility

external

State Mutability

``

issueMaxSynths

Source

Details

Signature

issueMaxSynths()

Visibility

external

State Mutability

``

Modifiers

issueMaxSynthsOnBehalf

Source

Details

Signature

issueMaxSynthsOnBehalf(address issueForAddress)

Visibility

external

State Mutability

``

Modifiers

issueSynths

Source

Details

Signature

issueSynths(uint256 amount)

Visibility

external

State Mutability

``

Modifiers

issueSynthsOnBehalf

Source

Details

Signature

issueSynthsOnBehalf(address issueForAddress, uint256 amount)

Visibility

external

State Mutability

``

Modifiers

liquidateDelinquentAccount

Source

Details

Signature

liquidateDelinquentAccount(address account) returns (bool)

Visibility

external

State Mutability

``

Modifiers

liquidateDelinquentAccountEscrowIndex

Source

Details

Signature

liquidateDelinquentAccountEscrowIndex(address account, uint256 escrowStartIndex) returns (bool)

Visibility

external

State Mutability

``

Modifiers

liquidateSelf

Source

Details

Signature

liquidateSelf() returns (bool)

Visibility

external

State Mutability

``

Requires

Modifiers

migrateAccountBalances

Source

Details

Signature

migrateAccountBalances(address account) returns (uint256 totalEscrowRevoked, uint256 totalLiquidBalance)

Visibility

external

State Mutability

``

Requires

Modifiers

mint

Source

Details

Signature

mint() returns (bool)

Visibility

external

State Mutability

``

mintSecondary

Source

Details

Signature

mintSecondary(address, uint256)

Visibility

external

State Mutability

``

mintSecondaryRewards

Source

Details

Signature

mintSecondaryRewards(uint256)

Visibility

external

State Mutability

``

revokeAllEscrow

Source

Details

Signature

revokeAllEscrow(address account)

Visibility

external

State Mutability

``

Requires

Modifiers

settle

Source

Details

Signature

settle(bytes32 currencyKey) returns (uint256 reclaimed, uint256 refunded, uint256 numEntriesSettled)

Visibility

external

State Mutability

``

Modifiers

Modifiers

exchangeActive

Source

Signature: exchangeActive(bytes32 src, bytes32 dest)

issuanceActive

Source

onlyExchanger

Source

onlyProxyOrInternal

Source

systemActive

Source

Events

AccountLiquidated

Source

Signature: AccountLiquidated(address account, uint256 snxRedeemed, uint256 amountLiquidated, address liquidator)

ExchangeRebate

Source

Signature: ExchangeRebate(address account, bytes32 currencyKey, uint256 amount)

ExchangeReclaim

Source

Signature: ExchangeReclaim(address account, bytes32 currencyKey, uint256 amount)

ExchangeTracking

Source

Signature: ExchangeTracking(bytes32 trackingCode, bytes32 toCurrencyKey, uint256 toAmount, uint256 fee)

SynthExchange

Source

Signature: SynthExchange(address account, bytes32 fromCurrencyKey, uint256 fromAmount, bytes32 toCurrencyKey, uint256 toAmount, address toAddress)