-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathCHANGELOG
More file actions
77 lines (44 loc) · 3.72 KB
/
CHANGELOG
File metadata and controls
77 lines (44 loc) · 3.72 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
## 2022-10-11
### Intro
1. Every Webhook will contain information of 1 stream only, before 1 webhook could contain multiple streams. Meaning 1 Webook = 1 Stream. This will make it easier for you to handle the webhook data. That resulted in some changes in the webhook data structure and the `history` endpoint response.
2. The `abis` field (webhook) was renamed to `abi` and does not contain all abis anymore. Now it is the abi you have specified when creating a stream.
3. Changed the `replay` endpoint to also require the `streamId` as a parameter.
### Added
- `history` endpoint now contains a `tinyPayload`, which includes `blockNumber`, `chainId` and
amount of records, useful for UI pagination
- `history` now contains streamId and tag
### Changed
- Changed Webhook Response to include `tag` and `streamId` in root object.
- Changed `abis` to `abi` in webhook response. Abi is an array of AbiItems that you have specified when creating a stream.
- Changed required parameters for replaying a webhook. Now requiring the `streamId` aswell.
### Removed
- Removed `tag` and `streamId` from `txs`, `internalTxs` and `logs`.
## 2022-10-05
### Intro
1. We have removed all notion of wallet/contract type in order to make the API more clean and flexible.
2. Wether you want to watch contracts or user wallets you specify which addresses you are interested in and the address level options such as wether you want logs, internal transactions, native transactions etc
3. If the addresses you are watching are contracts and you want to watch the events they emit you can provide an array of ABIs to the stream
4. You can monitor multiple topics in the same stream as the Streams API now expects an array of ABIs
5. For each topic you can specify advanced topic-level options such as wether you want internal and native transactions included or not. For each topic you can also provide a filter.
### Added
- Added `advancedOptions` option to create streams. With this option you can have more control over the topics you are passing to the stream. For each topic you can have advanced options that include the `topic`, a `filter` and a `includeNativeTxs` field
- Added `includeContractLogs` option to include or not all logs where the
attached address is present in the logs [_address_, _topic1_, _topic2_,
_topic3_]. Meaning if you are monitoring a wallet that interacts with a contract, you can decide to include the event logs besides the transaction details
- Added `includeInternalTxs` option to include or not all internal transactions
where the attached address is present in the from or to address of a the
internal transaction
- Added `allAddresses` option to monitor **ALL ADDRESSESS** where the topic0 is
emitted. Meaning if you are monitoring ['Transfer(address,address,uint256)'] and allAddresses is set to true you will get every transfer event from every contract that emits this event
- Added new endpoint `streams/evm/${id}/address`
- POST: Add single or multiple addresses to the stream
- GET: Get all addresses from the stream
- DELETE: Delete a single addresses from the stream
### Changed
- Changed `abi` type from object to array. Now allowing multiple abi items that are events.
- Changed `topic0` type from string to array. Now allowing multiple topic0 to be monitored
### Removed
- Removed `tokenAddress` from create stream options. Removed in favor of attaching addressess to an exisiting stream
- Removed `address` from create stream options. Removed in favor of attaching addressess to an exisiting stream
- Removed `type` from create stream options. Removed in favor of attaching addressess to an exisiting stream
- Removed `filter` from create stream options. This is now part of the `advancedOptions` field mentioned above