catapult-rest
Catapult REST gateway combines HTTP and WebSockets to perform read and write actions on the blockchain.
Requirements
- NodeJS version 8 or 9
- yarn dependency manager
- catapult-server configured as an API node.
Installation
- Edit
rest/resources/rest.jsonconfiguration:
| Parameter | Description | Example |
|---|---|---|
| clientPrivateKey | REST client private key. | 000...000 |
| db.url | MongoDB connection URL. | mongodb://localhost:27017/ |
| apiNode.host | API node connection host. | 127.0.0.1 |
| apiNode.port | API node connection port. | 7900 |
| api.publicKey | API node public key. | FFFF...FFF |
| websocket.mq.host | ZeroMQ connection host. | 127.0.0.1 |
| websocket.mq.port | ZeroMQ connection port. | 7902 |
Note: catapult-rest has to reach the API node, ZeroMQ and MongoDB ports. If you are running catapult-server on a VPS, you can bind the ports to your local development environment creating an SSH tunnel:
ssh -L 27017:localhost:27017 -L 7900:localhost:7900 -L 7902:localhost:7902 -p 2357 <USER>@<VPS_IP>
- Install the project's dependencies:
./yarn_setup.sh
- Run catapult-rest:
cd rest
yarn start resources/rest.json
Usage
Please refer to the documentation for more information.
Contributing
Before contributing please read this and consider the following guidelines:
- Submit small and concise PRs that address a single and clear feature or issue
- Submit only fully tested code
- Split test scope areas with Arrange/Act/Assert comments
- Use spontaneous comments only when necessary
- Follow linting rules - tests are set to fail if those aren't followed
- Notify or update related API resources of accepted changes (OpenApi)
License
Copyright (c) 2018 Jaguar0625, gimre, BloodyRookie, Tech Bureau, Corp Licensed under the GNU Lesser General Public License v3