Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vechain/web3-gear
Proxy Thor's RESTful API to Eth JSON-RPC, to support Remix, Truffle and more.
https://github.com/vechain/web3-gear
blockchain ethereum remix thor truffle vechain web3
Last synced: 7 days ago
JSON representation
Proxy Thor's RESTful API to Eth JSON-RPC, to support Remix, Truffle and more.
- Host: GitHub
- URL: https://github.com/vechain/web3-gear
- Owner: vechain
- License: mit
- Created: 2018-06-27T07:21:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-18T03:38:49.000Z (about 3 years ago)
- Last Synced: 2024-03-14T23:23:25.280Z (8 months ago)
- Topics: blockchain, ethereum, remix, thor, truffle, vechain, web3
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 31
- Watchers: 9
- Forks: 17
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vechain - Web3 Gear - Proxy Thor's RESTful API to Eth JSON-RPC, to support Remix, Truffle and more. (Developer resources / Blockchain development)
README
# Web3-gear [](https://gitter.im/vechain/thor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Proxy [Thor](https://github.com/vechain/thor)'s RESTful API to Eth JSON-RPC, to support Remix, Truffle and more (You should give priority to using Thor's RESTful API).
Working with [Thor Builtins](https://github.com/vechain/thor-builtins) will make Web3-Gear more usable.
# Quick Start
## Installation
### On OS X
* Python 3.7+ support
1. Install the system-dependecies
```
brew install openssl
export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"
export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"
```
2. Installation of Web3-Gear and it's dependent Python packages via PyPI
```
pip3 install web3-gear
```
### On Ubuntu
* Python 3.7+ support
1. Install the system-dependecies
```
sudo apt-get install build-essential libssl-dev python-dev
```
2. Use a virtual environment to isolate your web3-gear project
```
python3 -m venv thor-venv
source thor-venv/bin/activate
```
3. Installation of Web3-Gear and it's dependent Python packages via PyPI
```
pip3 install web3-gear
```
Note that you can activate and deactivate your virtual environment now
```
source thor-venv/bin/activate
deactivate
```
See https://docs.python.org/3/library/venv.html for more information
### On Windows
* Python 3.7+ support
1. Install Visual C++ Build Tools.
2. Install [scrypt-py](https://pypi.org/project/scrypt/#files) use the precompiled wheels.
3. Installation of Web3-Gear and it's dependent Python packages via PyPI
```
pip3 install web3-gear
```
## Run
Installing through pip will make the ``web3-gear`` command available on your machine (a running [thor](https://github.com/vechain/thor) client is required)
```
web3-gear
```
This will run web3-gear on `127.0.0.1:8545`.
You can change its default behavior with the following parameters:
- **host**: rpc service host, eg: `--host 127.0.0.1`
- **port**: rpc service port, eg: `--port 8545`
- **endpoint**: thor restful service endpoint, eg: `--endpoint http://127.0.0.1:8669`
- **keystore**: keystore file path, eg: `--keystore /Users/(username)/keystore)`, default=thor stand-alone(solo) built-in accounts
- **passcode**: passcode of keystore, eg: `--passcode xxxxxxxx`
- **debug**: bool default=false, whether to display debug logs, eg: `--debug true`
- **log**: bool default=false, whether to display rpc logs, eg: `--log false`
### Work with Remix
Change the Remix environment to Web3 provide.
### Work with Truffle
* Truffle 4.0.6+ support
Modify the configuration of truffle first(`truffle.js`):
```js
module.exports = {
networks: {
development: {
host: "localhost",
port: 8545,
network_id: "*" // Match any network id
}
}
};
```
Then you can use truffle's command line tool.
There are some projects based on truffle, can use them for testing:
- [Crowdsale Contracts](https://github.com/vechain/crowdsale-contracts).
- [Token Distribution](https://github.com/libotony/token-distribution).
- [Solidity Idiosyncrasies](https://github.com/miguelmota/solidity-idiosyncrasies).