new FeePool(contractSettings)
- Source:
Parameters:
Name | Type | Description |
---|---|---|
contractSettings |
ContractSettings |
Methods
acceptOwnership(txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
txParams |
TxParams |
amountReceivedFromExchange(value)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
value |
BigNumber |
Returns:
BigNumber
amountReceivedFromTransfer(value)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
value |
BigNumber |
Returns:
BigNumber
claimFees(currencyKey, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
currencyKey |
bytes4 | |
txParams |
TxParams |
Returns:
boolean
closeCurrentFeePeriod(txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
txParams |
TxParams |
currentPenalty(account)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
account |
String.<EthAddress> |
Returns:
BigNumber
exchangedAmountToReceive(value)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
value |
BigNumber |
Returns:
BigNumber
exchangeFeeIncurred(value)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
value |
BigNumber |
Returns:
BigNumber
exchangeFeeRate()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
FEE_ADDRESS()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
String
FEE_PERIOD_LENGTH()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
Number
feeAuthority()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
String
feePaid(currencyKey, amount, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
currencyKey |
bytes4 | |
amount |
BigNumber | |
txParams |
TxParams |
feePeriodDuration()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
feesAvailable(account, currencyKey)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
account |
String.<EthAddress> | |
currencyKey |
bytes4 |
Returns:
BigNumber
feesByPeriod(account)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
account |
String.<EthAddress> |
Returns:
uint256[6]
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
lastFeeWithdrawal(address)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
address |
String.<EthAddress> |
Returns:
BigNumber
MAX_EXCHANGE_FEE_RATE()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
MAX_FEE_PERIOD_DURATION()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
MAX_TRANSFER_FEE_RATE()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
MIN_FEE_PERIOD_DURATION()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
nextFeePeriodId()
- 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 |
owner()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
String
proxy()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
String
recentFeePeriods(uint256)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
uint256 |
BigNumber |
Returns:
Object
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
setExchangeFeeRate(_exchangeFeeRate, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
_exchangeFeeRate |
BigNumber | |
txParams |
TxParams |
setFeeAuthority(_feeAuthority, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
_feeAuthority |
String.<EthAddress> | |
txParams |
TxParams |
setFeePeriodDuration(_feePeriodDuration, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
_feePeriodDuration |
BigNumber | |
txParams |
TxParams |
setMessageSender(sender, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
sender |
String.<EthAddress> | |
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 |
setSynthetix(_synthetix, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
_synthetix |
String.<EthAddress> | |
txParams |
TxParams |
setTransferFeeRate(_transferFeeRate, txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
_transferFeeRate |
BigNumber | |
txParams |
TxParams |
synthetix()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
String
terminateSelfDestruct(txParams)
- Source:
Transaction (consumes gas, requires signer)
Parameters:
Name | Type | Description |
---|---|---|
txParams |
TxParams |
totalFeesAvailable(currencyKey)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
currencyKey |
bytes4 |
Returns:
BigNumber
transferFeeIncurred(value)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
value |
BigNumber |
Returns:
BigNumber
transferFeeRate()
- Source:
Call (no gas consumed, doesn't require signer)
Returns:
BigNumber
transferredAmountToReceive(value)
- Source:
Call (no gas consumed, doesn't require signer)
Parameters:
Name | Type | Description |
---|---|---|
value |
BigNumber |
Returns:
BigNumber