Interface OrderbookStream

Hierarchy

BaseContract
- OrderbookStream

Properties

`Readonly` [internal]

[internal]: any

add

add: TypedContractMethod<[quote: QuoteStruct[]], [void], "nonpayable">

`Readonly` fallback

fallback: null | WrappedFallback

filters

filters: {
PublishQuote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
PublishQuote(tuple,address,address,uint256,uint256,bool,uint256,uint256,tuple,tuple): TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
}

Type declaration

PublishQuote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>
PublishQuote(tuple,address,address,uint256,uint256,bool,uint256,uint256,tuple,tuple): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

interface

interface: OrderbookStreamInterface

`Readonly` runner

runner: null | ContractRunner

`Readonly` target

target: string | Addressable

Methods

addListener

addListener(event, listener): Promise<OrderbookStream>
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<OrderbookStream>
Inherited from BaseContract.addListener
- Defined in node_modules/ethers/types/contract/contract.d.ts:42

attach

attach(addressOrName): OrderbookStream
Parameters
- addressOrName: AddressLike
Returns OrderbookStream
- Defined in src/typechain/OrderbookStream.ts:155

connect

connect(runner?): BaseContract
Parameters
- Optional runner: null | ContractRunner
Returns BaseContract
Overrides BaseContract.connect
- Defined in src/typechain/OrderbookStream.ts:154

deployed

deployed(): Promise<OrderbookStream>
Returns Promise<OrderbookStream>
- Defined in src/typechain/OrderbookStream.ts:156

deploymentTransaction

deploymentTransaction(): null | ContractTransactionResponse
Returns null | ContractTransactionResponse
Inherited from BaseContract.deploymentTransaction
- Defined in node_modules/ethers/types/contract/contract.d.ts:30

emit

emit(event, ...args): Promise<boolean>
Parameters
- event: ContractEventName
- Rest ...args: any[]
Returns Promise<boolean>
Inherited from BaseContract.emit
- Defined in node_modules/ethers/types/contract/contract.d.ts:37

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Inherited from BaseContract.getAddress
- Defined in node_modules/ethers/types/contract/contract.d.ts:27

getDeployedCode

getDeployedCode(): Promise<null | string>
Returns Promise<null | string>
Inherited from BaseContract.getDeployedCode
- Defined in node_modules/ethers/types/contract/contract.d.ts:28

getEvent

getEvent(key): TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Parameters
- key: "PublishQuote"
Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>
Overrides BaseContract.getEvent
- Defined in src/typechain/OrderbookStream.ts:215

getFunction

getFunction<T>(key): T
Type Parameters
- T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>
Parameters
- key: string | FunctionFragment
Returns T
Overrides BaseContract.getFunction
- Defined in src/typechain/OrderbookStream.ts:203
getFunction(nameOrSignature): TypedContractMethod<[quote: QuoteStruct[]], [void], "nonpayable">
Parameters
- nameOrSignature: "add"
Returns TypedContractMethod<[quote: QuoteStruct[]], [void], "nonpayable">
Overrides BaseContract.getFunction
- Defined in src/typechain/OrderbookStream.ts:207

listenerCount

listenerCount(event?): Promise<number>
Parameters
- Optional event: ContractEventName
Returns Promise<number>
Inherited from BaseContract.listenerCount
- Defined in node_modules/ethers/types/contract/contract.d.ts:38

listeners

listeners<TCEvent>(event): Promise<TypedListener<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
Returns Promise<TypedListener<TCEvent>[]>
Overrides BaseContract.listeners
- Defined in src/typechain/OrderbookStream.ts:189
listeners(eventName?): Promise<Listener[]>
Parameters
- Optional eventName: string
Returns Promise<Listener[]>
Overrides BaseContract.listeners
- Defined in src/typechain/OrderbookStream.ts:192

off

off(event, listener?): Promise<OrderbookStream>
Parameters
- event: ContractEventName
- Optional listener: Listener
Returns Promise<OrderbookStream>
Inherited from BaseContract.off
- Defined in node_modules/ethers/types/contract/contract.d.ts:40

on

on<TCEvent>(event, listener): Promise<OrderbookStream>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<OrderbookStream>
Overrides BaseContract.on
- Defined in src/typechain/OrderbookStream.ts:171
on<TCEvent>(filter, listener): Promise<OrderbookStream>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<OrderbookStream>
Overrides BaseContract.on
- Defined in src/typechain/OrderbookStream.ts:175

once

once<TCEvent>(event, listener): Promise<OrderbookStream>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- listener: TypedListener<TCEvent>
Returns Promise<OrderbookStream>
Overrides BaseContract.once
- Defined in src/typechain/OrderbookStream.ts:180
once<TCEvent>(filter, listener): Promise<OrderbookStream>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- listener: TypedListener<TCEvent>
Returns Promise<OrderbookStream>
Overrides BaseContract.once
- Defined in src/typechain/OrderbookStream.ts:184

queryFilter

queryFilter<TCEvent>(event, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- event: TCEvent
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TypedEventLog<TCEvent>[]>
Overrides BaseContract.queryFilter
- Defined in src/typechain/OrderbookStream.ts:160
queryFilter<TCEvent>(filter, fromBlockOrBlockhash?, toBlock?): Promise<TypedEventLog<TCEvent>[]>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- filter: TypedDeferredTopicFilter<TCEvent>
- Optional fromBlockOrBlockhash: string | number
- Optional toBlock: string | number
Returns Promise<TypedEventLog<TCEvent>[]>
Overrides BaseContract.queryFilter
- Defined in src/typechain/OrderbookStream.ts:165

queryTransaction

queryTransaction(hash): Promise<EventLog[]>
Parameters
- hash: string
Returns Promise<EventLog[]>
Inherited from BaseContract.queryTransaction
- Defined in node_modules/ethers/types/contract/contract.d.ts:33

removeAllListeners

removeAllListeners<TCEvent>(event?): Promise<OrderbookStream>
Type Parameters
- TCEvent extends TypedContractEvent<any, any, any, TCEvent>
Parameters
- Optional event: TCEvent
Returns Promise<OrderbookStream>
Overrides BaseContract.removeAllListeners
- Defined in src/typechain/OrderbookStream.ts:193

removeListener

removeListener(event, listener): Promise<OrderbookStream>
Parameters
- event: ContractEventName
- listener: Listener
Returns Promise<OrderbookStream>
Inherited from BaseContract.removeListener
- Defined in node_modules/ethers/types/contract/contract.d.ts:43

waitForDeployment

waitForDeployment(): Promise<OrderbookStream>
Returns Promise<OrderbookStream>
Inherited from BaseContract.waitForDeployment
- Defined in node_modules/ethers/types/contract/contract.d.ts:29

Interface OrderbookStream

Hierarchy

Index

Properties

Methods

Properties

Readonly [internal]

add

Readonly fallback

filters

Type declaration

PublishQuote: TypedContractEvent<InputTuple, OutputTuple, OutputObject>

PublishQuote(tuple,address,address,uint256,uint256,bool,uint256,uint256,tuple,tuple): TypedContractEvent<InputTuple, OutputTuple, OutputObject>

interface

Readonly runner

Readonly target

Methods

addListener

Parameters

event: ContractEventName

listener: Listener

Returns Promise<OrderbookStream>

attach

Parameters

addressOrName: AddressLike

Returns OrderbookStream

connect

Parameters

Optional runner: null | ContractRunner

Returns BaseContract

deployed

Returns Promise<OrderbookStream>

deploymentTransaction

Returns null | ContractTransactionResponse

emit

Parameters

event: ContractEventName

Rest ...args: any[]

Returns Promise<boolean>

getAddress

Returns Promise<string>

getDeployedCode

Returns Promise<null | string>

getEvent

Parameters

key: "PublishQuote"

Returns TypedContractEvent<InputTuple, OutputTuple, OutputObject>

getFunction

Type Parameters

T extends ContractMethod<any[], any, any, T> = ContractMethod<any[], any, any>

Parameters

key: string | FunctionFragment

Returns T

Parameters

nameOrSignature: "add"

Returns TypedContractMethod<[quote: QuoteStruct[]], [void], "nonpayable">

listenerCount

Parameters

Optional event: ContractEventName

Returns Promise<number>

listeners

Type Parameters

TCEvent extends TypedContractEvent<any, any, any, TCEvent>

Parameters

event: TCEvent

Returns Promise<TypedListener<TCEvent>[]>

Parameters

Optional eventName: string

Returns Promise<Listener[]>

off

Parameters

event: ContractEventName

Optional listener: Listener

Returns Promise<OrderbookStream>

on

Type Parameters

TCEvent extends TypedContractEvent<any, any, any, TCEvent>

Parameters

event: TCEvent

listener: TypedListener<TCEvent>

`Readonly` [internal]

`Readonly` fallback

`Readonly` runner

`Readonly` target

`Optional` runner: null | ContractRunner

`Rest` ...args: any[]

`Optional` event: ContractEventName

`Optional` eventName: string

`Optional` listener: Listener

`Optional` fromBlockOrBlockhash: string | number

`Optional` toBlock: string | number

`Optional` fromBlockOrBlockhash: string | number

`Optional` toBlock: string | number

`Optional` event: TCEvent