Interface SuperfluidPool

interface SuperfluidPool {
    callStatic: {
        GDA(overrides?): Promise<string>;
        admin(overrides?): Promise<string>;
        allowance(owner, spender, overrides?): Promise<BigNumber>;
        approve(spender, amount, overrides?): Promise<boolean>;
        balanceOf(account, overrides?): Promise<BigNumber>;
        castrate(overrides?): Promise<void>;
        claimAll()(overrides?): Promise<boolean>;
        claimAll(address)(memberAddr, overrides?): Promise<boolean>;
        decreaseAllowance(spender, subtractedValue, overrides?): Promise<boolean>;
        distributionFromAnyAddress(overrides?): Promise<boolean>;
        getClaimable(memberAddr, time, overrides?): Promise<BigNumber>;
        getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
            claimableBalance: BigNumber;
            timestamp: BigNumber;
        }>;
        getDisconnectedBalance(time, overrides?): Promise<BigNumber>;
        getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>;
        getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>;
        getTotalConnectedFlowRate(overrides?): Promise<BigNumber>;
        getTotalConnectedUnits(overrides?): Promise<BigNumber>;
        getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>;
        getTotalDisconnectedUnits(overrides?): Promise<BigNumber>;
        getTotalFlowRate(overrides?): Promise<BigNumber>;
        getTotalUnits(overrides?): Promise<BigNumber>;
        getUnits(memberAddr, overrides?): Promise<BigNumber>;
        increaseAllowance(spender, addedValue, overrides?): Promise<boolean>;
        initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<void>;
        operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<boolean>;
        operatorSetIndex(index, overrides?): Promise<boolean>;
        poolOperatorGetIndex(overrides?): Promise<PoolIndexDataStructOutput>;
        proxiableUUID(overrides?): Promise<string>;
        superToken(overrides?): Promise<string>;
        totalSupply(overrides?): Promise<BigNumber>;
        transfer(to, amount, overrides?): Promise<boolean>;
        transferFrom(from, to, amount, overrides?): Promise<boolean>;
        transferabilityForUnitsOwner(overrides?): Promise<boolean>;
        updateMemberUnits(memberAddr, newUnits, overrides?): Promise<boolean>;
    };
    estimateGas: {
        GDA(overrides?): Promise<BigNumber>;
        admin(overrides?): Promise<BigNumber>;
        allowance(owner, spender, overrides?): Promise<BigNumber>;
        approve(spender, amount, overrides?): Promise<BigNumber>;
        balanceOf(account, overrides?): Promise<BigNumber>;
        castrate(overrides?): Promise<BigNumber>;
        claimAll()(overrides?): Promise<BigNumber>;
        claimAll(address)(memberAddr, overrides?): Promise<BigNumber>;
        decreaseAllowance(spender, subtractedValue, overrides?): Promise<BigNumber>;
        distributionFromAnyAddress(overrides?): Promise<BigNumber>;
        getClaimable(memberAddr, time, overrides?): Promise<BigNumber>;
        getClaimableNow(memberAddr, overrides?): Promise<BigNumber>;
        getDisconnectedBalance(time, overrides?): Promise<BigNumber>;
        getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>;
        getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>;
        getTotalConnectedFlowRate(overrides?): Promise<BigNumber>;
        getTotalConnectedUnits(overrides?): Promise<BigNumber>;
        getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>;
        getTotalDisconnectedUnits(overrides?): Promise<BigNumber>;
        getTotalFlowRate(overrides?): Promise<BigNumber>;
        getTotalUnits(overrides?): Promise<BigNumber>;
        getUnits(memberAddr, overrides?): Promise<BigNumber>;
        increaseAllowance(spender, addedValue, overrides?): Promise<BigNumber>;
        initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<BigNumber>;
        operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<BigNumber>;
        operatorSetIndex(index, overrides?): Promise<BigNumber>;
        poolOperatorGetIndex(overrides?): Promise<BigNumber>;
        proxiableUUID(overrides?): Promise<BigNumber>;
        superToken(overrides?): Promise<BigNumber>;
        totalSupply(overrides?): Promise<BigNumber>;
        transfer(to, amount, overrides?): Promise<BigNumber>;
        transferFrom(from, to, amount, overrides?): Promise<BigNumber>;
        transferabilityForUnitsOwner(overrides?): Promise<BigNumber>;
        updateMemberUnits(memberAddr, newUnits, overrides?): Promise<BigNumber>;
    };
    filters: {
        Approval(owner?, spender?, value?): ApprovalEventFilter;
        Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter;
        DistributionClaimed(token?, member?, claimedAmount?, totalClaimed?): DistributionClaimedEventFilter;
        DistributionClaimed(address,address,int256,int256)(token?, member?, claimedAmount?, totalClaimed?): DistributionClaimedEventFilter;
        Initialized(version?): InitializedEventFilter;
        Initialized(uint8)(version?): InitializedEventFilter;
        MemberUnitsUpdated(token?, member?, oldUnits?, newUnits?): MemberUnitsUpdatedEventFilter;
        MemberUnitsUpdated(address,address,uint128,uint128)(token?, member?, oldUnits?, newUnits?): MemberUnitsUpdatedEventFilter;
        Transfer(from?, to?, value?): TransferEventFilter;
        Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter;
    };
    functions: {
        GDA(overrides?): Promise<[string]>;
        admin(overrides?): Promise<[string]>;
        allowance(owner, spender, overrides?): Promise<[BigNumber]>;
        approve(spender, amount, overrides?): Promise<ContractTransaction>;
        balanceOf(account, overrides?): Promise<[BigNumber]>;
        castrate(overrides?): Promise<ContractTransaction>;
        claimAll()(overrides?): Promise<ContractTransaction>;
        claimAll(address)(memberAddr, overrides?): Promise<ContractTransaction>;
        decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>;
        distributionFromAnyAddress(overrides?): Promise<[boolean]>;
        getClaimable(memberAddr, time, overrides?): Promise<[BigNumber]>;
        getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
            claimableBalance: BigNumber;
            timestamp: BigNumber;
        }>;
        getDisconnectedBalance(time, overrides?): Promise<[BigNumber] & {
            balance: BigNumber;
        }>;
        getMemberFlowRate(memberAddr, overrides?): Promise<[BigNumber]>;
        getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<[BigNumber]>;
        getTotalConnectedFlowRate(overrides?): Promise<[BigNumber]>;
        getTotalConnectedUnits(overrides?): Promise<[BigNumber]>;
        getTotalDisconnectedFlowRate(overrides?): Promise<[BigNumber] & {
            flowRate: BigNumber;
        }>;
        getTotalDisconnectedUnits(overrides?): Promise<[BigNumber]>;
        getTotalFlowRate(overrides?): Promise<[BigNumber]>;
        getTotalUnits(overrides?): Promise<[BigNumber]>;
        getUnits(memberAddr, overrides?): Promise<[BigNumber]>;
        increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>;
        initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<ContractTransaction>;
        operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<ContractTransaction>;
        operatorSetIndex(index, overrides?): Promise<ContractTransaction>;
        poolOperatorGetIndex(overrides?): Promise<[PoolIndexDataStructOutput]>;
        proxiableUUID(overrides?): Promise<[string]>;
        superToken(overrides?): Promise<[string]>;
        totalSupply(overrides?): Promise<[BigNumber]>;
        transfer(to, amount, overrides?): Promise<ContractTransaction>;
        transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>;
        transferabilityForUnitsOwner(overrides?): Promise<[boolean]>;
        updateMemberUnits(memberAddr, newUnits, overrides?): Promise<ContractTransaction>;
    };
    interface: SuperfluidPoolInterface;
    off: OnEvent<SuperfluidPool>;
    on: OnEvent<SuperfluidPool>;
    once: OnEvent<SuperfluidPool>;
    populateTransaction: {
        GDA(overrides?): Promise<PopulatedTransaction>;
        admin(overrides?): Promise<PopulatedTransaction>;
        allowance(owner, spender, overrides?): Promise<PopulatedTransaction>;
        approve(spender, amount, overrides?): Promise<PopulatedTransaction>;
        balanceOf(account, overrides?): Promise<PopulatedTransaction>;
        castrate(overrides?): Promise<PopulatedTransaction>;
        claimAll()(overrides?): Promise<PopulatedTransaction>;
        claimAll(address)(memberAddr, overrides?): Promise<PopulatedTransaction>;
        decreaseAllowance(spender, subtractedValue, overrides?): Promise<PopulatedTransaction>;
        distributionFromAnyAddress(overrides?): Promise<PopulatedTransaction>;
        getClaimable(memberAddr, time, overrides?): Promise<PopulatedTransaction>;
        getClaimableNow(memberAddr, overrides?): Promise<PopulatedTransaction>;
        getDisconnectedBalance(time, overrides?): Promise<PopulatedTransaction>;
        getMemberFlowRate(memberAddr, overrides?): Promise<PopulatedTransaction>;
        getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<PopulatedTransaction>;
        getTotalConnectedFlowRate(overrides?): Promise<PopulatedTransaction>;
        getTotalConnectedUnits(overrides?): Promise<PopulatedTransaction>;
        getTotalDisconnectedFlowRate(overrides?): Promise<PopulatedTransaction>;
        getTotalDisconnectedUnits(overrides?): Promise<PopulatedTransaction>;
        getTotalFlowRate(overrides?): Promise<PopulatedTransaction>;
        getTotalUnits(overrides?): Promise<PopulatedTransaction>;
        getUnits(memberAddr, overrides?): Promise<PopulatedTransaction>;
        increaseAllowance(spender, addedValue, overrides?): Promise<PopulatedTransaction>;
        initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<PopulatedTransaction>;
        operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<PopulatedTransaction>;
        operatorSetIndex(index, overrides?): Promise<PopulatedTransaction>;
        poolOperatorGetIndex(overrides?): Promise<PopulatedTransaction>;
        proxiableUUID(overrides?): Promise<PopulatedTransaction>;
        superToken(overrides?): Promise<PopulatedTransaction>;
        totalSupply(overrides?): Promise<PopulatedTransaction>;
        transfer(to, amount, overrides?): Promise<PopulatedTransaction>;
        transferFrom(from, to, amount, overrides?): Promise<PopulatedTransaction>;
        transferabilityForUnitsOwner(overrides?): Promise<PopulatedTransaction>;
        updateMemberUnits(memberAddr, newUnits, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<SuperfluidPool>;
    GDA(overrides?): Promise<string>;
    admin(overrides?): Promise<string>;
    allowance(owner, spender, overrides?): Promise<BigNumber>;
    approve(spender, amount, overrides?): Promise<ContractTransaction>;
    attach(addressOrName): this;
    balanceOf(account, overrides?): Promise<BigNumber>;
    castrate(overrides?): Promise<ContractTransaction>;
    claimAll()(overrides?): Promise<ContractTransaction>;
    claimAll(address)(memberAddr, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<SuperfluidPool>;
    distributionFromAnyAddress(overrides?): Promise<boolean>;
    getClaimable(memberAddr, time, overrides?): Promise<BigNumber>;
    getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
        claimableBalance: BigNumber;
        timestamp: BigNumber;
    }>;
    getDisconnectedBalance(time, overrides?): Promise<BigNumber>;
    getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>;
    getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>;
    getTotalConnectedFlowRate(overrides?): Promise<BigNumber>;
    getTotalConnectedUnits(overrides?): Promise<BigNumber>;
    getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>;
    getTotalDisconnectedUnits(overrides?): Promise<BigNumber>;
    getTotalFlowRate(overrides?): Promise<BigNumber>;
    getTotalUnits(overrides?): Promise<BigNumber>;
    getUnits(memberAddr, overrides?): Promise<BigNumber>;
    increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>;
    initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<ContractTransaction>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<ContractTransaction>;
    operatorSetIndex(index, overrides?): Promise<ContractTransaction>;
    poolOperatorGetIndex(overrides?): Promise<PoolIndexDataStructOutput>;
    proxiableUUID(overrides?): Promise<string>;
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    superToken(overrides?): Promise<string>;
    totalSupply(overrides?): Promise<BigNumber>;
    transfer(to, amount, overrides?): Promise<ContractTransaction>;
    transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>;
    transferabilityForUnitsOwner(overrides?): Promise<boolean>;
    updateMemberUnits(memberAddr, newUnits, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • SuperfluidPool

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

GDA admin allowance approve attach balanceOf castrate claimAll() claimAll(address) connect decreaseAllowance deployed distributionFromAnyAddress getClaimable getClaimableNow getDisconnectedBalance getMemberFlowRate getTotalAmountReceivedByMember getTotalConnectedFlowRate getTotalConnectedUnits getTotalDisconnectedFlowRate getTotalDisconnectedUnits getTotalFlowRate getTotalUnits getUnits increaseAllowance initialize listeners operatorConnectMember operatorSetIndex poolOperatorGetIndex proxiableUUID queryFilter removeAllListeners superToken totalSupply transfer transferFrom transferabilityForUnitsOwner updateMemberUnits

Properties

callStatic

callStatic: {
    GDA(overrides?): Promise<string>;
    admin(overrides?): Promise<string>;
    allowance(owner, spender, overrides?): Promise<BigNumber>;
    approve(spender, amount, overrides?): Promise<boolean>;
    balanceOf(account, overrides?): Promise<BigNumber>;
    castrate(overrides?): Promise<void>;
    claimAll()(overrides?): Promise<boolean>;
    claimAll(address)(memberAddr, overrides?): Promise<boolean>;
    decreaseAllowance(spender, subtractedValue, overrides?): Promise<boolean>;
    distributionFromAnyAddress(overrides?): Promise<boolean>;
    getClaimable(memberAddr, time, overrides?): Promise<BigNumber>;
    getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
        claimableBalance: BigNumber;
        timestamp: BigNumber;
    }>;
    getDisconnectedBalance(time, overrides?): Promise<BigNumber>;
    getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>;
    getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>;
    getTotalConnectedFlowRate(overrides?): Promise<BigNumber>;
    getTotalConnectedUnits(overrides?): Promise<BigNumber>;
    getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>;
    getTotalDisconnectedUnits(overrides?): Promise<BigNumber>;
    getTotalFlowRate(overrides?): Promise<BigNumber>;
    getTotalUnits(overrides?): Promise<BigNumber>;
    getUnits(memberAddr, overrides?): Promise<BigNumber>;
    increaseAllowance(spender, addedValue, overrides?): Promise<boolean>;
    initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<void>;
    operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<boolean>;
    operatorSetIndex(index, overrides?): Promise<boolean>;
    poolOperatorGetIndex(overrides?): Promise<PoolIndexDataStructOutput>;
    proxiableUUID(overrides?): Promise<string>;
    superToken(overrides?): Promise<string>;
    totalSupply(overrides?): Promise<BigNumber>;
    transfer(to, amount, overrides?): Promise<boolean>;
    transferFrom(from, to, amount, overrides?): Promise<boolean>;
    transferabilityForUnitsOwner(overrides?): Promise<boolean>;
    updateMemberUnits(memberAddr, newUnits, overrides?): Promise<boolean>;
}

Type declaration

  • GDA:function
    • GDA(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • admin:function
    • admin(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>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<BigNumber>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • castrate:function
    • castrate(overrides?): Promise<void>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • claimAll():function
    • claimAll()(overrides?): Promise<boolean>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • claimAll(address):function
    • claimAll(address)(memberAddr, overrides?): Promise<boolean>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • decreaseAllowance:function
    • decreaseAllowance(spender, subtractedValue, overrides?): Promise<boolean>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • distributionFromAnyAddress:function
    • distributionFromAnyAddress(overrides?): Promise<boolean>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • getClaimable:function
    • getClaimable(memberAddr, time, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimableNow:function
    • getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
          claimableBalance: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & {
          claimableBalance: BigNumber;
          timestamp: BigNumber;
      }>

  • getDisconnectedBalance:function
    • getDisconnectedBalance(time, overrides?): Promise<BigNumber>

    • Parameters

      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getMemberFlowRate:function
    • getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalAmountReceivedByMember:function
    • getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalConnectedFlowRate:function
    • getTotalConnectedFlowRate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalConnectedUnits:function
    • getTotalConnectedUnits(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDisconnectedFlowRate:function
    • getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDisconnectedUnits:function
    • getTotalDisconnectedUnits(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalFlowRate:function
    • getTotalFlowRate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalUnits:function
    • getTotalUnits(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnits:function
    • getUnits(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • 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(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<void>

    • Parameters

      • admin_: string
      • superToken_: string
      • transferabilityForUnitsOwner_: boolean
      • distributionFromAnyAddress_: boolean
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • operatorConnectMember:function
    • operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<boolean>

    • Parameters

      • memberAddr: string
      • doConnect: boolean
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • operatorSetIndex:function
    • operatorSetIndex(index, overrides?): Promise<boolean>

    • Parameters

      • index: PDPoolIndexStruct
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • poolOperatorGetIndex:function
    • poolOperatorGetIndex(overrides?): Promise<PoolIndexDataStructOutput>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PoolIndexDataStructOutput>

  • proxiableUUID:function
    • proxiableUUID(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • superToken:function
    • superToken(overrides?): Promise<string>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • totalSupply:function
    • totalSupply(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<boolean>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<boolean>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • transferabilityForUnitsOwner:function
    • transferabilityForUnitsOwner(overrides?): Promise<boolean>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • updateMemberUnits:function
    • updateMemberUnits(memberAddr, newUnits, overrides?): Promise<boolean>

    • Parameters

      • memberAddr: string
      • newUnits: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

estimateGas

estimateGas: {
    GDA(overrides?): Promise<BigNumber>;
    admin(overrides?): Promise<BigNumber>;
    allowance(owner, spender, overrides?): Promise<BigNumber>;
    approve(spender, amount, overrides?): Promise<BigNumber>;
    balanceOf(account, overrides?): Promise<BigNumber>;
    castrate(overrides?): Promise<BigNumber>;
    claimAll()(overrides?): Promise<BigNumber>;
    claimAll(address)(memberAddr, overrides?): Promise<BigNumber>;
    decreaseAllowance(spender, subtractedValue, overrides?): Promise<BigNumber>;
    distributionFromAnyAddress(overrides?): Promise<BigNumber>;
    getClaimable(memberAddr, time, overrides?): Promise<BigNumber>;
    getClaimableNow(memberAddr, overrides?): Promise<BigNumber>;
    getDisconnectedBalance(time, overrides?): Promise<BigNumber>;
    getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>;
    getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>;
    getTotalConnectedFlowRate(overrides?): Promise<BigNumber>;
    getTotalConnectedUnits(overrides?): Promise<BigNumber>;
    getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>;
    getTotalDisconnectedUnits(overrides?): Promise<BigNumber>;
    getTotalFlowRate(overrides?): Promise<BigNumber>;
    getTotalUnits(overrides?): Promise<BigNumber>;
    getUnits(memberAddr, overrides?): Promise<BigNumber>;
    increaseAllowance(spender, addedValue, overrides?): Promise<BigNumber>;
    initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<BigNumber>;
    operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<BigNumber>;
    operatorSetIndex(index, overrides?): Promise<BigNumber>;
    poolOperatorGetIndex(overrides?): Promise<BigNumber>;
    proxiableUUID(overrides?): Promise<BigNumber>;
    superToken(overrides?): Promise<BigNumber>;
    totalSupply(overrides?): Promise<BigNumber>;
    transfer(to, amount, overrides?): Promise<BigNumber>;
    transferFrom(from, to, amount, overrides?): Promise<BigNumber>;
    transferabilityForUnitsOwner(overrides?): Promise<BigNumber>;
    updateMemberUnits(memberAddr, newUnits, overrides?): Promise<BigNumber>;
}

Type declaration

  • GDA:function
    • GDA(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • admin:function
    • admin(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>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<BigNumber>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • castrate:function
    • castrate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • claimAll():function
    • claimAll()(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • claimAll(address):function
    • claimAll(address)(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • decreaseAllowance:function
    • decreaseAllowance(spender, subtractedValue, overrides?): Promise<BigNumber>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • distributionFromAnyAddress:function
    • distributionFromAnyAddress(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimable:function
    • getClaimable(memberAddr, time, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getClaimableNow:function
    • getClaimableNow(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getDisconnectedBalance:function
    • getDisconnectedBalance(time, overrides?): Promise<BigNumber>

    • Parameters

      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getMemberFlowRate:function
    • getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalAmountReceivedByMember:function
    • getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalConnectedFlowRate:function
    • getTotalConnectedFlowRate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalConnectedUnits:function
    • getTotalConnectedUnits(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDisconnectedFlowRate:function
    • getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalDisconnectedUnits:function
    • getTotalDisconnectedUnits(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalFlowRate:function
    • getTotalFlowRate(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getTotalUnits:function
    • getTotalUnits(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getUnits:function
    • getUnits(memberAddr, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • 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(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<BigNumber>

    • Parameters

      • admin_: string
      • superToken_: string
      • transferabilityForUnitsOwner_: boolean
      • distributionFromAnyAddress_: boolean
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • operatorConnectMember:function
    • operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • doConnect: boolean
      • time: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • operatorSetIndex:function
    • operatorSetIndex(index, overrides?): Promise<BigNumber>

    • Parameters

      • index: PDPoolIndexStruct
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • poolOperatorGetIndex:function
    • poolOperatorGetIndex(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • proxiableUUID:function
    • proxiableUUID(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • superToken:function
    • superToken(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • totalSupply:function
    • totalSupply(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<BigNumber>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<BigNumber>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • transferabilityForUnitsOwner:function
    • transferabilityForUnitsOwner(overrides?): Promise<BigNumber>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • updateMemberUnits:function
    • updateMemberUnits(memberAddr, newUnits, overrides?): Promise<BigNumber>

    • Parameters

      • memberAddr: string
      • newUnits: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

filters

filters: {
    Approval(owner?, spender?, value?): ApprovalEventFilter;
    Approval(address,address,uint256)(owner?, spender?, value?): ApprovalEventFilter;
    DistributionClaimed(token?, member?, claimedAmount?, totalClaimed?): DistributionClaimedEventFilter;
    DistributionClaimed(address,address,int256,int256)(token?, member?, claimedAmount?, totalClaimed?): DistributionClaimedEventFilter;
    Initialized(version?): InitializedEventFilter;
    Initialized(uint8)(version?): InitializedEventFilter;
    MemberUnitsUpdated(token?, member?, oldUnits?, newUnits?): MemberUnitsUpdatedEventFilter;
    MemberUnitsUpdated(address,address,uint128,uint128)(token?, member?, oldUnits?, newUnits?): MemberUnitsUpdatedEventFilter;
    Transfer(from?, to?, value?): TransferEventFilter;
    Transfer(address,address,uint256)(from?, to?, value?): TransferEventFilter;
}

Type declaration

  • 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

  • DistributionClaimed:function
    • DistributionClaimed(token?, member?, claimedAmount?, totalClaimed?): DistributionClaimedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional member: null | string
      • Optional claimedAmount: null
      • Optional totalClaimed: null

      Returns DistributionClaimedEventFilter

  • DistributionClaimed(address,address,int256,int256):function
    • DistributionClaimed(address,address,int256,int256)(token?, member?, claimedAmount?, totalClaimed?): DistributionClaimedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional member: null | string
      • Optional claimedAmount: null
      • Optional totalClaimed: null

      Returns DistributionClaimedEventFilter

  • Initialized:function
    • Initialized(version?): InitializedEventFilter

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

  • Initialized(uint8):function
    • Initialized(uint8)(version?): InitializedEventFilter

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

  • MemberUnitsUpdated:function
    • MemberUnitsUpdated(token?, member?, oldUnits?, newUnits?): MemberUnitsUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional member: null | string
      • Optional oldUnits: null
      • Optional newUnits: null

      Returns MemberUnitsUpdatedEventFilter

  • MemberUnitsUpdated(address,address,uint128,uint128):function
    • MemberUnitsUpdated(address,address,uint128,uint128)(token?, member?, oldUnits?, newUnits?): MemberUnitsUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional member: null | string
      • Optional oldUnits: null
      • Optional newUnits: null

      Returns MemberUnitsUpdatedEventFilter

  • 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: {
    GDA(overrides?): Promise<[string]>;
    admin(overrides?): Promise<[string]>;
    allowance(owner, spender, overrides?): Promise<[BigNumber]>;
    approve(spender, amount, overrides?): Promise<ContractTransaction>;
    balanceOf(account, overrides?): Promise<[BigNumber]>;
    castrate(overrides?): Promise<ContractTransaction>;
    claimAll()(overrides?): Promise<ContractTransaction>;
    claimAll(address)(memberAddr, overrides?): Promise<ContractTransaction>;
    decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>;
    distributionFromAnyAddress(overrides?): Promise<[boolean]>;
    getClaimable(memberAddr, time, overrides?): Promise<[BigNumber]>;
    getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
        claimableBalance: BigNumber;
        timestamp: BigNumber;
    }>;
    getDisconnectedBalance(time, overrides?): Promise<[BigNumber] & {
        balance: BigNumber;
    }>;
    getMemberFlowRate(memberAddr, overrides?): Promise<[BigNumber]>;
    getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<[BigNumber]>;
    getTotalConnectedFlowRate(overrides?): Promise<[BigNumber]>;
    getTotalConnectedUnits(overrides?): Promise<[BigNumber]>;
    getTotalDisconnectedFlowRate(overrides?): Promise<[BigNumber] & {
        flowRate: BigNumber;
    }>;
    getTotalDisconnectedUnits(overrides?): Promise<[BigNumber]>;
    getTotalFlowRate(overrides?): Promise<[BigNumber]>;
    getTotalUnits(overrides?): Promise<[BigNumber]>;
    getUnits(memberAddr, overrides?): Promise<[BigNumber]>;
    increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>;
    initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<ContractTransaction>;
    operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<ContractTransaction>;
    operatorSetIndex(index, overrides?): Promise<ContractTransaction>;
    poolOperatorGetIndex(overrides?): Promise<[PoolIndexDataStructOutput]>;
    proxiableUUID(overrides?): Promise<[string]>;
    superToken(overrides?): Promise<[string]>;
    totalSupply(overrides?): Promise<[BigNumber]>;
    transfer(to, amount, overrides?): Promise<ContractTransaction>;
    transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>;
    transferabilityForUnitsOwner(overrides?): Promise<[boolean]>;
    updateMemberUnits(memberAddr, newUnits, overrides?): Promise<ContractTransaction>;
}

Type declaration

  • GDA:function
    • GDA(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • admin:function
    • admin(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>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<[BigNumber]>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • castrate:function
    • castrate(overrides?): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • claimAll():function
    • claimAll()(overrides?): Promise<ContractTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • claimAll(address):function
    • claimAll(address)(memberAddr, overrides?): Promise<ContractTransaction>

    • Parameters

      • memberAddr: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • decreaseAllowance:function
    • decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • distributionFromAnyAddress:function
    • distributionFromAnyAddress(overrides?): Promise<[boolean]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • getClaimable:function
    • getClaimable(memberAddr, time, overrides?): Promise<[BigNumber]>

    • Parameters

      • memberAddr: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getClaimableNow:function
    • getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
          claimableBalance: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & {
          claimableBalance: BigNumber;
          timestamp: BigNumber;
      }>

  • getDisconnectedBalance:function
    • getDisconnectedBalance(time, overrides?): Promise<[BigNumber] & {
          balance: BigNumber;
      }>

    • Parameters

      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & {
          balance: BigNumber;
      }>

  • getMemberFlowRate:function
    • getMemberFlowRate(memberAddr, overrides?): Promise<[BigNumber]>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalAmountReceivedByMember:function
    • getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<[BigNumber]>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalConnectedFlowRate:function
    • getTotalConnectedFlowRate(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalConnectedUnits:function
    • getTotalConnectedUnits(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalDisconnectedFlowRate:function
    • getTotalDisconnectedFlowRate(overrides?): Promise<[BigNumber] & {
          flowRate: BigNumber;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber] & {
          flowRate: BigNumber;
      }>

  • getTotalDisconnectedUnits:function
    • getTotalDisconnectedUnits(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalFlowRate:function
    • getTotalFlowRate(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getTotalUnits:function
    • getTotalUnits(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • getUnits:function
    • getUnits(memberAddr, overrides?): Promise<[BigNumber]>

    • Parameters

      • memberAddr: string
      • 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(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<ContractTransaction>

    • Parameters

      • admin_: string
      • superToken_: string
      • transferabilityForUnitsOwner_: boolean
      • distributionFromAnyAddress_: boolean
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • operatorConnectMember:function
    • operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<ContractTransaction>

    • Parameters

      • memberAddr: string
      • doConnect: boolean
      • time: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • operatorSetIndex:function
    • operatorSetIndex(index, overrides?): Promise<ContractTransaction>

    • Parameters

      • index: PDPoolIndexStruct
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • poolOperatorGetIndex:function
    • poolOperatorGetIndex(overrides?): Promise<[PoolIndexDataStructOutput]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[PoolIndexDataStructOutput]>

  • proxiableUUID:function
    • proxiableUUID(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • superToken:function
    • superToken(overrides?): Promise<[string]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • totalSupply:function
    • totalSupply(overrides?): Promise<[BigNumber]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber]>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<ContractTransaction>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • transferabilityForUnitsOwner:function
    • transferabilityForUnitsOwner(overrides?): Promise<[boolean]>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • updateMemberUnits:function
    • updateMemberUnits(memberAddr, newUnits, overrides?): Promise<ContractTransaction>

    • Parameters

      • memberAddr: string
      • newUnits: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

interface

interface: SuperfluidPoolInterface

off

off: OnEvent<SuperfluidPool>

on

on: OnEvent<SuperfluidPool>

once

once: OnEvent<SuperfluidPool>

populateTransaction

populateTransaction: {
    GDA(overrides?): Promise<PopulatedTransaction>;
    admin(overrides?): Promise<PopulatedTransaction>;
    allowance(owner, spender, overrides?): Promise<PopulatedTransaction>;
    approve(spender, amount, overrides?): Promise<PopulatedTransaction>;
    balanceOf(account, overrides?): Promise<PopulatedTransaction>;
    castrate(overrides?): Promise<PopulatedTransaction>;
    claimAll()(overrides?): Promise<PopulatedTransaction>;
    claimAll(address)(memberAddr, overrides?): Promise<PopulatedTransaction>;
    decreaseAllowance(spender, subtractedValue, overrides?): Promise<PopulatedTransaction>;
    distributionFromAnyAddress(overrides?): Promise<PopulatedTransaction>;
    getClaimable(memberAddr, time, overrides?): Promise<PopulatedTransaction>;
    getClaimableNow(memberAddr, overrides?): Promise<PopulatedTransaction>;
    getDisconnectedBalance(time, overrides?): Promise<PopulatedTransaction>;
    getMemberFlowRate(memberAddr, overrides?): Promise<PopulatedTransaction>;
    getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<PopulatedTransaction>;
    getTotalConnectedFlowRate(overrides?): Promise<PopulatedTransaction>;
    getTotalConnectedUnits(overrides?): Promise<PopulatedTransaction>;
    getTotalDisconnectedFlowRate(overrides?): Promise<PopulatedTransaction>;
    getTotalDisconnectedUnits(overrides?): Promise<PopulatedTransaction>;
    getTotalFlowRate(overrides?): Promise<PopulatedTransaction>;
    getTotalUnits(overrides?): Promise<PopulatedTransaction>;
    getUnits(memberAddr, overrides?): Promise<PopulatedTransaction>;
    increaseAllowance(spender, addedValue, overrides?): Promise<PopulatedTransaction>;
    initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<PopulatedTransaction>;
    operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<PopulatedTransaction>;
    operatorSetIndex(index, overrides?): Promise<PopulatedTransaction>;
    poolOperatorGetIndex(overrides?): Promise<PopulatedTransaction>;
    proxiableUUID(overrides?): Promise<PopulatedTransaction>;
    superToken(overrides?): Promise<PopulatedTransaction>;
    totalSupply(overrides?): Promise<PopulatedTransaction>;
    transfer(to, amount, overrides?): Promise<PopulatedTransaction>;
    transferFrom(from, to, amount, overrides?): Promise<PopulatedTransaction>;
    transferabilityForUnitsOwner(overrides?): Promise<PopulatedTransaction>;
    updateMemberUnits(memberAddr, newUnits, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

  • GDA:function
    • GDA(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • admin:function
    • admin(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>

  • balanceOf:function
    • balanceOf(account, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • castrate:function
    • castrate(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • claimAll():function
    • claimAll()(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • claimAll(address):function
    • claimAll(address)(memberAddr, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • decreaseAllowance:function
    • decreaseAllowance(spender, subtractedValue, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • spender: string
      • subtractedValue: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • distributionFromAnyAddress:function
    • distributionFromAnyAddress(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getClaimable:function
    • getClaimable(memberAddr, time, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getClaimableNow:function
    • getClaimableNow(memberAddr, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getDisconnectedBalance:function
    • getDisconnectedBalance(time, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getMemberFlowRate:function
    • getMemberFlowRate(memberAddr, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalAmountReceivedByMember:function
    • getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalConnectedFlowRate:function
    • getTotalConnectedFlowRate(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalConnectedUnits:function
    • getTotalConnectedUnits(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalDisconnectedFlowRate:function
    • getTotalDisconnectedFlowRate(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalDisconnectedUnits:function
    • getTotalDisconnectedUnits(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalFlowRate:function
    • getTotalFlowRate(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getTotalUnits:function
    • getTotalUnits(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getUnits:function
    • getUnits(memberAddr, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • 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(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • admin_: string
      • superToken_: string
      • transferabilityForUnitsOwner_: boolean
      • distributionFromAnyAddress_: boolean
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • operatorConnectMember:function
    • operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • doConnect: boolean
      • time: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • operatorSetIndex:function
    • operatorSetIndex(index, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • index: PDPoolIndexStruct
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • poolOperatorGetIndex:function
    • poolOperatorGetIndex(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • proxiableUUID:function
    • proxiableUUID(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • superToken:function
    • superToken(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • totalSupply:function
    • totalSupply(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • transfer:function
    • transfer(to, amount, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • transferFrom:function
    • transferFrom(from, to, amount, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • from: string
      • to: string
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • transferabilityForUnitsOwner:function
    • transferabilityForUnitsOwner(overrides?): Promise<PopulatedTransaction>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • updateMemberUnits:function
    • updateMemberUnits(memberAddr, newUnits, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • memberAddr: string
      • newUnits: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<SuperfluidPool>

Methods

GDA

  • GDA(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

admin

  • admin(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

allowance

  • allowance(owner, spender, overrides?): Promise<BigNumber>

  • Parameters

    • owner: string
    • spender: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

approve

  • approve(spender, amount, overrides?): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • amount: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

balanceOf

  • balanceOf(account, overrides?): Promise<BigNumber>

  • Parameters

    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

castrate

  • castrate(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

claimAll()

  • claimAll()(overrides?): Promise<ContractTransaction>

  • Parameters

    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

claimAll(address)

  • claimAll(address)(memberAddr, overrides?): Promise<ContractTransaction>

  • Parameters

    • memberAddr: string
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

decreaseAllowance

  • decreaseAllowance(spender, subtractedValue, overrides?): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • subtractedValue: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deployed

  • deployed(): Promise<SuperfluidPool>

  • Returns Promise<SuperfluidPool>

distributionFromAnyAddress

  • distributionFromAnyAddress(overrides?): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

getClaimable

  • getClaimable(memberAddr, time, overrides?): Promise<BigNumber>

  • Parameters

    • memberAddr: string
    • time: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getClaimableNow

  • getClaimableNow(memberAddr, overrides?): Promise<[BigNumber, BigNumber] & {
        claimableBalance: BigNumber;
        timestamp: BigNumber;
    }>

  • Parameters

    • memberAddr: string
    • Optional overrides: CallOverrides

    Returns Promise<[BigNumber, BigNumber] & {
        claimableBalance: BigNumber;
        timestamp: BigNumber;
    }>

getDisconnectedBalance

  • getDisconnectedBalance(time, overrides?): Promise<BigNumber>

  • Parameters

    • time: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getMemberFlowRate

  • getMemberFlowRate(memberAddr, overrides?): Promise<BigNumber>

  • Parameters

    • memberAddr: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalAmountReceivedByMember

  • getTotalAmountReceivedByMember(memberAddr, overrides?): Promise<BigNumber>

  • Parameters

    • memberAddr: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalConnectedFlowRate

  • getTotalConnectedFlowRate(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalConnectedUnits

  • getTotalConnectedUnits(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalDisconnectedFlowRate

  • getTotalDisconnectedFlowRate(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalDisconnectedUnits

  • getTotalDisconnectedUnits(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalFlowRate

  • getTotalFlowRate(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getTotalUnits

  • getTotalUnits(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getUnits

  • getUnits(memberAddr, overrides?): Promise<BigNumber>

  • Parameters

    • memberAddr: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

increaseAllowance

  • increaseAllowance(spender, addedValue, overrides?): Promise<ContractTransaction>

  • Parameters

    • spender: string
    • addedValue: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

initialize

  • initialize(admin_, superToken_, transferabilityForUnitsOwner_, distributionFromAnyAddress_, overrides?): Promise<ContractTransaction>

  • Parameters

    • admin_: string
    • superToken_: string
    • transferabilityForUnitsOwner_: boolean
    • distributionFromAnyAddress_: boolean
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

listeners

  • listeners<TEvent>(eventFilter?): TypedListener<TEvent>[]

  • Type Parameters

    • TEvent extends TypedEvent<any, any>

    Parameters

    • Optional eventFilter: TypedEventFilter<TEvent>

    Returns TypedListener<TEvent>[]

  • listeners(eventName?): Listener[]

  • Parameters

    • Optional eventName: string

    Returns Listener[]

operatorConnectMember

  • operatorConnectMember(memberAddr, doConnect, time, overrides?): Promise<ContractTransaction>

  • Parameters

    • memberAddr: string
    • doConnect: boolean
    • time: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

operatorSetIndex

  • operatorSetIndex(index, overrides?): Promise<ContractTransaction>

  • Parameters

    • index: PDPoolIndexStruct
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

poolOperatorGetIndex

  • poolOperatorGetIndex(overrides?): Promise<PoolIndexDataStructOutput>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<PoolIndexDataStructOutput>

proxiableUUID

  • proxiableUUID(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

queryFilter

  • queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>

  • Type Parameters

    • TEvent extends TypedEvent<any, any>

    Parameters

    • event: TypedEventFilter<TEvent>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TEvent[]>

removeAllListeners

  • removeAllListeners<TEvent>(eventFilter): this

  • Type Parameters

    • TEvent extends TypedEvent<any, any>

    Parameters

    • eventFilter: TypedEventFilter<TEvent>

    Returns this

  • removeAllListeners(eventName?): this

  • Parameters

    • Optional eventName: string

    Returns this

superToken

  • superToken(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

totalSupply

  • totalSupply(overrides?): Promise<BigNumber>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

transfer

  • transfer(to, amount, overrides?): Promise<ContractTransaction>

  • Parameters

    • to: string
    • amount: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

transferFrom

  • transferFrom(from, to, amount, overrides?): Promise<ContractTransaction>

  • Parameters

    • from: string
    • to: string
    • amount: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

transferabilityForUnitsOwner

  • transferabilityForUnitsOwner(overrides?): Promise<boolean>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<boolean>

updateMemberUnits

  • updateMemberUnits(memberAddr, newUnits, overrides?): Promise<ContractTransaction>

  • Parameters

    • memberAddr: string
    • newUnits: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc