Class ConstantFlowAgreementV1

Constant Flow Agreement V1 Helper Class

Description

A helper class to interact with the CFAV1 contract.

Hierarchy

  • default
    • ConstantFlowAgreementV1

Constructors

constructor

Properties

_getCallAgreementOperation _sanitizeFlowInfo _sanitizeFlowOperatorData contract createFlow createFlowByOperator deleteFlow deleteFlowByOperator forwarder getAccountFlowInfo getFlow getFlowOperatorData getFlowOperatorDataByID getNetFlow host updateFlow updateFlowByOperator

Methods

authorizeFlowOperatorWithFullControl decreaseFlowRateAllowance decreaseFlowRateAllowanceWithPermissions increaseFlowRateAllowance increaseFlowRateAllowanceWithPermissions revokeFlowOperatorWithFullControl updateFlowOperatorPermissions

Constructors

constructor

  • new ConstantFlowAgreementV1(hostAddress, cfaV1Address, cfaV1ForwarderAddress): _sdkCore.ConstantFlowAgreementV1

  • Parameters

    • hostAddress: string
    • cfaV1Address: string
    • cfaV1ForwarderAddress: string

    Returns _sdkCore.ConstantFlowAgreementV1

Properties

_getCallAgreementOperation

_getCallAgreementOperation: ((callAgreementOperation, forwarderPopulatedTransactionPromise?, shouldUseCallAgreement?) => Operation)

Returns the desired Operation based on shouldUseCallAgreement.

Type declaration

    • (callAgreementOperation, forwarderPopulatedTransactionPromise?, shouldUseCallAgreement?): Operation

    • Returns the desired Operation based on shouldUseCallAgreement.

      Parameters

      • callAgreementOperation: Operation

        the host.callAgreement created Operation

      • Optional forwarderPopulatedTransactionPromise: Promise<PopulatedTransaction>

        the populated forwarder transaction promise

      • Optional shouldUseCallAgreement: boolean

        whether or not to use host.callAgreement

      Returns Operation

Param: shouldUseCallAgreement

whether or not to use host.callAgreement

Param: callAgreementOperation

the host.callAgreement created Operation

Param: forwarderPopulatedTransactionPromise

the populated forwarder transaction promise

_sanitizeFlowInfo

_sanitizeFlowInfo: ((params) => IWeb3FlowInfo)

Sanitizes flow info, converting BigNumber to string.

Type declaration

Param: timestamp

last updated timestamp of flow

Param: flowRate

the current flow rate

Param: deposit

the deposit amount

Param: owedDeposit

any owed deposit

Returns

sanitized web3 flow info

_sanitizeFlowOperatorData

_sanitizeFlowOperatorData: ((params) => IWeb3FlowOperatorData)

Sanitizes flow operator data, converting BigNumber to string.

Type declaration

Param: flowOperatorId

The keccak256 hash of encoded string "flowOperator", sender and flowOperator

Param: permissions

the permissions

Param: flowRateAllowance

the flow rate allowance granted to the flow operator

Returns

sanitized web3 flow info

Readonly contract

contract: IConstantFlowAgreementV1

createFlow

createFlow: ((params) => Operation)

Create a flow.

Type declaration

Param: flowRate

The specified flow rate.

Param: sender

The sender of the flow

Param: receiver

The receiver of the flow.

Param: superToken

The token to be flowed.

Param: userData

Extra user data provided.

Param: overrides

ethers overrides object for more control over the transaction sent.

Param: shouldUseCallAgreement

Whether to use callAgreement, or the CFAv1Forwarder

Returns

An instance of Operation which can be executed or batched.

createFlowByOperator

createFlowByOperator: ((params) => Operation)

Create a flow as an operator

Type declaration

Param: flowRate

The specified flow rate.

Param: sender

The sender of the flow.

Param: receiver

The receiver of the flow.

Param: superToken

The token to be flowed.

Param: userData

Extra user data provided.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

deleteFlow

deleteFlow: ((params) => Operation)

Delete a flow.

Type declaration

Param: superToken

The token to be flowed.

Param: sender

The sender of the flow.

Param: receiver

The receiver of the flow.

Param: userData

Extra user data provided.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

deleteFlowByOperator

deleteFlowByOperator: ((params) => Operation)

Delete a flow as an operator.

Type declaration

Param: sender

The sender of the flow.

Param: receiver

The receiver of the flow.

Param: superToken

The token to be flowed.

Param: userData

Extra user data provided.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

Readonly forwarder

forwarder: CFAv1Forwarder

getAccountFlowInfo

getAccountFlowInfo: ((params) => Promise<IWeb3FlowInfo>)

Get the flow info of an account (net flow).

Type declaration

Param: superToken

the superToken of the agreement

Param: account

the account we're querying

Param: providerOrSigner

a provider or signer object

Returns

Web3 Flow info object

getFlow

getFlow: ((params) => Promise<IWeb3FlowInfo>)

Get the details of a flow.

Type declaration

Param: superToken

the superToken of the agreement

Param: sender

the sender of the flow

Param: receiver

the receiver of the flow

Param: providerOrSigner

a provider or signer object

Returns

Web3 Flow info object

getFlowOperatorData

getFlowOperatorData: ((params) => Promise<IWeb3FlowOperatorData>)

Get flow operator data.

Type declaration

Param: superToken

the superToken of the agreement

Param: sender

the sender

Param: flowOperator

the flowOperator

Param: providerOrSigner

a provider or signer object

Returns

Web3 Flow info object

getFlowOperatorDataByID

getFlowOperatorDataByID: ((params) => Promise<IWeb3FlowOperatorData>)

Get flow operator data using the flowOperatorId.

Type declaration

Param: superToken

the superToken of the agreement

Param: flowOperatorId

The keccak256 hash of encoded string "flowOperator", sender and flowOperator

Param: providerOrSigner

a provider or signer object

Returns

Web3 Flow info object

getNetFlow

getNetFlow: ((params) => Promise<string>)

Get the net flow of an account.

Type declaration

    • (params): Promise<string>

    • Get the net flow of an account.

      Parameters

      Returns Promise<string>

      Web3 Flow info object

Param: superToken

the superToken of the agreement

Param: account

the account we're querying

Param: providerOrSigner

a provider or signer object

Returns

Web3 Flow info object

Readonly host

host: Host

updateFlow

updateFlow: ((params) => Operation)

Update a flow.

Type declaration

Param: flowRate

The specified flow rate.

Param: sender

The sender of the flow

Param: receiver

The receiver of the flow.

Param: superToken

The token to be flowed.

Param: userData

Extra user data provided.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

updateFlowByOperator

updateFlowByOperator: ((params) => Operation)

Update a flow as an operator.

Type declaration

Param: flowRate

The specified flow rate.

Param: sender

The sender of the flow.

Param: receiver

The receiver of the flow.

Param: superToken

The token to be flowed.

Param: userData

Extra user data provided.

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

An instance of Operation which can be executed or batched.

Methods

authorizeFlowOperatorWithFullControl

  • authorizeFlowOperatorWithFullControl(params): Operation

  • Give flow operator full control - max flow rate and create/update/delete permissions.

    Parameters

    Returns Operation

decreaseFlowRateAllowance

  • decreaseFlowRateAllowance(params): Operation

  • Decrease the flow rate allowance for an ACL operator.

    Parameters

    Returns Operation

    An instance of Operation which can be executed or batched.

decreaseFlowRateAllowanceWithPermissions

  • decreaseFlowRateAllowanceWithPermissions(params): Operation

  • Decrease the flow rate allowance and sets permissions for an ACL operator.

    Parameters

    Returns Operation

    An instance of Operation which can be executed or batched.

increaseFlowRateAllowance

  • increaseFlowRateAllowance(params): Operation

  • Increase the flow rate allowance for an ACL operator.

    Parameters

    Returns Operation

    An instance of Operation which can be executed or batched.

increaseFlowRateAllowanceWithPermissions

  • increaseFlowRateAllowanceWithPermissions(params): Operation

  • Increase the flow rate allowance and sets permissions for an ACL operator.

    Parameters

    Returns Operation

    An instance of Operation which can be executed or batched.

revokeFlowOperatorWithFullControl

  • revokeFlowOperatorWithFullControl(params): Operation

  • Revoke flow operator control - set flow rate to 0 with no permissions.

    Parameters

    Returns Operation

updateFlowOperatorPermissions

  • updateFlowOperatorPermissions(params): Operation

  • Update permissions for a flow operator as a sender.

    Parameters

    Returns Operation

    An instance of Operation which can be executed or batched.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc