Loading [Contrib]/a11y/accessibility-menu.js
Skip to content

ISynthetix¶

Description¶

Source: contracts/interfaces/ISynthetix.sol

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 issuer, bytes32 currencyKey) 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 issuer) view returns (uint256 maxIssuable)

Visibility

external

State Mutability

view

remainingIssuableSynths¶

Source

Details

Signature

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

Visibility

external

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

External Functions¶

burnSecondary¶

Source

Details

Signature

burnSecondary(address account, uint256 amount)

Visibility

external

State Mutability

``

burnSynths¶

Source

Details

Signature

burnSynths(uint256 amount)

Visibility

external

State Mutability

``

burnSynthsOnBehalf¶

Source

Details

Signature

burnSynthsOnBehalf(address burnForAddress, uint256 amount)

Visibility

external

State Mutability

``

burnSynthsToTarget¶

Source

Details

Signature

burnSynthsToTarget()

Visibility

external

State Mutability

``

burnSynthsToTargetOnBehalf¶

Source

Details

Signature

burnSynthsToTargetOnBehalf(address burnForAddress)

Visibility

external

State Mutability

``

exchange¶

Source

Details

Signature

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

Visibility

external

State Mutability

``

exchangeAtomically¶

Source

Details

Signature

exchangeAtomically(bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey, bytes32 trackingCode, uint256 minAmount) returns (uint256 amountReceived)

Visibility

external

State Mutability

``

exchangeOnBehalf¶

Source

Details

Signature

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

Visibility

external

State Mutability

``

exchangeOnBehalfWithTracking¶

Source

Details

Signature

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

Visibility

external

State Mutability

``

exchangeWithTracking¶

Source

Details

Signature

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

Visibility

external

State Mutability

``

exchangeWithTrackingForInitiator¶

Source

Details

Signature

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

Visibility

external

State Mutability

``

exchangeWithVirtual¶

Source

Details

Signature

exchangeWithVirtual(bytes32 sourceCurrencyKey, uint256 sourceAmount, bytes32 destinationCurrencyKey, bytes32 trackingCode) returns (uint256 amountReceived, contract IVirtualSynth vSynth)

Visibility

external

State Mutability

``

issueMaxSynths¶

Source

Details

Signature

issueMaxSynths()

Visibility

external

State Mutability

``

issueMaxSynthsOnBehalf¶

Source

Details

Signature

issueMaxSynthsOnBehalf(address issueForAddress)

Visibility

external

State Mutability

``

issueSynths¶

Source

Details

Signature

issueSynths(uint256 amount)

Visibility

external

State Mutability

``

issueSynthsOnBehalf¶

Source

Details

Signature

issueSynthsOnBehalf(address issueForAddress, uint256 amount)

Visibility

external

State Mutability

``

liquidateDelinquentAccount¶

Source

Details

Signature

liquidateDelinquentAccount(address account) returns (bool)

Visibility

external

State Mutability

``

liquidateSelf¶

Source

Details

Signature

liquidateSelf() returns (bool)

Visibility

external

State Mutability

``

mint¶

Source

Details

Signature

mint() returns (bool)

Visibility

external

State Mutability

``

mintSecondary¶

Source

Details

Signature

mintSecondary(address account, uint256 amount)

Visibility

external

State Mutability

``

mintSecondaryRewards¶

Source

Details

Signature

mintSecondaryRewards(uint256 amount)

Visibility

external

State Mutability

``

settle¶

Source

Details

Signature

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

Visibility

external

State Mutability

``