events.ContractEvent
@nevermined-io/nevermined-sdk-js / events / ContractEvent
Class: ContractEvent
events.ContractEvent
Hierarchy
↳
ContractEvent
Table of contents
Constructors
Properties
Accessors
Methods
- addresses
- checkExists
- eventExists
- filterToArgs
- findSigner
- getBlockNumber
- getEventData
- getPastEvents
- once
- setInstanceConfig
- subscribe
- addressesStatic
- findSignerStatic
- getInstance
- setInstanceConfig
Constructors
constructor
• Protected
new ContractEvent(contract
, eventEmitter
)
Parameters
Name | Type |
---|---|
contract | ContractBase |
eventEmitter | EventEmitter |
Inherited from
Defined in
src/events/NeverminedEvent.ts:35
Properties
contract
• Protected
contract: ContractBase
= null
Inherited from
Defined in
src/events/NeverminedEvent.ts:30
eventEmitter
• Protected
eventEmitter: EventEmitter
Inherited from
Defined in
src/events/NeverminedEvent.ts:29
Accessors
artifactsFolder
• Protected
get
artifactsFolder(): string
Returns
string
Inherited from
NeverminedEvent.artifactsFolder
Defined in
src/Instantiable.abstract.ts:96
config
• Protected
get
config(): Config
Returns
Inherited from
NeverminedEvent.config
Defined in
src/Instantiable.abstract.ts:80
instanceConfig
• Protected
get
instanceConfig(): InstantiableConfig
Returns
InstantiableConfig
Inherited from
NeverminedEvent.instanceConfig
Defined in
src/Instantiable.abstract.ts:100
instantiableConfig
• Protected
get
instantiableConfig(): InstantiableConfig
Returns
InstantiableConfig
Inherited from
NeverminedEvent.instantiableConfig
Defined in
src/Instantiable.abstract.ts:73
logger
• Protected
get
logger(): Logger
Returns
Inherited from
NeverminedEvent.logger
Defined in
src/Instantiable.abstract.ts:87
nevermined
• Protected
get
nevermined(): Nevermined
Returns
Inherited from
NeverminedEvent.nevermined
Defined in
src/Instantiable.abstract.ts:33
web3
• Protected
get
web3(): JsonRpcProvider
Returns
JsonRpcProvider
Inherited from
NeverminedEvent.web3
Defined in
src/Instantiable.abstract.ts:63
Methods
addresses
▸ addresses(): Promise
<string
[]>
Returns
Promise
<string
[]>
Inherited from
Defined in
src/Instantiable.abstract.ts:129
checkExists
▸ Protected
checkExists(address
): Promise
<boolean
>
Returns true of contract exists else it throws.
Parameters
Name | Type |
---|---|
address | string |
Returns
Promise
<boolean
>
true if the contract exists.
Inherited from
Defined in
src/Instantiable.abstract.ts:44
eventExists
▸ Private
eventExists(eventName
): boolean
Parameters
Name | Type |
---|---|
eventName | string |
Returns
boolean
Defined in
src/events/ContractEvent.ts:69
filterToArgs
▸ Private
filterToArgs(eventName
, filter
): any
[]
Parameters
Name | Type |
---|---|
eventName | string |
filter | Filter |
Returns
any
[]
Defined in
src/events/ContractEvent.ts:73
findSigner
▸ findSigner(from
): Promise
<Signer
>
Parameters
Name | Type |
---|---|
from | string |
Returns
Promise
<Signer
>
Inherited from
Defined in
src/Instantiable.abstract.ts:105
getBlockNumber
▸ getBlockNumber(): Promise
<number
>
Returns
Promise
<number
>
Overrides
NeverminedEvent.getBlockNumber
Defined in
src/events/ContractEvent.ts:65
getEventData
▸ getEventData(options
): EventResult
Parameters
Name | Type |
---|---|
options | EventOptions |
Returns
Overrides
Defined in
src/events/ContractEvent.ts:29
getPastEvents
▸ getPastEvents(options
): EventResult
Parameters
Name | Type |
---|---|
options | EventOptions |
Returns
Overrides
Defined in
src/events/ContractEvent.ts:47
once
▸ once(callback?
, options?
): Promise
<EventResult
>
Parameters
Name | Type |
---|---|
callback? | (events : EventResult []) => void |
options? | EventOptions |
Returns
Promise
<EventResult
>
Inherited from
Defined in
src/events/NeverminedEvent.ts:55
setInstanceConfig
▸ Protected
setInstanceConfig(config
): void
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
void
Inherited from
NeverminedEvent.setInstanceConfig
Defined in
src/Instantiable.abstract.ts:171
subscribe
▸ subscribe(callback
, options
): ContractEventSubscription
Parameters
Name | Type |
---|---|
callback | (events : EventResult []) => void |
options | EventOptions |
Returns
Inherited from
Defined in
src/events/NeverminedEvent.ts:41
addressesStatic
▸ Static
addressesStatic(config
, web3
): Promise
<string
[]>
Parameters
Name | Type |
---|---|
config | Config |
web3 | JsonRpcProvider |
Returns
Promise
<string
[]>
Inherited from
NeverminedEvent.addressesStatic
Defined in
src/Instantiable.abstract.ts:142
findSignerStatic
▸ Static
findSignerStatic(config
, web3
, from
): Promise
<Signer
>
Parameters
Name | Type |
---|---|
config | Config |
web3 | JsonRpcProvider |
from | string |
Returns
Promise
<Signer
>
Inherited from
NeverminedEvent.findSignerStatic
Defined in
src/Instantiable.abstract.ts:115
getInstance
▸ Static
getInstance(contract
, eventEmitter
, nevermined
, web3
): ContractEvent
Parameters
Name | Type |
---|---|
contract | ContractBase |
eventEmitter | EventEmitter |
nevermined | Nevermined |
web3 | JsonRpcProvider |
Returns
Overrides
Defined in
src/events/ContractEvent.ts:14
setInstanceConfig
▸ Static
Protected
setInstanceConfig<T
>(instance
, instantiableConfig
): void
Type parameters
Name | Type |
---|---|
T | extends Instantiable <T > |
Parameters
Name | Type |
---|---|
instance | T |
instantiableConfig | InstantiableConfig |
Returns
void
Inherited from
NeverminedEvent.setInstanceConfig