https://github.com/diem/liquidity-emulator

A liquidity emulator to support the Diem reference projects
https://github.com/diem/liquidity-emulator

Last synced: about 2 months ago
JSON representation

A liquidity emulator to support the Diem reference projects

• Host: GitHub
• URL: https://github.com/diem/liquidity-emulator
• Owner: diem
• License: apache-2.0
• Created: 2020-09-29T18:45:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-15T08:02:05.000Z (almost 4 years ago)
• Last Synced: 2023-03-04T09:31:08.695Z (almost 2 years ago)
• Language: Python
• Homepage:
• Size: 87.9 KB
• Stars: 1
• Watchers: 45
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Liquidity Service Emulator

## Development

This project used the following tools:

- Flask as the HTTP server.

- Black for automatic code formatting.

- Flake8 for linting.

### Testnet setup

```shell script

pipenv install --dev

pipenv run pre-commit install

pipenv run python setup_env.py

./run.sh

```

The last command will install the git hooks that will run code formatting

and linting on each commit.

### Premainnet setup

Premainnet setup works identically to the testnet setup, but requires two

environment variables to be present: `BLOCKCHAIN` and `LIQUIDITY_ACCOUNT_PRIVATE_KEY`.

The value of `BLOCKCHAIN` must be `premainnet`; the value of

`LIQUIDITY_ACCOUNT_PRIVATE_KEY` must be the private key of the Designated

Dealer account, encoded as a hexadecimal string.

### PyCharm configuration

- Add Black to `Settings/Tools/File Watchers` as described in the [documentation][1].

### Helper scripts

- `run.sh` Starts the HTTP server

- `develop.sh` Starts the HTTP server with code auto-reloading.

- `lint.sh` Fix code formatting and run linting

[1]: https://black.readthedocs.io/en/stable/editor_integration.html