Interface CFAv1Forwarder

interface CFAv1Forwarder {
    callStatic: {
        createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<boolean>;
        deleteFlow(token, sender, receiver, userData, overrides?): Promise<boolean>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>;
        getAccountFlowrate(token, account, overrides?): Promise<BigNumber>;
        getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>;
        getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>;
        getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
            flowrateAllowance: BigNumber;
            permissions: number;
        }>;
        getFlowrate(token, sender, receiver, overrides?): Promise<BigNumber>;
        grantPermissions(token, flowOperator, overrides?): Promise<boolean>;
        revokePermissions(token, flowOperator, overrides?): Promise<boolean>;
        setFlowrate(token, receiver, flowrate, overrides?): Promise<boolean>;
        setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<boolean>;
        updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<boolean>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<boolean>;
    };
    estimateGas: {
        createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<BigNumber>;
        deleteFlow(token, sender, receiver, userData, overrides?): Promise<BigNumber>;
        getAccountFlowInfo(token, account, overrides?): Promise<BigNumber>;
        getAccountFlowrate(token, account, overrides?): Promise<BigNumber>;
        getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>;
        getFlowInfo(token, sender, receiver, overrides?): Promise<BigNumber>;
        getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<BigNumber>;
        getFlowrate(token, sender, receiver, overrides?): Promise<BigNumber>;
        grantPermissions(token, flowOperator, overrides?): Promise<BigNumber>;
        revokePermissions(token, flowOperator, overrides?): Promise<BigNumber>;
        setFlowrate(token, receiver, flowrate, overrides?): Promise<BigNumber>;
        setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<BigNumber>;
        updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<BigNumber>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<BigNumber>;
    };
    filters: {};
    functions: {
        createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>;
        deleteFlow(token, sender, receiver, userData, overrides?): Promise<ContractTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>;
        getAccountFlowrate(token, account, overrides?): Promise<[BigNumber] & {
            flowrate: BigNumber;
        }>;
        getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<[BigNumber] & {
            bufferAmount: BigNumber;
        }>;
        getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>;
        getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
            flowrateAllowance: BigNumber;
            permissions: number;
        }>;
        getFlowrate(token, sender, receiver, overrides?): Promise<[BigNumber] & {
            flowrate: BigNumber;
        }>;
        grantPermissions(token, flowOperator, overrides?): Promise<ContractTransaction>;
        revokePermissions(token, flowOperator, overrides?): Promise<ContractTransaction>;
        setFlowrate(token, receiver, flowrate, overrides?): Promise<ContractTransaction>;
        setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<ContractTransaction>;
        updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<ContractTransaction>;
    };
    interface: CFAv1ForwarderInterface;
    off: OnEvent<CFAv1Forwarder>;
    on: OnEvent<CFAv1Forwarder>;
    once: OnEvent<CFAv1Forwarder>;
    populateTransaction: {
        createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<PopulatedTransaction>;
        deleteFlow(token, sender, receiver, userData, overrides?): Promise<PopulatedTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<PopulatedTransaction>;
        getAccountFlowrate(token, account, overrides?): Promise<PopulatedTransaction>;
        getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<PopulatedTransaction>;
        getFlowInfo(token, sender, receiver, overrides?): Promise<PopulatedTransaction>;
        getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<PopulatedTransaction>;
        getFlowrate(token, sender, receiver, overrides?): Promise<PopulatedTransaction>;
        grantPermissions(token, flowOperator, overrides?): Promise<PopulatedTransaction>;
        revokePermissions(token, flowOperator, overrides?): Promise<PopulatedTransaction>;
        setFlowrate(token, receiver, flowrate, overrides?): Promise<PopulatedTransaction>;
        setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<PopulatedTransaction>;
        updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<PopulatedTransaction>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<CFAv1Forwarder>;
    attach(addressOrName): this;
    connect(signerOrProvider): this;
    createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>;
    deleteFlow(token, sender, receiver, userData, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<CFAv1Forwarder>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowrate: BigNumber;
        lastUpdated: BigNumber;
        owedDeposit: BigNumber;
    }>;
    getAccountFlowrate(token, account, overrides?): Promise<BigNumber>;
    getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>;
    getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowrate: BigNumber;
        lastUpdated: BigNumber;
        owedDeposit: BigNumber;
    }>;
    getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
        flowrateAllowance: BigNumber;
        permissions: number;
    }>;
    getFlowrate(token, sender, receiver, overrides?): Promise<BigNumber>;
    grantPermissions(token, flowOperator, overrides?): Promise<ContractTransaction>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    revokePermissions(token, flowOperator, overrides?): Promise<ContractTransaction>;
    setFlowrate(token, receiver, flowrate, overrides?): Promise<ContractTransaction>;
    setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<ContractTransaction>;
    updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • CFAv1Forwarder

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

attach connect createFlow deleteFlow deployed getAccountFlowInfo getAccountFlowrate getBufferAmountByFlowrate getFlowInfo getFlowOperatorPermissions getFlowrate grantPermissions listeners queryFilter removeAllListeners revokePermissions setFlowrate setFlowrateFrom updateFlow updateFlowOperatorPermissions

Properties

callStatic

callStatic: {
    createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<boolean>;
    deleteFlow(token, sender, receiver, userData, overrides?): Promise<boolean>;
    getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowrate: BigNumber;
        lastUpdated: BigNumber;
        owedDeposit: BigNumber;
    }>;
    getAccountFlowrate(token, account, overrides?): Promise<BigNumber>;
    getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>;
    getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        deposit: BigNumber;
        flowrate: BigNumber;
        lastUpdated: BigNumber;
        owedDeposit: BigNumber;
    }>;
    getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
        flowrateAllowance: BigNumber;
        permissions: number;
    }>;
    getFlowrate(token, sender, receiver, overrides?): Promise<BigNumber>;
    grantPermissions(token, flowOperator, overrides?): Promise<boolean>;
    revokePermissions(token, flowOperator, overrides?): Promise<boolean>;
    setFlowrate(token, receiver, flowrate, overrides?): Promise<boolean>;
    setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<boolean>;
    updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<boolean>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<boolean>;
}

Type declaration

  • createFlow:function
    • createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowrate: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • deleteFlow:function
    • deleteFlow(token, sender, receiver, userData, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

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

    • Parameters

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

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

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

    • Parameters

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

      Returns Promise<BigNumber>

  • getBufferAmountByFlowrate:function
    • getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getFlowInfo:function
    • getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowrate: BigNumber;
          lastUpdated: BigNumber;
          owedDeposit: BigNumber;
      }>

    • Parameters

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

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

  • getFlowOperatorPermissions:function
    • getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
          flowrateAllowance: BigNumber;
          permissions: number;
      }>

    • Parameters

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

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

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

    • Parameters

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

      Returns Promise<BigNumber>

  • grantPermissions:function
    • grantPermissions(token, flowOperator, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

  • revokePermissions:function
    • revokePermissions(token, flowOperator, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

  • setFlowrate:function
    • setFlowrate(token, receiver, flowrate, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • receiver: string
      • flowrate: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • setFlowrateFrom:function
    • setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

  • updateFlow:function
    • updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • flowrate: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • updateFlowOperatorPermissions:function
    • updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<boolean>

    • Parameters

      • token: string
      • flowOperator: string
      • permissions: BigNumberish
      • flowrateAllowance: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

estimateGas

estimateGas: {
    createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<BigNumber>;
    deleteFlow(token, sender, receiver, userData, overrides?): Promise<BigNumber>;
    getAccountFlowInfo(token, account, overrides?): Promise<BigNumber>;
    getAccountFlowrate(token, account, overrides?): Promise<BigNumber>;
    getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>;
    getFlowInfo(token, sender, receiver, overrides?): Promise<BigNumber>;
    getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<BigNumber>;
    getFlowrate(token, sender, receiver, overrides?): Promise<BigNumber>;
    grantPermissions(token, flowOperator, overrides?): Promise<BigNumber>;
    revokePermissions(token, flowOperator, overrides?): Promise<BigNumber>;
    setFlowrate(token, receiver, flowrate, overrides?): Promise<BigNumber>;
    setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<BigNumber>;
    updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<BigNumber>;
    updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<BigNumber>;
}

Type declaration

  • createFlow:function
    • createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • token: string
      • sender: string
      • receiver: string
      • userData: 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>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • getBufferAmountByFlowrate:function
    • getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • setFlowrate:function
    • setFlowrate(token, receiver, flowrate, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • receiver: string
      • flowrate: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • updateFlow:function
    • updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

filters

filters: {}

Type declaration

    functions

    functions: {
        createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>;
        deleteFlow(token, sender, receiver, userData, overrides?): Promise<ContractTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>;
        getAccountFlowrate(token, account, overrides?): Promise<[BigNumber] & {
            flowrate: BigNumber;
        }>;
        getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<[BigNumber] & {
            bufferAmount: BigNumber;
        }>;
        getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>;
        getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
            flowrateAllowance: BigNumber;
            permissions: number;
        }>;
        getFlowrate(token, sender, receiver, overrides?): Promise<[BigNumber] & {
            flowrate: BigNumber;
        }>;
        grantPermissions(token, flowOperator, overrides?): Promise<ContractTransaction>;
        revokePermissions(token, flowOperator, overrides?): Promise<ContractTransaction>;
        setFlowrate(token, receiver, flowrate, overrides?): Promise<ContractTransaction>;
        setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<ContractTransaction>;
        updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<ContractTransaction>;
    }

    Type declaration

    • createFlow:function
      • createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>

      • Parameters

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

        Returns Promise<ContractTransaction>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

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

      • Parameters

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

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

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

      • Parameters

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

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

    • getBufferAmountByFlowrate:function
      • getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<[BigNumber] & {
            bufferAmount: BigNumber;
        }>

      • Parameters

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

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

    • getFlowInfo:function
      • getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            deposit: BigNumber;
            flowrate: BigNumber;
            lastUpdated: BigNumber;
            owedDeposit: BigNumber;
        }>

      • Parameters

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

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

    • getFlowOperatorPermissions:function
      • getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
            flowrateAllowance: BigNumber;
            permissions: number;
        }>

      • Parameters

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

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

    • getFlowrate:function
      • getFlowrate(token, sender, receiver, overrides?): Promise<[BigNumber] & {
            flowrate: BigNumber;
        }>

      • Parameters

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

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

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

      • Parameters

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

        Returns Promise<ContractTransaction>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

    • setFlowrate:function
      • setFlowrate(token, receiver, flowrate, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • receiver: string
        • flowrate: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • setFlowrateFrom:function
      • setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<ContractTransaction>

      • Parameters

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

        Returns Promise<ContractTransaction>

    • updateFlow:function
      • updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>

      • Parameters

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

        Returns Promise<ContractTransaction>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

    interface

    interface: CFAv1ForwarderInterface

    off

    off: OnEvent<CFAv1Forwarder>

    on

    on: OnEvent<CFAv1Forwarder>

    once

    once: OnEvent<CFAv1Forwarder>

    populateTransaction

    populateTransaction: {
        createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<PopulatedTransaction>;
        deleteFlow(token, sender, receiver, userData, overrides?): Promise<PopulatedTransaction>;
        getAccountFlowInfo(token, account, overrides?): Promise<PopulatedTransaction>;
        getAccountFlowrate(token, account, overrides?): Promise<PopulatedTransaction>;
        getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<PopulatedTransaction>;
        getFlowInfo(token, sender, receiver, overrides?): Promise<PopulatedTransaction>;
        getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<PopulatedTransaction>;
        getFlowrate(token, sender, receiver, overrides?): Promise<PopulatedTransaction>;
        grantPermissions(token, flowOperator, overrides?): Promise<PopulatedTransaction>;
        revokePermissions(token, flowOperator, overrides?): Promise<PopulatedTransaction>;
        setFlowrate(token, receiver, flowrate, overrides?): Promise<PopulatedTransaction>;
        setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<PopulatedTransaction>;
        updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<PopulatedTransaction>;
        updateFlowOperatorPermissions(token, flowOperator, permissions, flowrateAllowance, overrides?): Promise<PopulatedTransaction>;
    }

    Type declaration

    • createFlow:function
      • createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

        • token: string
        • sender: string
        • receiver: string
        • userData: 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>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • getBufferAmountByFlowrate:function
      • getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<PopulatedTransaction>

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • setFlowrate:function
      • setFlowrate(token, receiver, flowrate, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • receiver: string
        • flowrate: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • updateFlow:function
      • updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    removeListener

    removeListener: OnEvent<CFAv1Forwarder>

    Methods

    attach

    • attach(addressOrName): this

    • Parameters

      • addressOrName: string

      Returns this

    connect

    • connect(signerOrProvider): this

    • Parameters

      • signerOrProvider: string | Signer | Provider

      Returns this

    createFlow

    • createFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

    deleteFlow

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    deployed

    • deployed(): Promise<CFAv1Forwarder>

    • Returns Promise<CFAv1Forwarder>

    getAccountFlowInfo

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

    • Parameters

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

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

    getAccountFlowrate

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

    • Parameters

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

      Returns Promise<BigNumber>

    getBufferAmountByFlowrate

    • getBufferAmountByFlowrate(token, flowrate, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

    getFlowInfo

    • getFlowInfo(token, sender, receiver, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
          deposit: BigNumber;
          flowrate: BigNumber;
          lastUpdated: BigNumber;
          owedDeposit: BigNumber;
      }>

    • Parameters

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

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

    getFlowOperatorPermissions

    • getFlowOperatorPermissions(token, sender, flowOperator, overrides?): Promise<[number, BigNumber] & {
          flowrateAllowance: BigNumber;
          permissions: number;
      }>

    • Parameters

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

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

    getFlowrate

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

    • Parameters

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

      Returns Promise<BigNumber>

    grantPermissions

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    listeners

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

    • Type Parameters

      • TEvent extends TypedEvent<any, any>

      Parameters

      • Optional eventFilter: TypedEventFilter<TEvent>

      Returns TypedListener<TEvent>[]

    • listeners(eventName?): Listener[]

    • Parameters

      • Optional eventName: string

      Returns Listener[]

    queryFilter

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

    • Type Parameters

      • TEvent extends TypedEvent<any, any>

      Parameters

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

      Returns Promise<TEvent[]>

    removeAllListeners

    • removeAllListeners<TEvent>(eventFilter): this

    • Type Parameters

      • TEvent extends TypedEvent<any, any>

      Parameters

      • eventFilter: TypedEventFilter<TEvent>

      Returns this

    • removeAllListeners(eventName?): this

    • Parameters

      • Optional eventName: string

      Returns this

    revokePermissions

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    setFlowrate

    • setFlowrate(token, receiver, flowrate, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • receiver: string
      • flowrate: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    setFlowrateFrom

    • setFlowrateFrom(token, sender, receiver, flowrate, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

    updateFlow

    • updateFlow(token, sender, receiver, flowrate, userData, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

    updateFlowOperatorPermissions

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc