Interface GeneralDistributionAgreementV1

interface GeneralDistributionAgreementV1 {
    callStatic: {
        SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<string>;
        SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<string>;
        agreementType(overrides?): Promise<string>;
        appendIndexUpdateByPool(token, p, t, overrides?): Promise<boolean>;
        castrate(overrides?): Promise<void>;
        claimAll(pool, memberAddress, ctx, overrides?): Promise<string>;
        connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<string>;
        connectPool(address,bytes)(pool, ctx, overrides?): Promise<string>;
        createPool(token, admin, config, overrides?): Promise<string>;
        disconnectPool(pool, ctx, overrides?): Promise<string>;
        distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<string>;
        distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<string>;
        estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
        estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
            actualFlowRate: BigNumber;
            totalDistributionFlowRate: BigNumber;
        }>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            timestamp: BigNumber;
        }>;
        getCodeAddress(overrides?): Promise<string>;
        getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            lastUpdated: BigNumber;
        }>;
        getFlowRate(token, from, to, overrides?): Promise<BigNumber>;
        getNetFlow(token, account, overrides?): Promise<BigNumber>;
        getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
            flowHash: string;
            flowRate: BigNumber;
            recipient: string;
        }>;
        getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>;
        isMemberConnected(pool, member, overrides?): Promise<boolean>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>;
        isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
            isCurrentlyPatricianPeriod: boolean;
            timestamp: BigNumber;
        }>;
        isPool(token, account, overrides?): Promise<boolean>;
        poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<boolean>;
        proxiableUUID(overrides?): Promise<string>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            buf: BigNumber;
            owedBuffer: BigNumber;
            rtb: BigNumber;
        }>;
        realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            availableBalance: BigNumber;
            buffer: BigNumber;
            owedBuffer: BigNumber;
            timestamp: BigNumber;
        }>;
        superfluidPoolBeacon(overrides?): Promise<string>;
        updateCode(newAddress, overrides?): Promise<void>;
        updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<string>;
    };
    estimateGas: {
        SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<BigNumber>;
        SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<BigNumber>;
        agreementType(overrides?): Promise<BigNumber>;
        appendIndexUpdateByPool(token, p, t, overrides?): Promise<BigNumber>;
        castrate(overrides?): Promise<BigNumber>;
        claimAll(pool, memberAddress, ctx, overrides?): Promise<BigNumber>;
        connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<BigNumber>;
        connectPool(address,bytes)(pool, ctx, overrides?): Promise<BigNumber>;
        createPool(token, admin, config, overrides?): Promise<BigNumber>;
        disconnectPool(pool, ctx, overrides?): Promise<BigNumber>;
        distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<BigNumber>;
        distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<BigNumber>;
        estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
        estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<BigNumber>;
        getAccountFlowInfo(token, account, overrides?): Promise<BigNumber>;
        getCodeAddress(overrides?): Promise<BigNumber>;
        getFlow(token, from, to, overrides?): Promise<BigNumber>;
        getFlowRate(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>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<BigNumber>;
        isPatricianPeriodNow(token, account, overrides?): Promise<BigNumber>;
        isPool(token, account, overrides?): Promise<BigNumber>;
        poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<BigNumber>;
        proxiableUUID(overrides?): Promise<BigNumber>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>;
        realtimeBalanceOfNow(token, account, overrides?): Promise<BigNumber>;
        superfluidPoolBeacon(overrides?): Promise<BigNumber>;
        updateCode(newAddress, overrides?): Promise<BigNumber>;
        updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<BigNumber>;
    };
    filters: {
        BufferAdjusted(token?, pool?, from?, bufferDelta?, newBufferAmount?, totalBufferAmount?): BufferAdjustedEventFilter;
        BufferAdjusted(address,address,address,int256,uint256,uint256)(token?, pool?, from?, bufferDelta?, newBufferAmount?, totalBufferAmount?): BufferAdjustedEventFilter;
        CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter;
        CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter;
        FlowDistributionUpdated(token?, pool?, distributor?, operator?, oldFlowRate?, newDistributorToPoolFlowRate?, newTotalDistributionFlowRate?, adjustmentFlowRecipient?, adjustmentFlowRate?, userData?): FlowDistributionUpdatedEventFilter;
        FlowDistributionUpdated(address,address,address,address,int96,int96,int96,address,int96,bytes)(token?, pool?, distributor?, operator?, oldFlowRate?, newDistributorToPoolFlowRate?, newTotalDistributionFlowRate?, adjustmentFlowRecipient?, adjustmentFlowRate?, userData?): FlowDistributionUpdatedEventFilter;
        Initialized(version?): InitializedEventFilter;
        Initialized(uint8)(version?): InitializedEventFilter;
        InstantDistributionUpdated(token?, pool?, distributor?, operator?, requestedAmount?, actualAmount?, userData?): InstantDistributionUpdatedEventFilter;
        InstantDistributionUpdated(address,address,address,address,uint256,uint256,bytes)(token?, pool?, distributor?, operator?, requestedAmount?, actualAmount?, userData?): InstantDistributionUpdatedEventFilter;
        PoolConnectionUpdated(token?, pool?, account?, connected?, userData?): PoolConnectionUpdatedEventFilter;
        PoolConnectionUpdated(address,address,address,bool,bytes)(token?, pool?, account?, connected?, userData?): PoolConnectionUpdatedEventFilter;
        PoolCreated(token?, admin?, pool?): PoolCreatedEventFilter;
        PoolCreated(address,address,address)(token?, admin?, pool?): PoolCreatedEventFilter;
    };
    functions: {
        SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<[string]>;
        SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<[string]>;
        agreementType(overrides?): Promise<[string]>;
        appendIndexUpdateByPool(token, p, t, overrides?): Promise<ContractTransaction>;
        castrate(overrides?): Promise<ContractTransaction>;
        claimAll(pool, memberAddress, ctx, overrides?): Promise<ContractTransaction>;
        connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<ContractTransaction>;
        connectPool(address,bytes)(pool, ctx, overrides?): Promise<ContractTransaction>;
        createPool(token, admin, config, overrides?): Promise<ContractTransaction>;
        disconnectPool(pool, ctx, overrides?): Promise<ContractTransaction>;
        distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<ContractTransaction>;
        distributeFlow(token, from, pool, requestedFlowRate, ctx, 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;
        }>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            timestamp: BigNumber;
        }>;
        getCodeAddress(overrides?): Promise<[string] & {
            codeAddress: string;
        }>;
        getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            lastUpdated: BigNumber;
        }>;
        getFlowRate(token, from, to, overrides?): Promise<[BigNumber]>;
        getNetFlow(token, account, overrides?): Promise<[BigNumber] & {
            netFlowRate: BigNumber;
        }>;
        getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
            flowHash: string;
            flowRate: BigNumber;
            recipient: string;
        }>;
        getPoolAdjustmentFlowRate(pool, overrides?): Promise<[BigNumber]>;
        isMemberConnected(pool, member, overrides?): Promise<[boolean]>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<[boolean]>;
        isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
            isCurrentlyPatricianPeriod: boolean;
            timestamp: BigNumber;
        }>;
        isPool(token, account, overrides?): Promise<[boolean]>;
        poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<ContractTransaction>;
        proxiableUUID(overrides?): Promise<[string]>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            buf: BigNumber;
            owedBuffer: BigNumber;
            rtb: BigNumber;
        }>;
        realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            availableBalance: BigNumber;
            buffer: BigNumber;
            owedBuffer: BigNumber;
            timestamp: BigNumber;
        }>;
        superfluidPoolBeacon(overrides?): Promise<[string]>;
        updateCode(newAddress, overrides?): Promise<ContractTransaction>;
        updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<ContractTransaction>;
    };
    interface: GeneralDistributionAgreementV1Interface;
    off: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>;
    on: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>;
    once: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>;
    populateTransaction: {
        SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<PopulatedTransaction>;
        SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<PopulatedTransaction>;
        agreementType(overrides?): Promise<PopulatedTransaction>;
        appendIndexUpdateByPool(token, p, t, overrides?): Promise<PopulatedTransaction>;
        castrate(overrides?): Promise<PopulatedTransaction>;
        claimAll(pool, memberAddress, ctx, overrides?): Promise<PopulatedTransaction>;
        connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<PopulatedTransaction>;
        connectPool(address,bytes)(pool, ctx, overrides?): Promise<PopulatedTransaction>;
        createPool(token, admin, config, overrides?): Promise<PopulatedTransaction>;
        disconnectPool(pool, ctx, overrides?): Promise<PopulatedTransaction>;
        distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<PopulatedTransaction>;
        distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<PopulatedTransaction>;
        estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<PopulatedTransaction>;
        estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<PopulatedTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<PopulatedTransaction>;
        getCodeAddress(overrides?): Promise<PopulatedTransaction>;
        getFlow(token, from, to, overrides?): Promise<PopulatedTransaction>;
        getFlowRate(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>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<PopulatedTransaction>;
        isPatricianPeriodNow(token, account, overrides?): Promise<PopulatedTransaction>;
        isPool(token, account, overrides?): Promise<PopulatedTransaction>;
        poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<PopulatedTransaction>;
        proxiableUUID(overrides?): Promise<PopulatedTransaction>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>;
        realtimeBalanceOfNow(token, account, overrides?): Promise<PopulatedTransaction>;
        superfluidPoolBeacon(overrides?): Promise<PopulatedTransaction>;
        updateCode(newAddress, overrides?): Promise<PopulatedTransaction>;
        updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>;
    SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<string>;
    SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<string>;
    agreementType(overrides?): Promise<string>;
    appendIndexUpdateByPool(token, p, t, overrides?): Promise<ContractTransaction>;
    attach(addressOrName): this;
    castrate(overrides?): Promise<ContractTransaction>;
    claimAll(pool, memberAddress, ctx, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<ContractTransaction>;
    connectPool(address,bytes)(pool, ctx, overrides?): Promise<ContractTransaction>;
    createPool(token, admin, config, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>;
    disconnectPool(pool, ctx, overrides?): Promise<ContractTransaction>;
    distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<ContractTransaction>;
    distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<ContractTransaction>;
    estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
    estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
        actualFlowRate: BigNumber;
        totalDistributionFlowRate: BigNumber;
    }>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        timestamp: BigNumber;
    }>;
    getCodeAddress(overrides?): Promise<string>;
    getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        lastUpdated: BigNumber;
    }>;
    getFlowRate(token, from, to, overrides?): Promise<BigNumber>;
    getNetFlow(token, account, overrides?): Promise<BigNumber>;
    getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
        flowHash: string;
        flowRate: BigNumber;
        recipient: string;
    }>;
    getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>;
    isMemberConnected(pool, member, overrides?): Promise<boolean>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>;
    isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>;
    isPool(token, account, overrides?): Promise<boolean>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<ContractTransaction>;
    proxiableUUID(overrides?): Promise<string>;
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        buf: BigNumber;
        owedBuffer: BigNumber;
        rtb: BigNumber;
    }>;
    realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        buffer: BigNumber;
        owedBuffer: BigNumber;
        timestamp: BigNumber;
    }>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    superfluidPoolBeacon(overrides?): Promise<string>;
    updateCode(newAddress, overrides?): Promise<ContractTransaction>;
    updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • GeneralDistributionAgreementV1

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

SLOTS_BITMAP_LIBRARY_ADDRESS SUPERFLUID_POOL_DEPLOYER_ADDRESS agreementType appendIndexUpdateByPool attach castrate claimAll connect connectPool(address,bool,bytes) connectPool(address,bytes) createPool deployed disconnectPool distribute distributeFlow estimateDistributionActualAmount estimateFlowDistributionActualFlowRate getAccountFlowInfo getCodeAddress getFlow getFlowRate getNetFlow getPoolAdjustmentFlowInfo getPoolAdjustmentFlowRate isMemberConnected isPatricianPeriod isPatricianPeriodNow isPool listeners poolSettleClaim proxiableUUID queryFilter realtimeBalanceOf realtimeBalanceOfNow removeAllListeners superfluidPoolBeacon updateCode updateMemberUnits

Properties

callStatic

callStatic: {
    SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<string>;
    SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<string>;
    agreementType(overrides?): Promise<string>;
    appendIndexUpdateByPool(token, p, t, overrides?): Promise<boolean>;
    castrate(overrides?): Promise<void>;
    claimAll(pool, memberAddress, ctx, overrides?): Promise<string>;
    connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<string>;
    connectPool(address,bytes)(pool, ctx, overrides?): Promise<string>;
    createPool(token, admin, config, overrides?): Promise<string>;
    disconnectPool(pool, ctx, overrides?): Promise<string>;
    distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<string>;
    distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<string>;
    estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
    estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<[BigNumber, BigNumber] & {
        actualFlowRate: BigNumber;
        totalDistributionFlowRate: BigNumber;
    }>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        timestamp: BigNumber;
    }>;
    getCodeAddress(overrides?): Promise<string>;
    getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        lastUpdated: BigNumber;
    }>;
    getFlowRate(token, from, to, overrides?): Promise<BigNumber>;
    getNetFlow(token, account, overrides?): Promise<BigNumber>;
    getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
        flowHash: string;
        flowRate: BigNumber;
        recipient: string;
    }>;
    getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>;
    isMemberConnected(pool, member, overrides?): Promise<boolean>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>;
    isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>;
    isPool(token, account, overrides?): Promise<boolean>;
    poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<boolean>;
    proxiableUUID(overrides?): Promise<string>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        buf: BigNumber;
        owedBuffer: BigNumber;
        rtb: BigNumber;
    }>;
    realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        buffer: BigNumber;
        owedBuffer: BigNumber;
        timestamp: BigNumber;
    }>;
    superfluidPoolBeacon(overrides?): Promise<string>;
    updateCode(newAddress, overrides?): Promise<void>;
    updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<string>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • appendIndexUpdateByPool:function
    • appendIndexUpdateByPool(token, p, t, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • p: BasicParticleStruct
      • t: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • claimAll:function
    • claimAll(pool, memberAddress, ctx, overrides?): Promise<string>

    • Parameters

      • pool: string
      • memberAddress: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • connectPool(address,bool,bytes):function
    • connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<string>

    • Parameters

      • pool: string
      • doConnect: boolean
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • connectPool(address,bytes):function
    • connectPool(address,bytes)(pool, ctx, overrides?): Promise<string>

    • Parameters

      • pool: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createPool:function
    • createPool(token, admin, config, overrides?): Promise<string>

    • Parameters

      • token: string
      • admin: string
      • config: PoolConfigStruct
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • disconnectPool:function
    • disconnectPool(pool, ctx, overrides?): Promise<string>

    • Parameters

      • pool: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • distribute:function
    • distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedAmount: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • distributeFlow:function
    • distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedFlowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • 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;
      }>

  • getAccountFlowInfo:function
    • getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowRate: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getFlow:function
    • getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowRate: BigNumber;
          lastUpdated: BigNumber;
      }>

    • Parameters

      • token: string
      • from: string
      • to: string
      • Optional overrides: CallOverrides

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

  • getFlowRate:function
    • getFlowRate(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] & {
          flowHash: string;
          flowRate: BigNumber;
          recipient: string;
      }>

    • Parameters

      • pool: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, string, BigNumber] & {
          flowHash: string;
          flowRate: BigNumber;
          recipient: string;
      }>

  • 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>

  • isPatricianPeriod:function
    • isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isPatricianPeriodNow:function
    • isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
          isCurrentlyPatricianPeriod: boolean;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

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

  • isPool:function
    • isPool(token, account, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • poolSettleClaim:function
    • poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<boolean>

    • Parameters

      • superToken: string
      • claimRecipient: string
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          buf: BigNumber;
          owedBuffer: BigNumber;
          rtb: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber, BigNumber] & {
          buf: BigNumber;
          owedBuffer: BigNumber;
          rtb: BigNumber;
      }>

  • realtimeBalanceOfNow:function
    • realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          availableBalance: BigNumber;
          buffer: BigNumber;
          owedBuffer: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          availableBalance: BigNumber;
          buffer: BigNumber;
          owedBuffer: BigNumber;
          timestamp: BigNumber;
      }>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<void>

    • Parameters

      • newAddress: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateMemberUnits:function
    • updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<string>

    • Parameters

      • pool: string
      • memberAddress: string
      • newUnits: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

estimateGas

estimateGas: {
    SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<BigNumber>;
    SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<BigNumber>;
    agreementType(overrides?): Promise<BigNumber>;
    appendIndexUpdateByPool(token, p, t, overrides?): Promise<BigNumber>;
    castrate(overrides?): Promise<BigNumber>;
    claimAll(pool, memberAddress, ctx, overrides?): Promise<BigNumber>;
    connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<BigNumber>;
    connectPool(address,bytes)(pool, ctx, overrides?): Promise<BigNumber>;
    createPool(token, admin, config, overrides?): Promise<BigNumber>;
    disconnectPool(pool, ctx, overrides?): Promise<BigNumber>;
    distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<BigNumber>;
    distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<BigNumber>;
    estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>;
    estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<BigNumber>;
    getAccountFlowInfo(token, account, overrides?): Promise<BigNumber>;
    getCodeAddress(overrides?): Promise<BigNumber>;
    getFlow(token, from, to, overrides?): Promise<BigNumber>;
    getFlowRate(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>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<BigNumber>;
    isPatricianPeriodNow(token, account, overrides?): Promise<BigNumber>;
    isPool(token, account, overrides?): Promise<BigNumber>;
    poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<BigNumber>;
    proxiableUUID(overrides?): Promise<BigNumber>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>;
    realtimeBalanceOfNow(token, account, overrides?): Promise<BigNumber>;
    superfluidPoolBeacon(overrides?): Promise<BigNumber>;
    updateCode(newAddress, overrides?): Promise<BigNumber>;
    updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<BigNumber>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • appendIndexUpdateByPool:function
    • appendIndexUpdateByPool(token, p, t, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • p: BasicParticleStruct
      • t: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • claimAll:function
    • claimAll(pool, memberAddress, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • pool: string
      • memberAddress: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • connectPool(address,bool,bytes):function
    • connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • pool: string
      • doConnect: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • connectPool(address,bytes):function
    • connectPool(address,bytes)(pool, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • pool: string
      • ctx: 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, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • distribute:function
    • distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedAmount: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • distributeFlow:function
    • distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedFlowRate: BigNumberish
      • ctx: 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>

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

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFlow:function
    • getFlow(token, from, to, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • from: string
      • to: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

  • isPatricianPeriod:function
    • isPatricianPeriod(token, account, timestamp, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • token: string
      • account: 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>

  • poolSettleClaim:function
    • poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • updateMemberUnits:function
    • updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • pool: string
      • memberAddress: string
      • newUnits: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

filters

filters: {
    BufferAdjusted(token?, pool?, from?, bufferDelta?, newBufferAmount?, totalBufferAmount?): BufferAdjustedEventFilter;
    BufferAdjusted(address,address,address,int256,uint256,uint256)(token?, pool?, from?, bufferDelta?, newBufferAmount?, totalBufferAmount?): BufferAdjustedEventFilter;
    CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter;
    CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter;
    FlowDistributionUpdated(token?, pool?, distributor?, operator?, oldFlowRate?, newDistributorToPoolFlowRate?, newTotalDistributionFlowRate?, adjustmentFlowRecipient?, adjustmentFlowRate?, userData?): FlowDistributionUpdatedEventFilter;
    FlowDistributionUpdated(address,address,address,address,int96,int96,int96,address,int96,bytes)(token?, pool?, distributor?, operator?, oldFlowRate?, newDistributorToPoolFlowRate?, newTotalDistributionFlowRate?, adjustmentFlowRecipient?, adjustmentFlowRate?, userData?): FlowDistributionUpdatedEventFilter;
    Initialized(version?): InitializedEventFilter;
    Initialized(uint8)(version?): InitializedEventFilter;
    InstantDistributionUpdated(token?, pool?, distributor?, operator?, requestedAmount?, actualAmount?, userData?): InstantDistributionUpdatedEventFilter;
    InstantDistributionUpdated(address,address,address,address,uint256,uint256,bytes)(token?, pool?, distributor?, operator?, requestedAmount?, actualAmount?, userData?): InstantDistributionUpdatedEventFilter;
    PoolConnectionUpdated(token?, pool?, account?, connected?, userData?): PoolConnectionUpdatedEventFilter;
    PoolConnectionUpdated(address,address,address,bool,bytes)(token?, pool?, account?, connected?, userData?): PoolConnectionUpdatedEventFilter;
    PoolCreated(token?, admin?, pool?): PoolCreatedEventFilter;
    PoolCreated(address,address,address)(token?, admin?, pool?): PoolCreatedEventFilter;
}

Type declaration

  • BufferAdjusted:function
    • BufferAdjusted(token?, pool?, from?, bufferDelta?, newBufferAmount?, totalBufferAmount?): BufferAdjustedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional from: null | string
      • Optional bufferDelta: null
      • Optional newBufferAmount: null
      • Optional totalBufferAmount: null

      Returns BufferAdjustedEventFilter

  • BufferAdjusted(address,address,address,int256,uint256,uint256):function
    • BufferAdjusted(address,address,address,int256,uint256,uint256)(token?, pool?, from?, bufferDelta?, newBufferAmount?, totalBufferAmount?): BufferAdjustedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional from: null | string
      • Optional bufferDelta: null
      • Optional newBufferAmount: null
      • Optional totalBufferAmount: null

      Returns BufferAdjustedEventFilter

  • CodeUpdated:function
    • CodeUpdated(uuid?, codeAddress?): CodeUpdatedEventFilter

    • Parameters

      • Optional uuid: null
      • Optional codeAddress: null

      Returns CodeUpdatedEventFilter

  • CodeUpdated(bytes32,address):function
    • CodeUpdated(bytes32,address)(uuid?, codeAddress?): CodeUpdatedEventFilter

    • Parameters

      • Optional uuid: null
      • Optional codeAddress: null

      Returns CodeUpdatedEventFilter

  • FlowDistributionUpdated:function
    • FlowDistributionUpdated(token?, pool?, distributor?, operator?, oldFlowRate?, newDistributorToPoolFlowRate?, newTotalDistributionFlowRate?, adjustmentFlowRecipient?, adjustmentFlowRate?, userData?): FlowDistributionUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional distributor: null | string
      • Optional operator: null
      • Optional oldFlowRate: null
      • Optional newDistributorToPoolFlowRate: null
      • Optional newTotalDistributionFlowRate: null
      • Optional adjustmentFlowRecipient: null
      • Optional adjustmentFlowRate: null
      • Optional userData: null

      Returns FlowDistributionUpdatedEventFilter

  • FlowDistributionUpdated(address,address,address,address,int96,int96,int96,address,int96,bytes):function
    • FlowDistributionUpdated(address,address,address,address,int96,int96,int96,address,int96,bytes)(token?, pool?, distributor?, operator?, oldFlowRate?, newDistributorToPoolFlowRate?, newTotalDistributionFlowRate?, adjustmentFlowRecipient?, adjustmentFlowRate?, userData?): FlowDistributionUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional distributor: null | string
      • Optional operator: null
      • Optional oldFlowRate: null
      • Optional newDistributorToPoolFlowRate: null
      • Optional newTotalDistributionFlowRate: null
      • Optional adjustmentFlowRecipient: null
      • Optional adjustmentFlowRate: null
      • Optional userData: null

      Returns FlowDistributionUpdatedEventFilter

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

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

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

    • Parameters

      • Optional version: null

      Returns InitializedEventFilter

  • InstantDistributionUpdated:function
    • InstantDistributionUpdated(token?, pool?, distributor?, operator?, requestedAmount?, actualAmount?, userData?): InstantDistributionUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional distributor: null | string
      • Optional operator: null
      • Optional requestedAmount: null
      • Optional actualAmount: null
      • Optional userData: null

      Returns InstantDistributionUpdatedEventFilter

  • InstantDistributionUpdated(address,address,address,address,uint256,uint256,bytes):function
    • InstantDistributionUpdated(address,address,address,address,uint256,uint256,bytes)(token?, pool?, distributor?, operator?, requestedAmount?, actualAmount?, userData?): InstantDistributionUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional distributor: null | string
      • Optional operator: null
      • Optional requestedAmount: null
      • Optional actualAmount: null
      • Optional userData: null

      Returns InstantDistributionUpdatedEventFilter

  • PoolConnectionUpdated:function
    • PoolConnectionUpdated(token?, pool?, account?, connected?, userData?): PoolConnectionUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional account: null | string
      • Optional connected: null
      • Optional userData: null

      Returns PoolConnectionUpdatedEventFilter

  • PoolConnectionUpdated(address,address,address,bool,bytes):function
    • PoolConnectionUpdated(address,address,address,bool,bytes)(token?, pool?, account?, connected?, userData?): PoolConnectionUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pool: null | string
      • Optional account: null | string
      • Optional connected: null
      • Optional userData: null

      Returns PoolConnectionUpdatedEventFilter

  • PoolCreated:function
    • PoolCreated(token?, admin?, pool?): PoolCreatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional admin: null | string
      • Optional pool: null

      Returns PoolCreatedEventFilter

  • PoolCreated(address,address,address):function
    • PoolCreated(address,address,address)(token?, admin?, pool?): PoolCreatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional admin: null | string
      • Optional pool: null

      Returns PoolCreatedEventFilter

functions

functions: {
    SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<[string]>;
    SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<[string]>;
    agreementType(overrides?): Promise<[string]>;
    appendIndexUpdateByPool(token, p, t, overrides?): Promise<ContractTransaction>;
    castrate(overrides?): Promise<ContractTransaction>;
    claimAll(pool, memberAddress, ctx, overrides?): Promise<ContractTransaction>;
    connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<ContractTransaction>;
    connectPool(address,bytes)(pool, ctx, overrides?): Promise<ContractTransaction>;
    createPool(token, admin, config, overrides?): Promise<ContractTransaction>;
    disconnectPool(pool, ctx, overrides?): Promise<ContractTransaction>;
    distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<ContractTransaction>;
    distributeFlow(token, from, pool, requestedFlowRate, ctx, 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;
    }>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        timestamp: BigNumber;
    }>;
    getCodeAddress(overrides?): Promise<[string] & {
        codeAddress: string;
    }>;
    getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        lastUpdated: BigNumber;
    }>;
    getFlowRate(token, from, to, overrides?): Promise<[BigNumber]>;
    getNetFlow(token, account, overrides?): Promise<[BigNumber] & {
        netFlowRate: BigNumber;
    }>;
    getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
        flowHash: string;
        flowRate: BigNumber;
        recipient: string;
    }>;
    getPoolAdjustmentFlowRate(pool, overrides?): Promise<[BigNumber]>;
    isMemberConnected(pool, member, overrides?): Promise<[boolean]>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<[boolean]>;
    isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>;
    isPool(token, account, overrides?): Promise<[boolean]>;
    poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<ContractTransaction>;
    proxiableUUID(overrides?): Promise<[string]>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        buf: BigNumber;
        owedBuffer: BigNumber;
        rtb: BigNumber;
    }>;
    realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        buffer: BigNumber;
        owedBuffer: BigNumber;
        timestamp: BigNumber;
    }>;
    superfluidPoolBeacon(overrides?): Promise<[string]>;
    updateCode(newAddress, overrides?): Promise<ContractTransaction>;
    updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<ContractTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • appendIndexUpdateByPool:function
    • appendIndexUpdateByPool(token, p, t, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • p: BasicParticleStruct
      • t: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

  • claimAll:function
    • claimAll(pool, memberAddress, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • pool: string
      • memberAddress: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • connectPool(address,bool,bytes):function
    • connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • pool: string
      • doConnect: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • connectPool(address,bytes):function
    • connectPool(address,bytes)(pool, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • pool: string
      • ctx: 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, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • distribute:function
    • distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedAmount: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • distributeFlow:function
    • distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedFlowRate: BigNumberish
      • ctx: 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;
      }>

  • getAccountFlowInfo:function
    • getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowRate: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

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

  • getCodeAddress:function
    • getCodeAddress(overrides?): Promise<[string] & {
          codeAddress: string;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string] & {
          codeAddress: string;
      }>

  • getFlow:function
    • getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowRate: BigNumber;
          lastUpdated: BigNumber;
      }>

    • Parameters

      • token: string
      • from: string
      • to: string
      • Optional overrides: CallOverrides

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

  • getFlowRate:function
    • getFlowRate(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] & {
          netFlowRate: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

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

  • getPoolAdjustmentFlowInfo:function
    • getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
          flowHash: string;
          flowRate: BigNumber;
          recipient: string;
      }>

    • Parameters

      • pool: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, string, BigNumber] & {
          flowHash: string;
          flowRate: BigNumber;
          recipient: string;
      }>

  • 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]>

  • isPatricianPeriod:function
    • isPatricianPeriod(token, account, timestamp, overrides?): Promise<[boolean]>

    • Parameters

      • token: string
      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • isPatricianPeriodNow:function
    • isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
          isCurrentlyPatricianPeriod: boolean;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

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

  • isPool:function
    • isPool(token, account, overrides?): Promise<[boolean]>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean]>

  • poolSettleClaim:function
    • poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          buf: BigNumber;
          owedBuffer: BigNumber;
          rtb: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber, BigNumber] & {
          buf: BigNumber;
          owedBuffer: BigNumber;
          rtb: BigNumber;
      }>

  • realtimeBalanceOfNow:function
    • realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          availableBalance: BigNumber;
          buffer: BigNumber;
          owedBuffer: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          availableBalance: BigNumber;
          buffer: BigNumber;
          owedBuffer: BigNumber;
          timestamp: BigNumber;
      }>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateMemberUnits:function
    • updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • pool: string
      • memberAddress: string
      • newUnits: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

interface

interface: GeneralDistributionAgreementV1Interface

off

off: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>

on

on: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>

once

once: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>

populateTransaction

populateTransaction: {
    SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<PopulatedTransaction>;
    SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<PopulatedTransaction>;
    agreementType(overrides?): Promise<PopulatedTransaction>;
    appendIndexUpdateByPool(token, p, t, overrides?): Promise<PopulatedTransaction>;
    castrate(overrides?): Promise<PopulatedTransaction>;
    claimAll(pool, memberAddress, ctx, overrides?): Promise<PopulatedTransaction>;
    connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<PopulatedTransaction>;
    connectPool(address,bytes)(pool, ctx, overrides?): Promise<PopulatedTransaction>;
    createPool(token, admin, config, overrides?): Promise<PopulatedTransaction>;
    disconnectPool(pool, ctx, overrides?): Promise<PopulatedTransaction>;
    distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<PopulatedTransaction>;
    distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<PopulatedTransaction>;
    estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<PopulatedTransaction>;
    estimateFlowDistributionActualFlowRate(token, from, to, requestedFlowRate, overrides?): Promise<PopulatedTransaction>;
    getAccountFlowInfo(token, account, overrides?): Promise<PopulatedTransaction>;
    getCodeAddress(overrides?): Promise<PopulatedTransaction>;
    getFlow(token, from, to, overrides?): Promise<PopulatedTransaction>;
    getFlowRate(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>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<PopulatedTransaction>;
    isPatricianPeriodNow(token, account, overrides?): Promise<PopulatedTransaction>;
    isPool(token, account, overrides?): Promise<PopulatedTransaction>;
    poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<PopulatedTransaction>;
    proxiableUUID(overrides?): Promise<PopulatedTransaction>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>;
    realtimeBalanceOfNow(token, account, overrides?): Promise<PopulatedTransaction>;
    superfluidPoolBeacon(overrides?): Promise<PopulatedTransaction>;
    updateCode(newAddress, overrides?): Promise<PopulatedTransaction>;
    updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • appendIndexUpdateByPool:function
    • appendIndexUpdateByPool(token, p, t, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • p: BasicParticleStruct
      • t: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • claimAll:function
    • claimAll(pool, memberAddress, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • pool: string
      • memberAddress: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • connectPool(address,bool,bytes):function
    • connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • pool: string
      • doConnect: boolean
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • connectPool(address,bytes):function
    • connectPool(address,bytes)(pool, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • pool: string
      • ctx: 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, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • distribute:function
    • distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedAmount: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • distributeFlow:function
    • distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • from: string
      • pool: string
      • requestedFlowRate: BigNumberish
      • ctx: 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>

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

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFlow:function
    • getFlow(token, from, to, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • from: string
      • to: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

  • isPatricianPeriod:function
    • isPatricianPeriod(token, account, timestamp, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • token: string
      • account: 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>

  • poolSettleClaim:function
    • poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • account: string
      • time: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • token: string
      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • updateCode:function
    • updateCode(newAddress, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updateMemberUnits:function
    • updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • pool: string
      • memberAddress: string
      • newUnits: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<_sdkCore.contracts.agreements.gdav1.GeneralDistributionAgreementV1>

Methods

SLOTS_BITMAP_LIBRARY_ADDRESS

  • SLOTS_BITMAP_LIBRARY_ADDRESS(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

SUPERFLUID_POOL_DEPLOYER_ADDRESS

  • SUPERFLUID_POOL_DEPLOYER_ADDRESS(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

agreementType

  • agreementType(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

appendIndexUpdateByPool

  • appendIndexUpdateByPool(token, p, t, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • p: BasicParticleStruct
    • t: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

castrate

  • castrate(overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

claimAll

  • claimAll(pool, memberAddress, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • pool: string
    • memberAddress: string
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

connectPool(address,bool,bytes)

  • connectPool(address,bool,bytes)(pool, doConnect, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • pool: string
    • doConnect: boolean
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

connectPool(address,bytes)

  • connectPool(address,bytes)(pool, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

createPool

  • createPool(token, admin, config, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • admin: string
    • config: PoolConfigStruct
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deployed

disconnectPool

  • disconnectPool(pool, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

distribute

  • distribute(token, from, pool, requestedAmount, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • from: string
    • pool: string
    • requestedAmount: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

distributeFlow

  • distributeFlow(token, from, pool, requestedFlowRate, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • from: string
    • pool: string
    • requestedFlowRate: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

estimateDistributionActualAmount

  • estimateDistributionActualAmount(token, from, to, requestedAmount, overrides?): Promise<BigNumber>

  • Parameters

    • token: string
    • from: string
    • to: string
    • requestedAmount: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

estimateFlowDistributionActualFlowRate

  • 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;
    }>

getAccountFlowInfo

  • getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        timestamp: BigNumber;
    }>

  • Parameters

    • token: string
    • account: string
    • Optional overrides: CallOverrides

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

getCodeAddress

  • getCodeAddress(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

getFlow

  • getFlow(token, from, to, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        lastUpdated: BigNumber;
    }>

  • Parameters

    • token: string
    • from: string
    • to: string
    • Optional overrides: CallOverrides

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

getFlowRate

  • getFlowRate(token, from, to, overrides?): Promise<BigNumber>

  • Parameters

    • token: string
    • from: string
    • to: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getNetFlow

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

  • Parameters

    • token: string
    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getPoolAdjustmentFlowInfo

  • getPoolAdjustmentFlowInfo(pool, overrides?): Promise<[string, string, BigNumber] & {
        flowHash: string;
        flowRate: BigNumber;
        recipient: string;
    }>

  • Parameters

    • pool: string
    • Optional overrides: CallOverrides

    Returns Promise<[string, string, BigNumber] & {
        flowHash: string;
        flowRate: BigNumber;
        recipient: string;
    }>

getPoolAdjustmentFlowRate

  • getPoolAdjustmentFlowRate(pool, overrides?): Promise<BigNumber>

  • Parameters

    • pool: string
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

isMemberConnected

  • isMemberConnected(pool, member, overrides?): Promise<boolean>

  • Parameters

    • pool: string
    • member: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isPatricianPeriod

  • isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>

  • Parameters

    • token: string
    • account: string
    • timestamp: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isPatricianPeriodNow

  • isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>

  • Parameters

    • token: string
    • account: string
    • Optional overrides: CallOverrides

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

isPool

  • isPool(token, account, overrides?): Promise<boolean>

  • Parameters

    • token: string
    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

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[]

poolSettleClaim

  • poolSettleClaim(superToken, claimRecipient, amount, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

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[]>

realtimeBalanceOf

  • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        buf: BigNumber;
        owedBuffer: BigNumber;
        rtb: BigNumber;
    }>

  • Parameters

    • token: string
    • account: string
    • time: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<[BigNumber, BigNumber, BigNumber] & {
        buf: BigNumber;
        owedBuffer: BigNumber;
        rtb: BigNumber;
    }>

realtimeBalanceOfNow

  • realtimeBalanceOfNow(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        buffer: BigNumber;
        owedBuffer: BigNumber;
        timestamp: BigNumber;
    }>

  • Parameters

    • token: string
    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        buffer: BigNumber;
        owedBuffer: BigNumber;
        timestamp: BigNumber;
    }>

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

superfluidPoolBeacon

  • superfluidPoolBeacon(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

updateCode

  • updateCode(newAddress, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateMemberUnits

  • updateMemberUnits(pool, memberAddress, newUnits, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • pool: string
    • memberAddress: string
    • newUnits: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc