2022-01-18 11:10:20 +00:00
|
|
|
import pkg/asynctest
|
|
|
|
import pkg/chronos
|
feat: Allow contract transactions to be waited on
Allow waiting for a specified number of confirmations for contract transactions.
This change only requires an optional TransactionResponse return type to be added to the contract function. This allows the transaction hash to be passed to `.wait`.
For example, previously the `mint` method looked like this without a return value:
```
method mint(token: TestToken, holder: Address, amount: UInt256) {.base, contract.}
```
it still works without a return value, but if we want to wait for a 3 confirmations, we can now define it like this:
```
method mint(token: TestToken, holder: Address, amount: UInt256): ?TransactionResponse {.base, contract.}
```
and use like this:
```
let receipt = await token.connect(signer0)
.mint(accounts[1], 100.u256)
.wait(3) # wait for 3 confirmations
```
2022-05-17 04:57:18 +00:00
|
|
|
import pkg/ethers
|
2023-06-19 12:13:44 +00:00
|
|
|
import pkg/ethers/providers/jsonrpc/conversions
|
2022-05-17 02:34:22 +00:00
|
|
|
import pkg/stew/byteutils
|
2023-06-21 13:01:04 +00:00
|
|
|
import ../../examples
|
|
|
|
import ../../miner
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
for url in ["ws://localhost:8545", "http://localhost:8545"]:
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
suite "JsonRpcProvider (" & url & ")":
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
var provider: JsonRpcProvider
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
setup:
|
2023-06-27 13:08:37 +00:00
|
|
|
provider = JsonRpcProvider.new(url, pollingInterval = 100.millis)
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 14:40:29 +00:00
|
|
|
|
|
|
|
teardown:
|
|
|
|
await provider.close()
|
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
test "can be instantiated with a default URL":
|
|
|
|
discard JsonRpcProvider.new()
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
test "lists all accounts":
|
|
|
|
let accounts = await provider.listAccounts()
|
|
|
|
check accounts.len > 0
|
2022-01-18 11:10:20 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
test "sends raw messages to the provider":
|
|
|
|
let response = await provider.send("evm_mine")
|
|
|
|
check response == %"0x0"
|
2022-01-18 13:24:46 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
test "returns block number":
|
|
|
|
let blocknumber1 = await provider.getBlockNumber()
|
|
|
|
discard await provider.send("evm_mine")
|
|
|
|
let blocknumber2 = await provider.getBlockNumber()
|
|
|
|
check blocknumber2 > blocknumber1
|
|
|
|
|
|
|
|
test "returns block":
|
|
|
|
let block1 = !await provider.getBlock(BlockTag.earliest)
|
|
|
|
let block2 = !await provider.getBlock(BlockTag.latest)
|
|
|
|
check block1.hash != block2.hash
|
|
|
|
check !block1.number < !block2.number
|
|
|
|
check block1.timestamp < block2.timestamp
|
|
|
|
|
|
|
|
test "subscribes to new blocks":
|
|
|
|
let oldBlock = !await provider.getBlock(BlockTag.latest)
|
2023-06-27 13:24:01 +00:00
|
|
|
discard await provider.send("evm_mine")
|
2023-06-27 13:05:15 +00:00
|
|
|
var newBlock: Block
|
2023-06-29 07:59:48 +00:00
|
|
|
let blockHandler = proc(blck: Block) = newBlock = blck
|
2023-06-27 13:05:15 +00:00
|
|
|
let subscription = await provider.subscribe(blockHandler)
|
|
|
|
discard await provider.send("evm_mine")
|
|
|
|
check eventually newBlock.number.isSome
|
|
|
|
check !newBlock.number > !oldBlock.number
|
|
|
|
check newBlock.timestamp > oldBlock.timestamp
|
|
|
|
check newBlock.hash != oldBlock.hash
|
|
|
|
await subscription.unsubscribe()
|
|
|
|
|
|
|
|
test "can send a transaction":
|
|
|
|
let signer = provider.getSigner()
|
|
|
|
let transaction = Transaction.example
|
|
|
|
let populated = await signer.populateTransaction(transaction)
|
|
|
|
|
|
|
|
let txResp = await signer.sendTransaction(populated)
|
|
|
|
check txResp.hash.len == 32
|
|
|
|
check UInt256.fromHex("0x" & txResp.hash.toHex) > 0
|
|
|
|
|
|
|
|
test "can wait for a transaction to be confirmed":
|
2023-06-29 07:59:48 +00:00
|
|
|
for confirmations in 0..3:
|
|
|
|
let signer = provider.getSigner()
|
|
|
|
let transaction = Transaction.example
|
|
|
|
let populated = await signer.populateTransaction(transaction)
|
|
|
|
let confirming = signer.sendTransaction(populated).confirm(confirmations)
|
|
|
|
await sleepAsync(100.millis) # wait for tx to be mined
|
|
|
|
await provider.mineBlocks(confirmations - 1)
|
|
|
|
let receipt = await confirming
|
|
|
|
check receipt.blockNumber.isSome
|
|
|
|
|
|
|
|
test "confirmation times out":
|
|
|
|
let hash = TransactionHash.example
|
|
|
|
let tx = TransactionResponse(provider: provider, hash: hash)
|
|
|
|
let confirming = tx.confirm(confirmations = 2, timeout = 5)
|
|
|
|
await provider.mineBlocks(5)
|
|
|
|
expect EthersError:
|
|
|
|
discard await confirming
|
2022-05-18 13:14:39 +00:00
|
|
|
|
2023-06-27 13:05:15 +00:00
|
|
|
test "raises JsonRpcProviderError when something goes wrong":
|
|
|
|
let provider = JsonRpcProvider.new("http://invalid.")
|
|
|
|
expect JsonRpcProviderError:
|
|
|
|
discard await provider.listAccounts()
|
|
|
|
expect JsonRpcProviderError:
|
|
|
|
discard await provider.send("evm_mine")
|
|
|
|
expect JsonRpcProviderError:
|
|
|
|
discard await provider.getBlockNumber()
|
|
|
|
expect JsonRpcProviderError:
|
|
|
|
discard await provider.getBlock(BlockTag.latest)
|
|
|
|
expect JsonRpcProviderError:
|
2023-06-29 07:59:48 +00:00
|
|
|
discard await provider.subscribe(proc(_: Block) = discard)
|
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 05:50:46 +00:00
|
|
|
expect JsonRpcSignerError:
|
2023-06-27 13:05:15 +00:00
|
|
|
discard await provider.getSigner().sendTransaction(Transaction.example)
|
2024-02-20 15:25:23 +00:00
|
|
|
|
|
|
|
test "syncing":
|
|
|
|
let isSyncing = await provider.isSyncing()
|
|
|
|
check not isSyncing
|
|
|
|
|