add default values, further refactor account-types vs account-ids

Author: conorpp

client/account.go

@@ -1,44 +1,17 @@
 package client
 
 import (
-	"path/filepath"
-	"strings"
-
 	oc "github.com/cordialsys/offchain"
 )
 
-// - accounts/funding
-// - accounts/trading
-// - accounts/x/subacounts/y
-
-// - core/funding
-// - core/trading
-// - core/margin
-
-type AccountName string
-type AccountType string
-
-// var CoreFunding AccountName = "core/funding"
-// var CoreTrading AccountName = "core/trading"
-// var CoreMargin AccountName = "core/margin"
-
-func (name AccountName) Id() string {
-	if strings.HasPrefix(string(name), "core/") {
-		return ""
-	}
-	return strings.TrimPrefix(string(name), "accounts/")
-}
-
-func NewAccountName(id string) AccountName {
-	return AccountName(filepath.Join("accounts", id))
-}
+type AccountId string
 
 type AccountTransferArgs struct {
-	from AccountName
-	to   AccountName
+	from AccountId
+	to   AccountId
 
-	fromType AccountType
-	toType   AccountType
+	fromType oc.AccountType
+	toType   oc.AccountType
 
 	symbol oc.SymbolId
 	amount oc.Amount
@@ -55,21 +28,21 @@ func NewAccountTransferArgs(symbol oc.SymbolId, amount oc.Amount) AccountTransfe
 	}
 }
 
-func (args *AccountTransferArgs) SetFrom(from AccountName, fromType AccountType) {
+func (args *AccountTransferArgs) SetFrom(from AccountId, fromType oc.AccountType) {
 	args.from = from
 	args.fromType = fromType
 }
 
-func (args *AccountTransferArgs) SetTo(to AccountName, toType AccountType) {
+func (args *AccountTransferArgs) SetTo(to AccountId, toType oc.AccountType) {
 	args.to = to
 	args.toType = toType
 }
 
-func (args *AccountTransferArgs) GetFrom() (AccountName, AccountType) {
+func (args *AccountTransferArgs) GetFrom() (AccountId, oc.AccountType) {
 	return args.from, args.fromType
 }
 
-func (args *AccountTransferArgs) GetTo() (AccountName, AccountType) {
+func (args *AccountTransferArgs) GetTo() (AccountId, oc.AccountType) {
 	return args.to, args.toType
 }
 

client/address.go

@@ -5,9 +5,9 @@ import (
 )
 
 type GetDepositAddressArgs struct {
-	symbol       oc.SymbolId
-	network      oc.NetworkId
-	accountMaybe AccountName
+	symbol     oc.SymbolId
+	network    oc.NetworkId
+	subaccount AccountId
 }
 
 func NewGetDepositAddressArgs(coin oc.SymbolId, network oc.NetworkId, options ...GetDepositAddressOption) GetDepositAddressArgs {
@@ -30,19 +30,18 @@ func (args *GetDepositAddressArgs) GetNetwork() oc.NetworkId {
 	return args.network
 }
 
-func (args *GetDepositAddressArgs) GetAccount() (AccountName, bool) {
-	return args.accountMaybe, args.accountMaybe != ""
-}
-
-func (args *GetDepositAddressArgs) GetAccountId() (string, bool) {
-	id := args.accountMaybe.Id()
-	return id, id != ""
+func (args *GetDepositAddressArgs) GetSubaccount() (AccountId, bool) {
+	return args.subaccount, args.subaccount != ""
 }
 
 type GetDepositAddressOption func(args *GetDepositAddressArgs)
 
-func WithAccount(account AccountName) GetDepositAddressOption {
+func WithSubaccount(subaccount AccountId) GetDepositAddressOption {
 	return func(args *GetDepositAddressArgs) {
-		args.accountMaybe = account
+		args.subaccount = subaccount
 	}
 }
+
+func (args *GetDepositAddressArgs) SetSubaccount(subaccount AccountId) {
+	args.subaccount = subaccount
+}

client/balance.go

@@ -1,15 +1,21 @@
 package client
 
+import oc "github.com/cordialsys/offchain"
+
 type GetBalanceArgs struct {
-	accountType AccountType
+	accountType oc.AccountType
 }
 
-func NewGetBalanceArgs(accountType AccountType) GetBalanceArgs {
+func NewGetBalanceArgs(accountType oc.AccountType) GetBalanceArgs {
 	return GetBalanceArgs{
 		accountType: accountType,
 	}
 }
 
-func (args *GetBalanceArgs) GetAccountType() AccountType {
+func (args *GetBalanceArgs) GetAccountType() oc.AccountType {
 	return args.accountType
 }
+
+func (args *GetBalanceArgs) SetAccountType(accountType oc.AccountType) {
+	args.accountType = accountType
+}

cmd/oc/config.go

@@ -3,7 +3,7 @@ package main
 import (
 	"fmt"
 
-	"github.com/cordialsys/offchain/loader"
+	oc "github.com/cordialsys/offchain"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v3"
 )
@@ -15,7 +15,7 @@ func NewConfigCmd() *cobra.Command {
 		Use:          "config",
 		Short:        "Print out the current config",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			config, err := loader.LoadConfig(configPath)
+			config, err := oc.LoadConfig(configPath)
 			if err != nil {
 				return err
 			}
@@ -32,7 +32,7 @@ func NewConfigCmd() *cobra.Command {
 		"config",
 		"c",
 		"",
-		fmt.Sprintf("path to the config file (may set %s)", loader.ENV_OFFCHAIN_CONFIG),
+		fmt.Sprintf("path to the config file (may set %s)", oc.ENV_OFFCHAIN_CONFIG),
 	)
 	return cmd
 }

cmd/oc/exchange/account_transfer.go

@@ -23,7 +23,7 @@ func NewAccountTransferCmd() *cobra.Command {
 		Short:        "Transfer funds between accounts on exchange",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			exchangeConfig, secrets := unwrapAccountConfig(cmd.Context())
-			cli, err := loader.NewClient(exchangeConfig.ExchangeId, &exchangeConfig.ExchangeClientConfig, secrets)
+			cli, err := loader.NewClient(exchangeConfig, secrets)
 			if err != nil {
 				return err
 			}
@@ -38,14 +38,21 @@ func NewAccountTransferCmd() *cobra.Command {
 				return fmt.Errorf("--symbol is required")
 			}
 
+			fromType, ok, message := exchangeConfig.ResolveAccountType(fromType)
+			if !ok {
+				return fmt.Errorf("%s", message)
+			}
+			toType, ok, message := exchangeConfig.ResolveAccountType(toType)
+			if !ok {
+				return fmt.Errorf("%s", message)
+			}
 			transferArgs := client.NewAccountTransferArgs(
-				// client.AccountName(from),
-				// client.AccountName(to),
 				oc.SymbolId(symbol),
 				amount,
 			)
-			transferArgs.SetFrom(client.AccountName(from), client.AccountType(fromType))
-			transferArgs.SetTo(client.AccountName(to), client.AccountType(toType))
+
+			transferArgs.SetFrom(client.AccountId(from), fromType.Type)
+			transferArgs.SetTo(client.AccountId(to), toType.Type)
 
 			resp, err := cli.CreateAccountTransfer(transferArgs)
 			if err != nil {

cmd/oc/exchange/cmd.go

@@ -8,7 +8,6 @@ import (
 
 	oc "github.com/cordialsys/offchain"
 	"github.com/cordialsys/offchain/cmd"
-	"github.com/cordialsys/offchain/loader"
 	"github.com/spf13/cobra"
 )
 
@@ -51,7 +50,7 @@ func NewExchangeCmd() *cobra.Command {
 		SilenceUsage: true,
 		PersistentPreRunE: func(preCmd *cobra.Command, args []string) error {
 			cmd.SetVerbosityFromCmd(preCmd)
-			config, err := loader.LoadConfig(configPath)
+			config, err := oc.LoadConfig(configPath)
 			if err != nil {
 				return err
 			}
@@ -103,7 +102,7 @@ func NewExchangeCmd() *cobra.Command {
 	cmd.AddCommand(NewGetDepositAddressCmd())
 	cmd.AddCommand(NewListWithdrawalHistoryCmd())
 	cmd.AddCommand(NewListSubaccountsCmd())
-
+	cmd.AddCommand(NewListAccountTypesCmd())
 	cmd.PersistentFlags().StringVarP(
 		&exchange,
 		"exchange",
@@ -125,7 +124,7 @@ func NewExchangeCmd() *cobra.Command {
 		"config",
 		"c",
 		"",
-		fmt.Sprintf("path to the config file (may set %s)", loader.ENV_OFFCHAIN_CONFIG),
+		fmt.Sprintf("path to the config file (may set %s)", oc.ENV_OFFCHAIN_CONFIG),
 	)
 
 	return cmd

cmd/oc/exchange/get_assets.go

@@ -12,7 +12,7 @@ func NewGetAssetsCmd() *cobra.Command {
 		Short:        "list the asset symbols and networks of the exchange",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			exchangeConfig, secrets := unwrapAccountConfig(cmd.Context())
-			cli, err := loader.NewClient(exchangeConfig.ExchangeId, &exchangeConfig.ExchangeClientConfig, secrets)
+			cli, err := loader.NewClient(exchangeConfig, secrets)
 			if err != nil {
 				return err
 			}

cmd/oc/exchange/get_balances.go

@@ -1,28 +1,46 @@
 package exchange
 
 import (
+	"fmt"
+
+	oc "github.com/cordialsys/offchain"
 	"github.com/cordialsys/offchain/client"
 	"github.com/cordialsys/offchain/loader"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 func NewListBalancesCmd() *cobra.Command {
-	var account string
+	var accountType string
 	cmd := &cobra.Command{
 		SilenceUsage: true,
 		Use:          "balances",
 		Short:        "List your balances on the exchange",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			exchangeConfig, secrets := unwrapAccountConfig(cmd.Context())
-			cli, err := loader.NewClient(exchangeConfig.ExchangeId, &exchangeConfig.ExchangeClientConfig, secrets)
+			cli, err := loader.NewClient(exchangeConfig, secrets)
 			if err != nil {
 				return err
 			}
-			accountType := client.AccountType("") //client.CoreFunding
-			if account != "" {
-				accountType = client.AccountType(account)
+			balanceArgs := client.NewGetBalanceArgs("")
+			if accountType != "" {
+				at, ok, message := exchangeConfig.ResolveAccountType(accountType)
+				if !ok {
+					return fmt.Errorf("%s", message)
+				}
+				balanceArgs.SetAccountType(at.Type)
+			} else {
+				// try taking the first account type
+				defaults, ok := oc.GetDefaultConfig(exchangeConfig.ExchangeId)
+				if ok {
+					if len(defaults.AccountTypes) > 0 {
+						logrus.WithFields(logrus.Fields{
+							"type": defaults.AccountTypes[0].Type,
+						}).Infof("using default account type")
+						balanceArgs.SetAccountType(defaults.AccountTypes[0].Type)
+					}
+				}
 			}
-			balanceArgs := client.NewGetBalanceArgs(accountType)
 
 			assets, err := cli.ListBalances(balanceArgs)
 			if err != nil {
@@ -33,10 +51,10 @@ func NewListBalancesCmd() *cobra.Command {
 		},
 	}
 	cmd.Flags().StringVar(
-		&account,
-		"account",
+		&accountType,
+		"type",
 		"",
-		"the account to get balances for",
+		"the account type to get balances for",
 	)
 	return cmd
 }

cmd/oc/exchange/get_deposit_address.go

@@ -12,14 +12,14 @@ import (
 func NewGetDepositAddressCmd() *cobra.Command {
 	var symbol string
 	var network string
-	var account string
+	var subaccount string
 	cmd := &cobra.Command{
 		SilenceUsage: true,
 		Use:          "deposit",
 		Short:        "Get a deposit address for a symbol and network",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			exchangeConfig, secrets := unwrapAccountConfig(cmd.Context())
-			cli, err := loader.NewClient(exchangeConfig.ExchangeId, &exchangeConfig.ExchangeClientConfig, secrets)
+			cli, err := loader.NewClient(exchangeConfig, secrets)
 			if err != nil {
 				return err
 			}
@@ -31,8 +31,8 @@ func NewGetDepositAddressCmd() *cobra.Command {
 			}
 
 			options := []client.GetDepositAddressOption{}
-			if account != "" {
-				options = append(options, client.WithAccount(client.AccountName(account)))
+			if subaccount != "" {
+				options = append(options, client.WithSubaccount(client.AccountId(subaccount)))
 			}
 
 			resp, err := cli.GetDepositAddress(client.NewGetDepositAddressArgs(
@@ -50,6 +50,6 @@ func NewGetDepositAddressCmd() *cobra.Command {
 	}
 	cmd.Flags().StringVar(&symbol, "symbol", "", "The symbol to withdraw")
 	cmd.Flags().StringVar(&network, "network", "", "The network to transact on")
-	cmd.Flags().StringVar(&account, "account", "", "The account to get the deposit address for (optional)")
+	cmd.Flags().StringVar(&subaccount, "for", "", "The subaccount to get the deposit address for, when using the main account to query (optional)")
 	return cmd
 }