UNPKG

web3-eth

Version:

Web3 module to interact with the Ethereum blockchain and smart contracts.

github.com/ChainSafe/web3.js

ChainSafe/web3.js

62 lines (61 loc) • 4.75 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
import { Web3Context } from 'web3-core'; import { DataFormat, EthExecutionAPI, Numbers, FilterParams } from 'web3-types'; /** * View additional documentations here: {@link Web3Eth.createNewPendingTransactionFilter} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. * @param returnFormat ({@link DataFormat}) Return format */ export declare function createNewPendingTransactionFilter<ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, returnFormat: ReturnFormat): Promise<import("web3-types").NumberTypes[ReturnFormat["number"]]>; /** * View additional documentations here: {@link Web3Eth.createNewFilter} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. * @param filter ({@link FilterParam}) Filter param optional having from-block to-block address or params * @param returnFormat ({@link DataFormat}) Return format */ export declare function createNewFilter<ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, filter: FilterParams, returnFormat: ReturnFormat): Promise<import("web3-types").NumberTypes[ReturnFormat["number"]]>; /** * View additional documentations here: {@link Web3Eth.createNewBlockFilter} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. * @param returnFormat ({@link DataFormat}) Return format */ export declare function createNewBlockFilter<ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, returnFormat: ReturnFormat): Promise<import("web3-types").NumberTypes[ReturnFormat["number"]]>; /** * View additional documentations here: {@link Web3Eth.uninstallFilter} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. * @param filterIdentifier ({@link Numbers}) filter id */ export declare function uninstallFilter(web3Context: Web3Context<EthExecutionAPI>, filterIdentifier: Numbers): Promise<boolean>; /** * View additional documentations here: {@link Web3Eth.getFilterChanges} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. * @param filterIdentifier ({@link Numbers}) filter id */ export declare function getFilterChanges<ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, filterIdentifier: Numbers, returnFormat: ReturnFormat): Promise<(string | { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: import("web3-types").NumberTypes[ReturnFormat["number"]] | undefined; readonly transactionIndex?: import("web3-types").NumberTypes[ReturnFormat["number"]] | undefined; readonly transactionHash?: import("web3-types").ByteTypes[ReturnFormat["bytes"]] | undefined; readonly blockHash?: import("web3-types").ByteTypes[ReturnFormat["bytes"]] | undefined; readonly blockNumber?: import("web3-types").NumberTypes[ReturnFormat["number"]] | undefined; readonly address?: import("web3-types").Address | undefined; readonly data?: import("web3-types").ByteTypes[ReturnFormat["bytes"]] | undefined; readonly topics?: import("web3-types").ByteTypes[ReturnFormat["bytes"]][] | undefined; })[]>; /** * View additional documentations here: {@link Web3Eth.getFilterLogs} * @param web3Context ({@link Web3Context}) Web3 configuration object that contains things such as the provider, request manager, wallet, etc. * @param filterIdentifier ({@link Numbers}) filter id */ export declare function getFilterLogs<ReturnFormat extends DataFormat>(web3Context: Web3Context<EthExecutionAPI>, filterIdentifier: Numbers, returnFormat: ReturnFormat): Promise<(string | { readonly id?: string | undefined; readonly removed?: boolean | undefined; readonly logIndex?: import("web3-types").NumberTypes[ReturnFormat["number"]] | undefined; readonly transactionIndex?: import("web3-types").NumberTypes[ReturnFormat["number"]] | undefined; readonly transactionHash?: import("web3-types").ByteTypes[ReturnFormat["bytes"]] | undefined; readonly blockHash?: import("web3-types").ByteTypes[ReturnFormat["bytes"]] | undefined; readonly blockNumber?: import("web3-types").NumberTypes[ReturnFormat["number"]] | undefined; readonly address?: import("web3-types").Address | undefined; readonly data?: import("web3-types").ByteTypes[ReturnFormat["bytes"]] | undefined; readonly topics?: import("web3-types").ByteTypes[ReturnFormat["bytes"]][] | undefined; })[]>;