Interface SuperTokenLibraryIDASuperAppMock

interface SuperTokenLibraryIDASuperAppMock {
    callStatic: {
        afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<string>;
        afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<string>;
        afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<string>;
        approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<void>;
        approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<void>;
        beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
        beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
        beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
        calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>;
        claimTest(token, publisher, indexId, subscriber, overrides?): Promise<void>;
        claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<void>;
        createIndexTest(token, indexId, overrides?): Promise<void>;
        createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<void>;
        deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<void>;
        deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<void>;
        distributeTest(token, indexId, amount, overrides?): Promise<void>;
        distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<void>;
        getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>;
        getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>;
        getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>;
        listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>;
        revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<void>;
        revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<void>;
        updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<void>;
        updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<void>;
        updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<void>;
        updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<void>;
    };
    estimateGas: {
        afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<BigNumber>;
        afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<BigNumber>;
        afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<BigNumber>;
        approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<BigNumber>;
        approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
        beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>;
        beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>;
        beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>;
        calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<BigNumber>;
        claimTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
        claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>;
        createIndexTest(token, indexId, overrides?): Promise<BigNumber>;
        createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<BigNumber>;
        deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
        deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>;
        distributeTest(token, indexId, amount, overrides?): Promise<BigNumber>;
        distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<BigNumber>;
        getIndexTest(token, publisher, indexId, overrides?): Promise<BigNumber>;
        getSubscriptionByIDTest(token, agreementId, overrides?): Promise<BigNumber>;
        getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
        listSubscriptionsTest(token, subscriber, overrides?): Promise<BigNumber>;
        revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<BigNumber>;
        revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
        updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<BigNumber>;
        updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<BigNumber>;
        updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<BigNumber>;
        updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<BigNumber>;
    };
    filters: {};
    functions: {
        afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>;
        afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<ContractTransaction>;
        afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>;
        approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>;
        approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>;
        beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>;
        beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>;
        calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>;
        claimTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>;
        claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
        createIndexTest(token, indexId, overrides?): Promise<ContractTransaction>;
        createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<ContractTransaction>;
        deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>;
        deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
        distributeTest(token, indexId, amount, overrides?): Promise<ContractTransaction>;
        distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>;
        getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>;
        getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>;
        getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>;
        listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>;
        revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>;
        revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<ContractTransaction>;
        updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>;
        updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<ContractTransaction>;
        updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>;
    };
    interface: SuperTokenLibraryIDASuperAppMockInterface;
    off: OnEvent<SuperTokenLibraryIDASuperAppMock>;
    on: OnEvent<SuperTokenLibraryIDASuperAppMock>;
    once: OnEvent<SuperTokenLibraryIDASuperAppMock>;
    populateTransaction: {
        afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<PopulatedTransaction>;
        afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<PopulatedTransaction>;
        afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<PopulatedTransaction>;
        approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>;
        beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>;
        beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>;
        calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<PopulatedTransaction>;
        claimTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>;
        createIndexTest(token, indexId, overrides?): Promise<PopulatedTransaction>;
        createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>;
        distributeTest(token, indexId, amount, overrides?): Promise<PopulatedTransaction>;
        distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<PopulatedTransaction>;
        getIndexTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionByIDTest(token, agreementId, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        listSubscriptionsTest(token, subscriber, overrides?): Promise<PopulatedTransaction>;
        revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<PopulatedTransaction>;
        updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<PopulatedTransaction>;
        updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<PopulatedTransaction>;
        updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<SuperTokenLibraryIDASuperAppMock>;
    afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>;
    afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<ContractTransaction>;
    afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>;
    approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>;
    approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
    attach(addressOrName): this;
    beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
    beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
    beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
    calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
        actualAmount: BigNumber;
        newIndexValue: BigNumber;
    }>;
    claimTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>;
    claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    createIndexTest(token, indexId, overrides?): Promise<ContractTransaction>;
    createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<ContractTransaction>;
    deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>;
    deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<SuperTokenLibraryIDASuperAppMock>;
    distributeTest(token, indexId, amount, overrides?): Promise<ContractTransaction>;
    distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>;
    getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
        exist: boolean;
        indexValue: BigNumber;
        totalUnitsApproved: BigNumber;
        totalUnitsPending: BigNumber;
    }>;
    getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        indexId: number;
        pendingDistribution: BigNumber;
        publisher: string;
        units: BigNumber;
    }>;
    getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        exist: boolean;
        pendingDistribution: BigNumber;
        units: BigNumber;
    }>;
    listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
        indexIds: number[];
        publishers: string[];
        unitsList: BigNumber[];
    }>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>;
    revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
    updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<ContractTransaction>;
    updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>;
    updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<ContractTransaction>;
    updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • SuperTokenLibraryIDASuperAppMock

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

afterAgreementCreated afterAgreementTerminated afterAgreementUpdated approveSubscriptionTest approveSubscriptionWithUserDataTest attach beforeAgreementCreated beforeAgreementTerminated beforeAgreementUpdated calculateDistributionTest claimTest claimWithUserDataTest connect createIndexTest createIndexWithUserDataTest deleteSubscriptionTest deleteSubscriptionWithUserDataTest deployed distributeTest distributeWithUserDataTest getIndexTest getSubscriptionByIDTest getSubscriptionTest listSubscriptionsTest listeners queryFilter removeAllListeners revokeSubscriptionTest revokeSubscriptionWithUserDataTest updateIndexValueTest updateIndexValueWithUserDataTest updateSubscriptionUnitsTest updateSubscriptionUnitsWithUserDataTest

Properties

callStatic

callStatic: {
    afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<string>;
    afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<string>;
    afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<string>;
    approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<void>;
    approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<void>;
    beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
    beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
    beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>;
    calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
        actualAmount: BigNumber;
        newIndexValue: BigNumber;
    }>;
    claimTest(token, publisher, indexId, subscriber, overrides?): Promise<void>;
    claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<void>;
    createIndexTest(token, indexId, overrides?): Promise<void>;
    createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<void>;
    deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<void>;
    deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<void>;
    distributeTest(token, indexId, amount, overrides?): Promise<void>;
    distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<void>;
    getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
        exist: boolean;
        indexValue: BigNumber;
        totalUnitsApproved: BigNumber;
        totalUnitsPending: BigNumber;
    }>;
    getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        indexId: number;
        pendingDistribution: BigNumber;
        publisher: string;
        units: BigNumber;
    }>;
    getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        exist: boolean;
        pendingDistribution: BigNumber;
        units: BigNumber;
    }>;
    listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
        indexIds: number[];
        publishers: string[];
        unitsList: BigNumber[];
    }>;
    revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<void>;
    revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<void>;
    updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<void>;
    updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<void>;
    updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<void>;
    updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<void>;
}

Type declaration

  • afterAgreementCreated:function
    • afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • afterAgreementTerminated:function
    • afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • arg5: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • afterAgreementUpdated:function
    • afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<string>

    • Parameters

      • token: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • ctx: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • approveSubscriptionTest:function
    • approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • approveSubscriptionWithUserDataTest:function
    • approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • beforeAgreementCreated:function
    • beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • beforeAgreementTerminated:function
    • beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • beforeAgreementUpdated:function
    • beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • calculateDistributionTest:function
    • calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
          actualAmount: BigNumber;
          newIndexValue: BigNumber;
      }>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & {
          actualAmount: BigNumber;
          newIndexValue: BigNumber;
      }>

  • claimTest:function
    • claimTest(token, publisher, indexId, subscriber, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • claimWithUserDataTest:function
    • claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • createIndexTest:function
    • createIndexTest(token, indexId, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

  • createIndexWithUserDataTest:function
    • createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • deleteSubscriptionTest:function
    • deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • deleteSubscriptionWithUserDataTest:function
    • deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • distributeTest:function
    • distributeTest(token, indexId, amount, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • distributeWithUserDataTest:function
    • distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • getIndexTest:function
    • getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
          exist: boolean;
          indexValue: BigNumber;
          totalUnitsApproved: BigNumber;
          totalUnitsPending: BigNumber;
      }>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
          exist: boolean;
          indexValue: BigNumber;
          totalUnitsApproved: BigNumber;
          totalUnitsPending: BigNumber;
      }>

  • getSubscriptionByIDTest:function
    • getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          indexId: number;
          pendingDistribution: BigNumber;
          publisher: string;
          units: BigNumber;
      }>

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[string, number, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          indexId: number;
          pendingDistribution: BigNumber;
          publisher: string;
          units: BigNumber;
      }>

  • getSubscriptionTest:function
    • getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          exist: boolean;
          pendingDistribution: BigNumber;
          units: BigNumber;
      }>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          exist: boolean;
          pendingDistribution: BigNumber;
          units: BigNumber;
      }>

  • listSubscriptionsTest:function
    • listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
          indexIds: number[];
          publishers: string[];
          unitsList: BigNumber[];
      }>

    • Parameters

      • token: string
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<[string[], number[], BigNumber[]] & {
          indexIds: number[];
          publishers: string[];
          unitsList: BigNumber[];
      }>

  • revokeSubscriptionTest:function
    • revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • revokeSubscriptionWithUserDataTest:function
    • revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateIndexValueTest:function
    • updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • indexValue: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateIndexValueWithUserDataTest:function
    • updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • indexValue: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateSubscriptionUnitsTest:function
    • updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • subscriber: string
      • units: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<void>

  • updateSubscriptionUnitsWithUserDataTest:function
    • updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<void>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • subscriber: string
      • units: BigNumberish
      • userData: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<void>

estimateGas

estimateGas: {
    afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<BigNumber>;
    afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<BigNumber>;
    afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<BigNumber>;
    approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<BigNumber>;
    approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
    beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>;
    beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>;
    beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>;
    calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<BigNumber>;
    claimTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
    claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>;
    createIndexTest(token, indexId, overrides?): Promise<BigNumber>;
    createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<BigNumber>;
    deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
    deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>;
    distributeTest(token, indexId, amount, overrides?): Promise<BigNumber>;
    distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<BigNumber>;
    getIndexTest(token, publisher, indexId, overrides?): Promise<BigNumber>;
    getSubscriptionByIDTest(token, agreementId, overrides?): Promise<BigNumber>;
    getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
    listSubscriptionsTest(token, subscriber, overrides?): Promise<BigNumber>;
    revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<BigNumber>;
    revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
    updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<BigNumber>;
    updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<BigNumber>;
    updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<BigNumber>;
    updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<BigNumber>;
}

Type declaration

  • afterAgreementCreated:function
    • afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • afterAgreementTerminated:function
    • afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • arg5: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • afterAgreementUpdated:function
    • afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • approveSubscriptionTest:function
    • approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • approveSubscriptionWithUserDataTest:function
    • approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • beforeAgreementCreated:function
    • beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • beforeAgreementTerminated:function
    • beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • beforeAgreementUpdated:function
    • beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<BigNumber>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • calculateDistributionTest:function
    • calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • claimTest:function
    • claimTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • claimWithUserDataTest:function
    • claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • createIndexTest:function
    • createIndexTest(token, indexId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • createIndexWithUserDataTest:function
    • createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • deleteSubscriptionTest:function
    • deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • deleteSubscriptionWithUserDataTest:function
    • deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • distributeTest:function
    • distributeTest(token, indexId, amount, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • distributeWithUserDataTest:function
    • distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • getIndexTest:function
    • getIndexTest(token, publisher, indexId, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getSubscriptionByIDTest:function
    • getSubscriptionByIDTest(token, agreementId, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getSubscriptionTest:function
    • getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • listSubscriptionsTest:function
    • listSubscriptionsTest(token, subscriber, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • revokeSubscriptionTest:function
    • revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • revokeSubscriptionWithUserDataTest:function
    • revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateIndexValueTest:function
    • updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • indexValue: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateIndexValueWithUserDataTest:function
    • updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • indexValue: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateSubscriptionUnitsTest:function
    • updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • subscriber: string
      • units: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

  • updateSubscriptionUnitsWithUserDataTest:function
    • updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<BigNumber>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • subscriber: string
      • units: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<BigNumber>

filters

filters: {}

Type declaration

    functions

    functions: {
        afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>;
        afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<ContractTransaction>;
        afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>;
        approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>;
        approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>;
        beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>;
        beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>;
        calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>;
        claimTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>;
        claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
        createIndexTest(token, indexId, overrides?): Promise<ContractTransaction>;
        createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<ContractTransaction>;
        deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>;
        deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
        distributeTest(token, indexId, amount, overrides?): Promise<ContractTransaction>;
        distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>;
        getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>;
        getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>;
        getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>;
        listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>;
        revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>;
        revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<ContractTransaction>;
        updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>;
        updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<ContractTransaction>;
        updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>;
    }

    Type declaration

    • afterAgreementCreated:function
      • afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • ctx: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • afterAgreementTerminated:function
      • afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<ContractTransaction>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • arg5: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • afterAgreementUpdated:function
      • afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • ctx: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • approveSubscriptionTest:function
      • approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • approveSubscriptionWithUserDataTest:function
      • approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • beforeAgreementCreated:function
      • beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<[string]>

    • beforeAgreementTerminated:function
      • beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<[string]>

    • beforeAgreementUpdated:function
      • beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<[string]>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<[string]>

    • calculateDistributionTest:function
      • calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • amount: BigNumberish
        • Optional overrides: CallOverrides

        Returns Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>

    • claimTest:function
      • claimTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • claimWithUserDataTest:function
      • claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • createIndexTest:function
      • createIndexTest(token, indexId, overrides?): Promise<ContractTransaction>

      • Parameters

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

        Returns Promise<ContractTransaction>

    • createIndexWithUserDataTest:function
      • createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<ContractTransaction>

      • Parameters

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

        Returns Promise<ContractTransaction>

    • deleteSubscriptionTest:function
      • deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • deleteSubscriptionWithUserDataTest:function
      • deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • distributeTest:function
      • distributeTest(token, indexId, amount, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • amount: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • distributeWithUserDataTest:function
      • distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • amount: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • getIndexTest:function
      • getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • Optional overrides: CallOverrides

        Returns Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>

    • getSubscriptionByIDTest:function
      • getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>

      • Parameters

        • token: string
        • agreementId: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>

    • getSubscriptionTest:function
      • getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • Optional overrides: CallOverrides

        Returns Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>

    • listSubscriptionsTest:function
      • listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>

      • Parameters

        • token: string
        • subscriber: string
        • Optional overrides: CallOverrides

        Returns Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>

    • revokeSubscriptionTest:function
      • revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • revokeSubscriptionWithUserDataTest:function
      • revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • updateIndexValueTest:function
      • updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • indexValue: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • updateIndexValueWithUserDataTest:function
      • updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • indexValue: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • updateSubscriptionUnitsTest:function
      • updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • subscriber: string
        • units: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    • updateSubscriptionUnitsWithUserDataTest:function
      • updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • subscriber: string
        • units: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<ContractTransaction>

    interface

    interface: SuperTokenLibraryIDASuperAppMockInterface

    off

    off: OnEvent<SuperTokenLibraryIDASuperAppMock>

    on

    on: OnEvent<SuperTokenLibraryIDASuperAppMock>

    once

    once: OnEvent<SuperTokenLibraryIDASuperAppMock>

    populateTransaction

    populateTransaction: {
        afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<PopulatedTransaction>;
        afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<PopulatedTransaction>;
        afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<PopulatedTransaction>;
        approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>;
        beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>;
        beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>;
        calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<PopulatedTransaction>;
        claimTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>;
        createIndexTest(token, indexId, overrides?): Promise<PopulatedTransaction>;
        createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>;
        distributeTest(token, indexId, amount, overrides?): Promise<PopulatedTransaction>;
        distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<PopulatedTransaction>;
        getIndexTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionByIDTest(token, agreementId, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        listSubscriptionsTest(token, subscriber, overrides?): Promise<PopulatedTransaction>;
        revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<PopulatedTransaction>;
        updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<PopulatedTransaction>;
        updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<PopulatedTransaction>;
        updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<PopulatedTransaction>;
    }

    Type declaration

    • afterAgreementCreated:function
      • afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • ctx: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • afterAgreementTerminated:function
      • afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • arg5: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • afterAgreementUpdated:function
      • afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • ctx: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • approveSubscriptionTest:function
      • approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • approveSubscriptionWithUserDataTest:function
      • approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • beforeAgreementCreated:function
      • beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • beforeAgreementTerminated:function
      • beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • beforeAgreementUpdated:function
      • beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • arg0: string
        • arg1: string
        • arg2: BytesLike
        • arg3: BytesLike
        • arg4: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • calculateDistributionTest:function
      • calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • amount: BigNumberish
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • claimTest:function
      • claimTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • claimWithUserDataTest:function
      • claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • createIndexTest:function
      • createIndexTest(token, indexId, overrides?): Promise<PopulatedTransaction>

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • createIndexWithUserDataTest:function
      • createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • deleteSubscriptionTest:function
      • deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • deleteSubscriptionWithUserDataTest:function
      • deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • distributeTest:function
      • distributeTest(token, indexId, amount, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • amount: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • distributeWithUserDataTest:function
      • distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • amount: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • getIndexTest:function
      • getIndexTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • getSubscriptionByIDTest:function
      • getSubscriptionByIDTest(token, agreementId, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • agreementId: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • getSubscriptionTest:function
      • getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • subscriber: string
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • listSubscriptionsTest:function
      • listSubscriptionsTest(token, subscriber, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • subscriber: string
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

    • revokeSubscriptionTest:function
      • revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • revokeSubscriptionWithUserDataTest:function
      • revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • publisher: string
        • indexId: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • updateIndexValueTest:function
      • updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • indexValue: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • updateIndexValueWithUserDataTest:function
      • updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • indexValue: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • updateSubscriptionUnitsTest:function
      • updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • subscriber: string
        • units: BigNumberish
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    • updateSubscriptionUnitsWithUserDataTest:function
      • updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • token: string
        • indexId: BigNumberish
        • subscriber: string
        • units: BigNumberish
        • userData: BytesLike
        • Optional overrides: Overrides & {
              from?: string;
          }

        Returns Promise<PopulatedTransaction>

    removeListener

    removeListener: OnEvent<SuperTokenLibraryIDASuperAppMock>

    Methods

    afterAgreementCreated

    • afterAgreementCreated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    afterAgreementTerminated

    • afterAgreementTerminated(arg0, arg1, arg2, arg3, arg4, arg5, overrides?): Promise<ContractTransaction>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • arg5: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    afterAgreementUpdated

    • afterAgreementUpdated(token, arg1, arg2, arg3, arg4, ctx, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • ctx: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    approveSubscriptionTest

    • approveSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    approveSubscriptionWithUserDataTest

    • approveSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    attach

    • attach(addressOrName): this

    • Parameters

      • addressOrName: string

      Returns this

    beforeAgreementCreated

    • beforeAgreementCreated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

    beforeAgreementTerminated

    • beforeAgreementTerminated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

    beforeAgreementUpdated

    • beforeAgreementUpdated(arg0, arg1, arg2, arg3, arg4, overrides?): Promise<string>

    • Parameters

      • arg0: string
      • arg1: string
      • arg2: BytesLike
      • arg3: BytesLike
      • arg4: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

    calculateDistributionTest

    • calculateDistributionTest(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
          actualAmount: BigNumber;
          newIndexValue: BigNumber;
      }>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[BigNumber, BigNumber] & {
          actualAmount: BigNumber;
          newIndexValue: BigNumber;
      }>

    claimTest

    • claimTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    claimWithUserDataTest

    • claimWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    connect

    • connect(signerOrProvider): this

    • Parameters

      • signerOrProvider: string | Signer | Provider

      Returns this

    createIndexTest

    • createIndexTest(token, indexId, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

    createIndexWithUserDataTest

    • createIndexWithUserDataTest(token, indexId, userData, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

    deleteSubscriptionTest

    • deleteSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    deleteSubscriptionWithUserDataTest

    • deleteSubscriptionWithUserDataTest(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    deployed

    distributeTest

    • distributeTest(token, indexId, amount, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    distributeWithUserDataTest

    • distributeWithUserDataTest(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • amount: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    getIndexTest

    • getIndexTest(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
          exist: boolean;
          indexValue: BigNumber;
          totalUnitsApproved: BigNumber;
          totalUnitsPending: BigNumber;
      }>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: CallOverrides

      Returns Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
          exist: boolean;
          indexValue: BigNumber;
          totalUnitsApproved: BigNumber;
          totalUnitsPending: BigNumber;
      }>

    getSubscriptionByIDTest

    • getSubscriptionByIDTest(token, agreementId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          indexId: number;
          pendingDistribution: BigNumber;
          publisher: string;
          units: BigNumber;
      }>

    • Parameters

      • token: string
      • agreementId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<[string, number, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          indexId: number;
          pendingDistribution: BigNumber;
          publisher: string;
          units: BigNumber;
      }>

    getSubscriptionTest

    • getSubscriptionTest(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          exist: boolean;
          pendingDistribution: BigNumber;
          units: BigNumber;
      }>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<[boolean, boolean, BigNumber, BigNumber] & {
          approved: boolean;
          exist: boolean;
          pendingDistribution: BigNumber;
          units: BigNumber;
      }>

    listSubscriptionsTest

    • listSubscriptionsTest(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
          indexIds: number[];
          publishers: string[];
          unitsList: BigNumber[];
      }>

    • Parameters

      • token: string
      • subscriber: string
      • Optional overrides: CallOverrides

      Returns Promise<[string[], number[], BigNumber[]] & {
          indexIds: number[];
          publishers: string[];
          unitsList: BigNumber[];
      }>

    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

    revokeSubscriptionTest

    • revokeSubscriptionTest(token, publisher, indexId, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    revokeSubscriptionWithUserDataTest

    • revokeSubscriptionWithUserDataTest(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • publisher: string
      • indexId: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    updateIndexValueTest

    • updateIndexValueTest(token, indexId, indexValue, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • indexValue: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    updateIndexValueWithUserDataTest

    • updateIndexValueWithUserDataTest(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • indexValue: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    updateSubscriptionUnitsTest

    • updateSubscriptionUnitsTest(token, indexId, subscriber, units, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • subscriber: string
      • units: BigNumberish
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    updateSubscriptionUnitsWithUserDataTest

    • updateSubscriptionUnitsWithUserDataTest(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>

    • Parameters

      • token: string
      • indexId: BigNumberish
      • subscriber: string
      • units: BigNumberish
      • userData: BytesLike
      • Optional overrides: Overrides & {
            from?: string;
        }

      Returns Promise<ContractTransaction>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc