Interface IDAv1Forwarder

interface IDAv1Forwarder {
    callStatic: {
        approveSubscription(token, publisher, indexId, userData, overrides?): Promise<boolean>;
        calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>;
        createIndex(token, indexId, userData, overrides?): Promise<boolean>;
        deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<boolean>;
        distribute(token, indexId, amount, userData, overrides?): Promise<boolean>;
        getIndex(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>;
        getPublisherId(publisher, indexId, overrides?): Promise<string>;
        getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>;
        getSubscriptionByID(token, subscriptionId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>;
        getSubscriptionId(subscriber, publisherId, overrides?): Promise<string>;
        listSubscriptions(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>;
        revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<boolean>;
        updateIndex(token, indexId, indexValue, userData, overrides?): Promise<boolean>;
        updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<boolean>;
    };
    estimateGas: {
        approveSubscription(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
        calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<BigNumber>;
        createIndex(token, indexId, userData, overrides?): Promise<BigNumber>;
        deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>;
        distribute(token, indexId, amount, userData, overrides?): Promise<BigNumber>;
        getIndex(token, publisher, indexId, overrides?): Promise<BigNumber>;
        getPublisherId(publisher, indexId, overrides?): Promise<BigNumber>;
        getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
        getSubscriptionByID(token, subscriptionId, overrides?): Promise<BigNumber>;
        getSubscriptionId(subscriber, publisherId, overrides?): Promise<BigNumber>;
        listSubscriptions(token, subscriber, overrides?): Promise<BigNumber>;
        revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
        updateIndex(token, indexId, indexValue, userData, overrides?): Promise<BigNumber>;
        updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<BigNumber>;
    };
    filters: {};
    functions: {
        approveSubscription(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>;
        createIndex(token, indexId, userData, overrides?): Promise<ContractTransaction>;
        deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
        distribute(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>;
        getIndex(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>;
        getPublisherId(publisher, indexId, overrides?): Promise<[string] & {
            publisherId: string;
        }>;
        getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>;
        getSubscriptionByID(token, subscriptionId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>;
        getSubscriptionId(subscriber, publisherId, overrides?): Promise<[string] & {
            subscriptionId: string;
        }>;
        listSubscriptions(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>;
        revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        updateIndex(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>;
        updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>;
    };
    interface: IDAv1ForwarderInterface;
    off: OnEvent<IDAv1Forwarder>;
    on: OnEvent<IDAv1Forwarder>;
    once: OnEvent<IDAv1Forwarder>;
    populateTransaction: {
        approveSubscription(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<PopulatedTransaction>;
        createIndex(token, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>;
        distribute(token, indexId, amount, userData, overrides?): Promise<PopulatedTransaction>;
        getIndex(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        getPublisherId(publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionByID(token, subscriptionId, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionId(subscriber, publisherId, overrides?): Promise<PopulatedTransaction>;
        listSubscriptions(token, subscriber, overrides?): Promise<PopulatedTransaction>;
        revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        updateIndex(token, indexId, indexValue, userData, overrides?): Promise<PopulatedTransaction>;
        updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<IDAv1Forwarder>;
    approveSubscription(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
    attach(addressOrName): this;
    calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
        actualAmount: BigNumber;
        newIndexValue: BigNumber;
    }>;
    connect(signerOrProvider): this;
    createIndex(token, indexId, userData, overrides?): Promise<ContractTransaction>;
    deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
    deployed(): Promise<IDAv1Forwarder>;
    distribute(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>;
    getIndex(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
        exist: boolean;
        indexValue: BigNumber;
        totalUnitsApproved: BigNumber;
        totalUnitsPending: BigNumber;
    }>;
    getPublisherId(publisher, indexId, overrides?): Promise<string>;
    getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        exist: boolean;
        pendingDistribution: BigNumber;
        units: BigNumber;
    }>;
    getSubscriptionByID(token, subscriptionId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        indexId: number;
        pendingDistribution: BigNumber;
        publisher: string;
        units: BigNumber;
    }>;
    getSubscriptionId(subscriber, publisherId, overrides?): Promise<string>;
    listSubscriptions(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;
    revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
    updateIndex(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>;
    updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • IDAv1Forwarder

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

approveSubscription attach calculateDistribution connect createIndex deleteSubscription deployed distribute getIndex getPublisherId getSubscription getSubscriptionByID getSubscriptionId listSubscriptions listeners queryFilter removeAllListeners revokeSubscription updateIndex updateSubscriptionUnits

Properties

callStatic

callStatic: {
    approveSubscription(token, publisher, indexId, userData, overrides?): Promise<boolean>;
    calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
        actualAmount: BigNumber;
        newIndexValue: BigNumber;
    }>;
    createIndex(token, indexId, userData, overrides?): Promise<boolean>;
    deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<boolean>;
    distribute(token, indexId, amount, userData, overrides?): Promise<boolean>;
    getIndex(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
        exist: boolean;
        indexValue: BigNumber;
        totalUnitsApproved: BigNumber;
        totalUnitsPending: BigNumber;
    }>;
    getPublisherId(publisher, indexId, overrides?): Promise<string>;
    getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        exist: boolean;
        pendingDistribution: BigNumber;
        units: BigNumber;
    }>;
    getSubscriptionByID(token, subscriptionId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
        approved: boolean;
        indexId: number;
        pendingDistribution: BigNumber;
        publisher: string;
        units: BigNumber;
    }>;
    getSubscriptionId(subscriber, publisherId, overrides?): Promise<string>;
    listSubscriptions(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
        indexIds: number[];
        publishers: string[];
        unitsList: BigNumber[];
    }>;
    revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<boolean>;
    updateIndex(token, indexId, indexValue, userData, overrides?): Promise<boolean>;
    updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<boolean>;
}

Type declaration

  • approveSubscription:function
    • approveSubscription(token, publisher, indexId, userData, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

  • calculateDistribution:function
    • calculateDistribution(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;
      }>

  • createIndex:function
    • createIndex(token, indexId, userData, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

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

    • Parameters

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

      Returns Promise<boolean>

  • distribute:function
    • distribute(token, indexId, amount, userData, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

  • getIndex:function
    • getIndex(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;
      }>

  • getPublisherId:function
    • getPublisherId(publisher, indexId, overrides?): Promise<string>

    • Parameters

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

      Returns Promise<string>

  • getSubscription:function
    • getSubscription(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;
      }>

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

    • Parameters

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

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

  • getSubscriptionId:function
    • getSubscriptionId(subscriber, publisherId, overrides?): Promise<string>

    • Parameters

      • subscriber: string
      • publisherId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • listSubscriptions:function
    • listSubscriptions(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[];
      }>

  • revokeSubscription:function
    • revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

  • updateIndex:function
    • updateIndex(token, indexId, indexValue, userData, overrides?): Promise<boolean>

    • Parameters

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

      Returns Promise<boolean>

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

    • Parameters

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

      Returns Promise<boolean>

estimateGas

estimateGas: {
    approveSubscription(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
    calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<BigNumber>;
    createIndex(token, indexId, userData, overrides?): Promise<BigNumber>;
    deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<BigNumber>;
    distribute(token, indexId, amount, userData, overrides?): Promise<BigNumber>;
    getIndex(token, publisher, indexId, overrides?): Promise<BigNumber>;
    getPublisherId(publisher, indexId, overrides?): Promise<BigNumber>;
    getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<BigNumber>;
    getSubscriptionByID(token, subscriptionId, overrides?): Promise<BigNumber>;
    getSubscriptionId(subscriber, publisherId, overrides?): Promise<BigNumber>;
    listSubscriptions(token, subscriber, overrides?): Promise<BigNumber>;
    revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<BigNumber>;
    updateIndex(token, indexId, indexValue, userData, overrides?): Promise<BigNumber>;
    updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<BigNumber>;
}

Type declaration

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • deleteSubscription:function
    • deleteSubscription(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>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • getSubscriptionByID:function
    • getSubscriptionByID(token, subscriptionId, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getSubscriptionId:function
    • getSubscriptionId(subscriber, publisherId, overrides?): Promise<BigNumber>

    • Parameters

      • subscriber: string
      • publisherId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

  • updateSubscriptionUnits:function
    • updateSubscriptionUnits(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: {
        approveSubscription(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<[BigNumber, BigNumber] & {
            actualAmount: BigNumber;
            newIndexValue: BigNumber;
        }>;
        createIndex(token, indexId, userData, overrides?): Promise<ContractTransaction>;
        deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<ContractTransaction>;
        distribute(token, indexId, amount, userData, overrides?): Promise<ContractTransaction>;
        getIndex(token, publisher, indexId, overrides?): Promise<[boolean, BigNumber, BigNumber, BigNumber] & {
            exist: boolean;
            indexValue: BigNumber;
            totalUnitsApproved: BigNumber;
            totalUnitsPending: BigNumber;
        }>;
        getPublisherId(publisher, indexId, overrides?): Promise<[string] & {
            publisherId: string;
        }>;
        getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<[boolean, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            exist: boolean;
            pendingDistribution: BigNumber;
            units: BigNumber;
        }>;
        getSubscriptionByID(token, subscriptionId, overrides?): Promise<[string, number, boolean, BigNumber, BigNumber] & {
            approved: boolean;
            indexId: number;
            pendingDistribution: BigNumber;
            publisher: string;
            units: BigNumber;
        }>;
        getSubscriptionId(subscriber, publisherId, overrides?): Promise<[string] & {
            subscriptionId: string;
        }>;
        listSubscriptions(token, subscriber, overrides?): Promise<[string[], number[], BigNumber[]] & {
            indexIds: number[];
            publishers: string[];
            unitsList: BigNumber[];
        }>;
        revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<ContractTransaction>;
        updateIndex(token, indexId, indexValue, userData, overrides?): Promise<ContractTransaction>;
        updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<ContractTransaction>;
    }

    Type declaration

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

      • Parameters

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

        Returns Promise<ContractTransaction>

    • calculateDistribution:function
      • calculateDistribution(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;
        }>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

    • deleteSubscription:function
      • deleteSubscription(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>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

    • getIndex:function
      • getIndex(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;
        }>

    • getPublisherId:function
      • getPublisherId(publisher, indexId, overrides?): Promise<[string] & {
            publisherId: string;
        }>

      • Parameters

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

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

    • getSubscription:function
      • getSubscription(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;
        }>

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

      • Parameters

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

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

    • getSubscriptionId:function
      • getSubscriptionId(subscriber, publisherId, overrides?): Promise<[string] & {
            subscriptionId: string;
        }>

      • Parameters

        • subscriber: string
        • publisherId: BytesLike
        • Optional overrides: CallOverrides

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

    • listSubscriptions:function
      • listSubscriptions(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[];
        }>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

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

      • Parameters

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

        Returns Promise<ContractTransaction>

    • updateSubscriptionUnits:function
      • updateSubscriptionUnits(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: IDAv1ForwarderInterface

    off

    off: OnEvent<IDAv1Forwarder>

    on

    on: OnEvent<IDAv1Forwarder>

    once

    once: OnEvent<IDAv1Forwarder>

    populateTransaction

    populateTransaction: {
        approveSubscription(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        calculateDistribution(token, publisher, indexId, amount, overrides?): Promise<PopulatedTransaction>;
        createIndex(token, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        deleteSubscription(token, publisher, indexId, subscriber, userData, overrides?): Promise<PopulatedTransaction>;
        distribute(token, indexId, amount, userData, overrides?): Promise<PopulatedTransaction>;
        getIndex(token, publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        getPublisherId(publisher, indexId, overrides?): Promise<PopulatedTransaction>;
        getSubscription(token, publisher, indexId, subscriber, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionByID(token, subscriptionId, overrides?): Promise<PopulatedTransaction>;
        getSubscriptionId(subscriber, publisherId, overrides?): Promise<PopulatedTransaction>;
        listSubscriptions(token, subscriber, overrides?): Promise<PopulatedTransaction>;
        revokeSubscription(token, publisher, indexId, userData, overrides?): Promise<PopulatedTransaction>;
        updateIndex(token, indexId, indexValue, userData, overrides?): Promise<PopulatedTransaction>;
        updateSubscriptionUnits(token, indexId, subscriber, units, userData, overrides?): Promise<PopulatedTransaction>;
    }

    Type declaration

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • deleteSubscription:function
      • deleteSubscription(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>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • getSubscriptionByID:function
      • getSubscriptionByID(token, subscriptionId, overrides?): Promise<PopulatedTransaction>

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • getSubscriptionId:function
      • getSubscriptionId(subscriber, publisherId, overrides?): Promise<PopulatedTransaction>

      • Parameters

        • subscriber: string
        • publisherId: BytesLike
        • Optional overrides: CallOverrides

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

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

      • Parameters

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

        Returns Promise<PopulatedTransaction>

    • updateSubscriptionUnits:function
      • updateSubscriptionUnits(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<IDAv1Forwarder>

    Methods

    approveSubscription

    • approveSubscription(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

    calculateDistribution

    • calculateDistribution(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;
      }>

    connect

    • connect(signerOrProvider): this

    • Parameters

      • signerOrProvider: string | Signer | Provider

      Returns this

    createIndex

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    deleteSubscription

    • deleteSubscription(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

    • deployed(): Promise<IDAv1Forwarder>

    • Returns Promise<IDAv1Forwarder>

    distribute

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    getIndex

    • getIndex(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;
      }>

    getPublisherId

    • getPublisherId(publisher, indexId, overrides?): Promise<string>

    • Parameters

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

      Returns Promise<string>

    getSubscription

    • getSubscription(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;
      }>

    getSubscriptionByID

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

    • Parameters

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

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

    getSubscriptionId

    • getSubscriptionId(subscriber, publisherId, overrides?): Promise<string>

    • Parameters

      • subscriber: string
      • publisherId: BytesLike
      • Optional overrides: CallOverrides

      Returns Promise<string>

    listSubscriptions

    • listSubscriptions(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

    revokeSubscription

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    updateIndex

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

    • Parameters

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

      Returns Promise<ContractTransaction>

    updateSubscriptionUnits

    • updateSubscriptionUnits(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