Interface IConstantFlowAgreementV1

interface IConstantFlowAgreementV1 {
    callStatic: {
        agreementType(overrides?): Promise<string>;
        authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<string>;
        createFlow(token, receiver, flowRate, ctx, overrides?): Promise<string>;
        createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<string>;
        decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<string>;
        decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<string>;
        deleteFlow(token, sender, receiver, ctx, overrides?): Promise<string>;
        deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<string>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>;
        getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        getFlowByID(token, agreementId, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
            flowOperatorId: string;
            flowRateAllowance: BigNumber;
            permissions: number;
        }>;
        getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
            flowRateAllowance: BigNumber;
            permissions: number;
        }>;
        getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>;
        getNetFlow(token, account, overrides?): Promise<BigNumber>;
        increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<string>;
        increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<string>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>;
        isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
            isCurrentlyPatricianPeriod: boolean;
            timestamp: BigNumber;
        }>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            dynamicBalance: BigNumber;
            owedDeposit: BigNumber;
        }>;
        revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<string>;
        updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<string>;
        updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<string>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<string>;
    };
    estimateGas: {
        agreementType(overrides?): Promise<BigNumber>;
        authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<BigNumber>;
        createFlow(token, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
        createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
        decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
        decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
        deleteFlow(token, sender, receiver, ctx, overrides?): Promise<BigNumber>;
        deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<BigNumber>;
        getAccountFlowInfo(token, account, overrides?): Promise<BigNumber>;
        getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>;
        getFlow(token, sender, receiver, overrides?): Promise<BigNumber>;
        getFlowByID(token, agreementId, overrides?): Promise<BigNumber>;
        getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<BigNumber>;
        getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<BigNumber>;
        getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>;
        getNetFlow(token, account, overrides?): Promise<BigNumber>;
        increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
        increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<BigNumber>;
        isPatricianPeriodNow(token, account, overrides?): Promise<BigNumber>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>;
        revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<BigNumber>;
        updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
        updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<BigNumber>;
    };
    filters: {
        FlowOperatorUpdated(token?, sender?, flowOperator?, permissions?, flowRateAllowance?): FlowOperatorUpdatedEventFilter;
        FlowOperatorUpdated(address,address,address,uint8,int96)(token?, sender?, flowOperator?, permissions?, flowRateAllowance?): FlowOperatorUpdatedEventFilter;
        FlowUpdated(token?, sender?, receiver?, flowRate?, totalSenderFlowRate?, totalReceiverFlowRate?, userData?): FlowUpdatedEventFilter;
        FlowUpdated(address,address,address,int96,int256,int256,bytes)(token?, sender?, receiver?, flowRate?, totalSenderFlowRate?, totalReceiverFlowRate?, userData?): FlowUpdatedEventFilter;
        FlowUpdatedExtension(flowOperator?, deposit?): FlowUpdatedExtensionEventFilter;
        FlowUpdatedExtension(address,uint256)(flowOperator?, deposit?): FlowUpdatedExtensionEventFilter;
    };
    functions: {
        agreementType(overrides?): Promise<[string]>;
        authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>;
        createFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
        createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
        decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
        decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
        deleteFlow(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>;
        deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<[BigNumber] & {
            deposit: BigNumber;
        }>;
        getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        getFlowByID(token, agreementId, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowRate: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
            flowOperatorId: string;
            flowRateAllowance: BigNumber;
            permissions: number;
        }>;
        getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
            flowRateAllowance: BigNumber;
            permissions: number;
        }>;
        getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<[BigNumber] & {
            flowRate: BigNumber;
        }>;
        getNetFlow(token, account, overrides?): Promise<[BigNumber] & {
            flowRate: BigNumber;
        }>;
        increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
        increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<[boolean]>;
        isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
            isCurrentlyPatricianPeriod: boolean;
            timestamp: BigNumber;
        }>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            dynamicBalance: BigNumber;
            owedDeposit: BigNumber;
        }>;
        revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>;
        updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
        updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    };
    interface: IConstantFlowAgreementV1Interface;
    off: OnEvent<IConstantFlowAgreementV1>;
    on: OnEvent<IConstantFlowAgreementV1>;
    once: OnEvent<IConstantFlowAgreementV1>;
    populateTransaction: {
        agreementType(overrides?): Promise<PopulatedTransaction>;
        authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<PopulatedTransaction>;
        createFlow(token, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
        createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
        decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
        decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
        deleteFlow(token, sender, receiver, ctx, overrides?): Promise<PopulatedTransaction>;
        deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<PopulatedTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<PopulatedTransaction>;
        getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<PopulatedTransaction>;
        getFlow(token, sender, receiver, overrides?): Promise<PopulatedTransaction>;
        getFlowByID(token, agreementId, overrides?): Promise<PopulatedTransaction>;
        getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<PopulatedTransaction>;
        getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<PopulatedTransaction>;
        getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<PopulatedTransaction>;
        getNetFlow(token, account, overrides?): Promise<PopulatedTransaction>;
        increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
        increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
        isPatricianPeriod(token, account, timestamp, overrides?): Promise<PopulatedTransaction>;
        isPatricianPeriodNow(token, account, overrides?): Promise<PopulatedTransaction>;
        realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>;
        revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<PopulatedTransaction>;
        updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
        updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<IConstantFlowAgreementV1>;
    agreementType(overrides?): Promise<string>;
    attach(addressOrName): this;
    authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    createFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    deleteFlow(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>;
    deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<IConstantFlowAgreementV1>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>;
    getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getFlowByID(token, agreementId, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
        flowOperatorId: string;
        flowRateAllowance: BigNumber;
        permissions: number;
    }>;
    getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
        flowRateAllowance: BigNumber;
        permissions: number;
    }>;
    getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>;
    getNetFlow(token, account, overrides?): Promise<BigNumber>;
    increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>;
    isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>;
    updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • IConstantFlowAgreementV1

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

agreementType attach authorizeFlowOperatorWithFullControl connect createFlow createFlowByOperator decreaseFlowRateAllowance decreaseFlowRateAllowanceWithPermissions deleteFlow deleteFlowByOperator deployed getAccountFlowInfo getDepositRequiredForFlowRate getFlow getFlowByID getFlowOperatorData getFlowOperatorDataByID getMaximumFlowRateFromDeposit getNetFlow increaseFlowRateAllowance increaseFlowRateAllowanceWithPermissions isPatricianPeriod isPatricianPeriodNow listeners queryFilter realtimeBalanceOf removeAllListeners revokeFlowOperatorWithFullControl updateFlow updateFlowByOperator updateFlowOperatorPermissions

Properties

callStatic

callStatic: {
    agreementType(overrides?): Promise<string>;
    authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<string>;
    createFlow(token, receiver, flowRate, ctx, overrides?): Promise<string>;
    createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<string>;
    decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<string>;
    decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<string>;
    deleteFlow(token, sender, receiver, ctx, overrides?): Promise<string>;
    deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<string>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>;
    getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getFlowByID(token, agreementId, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
        flowOperatorId: string;
        flowRateAllowance: BigNumber;
        permissions: number;
    }>;
    getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
        flowRateAllowance: BigNumber;
        permissions: number;
    }>;
    getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>;
    getNetFlow(token, account, overrides?): Promise<BigNumber>;
    increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<string>;
    increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<string>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<boolean>;
    isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>;
    revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<string>;
    updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<string>;
    updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<string>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<string>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • authorizeFlowOperatorWithFullControl:function
    • authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createFlow:function
    • createFlow(token, receiver, flowRate, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • createFlowByOperator:function
    • createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • decreaseFlowRateAllowance:function
    • decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • subtractedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • decreaseFlowRateAllowanceWithPermissions:function
    • decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToRemove: BigNumberish
      • subtractedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • deleteFlow:function
    • deleteFlow(token, sender, receiver, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • deleteFlowByOperator:function
    • deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

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

    • Parameters

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

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

  • getDepositRequiredForFlowRate:function
    • getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • flowRate: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFlow:function
    • getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowRate: BigNumber;
          owedDeposit: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

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

  • getFlowOperatorData:function
    • getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
          flowOperatorId: string;
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

    • Parameters

      • token: string
      • sender: string
      • flowOperator: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, number, BigNumber] & {
          flowOperatorId: string;
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

  • getFlowOperatorDataByID:function
    • getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

    • Parameters

      • token: string
      • flowOperatorId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[number, BigNumber] & {
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

  • getMaximumFlowRateFromDeposit:function
    • getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>

    • Parameters

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

  • increaseFlowRateAllowance:function
    • increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • addedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • increaseFlowRateAllowanceWithPermissions:function
    • increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToAdd: BigNumberish
      • addedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

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

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

  • revokeFlowOperatorWithFullControl:function
    • revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • updateFlow:function
    • updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • updateFlowByOperator:function
    • updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • updateFlowOperatorPermissions:function
    • updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • flowOperator: string
      • permissions: BigNumberish
      • flowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

estimateGas

estimateGas: {
    agreementType(overrides?): Promise<BigNumber>;
    authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<BigNumber>;
    createFlow(token, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
    createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
    decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
    decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
    deleteFlow(token, sender, receiver, ctx, overrides?): Promise<BigNumber>;
    deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<BigNumber>;
    getAccountFlowInfo(token, account, overrides?): Promise<BigNumber>;
    getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>;
    getFlow(token, sender, receiver, overrides?): Promise<BigNumber>;
    getFlowByID(token, agreementId, overrides?): Promise<BigNumber>;
    getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<BigNumber>;
    getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<BigNumber>;
    getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>;
    getNetFlow(token, account, overrides?): Promise<BigNumber>;
    increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
    increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<BigNumber>;
    isPatricianPeriodNow(token, account, overrides?): Promise<BigNumber>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<BigNumber>;
    revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<BigNumber>;
    updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
    updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<BigNumber>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<BigNumber>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • authorizeFlowOperatorWithFullControl:function
    • authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • createFlow:function
    • createFlow(token, receiver, flowRate, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • createFlowByOperator:function
    • createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • decreaseFlowRateAllowance:function
    • decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • decreaseFlowRateAllowanceWithPermissions:function
    • decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToRemove: BigNumberish
      • subtractedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • deleteFlow:function
    • deleteFlow(token, sender, receiver, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • deleteFlowByOperator:function
    • deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • getDepositRequiredForFlowRate:function
    • getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • flowRate: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFlow:function
    • getFlow(token, sender, receiver, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFlowByID:function
    • getFlowByID(token, agreementId, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFlowOperatorData:function
    • getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • sender: string
      • flowOperator: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getFlowOperatorDataByID:function
    • getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • flowOperatorId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getMaximumFlowRateFromDeposit:function
    • getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>

    • Parameters

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

  • increaseFlowRateAllowance:function
    • increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • increaseFlowRateAllowanceWithPermissions:function
    • increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToAdd: BigNumberish
      • addedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      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>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • revokeFlowOperatorWithFullControl:function
    • revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • updateFlow:function
    • updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • updateFlowByOperator:function
    • updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateFlowOperatorPermissions:function
    • updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • flowOperator: string
      • permissions: BigNumberish
      • flowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

filters

filters: {
    FlowOperatorUpdated(token?, sender?, flowOperator?, permissions?, flowRateAllowance?): FlowOperatorUpdatedEventFilter;
    FlowOperatorUpdated(address,address,address,uint8,int96)(token?, sender?, flowOperator?, permissions?, flowRateAllowance?): FlowOperatorUpdatedEventFilter;
    FlowUpdated(token?, sender?, receiver?, flowRate?, totalSenderFlowRate?, totalReceiverFlowRate?, userData?): FlowUpdatedEventFilter;
    FlowUpdated(address,address,address,int96,int256,int256,bytes)(token?, sender?, receiver?, flowRate?, totalSenderFlowRate?, totalReceiverFlowRate?, userData?): FlowUpdatedEventFilter;
    FlowUpdatedExtension(flowOperator?, deposit?): FlowUpdatedExtensionEventFilter;
    FlowUpdatedExtension(address,uint256)(flowOperator?, deposit?): FlowUpdatedExtensionEventFilter;
}

Type declaration

  • FlowOperatorUpdated:function
    • FlowOperatorUpdated(token?, sender?, flowOperator?, permissions?, flowRateAllowance?): FlowOperatorUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional sender: null | string
      • Optional flowOperator: null | string
      • Optional permissions: null
      • Optional flowRateAllowance: null

      Returns FlowOperatorUpdatedEventFilter

  • FlowOperatorUpdated(address,address,address,uint8,int96):function
    • FlowOperatorUpdated(address,address,address,uint8,int96)(token?, sender?, flowOperator?, permissions?, flowRateAllowance?): FlowOperatorUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional sender: null | string
      • Optional flowOperator: null | string
      • Optional permissions: null
      • Optional flowRateAllowance: null

      Returns FlowOperatorUpdatedEventFilter

  • FlowUpdated:function
    • FlowUpdated(token?, sender?, receiver?, flowRate?, totalSenderFlowRate?, totalReceiverFlowRate?, userData?): FlowUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional sender: null | string
      • Optional receiver: null | string
      • Optional flowRate: null
      • Optional totalSenderFlowRate: null
      • Optional totalReceiverFlowRate: null
      • Optional userData: null

      Returns FlowUpdatedEventFilter

  • FlowUpdated(address,address,address,int96,int256,int256,bytes):function
    • FlowUpdated(address,address,address,int96,int256,int256,bytes)(token?, sender?, receiver?, flowRate?, totalSenderFlowRate?, totalReceiverFlowRate?, userData?): FlowUpdatedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional sender: null | string
      • Optional receiver: null | string
      • Optional flowRate: null
      • Optional totalSenderFlowRate: null
      • Optional totalReceiverFlowRate: null
      • Optional userData: null

      Returns FlowUpdatedEventFilter

  • FlowUpdatedExtension:function
    • FlowUpdatedExtension(flowOperator?, deposit?): FlowUpdatedExtensionEventFilter

    • Parameters

      • Optional flowOperator: null | string
      • Optional deposit: null

      Returns FlowUpdatedExtensionEventFilter

  • FlowUpdatedExtension(address,uint256):function
    • FlowUpdatedExtension(address,uint256)(flowOperator?, deposit?): FlowUpdatedExtensionEventFilter

    • Parameters

      • Optional flowOperator: null | string
      • Optional deposit: null

      Returns FlowUpdatedExtensionEventFilter

functions

functions: {
    agreementType(overrides?): Promise<[string]>;
    authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>;
    createFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    deleteFlow(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>;
    deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<[BigNumber] & {
        deposit: BigNumber;
    }>;
    getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getFlowByID(token, agreementId, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
        flowOperatorId: string;
        flowRateAllowance: BigNumber;
        permissions: number;
    }>;
    getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
        flowRateAllowance: BigNumber;
        permissions: number;
    }>;
    getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<[BigNumber] & {
        flowRate: BigNumber;
    }>;
    getNetFlow(token, account, overrides?): Promise<[BigNumber] & {
        flowRate: BigNumber;
    }>;
    increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<[boolean]>;
    isPatricianPeriodNow(token, account, overrides?): Promise<[boolean, BigNumber] & {
        isCurrentlyPatricianPeriod: boolean;
        timestamp: BigNumber;
    }>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>;
    revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>;
    updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<ContractTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • authorizeFlowOperatorWithFullControl:function
    • authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • createFlow:function
    • createFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • createFlowByOperator:function
    • createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • decreaseFlowRateAllowance:function
    • decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • decreaseFlowRateAllowanceWithPermissions:function
    • decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToRemove: BigNumberish
      • subtractedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • deleteFlow:function
    • deleteFlow(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • deleteFlowByOperator:function
    • deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

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

    • Parameters

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

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

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

    • Parameters

      • token: string
      • flowRate: BigNumberish
      • Optional overrides: CallOverrides

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

  • getFlow:function
    • getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowRate: BigNumber;
          owedDeposit: BigNumber;
          timestamp: BigNumber;
      }>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

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

  • getFlowOperatorData:function
    • getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
          flowOperatorId: string;
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

    • Parameters

      • token: string
      • sender: string
      • flowOperator: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, number, BigNumber] & {
          flowOperatorId: string;
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

  • getFlowOperatorDataByID:function
    • getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

    • Parameters

      • token: string
      • flowOperatorId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[number, BigNumber] & {
          flowRateAllowance: BigNumber;
          permissions: number;
      }>

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

    • Parameters

      • token: string
      • deposit: BigNumberish
      • Optional overrides: CallOverrides

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

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

    • Parameters

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

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

  • increaseFlowRateAllowance:function
    • increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • increaseFlowRateAllowanceWithPermissions:function
    • increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToAdd: BigNumberish
      • addedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

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

  • realtimeBalanceOf:function
    • realtimeBalanceOf(token, account, time, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          dynamicBalance: BigNumber;
          owedDeposit: BigNumber;
      }>

  • revokeFlowOperatorWithFullControl:function
    • revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateFlow:function
    • updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • updateFlowByOperator:function
    • updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • updateFlowOperatorPermissions:function
    • updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • flowOperator: string
      • permissions: BigNumberish
      • flowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

interface

interface: IConstantFlowAgreementV1Interface

off

off: OnEvent<IConstantFlowAgreementV1>

on

on: OnEvent<IConstantFlowAgreementV1>

once

once: OnEvent<IConstantFlowAgreementV1>

populateTransaction

populateTransaction: {
    agreementType(overrides?): Promise<PopulatedTransaction>;
    authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<PopulatedTransaction>;
    createFlow(token, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
    createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
    decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
    decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
    deleteFlow(token, sender, receiver, ctx, overrides?): Promise<PopulatedTransaction>;
    deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<PopulatedTransaction>;
    getAccountFlowInfo(token, account, overrides?): Promise<PopulatedTransaction>;
    getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<PopulatedTransaction>;
    getFlow(token, sender, receiver, overrides?): Promise<PopulatedTransaction>;
    getFlowByID(token, agreementId, overrides?): Promise<PopulatedTransaction>;
    getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<PopulatedTransaction>;
    getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<PopulatedTransaction>;
    getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<PopulatedTransaction>;
    getNetFlow(token, account, overrides?): Promise<PopulatedTransaction>;
    increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
    increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
    isPatricianPeriod(token, account, timestamp, overrides?): Promise<PopulatedTransaction>;
    isPatricianPeriodNow(token, account, overrides?): Promise<PopulatedTransaction>;
    realtimeBalanceOf(token, account, time, overrides?): Promise<PopulatedTransaction>;
    revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<PopulatedTransaction>;
    updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
    updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • authorizeFlowOperatorWithFullControl:function
    • authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • createFlow:function
    • createFlow(token, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • createFlowByOperator:function
    • createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • decreaseFlowRateAllowance:function
    • decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • decreaseFlowRateAllowanceWithPermissions:function
    • decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToRemove: BigNumberish
      • subtractedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • deleteFlow:function
    • deleteFlow(token, sender, receiver, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • deleteFlowByOperator:function
    • deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getDepositRequiredForFlowRate:function
    • getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • flowRate: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFlow:function
    • getFlow(token, sender, receiver, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFlowByID:function
    • getFlowByID(token, agreementId, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFlowOperatorData:function
    • getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • sender: string
      • flowOperator: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getFlowOperatorDataByID:function
    • getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • flowOperatorId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getMaximumFlowRateFromDeposit:function
    • getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

  • increaseFlowRateAllowance:function
    • increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • increaseFlowRateAllowanceWithPermissions:function
    • increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • flowOperator: string
      • permissionsToAdd: BigNumberish
      • addedFlowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      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>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • revokeFlowOperatorWithFullControl:function
    • revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updateFlow:function
    • updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • updateFlowByOperator:function
    • updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowRate: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • updateFlowOperatorPermissions:function
    • updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • token: string
      • flowOperator: string
      • permissions: BigNumberish
      • flowRateAllowance: BigNumberish
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<IConstantFlowAgreementV1>

Methods

agreementType

  • agreementType(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

authorizeFlowOperatorWithFullControl

  • authorizeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

createFlow

  • createFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

createFlowByOperator

  • createFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • sender: string
    • receiver: string
    • flowRate: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

decreaseFlowRateAllowance

  • decreaseFlowRateAllowance(token, flowOperator, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

decreaseFlowRateAllowanceWithPermissions

  • decreaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToRemove, subtractedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • flowOperator: string
    • permissionsToRemove: BigNumberish
    • subtractedFlowRateAllowance: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deleteFlow

  • deleteFlow(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • sender: string
    • receiver: string
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deleteFlowByOperator

  • deleteFlowByOperator(token, sender, receiver, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • sender: string
    • receiver: string
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deployed

getAccountFlowInfo

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

  • Parameters

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

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

getDepositRequiredForFlowRate

  • getDepositRequiredForFlowRate(token, flowRate, overrides?): Promise<BigNumber>

  • Parameters

    • token: string
    • flowRate: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getFlow

  • getFlow(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowRate: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>

  • Parameters

    • token: string
    • sender: string
    • receiver: string
    • Optional overrides: CallOverrides

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

getFlowByID

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

  • Parameters

    • token: string
    • agreementId: BytesLike
    • Optional overrides: CallOverrides

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

getFlowOperatorData

  • getFlowOperatorData(token, sender, flowOperator, overrides?): Promise<[string, number, BigNumber] & {
        flowOperatorId: string;
        flowRateAllowance: BigNumber;
        permissions: number;
    }>

  • Parameters

    • token: string
    • sender: string
    • flowOperator: string
    • Optional overrides: CallOverrides

    Returns Promise<[string, number, BigNumber] & {
        flowOperatorId: string;
        flowRateAllowance: BigNumber;
        permissions: number;
    }>

getFlowOperatorDataByID

  • getFlowOperatorDataByID(token, flowOperatorId, overrides?): Promise<[number, BigNumber] & {
        flowRateAllowance: BigNumber;
        permissions: number;
    }>

  • Parameters

    • token: string
    • flowOperatorId: BytesLike
    • Optional overrides: CallOverrides

    Returns Promise<[number, BigNumber] & {
        flowRateAllowance: BigNumber;
        permissions: number;
    }>

getMaximumFlowRateFromDeposit

  • getMaximumFlowRateFromDeposit(token, deposit, overrides?): Promise<BigNumber>

  • Parameters

    • token: string
    • deposit: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<BigNumber>

getNetFlow

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

  • Parameters

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

    Returns Promise<BigNumber>

increaseFlowRateAllowance

  • increaseFlowRateAllowance(token, flowOperator, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

increaseFlowRateAllowanceWithPermissions

  • increaseFlowRateAllowanceWithPermissions(token, flowOperator, permissionsToAdd, addedFlowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • flowOperator: string
    • permissionsToAdd: BigNumberish
    • addedFlowRateAllowance: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

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

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

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] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: BigNumber;
    }>

  • Parameters

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

    Returns Promise<[BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        dynamicBalance: BigNumber;
        owedDeposit: 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

revokeFlowOperatorWithFullControl

  • revokeFlowOperatorWithFullControl(token, flowOperator, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateFlow

  • updateFlow(token, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

updateFlowByOperator

  • updateFlowByOperator(token, sender, receiver, flowRate, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • sender: string
    • receiver: string
    • flowRate: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

updateFlowOperatorPermissions

  • updateFlowOperatorPermissions(token, flowOperator, permissions, flowRateAllowance, ctx, overrides?): Promise<ContractTransaction>

  • Parameters

    • token: string
    • flowOperator: string
    • permissions: BigNumberish
    • flowRateAllowance: BigNumberish
    • ctx: BytesLike
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc