Properties
callStatic
callStatic: {
CONSTANT_INFLOW_NFT(overrides?): Promise<string>;
CONSTANT_OUTFLOW_NFT(overrides?): Promise<string>;
POOL_ADMIN_NFT(overrides?): Promise<string>;
POOL_MEMBER_NFT(overrides?): Promise<string>;
allowance(owner, spender, overrides?): Promise<BigNumber>;
approve(spender, amount, overrides?): Promise<boolean>;
authorizeOperator(operator, overrides?): Promise<void>;
balanceOf(account, overrides?): Promise<BigNumber>;
burn(amount, userData, overrides?): Promise<void>;
changeAdmin(newAdmin, overrides?): Promise<void>;
createAgreement(id, data, overrides?): Promise<void>;
decimals(overrides?): Promise<number>;
decreaseAllowance(spender, subtractedValue, overrides?): Promise<boolean>;
defaultOperators(overrides?): Promise<string[]>;
downgrade(amount, overrides?): Promise<void>;
downgradeTo(to, amount, overrides?): Promise<void>;
getAccountActiveAgreements(account, overrides?): Promise<string[]>;
getAdmin(overrides?): Promise<string>;
getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>;
getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>;
getHost(overrides?): Promise<string>;
getUnderlyingDecimals(overrides?): Promise<number>;
getUnderlyingToken(overrides?): Promise<string>;
granularity(overrides?): Promise<BigNumber>;
increaseAllowance(spender, addedValue, overrides?): Promise<boolean>;
initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<void>;
initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<void>;
isAccountCritical(account, timestamp, overrides?): Promise<boolean>;
isAccountCriticalNow(account, overrides?): Promise<boolean>;
isAccountSolvent(account, timestamp, overrides?): Promise<boolean>;
isAccountSolventNow(account, overrides?): Promise<boolean>;
isOperatorFor(operator, tokenHolder, overrides?): Promise<boolean>;
makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<void>;
name(overrides?): Promise<string>;
operationApprove(account, spender, amount, overrides?): Promise<void>;
operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<void>;
operationDowngrade(account, amount, overrides?): Promise<void>;
operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<void>;
operationSend(spender, recipient, amount, userData, overrides?): Promise<void>;
operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<void>;
operationUpgrade(account, amount, overrides?): Promise<void>;
operatorBurn(account, amount, userData, operatorData, overrides?): Promise<void>;
operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<void>;
realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
}>;
realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
timestamp: BigNumber;
}>;
revokeOperator(operator, overrides?): Promise<void>;
selfApproveFor(account, spender, amount, overrides?): Promise<void>;
selfBurn(account, amount, userData, overrides?): Promise<void>;
selfMint(account, amount, userData, overrides?): Promise<void>;
selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<void>;
send(recipient, amount, userData, overrides?): Promise<void>;
settleBalance(account, delta, overrides?): Promise<void>;
symbol(overrides?): Promise<string>;
terminateAgreement(id, dataLength, overrides?): Promise<void>;
toUnderlyingAmount(amount, overrides?): Promise<[BigNumber, BigNumber] & {
adjustedAmount: BigNumber;
underlyingAmount: BigNumber;
}>;
totalSupply(overrides?): Promise<BigNumber>;
transfer(recipient, amount, overrides?): Promise<boolean>;
transferAll(recipient, overrides?): Promise<void>;
transferFrom(sender, recipient, amount, overrides?): Promise<boolean>;
updateAgreementData(id, data, overrides?): Promise<void>;
updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<void>;
upgrade(amount, overrides?): Promise<void>;
upgradeTo(to, amount, userData, overrides?): Promise<void>;
}
Type declaration
CONSTANT_INFLOW_NFT:function
- CONSTANT_INFLOW_NFT(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
CONSTANT_OUTFLOW_NFT:function
- CONSTANT_OUTFLOW_NFT(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
POOL_ADMIN_NFT:function
- POOL_ADMIN_NFT(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
POOL_MEMBER_NFT:function
- POOL_MEMBER_NFT(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
allowance:function
- allowance(owner, spender, overrides?): Promise<BigNumber>
Parameters
owner: string
spender: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
approve:function
- approve(spender, amount, overrides?): Promise<boolean>
Parameters
spender: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
authorizeOperator:function
- authorizeOperator(operator, overrides?): Promise<void>
Parameters
operator: string
Optional overrides: CallOverrides
Returns Promise<void>
balanceOf:function
- balanceOf(account, overrides?): Promise<BigNumber>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
burn:function
- burn(amount, userData, overrides?): Promise<void>
Parameters
amount: BigNumberish
userData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
changeAdmin:function
- changeAdmin(newAdmin, overrides?): Promise<void>
Parameters
newAdmin: string
Optional overrides: CallOverrides
Returns Promise<void>
createAgreement:function
- createAgreement(id, data, overrides?): Promise<void>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: CallOverrides
Returns Promise<void>
decimals:function
- decimals(overrides?): Promise<number>
Parameters
Optional overrides: CallOverrides
Returns Promise<number>
decreaseAllowance:function
- decreaseAllowance(spender, subtractedValue, overrides?): Promise<boolean>
Parameters
spender: string
subtractedValue: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
defaultOperators:function
- defaultOperators(overrides?): Promise<string[]>
Parameters
Optional overrides: CallOverrides
Returns Promise<string[]>
downgrade:function
- downgrade(amount, overrides?): Promise<void>
Parameters
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
downgradeTo:function
- downgradeTo(to, amount, overrides?): Promise<void>
Parameters
to: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
getAccountActiveAgreements:function
- getAccountActiveAgreements(account, overrides?): Promise<string[]>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<string[]>
getAdmin:function
- getAdmin(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
getAgreementData:function
- getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>
Parameters
agreementClass: string
id: BytesLike
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<string[]>
getAgreementStateSlot:function
- getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>
Parameters
agreementClass: string
account: string
slotId: BigNumberish
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<string[]>
getHost:function
- getHost(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
getUnderlyingDecimals:function
- getUnderlyingDecimals(overrides?): Promise<number>
Parameters
Optional overrides: CallOverrides
Returns Promise<number>
getUnderlyingToken:function
- getUnderlyingToken(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
granularity:function
- granularity(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
increaseAllowance:function
- increaseAllowance(spender, addedValue, overrides?): Promise<boolean>
Parameters
spender: string
addedValue: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
initialize:function
- initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<void>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
Optional overrides: CallOverrides
Returns Promise<void>
initializeWithAdmin:function
- initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<void>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
admin: string
Optional overrides: CallOverrides
Returns Promise<void>
isAccountCritical:function
- isAccountCritical(account, timestamp, overrides?): Promise<boolean>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
isAccountCriticalNow:function
- isAccountCriticalNow(account, overrides?): Promise<boolean>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<boolean>
isAccountSolvent:function
- isAccountSolvent(account, timestamp, overrides?): Promise<boolean>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
isAccountSolventNow:function
- isAccountSolventNow(account, overrides?): Promise<boolean>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<boolean>
isOperatorFor:function
- isOperatorFor(operator, tokenHolder, overrides?): Promise<boolean>
Parameters
operator: string
tokenHolder: string
Optional overrides: CallOverrides
Returns Promise<boolean>
makeLiquidationPayoutsV2:function
- makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<void>
Parameters
id: BytesLike
liquidationTypeData: BytesLike
liquidatorAccount: string
useDefaultRewardAccount: boolean
targetAccount: string
rewardAmount: BigNumberish
targetAccountBalanceDelta: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
name:function
- name(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
operationApprove:function
- operationApprove(account, spender, amount, overrides?): Promise<void>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
operationDecreaseAllowance:function
- operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<void>
Parameters
account: string
spender: string
subtractedValue: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
operationDowngrade:function
- operationDowngrade(account, amount, overrides?): Promise<void>
Parameters
account: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
operationIncreaseAllowance:function
- operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<void>
Parameters
account: string
spender: string
addedValue: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
operationSend:function
- operationSend(spender, recipient, amount, userData, overrides?): Promise<void>
Parameters
spender: string
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
operationTransferFrom:function
- operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<void>
Parameters
account: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
operationUpgrade:function
- operationUpgrade(account, amount, overrides?): Promise<void>
Parameters
account: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
operatorBurn:function
- operatorBurn(account, amount, userData, operatorData, overrides?): Promise<void>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
operatorSend:function
- operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<void>
Parameters
sender: string
recipient: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
realtimeBalanceOf:function
- realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
}> Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
}>
realtimeBalanceOfNow:function
- realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
timestamp: BigNumber;
}> Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
timestamp: BigNumber;
}>
revokeOperator:function
- revokeOperator(operator, overrides?): Promise<void>
Parameters
operator: string
Optional overrides: CallOverrides
Returns Promise<void>
selfApproveFor:function
- selfApproveFor(account, spender, amount, overrides?): Promise<void>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
selfBurn:function
- selfBurn(account, amount, userData, overrides?): Promise<void>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
selfMint:function
- selfMint(account, amount, userData, overrides?): Promise<void>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
selfTransferFrom:function
- selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<void>
Parameters
sender: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
send:function
- send(recipient, amount, userData, overrides?): Promise<void>
Parameters
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
settleBalance:function
- settleBalance(account, delta, overrides?): Promise<void>
Parameters
account: string
delta: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
symbol:function
- symbol(overrides?): Promise<string>
Parameters
Optional overrides: CallOverrides
Returns Promise<string>
terminateAgreement:function
- terminateAgreement(id, dataLength, overrides?): Promise<void>
Parameters
id: BytesLike
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
toUnderlyingAmount:function
- toUnderlyingAmount(amount, overrides?): Promise<[BigNumber, BigNumber] & {
adjustedAmount: BigNumber;
underlyingAmount: BigNumber;
}> Parameters
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber] & {
adjustedAmount: BigNumber;
underlyingAmount: BigNumber;
}>
totalSupply:function
- totalSupply(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
transfer:function
- transfer(recipient, amount, overrides?): Promise<boolean>
Parameters
recipient: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
transferAll:function
- transferAll(recipient, overrides?): Promise<void>
Parameters
recipient: string
Optional overrides: CallOverrides
Returns Promise<void>
transferFrom:function
- transferFrom(sender, recipient, amount, overrides?): Promise<boolean>
Parameters
sender: string
recipient: string
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<boolean>
updateAgreementData:function
- updateAgreementData(id, data, overrides?): Promise<void>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: CallOverrides
Returns Promise<void>
updateAgreementStateSlot:function
- updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<void>
Parameters
account: string
slotId: BigNumberish
slotData: BytesLike[]
Optional overrides: CallOverrides
Returns Promise<void>
upgrade:function
- upgrade(amount, overrides?): Promise<void>
Parameters
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<void>
upgradeTo:function
- upgradeTo(to, amount, userData, overrides?): Promise<void>
Parameters
to: string
amount: BigNumberish
userData: BytesLike
Optional overrides: CallOverrides
Returns Promise<void>
estimateGas
estimateGas: {
CONSTANT_INFLOW_NFT(overrides?): Promise<BigNumber>;
CONSTANT_OUTFLOW_NFT(overrides?): Promise<BigNumber>;
POOL_ADMIN_NFT(overrides?): Promise<BigNumber>;
POOL_MEMBER_NFT(overrides?): Promise<BigNumber>;
allowance(owner, spender, overrides?): Promise<BigNumber>;
approve(spender, amount, overrides?): Promise<BigNumber>;
authorizeOperator(operator, overrides?): Promise<BigNumber>;
balanceOf(account, overrides?): Promise<BigNumber>;
burn(amount, userData, overrides?): Promise<BigNumber>;
changeAdmin(newAdmin, overrides?): Promise<BigNumber>;
createAgreement(id, data, overrides?): Promise<BigNumber>;
decimals(overrides?): Promise<BigNumber>;
decreaseAllowance(spender, subtractedValue, overrides?): Promise<BigNumber>;
defaultOperators(overrides?): Promise<BigNumber>;
downgrade(amount, overrides?): Promise<BigNumber>;
downgradeTo(to, amount, overrides?): Promise<BigNumber>;
getAccountActiveAgreements(account, overrides?): Promise<BigNumber>;
getAdmin(overrides?): Promise<BigNumber>;
getAgreementData(agreementClass, id, dataLength, overrides?): Promise<BigNumber>;
getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<BigNumber>;
getHost(overrides?): Promise<BigNumber>;
getUnderlyingDecimals(overrides?): Promise<BigNumber>;
getUnderlyingToken(overrides?): Promise<BigNumber>;
granularity(overrides?): Promise<BigNumber>;
increaseAllowance(spender, addedValue, overrides?): Promise<BigNumber>;
initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<BigNumber>;
initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<BigNumber>;
isAccountCritical(account, timestamp, overrides?): Promise<BigNumber>;
isAccountCriticalNow(account, overrides?): Promise<BigNumber>;
isAccountSolvent(account, timestamp, overrides?): Promise<BigNumber>;
isAccountSolventNow(account, overrides?): Promise<BigNumber>;
isOperatorFor(operator, tokenHolder, overrides?): Promise<BigNumber>;
makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<BigNumber>;
name(overrides?): Promise<BigNumber>;
operationApprove(account, spender, amount, overrides?): Promise<BigNumber>;
operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<BigNumber>;
operationDowngrade(account, amount, overrides?): Promise<BigNumber>;
operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<BigNumber>;
operationSend(spender, recipient, amount, userData, overrides?): Promise<BigNumber>;
operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<BigNumber>;
operationUpgrade(account, amount, overrides?): Promise<BigNumber>;
operatorBurn(account, amount, userData, operatorData, overrides?): Promise<BigNumber>;
operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<BigNumber>;
realtimeBalanceOf(account, timestamp, overrides?): Promise<BigNumber>;
realtimeBalanceOfNow(account, overrides?): Promise<BigNumber>;
revokeOperator(operator, overrides?): Promise<BigNumber>;
selfApproveFor(account, spender, amount, overrides?): Promise<BigNumber>;
selfBurn(account, amount, userData, overrides?): Promise<BigNumber>;
selfMint(account, amount, userData, overrides?): Promise<BigNumber>;
selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<BigNumber>;
send(recipient, amount, userData, overrides?): Promise<BigNumber>;
settleBalance(account, delta, overrides?): Promise<BigNumber>;
symbol(overrides?): Promise<BigNumber>;
terminateAgreement(id, dataLength, overrides?): Promise<BigNumber>;
toUnderlyingAmount(amount, overrides?): Promise<BigNumber>;
totalSupply(overrides?): Promise<BigNumber>;
transfer(recipient, amount, overrides?): Promise<BigNumber>;
transferAll(recipient, overrides?): Promise<BigNumber>;
transferFrom(sender, recipient, amount, overrides?): Promise<BigNumber>;
updateAgreementData(id, data, overrides?): Promise<BigNumber>;
updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<BigNumber>;
upgrade(amount, overrides?): Promise<BigNumber>;
upgradeTo(to, amount, userData, overrides?): Promise<BigNumber>;
}
Type declaration
CONSTANT_INFLOW_NFT:function
- CONSTANT_INFLOW_NFT(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
CONSTANT_OUTFLOW_NFT:function
- CONSTANT_OUTFLOW_NFT(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
POOL_ADMIN_NFT:function
- POOL_ADMIN_NFT(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
POOL_MEMBER_NFT:function
- POOL_MEMBER_NFT(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
allowance:function
- allowance(owner, spender, overrides?): Promise<BigNumber>
Parameters
owner: string
spender: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
approve:function
- approve(spender, amount, overrides?): Promise<BigNumber>
Parameters
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
authorizeOperator:function
- authorizeOperator(operator, overrides?): Promise<BigNumber>
Parameters
operator: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
balanceOf:function
- balanceOf(account, overrides?): Promise<BigNumber>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
burn:function
- burn(amount, userData, overrides?): Promise<BigNumber>
Parameters
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
changeAdmin:function
- changeAdmin(newAdmin, overrides?): Promise<BigNumber>
Parameters
newAdmin: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
createAgreement:function
- createAgreement(id, data, overrides?): Promise<BigNumber>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
decimals:function
- decimals(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
decreaseAllowance:function
- decreaseAllowance(spender, subtractedValue, overrides?): Promise<BigNumber>
Parameters
spender: string
subtractedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
defaultOperators:function
- defaultOperators(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
downgrade:function
- downgrade(amount, overrides?): Promise<BigNumber>
Parameters
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
downgradeTo:function
- downgradeTo(to, amount, overrides?): Promise<BigNumber>
Parameters
to: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
getAccountActiveAgreements:function
- getAccountActiveAgreements(account, overrides?): Promise<BigNumber>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
getAdmin:function
- getAdmin(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
getAgreementData:function
- getAgreementData(agreementClass, id, dataLength, overrides?): Promise<BigNumber>
Parameters
agreementClass: string
id: BytesLike
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<BigNumber>
getAgreementStateSlot:function
- getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<BigNumber>
Parameters
agreementClass: string
account: string
slotId: BigNumberish
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<BigNumber>
getHost:function
- getHost(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
getUnderlyingDecimals:function
- getUnderlyingDecimals(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
getUnderlyingToken:function
- getUnderlyingToken(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
granularity:function
- granularity(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
increaseAllowance:function
- increaseAllowance(spender, addedValue, overrides?): Promise<BigNumber>
Parameters
spender: string
addedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
initialize:function
- initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<BigNumber>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
initializeWithAdmin:function
- initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<BigNumber>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
admin: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
isAccountCritical:function
- isAccountCritical(account, timestamp, overrides?): Promise<BigNumber>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<BigNumber>
isAccountCriticalNow:function
- isAccountCriticalNow(account, overrides?): Promise<BigNumber>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
isAccountSolvent:function
- isAccountSolvent(account, timestamp, overrides?): Promise<BigNumber>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<BigNumber>
isAccountSolventNow:function
- isAccountSolventNow(account, overrides?): Promise<BigNumber>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
isOperatorFor:function
- isOperatorFor(operator, tokenHolder, overrides?): Promise<BigNumber>
Parameters
operator: string
tokenHolder: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
makeLiquidationPayoutsV2:function
- makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<BigNumber>
Parameters
id: BytesLike
liquidationTypeData: BytesLike
liquidatorAccount: string
useDefaultRewardAccount: boolean
targetAccount: string
rewardAmount: BigNumberish
targetAccountBalanceDelta: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
name:function
- name(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
operationApprove:function
- operationApprove(account, spender, amount, overrides?): Promise<BigNumber>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operationDecreaseAllowance:function
- operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<BigNumber>
Parameters
account: string
spender: string
subtractedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operationDowngrade:function
- operationDowngrade(account, amount, overrides?): Promise<BigNumber>
Parameters
account: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operationIncreaseAllowance:function
- operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<BigNumber>
Parameters
account: string
spender: string
addedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operationSend:function
- operationSend(spender, recipient, amount, userData, overrides?): Promise<BigNumber>
Parameters
spender: string
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operationTransferFrom:function
- operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<BigNumber>
Parameters
account: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operationUpgrade:function
- operationUpgrade(account, amount, overrides?): Promise<BigNumber>
Parameters
account: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operatorBurn:function
- operatorBurn(account, amount, userData, operatorData, overrides?): Promise<BigNumber>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
operatorSend:function
- operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<BigNumber>
Parameters
sender: string
recipient: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
realtimeBalanceOf:function
- realtimeBalanceOf(account, timestamp, overrides?): Promise<BigNumber>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<BigNumber>
realtimeBalanceOfNow:function
- realtimeBalanceOfNow(account, overrides?): Promise<BigNumber>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<BigNumber>
revokeOperator:function
- revokeOperator(operator, overrides?): Promise<BigNumber>
Parameters
operator: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
selfApproveFor:function
- selfApproveFor(account, spender, amount, overrides?): Promise<BigNumber>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
selfBurn:function
- selfBurn(account, amount, userData, overrides?): Promise<BigNumber>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
selfMint:function
- selfMint(account, amount, userData, overrides?): Promise<BigNumber>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
selfTransferFrom:function
- selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<BigNumber>
Parameters
sender: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
send:function
- send(recipient, amount, userData, overrides?): Promise<BigNumber>
Parameters
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
settleBalance:function
- settleBalance(account, delta, overrides?): Promise<BigNumber>
Parameters
account: string
delta: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
symbol:function
- symbol(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
terminateAgreement:function
- terminateAgreement(id, dataLength, overrides?): Promise<BigNumber>
Parameters
id: BytesLike
dataLength: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
toUnderlyingAmount:function
- toUnderlyingAmount(amount, overrides?): Promise<BigNumber>
Parameters
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<BigNumber>
totalSupply:function
- totalSupply(overrides?): Promise<BigNumber>
Parameters
Optional overrides: CallOverrides
Returns Promise<BigNumber>
transfer:function
- transfer(recipient, amount, overrides?): Promise<BigNumber>
Parameters
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
transferAll:function
- transferAll(recipient, overrides?): Promise<BigNumber>
Parameters
recipient: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
transferFrom:function
- transferFrom(sender, recipient, amount, overrides?): Promise<BigNumber>
Parameters
sender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
updateAgreementData:function
- updateAgreementData(id, data, overrides?): Promise<BigNumber>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
updateAgreementStateSlot:function
- updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<BigNumber>
Parameters
account: string
slotId: BigNumberish
slotData: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
upgrade:function
- upgrade(amount, overrides?): Promise<BigNumber>
Parameters
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
upgradeTo:function
- upgradeTo(to, amount, userData, overrides?): Promise<BigNumber>
Parameters
to: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
filters
filters: {
AdminChanged(oldAdmin?, newAdmin?): AdminChangedEventFilter;
AdminChanged(address,address)(oldAdmin?, newAdmin?): AdminChangedEventFilter;
AgreementCreated(agreementClass?, id?, data?): AgreementCreatedEventFilter;
AgreementCreated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementCreatedEventFilter;
AgreementLiquidated(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter;
AgreementLiquidated(address,bytes32,address,address,uint256)(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter;
AgreementLiquidatedBy(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter;
AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256)(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter;
AgreementLiquidatedV2(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter;
AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes)(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter;
AgreementStateUpdated(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter;
AgreementStateUpdated(address,address,uint256)(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter;
AgreementTerminated(agreementClass?, id?): AgreementTerminatedEventFilter;
AgreementTerminated(address,bytes32)(agreementClass?, id?): AgreementTerminatedEventFilter;
AgreementUpdated(agreementClass?, id?, data?): AgreementUpdatedEventFilter;
AgreementUpdated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementUpdatedEventFilter;
Approval(owner?, spender?, value?): ApprovalEventFilter;
Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter;
AuthorizedOperator(operator?, tokenHolder?): AuthorizedOperatorEventFilter;
AuthorizedOperator(address,address)(operator?, tokenHolder?): AuthorizedOperatorEventFilter;
Bailout(bailoutAccount?, bailoutAmount?): BailoutEventFilter;
Bailout(address,uint256)(bailoutAccount?, bailoutAmount?): BailoutEventFilter;
Burned(operator?, from?, amount?, data?, operatorData?): BurnedEventFilter;
Burned(address,address,uint256,bytes,bytes)(operator?, from?, amount?, data?, operatorData?): BurnedEventFilter;
ConstantInflowNFTCreated(constantInflowNFT?): ConstantInflowNFTCreatedEventFilter;
ConstantInflowNFTCreated(address)(constantInflowNFT?): ConstantInflowNFTCreatedEventFilter;
ConstantOutflowNFTCreated(constantOutflowNFT?): ConstantOutflowNFTCreatedEventFilter;
ConstantOutflowNFTCreated(address)(constantOutflowNFT?): ConstantOutflowNFTCreatedEventFilter;
Minted(operator?, to?, amount?, data?, operatorData?): MintedEventFilter;
Minted(address,address,uint256,bytes,bytes)(operator?, to?, amount?, data?, operatorData?): MintedEventFilter;
PoolAdminNFTCreated(poolAdminNFT?): PoolAdminNFTCreatedEventFilter;
PoolAdminNFTCreated(address)(poolAdminNFT?): PoolAdminNFTCreatedEventFilter;
PoolMemberNFTCreated(poolMemberNFT?): PoolMemberNFTCreatedEventFilter;
PoolMemberNFTCreated(address)(poolMemberNFT?): PoolMemberNFTCreatedEventFilter;
RevokedOperator(operator?, tokenHolder?): RevokedOperatorEventFilter;
RevokedOperator(address,address)(operator?, tokenHolder?): RevokedOperatorEventFilter;
Sent(operator?, from?, to?, amount?, data?, operatorData?): SentEventFilter;
Sent(address,address,address,uint256,bytes,bytes)(operator?, from?, to?, amount?, data?, operatorData?): SentEventFilter;
TokenDowngraded(account?, amount?): TokenDowngradedEventFilter;
TokenDowngraded(address,uint256)(account?, amount?): TokenDowngradedEventFilter;
TokenUpgraded(account?, amount?): TokenUpgradedEventFilter;
TokenUpgraded(address,uint256)(account?, amount?): TokenUpgradedEventFilter;
Transfer(from?, to?, value?): TransferEventFilter;
Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter;
}
Type declaration
AdminChanged:function
- AdminChanged(oldAdmin?, newAdmin?): AdminChangedEventFilter
Parameters
Optional oldAdmin: null | string
Optional newAdmin: null | string
Returns AdminChangedEventFilter
AdminChanged(address,address):function
- AdminChanged(address,address)(oldAdmin?, newAdmin?): AdminChangedEventFilter
Parameters
Optional oldAdmin: null | string
Optional newAdmin: null | string
Returns AdminChangedEventFilter
AgreementCreated:function
- AgreementCreated(agreementClass?, id?, data?): AgreementCreatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional data: null
Returns AgreementCreatedEventFilter
AgreementCreated(address,bytes32,bytes32[]):function
- AgreementCreated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementCreatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional data: null
Returns AgreementCreatedEventFilter
AgreementLiquidated:function
- AgreementLiquidated(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional penaltyAccount: null | string
Optional rewardAccount: null | string
Optional rewardAmount: null
Returns AgreementLiquidatedEventFilter
AgreementLiquidated(address,bytes32,address,address,uint256):function
- AgreementLiquidated(address,bytes32,address,address,uint256)(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional penaltyAccount: null | string
Optional rewardAccount: null | string
Optional rewardAmount: null
Returns AgreementLiquidatedEventFilter
AgreementLiquidatedBy:function
- AgreementLiquidatedBy(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter
Parameters
Optional liquidatorAccount: null
Optional agreementClass: null | string
Optional id: null
Optional penaltyAccount: null | string
Optional bondAccount: null | string
Optional rewardAmount: null
Optional bailoutAmount: null
Returns AgreementLiquidatedByEventFilter
AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256):function
- AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256)(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter
Parameters
Optional liquidatorAccount: null
Optional agreementClass: null | string
Optional id: null
Optional penaltyAccount: null | string
Optional bondAccount: null | string
Optional rewardAmount: null
Optional bailoutAmount: null
Returns AgreementLiquidatedByEventFilter
AgreementLiquidatedV2:function
- AgreementLiquidatedV2(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional liquidatorAccount: null | string
Optional targetAccount: null | string
Optional rewardAmountReceiver: null
Optional rewardAmount: null
Optional targetAccountBalanceDelta: null
Optional liquidationTypeData: null
Returns AgreementLiquidatedV2EventFilter
AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes):function
- AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes)(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional liquidatorAccount: null | string
Optional targetAccount: null | string
Optional rewardAmountReceiver: null
Optional rewardAmount: null
Optional targetAccountBalanceDelta: null
Optional liquidationTypeData: null
Returns AgreementLiquidatedV2EventFilter
AgreementStateUpdated:function
- AgreementStateUpdated(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter
Parameters
Optional agreementClass: null | string
Optional account: null | string
Optional slotId: null
Returns AgreementStateUpdatedEventFilter
AgreementStateUpdated(address,address,uint256):function
- AgreementStateUpdated(address,address,uint256)(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter
Parameters
Optional agreementClass: null | string
Optional account: null | string
Optional slotId: null
Returns AgreementStateUpdatedEventFilter
AgreementTerminated:function
- AgreementTerminated(agreementClass?, id?): AgreementTerminatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Returns AgreementTerminatedEventFilter
AgreementTerminated(address,bytes32):function
- AgreementTerminated(address,bytes32)(agreementClass?, id?): AgreementTerminatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Returns AgreementTerminatedEventFilter
AgreementUpdated:function
- AgreementUpdated(agreementClass?, id?, data?): AgreementUpdatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional data: null
Returns AgreementUpdatedEventFilter
AgreementUpdated(address,bytes32,bytes32[]):function
- AgreementUpdated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementUpdatedEventFilter
Parameters
Optional agreementClass: null | string
Optional id: null
Optional data: null
Returns AgreementUpdatedEventFilter
Approval:function
- Approval(owner?, spender?, value?): ApprovalEventFilter
Parameters
Optional owner: null | string
Optional spender: null | string
Optional value: null
Returns ApprovalEventFilter
Approval(address,address,uint256):function
- Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter
Parameters
Optional owner: null | string
Optional spender: null | string
Optional value: null
Returns ApprovalEventFilter
AuthorizedOperator:function
- AuthorizedOperator(operator?, tokenHolder?): AuthorizedOperatorEventFilter
Parameters
Optional operator: null | string
Optional tokenHolder: null | string
Returns AuthorizedOperatorEventFilter
AuthorizedOperator(address,address):function
- AuthorizedOperator(address,address)(operator?, tokenHolder?): AuthorizedOperatorEventFilter
Parameters
Optional operator: null | string
Optional tokenHolder: null | string
Returns AuthorizedOperatorEventFilter
Bailout:function
- Bailout(bailoutAccount?, bailoutAmount?): BailoutEventFilter
Parameters
Optional bailoutAccount: null | string
Optional bailoutAmount: null
Returns BailoutEventFilter
Bailout(address,uint256):function
- Bailout(address,uint256)(bailoutAccount?, bailoutAmount?): BailoutEventFilter
Parameters
Optional bailoutAccount: null | string
Optional bailoutAmount: null
Returns BailoutEventFilter
Burned:function
- Burned(operator?, from?, amount?, data?, operatorData?): BurnedEventFilter
Parameters
Optional operator: null | string
Optional from: null | string
Optional amount: null
Optional data: null
Optional operatorData: null
Returns BurnedEventFilter
Burned(address,address,uint256,bytes,bytes):function
- Burned(address,address,uint256,bytes,bytes)(operator?, from?, amount?, data?, operatorData?): BurnedEventFilter
Parameters
Optional operator: null | string
Optional from: null | string
Optional amount: null
Optional data: null
Optional operatorData: null
Returns BurnedEventFilter
ConstantInflowNFTCreated:function
- ConstantInflowNFTCreated(constantInflowNFT?): ConstantInflowNFTCreatedEventFilter
Parameters
Optional constantInflowNFT: null | string
Returns ConstantInflowNFTCreatedEventFilter
ConstantInflowNFTCreated(address):function
- ConstantInflowNFTCreated(address)(constantInflowNFT?): ConstantInflowNFTCreatedEventFilter
Parameters
Optional constantInflowNFT: null | string
Returns ConstantInflowNFTCreatedEventFilter
ConstantOutflowNFTCreated:function
- ConstantOutflowNFTCreated(constantOutflowNFT?): ConstantOutflowNFTCreatedEventFilter
Parameters
Optional constantOutflowNFT: null | string
Returns ConstantOutflowNFTCreatedEventFilter
ConstantOutflowNFTCreated(address):function
- ConstantOutflowNFTCreated(address)(constantOutflowNFT?): ConstantOutflowNFTCreatedEventFilter
Parameters
Optional constantOutflowNFT: null | string
Returns ConstantOutflowNFTCreatedEventFilter
Minted:function
- Minted(operator?, to?, amount?, data?, operatorData?): MintedEventFilter
Parameters
Optional operator: null | string
Optional to: null | string
Optional amount: null
Optional data: null
Optional operatorData: null
Returns MintedEventFilter
Minted(address,address,uint256,bytes,bytes):function
- Minted(address,address,uint256,bytes,bytes)(operator?, to?, amount?, data?, operatorData?): MintedEventFilter
Parameters
Optional operator: null | string
Optional to: null | string
Optional amount: null
Optional data: null
Optional operatorData: null
Returns MintedEventFilter
PoolAdminNFTCreated:function
- PoolAdminNFTCreated(poolAdminNFT?): PoolAdminNFTCreatedEventFilter
Parameters
Optional poolAdminNFT: null | string
Returns PoolAdminNFTCreatedEventFilter
PoolAdminNFTCreated(address):function
- PoolAdminNFTCreated(address)(poolAdminNFT?): PoolAdminNFTCreatedEventFilter
Parameters
Optional poolAdminNFT: null | string
Returns PoolAdminNFTCreatedEventFilter
PoolMemberNFTCreated:function
- PoolMemberNFTCreated(poolMemberNFT?): PoolMemberNFTCreatedEventFilter
Parameters
Optional poolMemberNFT: null | string
Returns PoolMemberNFTCreatedEventFilter
PoolMemberNFTCreated(address):function
- PoolMemberNFTCreated(address)(poolMemberNFT?): PoolMemberNFTCreatedEventFilter
Parameters
Optional poolMemberNFT: null | string
Returns PoolMemberNFTCreatedEventFilter
RevokedOperator:function
- RevokedOperator(operator?, tokenHolder?): RevokedOperatorEventFilter
Parameters
Optional operator: null | string
Optional tokenHolder: null | string
Returns RevokedOperatorEventFilter
RevokedOperator(address,address):function
- RevokedOperator(address,address)(operator?, tokenHolder?): RevokedOperatorEventFilter
Parameters
Optional operator: null | string
Optional tokenHolder: null | string
Returns RevokedOperatorEventFilter
Sent:function
- Sent(operator?, from?, to?, amount?, data?, operatorData?): SentEventFilter
Parameters
Optional operator: null | string
Optional from: null | string
Optional to: null | string
Optional amount: null
Optional data: null
Optional operatorData: null
Returns SentEventFilter
Sent(address,address,address,uint256,bytes,bytes):function
- Sent(address,address,address,uint256,bytes,bytes)(operator?, from?, to?, amount?, data?, operatorData?): SentEventFilter
Parameters
Optional operator: null | string
Optional from: null | string
Optional to: null | string
Optional amount: null
Optional data: null
Optional operatorData: null
Returns SentEventFilter
TokenDowngraded:function
- TokenDowngraded(account?, amount?): TokenDowngradedEventFilter
Parameters
Optional account: null | string
Optional amount: null
Returns TokenDowngradedEventFilter
TokenDowngraded(address,uint256):function
- TokenDowngraded(address,uint256)(account?, amount?): TokenDowngradedEventFilter
Parameters
Optional account: null | string
Optional amount: null
Returns TokenDowngradedEventFilter
TokenUpgraded:function
- TokenUpgraded(account?, amount?): TokenUpgradedEventFilter
Parameters
Optional account: null | string
Optional amount: null
Returns TokenUpgradedEventFilter
TokenUpgraded(address,uint256):function
- TokenUpgraded(address,uint256)(account?, amount?): TokenUpgradedEventFilter
Parameters
Optional account: null | string
Optional amount: null
Returns TokenUpgradedEventFilter
Transfer:function
- Transfer(from?, to?, value?): TransferEventFilter
Parameters
Optional from: null | string
Optional to: null | string
Optional value: null
Returns TransferEventFilter
Transfer(address,address,uint256):function
- Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter
Parameters
Optional from: null | string
Optional to: null | string
Optional value: null
Returns TransferEventFilter
functions
functions: {
CONSTANT_INFLOW_NFT(overrides?): Promise<[string]>;
CONSTANT_OUTFLOW_NFT(overrides?): Promise<[string]>;
POOL_ADMIN_NFT(overrides?): Promise<[string]>;
POOL_MEMBER_NFT(overrides?): Promise<[string]>;
allowance(owner, spender, overrides?): Promise<[BigNumber]>;
approve(spender, amount, overrides?): Promise<ContractTransaction>;
authorizeOperator(operator, overrides?): Promise<ContractTransaction>;
balanceOf(account, overrides?): Promise<[BigNumber] & {
balance: BigNumber;
}>;
burn(amount, userData, overrides?): Promise<ContractTransaction>;
changeAdmin(newAdmin, overrides?): Promise<ContractTransaction>;
createAgreement(id, data, overrides?): Promise<ContractTransaction>;
decimals(overrides?): Promise<[number]>;
decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>;
defaultOperators(overrides?): Promise<[string[]]>;
downgrade(amount, overrides?): Promise<ContractTransaction>;
downgradeTo(to, amount, overrides?): Promise<ContractTransaction>;
getAccountActiveAgreements(account, overrides?): Promise<[string[]] & {
activeAgreements: string[];
}>;
getAdmin(overrides?): Promise<[string] & {
admin: string;
}>;
getAgreementData(agreementClass, id, dataLength, overrides?): Promise<[string[]] & {
data: string[];
}>;
getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<[string[]] & {
slotData: string[];
}>;
getHost(overrides?): Promise<[string] & {
host: string;
}>;
getUnderlyingDecimals(overrides?): Promise<[number] & {
underlyingDecimals: number;
}>;
getUnderlyingToken(overrides?): Promise<[string] & {
tokenAddr: string;
}>;
granularity(overrides?): Promise<[BigNumber]>;
increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>;
initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<ContractTransaction>;
initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<ContractTransaction>;
isAccountCritical(account, timestamp, overrides?): Promise<[boolean] & {
isCritical: boolean;
}>;
isAccountCriticalNow(account, overrides?): Promise<[boolean] & {
isCritical: boolean;
}>;
isAccountSolvent(account, timestamp, overrides?): Promise<[boolean] & {
isSolvent: boolean;
}>;
isAccountSolventNow(account, overrides?): Promise<[boolean] & {
isSolvent: boolean;
}>;
isOperatorFor(operator, tokenHolder, overrides?): Promise<[boolean]>;
makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>;
name(overrides?): Promise<[string]>;
operationApprove(account, spender, amount, overrides?): Promise<ContractTransaction>;
operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<ContractTransaction>;
operationDowngrade(account, amount, overrides?): Promise<ContractTransaction>;
operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<ContractTransaction>;
operationSend(spender, recipient, amount, userData, overrides?): Promise<ContractTransaction>;
operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<ContractTransaction>;
operationUpgrade(account, amount, overrides?): Promise<ContractTransaction>;
operatorBurn(account, amount, userData, operatorData, overrides?): Promise<ContractTransaction>;
operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<ContractTransaction>;
realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
}>;
realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
timestamp: BigNumber;
}>;
revokeOperator(operator, overrides?): Promise<ContractTransaction>;
selfApproveFor(account, spender, amount, overrides?): Promise<ContractTransaction>;
selfBurn(account, amount, userData, overrides?): Promise<ContractTransaction>;
selfMint(account, amount, userData, overrides?): Promise<ContractTransaction>;
selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<ContractTransaction>;
send(recipient, amount, userData, overrides?): Promise<ContractTransaction>;
settleBalance(account, delta, overrides?): Promise<ContractTransaction>;
symbol(overrides?): Promise<[string]>;
terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>;
toUnderlyingAmount(amount, overrides?): Promise<[BigNumber, BigNumber] & {
adjustedAmount: BigNumber;
underlyingAmount: BigNumber;
}>;
totalSupply(overrides?): Promise<[BigNumber]>;
transfer(recipient, amount, overrides?): Promise<ContractTransaction>;
transferAll(recipient, overrides?): Promise<ContractTransaction>;
transferFrom(sender, recipient, amount, overrides?): Promise<ContractTransaction>;
updateAgreementData(id, data, overrides?): Promise<ContractTransaction>;
updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>;
upgrade(amount, overrides?): Promise<ContractTransaction>;
upgradeTo(to, amount, userData, overrides?): Promise<ContractTransaction>;
}
Type declaration
CONSTANT_INFLOW_NFT:function
- CONSTANT_INFLOW_NFT(overrides?): Promise<[string]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string]>
CONSTANT_OUTFLOW_NFT:function
- CONSTANT_OUTFLOW_NFT(overrides?): Promise<[string]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string]>
POOL_ADMIN_NFT:function
- POOL_ADMIN_NFT(overrides?): Promise<[string]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string]>
POOL_MEMBER_NFT:function
- POOL_MEMBER_NFT(overrides?): Promise<[string]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string]>
allowance:function
- allowance(owner, spender, overrides?): Promise<[BigNumber]>
Parameters
owner: string
spender: string
Optional overrides: CallOverrides
Returns Promise<[BigNumber]>
approve:function
- approve(spender, amount, overrides?): Promise<ContractTransaction>
Parameters
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
authorizeOperator:function
- authorizeOperator(operator, overrides?): Promise<ContractTransaction>
Parameters
operator: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
balanceOf:function
- balanceOf(account, overrides?): Promise<[BigNumber] & {
balance: BigNumber;
}> Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<[BigNumber] & {
balance: BigNumber;
}>
burn:function
- burn(amount, userData, overrides?): Promise<ContractTransaction>
Parameters
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
changeAdmin:function
- changeAdmin(newAdmin, overrides?): Promise<ContractTransaction>
Parameters
newAdmin: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
createAgreement:function
- createAgreement(id, data, overrides?): Promise<ContractTransaction>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
decimals:function
- decimals(overrides?): Promise<[number]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[number]>
decreaseAllowance:function
- decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>
Parameters
spender: string
subtractedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
defaultOperators:function
- defaultOperators(overrides?): Promise<[string[]]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string[]]>
downgrade:function
- downgrade(amount, overrides?): Promise<ContractTransaction>
Parameters
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
downgradeTo:function
- downgradeTo(to, amount, overrides?): Promise<ContractTransaction>
Parameters
to: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
getAccountActiveAgreements:function
- getAccountActiveAgreements(account, overrides?): Promise<[string[]] & {
activeAgreements: string[];
}> Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<[string[]] & {
activeAgreements: string[];
}>
getAdmin:function
- getAdmin(overrides?): Promise<[string] & {
admin: string;
}> Parameters
Optional overrides: CallOverrides
Returns Promise<[string] & {
admin: string;
}>
getAgreementData:function
- getAgreementData(agreementClass, id, dataLength, overrides?): Promise<[string[]] & {
data: string[];
}> Parameters
agreementClass: string
id: BytesLike
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[string[]] & {
data: string[];
}>
getAgreementStateSlot:function
- getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<[string[]] & {
slotData: string[];
}> Parameters
agreementClass: string
account: string
slotId: BigNumberish
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[string[]] & {
slotData: string[];
}>
getHost:function
- getHost(overrides?): Promise<[string] & {
host: string;
}> Parameters
Optional overrides: CallOverrides
Returns Promise<[string] & {
host: string;
}>
getUnderlyingDecimals:function
- getUnderlyingDecimals(overrides?): Promise<[number] & {
underlyingDecimals: number;
}> Parameters
Optional overrides: CallOverrides
Returns Promise<[number] & {
underlyingDecimals: number;
}>
getUnderlyingToken:function
- getUnderlyingToken(overrides?): Promise<[string] & {
tokenAddr: string;
}> Parameters
Optional overrides: CallOverrides
Returns Promise<[string] & {
tokenAddr: string;
}>
granularity:function
- granularity(overrides?): Promise<[BigNumber]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[BigNumber]>
increaseAllowance:function
- increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>
Parameters
spender: string
addedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
initialize:function
- initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<ContractTransaction>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
initializeWithAdmin:function
- initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<ContractTransaction>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
admin: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
isAccountCritical:function
- isAccountCritical(account, timestamp, overrides?): Promise<[boolean] & {
isCritical: boolean;
}> Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[boolean] & {
isCritical: boolean;
}>
isAccountCriticalNow:function
- isAccountCriticalNow(account, overrides?): Promise<[boolean] & {
isCritical: boolean;
}> Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<[boolean] & {
isCritical: boolean;
}>
isAccountSolvent:function
- isAccountSolvent(account, timestamp, overrides?): Promise<[boolean] & {
isSolvent: boolean;
}> Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[boolean] & {
isSolvent: boolean;
}>
isAccountSolventNow:function
- isAccountSolventNow(account, overrides?): Promise<[boolean] & {
isSolvent: boolean;
}> Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<[boolean] & {
isSolvent: boolean;
}>
isOperatorFor:function
- isOperatorFor(operator, tokenHolder, overrides?): Promise<[boolean]>
Parameters
operator: string
tokenHolder: string
Optional overrides: CallOverrides
Returns Promise<[boolean]>
makeLiquidationPayoutsV2:function
- makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>
Parameters
id: BytesLike
liquidationTypeData: BytesLike
liquidatorAccount: string
useDefaultRewardAccount: boolean
targetAccount: string
rewardAmount: BigNumberish
targetAccountBalanceDelta: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
name:function
- name(overrides?): Promise<[string]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string]>
operationApprove:function
- operationApprove(account, spender, amount, overrides?): Promise<ContractTransaction>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operationDecreaseAllowance:function
- operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<ContractTransaction>
Parameters
account: string
spender: string
subtractedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operationDowngrade:function
- operationDowngrade(account, amount, overrides?): Promise<ContractTransaction>
Parameters
account: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operationIncreaseAllowance:function
- operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<ContractTransaction>
Parameters
account: string
spender: string
addedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operationSend:function
- operationSend(spender, recipient, amount, userData, overrides?): Promise<ContractTransaction>
Parameters
spender: string
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operationTransferFrom:function
- operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<ContractTransaction>
Parameters
account: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operationUpgrade:function
- operationUpgrade(account, amount, overrides?): Promise<ContractTransaction>
Parameters
account: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operatorBurn:function
- operatorBurn(account, amount, userData, operatorData, overrides?): Promise<ContractTransaction>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
operatorSend:function
- operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<ContractTransaction>
Parameters
sender: string
recipient: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
realtimeBalanceOf:function
- realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
}> Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
}>
realtimeBalanceOfNow:function
- realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
timestamp: BigNumber;
}> Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
availableBalance: BigNumber;
deposit: BigNumber;
owedDeposit: BigNumber;
timestamp: BigNumber;
}>
revokeOperator:function
- revokeOperator(operator, overrides?): Promise<ContractTransaction>
Parameters
operator: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
selfApproveFor:function
- selfApproveFor(account, spender, amount, overrides?): Promise<ContractTransaction>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
selfBurn:function
- selfBurn(account, amount, userData, overrides?): Promise<ContractTransaction>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
selfMint:function
- selfMint(account, amount, userData, overrides?): Promise<ContractTransaction>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
selfTransferFrom:function
- selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<ContractTransaction>
Parameters
sender: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
send:function
- send(recipient, amount, userData, overrides?): Promise<ContractTransaction>
Parameters
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
settleBalance:function
- settleBalance(account, delta, overrides?): Promise<ContractTransaction>
Parameters
account: string
delta: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
symbol:function
- symbol(overrides?): Promise<[string]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[string]>
terminateAgreement:function
- terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>
Parameters
id: BytesLike
dataLength: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
toUnderlyingAmount:function
- toUnderlyingAmount(amount, overrides?): Promise<[BigNumber, BigNumber] & {
adjustedAmount: BigNumber;
underlyingAmount: BigNumber;
}> Parameters
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber] & {
adjustedAmount: BigNumber;
underlyingAmount: BigNumber;
}>
totalSupply:function
- totalSupply(overrides?): Promise<[BigNumber]>
Parameters
Optional overrides: CallOverrides
Returns Promise<[BigNumber]>
transfer:function
- transfer(recipient, amount, overrides?): Promise<ContractTransaction>
Parameters
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
transferAll:function
- transferAll(recipient, overrides?): Promise<ContractTransaction>
Parameters
recipient: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
transferFrom:function
- transferFrom(sender, recipient, amount, overrides?): Promise<ContractTransaction>
Parameters
sender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
updateAgreementData:function
- updateAgreementData(id, data, overrides?): Promise<ContractTransaction>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
updateAgreementStateSlot:function
- updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>
Parameters
account: string
slotId: BigNumberish
slotData: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
upgrade:function
- upgrade(amount, overrides?): Promise<ContractTransaction>
Parameters
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
upgradeTo:function
- upgradeTo(to, amount, userData, overrides?): Promise<ContractTransaction>
Parameters
to: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
interface
interface: ISuperTokenInterface
populateTransaction
populateTransaction: {
CONSTANT_INFLOW_NFT(overrides?): Promise<PopulatedTransaction>;
CONSTANT_OUTFLOW_NFT(overrides?): Promise<PopulatedTransaction>;
POOL_ADMIN_NFT(overrides?): Promise<PopulatedTransaction>;
POOL_MEMBER_NFT(overrides?): Promise<PopulatedTransaction>;
allowance(owner, spender, overrides?): Promise<PopulatedTransaction>;
approve(spender, amount, overrides?): Promise<PopulatedTransaction>;
authorizeOperator(operator, overrides?): Promise<PopulatedTransaction>;
balanceOf(account, overrides?): Promise<PopulatedTransaction>;
burn(amount, userData, overrides?): Promise<PopulatedTransaction>;
changeAdmin(newAdmin, overrides?): Promise<PopulatedTransaction>;
createAgreement(id, data, overrides?): Promise<PopulatedTransaction>;
decimals(overrides?): Promise<PopulatedTransaction>;
decreaseAllowance(spender, subtractedValue, overrides?): Promise<PopulatedTransaction>;
defaultOperators(overrides?): Promise<PopulatedTransaction>;
downgrade(amount, overrides?): Promise<PopulatedTransaction>;
downgradeTo(to, amount, overrides?): Promise<PopulatedTransaction>;
getAccountActiveAgreements(account, overrides?): Promise<PopulatedTransaction>;
getAdmin(overrides?): Promise<PopulatedTransaction>;
getAgreementData(agreementClass, id, dataLength, overrides?): Promise<PopulatedTransaction>;
getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<PopulatedTransaction>;
getHost(overrides?): Promise<PopulatedTransaction>;
getUnderlyingDecimals(overrides?): Promise<PopulatedTransaction>;
getUnderlyingToken(overrides?): Promise<PopulatedTransaction>;
granularity(overrides?): Promise<PopulatedTransaction>;
increaseAllowance(spender, addedValue, overrides?): Promise<PopulatedTransaction>;
initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<PopulatedTransaction>;
initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<PopulatedTransaction>;
isAccountCritical(account, timestamp, overrides?): Promise<PopulatedTransaction>;
isAccountCriticalNow(account, overrides?): Promise<PopulatedTransaction>;
isAccountSolvent(account, timestamp, overrides?): Promise<PopulatedTransaction>;
isAccountSolventNow(account, overrides?): Promise<PopulatedTransaction>;
isOperatorFor(operator, tokenHolder, overrides?): Promise<PopulatedTransaction>;
makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<PopulatedTransaction>;
name(overrides?): Promise<PopulatedTransaction>;
operationApprove(account, spender, amount, overrides?): Promise<PopulatedTransaction>;
operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<PopulatedTransaction>;
operationDowngrade(account, amount, overrides?): Promise<PopulatedTransaction>;
operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<PopulatedTransaction>;
operationSend(spender, recipient, amount, userData, overrides?): Promise<PopulatedTransaction>;
operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<PopulatedTransaction>;
operationUpgrade(account, amount, overrides?): Promise<PopulatedTransaction>;
operatorBurn(account, amount, userData, operatorData, overrides?): Promise<PopulatedTransaction>;
operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<PopulatedTransaction>;
realtimeBalanceOf(account, timestamp, overrides?): Promise<PopulatedTransaction>;
realtimeBalanceOfNow(account, overrides?): Promise<PopulatedTransaction>;
revokeOperator(operator, overrides?): Promise<PopulatedTransaction>;
selfApproveFor(account, spender, amount, overrides?): Promise<PopulatedTransaction>;
selfBurn(account, amount, userData, overrides?): Promise<PopulatedTransaction>;
selfMint(account, amount, userData, overrides?): Promise<PopulatedTransaction>;
selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<PopulatedTransaction>;
send(recipient, amount, userData, overrides?): Promise<PopulatedTransaction>;
settleBalance(account, delta, overrides?): Promise<PopulatedTransaction>;
symbol(overrides?): Promise<PopulatedTransaction>;
terminateAgreement(id, dataLength, overrides?): Promise<PopulatedTransaction>;
toUnderlyingAmount(amount, overrides?): Promise<PopulatedTransaction>;
totalSupply(overrides?): Promise<PopulatedTransaction>;
transfer(recipient, amount, overrides?): Promise<PopulatedTransaction>;
transferAll(recipient, overrides?): Promise<PopulatedTransaction>;
transferFrom(sender, recipient, amount, overrides?): Promise<PopulatedTransaction>;
updateAgreementData(id, data, overrides?): Promise<PopulatedTransaction>;
updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<PopulatedTransaction>;
upgrade(amount, overrides?): Promise<PopulatedTransaction>;
upgradeTo(to, amount, userData, overrides?): Promise<PopulatedTransaction>;
}
Type declaration
CONSTANT_INFLOW_NFT:function
- CONSTANT_INFLOW_NFT(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
CONSTANT_OUTFLOW_NFT:function
- CONSTANT_OUTFLOW_NFT(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
POOL_ADMIN_NFT:function
- POOL_ADMIN_NFT(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
POOL_MEMBER_NFT:function
- POOL_MEMBER_NFT(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
allowance:function
- allowance(owner, spender, overrides?): Promise<PopulatedTransaction>
Parameters
owner: string
spender: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
approve:function
- approve(spender, amount, overrides?): Promise<PopulatedTransaction>
Parameters
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
authorizeOperator:function
- authorizeOperator(operator, overrides?): Promise<PopulatedTransaction>
Parameters
operator: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
balanceOf:function
- balanceOf(account, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
burn:function
- burn(amount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
changeAdmin:function
- changeAdmin(newAdmin, overrides?): Promise<PopulatedTransaction>
Parameters
newAdmin: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
createAgreement:function
- createAgreement(id, data, overrides?): Promise<PopulatedTransaction>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
decimals:function
- decimals(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
decreaseAllowance:function
- decreaseAllowance(spender, subtractedValue, overrides?): Promise<PopulatedTransaction>
Parameters
spender: string
subtractedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
defaultOperators:function
- defaultOperators(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
downgrade:function
- downgrade(amount, overrides?): Promise<PopulatedTransaction>
Parameters
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
downgradeTo:function
- downgradeTo(to, amount, overrides?): Promise<PopulatedTransaction>
Parameters
to: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
getAccountActiveAgreements:function
- getAccountActiveAgreements(account, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getAdmin:function
- getAdmin(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getAgreementData:function
- getAgreementData(agreementClass, id, dataLength, overrides?): Promise<PopulatedTransaction>
Parameters
agreementClass: string
id: BytesLike
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getAgreementStateSlot:function
- getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<PopulatedTransaction>
Parameters
agreementClass: string
account: string
slotId: BigNumberish
dataLength: BigNumberish
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getHost:function
- getHost(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getUnderlyingDecimals:function
- getUnderlyingDecimals(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getUnderlyingToken:function
- getUnderlyingToken(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
granularity:function
- granularity(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
increaseAllowance:function
- increaseAllowance(spender, addedValue, overrides?): Promise<PopulatedTransaction>
Parameters
spender: string
addedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
initialize:function
- initialize(underlyingToken, underlyingDecimals, n, s, overrides?): Promise<PopulatedTransaction>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
initializeWithAdmin:function
- initializeWithAdmin(underlyingToken, underlyingDecimals, n, s, admin, overrides?): Promise<PopulatedTransaction>
Parameters
underlyingToken: string
underlyingDecimals: BigNumberish
n: string
s: string
admin: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
isAccountCritical:function
- isAccountCritical(account, timestamp, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
isAccountCriticalNow:function
- isAccountCriticalNow(account, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
isAccountSolvent:function
- isAccountSolvent(account, timestamp, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
isAccountSolventNow:function
- isAccountSolventNow(account, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
isOperatorFor:function
- isOperatorFor(operator, tokenHolder, overrides?): Promise<PopulatedTransaction>
Parameters
operator: string
tokenHolder: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
makeLiquidationPayoutsV2:function
- makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<PopulatedTransaction>
Parameters
id: BytesLike
liquidationTypeData: BytesLike
liquidatorAccount: string
useDefaultRewardAccount: boolean
targetAccount: string
rewardAmount: BigNumberish
targetAccountBalanceDelta: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
name:function
- name(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
operationApprove:function
- operationApprove(account, spender, amount, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operationDecreaseAllowance:function
- operationDecreaseAllowance(account, spender, subtractedValue, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
spender: string
subtractedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operationDowngrade:function
- operationDowngrade(account, amount, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operationIncreaseAllowance:function
- operationIncreaseAllowance(account, spender, addedValue, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
spender: string
addedValue: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operationSend:function
- operationSend(spender, recipient, amount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
spender: string
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operationTransferFrom:function
- operationTransferFrom(account, spender, recipient, amount, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operationUpgrade:function
- operationUpgrade(account, amount, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operatorBurn:function
- operatorBurn(account, amount, userData, operatorData, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
operatorSend:function
- operatorSend(sender, recipient, amount, userData, operatorData, overrides?): Promise<PopulatedTransaction>
Parameters
sender: string
recipient: string
amount: BigNumberish
userData: BytesLike
operatorData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
realtimeBalanceOf:function
- realtimeBalanceOf(account, timestamp, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
timestamp: BigNumberish
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
realtimeBalanceOfNow:function
- realtimeBalanceOfNow(account, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
revokeOperator:function
- revokeOperator(operator, overrides?): Promise<PopulatedTransaction>
Parameters
operator: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
selfApproveFor:function
- selfApproveFor(account, spender, amount, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
spender: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
selfBurn:function
- selfBurn(account, amount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
selfMint:function
- selfMint(account, amount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
selfTransferFrom:function
- selfTransferFrom(sender, spender, recipient, amount, overrides?): Promise<PopulatedTransaction>
Parameters
sender: string
spender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
send:function
- send(recipient, amount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
recipient: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
settleBalance:function
- settleBalance(account, delta, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
delta: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
symbol:function
- symbol(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
terminateAgreement:function
- terminateAgreement(id, dataLength, overrides?): Promise<PopulatedTransaction>
Parameters
id: BytesLike
dataLength: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
toUnderlyingAmount:function
- toUnderlyingAmount(amount, overrides?): Promise<PopulatedTransaction>
Parameters
amount: BigNumberish
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
totalSupply:function
- totalSupply(overrides?): Promise<PopulatedTransaction>
Parameters
Optional overrides: CallOverrides
Returns Promise<PopulatedTransaction>
transfer:function
- transfer(recipient, amount, overrides?): Promise<PopulatedTransaction>
Parameters
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
transferAll:function
- transferAll(recipient, overrides?): Promise<PopulatedTransaction>
Parameters
recipient: string
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
transferFrom:function
- transferFrom(sender, recipient, amount, overrides?): Promise<PopulatedTransaction>
Parameters
sender: string
recipient: string
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
updateAgreementData:function
- updateAgreementData(id, data, overrides?): Promise<PopulatedTransaction>
Parameters
id: BytesLike
data: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
updateAgreementStateSlot:function
- updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<PopulatedTransaction>
Parameters
account: string
slotId: BigNumberish
slotData: BytesLike[]
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
upgrade:function
- upgrade(amount, overrides?): Promise<PopulatedTransaction>
Parameters
amount: BigNumberish
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
upgradeTo:function
- upgradeTo(to, amount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
to: string
amount: BigNumberish
userData: BytesLike
Optional overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>