Files
gocryptotrader/cmd/documentation/engine_templates/portfolio_manager.tmpl
Adrian Gallagher ba92ba3254 docs: Add CODING_GUIDELINES.md and other adjustments (#1988)
* docs: Create new CODING_GUIDELINES doc

Rids excess contribution instructions from other packages
Adds AGENTS.md file for the AI overlords
Rids unused templates
Updates ADD_NEW_EXCHANGE.md with minor fixes

* docs: Fix linter issues and minor adjustments based on Copilot feedback

* docs: Update coding guidelines for API parameters and testing practices

* docs: Remove redundant GoDoc references

Adds copilot-instructions.md

* docs: Update CODING_GUIDELINES with export recommendations and test commentary

* docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links

* docs: Update struct naming conventions for request and response types

* docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md

* refactor: Simplify error handling in QueryOrder method
2025-08-08 12:10:53 +10:00

30 lines
1.5 KiB
Cheetah

{{define "engine portfolio_manager" -}}
{{template "header" .}}
## Current Features for {{.CapitalName}}
+ The portfolio manager subsystem is used to synchronise and monitor wallet addresses
+ It can read addresses specified in your config file
+ If you have set API keys for an enabled exchange and enabled `authenticatedSupport`, it will store your exchange addresses
+ In order to modify the behaviour of the portfolio manager subsystem, you can edit the following inside your config file under `portfolioAddresses`:
### portfolioAddresses
| Config | Description | Example |
| ------ | ----------- | ------- |
| Verbose | Enabling this will output more detailed logs to your logging output | `false` |
| addresses | An array of portfolio wallet addresses to monitor, see below table | |
### addresses
| Config | Description | Example |
| ------ | ----------- | ------- |
| Address | The wallet address | `{{.DonationAddress}}` |
| CoinType | The coin for the wallet address | `BTC` |
| Balance | The balance of the wallet | |
| Description | A customisable description | `My secret billion stash` |
| WhiteListed | Determines whether GoCryptoTrader withdraw manager subsystem can make withdrawals from this address | `true` |
| ColdStorage | Describes whether the wallet address is a cold storage wallet eg Ledger | `false` |
| SupportedExchanges | A comma delimited string of which exchanges are allowed to interact with this wallet | `"Binance"` |
{{template "donations" .}}
{{end}}