nim-ethers/testmodule/testWallet.nim

123 lines
4.8 KiB
Nim
Raw Normal View History

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 03:58:45 +00:00
import std/os
2022-07-12 18:26:54 +00:00
import pkg/asynctest
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
import pkg/serde
2022-07-14 08:22:54 +00:00
import pkg/stew/byteutils
2022-07-12 18:26:54 +00:00
import ../ethers
const pk1 = "9c0257114eb9399a2985f8e75dad7600c5d89fe3824ffa99ec1c3eb8bf3b0501"
const pk_with_funds = "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d"
2022-07-12 19:17:59 +00:00
type Erc20* = ref object of Contract
proc transfer*(erc20: Erc20, recipient: Address, amount: UInt256) {.contract.}
2022-07-12 18:26:54 +00:00
suite "Wallet":
2022-07-21 00:00:57 +00:00
var provider: JsonRpcProvider
var snapshot: JsonNode
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 03:58:45 +00:00
let providerUrl = getEnv("ETHERS_TEST_PROVIDER", "localhost:8545")
2022-07-21 00:00:57 +00:00
setup:
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 03:58:45 +00:00
provider = JsonRpcProvider.new("http://" & providerUrl)
2022-07-21 00:00:57 +00:00
snapshot = await provider.send("evm_snapshot")
teardown:
discard await provider.send("evm_revert", @[snapshot])
await provider.close()
2022-07-21 00:00:57 +00:00
2022-07-12 18:26:54 +00:00
test "Can create Wallet with private key":
check isSuccess Wallet.new(pk1)
discard Wallet.new(PrivateKey.fromHex(pk1).get)
2022-07-12 18:26:54 +00:00
test "Private key can start with 0x":
check isSuccess Wallet.new("0x" & pk1)
2022-07-14 08:22:54 +00:00
2022-07-12 18:26:54 +00:00
test "Can create Wallet with provider":
let provider = JsonRpcProvider.new()
check isSuccess Wallet.new(pk1, provider)
discard Wallet.new(PrivateKey.fromHex(pk1).get, provider)
test "Cannot create wallet with invalid key string":
check isFailure Wallet.new("0xInvalidKey")
check isFailure Wallet.new("0xInvalidKey", JsonRpcProvider.new())
2022-07-12 18:26:54 +00:00
test "Can connect Wallet to provider":
let wallet = !Wallet.new(pk1)
2022-07-12 18:26:54 +00:00
wallet.connect(provider)
2022-07-14 08:22:54 +00:00
2022-07-12 18:26:54 +00:00
test "Can create Random Wallet":
discard Wallet.createRandom()
test "Can create Random Wallet with provider":
discard Wallet.createRandom(provider)
test "Multiple Random Wallets are different":
let wallet1 = Wallet.createRandom()
let wallet2 = Wallet.createRandom()
check $wallet1.privateKey != $wallet2.privateKey
2022-07-14 08:22:54 +00:00
2022-07-12 18:26:54 +00:00
test "Creates the correct public key and Address from private key":
let wallet = !Wallet.new(pk1)
2022-07-12 18:26:54 +00:00
check $wallet.publicKey == "5eed5fa3a67696c334762bb4823e585e2ee579aba3558d9955296d6c04541b426078dbd48d74af1fd0c72aa1a05147cf17be6b60bdbed6ba19b08ec28445b0ca"
check $wallet.address == "0x328809bc894f92807417d2dad6b7c998c1afdac6"
2022-07-14 08:22:54 +00:00
2022-07-12 18:26:54 +00:00
test "Can sign manually created transaction":
2023-07-03 13:51:42 +00:00
# Example from EIP-155
let wallet = !Wallet.new("0x4646464646464646464646464646464646464646464646464646464646464646")
2023-07-03 13:51:42 +00:00
let transaction = Transaction(
to: !Address.init("0x3535353535353535353535353535353535353535"),
nonce: some 9.u256,
chainId: some 1.u256,
gasPrice: some 20 * 10.u256.pow(9),
gasLimit: some 21000.u256,
value: 10.u256.pow(18),
data: @[]
2022-07-12 18:26:54 +00:00
)
2023-07-03 13:51:42 +00:00
let signed = await wallet.signTransaction(transaction)
check signed.toHex == "f86c098504a817c800825208943535353535353535353535353535353535353535880de0b6b3a76400008025a028ef61340bd939bc2195fe537567866003e1a15d3c71ff63e1590620aa636276a067cbe9d8997f761aecb703304b3800ccf555c9f3dc64214b297fb1966a3b6d83"
2022-07-12 18:26:54 +00:00
test "Can sign manually created tx with EIP1559":
let wallet = !Wallet.new(pk1)
2022-07-12 18:26:54 +00:00
let tx = Transaction(
to: wallet.address,
nonce: some 0.u256,
chainId: some 31337.u256,
maxFee: some 2_000_000_000.u256,
maxPriorityFee: some 1_000_000_000.u256,
gasLimit: some 21_000.u256
)
let signedTx = await wallet.signTransaction(tx)
2022-07-14 08:22:54 +00:00
check signedTx.toHex == "02f86c827a6980843b9aca00847735940082520894328809bc894f92807417d2dad6b7c998c1afdac68080c001a0162929fc5b4cb286ed4cd630d172d1dd747dad4ffbeb413b037f21168f4fe366a062b931c1fc55028ae1fdf5342564300cae251791d785a0efd31c088405a651e7"
2022-07-12 18:26:54 +00:00
test "Can send rawTransaction":
let wallet = !Wallet.new(pk_with_funds)
2022-07-12 18:26:54 +00:00
let tx = Transaction(
to: wallet.address,
nonce: some 0.u256,
chainId: some 31337.u256,
gasPrice: some 1_000_000_000.u256,
gasLimit: some 21_000.u256,
)
let signedTx = await wallet.signTransaction(tx)
let txHash = await provider.sendTransaction(signedTx)
2023-07-03 13:51:42 +00:00
check txHash.hash != TransactionHash.default
2022-07-14 08:22:54 +00:00
2022-07-12 19:17:59 +00:00
test "Can call state-changing function automatically":
#TODO add actual token contract, not random address. Should work regardless
let wallet = !Wallet.new(pk_with_funds, provider)
2022-07-12 19:17:59 +00:00
let overrides = TransactionOverrides(
nonce: some 0.u256,
2022-07-12 19:17:59 +00:00
gasPrice: some 1_000_000_000.u256,
gasLimit: some 22_000.u256)
let testToken = Erc20.new(wallet.address, wallet)
await testToken.transfer(wallet.address, 24.u256, overrides)
2022-07-12 19:17:59 +00:00
test "Can call state-changing function automatically EIP1559":
#TODO add actual token contract, not random address. Should work regardless
let wallet = !Wallet.new(pk_with_funds, provider)
2022-07-12 19:17:59 +00:00
let overrides = TransactionOverrides(
nonce: some 0.u256,
2022-07-12 19:17:59 +00:00
maxFee: some 1_000_000_000.u256,
maxPriorityFee: some 1_000_000_000.u256,
gasLimit: some 22_000.u256)
let testToken = Erc20.new(wallet.address, wallet)
2022-07-14 08:22:54 +00:00
await testToken.transfer(wallet.address, 24.u256, overrides)