status-im
/
nim-web3
mirror of https://github.com/status-im/nim-web3.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
139 Commits 10 Branches 0 Tags 3.2 MiB
Nim 99.6%
Shell 0.4%
Go to file
Will Whitty 3d539d55cf
Update docs 		2022-09-17 15:57:54 +04:00
.github/workflows Fix macos devel build on CI (#59) 2022-09-06 11:53:06 +02:00
tests tighten nimcrypto imports (#58) 2022-09-05 19:29:33 +02:00
web3 tighten nimcrypto imports (#58) 2022-09-05 19:29:33 +02:00
.gitignore Replace ganache with hardhat 2021-12-14 08:21:39 +01:00
LICENSE-APACHEv2 Initial commit 2018-12-21 18:27:09 +01:00
LICENSE-MIT Initial commit 2018-12-21 18:27:09 +01:00
README.md Update docs 2022-09-17 15:57:54 +04:00
ci-test.sh CI: test with multiple Nim versions (#46) 2022-01-14 05:46:13 +01:00
nim.cfg move `-d:nimRawSetjmp` to config.nims (#51) 2022-07-12 21:04:31 +03:00
web3.nim tighten nimcrypto imports (#58) 2022-09-05 19:29:33 +02:00
web3.nimble use --stylecheck:error (#52) 2022-07-21 11:18:09 +00:00

README.md

web3

License: MIT License: Apache Stability: experimental Github action

The humble beginnings of a Nim library similar to web3.[js|py]

Installation

You can install the developement version of the library through nimble with the following command

nimble install https://github.com/status-im/nim-web3@#master

Development

You should first run ./simulator.sh which runs ganache-cli

This creates a local simulated Ethereum network on your local machine and the tests will use this for their E2E processing

Interaction with nimbus-eth2

This repo relies heavily on parts of the nimbus-eth2 repo. In order to work properly here you need to source /nimbus-eth2/env.sh

Example

Need to log the output of the websocketclient.nim responses:

  1. Make modifications in /nimbus-eth2/vendor/nim-json-rpc/json-rpc/clients/websocketclient.nim
  2. source /nimbus-eth2/env.sh
  3. Run tests (nimble test) in the web3-repo

We should now see our output logged correctly to the console.

License

Licensed and distributed under either of

or

at your option. This file may not be copied, modified, or distributed except according to those terms.