wallet

Documentation

Index

• func BalanceFor(addr string, tid *types.TokenID, db storage.Table) (uint64, error)
• func FetchUtxosOf(addr string, tid *types.TokenID, total uint64, forBalance bool, ...) ([]*rpcpb.Utxo, error)
• func ReadPassphraseStdin() (string, error)
• type Config
• type LiveUtxoCache
  • func NewLiveUtxoCache() *LiveUtxoCache
  • func (cache *LiveUtxoCache) Add(op *types.OutPoint)
  • func (cache *LiveUtxoCache) Contains(op *types.OutPoint) bool
  • func (cache *LiveUtxoCache) Count() int
  • func (cache *LiveUtxoCache) Del(op ...*types.OutPoint)
  • func (cache *LiveUtxoCache) SetLiveDuration(expired int)
  • func (cache *LiveUtxoCache) Shrink()
• type Manager
  • func NewWalletManager(path string) (*Manager, error)
  • func (wlt *Manager) DumpPrivKey(address, passphrase string) (string, error)
  • func (wlt *Manager) GetAccount(pubKeyHash string) (account *acc.Account, exist bool)
  • func (wlt *Manager) ListAccounts() []*acc.Account
  • func (wlt *Manager) NewAccount(passphrase string) (string, error)
  • func (wlt *Manager) NewAccountWithPrivKey(privKey *crypto.PrivateKey, passphrase string) (string, error)
  • func (wlt *Manager) Sign(msg []byte, pubKeyHash, passphrase string) ([]byte, error)
• type Server
  • func NewServer(parent goprocess.Process, config *Config, s storage.Storage, bus eventbus.Bus) (*Server, error)
  • func (w *Server) Balance(addr string, tokenID *types.TokenID) (uint64, error)
  • func (w *Server) Proc() goprocess.Process
  • func (w *Server) Run() error
  • func (w *Server) Stop()
  • func (w *Server) Utxos(addr string, tokenID *types.TokenID, amount uint64) ([]*rpcpb.Utxo, error)

Functions

func BalanceFor

func BalanceFor(addr string, tid *types.TokenID, db storage.Table) (uint64, error)

BalanceFor returns balance amount of an address using balance index

func FetchUtxosOf

func FetchUtxosOf(
	addr string, tid *types.TokenID, total uint64, forBalance bool, db storage.Table,
) ([]*rpcpb.Utxo, error)

FetchUtxosOf fetches utxos from db NOTE: if total is 0, fetch all utxos NOTE: if tokenID is nil, fetch box utxos

func ReadPassphraseStdin

func ReadPassphraseStdin() (string, error)

ReadPassphraseStdin reads passphrase from stdin without echo passphrase into terminal

Types

type Config

type Config struct {
	Enable        bool `mapstructure:"enable"`
	CacheSize     int  `mapstructure:"cache_size"`
	UtxoCacheTime int  `mapstructure:"utxo_cache_time"`
}

Config contains config information for wallet server

type LiveUtxoCache

type LiveUtxoCache struct {
	sync.RWMutex

	Op2ts map[types.OutPoint]int64
	// contains filtered or unexported fields
}

LiveUtxoCache defines a cache in that utxos keep alive

func NewLiveUtxoCache

func NewLiveUtxoCache() *LiveUtxoCache

NewLiveUtxoCache new a LiveUtxoCache instance with expired seconds

func (*LiveUtxoCache) Add

func (cache *LiveUtxoCache) Add(op *types.OutPoint)

Add adds a OutPoint to cache

func (*LiveUtxoCache) Contains

func (cache *LiveUtxoCache) Contains(op *types.OutPoint) bool

Contains return whether OutPoint is in cache

func (*LiveUtxoCache) Count

func (cache *LiveUtxoCache) Count() int

Count returns OutPoint count

func (*LiveUtxoCache) Del

func (cache *LiveUtxoCache) Del(op ...*types.OutPoint)

Del deletes a OutPoint in cache

func (*LiveUtxoCache) SetLiveDuration

func (cache *LiveUtxoCache) SetLiveDuration(expired int)

SetLiveDuration sets live duration

func (*LiveUtxoCache) Shrink

func (cache *LiveUtxoCache) Shrink()

Shrink shrinks phase out OutPoints

type Manager

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

Manager is a directory based type to manipulate account Operation add/delete/query, import/export and sign are supported

func NewWalletManager

func NewWalletManager(path string) (*Manager, error)

NewWalletManager creates a wallet manager from files in the path

func (*Manager) DumpPrivKey

func (wlt *Manager) DumpPrivKey(address, passphrase string) (string, error)

DumpPrivKey returns an account's private key bytes in hex string format

func (*Manager) GetAccount

func (wlt *Manager) GetAccount(pubKeyHash string) (account *acc.Account, exist bool)

GetAccount checks if this Manager contains this public key and returns the related account if it exists

func (*Manager) ListAccounts

func (wlt *Manager) ListAccounts() []*acc.Account

ListAccounts returns all the addresses of keystore files in directory

func (*Manager) NewAccount

func (wlt *Manager) NewAccount(passphrase string) (string, error)

NewAccount creates a ecdsa key pair and store them in a file encrypted by the passphrase user entered returns a hexstring format public key hash, address and error

func (*Manager) NewAccountWithPrivKey

func (wlt *Manager) NewAccountWithPrivKey(privKey *crypto.PrivateKey, passphrase string) (string, error)

NewAccountWithPrivKey store the give private key in a file encrypted by the passphrase user entered returns a hexstring format public key hash, address and error

func (*Manager) Sign

func (wlt *Manager) Sign(msg []byte, pubKeyHash, passphrase string) ([]byte, error)

Sign create signature of message bytes using private key related to input public key

type Server

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

Server is the struct type of an wallet service

func NewServer

func NewServer(parent goprocess.Process, config *Config, s storage.Storage,
	bus eventbus.Bus) (*Server, error)

NewServer creates an Server instance using config and storage

func (*Server) Balance

func (w *Server) Balance(addr string, tokenID *types.TokenID) (uint64, error)

Balance returns the total balance of an address

func (*Server) Proc

func (w *Server) Proc() goprocess.Process

Proc returns then go process of the wallet server

func (*Server) Run

func (w *Server) Run() error

Run starts Server main loop

func (*Server) Stop

func (w *Server) Stop()

Stop terminate the Server process

func (*Server) Utxos

func (w *Server) Utxos(addr string, tokenID *types.TokenID, amount uint64) (
	[]*rpcpb.Utxo, error)

Utxos returns all utxos of an address NOTE: return all utxos of addr if amount is equal to 0