96 Commits

Author SHA1 Message Date
Mark Spanbroek
86b9a02054 feat(subscriptions): use websocket to get instant updates 2025-09-10 11:46:18 +02:00
Mark Spanbroek
ff667cb8f0 refactor!(subscriptions): replace old implementation 2025-09-10 11:38:59 +02:00
Mark Spanbroek
3b0f94f2b5 refactor(subscriptions): remove unnecessary json-rpc method table 2025-09-03 16:12:27 +02:00
Mark Spanbroek
119c0dff9c chore: fix warning 2025-09-03 15:45:58 +02:00
Mark Spanbroek
26b19140a1 chore: formatting 2025-09-03 15:29:41 +02:00
Arnaud
30871c7b1d
chore: add EIP-1559 implementation for gas price (#113)
* Add EIP-1559 implementation for gas price

* Improve logs

* Improve comment

* Rename maxFee and maxPriorityFee to use official EIP-1559 names

* Delete gas price when using EIP-1559

* Allow override maxFeePerGas

* Code style

* Remove useless specific EIP1559 test because Hardhart support it so all transactions are using EIP1559 by default

* Restore test to check legacy transaction

* Update after rebase

* Call eth_maxPriorityFeePerGas and returns a manual defined maxPriorityFeePerGas as a fallback

* Catch JsonRpcProviderError instead of ProviderError

* Improve readability

* Set none value for maxFeePerGas in case of non EIP-1559 transaction

* Assign none to maxPriorityFeePerGas for non EIP-1559 transaction to avoid potential side effect in wallet signing

* Remove upper bound version for stew and update contractabi
2025-05-28 16:14:01 +02:00
Arnaud
af3d7379c8
chore: add ws resubscription for hardhat workaround (#112)
* 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
2025-04-10 10:48:41 +02:00
Eric
d2b11a8657
fix(async): propagate async cancellation (#105)
* fix(async): propagate CancelledErrors

* remove CatchableError from contract macro async raises list

* remove mistakenly added ContractError
2025-02-17 20:31:24 +11:00
Arnaud
26342d3e27
Update to nim 2 x (#103)
* 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>
2025-02-14 14:18:19 +11:00
Adam Uhlíř
037bef0256
chore: fix async raises warnings (#100) 2024-12-09 16:22:25 +01:00
Marcin Czenko
c0cc437aa2 applies review comments 2024-11-28 16:08:51 +01:00
Marcin Czenko
4642545309 makes sure that a key on subscriptionMapping exists before trying to access it 2024-11-28 16:08:51 +01:00
Adam Uhlíř
d88e4614b1
feat: subscriptions get passed result questionable (#91)
Co-authored-by: Eric <5089238+emizzle@users.noreply.github.com>
2024-11-28 14:48:10 +01:00
Mark Spanbroek
35aebdb46f cleanup 2024-11-13 10:09:40 +01:00
Mark Spanbroek
f15d55f513 do not crash polling when just unsubscribed 2024-11-13 10:09:40 +01:00
Mark Spanbroek
c6a59b5187 resubscribe when error in polling 2024-11-13 10:09:40 +01:00
Adam Uhlíř
80b2ead97c
fix: block filters can be also recreated (#85)
* fix: block filters can be also recreated

* refactor: rename filter to logFilter
2024-10-30 17:26:27 +01:00
Eric
6523e70eaf
fix: items(JsonNode) symbol not found (#87)
* chore: export subscriptions

This has a knock-on effect of nim-serde not being imported into subscriptions when JsonRpcProvider.new is called from a consumer that does not export nim-serde.

* import/export serde

* Replace all instances of std/json with pkg/serde
2024-10-28 14:06:20 +11:00
Eric
765379a662
fix: nonce too high (#81)
* fix nonce issues by locking populate and send transaction

Concurrent asynchronous population of transactions cause issues with nonces not being in sync with the transaction count for an account on chain. This was being mitigated by tracking a "last seen" nonce and locking inside of `populateTransaction` so that the nonce could be populated in a concurrent fashion. However, if there was an async cancellation before the transaction was sent, then the nonce would become out of sync. One solution was to decrease the nonce if a cancellation occurred. The other solution, in this commit, is simply to lock the populate and sendTransaction calls together, so that there will not be concurrent nonce discrepancies. This removes the need for "lastSeenNonce" and is overall more simple.

* remove lastSeenNonce

Internal nonce tracking is no longer needed since populate/sendTransaction is now locked. Even if cancelled midway, the nonce will get a refreshed value from the number of transactions from chain.

* chronos v4 exception tracking

* Add tests
2024-10-25 15:08:00 +11:00
Eric
b68bea9909
fix: modify unsubscribe cleanup routine and tests (#84)
* 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>
2024-10-25 14:58:45 +11:00
Adam Uhlíř
507ac6a4cc
fix(subscriptions): filter not found recreates polling filter (#78) 2024-10-22 15:57:25 +02:00
Adam Uhlíř
53e596e75a
fix: pinning nim-eth dependency (#77)
Co-authored-by: Eric <5089238+emizzle@users.noreply.github.com>
2024-10-22 10:39:11 +02:00
Mark Spanbroek
241ce6e8f3 sendTransaction raises ProviderError instead of SignerError
Allows it to contain error data.
It is not the signing that fails, so it makes sense to
use an error type that indicates that the provider failed.
2024-05-21 13:19:24 +02:00
Mark Spanbroek
1ce9824738 EstimateGasError is a ProviderError instead of a SignerError
Which allows for it to contain error data
2024-05-21 13:19:24 +02:00
Mark Spanbroek
875900b493 jsonrpc: extract error data from JSON RPC error
Inspired by 'spelunk' from ethers.js:
f97b92bbb1/packages/providers/src.ts/json-rpc-provider.ts (L25)
2024-05-21 13:19:24 +02:00
Mark Spanbroek
52d7d3dbed jsonrpc: move error handling to separate module 2024-05-21 13:19:24 +02:00
Eric
027b5c37ad
fix: deserialize BlockTag from empty string (#73)
Allows BlockTag to be deserialized from an empty string
2024-05-21 13:10:06 +10:00
Eric
958d7b45d1
Remove overloaded UInt256.fromJson (#74)
* Remove overloaded UInt256.fromJson

Rely instead on UInt256.fromJson from nim-serde, which deserializes an empty string for ?UInt256 into UInt256.none. Previously, empty strings were deserialized into 0.u256. BlockNumber was using this deserialization, and it appears that deserializing a missing block number from a TransactionReceipt into 0 might actually cause some issues when waiting on block confirmations.

* bump version of serde

* Remove "v" from version in `.nimble`

* Fix nimble serde version again ¯\_(ツ)_/¯
2024-05-21 13:09:42 +10:00
markspanbroek
4ad5b6065e
Update dependencies (#70)
Updates hardhat and solidity

Uses personal_sign instead of eth_sign, because ethers.js also uses personal_sign, and eth_sign is now broken in hardhat (arguments are reversed).

Co-authored-by: Adam Uhlíř <adam@uhlir.dev>
2024-05-13 11:51:43 +02:00
Ben Bierens
942fe034fc
Fixes isSyncing issue where object is evaluated as false (#68) 2024-03-08 12:55:36 +01:00
Ben Bierens
e8196b3c82
Adds isSyncing to provider (#62) 2024-02-20 16:25:23 +01:00
Eric
43500c63d7
Upgrade to nim-json-rpc v0.4.2 and chronos v4 (#64)
* Add json de/serialization lib from codex to handle conversions

json-rpc now requires nim-json-serialization to convert types to/from json. Use the nim-json-serialization signatures to call the json serialization lib from nim-codex (should be moved to its own lib)

* Add ethers implementation for setMethodHandler

Was removed in json-rpc

* More json conversion updates

* Fix json_rpc.call returning JsonString instead of JsonNode

* Update exceptions

Use {.async: (raises: [...].} where needed
Annotate provider with {.push raises:[].}
Format signatures

* Start fixing tests (mainly conversion fixes)

* rename sender to `from`, update json error logging, add more conversions

* Refactor exceptions for providers and signers, fix more tests

- signer procs raise SignerError, provider procs raise ProviderError
- WalletError now inherits from SignerError
- move wallet module under signers
- create jsonrpo moudle under signers
- bump nim-json-rpc for null-handling fixes
- All jsonrpc provider tests passing, still need to fix others

* remove raises from async annotation for dynamic dispatch

- removes async: raises from getAddress and signTransaction because derived JsonRpcSigner methods were not being used when dynamically dispatched. Once `raises` was removed from the async annotation, the dynamic dispatch worked again. This is only the case for getAddress and signTransaction.
- add gcsafe annotation to wallet.provider so that it matches the base method

* Catch EstimateGasError before ProviderError

EstimateGasError is now a ProviderError (it is a SignerError, and SignerError is a ProviderError), so EstimateGasErrors were not being caught

* clean up - all tests passing

* support nim 2.0

* lock in chronos version

* Add serde options to the json util, along with tests

next step is to:
1. change back any ethers var names that were changed for serialization purposes, eg `from` and `type`
2. move the json util to its own lib

* bump json-rpc to 0.4.0 and fix test

* fix: specify raises for getAddress and sendTransaction

Fixes issue where getAddress and sendTransaction could not be found for MockSigner in tests. The problem was that the async: raises update had not been applied to the MockSigner.

* handle exceptions during jsonrpc init

There are too many exceptions to catch individually, including chronos raising CatchableError exceptions in await expansion. There are also many other errors captured inside of the new proc with CatchableError. Instead of making it more complicated and harder to read, I think sticking with excepting CatchableError inside of convertError is a sensible solution

* cleanup

* deserialize key defaults to serialize key

* Add more tests for OptIn/OptOut/Strict modes, fix logic

* use nim-serde instead of json util

Allows aliasing of de/serialized fields, so revert changes of sender to `from` and transactionType to `type`

* Move hash* shim to its own module

* address PR feedback

- add comments to hashes shim
- remove .catch from callback condition
- derive SignerError from EthersError instead of ProviderError. This allows Providers and Signers to be separate, as Ledger does it, to isolate functionality. Some signer functions now raise both ProviderError and SignerError
- Update reverts to check for SignerError
- Update ERC-20 method comment

* rename subscriptions.init > subscriptions.start
2024-02-19 16:50:46 +11:00
Mark Spanbroek
c25de86656 remove upraises
we no longer support nim 1.2.x,
so upraises is no longer necessary
2023-12-12 09:28:06 +01:00
Eric
2428b756d6
On transaction failure, fetch revert reason with replayed transaction (#57)
When transaction fails (receipt.status is Failed), fetch revert reason by replaying transaction.
2023-10-25 11:36:00 +11:00
Eric
7eac8410af
prevent stuck transactions by async locking nonce sequencing (+ estimate gas) (#55)
- async lock during nonce sequencing + gas estimation
- simplified cancelTransaction (still exported) such that the new transaction is populated using populateTransaction, so that all gas and fees are reset
- moved reverting contract function into its own testing helpers module, and refactored any tests to use it
- updated the test helper reverts to check EstimateGasErrors
- combine ensureNonceSequence into populateTransaction
2023-10-25 10:42:25 +11:00
Eric
f0303473f6
Increment nonce count when populating transaction (#54)
Increment nonce count when populating transaction

Co-authored-by: markspanbroek <mark@spanbroek.net>
2023-09-15 09:54:08 +10:00
Eric
12d7a35203
Query past contract events (#51)
Based on ethers.js's queryFilter, allows querying of past contract events, by querying the logs for a contract's event topic.

* queryFilter to query past logs
* Allow querying of past block log events
* Can query by block number or block hash
2023-07-20 15:51:28 +10:00
Mark Spanbroek
cb95cbc15a Make BlockHandler callback synchronous (breaking change)
Refactored the confirm() implementation to work
with a synchronous callback
2023-07-04 12:58:48 +02:00
Mark Spanbroek
82f6449374 Move JsonRpcSubscription type to jsonrpc module
Allows it to insert convertError to ensure that
any errors are re-raised as JsonRpcProviderError
2023-07-03 13:09:09 +02:00
Mark Spanbroek
738c6a87e2 Stop polling when provider is closed 2023-07-03 13:09:09 +02:00
Mark Spanbroek
a27c2de41c Close provider by unsubscribing and closing client 2023-07-03 13:09:09 +02:00
Mark Spanbroek
2481bda6e4 Subscribe to logs with polling 2023-07-03 13:09:09 +02:00
Mark Spanbroek
0aea16047c Ignore errors when retrieving block by hash 2023-07-03 13:09:09 +02:00
Mark Spanbroek
1b151d589d Add polling interval to constructor of provider 2023-07-03 13:09:09 +02:00
Mark Spanbroek
0322ae1451 Ignore errors while polling 2023-07-03 13:09:09 +02:00
Mark Spanbroek
50cfd9d9dd untilCancelled template 2023-07-03 13:09:09 +02:00
Mark Spanbroek
3a76fa74f1 Make polling interval configurable 2023-07-03 13:09:09 +02:00
Mark Spanbroek
6a034870f8 Polling block subscriptions for non-websocket connections 2023-07-03 13:09:09 +02:00
Mark Spanbroek
127c9c9b0d Formatting 2023-07-03 13:09:09 +02:00
Mark Spanbroek
16fa0cfcf8 Use new subscription handling in JSON RPC provider 2023-07-03 13:09:09 +02:00