Meter-gear

Proxy Meter's RESTful API to Eth JSON-RPC, to support Remix, Truffle and more (You should give priority to using Meter's RESTful API).

Quick Start

Installation

On OS X

• Python 3.8+ 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 Meter-Gear and it's dependent Python packages via PyPI

   pip3 install meter-gear
   

On Ubuntu

• Python 3.8+ support

1. Install the system-dependecies

   sudo apt-get install build-essential libssl-dev python-dev
   

2. Use a virtual environment to isolate your meter-gear project

   python3 -m venv meter-venv
   source meter-venv/bin/activate
   

3. Installation of Meter-Gear and it's dependent Python packages via PyPI

   pip3 install meter-gear
   

Note that you can activate and deactivate your virtual environment now

source meter-venv/bin/activate
deactivate

See https://docs.python.org/3/library/venv.html for more information

On Windows

• Python 3.8+ support

1. Install Visual C++ Build Tools.

2. Installation of Meter-Gear and it's dependent Python packages via PyPI

   pip3 install meter-gear
   

Run

Installing through pip will make the meter-gear command available on your machine (must run meter client first.)

meter-gear

This will run meter-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: meter restful service endpoint, eg: --endpoint http://127.0.0.1:8669
• keystore: keystore file path, eg: --keystore /Users/(username)/keystore), default=meter 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

Use Remix

Change the Remix environment to Web3 provide.

Use Truffle

• Truffle 4.0.6+ support

Modify the configuration of truffle first(truffle.js):

module.exports = {
    networks: {
        development: {
            host: "localhost",
            port: 8545,
            network_id: "*" // Match any network id
        }
    }
};

Then you can use truffle's command line tool.