accounts

README

Settings service

Settings service provides private API for storing all configuration for a selected account.

To enable:

1. Client must ensure that settings db is initialized in the api.Backend.
2. Add settings to APIModules in config.

API

settings_saveConfig

Parameters

• type: string - configuratin type. if not unique error is raised.
• conf: bytes - raw json.

settings_getConfig

Parameters

• type: string

Returns

• conf raw json

settings_saveNodeConfig

Special case of the settings_saveConfig. In status-go we are using constant node-config as a type for node configuration. Application depends on this value and will try to load it when node is started. This method is provided in order to remove syncing mentioned constant between status-go and users.

Parameters

• conf: params.NodeConfig

Documentation

Index

• Variables
• type API
  • func NewAccountsAPI(db *accounts.Database, feed *event.Feed) *API
  • func (api *API) DeleteAccount(ctx context.Context, address common.Address) error
  • func (api *API) GetAccounts(ctx context.Context) ([]accounts.Account, error)
  • func (api *API) SaveAccounts(ctx context.Context, accounts []accounts.Account) error
• type MultiAccountsAPI
  • func NewMultiAccountsAPI(db *multiaccounts.Database, manager *account.Manager) *MultiAccountsAPI
  • func (api *MultiAccountsAPI) UpdateAccount(account multiaccounts.Account) error
• type Service
  • func NewService(db *accounts.Database, mdb *multiaccounts.Database, manager *account.Manager, ...) *Service
  • func (s *Service) APIs() []rpc.API
  • func (s *Service) Protocols() []p2p.Protocol
  • func (s *Service) Start(*p2p.Server) error
  • func (s *Service) Stop() error
• type SettingsAPI
  • func NewSettingsAPI(db *accounts.Database) *SettingsAPI
  • func (api *SettingsAPI) GetConfig(ctx context.Context, typ string) (json.RawMessage, error)
  • func (api *SettingsAPI) GetConfigs(ctx context.Context, types []string) (map[string]json.RawMessage, error)
  • func (api *SettingsAPI) SaveConfig(ctx context.Context, typ string, conf json.RawMessage) error
  • func (api *SettingsAPI) SaveNodeConfig(ctx context.Context, conf *params.NodeConfig) error

Variables

var (
	// ErrUpdatingWrongAccount raised if caller tries to update any other account except one used for login.
	ErrUpdatingWrongAccount = errors.New("failed to updating wrong account. please login with that account first")
)

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API is class with methods available over RPC.

func NewAccountsAPI

func NewAccountsAPI(db *accounts.Database, feed *event.Feed) *API

func (*API) DeleteAccount

func (api *API) DeleteAccount(ctx context.Context, address common.Address) error

func (*API) GetAccounts

func (api *API) GetAccounts(ctx context.Context) ([]accounts.Account, error)

func (*API) SaveAccounts

func (api *API) SaveAccounts(ctx context.Context, accounts []accounts.Account) error

type MultiAccountsAPI

type MultiAccountsAPI struct {
	// contains filtered or unexported fields
}

MultiAccountsAPI is class with methods available over RPC.

func NewMultiAccountsAPI

func NewMultiAccountsAPI(db *multiaccounts.Database, manager *account.Manager) *MultiAccountsAPI

func (*MultiAccountsAPI) UpdateAccount

func (api *MultiAccountsAPI) UpdateAccount(account multiaccounts.Account) error

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service is a browsers service.

func NewService

func NewService(db *accounts.Database, mdb *multiaccounts.Database, manager *account.Manager, feed *event.Feed) *Service

NewService initializes service instance.

func (*Service) APIs

func (s *Service) APIs() []rpc.API

APIs returns list of available RPC APIs.

func (*Service) Protocols

func (s *Service) Protocols() []p2p.Protocol

Protocols returns list of p2p protocols.

func (*Service) Start

func (s *Service) Start(*p2p.Server) error

Start a service.

func (*Service) Stop

func (s *Service) Stop() error

Stop a service.

type SettingsAPI

type SettingsAPI struct {
	// contains filtered or unexported fields
}

SettingsAPI is class with methods available over RPC.

func NewSettingsAPI

func NewSettingsAPI(db *accounts.Database) *SettingsAPI

func (*SettingsAPI) GetConfig

func (api *SettingsAPI) GetConfig(ctx context.Context, typ string) (json.RawMessage, error)

func (*SettingsAPI) GetConfigs

func (api *SettingsAPI) GetConfigs(ctx context.Context, types []string) (map[string]json.RawMessage, error)

func (*SettingsAPI) SaveConfig

func (api *SettingsAPI) SaveConfig(ctx context.Context, typ string, conf json.RawMessage) error

func (*SettingsAPI) SaveNodeConfig

func (api *SettingsAPI) SaveNodeConfig(ctx context.Context, conf *params.NodeConfig) error