Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): update docker-compose commands to use 'docker compose' syntax #462

Merged
merged 1 commit into from
Dec 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/fassets/guides/1-deploy-fassets-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ To execute agent bot commands, use the `cli` profile with the `agent-bot` Docker
For example, to get the FAssets system running agents, use this command:

```bash
docker-compose --profile cli run agent-bot listAgents --fasset FASSET
docker compose --profile cli run agent-bot listAgents --fasset FASSET
```

Full reference for the agent bot commands can be found in the [Agent Bot CLI Reference](/fassets/reference/agent-bot).
Expand All @@ -220,7 +220,7 @@ To execute user bot commands, use the `cli` profile and the `user-bot` Docker co
For example, to retrieve FAsset system info, use this command:

```bash
docker-compose --profile cli run user-bot info --fasset FASSET
docker compose --profile cli run user-bot info --fasset FASSET
```

### Update the FAssets Agent
Expand All @@ -231,7 +231,7 @@ To restart and update the FAssets agent, run the following commands:
docker compose down
git pull
docker compose pull
docker-compose --profile cli run agent-bot listAgents --fasset FXRP
docker compose --profile cli run agent-bot listAgents --fasset FXRP
docker compose up -d
```

Expand Down
14 changes: 7 additions & 7 deletions docs/fassets/guides/3-create-fasset-agent-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You need to set up your agent's parameters like name, collateral, and fund with
1. Prepare the agent settings `tmp.agent-settings.json` exchanging `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you want to work on:

```bash
docker-compose --profile cli run agent-bot --fasset FASSET create --prepare
docker compose --profile cli run agent-bot --fasset FASSET create --prepare
```

2. Choose a suffix for your agent's collateral pool and fill in the `poolTokenSuffix` field in the `tmp.agent-settings.json`.
Expand All @@ -41,7 +41,7 @@ You need to set up your agent's parameters like name, collateral, and fund with
Exchange `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you are creating the agent.

```bash
docker-compose --profile cli run agent-bot --fasset FASSET create tmp.agent-settings.json
docker compose --profile cli run agent-bot --fasset FASSET create tmp.agent-settings.json
```

### Deposit Collateral
Expand All @@ -56,21 +56,21 @@ You have two options: either deposit the vault collateral and buy pool collatera
To deposit both vault and pool collateral together and let the tool calculate the minimum required collateral to back the lots, you can use the `depositCollateral` function to the agent, specifying your created agent address in the `AGENT_ADDRESS` and lot size in the `LOTS`, as well exchange `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you are creating the agent:

```bash
docker-compose --profile cli run agent-bot depositCollaterals AGENT_ADDRESS LOTS --fasset FASSET
docker compose --profile cli run agent-bot depositCollaterals AGENT_ADDRESS LOTS --fasset FASSET
```

#### Deposit Collateral Separately

1. Deposit enough vault collateral to the agent specifying your created agent address in the `AGENT_ADDRESS` and the amount of the stablecoin or wrapped ETH in the `AMOUNT` field, as well exchange `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you are creating the agent.

```bash
docker-compose --profile cli run agent-bot depositVaultCollateral AGENT_ADDRESS AMOUNT --fasset FASSET
docker compose --profile cli run agent-bot depositVaultCollateral AGENT_ADDRESS AMOUNT --fasset FASSET
```

2. Buy enough pool collateral for the agent specifying your agent's address in the `AGENT_ADDRESS` and the amount of the CFLR in the `CFLR_AMOUNT` field, as well exchange `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you are creating the agent.

```bash
docker-compose --profile cli run agent-bot buyPoolCollateral AGENT_ADDRESS CFLR_AMOUNT --fasset FASSET
docker compose --profile cli run agent-bot buyPoolCollateral AGENT_ADDRESS CFLR_AMOUNT --fasset FASSET
```

### Register the Agent as Available
Expand All @@ -80,13 +80,13 @@ You need to make your agent available to mint and redeem FAssets.
1. Register your agent as available to the network by executing this command replacing the `AGENT_ADDRESS` with your agent address, as well exchange `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you are entering the agent:

```bash
docker-compose --profile cli run agent-bot enter AGENT_ADDRESS --fasset FASSET
docker compose --profile cli run agent-bot enter AGENT_ADDRESS --fasset FASSET
```

2. If you deposited enough collateral, you should see that your agent has at least one lot available by running the command replacing `FASSET` with `FXRP`, `FBTC` or `FDOGE` according to which underlying network you are running the agent.

```bash
docker-compose --profile cli run user-bot agents --fasset FASSET
docker compose --profile cli run user-bot agents --fasset FASSET
```

If you don't have available lots, check if the vault and pool collaterals are enough.
Expand Down
4 changes: 2 additions & 2 deletions docs/fassets/reference/agent-bot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ To list all available commands:
yarn agent-bot help
```

To execute a specific command using the [Docker container](/fassets/guides/deploy-fassets-agent#execute-fasset-bot-commands) change `yarn agent-bot` with `docker-compose --profile cli run agent-bot`:
To execute a specific command using the [Docker container](/fassets/guides/deploy-fassets-agent#execute-fasset-bot-commands) change `yarn agent-bot` with `docker compose --profile cli run agent-bot`:

```bash
docker-compose --profile cli run agent-bot [command] <args> --fasset [fAssetSymbol]
docker compose --profile cli run agent-bot [command] <args> --fasset [fAssetSymbol]
```

## Owner and Agent Management
Expand Down
Loading