@aleph-sdk/monorepo
    Preparing search index...

    Class SuperfluidAccount

    SuperfluidAccount implements the Account class for the Superfluid protocol, now for AVAX and BASE chains. It is used to represent a Superfluid account when publishing a message on the Aleph network.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    address: string
    publicKey: undefined | string
    selectedRpcId?: RpcId

    Methods

    • Decrease the ALEPH flow rate to a given receiver. Deletes the flow if the new flow rate is 0.

      Parameters

      • receiver: string

        The receiver address.

      • alephPerHour: number | Decimal

        The amount of ALEPH per hour to decrease the flow by.

      Returns Promise<void>

    • Get the ALEPH flow rate to a given receiver in ALEPH per hour.

      Parameters

      • receiver: string

        The receiver address.

      Returns Promise<Decimal>

    • Increase the ALEPH flow rate to a given receiver. Creates a new flow if none exists.

      Parameters

      • receiver: string

        The receiver address.

      • alephPerHour: number | Decimal

        The amount of ALEPH per hour to increase the flow by.

      Returns Promise<void>