Interface IPendleFeeDistributorV2

interface IPendleFeeDistributorV2 {
    _deployedPromise: Promise<Contract>;
    _runningEvents: {
        [eventTag: string]: RunningEvent;
    };
    _wrappedEmits: {
        [eventTag: string]: ((...args) => void);
    };
    address: string;
    callStatic: {
        claimProtocol(receiver, pools, overrides?): Promise<[BN, BN[]] & {
            amountsOut: BN[];
            totalAmountOut: BN;
        }>;
        claimRetail(receiver, totalAccrued, proof, overrides?): Promise<BN>;
        getProtocolClaimables(user, pools, overrides?): Promise<BN[]>;
        getProtocolTotalAccrued(user, overrides?): Promise<BN>;
    };
    contractName: "IPFeeDistributorV2";
    deployTransaction: TransactionResponse;
    estimateGas: {
        claimProtocol(receiver, pools, overrides?): Promise<BN>;
        claimRetail(receiver, totalAccrued, proof, overrides?): Promise<BN>;
        getProtocolClaimables(user, pools, overrides?): Promise<BN>;
        getProtocolTotalAccrued(user, overrides?): Promise<BN>;
    };
    filters: {
        Claimed(user?, amountOut?): ClaimedEventFilter;
        Claimed(address,uint256)(user?, amountOut?): ClaimedEventFilter;
        SetMerkleRootAndFund(merkleRoot?, amountFunded?): SetMerkleRootAndFundEventFilter;
        SetMerkleRootAndFund(bytes32,uint256)(merkleRoot?, amountFunded?): SetMerkleRootAndFundEventFilter;
        UpdateProtocolClaimable(user?, sumTopUp?): UpdateProtocolClaimableEventFilter;
        UpdateProtocolClaimable(address,uint256)(user?, sumTopUp?): UpdateProtocolClaimableEventFilter;
    };
    functions: {
        claimProtocol(receiver, pools, overrides?): Promise<ContractTransaction>;
        claimRetail(receiver, totalAccrued, proof, overrides?): Promise<ContractTransaction>;
        getProtocolClaimables(user, pools, overrides?): Promise<[BN[]] & {
            claimables: BN[];
        }>;
        getProtocolTotalAccrued(user, overrides?): Promise<[BN]>;
    };
    interface: IPFeeDistributorV2Interface;
    off: OnEvent<IPendleFeeDistributorV2>;
    on: OnEvent<IPendleFeeDistributorV2>;
    once: OnEvent<IPendleFeeDistributorV2>;
    populateTransaction: {
        claimProtocol(receiver, pools, overrides?): Promise<PopulatedTransaction>;
        claimRetail(receiver, totalAccrued, proof, overrides?): Promise<PopulatedTransaction>;
        getProtocolClaimables(user, pools, overrides?): Promise<PopulatedTransaction>;
        getProtocolTotalAccrued(user, overrides?): Promise<PopulatedTransaction>;
    };
    provider: Provider;
    removeListener: OnEvent<IPendleFeeDistributorV2>;
    resolvedAddress: Promise<string>;
    signer: Signer;
    _checkRunningEvents(runningEvent): void;
    _deployed(blockTag?): Promise<Contract>;
    _wrapEvent(runningEvent, log, listener): Event;
    attach(addressOrName): this;
    claimProtocol(receiver, pools, overrides?): Promise<ContractTransaction>;
    claimRetail(receiver, totalAccrued, proof, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    deployed(): Promise<IPendleFeeDistributorV2>;
    emit(eventName, ...args): boolean;
    fallback(overrides?): Promise<TransactionResponse>;
    getProtocolClaimables(user, pools, overrides?): Promise<BN[]>;
    getProtocolTotalAccrued(user, overrides?): Promise<BN>;
    listenerCount(eventName?): number;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
}

Hierarchy

  • BaseContract
    • IPendleFeeDistributorV2

Properties

_deployedPromise _runningEvents _wrappedEmits address callStatic contractName deployTransaction estimateGas filters functions interface off on once populateTransaction provider removeListener resolvedAddress signer

Methods

_checkRunningEvents _deployed _wrapEvent attach claimProtocol claimRetail connect deployed emit fallback getProtocolClaimables getProtocolTotalAccrued listenerCount listeners queryFilter removeAllListeners

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {
    [eventTag: string]: RunningEvent;
}

Type declaration

  • [eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {
    [eventTag: string]: ((...args) => void);
}

Type declaration

  • [eventTag: string]: ((...args) => void)
      • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

Readonly address

address: string

callStatic

callStatic: {
    claimProtocol(receiver, pools, overrides?): Promise<[BN, BN[]] & {
        amountsOut: BN[];
        totalAmountOut: BN;
    }>;
    claimRetail(receiver, totalAccrued, proof, overrides?): Promise<BN>;
    getProtocolClaimables(user, pools, overrides?): Promise<BN[]>;
    getProtocolTotalAccrued(user, overrides?): Promise<BN>;
}

Type declaration

  • claimProtocol:function
    • claimProtocol(receiver, pools, overrides?): Promise<[BN, BN[]] & {
          amountsOut: BN[];
          totalAmountOut: BN;
      }>

    • Parameters

      • receiver: string
      • pools: string[]
      • Optional overrides: CallOverrides

      Returns Promise<[BN, BN[]] & {
          amountsOut: BN[];
          totalAmountOut: BN;
      }>

  • claimRetail:function
    • claimRetail(receiver, totalAccrued, proof, overrides?): Promise<BN>

    • Parameters

      Returns Promise<BN>

  • getProtocolClaimables:function
    • getProtocolClaimables(user, pools, overrides?): Promise<BN[]>

    • Parameters

      • user: string
      • pools: string[]
      • Optional overrides: CallOverrides

      Returns Promise<BN[]>

  • getProtocolTotalAccrued:function
    • getProtocolTotalAccrued(user, overrides?): Promise<BN>

    • Parameters

      • user: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

contractName

contractName: "IPFeeDistributorV2"

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: {
    claimProtocol(receiver, pools, overrides?): Promise<BN>;
    claimRetail(receiver, totalAccrued, proof, overrides?): Promise<BN>;
    getProtocolClaimables(user, pools, overrides?): Promise<BN>;
    getProtocolTotalAccrued(user, overrides?): Promise<BN>;
}

Type declaration

  • claimProtocol:function
    • claimProtocol(receiver, pools, overrides?): Promise<BN>

    • Parameters

      • receiver: string
      • pools: string[]
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • claimRetail:function
    • claimRetail(receiver, totalAccrued, proof, overrides?): Promise<BN>

    • Parameters

      • receiver: string
      • totalAccrued: BigNumberish
      • proof: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<BN>

  • getProtocolClaimables:function
    • getProtocolClaimables(user, pools, overrides?): Promise<BN>

    • Parameters

      • user: string
      • pools: string[]
      • Optional overrides: CallOverrides

      Returns Promise<BN>

  • getProtocolTotalAccrued:function
    • getProtocolTotalAccrued(user, overrides?): Promise<BN>

    • Parameters

      • user: string
      • Optional overrides: CallOverrides

      Returns Promise<BN>

filters

filters: {
    Claimed(user?, amountOut?): ClaimedEventFilter;
    Claimed(address,uint256)(user?, amountOut?): ClaimedEventFilter;
    SetMerkleRootAndFund(merkleRoot?, amountFunded?): SetMerkleRootAndFundEventFilter;
    SetMerkleRootAndFund(bytes32,uint256)(merkleRoot?, amountFunded?): SetMerkleRootAndFundEventFilter;
    UpdateProtocolClaimable(user?, sumTopUp?): UpdateProtocolClaimableEventFilter;
    UpdateProtocolClaimable(address,uint256)(user?, sumTopUp?): UpdateProtocolClaimableEventFilter;
}

Type declaration

  • Claimed:function
    • Claimed(user?, amountOut?): ClaimedEventFilter

    • Parameters

      • Optional user: null | string
      • Optional amountOut: null

      Returns ClaimedEventFilter

  • Claimed(address,uint256):function
    • Claimed(address,uint256)(user?, amountOut?): ClaimedEventFilter

    • Parameters

      • Optional user: null | string
      • Optional amountOut: null

      Returns ClaimedEventFilter

  • SetMerkleRootAndFund:function
    • SetMerkleRootAndFund(merkleRoot?, amountFunded?): SetMerkleRootAndFundEventFilter

    • Parameters

      • Optional merkleRoot: null | BytesLike
      • Optional amountFunded: null

      Returns SetMerkleRootAndFundEventFilter

  • SetMerkleRootAndFund(bytes32,uint256):function
    • SetMerkleRootAndFund(bytes32,uint256)(merkleRoot?, amountFunded?): SetMerkleRootAndFundEventFilter

    • Parameters

      • Optional merkleRoot: null | BytesLike
      • Optional amountFunded: null

      Returns SetMerkleRootAndFundEventFilter

  • UpdateProtocolClaimable:function
    • UpdateProtocolClaimable(user?, sumTopUp?): UpdateProtocolClaimableEventFilter

    • Parameters

      • Optional user: null | string
      • Optional sumTopUp: null

      Returns UpdateProtocolClaimableEventFilter

  • UpdateProtocolClaimable(address,uint256):function
    • UpdateProtocolClaimable(address,uint256)(user?, sumTopUp?): UpdateProtocolClaimableEventFilter

    • Parameters

      • Optional user: null | string
      • Optional sumTopUp: null

      Returns UpdateProtocolClaimableEventFilter

functions

functions: {
    claimProtocol(receiver, pools, overrides?): Promise<ContractTransaction>;
    claimRetail(receiver, totalAccrued, proof, overrides?): Promise<ContractTransaction>;
    getProtocolClaimables(user, pools, overrides?): Promise<[BN[]] & {
        claimables: BN[];
    }>;
    getProtocolTotalAccrued(user, overrides?): Promise<[BN]>;
}

Type declaration

  • claimProtocol:function
    • claimProtocol(receiver, pools, overrides?): Promise<ContractTransaction>

    • Parameters

      • receiver: string
      • pools: string[]
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • claimRetail:function
    • claimRetail(receiver, totalAccrued, proof, overrides?): Promise<ContractTransaction>

    • Parameters

      • receiver: string
      • totalAccrued: BigNumberish
      • proof: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<ContractTransaction>

  • getProtocolClaimables:function
    • getProtocolClaimables(user, pools, overrides?): Promise<[BN[]] & {
          claimables: BN[];
      }>

    • Parameters

      • user: string
      • pools: string[]
      • Optional overrides: CallOverrides

      Returns Promise<[BN[]] & {
          claimables: BN[];
      }>

  • getProtocolTotalAccrued:function
    • getProtocolTotalAccrued(user, overrides?): Promise<[BN]>

    • Parameters

      • user: string
      • Optional overrides: CallOverrides

      Returns Promise<[BN]>

interface

interface: IPFeeDistributorV2Interface

off

off: OnEvent<IPendleFeeDistributorV2>

on

on: OnEvent<IPendleFeeDistributorV2>

once

once: OnEvent<IPendleFeeDistributorV2>

populateTransaction

populateTransaction: {
    claimProtocol(receiver, pools, overrides?): Promise<PopulatedTransaction>;
    claimRetail(receiver, totalAccrued, proof, overrides?): Promise<PopulatedTransaction>;
    getProtocolClaimables(user, pools, overrides?): Promise<PopulatedTransaction>;
    getProtocolTotalAccrued(user, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

  • claimProtocol:function
    • claimProtocol(receiver, pools, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • receiver: string
      • pools: string[]
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • claimRetail:function
    • claimRetail(receiver, totalAccrued, proof, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • receiver: string
      • totalAccrued: BigNumberish
      • proof: BytesLike[]
      • Optional overrides: Overrides & {
            from?: string | Promise<string>;
        }

      Returns Promise<PopulatedTransaction>

  • getProtocolClaimables:function
    • getProtocolClaimables(user, pools, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • user: string
      • pools: string[]
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getProtocolTotalAccrued:function
    • getProtocolTotalAccrued(user, overrides?): Promise<PopulatedTransaction>

    • Parameters

      • user: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

removeListener

removeListener: OnEvent<IPendleFeeDistributorV2>

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

  • _checkRunningEvents(runningEvent): void

  • Parameters

    • runningEvent: RunningEvent

    Returns void

_deployed

  • _deployed(blockTag?): Promise<Contract>

  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

_wrapEvent

  • _wrapEvent(runningEvent, log, listener): Event

  • Parameters

    • runningEvent: RunningEvent
    • log: Log
    • listener: Listener

    Returns Event

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

claimProtocol

  • claimProtocol(receiver, pools, overrides?): Promise<ContractTransaction>

  • Parameters

    • receiver: string
    • pools: string[]
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

claimRetail

  • claimRetail(receiver, totalAccrued, proof, overrides?): Promise<ContractTransaction>

  • Parameters

    • receiver: string
    • totalAccrued: BigNumberish
    • proof: BytesLike[]
    • Optional overrides: Overrides & {
          from?: string | Promise<string>;
      }

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Provider | Signer

    Returns this

deployed

emit

  • emit(eventName, ...args): boolean

  • Parameters

    • eventName: string | EventFilter
    • Rest ...args: any[]

    Returns boolean

fallback

  • fallback(overrides?): Promise<TransactionResponse>

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

getProtocolClaimables

  • getProtocolClaimables(user, pools, overrides?): Promise<BN[]>

  • Parameters

    • user: string
    • pools: string[]
    • Optional overrides: CallOverrides

    Returns Promise<BN[]>

getProtocolTotalAccrued

  • getProtocolTotalAccrued(user, overrides?): Promise<BN>

  • Parameters

    • user: string
    • Optional overrides: CallOverrides

    Returns Promise<BN>

listenerCount

  • listenerCount(eventName?): number

  • Parameters

    • Optional eventName: string | EventFilter

    Returns number

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc