Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 3.94 KB

portfolio_manager.md

File metadata and controls

66 lines (43 loc) · 3.94 KB
Raw

GoCryptoTrader package Portfolio manager

Build Status Software License GoDoc Coverage Status Go Report Card

This portfolio_manager package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Current Features for Portfolio manager

  • 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 bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
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"

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc