Class Host

Host Helper Class

Description

A helper class which can be used as a standalone class to populate call agreement transactions.

Constructors

constructor

Properties

callAgreement callAppAction contract

Constructors

constructor

  • new Host(hostAddress): Host

  • Parameters

    • hostAddress: string

    Returns Host

Properties

callAgreement

callAgreement: ((agreementAddress, callData, userData, overrides?) => Operation)

Creates an Operation of the callAgreement function on the host contract.

Type declaration

    • (agreementAddress, callData, userData, overrides?): Operation

    • Creates an Operation of the callAgreement function on the host contract.

      Parameters

      • agreementAddress: string

        the agreement address (cfa or ida address)

      • callData: string

        the encoded callData for the function

      • userData: undefined | string

        any additional user data

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

        ethers overrides object for more control over the transaction sent.

      Returns Operation

      an Operation class

Param: agreementAddress

the agreement address (cfa or ida address)

Param: callData

the encoded callData for the function

Param: userData

any additional user data

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

an Operation class

callAppAction

callAppAction: ((app, callData, overrides?) => Operation)

Creates an Operation of the callAppAction function on the host contract.

Type declaration

    • (app, callData, overrides?): Operation

    • Creates an Operation of the callAppAction function on the host contract.

      Parameters

      • app: string

        the address of the Super App you are calling

      • callData: string

        the encoded callData for the function

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

        ethers overrides object for more control over the transaction sent.

      Returns Operation

      an Operation class

Param: app

the address of the Super App you are calling

Param: callData

the encoded callData for the function

Param: overrides

ethers overrides object for more control over the transaction sent.

Returns

an Operation class

contract

contract: Superfluid

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc