Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ownable

Hierarchy

  • BaseContract
    • Ownable

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Ownable(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): Ownable

  • Parameters

    • addressOrName: string
    • contractInterface: ContractInterface
    • Optional signerOrProvider: Signer | Provider

    Returns Ownable

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

  • [eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

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

      • Parameters

        • Rest ...args: any[]

        Returns void

Readonly address

address: string

callStatic

callStatic: { owner: any; renounceOwnership: any; transferOwnership: any }

Type declaration

  • owner: function
    • owner(overrides?: CallOverrides): Promise<string>

    • Returns the address of the current owner.

      Parameters

      • Optional overrides: CallOverrides

      Returns Promise<string>

  • renounceOwnership: function
    • renounceOwnership(overrides?: CallOverrides): Promise<void>

    • Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

      Parameters

      • Optional overrides: CallOverrides

      Returns Promise<void>

  • transferOwnership: function
    • transferOwnership(newOwner: string, overrides?: CallOverrides): Promise<void>

    • Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

      Parameters

      • newOwner: string
      • Optional overrides: CallOverrides

      Returns Promise<void>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { owner: any; renounceOwnership: any; transferOwnership: any }

Type declaration

  • owner: function
    • owner(overrides?: CallOverrides): Promise<BigNumber>

    • Returns the address of the current owner.

      Parameters

      • Optional overrides: CallOverrides

      Returns Promise<BigNumber>

  • renounceOwnership: function
    • renounceOwnership(overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

      Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

  • transferOwnership: function
    • transferOwnership(newOwner: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>

    • Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

      Parameters

      • newOwner: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<BigNumber>

filters

filters: { OwnershipTransferred: any }

Type declaration

  • OwnershipTransferred: function
    • OwnershipTransferred(previousOwner?: null | string, newOwner?: null | string): TypedEventFilter<[string, string], { newOwner: string; previousOwner: string }>

    • Parameters

      • Optional previousOwner: null | string
      • Optional newOwner: null | string

      Returns TypedEventFilter<[string, string], { newOwner: string; previousOwner: string }>

functions

functions: { owner: any; renounceOwnership: any; transferOwnership: any }

Type declaration

  • owner: function
    • owner(overrides?: CallOverrides): Promise<[string]>

    • Returns the address of the current owner.

      Parameters

      • Optional overrides: CallOverrides

      Returns Promise<[string]>

  • renounceOwnership: function
    • renounceOwnership(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

      Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

  • transferOwnership: function
    • transferOwnership(newOwner: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

    • Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

      Parameters

      • newOwner: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<ContractTransaction>

interface

interface: OwnableInterface

populateTransaction

populateTransaction: { owner: any; renounceOwnership: any; transferOwnership: any }

Type declaration

  • owner: function
    • owner(overrides?: CallOverrides): Promise<PopulatedTransaction>

    • Returns the address of the current owner.

      Parameters

      • Optional overrides: CallOverrides

      Returns Promise<PopulatedTransaction>

  • renounceOwnership: function
    • renounceOwnership(overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

      Parameters

      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

  • transferOwnership: function
    • transferOwnership(newOwner: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>

    • Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

      Parameters

      • newOwner: string
      • Optional overrides: Overrides & { from?: string | Promise<string> }

      Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

  • _checkRunningEvents(runningEvent: RunningEvent): void

  • Parameters

    • runningEvent: RunningEvent

    Returns void

_deployed

  • _deployed(blockTag?: BlockTag): Promise<Contract>

  • Parameters

    • Optional blockTag: BlockTag

    Returns Promise<Contract>

_wrapEvent

  • _wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

  • Parameters

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

    Returns Event

attach

  • attach(addressOrName: string): Ownable

  • Parameters

    • addressOrName: string

    Returns Ownable

connect

  • connect(signerOrProvider: string | Signer | Provider): Ownable

  • Parameters

    • signerOrProvider: string | Signer | Provider

    Returns Ownable

deployed

  • Returns Promise<Ownable>

emit

  • emit(eventName: string | EventFilter, ...args: any[]): boolean

  • Parameters

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

    Returns boolean

fallback

  • fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

  • Parameters

    • Optional overrides: TransactionRequest

    Returns Promise<TransactionResponse>

listenerCount

  • listenerCount(eventName?: string | EventFilter): number

  • Parameters

    • Optional eventName: string | EventFilter

    Returns number

listeners

  • listeners<EventArgsArray, EventArgsObject>(eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>): TypedListener<EventArgsArray, EventArgsObject>[]
  • listeners(eventName?: string): Listener[]

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • Optional eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>

    Returns TypedListener<EventArgsArray, EventArgsObject>[]

  • Parameters

    • Optional eventName: string

    Returns Listener[]

off

  • off<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Ownable
  • off(eventName: string, listener: Listener): Ownable

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns Ownable

  • Parameters

    • eventName: string
    • listener: Listener

    Returns Ownable

on

  • on<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Ownable
  • on(eventName: string, listener: Listener): Ownable

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns Ownable

  • Parameters

    • eventName: string
    • listener: Listener

    Returns Ownable

once

  • once<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Ownable
  • once(eventName: string, listener: Listener): Ownable

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns Ownable

  • Parameters

    • eventName: string
    • listener: Listener

    Returns Ownable

owner

  • owner(overrides?: CallOverrides): Promise<string>

  • Returns the address of the current owner.

    Parameters

    • Optional overrides: CallOverrides

    Returns Promise<string>

queryFilter

  • queryFilter<EventArgsArray, EventArgsObject>(event: TypedEventFilter<EventArgsArray, EventArgsObject>, fromBlockOrBlockhash?: string | number, toBlock?: string | number): Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • event: TypedEventFilter<EventArgsArray, EventArgsObject>
    • Optional fromBlockOrBlockhash: string | number
    • Optional toBlock: string | number

    Returns Promise<TypedEvent<EventArgsArray & EventArgsObject>[]>

removeAllListeners

  • removeAllListeners<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>): Ownable
  • removeAllListeners(eventName?: string): Ownable

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>

    Returns Ownable

  • Parameters

    • Optional eventName: string

    Returns Ownable

removeListener

  • removeListener<EventArgsArray, EventArgsObject>(eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>, listener: TypedListener<EventArgsArray, EventArgsObject>): Ownable
  • removeListener(eventName: string, listener: Listener): Ownable

  • Type parameters

    • EventArgsArray: any[]

    • EventArgsObject

    Parameters

    • eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
    • listener: TypedListener<EventArgsArray, EventArgsObject>

    Returns Ownable

  • Parameters

    • eventName: string
    • listener: Listener

    Returns Ownable

renounceOwnership

  • renounceOwnership(overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

    Parameters

    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

transferOwnership

  • transferOwnership(newOwner: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

  • Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

    Parameters

    • newOwner: string
    • Optional overrides: Overrides & { from?: string | Promise<string> }

    Returns Promise<ContractTransaction>

Static getContractAddress

  • getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

  • Parameters

    • transaction: { from: string; nonce: BigNumberish }
      • from: string
      • nonce: BigNumberish

    Returns string

Static getInterface

  • getInterface(contractInterface: ContractInterface): Interface

  • Parameters

    • contractInterface: ContractInterface

    Returns Interface

Static isIndexed

  • isIndexed(value: any): value is Indexed

  • Parameters

    • value: any

    Returns value is Indexed

Generated using TypeDoc