Skip to content

Commit 4b1546d

Browse files
authored
Liquidity Provider Doc Updates (#56)
* Upgraded Yarn packages due to outdated package with SSL vulnerability * Doc adjustments: Latest docker compose compatibility + tips and warnings + create market wrong command fix
1 parent 6bb30c5 commit 4b1546d

File tree

3 files changed

+4455
-5323
lines changed

3 files changed

+4455
-5323
lines changed

docs/provider/daemon/getting_started/run_docker.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@ title: 'Run with Docker'
33
sidebar_position: 2
44
---
55

6+
:::tip
7+
Ensure the server has at least 2GB of available memory, to avoid running into any out of memory exceptions.
8+
:::
9+
610
The easiest way to serve your daemon as a dockerized application is by using `docker compose` so you can well orchestrate your wallet and daemon instances. You can find a similar version of the following `docker-compose.yml` file in the [github repository](https://github.com/tdex-network/tdex-daemon/tree/v1/resources/compose/docker-compose.yml):
711

812
```yml
9-
version: "3.7"
10-
1113
services:
1214
oceand:
1315
container_name: oceand
@@ -26,8 +28,8 @@ services:
2628
ports:
2729
- "18000:18000"
2830
volumes:
29-
- volumes/oceand:/home/ocean/.ocean-wallet
30-
- volumes/ocean-cli:/home/ocean/.ocean-cli
31+
- ./volumes/oceand:/home/ocean/.ocean-wallet
32+
- ./volumes/ocean-cli:/home/ocean/.ocean-cli
3133
tdexd:
3234
container_name: tdexd
3335
image: ghcr.io/tdex-network/tdexd:latest
@@ -43,8 +45,8 @@ services:
4345
- "9000:9000"
4446
- "9945:9945"
4547
volumes:
46-
- volumes/tdexd:/home/tdex/.tdex-daemon
47-
- volumes/tdex-cli:/home/tdex/.tdex-operator
48+
- ./volumes/tdexd:/home/tdex/.tdex-daemon
49+
- ./volumes/tdex-cli:/home/tdex/.tdex-operator
4850
oceand-db:
4951
container_name: oceand-db
5052
image: postgres
@@ -78,13 +80,13 @@ Place this file in your preferred folder and name it `docker-compose.yml`, take
7880
You're now ready to start up the services. First of all, let's start the ocean services:
7981

8082
```bash
81-
$ docker-compose up -d oceand-db oceand
83+
$ docker compose up -d oceand-db oceand
8284
```
8385

8486
You can inspect the status of the service by running `docker ps` - don't be afraid if oceand gives errors at this stage, it can happen depending on how fast the db startup phase is. Once both services are up and running you can start up your provider service:
8587

8688
```bash
87-
$ docker-compose up -d tdexd
89+
$ docker compose up -d tdexd
8890
```
8991

9092
That's it! You just started your provider served as docker container. What's next? You can get some insights about [the daemon's configuration](configure_daemon.md), or you can take a look at how to [configure the CLI](configure_cli.md) to setup your markets, deposit and withdraw funds and even more cool stuff.

docs/provider/daemon/market_account.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ These are all the properties you can define for every market you create, some of
1717
## Create a market
1818

1919
```bash
20-
$ tdex market create \
20+
$ tdex market new \
2121
--base-asset 144c654344aa716d6f3abcc1ca90e5641e4e2a7f633bc09fe3baf64585819a49 \
2222
--quote-asset f3d1ec678811398cd2ae277cbe3849c6f6dbd72c74bc542f7c4b11ff0e820958 \
2323
--base-asset-precision 8 --quote-asset-precision 8 \
@@ -40,6 +40,12 @@ $ tdex config set quote_asset f3d1ec678811398cd2ae277cbe3849c6f6dbd72c74bc542f7c
4040

4141
All the commands that follow require both `base_asset` and `quote_asset` to be set in your CLI's config file. If you have created multiple markets and you need to switch between them, it's enough to change base and/or quote asset with the `tdex config set` command.
4242

43+
:::tip
44+
You may look up assets hashes available on the liquid network from the following [link](https://liquid.network/assets/featured).
45+
46+
Asset hashes will vary between mainnet and testnet, so ensure to accomodate accordingly.
47+
:::
48+
4349
## Deposit funds
4450

4551
Just like any other account, let's derive some new addresses to deposit base/quote asset funds to the market:
@@ -131,6 +137,13 @@ Once you're good with your market configuration and the funds are confirmed, you
131137
$ tdex market open
132138
```
133139

140+
:::caution
141+
142+
The market account needs to be funded with both the base and quote assets. Otherwise, trying to retrieve price information or perform swaps will results in errors.
143+
144+
:::
145+
146+
134147
## Get trading report
135148

136149
You can get a report of the trading activity of your market in a certain time period. This reports includes info like the trading volume and the total amount earned (collected fees).

0 commit comments

Comments
 (0)