Lisk DEX: Service is a web application middleware that allows the Lisk DEX: UI to interact with the Lisk DEX: Core blockchain application. The project is based on upon Lisk Service which is a Microservices-based implementation.
Below is an index of the repositories which relate to this repository for easy navigation:
| Repository | Description | |
|---|---|---|
| Lisk DEX: Specs | The Lisk DEX blockchain specifications. | |
| Lisk DEX: Core | The Lisk DEX blockchain application. | |
| X | Lisk DEX: Service | The Lisk DEX blockchain middleware between Core and UI. |
| Lisk DEX: UI | The Lisk DEX blockchain user-interface. |
Lisk DEX: Service adds the following microservices to the base set inherited from Lisk Service:
| Service | Description |
|---|---|
| DEX Base | The DEX Base service provides data related to liquidity provision and swaps, such as current pools, tokens, and prices. |
| DEX Goverance | The DEX Governance service provides data on proposals and votes which have been submitted to the DEX blockchain. |
| DEX Information | The DEX Information service provides statistical data about the DEX blockchain, such as top pools, top tokens, and past swaps. |
Lisk DEX: Service extends the Gateway microservice with additional API endpoints that are specific to the Lisk DEX: Core blockchain application.
Below is a summary of the additional API endpoints:
GET /api/dex/v1/getEventsByHeight- Returns a list of events by height.
GET /api/dex/v1/tokens/popularPairings- Returns a list of the top 6 frequently swapped token pairs.
GET /api/dex/v1/tokens/currentsqrtprice- Returns the current sqrt price of a given pool.
GET /api/dex/v1/prices/gettingSlippageBounds- Returns the slippage bounds for a given swap.
GET /api/dex/v1/gettingStatistics- Returns statistics for transactions.
GET /api/dex/v1/pools/available- Returns a list of available pools.
GET /api/dex/v1/prices/convert/token- Converts a token price to the equivalent amount of another token price.
GET /api/dex/v1/prices/impact- Returns the price impact on a swap trade on the market price of the pool.
GET /api/dex/v1/prices/convert/fiat- Converts a token price to the equivalent amount of fiat.
GET /api/dex/v1/tokens/supported- Returns a list of supported tokens.
GET /api/dex-governance/v1/proposals- Returns all proposals, or a specific proposal if it was specified.
GET /api/dex-governance/v1/votes- Returns details about the votes for a given account.
GET /api/dex-information/v1/getTopPoolsFromDatabase- Returns a list of top pools from the database.
GET /api/dex-information/v1/getTopTokensFromDatabase- Returns a list of top tokens from the database.
GET /api/dex-information/v1/getTransactionsByTokenID- Returns a list of transactions by tokenID.
The default installation method for Lisk DEX: Service is using Docker.
The following dependencies need to be installed in order to run this application:
For information on how to install these dependencies on various operating systems, refer to the following documents:
To build the docker images, execute the following command:
make build-imagesThe default configuration is sufficient to run Lisk DEX: Service against a local node.
Before running the application, copy the default docker-compose environment file:
cp docker/example.env .envAs required, set the required environment variables.
$EDITOR .envThe various configuration options are described in this document.
The current configuration can be reviewed with the command: make print-config.
To run the application container, execute the following command:
make upOnce the application container is started, Lisk DEX: Service (Gateway) is exposed accordingly:
http://localhost:9901 # HTTP API
ws://localhost:9901 # WebSocket RPCTo stop the application container, execute the following command:
make downhttps://github.com/LiskHQ/lisk-dex-service/graphs/contributors
Warning
The source code of Lisk DEX: Service is considered to be a pre-release beta version that is subject to missing or incomplete features, bugs, and potential security flaws, and is therefore not suitable for usage in a production environment such as the Lisk Mainnet.
By using the source code of Lisk DEX: Service, you acknowledge and agree that you have an adequate understanding of the risks associated with the use of the source code of Lisk DEX: Service and that it is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. To the fullest extent permitted by law, in no event shall the Lisk Foundation or other parties involved in the development of Lisk DEX: Service have any liability whatsoever to any person for any direct or indirect loss, liability, cost, claim, expense or damage of any kind, whether in contract or in tort, including negligence, or otherwise, arising out of or related to the use of all or part of the source code of Lisk DEX: Service.
Copyright 2016-2024 Lisk Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.