Interface ITOGAv2

interface ITOGAv2 {
    callStatic: {
        changeExitRate(token, newExitRate, overrides?): Promise<void>;
        getCurrentPIC(token, overrides?): Promise<string>;
        getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
            bond: BigNumber;
            exitRate: BigNumber;
            pic: string;
        }>;
        getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
        getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
        withdrawFundsInCustody(token, overrides?): Promise<void>;
    };
    estimateGas: {
        changeExitRate(token, newExitRate, overrides?): Promise<BigNumber>;
        getCurrentPIC(token, overrides?): Promise<BigNumber>;
        getCurrentPICInfo(token, overrides?): Promise<BigNumber>;
        getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
        getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
        withdrawFundsInCustody(token, overrides?): Promise<BigNumber>;
    };
    filters: {
        BondIncreased(token?, additionalBond?): BondIncreasedEventFilter;
        BondIncreased(address,uint256)(token?, additionalBond?): BondIncreasedEventFilter;
        ExitRateChanged(token?, exitRate?): ExitRateChangedEventFilter;
        ExitRateChanged(address,int96)(token?, exitRate?): ExitRateChangedEventFilter;
        NewPIC(token?, pic?, bond?, exitRate?): NewPICEventFilter;
        NewPIC(address,address,uint256,int96)(token?, pic?, bond?, exitRate?): NewPICEventFilter;
    };
    functions: {
        changeExitRate(token, newExitRate, overrides?): Promise<ContractTransaction>;
        getCurrentPIC(token, overrides?): Promise<[string] & {
            pic: string;
        }>;
        getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
            bond: BigNumber;
            exitRate: BigNumber;
            pic: string;
        }>;
        getDefaultExitRateFor(token, bondAmount, overrides?): Promise<[BigNumber] & {
            exitRate: BigNumber;
        }>;
        getMaxExitRateFor(token, bondAmount, overrides?): Promise<[BigNumber] & {
            exitRate: BigNumber;
        }>;
        withdrawFundsInCustody(token, overrides?): Promise<ContractTransaction>;
    };
    interface: ITOGAv2Interface;
    off: OnEvent<ITOGAv2>;
    on: OnEvent<ITOGAv2>;
    once: OnEvent<ITOGAv2>;
    populateTransaction: {
        changeExitRate(token, newExitRate, overrides?): Promise<PopulatedTransaction>;
        getCurrentPIC(token, overrides?): Promise<PopulatedTransaction>;
        getCurrentPICInfo(token, overrides?): Promise<PopulatedTransaction>;
        getDefaultExitRateFor(token, bondAmount, overrides?): Promise<PopulatedTransaction>;
        getMaxExitRateFor(token, bondAmount, overrides?): Promise<PopulatedTransaction>;
        withdrawFundsInCustody(token, overrides?): Promise<PopulatedTransaction>;
    };
    removeListener: OnEvent<ITOGAv2>;
    attach(addressOrName): this;
    changeExitRate(token, newExitRate, overrides?): Promise<ContractTransaction>;
    connect(signerOrProvider): this;
    deployed(): Promise<ITOGAv2>;
    getCurrentPIC(token, overrides?): Promise<string>;
    getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
        bond: BigNumber;
        exitRate: BigNumber;
        pic: string;
    }>;
    getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
    getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
    listeners<TEvent>(eventFilter?): TypedListener<TEvent>[];
    listeners(eventName?): Listener[];
    queryFilter<TEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TEvent[]>;
    removeAllListeners<TEvent>(eventFilter): this;
    removeAllListeners(eventName?): this;
    withdrawFundsInCustody(token, overrides?): Promise<ContractTransaction>;
}

Hierarchy

  • BaseContract
    • ITOGAv2

Properties

callStatic estimateGas filters functions interface off on once populateTransaction removeListener

Methods

attach changeExitRate connect deployed getCurrentPIC getCurrentPICInfo getDefaultExitRateFor getMaxExitRateFor listeners queryFilter removeAllListeners withdrawFundsInCustody

Properties

callStatic

callStatic: {
    changeExitRate(token, newExitRate, overrides?): Promise<void>;
    getCurrentPIC(token, overrides?): Promise<string>;
    getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
        bond: BigNumber;
        exitRate: BigNumber;
        pic: string;
    }>;
    getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
    getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
    withdrawFundsInCustody(token, overrides?): Promise<void>;
}

Type declaration

  • changeExitRate:function
    • changeExitRate(token, newExitRate, overrides?): Promise<void>

    • Parameters

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

      Returns Promise<void>

  • getCurrentPIC:function
    • getCurrentPIC(token, overrides?): Promise<string>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<string>

  • getCurrentPICInfo:function
    • getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
          bond: BigNumber;
          exitRate: BigNumber;
          pic: string;
      }>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, BigNumber, BigNumber] & {
          bond: BigNumber;
          exitRate: BigNumber;
          pic: string;
      }>

  • getDefaultExitRateFor:function
    • getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getMaxExitRateFor:function
    • getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

estimateGas

estimateGas: {
    changeExitRate(token, newExitRate, overrides?): Promise<BigNumber>;
    getCurrentPIC(token, overrides?): Promise<BigNumber>;
    getCurrentPICInfo(token, overrides?): Promise<BigNumber>;
    getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
    getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>;
    withdrawFundsInCustody(token, overrides?): Promise<BigNumber>;
}

Type declaration

  • changeExitRate:function
    • changeExitRate(token, newExitRate, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

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

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • getDefaultExitRateFor:function
    • getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

  • getMaxExitRateFor:function
    • getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>

    • Parameters

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

      Returns Promise<BigNumber>

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

    • Parameters

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

      Returns Promise<BigNumber>

filters

filters: {
    BondIncreased(token?, additionalBond?): BondIncreasedEventFilter;
    BondIncreased(address,uint256)(token?, additionalBond?): BondIncreasedEventFilter;
    ExitRateChanged(token?, exitRate?): ExitRateChangedEventFilter;
    ExitRateChanged(address,int96)(token?, exitRate?): ExitRateChangedEventFilter;
    NewPIC(token?, pic?, bond?, exitRate?): NewPICEventFilter;
    NewPIC(address,address,uint256,int96)(token?, pic?, bond?, exitRate?): NewPICEventFilter;
}

Type declaration

  • BondIncreased:function
    • BondIncreased(token?, additionalBond?): BondIncreasedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional additionalBond: null

      Returns BondIncreasedEventFilter

  • BondIncreased(address,uint256):function
    • BondIncreased(address,uint256)(token?, additionalBond?): BondIncreasedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional additionalBond: null

      Returns BondIncreasedEventFilter

  • ExitRateChanged:function
    • ExitRateChanged(token?, exitRate?): ExitRateChangedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional exitRate: null

      Returns ExitRateChangedEventFilter

  • ExitRateChanged(address,int96):function
    • ExitRateChanged(address,int96)(token?, exitRate?): ExitRateChangedEventFilter

    • Parameters

      • Optional token: null | string
      • Optional exitRate: null

      Returns ExitRateChangedEventFilter

  • NewPIC:function
    • NewPIC(token?, pic?, bond?, exitRate?): NewPICEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pic: null
      • Optional bond: null
      • Optional exitRate: null

      Returns NewPICEventFilter

  • NewPIC(address,address,uint256,int96):function
    • NewPIC(address,address,uint256,int96)(token?, pic?, bond?, exitRate?): NewPICEventFilter

    • Parameters

      • Optional token: null | string
      • Optional pic: null
      • Optional bond: null
      • Optional exitRate: null

      Returns NewPICEventFilter

functions

functions: {
    changeExitRate(token, newExitRate, overrides?): Promise<ContractTransaction>;
    getCurrentPIC(token, overrides?): Promise<[string] & {
        pic: string;
    }>;
    getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
        bond: BigNumber;
        exitRate: BigNumber;
        pic: string;
    }>;
    getDefaultExitRateFor(token, bondAmount, overrides?): Promise<[BigNumber] & {
        exitRate: BigNumber;
    }>;
    getMaxExitRateFor(token, bondAmount, overrides?): Promise<[BigNumber] & {
        exitRate: BigNumber;
    }>;
    withdrawFundsInCustody(token, overrides?): Promise<ContractTransaction>;
}

Type declaration

  • changeExitRate:function
    • changeExitRate(token, newExitRate, overrides?): Promise<ContractTransaction>

    • Parameters

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

      Returns Promise<ContractTransaction>

  • getCurrentPIC:function
    • getCurrentPIC(token, overrides?): Promise<[string] & {
          pic: string;
      }>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

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

  • getCurrentPICInfo:function
    • getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
          bond: BigNumber;
          exitRate: BigNumber;
          pic: string;
      }>

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<[string, BigNumber, BigNumber] & {
          bond: BigNumber;
          exitRate: BigNumber;
          pic: string;
      }>

  • getDefaultExitRateFor:function
    • getDefaultExitRateFor(token, bondAmount, overrides?): Promise<[BigNumber] & {
          exitRate: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          exitRate: BigNumber;
      }>

  • getMaxExitRateFor:function
    • getMaxExitRateFor(token, bondAmount, overrides?): Promise<[BigNumber] & {
          exitRate: BigNumber;
      }>

    • Parameters

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

      Returns Promise<[BigNumber] & {
          exitRate: BigNumber;
      }>

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

    • Parameters

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

      Returns Promise<ContractTransaction>

interface

interface: ITOGAv2Interface

off

off: OnEvent<ITOGAv2>

on

on: OnEvent<ITOGAv2>

once

once: OnEvent<ITOGAv2>

populateTransaction

populateTransaction: {
    changeExitRate(token, newExitRate, overrides?): Promise<PopulatedTransaction>;
    getCurrentPIC(token, overrides?): Promise<PopulatedTransaction>;
    getCurrentPICInfo(token, overrides?): Promise<PopulatedTransaction>;
    getDefaultExitRateFor(token, bondAmount, overrides?): Promise<PopulatedTransaction>;
    getMaxExitRateFor(token, bondAmount, overrides?): Promise<PopulatedTransaction>;
    withdrawFundsInCustody(token, overrides?): Promise<PopulatedTransaction>;
}

Type declaration

  • changeExitRate:function
    • changeExitRate(token, newExitRate, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

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

    • Parameters

      • token: string
      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • getDefaultExitRateFor:function
    • getDefaultExitRateFor(token, bondAmount, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

  • getMaxExitRateFor:function
    • getMaxExitRateFor(token, bondAmount, overrides?): Promise<PopulatedTransaction>

    • Parameters

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

      Returns Promise<PopulatedTransaction>

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

    • Parameters

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

      Returns Promise<PopulatedTransaction>

removeListener

removeListener: OnEvent<ITOGAv2>

Methods

attach

  • attach(addressOrName): this

  • Parameters

    • addressOrName: string

    Returns this

changeExitRate

  • changeExitRate(token, newExitRate, overrides?): Promise<ContractTransaction>

  • Parameters

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

    Returns Promise<ContractTransaction>

connect

  • connect(signerOrProvider): this

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns this

deployed

  • deployed(): Promise<ITOGAv2>

  • Returns Promise<ITOGAv2>

getCurrentPIC

  • getCurrentPIC(token, overrides?): Promise<string>

  • Parameters

    • token: string
    • Optional overrides: CallOverrides

    Returns Promise<string>

getCurrentPICInfo

  • getCurrentPICInfo(token, overrides?): Promise<[string, BigNumber, BigNumber] & {
        bond: BigNumber;
        exitRate: BigNumber;
        pic: string;
    }>

  • Parameters

    • token: string
    • Optional overrides: CallOverrides

    Returns Promise<[string, BigNumber, BigNumber] & {
        bond: BigNumber;
        exitRate: BigNumber;
        pic: string;
    }>

getDefaultExitRateFor

  • getDefaultExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>

  • Parameters

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

    Returns Promise<BigNumber>

getMaxExitRateFor

  • getMaxExitRateFor(token, bondAmount, overrides?): Promise<BigNumber>

  • Parameters

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

    Returns Promise<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

withdrawFundsInCustody

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

  • Parameters

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

    Returns Promise<ContractTransaction>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc