{"id":13796256,"url":"https://github.com/vechain/web3-gear","last_synced_at":"2025-04-13T00:31:21.217Z","repository":{"id":46569914,"uuid":"138844816","full_name":"vechain/web3-gear","owner":"vechain","description":"Proxy Thor's RESTful API to Eth JSON-RPC, to support Remix, Truffle and more.","archived":false,"fork":false,"pushed_at":"2021-10-18T03:38:49.000Z","size":83,"stargazers_count":31,"open_issues_count":9,"forks_count":17,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-03-14T23:23:25.280Z","etag":null,"topics":["blockchain","ethereum","remix","thor","truffle","vechain","web3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vechain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-27T07:21:36.000Z","updated_at":"2024-03-03T15:56:20.000Z","dependencies_parsed_at":"2022-09-04T10:23:23.972Z","dependency_job_id":null,"html_url":"https://github.com/vechain/web3-gear","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vechain%2Fweb3-gear","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vechain%2Fweb3-gear/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vechain%2Fweb3-gear/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vechain%2Fweb3-gear/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vechain","download_url":"https://codeload.github.com/vechain/web3-gear/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650590,"owners_count":21139670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","ethereum","remix","thor","truffle","vechain","web3"],"created_at":"2024-08-03T23:01:08.022Z","updated_at":"2025-04-13T00:31:20.895Z","avatar_url":"https://github.com/vechain.png","language":"Python","funding_links":[],"categories":["Developer resources"],"sub_categories":["Blockchain development"],"readme":"# Web3-gear \u0026nbsp;\u0026nbsp; [![Gitter](https://badges.gitter.im/vechain/thor.svg)](https://gitter.im/vechain/thor?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\nProxy [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).\n\nWorking with [Thor Builtins](https://github.com/vechain/thor-builtins) will make Web3-Gear more usable.\n\n# Quick Start\n\n## Installation\n\n### On OS X\n\n* Python 3.7+ support\n\n1. Install the system-dependecies\n\n    ```\n    brew install openssl\n    export CFLAGS=\"-I$(brew --prefix openssl)/include $CFLAGS\"\n    export LDFLAGS=\"-L$(brew --prefix openssl)/lib $LDFLAGS\"\n    ```\n\n2. Installation of Web3-Gear and it's dependent Python packages via PyPI\n\n    ```\n    pip3 install web3-gear\n    ```\n\n### On Ubuntu\n\n* Python 3.7+ support\n\n1. Install the system-dependecies\n\n    ```\n    sudo apt-get install build-essential libssl-dev python-dev\n    ```\n\n2. Use a virtual environment to isolate your web3-gear project\n\n    ```\n    python3 -m venv thor-venv\n    source thor-venv/bin/activate\n    ```\n\n3. Installation of Web3-Gear and it's dependent Python packages via PyPI\n\n    ```\n    pip3 install web3-gear\n    ```\n\nNote that you can activate and deactivate your virtual environment now\n\n```\nsource thor-venv/bin/activate\ndeactivate\n```\n\nSee https://docs.python.org/3/library/venv.html for more information\n\n### On Windows\n\n* Python 3.7+ support\n\n1. Install Visual C++ Build Tools.\n\n2. Install [scrypt-py](https://pypi.org/project/scrypt/#files) use the precompiled wheels.\n\n3. Installation of Web3-Gear and it's dependent Python packages via PyPI\n\n    ```\n    pip3 install web3-gear\n    ```\n\n## Run\n\nInstalling through pip will make the ``web3-gear`` command available on your machine (a running [thor](https://github.com/vechain/thor) client is required)\n\n```\nweb3-gear\n```\n\nThis will run web3-gear on `127.0.0.1:8545`.\n\nYou can change its default behavior with the following parameters:\n\n- **host**: rpc service host, eg: `--host 127.0.0.1`\n- **port**: rpc service port, eg: `--port 8545`\n- **endpoint**: thor restful service endpoint, eg: `--endpoint http://127.0.0.1:8669`\n- **keystore**: keystore file path, eg: `--keystore /Users/(username)/keystore)`, default=thor stand-alone(solo) built-in accounts\n- **passcode**: passcode of keystore, eg: `--passcode xxxxxxxx`\n- **debug**: bool default=false, whether to display debug logs, eg: `--debug true`\n- **log**: bool default=false, whether to display rpc logs, eg: `--log false`\n\n### Work with Remix\n\nChange the Remix environment to Web3 provide.\n\n### Work with Truffle\n\n* Truffle 4.0.6+ support\n\nModify the configuration of truffle first(`truffle.js`):\n\n```js\nmodule.exports = {\n    networks: {\n        development: {\n            host: \"localhost\",\n            port: 8545,\n            network_id: \"*\" // Match any network id\n        }\n    }\n};\n```\n\nThen you can use truffle's command line tool.\n\nThere are some projects based on truffle, can use them for testing:\n\n- [Crowdsale Contracts](https://github.com/vechain/crowdsale-contracts).\n- [Token Distribution](https://github.com/libotony/token-distribution).\n- [Solidity Idiosyncrasies](https://github.com/miguelmota/solidity-idiosyncrasies).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvechain%2Fweb3-gear","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvechain%2Fweb3-gear","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvechain%2Fweb3-gear/lists"}