Changes:
- supports Nim 2.0.x and 2.2.x
- no longer supports Nim versions 1.6.x
- better handling of async exceptions
- block number can be retrieved from a block tag
- workaround for hardhat websocket subscription timeouts
- supports estimating gas for contract calls
* Move logFilters to JsonRpcSubscriptions
* Add resubscribe flag
* Add documentation for the resubscribe symbol
* Rename the symbol for better clarity
* Provide better message
* Add nimbledeps to git ignore
* Update wording
* Update wording
* Remove the ws_resubscribe flag from the config
* Handle the concurrency issues when updating the logFilters and add tests
* Update log filters comment
* Add lock when subscribing to blocks
* Remove useless private access
* Fix wording
* Fix try except format
* Restore privateAccess because logEvents moved to JsonRpcSubscriptions
* Use seconds instead of milliseconds
* Remove extra dot in test label
* Restore new lines
* Pass the resubscribe internal in new function and remove unneeded try except
* Remove ws_resubscribe default value making testing easier
* Remove unneeded condition
* Add new line
* Fix nim syntax
* Update symbol description
* Log warning when the resubscription interval is more than 300 seconds
* Catch errors in close method
* Redefine raises for async pragma in close methods
* Provide better error message
* Update dependencies for Nim 2.x
* Use refc as memory management and disable styleCheck because of testutils
* Fix ambiguous import
* Change Address init because eth introduced Byte20 type for Address type
* use uint64 instead of init64
* Rename properties after a change in eth to be closer to the spec
* Use Opt type instead of Option
* Add 2.0.12 version to CI
* Increment the version
* Update the Nim version in CI
* Update to Nim 2.0.14
* Use Nim 2.x commit hash for contractabi
* Remove stable on CI because we don't want to test with Nim 2.2.x
* Update Nim minimum version to 2.0.14
* fix version deps
* remove fq typename
* Add debug flag
* Define maximumtaggedversions
* Update readme
---------
Co-authored-by: Eric <5089238+emizzle@users.noreply.github.com>
This is a braking change. Subscription callbacks wrap the arguments in the Result type.
Corrects the preceding commit marked with wrong version number (0.10.2).
* fix: modify unsubscribe cleanup routine
Ignore exceptions (other than CancelledError) if uninstallation of the filter fails. If it's the last step in the subscription cleanup, then filter changes for this filter will no longer be polled so if the filter continues to live on in geth for whatever reason, then it doesn't matter.
This includes a number of fixes:
- `CancelledError` is now caught inside of `getChanges`. This was causing conditions during `subscriptions.close`, where the `CancelledError` would get consumed by the `except CatchableError`, if there was an ongoing `poll` happening at the time of close.
- After creating a new filter inside of `getChanges`, the new filter is polled for changes before returning.
- `getChanges` also does not swallow `CatchableError` by returning an empty array, and instead re-raises the error if it is not `filter not found`.
- The tests were simplified by accessing the private fields of `PollingSubscriptions`. That way, there wasn't a race condition for the `newFilterId` counter inside of the mock.
- The `MockRpcHttpServer` was simplified by keeping track of the active filters only, and invalidation simply removes the filter. The tests then only needed to rely on the fact that the filter id changed in the mapping.
- Because of the above changes, we no longer needed to sleep inside of the tests, so the sleeps were removed, and the polling interval could be changed to 1ms, which not only makes the tests faster, but would further highlight any race conditions if present.
* docs: rpc custom port documentation
---------
Co-authored-by: Adam Uhlíř <adam@uhlir.dev>
Breaking change:
`Filter` has been changed to `EventFilter` to be inline with ethers.js. `Filter` is used for creating subscriptions in `nim-ethers`. All previously-created instances of `Filter` in your consuming application code should be changed to `EventFilter`.
Add support for indexed (and non-indexed) Event fields types that are distinct `ValueType` or `SmallByteArray`. For example,
```nim
type
DistinctAlias = distinct array[32, byte]
MyEvent = object of Event
a {.indexed.}: DistinctAlias
b: DistinctAlias # also allowed for non-indexed fields
## The below funcs generally need to be included for ABI
## encoding/decoding purposes when implementing distinct types.
func toArray(value: DistinctAlias): array[32, byte] =
array[32, byte](value)
func encode*(encoder: var AbiEncoder, value: DistinctAlias) =
encoder.write(value.toArray)
func decode*(decoder: var AbiDecoder,
T: type DistinctAlias): ?!T =
let d = ?decoder.read(type array[32, byte])
success DistinctAlias(d)
```
