Properties
callStatic
callStatic: {
claimAll(pool, memberAddress, userData, overrides?): Promise<boolean>;
connectPool(pool, userData, overrides?): Promise<boolean>;
createPool(token, admin, config, overrides?): Promise<[boolean, string] & {
pool: string;
success: boolean;
}>;
disconnectPool(pool, userData, overrides?): Promise<boolean>;
distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<boolean>;
distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<boolean>;
estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
actualFlowRate: BigNumber;
totalDistributionFlowRate: BigNumber;
}>;
getFlowDistributionFlowRate(token, from, to, overrides?): Promise<BigNumber>;
getNetFlow(token, account, overrides?): Promise<BigNumber>;
getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber]>;
getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>;
isMemberConnected(pool, member, overrides?): Promise<boolean>;
isPool(token, account, overrides?): Promise<boolean>;
updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<boolean>;
}
Type declaration
claimAll:function
- claimAll(pool, memberAddress, userData, overrides?): Promise<boolean>
Parameters
pool: string
memberAddress: string
userData: BytesLike
Optional
overrides: CallOverrides
Returns Promise<boolean>
connectPool:function
- connectPool(pool, userData, overrides?): Promise<boolean>
Parameters
pool: string
userData: BytesLike
Optional
overrides: CallOverrides
Returns Promise<boolean>
createPool:function
- createPool(token, admin, config, overrides?): Promise<[boolean, string] & {
pool: string;
success: boolean;
}> Parameters
token: string
admin: string
config: PoolConfigStruct
Optional
overrides: CallOverrides
Returns Promise<[boolean, string] & {
pool: string;
success: boolean;
}>
disconnectPool:function
- disconnectPool(pool, userData, overrides?): Promise<boolean>
Parameters
pool: string
userData: BytesLike
Optional
overrides: CallOverrides
Returns Promise<boolean>
distribute:function
- distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<boolean>
Parameters
token: string
from: string
pool: string
requestedAmount: BigNumberish
userData: BytesLike
Optional
overrides: CallOverrides
Returns Promise<boolean>
distributeFlow:function
- distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<boolean>
Parameters
token: string
from: string
pool: string
requestedFlowRate: BigNumberish
userData: BytesLike
Optional
overrides: CallOverrides
Returns Promise<boolean>
estimateDistributionActualAmount:function
- estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
to: string
requestedAmount: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
estimateFlowDistributionActualFlowRate:function
- estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
actualFlowRate: BigNumber;
totalDistributionFlowRate: BigNumber;
}> Parameters
token: string
from: string
to: string
requestedFlowRate: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber] & {
actualFlowRate: BigNumber;
totalDistributionFlowRate: BigNumber;
}>
getFlowDistributionFlowRate:function
- getFlowDistributionFlowRate(token, from, to, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
to: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
getNetFlow:function
- getNetFlow(token, account, overrides?): Promise<BigNumber>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
getPoolAdjustmentFlowInfo:function
- getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber]>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<[string, string, BigNumber]>
getPoolAdjustmentFlowRate:function
- getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
isMemberConnected:function
- isMemberConnected(pool, member, overrides?): Promise<boolean>
Parameters
pool: string
member: string
Optional
overrides: CallOverrides
Returns Promise<boolean>
isPool:function
- isPool(token, account, overrides?): Promise<boolean>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<boolean>
updateMemberUnits:function
- updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<boolean>
Parameters
pool: string
memberAddress: string
newUnits: BigNumberish
userData: BytesLike
Optional
overrides: CallOverrides
Returns Promise<boolean>
estimateGas
estimateGas: {
claimAll(pool, memberAddress, userData, overrides?): Promise<BigNumber>;
connectPool(pool, userData, overrides?): Promise<BigNumber>;
createPool(token, admin, config, overrides?): Promise<BigNumber>;
disconnectPool(pool, userData, overrides?): Promise<BigNumber>;
distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<BigNumber>;
distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<BigNumber>;
estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<BigNumber>;
getFlowDistributionFlowRate(token, from, to, overrides?): Promise<BigNumber>;
getNetFlow(token, account, overrides?): Promise<BigNumber>;
getPoolAdjustmentFlowInfo(pool, overrides?): Promise<BigNumber>;
getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>;
isMemberConnected(pool, member, overrides?): Promise<BigNumber>;
isPool(token, account, overrides?): Promise<BigNumber>;
updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<BigNumber>;
}
Type declaration
claimAll:function
- claimAll(pool, memberAddress, userData, overrides?): Promise<BigNumber>
Parameters
pool: string
memberAddress: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
connectPool:function
- connectPool(pool, userData, overrides?): Promise<BigNumber>
Parameters
pool: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
createPool:function
- createPool(token, admin, config, overrides?): Promise<BigNumber>
Parameters
token: string
admin: string
config: PoolConfigStruct
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
disconnectPool:function
- disconnectPool(pool, userData, overrides?): Promise<BigNumber>
Parameters
pool: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
distribute:function
- distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
pool: string
requestedAmount: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
distributeFlow:function
- distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
pool: string
requestedFlowRate: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
estimateDistributionActualAmount:function
- estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
to: string
requestedAmount: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
estimateFlowDistributionActualFlowRate:function
- estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
to: string
requestedFlowRate: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
getFlowDistributionFlowRate:function
- getFlowDistributionFlowRate(token, from, to, overrides?): Promise<BigNumber>
Parameters
token: string
from: string
to: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
getNetFlow:function
- getNetFlow(token, account, overrides?): Promise<BigNumber>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
getPoolAdjustmentFlowInfo:function
- getPoolAdjustmentFlowInfo(pool, overrides?): Promise<BigNumber>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
getPoolAdjustmentFlowRate:function
- getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
isMemberConnected:function
- isMemberConnected(pool, member, overrides?): Promise<BigNumber>
Parameters
pool: string
member: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
isPool:function
- isPool(token, account, overrides?): Promise<BigNumber>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<BigNumber>
updateMemberUnits:function
- updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<BigNumber>
Parameters
pool: string
memberAddress: string
newUnits: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<BigNumber>
functions
functions: {
claimAll(pool, memberAddress, userData, overrides?): Promise<ContractTransaction>;
connectPool(pool, userData, overrides?): Promise<ContractTransaction>;
createPool(token, admin, config, overrides?): Promise<ContractTransaction>;
disconnectPool(pool, userData, overrides?): Promise<ContractTransaction>;
distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<ContractTransaction>;
distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<ContractTransaction>;
estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<[BigNumber] & {
actualAmount: BigNumber;
}>;
estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
actualFlowRate: BigNumber;
totalDistributionFlowRate: BigNumber;
}>;
getFlowDistributionFlowRate(token, from, to, overrides?): Promise<[BigNumber]>;
getNetFlow(token, account, overrides?): Promise<[BigNumber]>;
getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber]>;
getPoolAdjustmentFlowRate(pool, overrides?): Promise<[BigNumber]>;
isMemberConnected(pool, member, overrides?): Promise<[boolean]>;
isPool(token, account, overrides?): Promise<[boolean]>;
updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<ContractTransaction>;
}
Type declaration
claimAll:function
- claimAll(pool, memberAddress, userData, overrides?): Promise<ContractTransaction>
Parameters
pool: string
memberAddress: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
connectPool:function
- connectPool(pool, userData, overrides?): Promise<ContractTransaction>
Parameters
pool: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
createPool:function
- createPool(token, admin, config, overrides?): Promise<ContractTransaction>
Parameters
token: string
admin: string
config: PoolConfigStruct
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
disconnectPool:function
- disconnectPool(pool, userData, overrides?): Promise<ContractTransaction>
Parameters
pool: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
distribute:function
- distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<ContractTransaction>
Parameters
token: string
from: string
pool: string
requestedAmount: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
distributeFlow:function
- distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<ContractTransaction>
Parameters
token: string
from: string
pool: string
requestedFlowRate: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
estimateDistributionActualAmount:function
- estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<[BigNumber] & {
actualAmount: BigNumber;
}> Parameters
token: string
from: string
to: string
requestedAmount: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<[BigNumber] & {
actualAmount: BigNumber;
}>
estimateFlowDistributionActualFlowRate:function
- estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
actualFlowRate: BigNumber;
totalDistributionFlowRate: BigNumber;
}> Parameters
token: string
from: string
to: string
requestedFlowRate: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<[BigNumber, BigNumber] & {
actualFlowRate: BigNumber;
totalDistributionFlowRate: BigNumber;
}>
getFlowDistributionFlowRate:function
- getFlowDistributionFlowRate(token, from, to, overrides?): Promise<[BigNumber]>
Parameters
token: string
from: string
to: string
Optional
overrides: CallOverrides
Returns Promise<[BigNumber]>
getNetFlow:function
- getNetFlow(token, account, overrides?): Promise<[BigNumber]>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<[BigNumber]>
getPoolAdjustmentFlowInfo:function
- getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber]>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<[string, string, BigNumber]>
getPoolAdjustmentFlowRate:function
- getPoolAdjustmentFlowRate(pool, overrides?): Promise<[BigNumber]>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<[BigNumber]>
isMemberConnected:function
- isMemberConnected(pool, member, overrides?): Promise<[boolean]>
Parameters
pool: string
member: string
Optional
overrides: CallOverrides
Returns Promise<[boolean]>
isPool:function
- isPool(token, account, overrides?): Promise<[boolean]>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<[boolean]>
updateMemberUnits:function
- updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<ContractTransaction>
Parameters
pool: string
memberAddress: string
newUnits: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<ContractTransaction>
interface
interface: GDAv1ForwarderInterface
populateTransaction
populateTransaction: {
claimAll(pool, memberAddress, userData, overrides?): Promise<PopulatedTransaction>;
connectPool(pool, userData, overrides?): Promise<PopulatedTransaction>;
createPool(token, admin, config, overrides?): Promise<PopulatedTransaction>;
disconnectPool(pool, userData, overrides?): Promise<PopulatedTransaction>;
distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<PopulatedTransaction>;
distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<PopulatedTransaction>;
estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<PopulatedTransaction>;
estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<PopulatedTransaction>;
getFlowDistributionFlowRate(token, from, to, overrides?): Promise<PopulatedTransaction>;
getNetFlow(token, account, overrides?): Promise<PopulatedTransaction>;
getPoolAdjustmentFlowInfo(pool, overrides?): Promise<PopulatedTransaction>;
getPoolAdjustmentFlowRate(pool, overrides?): Promise<PopulatedTransaction>;
isMemberConnected(pool, member, overrides?): Promise<PopulatedTransaction>;
isPool(token, account, overrides?): Promise<PopulatedTransaction>;
updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<PopulatedTransaction>;
}
Type declaration
claimAll:function
- claimAll(pool, memberAddress, userData, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
memberAddress: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
connectPool:function
- connectPool(pool, userData, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
createPool:function
- createPool(token, admin, config, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
admin: string
config: PoolConfigStruct
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
disconnectPool:function
- disconnectPool(pool, userData, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
distribute:function
- distribute(token, from, pool, requestedAmount, userData, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
from: string
pool: string
requestedAmount: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
distributeFlow:function
- distributeFlow(token, from, pool, requestedFlowRate, userData, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
from: string
pool: string
requestedFlowRate: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>
estimateDistributionActualAmount:function
- estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
from: string
to: string
requestedAmount: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
estimateFlowDistributionActualFlowRate:function
- estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
from: string
to: string
requestedFlowRate: BigNumberish
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getFlowDistributionFlowRate:function
- getFlowDistributionFlowRate(token, from, to, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
from: string
to: string
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getNetFlow:function
- getNetFlow(token, account, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getPoolAdjustmentFlowInfo:function
- getPoolAdjustmentFlowInfo(pool, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
getPoolAdjustmentFlowRate:function
- getPoolAdjustmentFlowRate(pool, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
isMemberConnected:function
- isMemberConnected(pool, member, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
member: string
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
isPool:function
- isPool(token, account, overrides?): Promise<PopulatedTransaction>
Parameters
token: string
account: string
Optional
overrides: CallOverrides
Returns Promise<PopulatedTransaction>
updateMemberUnits:function
- updateMemberUnits(pool, memberAddress, newUnits, userData, overrides?): Promise<PopulatedTransaction>
Parameters
pool: string
memberAddress: string
newUnits: BigNumberish
userData: BytesLike
Optional
overrides: Overrides & {
from?: string;
}
Returns Promise<PopulatedTransaction>