HandlerHelpers | @webb-tools/protocol-solidity

Hierarchy

BaseContract
- HandlerHelpers

Constructors

constructor

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

Inherited from BaseContract.constructor
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:105
Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Signer | Provider
Returns HandlerHelpers

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: { _bridgeAddress: any; _contractAddressToResourceID: any; _contractWhitelist: any; _resourceIDToContractAddress: any; executeProposal: any; migrateBridge: any; setResource: any }

Type declaration

_bridgeAddress:function
- _bridgeAddress(overrides?: CallOverrides): Promise<string>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:205
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
_contractAddressToResourceID:function
- _contractAddressToResourceID(arg0: string, overrides?: CallOverrides): Promise<string>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:207
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<string>
_contractWhitelist:function
- _contractWhitelist(arg0: string, overrides?: CallOverrides): Promise<boolean>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:212
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
_resourceIDToContractAddress:function
- _resourceIDToContractAddress(arg0: BytesLike, overrides?: CallOverrides): Promise<string>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:217
  Parameters
  - arg0: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<string>
executeProposal:function
- executeProposal(resourceID: BytesLike, data: BytesLike, overrides?: CallOverrides): Promise<void>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:222
  Parameters
  - resourceID: BytesLike
  - data: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<void>
migrateBridge:function
- migrateBridge(newBridge: string, overrides?: CallOverrides): Promise<void>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:228
  Parameters
  - newBridge: string
  - Optional overrides: CallOverrides
  Returns Promise<void>
setResource:function
- setResource(resourceID: BytesLike, contractAddress: string, overrides?: CallOverrides): Promise<void>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:230
  Parameters
  - resourceID: BytesLike
  - contractAddress: string
  - Optional overrides: CallOverrides
  Returns Promise<void>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { _bridgeAddress: any; _contractAddressToResourceID: any; _contractWhitelist: any; _resourceIDToContractAddress: any; executeProposal: any; migrateBridge: any; setResource: any }

Type declaration

_bridgeAddress:function
- _bridgeAddress(overrides?: CallOverrides): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:240
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
_contractAddressToResourceID:function
- _contractAddressToResourceID(arg0: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:242
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
_contractWhitelist:function
- _contractWhitelist(arg0: string, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:247
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
_resourceIDToContractAddress:function
- _resourceIDToContractAddress(arg0: BytesLike, overrides?: CallOverrides): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:252
  Parameters
  - arg0: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
executeProposal:function
- executeProposal(resourceID: BytesLike, data: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:257
  Parameters
  - resourceID: BytesLike
  - data: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
migrateBridge:function
- migrateBridge(newBridge: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:263
  Parameters
  - newBridge: string
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>
setResource:function
- setResource(resourceID: BytesLike, contractAddress: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<BigNumber>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:268
  Parameters
  - resourceID: BytesLike
  - contractAddress: string
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<BigNumber>

filters

filters: {}

Type declaration

functions

functions: { _bridgeAddress: any; _contractAddressToResourceID: any; _contractWhitelist: any; _resourceIDToContractAddress: any; executeProposal: any; migrateBridge: any; setResource: any }

Type declaration

_bridgeAddress:function
- _bridgeAddress(overrides?: CallOverrides): Promise<[string]>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:138
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
_contractAddressToResourceID:function
- _contractAddressToResourceID(arg0: string, overrides?: CallOverrides): Promise<[string]>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:140
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
_contractWhitelist:function
- _contractWhitelist(arg0: string, overrides?: CallOverrides): Promise<[boolean]>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:145
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<[boolean]>
_resourceIDToContractAddress:function
- _resourceIDToContractAddress(arg0: BytesLike, overrides?: CallOverrides): Promise<[string]>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:150
  Parameters
  - arg0: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<[string]>
executeProposal:function
- executeProposal(resourceID: BytesLike, data: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:155
  Parameters
  - resourceID: BytesLike
  - data: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
migrateBridge:function
- migrateBridge(newBridge: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:161
  Parameters
  - newBridge: string
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>
setResource:function
- setResource(resourceID: BytesLike, contractAddress: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:166
  Parameters
  - resourceID: BytesLike
  - contractAddress: string
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<ContractTransaction>

interface

interface: HandlerHelpersInterface

populateTransaction

populateTransaction: { _bridgeAddress: any; _contractAddressToResourceID: any; _contractWhitelist: any; _resourceIDToContractAddress: any; executeProposal: any; migrateBridge: any; setResource: any }

Type declaration

_bridgeAddress:function
- _bridgeAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:276
  Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
_contractAddressToResourceID:function
- _contractAddressToResourceID(arg0: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:278
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
_contractWhitelist:function
- _contractWhitelist(arg0: string, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:283
  Parameters
  - arg0: string
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
_resourceIDToContractAddress:function
- _resourceIDToContractAddress(arg0: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:288
  Parameters
  - arg0: BytesLike
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
executeProposal:function
- executeProposal(resourceID: BytesLike, data: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:293
  Parameters
  - resourceID: BytesLike
  - data: BytesLike
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
migrateBridge:function
- migrateBridge(newBridge: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:299
  Parameters
  - newBridge: string
  - Optional overrides: Overrides & { from?: string | Promise<string> }
  Returns Promise<PopulatedTransaction>
setResource:function
- setResource(resourceID: BytesLike, contractAddress: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<PopulatedTransaction>
- - Defined in packages/contracts/src/HandlerHelpers.d.ts:304
  Parameters
  - resourceID: BytesLike
  - contractAddress: 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

_bridgeAddress

_bridgeAddress(overrides?: CallOverrides): Promise<string>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:173
Parameters
- Optional overrides: CallOverrides
Returns Promise<string>

_checkRunningEvents

_checkRunningEvents(runningEvent: RunningEvent): void

Inherited from BaseContract._checkRunningEvents
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:119
Parameters
- runningEvent: RunningEvent
Returns void

_contractAddressToResourceID

_contractAddressToResourceID(arg0: string, overrides?: CallOverrides): Promise<string>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:175
Parameters
- arg0: string
- Optional overrides: CallOverrides
Returns Promise<string>

_contractWhitelist

_contractWhitelist(arg0: string, overrides?: CallOverrides): Promise<boolean>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:180
Parameters
- arg0: string
- Optional overrides: CallOverrides
Returns Promise<boolean>

_deployed

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

Inherited from BaseContract._deployed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:112
Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>

_resourceIDToContractAddress

_resourceIDToContractAddress(arg0: BytesLike, overrides?: CallOverrides): Promise<string>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:182
Parameters
- arg0: BytesLike
- Optional overrides: CallOverrides
Returns Promise<string>

_wrapEvent

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

Inherited from BaseContract._wrapEvent
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:120
Parameters
- runningEvent: RunningEvent
- log: Log
- listener: Listener
Returns Event

attach

attach(addressOrName: string): HandlerHelpers

Overrides BaseContract.attach
- Defined in packages/contracts/src/HandlerHelpers.d.ts:96
Parameters
- addressOrName: string
Returns HandlerHelpers

connect

connect(signerOrProvider: string | Signer | Provider): HandlerHelpers

Overrides BaseContract.connect
- Defined in packages/contracts/src/HandlerHelpers.d.ts:95
Parameters
- signerOrProvider: string | Signer | Provider
Returns HandlerHelpers

deployed

deployed(): Promise<HandlerHelpers>

Overrides BaseContract.deployed
- Defined in packages/contracts/src/HandlerHelpers.d.ts:97
Returns Promise<HandlerHelpers>

emit

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

Inherited from BaseContract.emit
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:125
Parameters
- eventName: string | EventFilter
- Rest ...args: any[]
Returns boolean

executeProposal

executeProposal(resourceID: BytesLike, data: BytesLike, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:187
Parameters
- resourceID: BytesLike
- data: BytesLike
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

fallback

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

Inherited from BaseContract.fallback
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:113
Parameters
- Optional overrides: TransactionRequest
Returns Promise<TransactionResponse>

listenerCount

listenerCount(eventName?: string | EventFilter): number

Inherited from BaseContract.listenerCount
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:126
Parameters
- Optional eventName: string | EventFilter
Returns number

listeners

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

Overrides BaseContract.listeners
- Defined in packages/contracts/src/HandlerHelpers.d.ts:99
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- Optional eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
Returns TypedListener<EventArgsArray, EventArgsObject>[]
Overrides BaseContract.listeners
- Defined in packages/contracts/src/HandlerHelpers.d.ts:122
Parameters
- Optional eventName: string
Returns Listener[]

migrateBridge

migrateBridge(newBridge: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:193
Parameters
- newBridge: string
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

off

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

Overrides BaseContract.off
- Defined in packages/contracts/src/HandlerHelpers.d.ts:102
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns HandlerHelpers
Overrides BaseContract.off
- Defined in packages/contracts/src/HandlerHelpers.d.ts:123
Parameters
- eventName: string
- listener: Listener
Returns HandlerHelpers

on

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

Overrides BaseContract.on
- Defined in packages/contracts/src/HandlerHelpers.d.ts:106
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns HandlerHelpers
Overrides BaseContract.on
- Defined in packages/contracts/src/HandlerHelpers.d.ts:124
Parameters
- eventName: string
- listener: Listener
Returns HandlerHelpers

once

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

Overrides BaseContract.once
- Defined in packages/contracts/src/HandlerHelpers.d.ts:110
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns HandlerHelpers
Overrides BaseContract.once
- Defined in packages/contracts/src/HandlerHelpers.d.ts:125
Parameters
- eventName: string
- listener: Listener
Returns HandlerHelpers

queryFilter

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

Overrides BaseContract.queryFilter
- Defined in packages/contracts/src/HandlerHelpers.d.ts:129
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>): HandlerHelpers
removeAllListeners(eventName?: string): HandlerHelpers

Overrides BaseContract.removeAllListeners
- Defined in packages/contracts/src/HandlerHelpers.d.ts:118
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
Returns HandlerHelpers
Overrides BaseContract.removeAllListeners
- Defined in packages/contracts/src/HandlerHelpers.d.ts:127
Parameters
- Optional eventName: string
Returns HandlerHelpers

removeListener

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

Overrides BaseContract.removeListener
- Defined in packages/contracts/src/HandlerHelpers.d.ts:114
Type parameters
- EventArgsArray: any[]
- EventArgsObject
Parameters
- eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
- listener: TypedListener<EventArgsArray, EventArgsObject>
Returns HandlerHelpers
Overrides BaseContract.removeListener
- Defined in packages/contracts/src/HandlerHelpers.d.ts:126
Parameters
- eventName: string
- listener: Listener
Returns HandlerHelpers

setResource

setResource(resourceID: BytesLike, contractAddress: string, overrides?: Overrides & { from?: string | Promise<string> }): Promise<ContractTransaction>

- Defined in packages/contracts/src/HandlerHelpers.d.ts:198
Parameters
- resourceID: BytesLike
- contractAddress: string
- Optional overrides: Overrides & { from?: string | Promise<string> }
Returns Promise<ContractTransaction>

Static getContractAddress

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

Inherited from BaseContract.getContractAddress
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:106
Parameters
- transaction: { from: string; nonce: BigNumberish }
  - from: string
  - nonce: BigNumberish
Returns string

Static getInterface

getInterface(contractInterface: ContractInterface): Interface

Inherited from BaseContract.getInterface
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:110
Parameters
- contractInterface: ContractInterface
Returns Interface

Static isIndexed

isIndexed(value: any): value is Indexed

Inherited from BaseContract.isIndexed
- Defined in node_modules/@ethersproject/contracts/lib/index.d.ts:116
Parameters
- value: any
Returns value is Indexed

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

addressOrName: string

contractInterface: ContractInterface

Optional signerOrProvider: Signer | Provider

Returns HandlerHelpers

Properties

_deployedPromise

_runningEvents

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

Type declaration

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

Parameters

Rest ...args: any[]

Returns void

Readonly address

callStatic

Type declaration

_bridgeAddress:function

Parameters

Optional overrides: CallOverrides

Returns Promise<string>

_contractAddressToResourceID:function

Parameters

arg0: string

Optional overrides: CallOverrides

Returns Promise<string>

_contractWhitelist:function

Parameters

arg0: string

Optional overrides: CallOverrides

Returns Promise<boolean>

_resourceIDToContractAddress:function

Parameters

arg0: BytesLike

Optional overrides: CallOverrides

Returns Promise<string>

executeProposal:function

Parameters

resourceID: BytesLike

data: BytesLike

Optional overrides: CallOverrides

Returns Promise<void>

migrateBridge:function

Parameters

newBridge: string

Optional overrides: CallOverrides

Returns Promise<void>

setResource:function

Parameters

resourceID: BytesLike

contractAddress: string

Optional overrides: CallOverrides

Returns Promise<void>

Readonly deployTransaction

estimateGas

Type declaration

_bridgeAddress:function

Parameters

Optional overrides: CallOverrides

Returns Promise<BigNumber>

_contractAddressToResourceID:function

Parameters

arg0: string

Optional overrides: CallOverrides

Returns Promise<BigNumber>

_contractWhitelist:function

Parameters

arg0: string

Optional overrides: CallOverrides

Returns Promise<BigNumber>

_resourceIDToContractAddress:function