Interface ISuperfluidToken

interface ISuperfluidToken {
    callStatic: {
        createAgreement(id, data, overrides?): Promise<void>;
        getAccountActiveAgreements(account, overrides?): Promise<string[]>;
        getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>;
        getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>;
        getHost(overrides?): Promise<string>;
        isAccountCritical(account, timestamp, overrides?): Promise<boolean>;
        isAccountCriticalNow(account, overrides?): Promise<boolean>;
        isAccountSolvent(account, timestamp, overrides?): Promise<boolean>;
        isAccountSolventNow(account, overrides?): Promise<boolean>;
        makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<void>;
        realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            availableBalance: BigNumber;
            deposit: BigNumber;
            owedDeposit: BigNumber;
        }>;
        realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            availableBalance: BigNumber;
            deposit: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        settleBalance(account, delta, overrides?): Promise<void>;
        terminateAgreement(id, dataLength, overrides?): Promise<void>;
        updateAgreementData(id, data, overrides?): Promise<void>;
        updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<void>;
    };
    estimateGas: {
        createAgreement(id, data, overrides?): Promise<BigNumber>;
        getAccountActiveAgreements(account, overrides?): Promise<BigNumber>;
        getAgreementData(agreementClass, id, dataLength, overrides?): Promise<BigNumber>;
        getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<BigNumber>;
        getHost(overrides?): Promise<BigNumber>;
        isAccountCritical(account, timestamp, overrides?): Promise<BigNumber>;
        isAccountCriticalNow(account, overrides?): Promise<BigNumber>;
        isAccountSolvent(account, timestamp, overrides?): Promise<BigNumber>;
        isAccountSolventNow(account, overrides?): Promise<BigNumber>;
        makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<BigNumber>;
        realtimeBalanceOf(account, timestamp, overrides?): Promise<BigNumber>;
        realtimeBalanceOfNow(account, overrides?): Promise<BigNumber>;
        settleBalance(account, delta, overrides?): Promise<BigNumber>;
        terminateAgreement(id, dataLength, overrides?): Promise<BigNumber>;
        updateAgreementData(id, data, overrides?): Promise<BigNumber>;
        updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<BigNumber>;
    };
    filters: {
        AgreementCreated(agreementClass?, id?, data?): AgreementCreatedEventFilter;
        AgreementCreated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementCreatedEventFilter;
        AgreementLiquidated(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter;
        AgreementLiquidated(address,bytes32,address,address,uint256)(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter;
        AgreementLiquidatedBy(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter;
        AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256)(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter;
        AgreementLiquidatedV2(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter;
        AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes)(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter;
        AgreementStateUpdated(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter;
        AgreementStateUpdated(address,address,uint256)(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter;
        AgreementTerminated(agreementClass?, id?): AgreementTerminatedEventFilter;
        AgreementTerminated(address,bytes32)(agreementClass?, id?): AgreementTerminatedEventFilter;
        AgreementUpdated(agreementClass?, id?, data?): AgreementUpdatedEventFilter;
        AgreementUpdated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementUpdatedEventFilter;
        Bailout(bailoutAccount?, bailoutAmount?): BailoutEventFilter;
        Bailout(address,uint256)(bailoutAccount?, bailoutAmount?): BailoutEventFilter;
    };
    functions: {
        createAgreement(id, data, overrides?): Promise<ContractTransaction>;
        getAccountActiveAgreements(account, overrides?): Promise<[string[]] & {
            activeAgreements: string[];
        }>;
        getAgreementData(agreementClass, id, dataLength, overrides?): Promise<[string[]] & {
            data: string[];
        }>;
        getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<[string[]] & {
            slotData: string[];
        }>;
        getHost(overrides?): Promise<[string] & {
            host: string;
        }>;
        isAccountCritical(account, timestamp, overrides?): Promise<[boolean] & {
            isCritical: boolean;
        }>;
        isAccountCriticalNow(account, overrides?): Promise<[boolean] & {
            isCritical: boolean;
        }>;
        isAccountSolvent(account, timestamp, overrides?): Promise<[boolean] & {
            isSolvent: boolean;
        }>;
        isAccountSolventNow(account, overrides?): Promise<[boolean] & {
            isSolvent: boolean;
        }>;
        makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>;
        realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
            availableBalance: BigNumber;
            deposit: BigNumber;
            owedDeposit: BigNumber;
        }>;
        realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
            availableBalance: BigNumber;
            deposit: BigNumber;
            owedDeposit: BigNumber;
            timestamp: BigNumber;
        }>;
        settleBalance(account, delta, overrides?): Promise<ContractTransaction>;
        terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>;
        updateAgreementData(id, data, overrides?): Promise<ContractTransaction>;
        updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>;
    };
    interface: ISuperfluidTokenInterface;
    off: OnEvent<ISuperfluidToken>;
    on: OnEvent<ISuperfluidToken>;
    once: OnEvent<ISuperfluidToken>;
    populateTransaction: {
        createAgreement(id, data, overrides?): Promise<PopulatedTransaction>;
        getAccountActiveAgreements(account, overrides?): Promise<PopulatedTransaction>;
        getAgreementData(agreementClass, id, dataLength, overrides?): Promise<PopulatedTransaction>;
        getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<PopulatedTransaction>;
        getHost(overrides?): Promise<PopulatedTransaction>;
        isAccountCritical(account, timestamp, overrides?): Promise<PopulatedTransaction>;
        isAccountCriticalNow(account, overrides?): Promise<PopulatedTransaction>;
        isAccountSolvent(account, timestamp, overrides?): Promise<PopulatedTransaction>;
        isAccountSolventNow(account, overrides?): Promise<PopulatedTransaction>;
        makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<PopulatedTransaction>;
        realtimeBalanceOf(account, timestamp, overrides?): Promise<PopulatedTransaction>;
        realtimeBalanceOfNow(account, overrides?): Promise<PopulatedTransaction>;
        settleBalance(account, delta, overrides?): Promise<PopulatedTransaction>;
        terminateAgreement(id, dataLength, overrides?): Promise<PopulatedTransaction>;
        updateAgreementData(id, data, overrides?): Promise<PopulatedTransaction>;
        updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<ISuperfluidToken>;
    attach(addressOrName): this;
    connect(signerOrProvider): this;
    createAgreement(id, data, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<ISuperfluidToken>;
    getAccountActiveAgreements(account, overrides?): Promise<string[]>;
    getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>;
    getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>;
    getHost(overrides?): Promise<string>;
    isAccountCritical(account, timestamp, overrides?): Promise<boolean>;
    isAccountCriticalNow(account, overrides?): Promise<boolean>;
    isAccountSolvent(account, timestamp, overrides?): Promise<boolean>;
    isAccountSolventNow(account, overrides?): Promise<boolean>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>;
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
    }>;
    realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    settleBalance(account, delta, overrides?): Promise<ContractTransaction>;
    terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>;
    updateAgreementData(id, data, overrides?): Promise<ContractTransaction>;
    updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • ISuperfluidToken

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

attach connect createAgreement deployed getAccountActiveAgreements getAgreementData getAgreementStateSlot getHost isAccountCritical isAccountCriticalNow isAccountSolvent isAccountSolventNow listeners makeLiquidationPayoutsV2 queryFilter realtimeBalanceOf realtimeBalanceOfNow removeAllListeners settleBalance terminateAgreement updateAgreementData updateAgreementStateSlot

Properties

callStatic

callStatic: {
    createAgreement(id, data, overrides?): Promise<void>;
    getAccountActiveAgreements(account, overrides?): Promise<string[]>;
    getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>;
    getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>;
    getHost(overrides?): Promise<string>;
    isAccountCritical(account, timestamp, overrides?): Promise<boolean>;
    isAccountCriticalNow(account, overrides?): Promise<boolean>;
    isAccountSolvent(account, timestamp, overrides?): Promise<boolean>;
    isAccountSolventNow(account, overrides?): Promise<boolean>;
    makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<void>;
    realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
    }>;
    realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    settleBalance(account, delta, overrides?): Promise<void>;
    terminateAgreement(id, dataLength, overrides?): Promise<void>;
    updateAgreementData(id, data, overrides?): Promise<void>;
    updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<void>;
}

Type declaration

  • createAgreement:function
    • createAgreement(id, data, overrides?): Promise<void>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • getAccountActiveAgreements:function
    • getAccountActiveAgreements(account, overrides?): Promise<string[]>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<string[]>

  • getAgreementData:function
    • getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>

    • Parameters

      • agreementClass: string
      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string[]>

  • getAgreementStateSlot:function
    • getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>

    • Parameters

      • agreementClass: string
      • account: string
      • slotId: BigNumberish
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<string[]>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • isAccountCritical:function
    • isAccountCritical(account, timestamp, overrides?): Promise<boolean>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isAccountCriticalNow:function
    • isAccountCriticalNow(account, overrides?): Promise<boolean>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isAccountSolvent:function
    • isAccountSolvent(account, timestamp, overrides?): Promise<boolean>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • isAccountSolventNow:function
    • isAccountSolventNow(account, overrides?): Promise<boolean>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<boolean>

  • makeLiquidationPayoutsV2:function
    • makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<void>

    • Parameters

      • id: BytesLike
      • liquidationTypeData: BytesLike
      • liquidatorAccount: string
      • useDefaultRewardAccount: boolean
      • targetAccount: string
      • rewardAmount: BigNumberish
      • targetAccountBalanceDelta: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

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

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

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

  • settleBalance:function
    • settleBalance(account, delta, overrides?): Promise<void>

    • Parameters

      • account: string
      • delta: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • terminateAgreement:function
    • terminateAgreement(id, dataLength, overrides?): Promise<void>

    • Parameters

      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateAgreementData:function
    • updateAgreementData(id, data, overrides?): Promise<void>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateAgreementStateSlot:function
    • updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<void>

    • Parameters

      • account: string
      • slotId: BigNumberish
      • slotData: BytesLike[]
      • Optional overrides: CallOverrides

      Returns Promise<void>

estimateGas

estimateGas: {
    createAgreement(id, data, overrides?): Promise<BigNumber>;
    getAccountActiveAgreements(account, overrides?): Promise<BigNumber>;
    getAgreementData(agreementClass, id, dataLength, overrides?): Promise<BigNumber>;
    getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<BigNumber>;
    getHost(overrides?): Promise<BigNumber>;
    isAccountCritical(account, timestamp, overrides?): Promise<BigNumber>;
    isAccountCriticalNow(account, overrides?): Promise<BigNumber>;
    isAccountSolvent(account, timestamp, overrides?): Promise<BigNumber>;
    isAccountSolventNow(account, overrides?): Promise<BigNumber>;
    makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<BigNumber>;
    realtimeBalanceOf(account, timestamp, overrides?): Promise<BigNumber>;
    realtimeBalanceOfNow(account, overrides?): Promise<BigNumber>;
    settleBalance(account, delta, overrides?): Promise<BigNumber>;
    terminateAgreement(id, dataLength, overrides?): Promise<BigNumber>;
    updateAgreementData(id, data, overrides?): Promise<BigNumber>;
    updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<BigNumber>;
}

Type declaration

  • createAgreement:function
    • createAgreement(id, data, overrides?): Promise<BigNumber>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getAgreementData:function
    • getAgreementData(agreementClass, id, dataLength, overrides?): Promise<BigNumber>

    • Parameters

      • agreementClass: string
      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getAgreementStateSlot:function
    • getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<BigNumber>

    • Parameters

      • agreementClass: string
      • account: string
      • slotId: BigNumberish
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isAccountCritical:function
    • isAccountCritical(account, timestamp, overrides?): Promise<BigNumber>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • isAccountSolvent:function
    • isAccountSolvent(account, timestamp, overrides?): Promise<BigNumber>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • makeLiquidationPayoutsV2:function
    • makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<BigNumber>

    • Parameters

      • id: BytesLike
      • liquidationTypeData: BytesLike
      • liquidatorAccount: string
      • useDefaultRewardAccount: boolean
      • targetAccount: string
      • rewardAmount: BigNumberish
      • targetAccountBalanceDelta: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

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

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • settleBalance:function
    • settleBalance(account, delta, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • terminateAgreement:function
    • terminateAgreement(id, dataLength, overrides?): Promise<BigNumber>

    • Parameters

      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateAgreementData:function
    • updateAgreementData(id, data, overrides?): Promise<BigNumber>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateAgreementStateSlot:function
    • updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<BigNumber>

    • Parameters

      • account: string
      • slotId: BigNumberish
      • slotData: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

filters

filters: {
    AgreementCreated(agreementClass?, id?, data?): AgreementCreatedEventFilter;
    AgreementCreated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementCreatedEventFilter;
    AgreementLiquidated(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter;
    AgreementLiquidated(address,bytes32,address,address,uint256)(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter;
    AgreementLiquidatedBy(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter;
    AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256)(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter;
    AgreementLiquidatedV2(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter;
    AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes)(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter;
    AgreementStateUpdated(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter;
    AgreementStateUpdated(address,address,uint256)(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter;
    AgreementTerminated(agreementClass?, id?): AgreementTerminatedEventFilter;
    AgreementTerminated(address,bytes32)(agreementClass?, id?): AgreementTerminatedEventFilter;
    AgreementUpdated(agreementClass?, id?, data?): AgreementUpdatedEventFilter;
    AgreementUpdated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementUpdatedEventFilter;
    Bailout(bailoutAccount?, bailoutAmount?): BailoutEventFilter;
    Bailout(address,uint256)(bailoutAccount?, bailoutAmount?): BailoutEventFilter;
}

Type declaration

  • AgreementCreated:function
    • AgreementCreated(agreementClass?, id?, data?): AgreementCreatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional data: null

      Returns AgreementCreatedEventFilter

  • AgreementCreated(address,bytes32,bytes32[]):function
    • AgreementCreated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementCreatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional data: null

      Returns AgreementCreatedEventFilter

  • AgreementLiquidated:function
    • AgreementLiquidated(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional penaltyAccount: null | string
      • Optional rewardAccount: null | string
      • Optional rewardAmount: null

      Returns AgreementLiquidatedEventFilter

  • AgreementLiquidated(address,bytes32,address,address,uint256):function
    • AgreementLiquidated(address,bytes32,address,address,uint256)(agreementClass?, id?, penaltyAccount?, rewardAccount?, rewardAmount?): AgreementLiquidatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional penaltyAccount: null | string
      • Optional rewardAccount: null | string
      • Optional rewardAmount: null

      Returns AgreementLiquidatedEventFilter

  • AgreementLiquidatedBy:function
    • AgreementLiquidatedBy(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter

    • Parameters

      • Optional liquidatorAccount: null
      • Optional agreementClass: null | string
      • Optional id: null
      • Optional penaltyAccount: null | string
      • Optional bondAccount: null | string
      • Optional rewardAmount: null
      • Optional bailoutAmount: null

      Returns AgreementLiquidatedByEventFilter

  • AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256):function
    • AgreementLiquidatedBy(address,address,bytes32,address,address,uint256,uint256)(liquidatorAccount?, agreementClass?, id?, penaltyAccount?, bondAccount?, rewardAmount?, bailoutAmount?): AgreementLiquidatedByEventFilter

    • Parameters

      • Optional liquidatorAccount: null
      • Optional agreementClass: null | string
      • Optional id: null
      • Optional penaltyAccount: null | string
      • Optional bondAccount: null | string
      • Optional rewardAmount: null
      • Optional bailoutAmount: null

      Returns AgreementLiquidatedByEventFilter

  • AgreementLiquidatedV2:function
    • AgreementLiquidatedV2(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional liquidatorAccount: null | string
      • Optional targetAccount: null | string
      • Optional rewardAmountReceiver: null
      • Optional rewardAmount: null
      • Optional targetAccountBalanceDelta: null
      • Optional liquidationTypeData: null

      Returns AgreementLiquidatedV2EventFilter

  • AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes):function
    • AgreementLiquidatedV2(address,bytes32,address,address,address,uint256,int256,bytes)(agreementClass?, id?, liquidatorAccount?, targetAccount?, rewardAmountReceiver?, rewardAmount?, targetAccountBalanceDelta?, liquidationTypeData?): AgreementLiquidatedV2EventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional liquidatorAccount: null | string
      • Optional targetAccount: null | string
      • Optional rewardAmountReceiver: null
      • Optional rewardAmount: null
      • Optional targetAccountBalanceDelta: null
      • Optional liquidationTypeData: null

      Returns AgreementLiquidatedV2EventFilter

  • AgreementStateUpdated:function
    • AgreementStateUpdated(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional account: null | string
      • Optional slotId: null

      Returns AgreementStateUpdatedEventFilter

  • AgreementStateUpdated(address,address,uint256):function
    • AgreementStateUpdated(address,address,uint256)(agreementClass?, account?, slotId?): AgreementStateUpdatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional account: null | string
      • Optional slotId: null

      Returns AgreementStateUpdatedEventFilter

  • AgreementTerminated:function
    • AgreementTerminated(agreementClass?, id?): AgreementTerminatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null

      Returns AgreementTerminatedEventFilter

  • AgreementTerminated(address,bytes32):function
    • AgreementTerminated(address,bytes32)(agreementClass?, id?): AgreementTerminatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null

      Returns AgreementTerminatedEventFilter

  • AgreementUpdated:function
    • AgreementUpdated(agreementClass?, id?, data?): AgreementUpdatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional data: null

      Returns AgreementUpdatedEventFilter

  • AgreementUpdated(address,bytes32,bytes32[]):function
    • AgreementUpdated(address,bytes32,bytes32[])(agreementClass?, id?, data?): AgreementUpdatedEventFilter

    • Parameters

      • Optional agreementClass: null | string
      • Optional id: null
      • Optional data: null

      Returns AgreementUpdatedEventFilter

  • Bailout:function
    • Bailout(bailoutAccount?, bailoutAmount?): BailoutEventFilter

    • Parameters

      • Optional bailoutAccount: null | string
      • Optional bailoutAmount: null

      Returns BailoutEventFilter

  • Bailout(address,uint256):function
    • Bailout(address,uint256)(bailoutAccount?, bailoutAmount?): BailoutEventFilter

    • Parameters

      • Optional bailoutAccount: null | string
      • Optional bailoutAmount: null

      Returns BailoutEventFilter

functions

functions: {
    createAgreement(id, data, overrides?): Promise<ContractTransaction>;
    getAccountActiveAgreements(account, overrides?): Promise<[string[]] & {
        activeAgreements: string[];
    }>;
    getAgreementData(agreementClass, id, dataLength, overrides?): Promise<[string[]] & {
        data: string[];
    }>;
    getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<[string[]] & {
        slotData: string[];
    }>;
    getHost(overrides?): Promise<[string] & {
        host: string;
    }>;
    isAccountCritical(account, timestamp, overrides?): Promise<[boolean] & {
        isCritical: boolean;
    }>;
    isAccountCriticalNow(account, overrides?): Promise<[boolean] & {
        isCritical: boolean;
    }>;
    isAccountSolvent(account, timestamp, overrides?): Promise<[boolean] & {
        isSolvent: boolean;
    }>;
    isAccountSolventNow(account, overrides?): Promise<[boolean] & {
        isSolvent: boolean;
    }>;
    makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>;
    realtimeBalanceOf(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
    }>;
    realtimeBalanceOfNow(account, overrides?): Promise<[BigNumber, BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
        timestamp: BigNumber;
    }>;
    settleBalance(account, delta, overrides?): Promise<ContractTransaction>;
    terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>;
    updateAgreementData(id, data, overrides?): Promise<ContractTransaction>;
    updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>;
}

Type declaration

  • createAgreement:function
    • createAgreement(id, data, overrides?): Promise<ContractTransaction>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • getAccountActiveAgreements:function
    • getAccountActiveAgreements(account, overrides?): Promise<[string[]] & {
          activeAgreements: string[];
      }>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[string[]] & {
          activeAgreements: string[];
      }>

  • getAgreementData:function
    • getAgreementData(agreementClass, id, dataLength, overrides?): Promise<[string[]] & {
          data: string[];
      }>

    • Parameters

      • agreementClass: string
      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string[]] & {
          data: string[];
      }>

  • getAgreementStateSlot:function
    • getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<[string[]] & {
          slotData: string[];
      }>

    • Parameters

      • agreementClass: string
      • account: string
      • slotId: BigNumberish
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[string[]] & {
          slotData: string[];
      }>

  • getHost:function
    • getHost(overrides?): Promise<[string] & {
          host: string;
      }>

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string] & {
          host: string;
      }>

  • isAccountCritical:function
    • isAccountCritical(account, timestamp, overrides?): Promise<[boolean] & {
          isCritical: boolean;
      }>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[boolean] & {
          isCritical: boolean;
      }>

  • isAccountCriticalNow:function
    • isAccountCriticalNow(account, overrides?): Promise<[boolean] & {
          isCritical: boolean;
      }>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean] & {
          isCritical: boolean;
      }>

  • isAccountSolvent:function
    • isAccountSolvent(account, timestamp, overrides?): Promise<[boolean] & {
          isSolvent: boolean;
      }>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[boolean] & {
          isSolvent: boolean;
      }>

  • isAccountSolventNow:function
    • isAccountSolventNow(account, overrides?): Promise<[boolean] & {
          isSolvent: boolean;
      }>

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean] & {
          isSolvent: boolean;
      }>

  • makeLiquidationPayoutsV2:function
    • makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>

    • Parameters

      • id: BytesLike
      • liquidationTypeData: BytesLike
      • liquidatorAccount: string
      • useDefaultRewardAccount: boolean
      • targetAccount: string
      • rewardAmount: BigNumberish
      • targetAccountBalanceDelta: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

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

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

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

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

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

  • settleBalance:function
    • settleBalance(account, delta, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • terminateAgreement:function
    • terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>

    • Parameters

      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • updateAgreementData:function
    • updateAgreementData(id, data, overrides?): Promise<ContractTransaction>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

  • updateAgreementStateSlot:function
    • updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>

    • Parameters

      • account: string
      • slotId: BigNumberish
      • slotData: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

interface

interface: ISuperfluidTokenInterface

off

off: OnEvent<ISuperfluidToken>

on

on: OnEvent<ISuperfluidToken>

once

once: OnEvent<ISuperfluidToken>

populateTransaction

populateTransaction: {
    createAgreement(id, data, overrides?): Promise<PopulatedTransaction>;
    getAccountActiveAgreements(account, overrides?): Promise<PopulatedTransaction>;
    getAgreementData(agreementClass, id, dataLength, overrides?): Promise<PopulatedTransaction>;
    getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<PopulatedTransaction>;
    getHost(overrides?): Promise<PopulatedTransaction>;
    isAccountCritical(account, timestamp, overrides?): Promise<PopulatedTransaction>;
    isAccountCriticalNow(account, overrides?): Promise<PopulatedTransaction>;
    isAccountSolvent(account, timestamp, overrides?): Promise<PopulatedTransaction>;
    isAccountSolventNow(account, overrides?): Promise<PopulatedTransaction>;
    makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<PopulatedTransaction>;
    realtimeBalanceOf(account, timestamp, overrides?): Promise<PopulatedTransaction>;
    realtimeBalanceOfNow(account, overrides?): Promise<PopulatedTransaction>;
    settleBalance(account, delta, overrides?): Promise<PopulatedTransaction>;
    terminateAgreement(id, dataLength, overrides?): Promise<PopulatedTransaction>;
    updateAgreementData(id, data, overrides?): Promise<PopulatedTransaction>;
    updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

  • createAgreement:function
    • createAgreement(id, data, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getAgreementData:function
    • getAgreementData(agreementClass, id, dataLength, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • agreementClass: string
      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getAgreementStateSlot:function
    • getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • agreementClass: string
      • account: string
      • slotId: BigNumberish
      • dataLength: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isAccountCritical:function
    • isAccountCritical(account, timestamp, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • isAccountSolvent:function
    • isAccountSolvent(account, timestamp, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • makeLiquidationPayoutsV2:function
    • makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • id: BytesLike
      • liquidationTypeData: BytesLike
      • liquidatorAccount: string
      • useDefaultRewardAccount: boolean
      • targetAccount: string
      • rewardAmount: BigNumberish
      • targetAccountBalanceDelta: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • account: string
      • timestamp: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • account: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • settleBalance:function
    • settleBalance(account, delta, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • terminateAgreement:function
    • terminateAgreement(id, dataLength, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • id: BytesLike
      • dataLength: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • updateAgreementData:function
    • updateAgreementData(id, data, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • id: BytesLike
      • data: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

  • updateAgreementStateSlot:function
    • updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • account: string
      • slotId: BigNumberish
      • slotData: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<ISuperfluidToken>

Methods

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

createAgreement

  • createAgreement(id, data, overrides?): Promise<ContractTransaction>

  • Parameters

    • id: BytesLike
    • data: BytesLike[]
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

deployed

  • deployed(): Promise<ISuperfluidToken>

  • Returns Promise<ISuperfluidToken>

getAccountActiveAgreements

  • getAccountActiveAgreements(account, overrides?): Promise<string[]>

  • Parameters

    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<string[]>

getAgreementData

  • getAgreementData(agreementClass, id, dataLength, overrides?): Promise<string[]>

  • Parameters

    • agreementClass: string
    • id: BytesLike
    • dataLength: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string[]>

getAgreementStateSlot

  • getAgreementStateSlot(agreementClass, account, slotId, dataLength, overrides?): Promise<string[]>

  • Parameters

    • agreementClass: string
    • account: string
    • slotId: BigNumberish
    • dataLength: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<string[]>

getHost

  • getHost(overrides?): Promise<string>

  • Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

isAccountCritical

  • isAccountCritical(account, timestamp, overrides?): Promise<boolean>

  • Parameters

    • account: string
    • timestamp: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isAccountCriticalNow

  • isAccountCriticalNow(account, overrides?): Promise<boolean>

  • Parameters

    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isAccountSolvent

  • isAccountSolvent(account, timestamp, overrides?): Promise<boolean>

  • Parameters

    • account: string
    • timestamp: BigNumberish
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

isAccountSolventNow

  • isAccountSolventNow(account, overrides?): Promise<boolean>

  • Parameters

    • account: string
    • Optional overrides: CallOverrides

    Returns Promise<boolean>

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

makeLiquidationPayoutsV2

  • makeLiquidationPayoutsV2(id, liquidationTypeData, liquidatorAccount, useDefaultRewardAccount, targetAccount, rewardAmount, targetAccountBalanceDelta, overrides?): Promise<ContractTransaction>

  • Parameters

    • id: BytesLike
    • liquidationTypeData: BytesLike
    • liquidatorAccount: string
    • useDefaultRewardAccount: boolean
    • targetAccount: string
    • rewardAmount: BigNumberish
    • targetAccountBalanceDelta: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

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(account, timestamp, overrides?): Promise<[BigNumber, BigNumber, BigNumber] & {
        availableBalance: BigNumber;
        deposit: BigNumber;
        owedDeposit: BigNumber;
    }>

  • Parameters

    • account: string
    • timestamp: BigNumberish
    • Optional overrides: CallOverrides

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

realtimeBalanceOfNow

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

  • Parameters

    • account: string
    • Optional overrides: CallOverrides

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

settleBalance

  • settleBalance(account, delta, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

terminateAgreement

  • terminateAgreement(id, dataLength, overrides?): Promise<ContractTransaction>

  • Parameters

    • id: BytesLike
    • dataLength: BigNumberish
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

updateAgreementData

  • updateAgreementData(id, data, overrides?): Promise<ContractTransaction>

  • Parameters

    • id: BytesLike
    • data: BytesLike[]
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

updateAgreementStateSlot

  • updateAgreementStateSlot(account, slotId, slotData, overrides?): Promise<ContractTransaction>

  • Parameters

    • account: string
    • slotId: BigNumberish
    • slotData: BytesLike[]
    • Optional overrides: Overrides & {
          from?: string;
      }

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc