Files
gocryptotrader/engine/portfolio_manager.md
Gareth Kirwan b4e45e9a1b Websocket: Restructure files and types (#1859)
* Websocket: Rename stream package

* Websocket: Rename Websocket to Manager

* Websocket: Replace explicit errs with common.NilGuard

* Websocket: Move websocket_types.go to types.go

* Websocket: Minor field comment and alignment in types

* Webosocket: Rename WebsocketConnection to Connection

* Alphapoint: Make gorilla ws import explicit

Just to avoid confusion with our own packages.

* Websocket: Move stream_match to match

* Websocket: Move websocket_connection to connection

* Websocket: Move websocket.go to manager.go

* Websocket: Break out all subscription methods into subscriptions.go

* Websocket: Move connection type into its file

* Websocket: Remove PositionUpdated

Type is not used anywhere

* Kraken: Use local constant for pong

Was the only use of websocket.Pong and doesn't really feel right to
represent kraken's api resp in one of our packages

* Websocket: Move connection sub-types to connection package

* Websocket: Move manager types into manager

* Websocket: Move ConnectionWrapper into manager

* Websocket: Move websocket_test to manager_test

* Websocket: Privatise connectionWrapper

* Websocket: Remaining types into types.go

These really belong somewhere else mostly, but this will do for now

* Websocket: Tidy up connection method vars

* Gofumpt: Moving package imports around

* Websocket: Rename errDuplicateConnectionSetup

* Websocket: Fix duplicate import of gws

* Websocket: Fix gofumpt -extra

* Websocket: Standardise import of gws across other pkgs

* Kraken: Remove unused sub conf consts

These were replaced by the generic Levels and Depth fields on all subs

* Websocket: Privitise ConnectioWrapper fields

* Websocket: inline single use var WebsocketNotAuthenticatedUsingRest

* Websocket: Move documentation to template

* Bithumb: Assertify TestWsHandleData
2025-04-10 16:25:02 +10:00

3.9 KiB

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 our GoCryptoTrader Kanban board.

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