wallet

type Account struct {
	// DCR fields
	ExternalKeyCount int32
	InternalKeyCount int32
	ImportedKeyCount int32

	// BTC fields
	AccountProperties

	// Has some fields common to both BTC and DCR
	WalletID int
	Balance  *Balance
	Number   int32
	Name     string
}

type AccountProperties struct {
	// AccountNumber is the internal number used to reference the account.
	AccountNumber uint32

	// AccountName is the user-identifying name of the account.
	AccountName string

	// ExternalKeyCount is the number of internal keys that have been
	// derived for the account.
	ExternalKeyCount uint32

	// InternalKeyCount is the number of internal keys that have been
	// derived for the account.
	InternalKeyCount uint32

	// ImportedKeyCount is the number of imported keys found within the
	// account.
	ImportedKeyCount uint32

	// AccountPubKey is the account's public key that can be used to
	// derive any address relevant to said account.
	//
	// NOTE: This may be nil for imported accounts.
	AccountPubKey *btchdkeychain.ExtendedKey // TODO: support LTC

	// MasterKeyFingerprint represents the fingerprint of the root key
	// corresponding to the master public key (also known as the key with
	// derivation path m/). This may be required by some hardware wallets
	// for proper identification and signing.
	MasterKeyFingerprint uint32

	// KeyScope is the key scope the account belongs to.
	KeyScope KeyScope

	// IsWatchOnly indicates whether the is set up as watch-only, i.e., it
	// doesn't contain any private key information.
	IsWatchOnly bool

	// AddrSchema, if non-nil, specifies an address schema override for
	// address generation only applicable to the account.
	AddrSchema *ScopeAddrSchema
}

type Accounts struct {
	Accounts           []*Account
	CurrentBlockHash   []byte
	CurrentBlockHeight int32
}

type AddressDiscoveryProgressReport struct {
	*GeneralSyncProgress
	AddressDiscoveryStartTime int64
	TotalDiscoveryTimeSpent   int64
	AddressDiscoveryProgress  int32 `json:"addressDiscoveryProgress"`
}

type AddressType uint8

type Amount struct {
	// UnitValue holds the base monetary unit value for a cryptocurrency.
	// The field is currently used for both BTC, LTC and DCR.
	// For Decred it holds the number of Atoms per DCR.
	// For Bitcoin it holds the number of satoshis per BTC.
	// For Litecoin it holds the number of litoshis per LTC.
	UnitValue int64
	// CoinValue holds the monetary amount counted in a cryptocurrency base
	// units, converted to a floating point value representing the amount
	// of said cryptocurrency.
	CoinValue float64
}

type Asset interface {
	Shutdown()
	IsSynced() bool
	IsSyncing() bool
	SpvSync() error
	CancelRescan()
	CancelSync()
	IsRescanning() bool
	RescanBlocks() error
	ConnectedPeers() int32
	RemovePeers()
	SetSpecificPeer(address string)
	GetExtendedPubKey(account int32) (string, error)
	IsSyncShuttingDown() bool

	LockWallet()
	IsLocked() bool
	IsWaiting() bool
	WalletOpened() bool
	OpenWallet() error
	GetWalletID() int
	GetWalletName() string
	IsWatchingOnlyWallet() bool
	UnlockWallet(string) error
	DeleteWallet(privPass string) error
	RenameWallet(newName string) error
	DecryptSeed(privatePassphrase string) (string, error)
	VerifySeedForWallet(seedMnemonic, privpass string) (bool, error)
	ChangePrivatePassphraseForWallet(oldPrivatePassphrase, newPrivatePassphrase string, privatePassphraseType int32) error

	RootDir() string
	DataDir() string
	GetEncryptedSeed() string
	IsConnectedToNetwork() bool
	NetType() utils.NetworkType
	ToAmount(v int64) AssetAmount
	GetAssetType() utils.AssetType
	Internal() *loader.LoadedWallets
	TargetTimePerBlockMinutes() float64
	RequiredConfirmations() int32
	ShutdownContextWithCancel() (context.Context, context.CancelFunc)
	LogFile() string

	PublishUnminedTransactions() error
	CountTransactions(txFilter int32) (int, error)
	GetTransactionRaw(txHash string) (*Transaction, error)
	TxMatchesFilter(tx *Transaction, txFilter int32) bool
	GetTransactionsRaw(offset, limit, txFilter int32, newestFirst bool, txHashSearch string) ([]*Transaction, error)

	GetBestBlock() *BlockInfo
	GetBestBlockHeight() int32
	GetBestBlockTimeStamp() int64

	ContainsDiscoveredAccounts() bool
	GetAccountsRaw() (*Accounts, error)
	GetAccount(accountNumber int32) (*Account, error)
	AccountName(accountNumber int32) (string, error)
	CreateNewAccount(accountName, privPass string) (int32, error)
	RenameAccount(accountNumber int32, newName string) error
	AccountNumber(accountName string) (int32, error)
	AccountNameRaw(accountNumber uint32) (string, error)
	GetAccountBalance(accountNumber int32) (*Balance, error)
	GetWalletBalance() (*Balance, error)
	UnspentOutputs(account int32) ([]*UnspentOutput, error)

	AddSyncProgressListener(syncProgressListener *SyncProgressListener, uniqueIdentifier string) error
	RemoveSyncProgressListener(uniqueIdentifier string)
	AddTxAndBlockNotificationListener(txAndBlockNotificationListener *TxAndBlockNotificationListener, uniqueIdentifier string) error
	RemoveTxAndBlockNotificationListener(uniqueIdentifier string)
	SetBlocksRescanProgressListener(blocksRescanProgressListener *BlocksRescanProgressListener)

	CurrentAddress(account int32) (string, error)
	NextAddress(account int32) (string, error)
	IsAddressValid(address string) bool
	HaveAddress(address string) bool

	SignMessage(passphrase, address, message string) ([]byte, error)
	VerifyMessage(address, message, signatureBase64 string) (bool, error)

	SaveUserConfigValue(key string, value interface{})
	ReadUserConfigValue(key string, valueOut interface{}) error

	SetBoolConfigValueForKey(key string, value bool)
	SetDoubleConfigValueForKey(key string, value float64)
	SetIntConfigValueForKey(key string, value int)
	SetInt32ConfigValueForKey(key string, value int32)
	SetLongConfigValueForKey(key string, value int64)
	SetStringConfigValueForKey(key, value string)

	ReadBoolConfigValueForKey(key string, defaultValue bool) bool
	ReadDoubleConfigValueForKey(key string, defaultValue float64) float64
	ReadIntConfigValueForKey(key string, defaultValue int) int
	ReadInt32ConfigValueForKey(key string, defaultValue int32) int32
	ReadLongConfigValueForKey(key string, defaultValue int64) int64
	ReadStringConfigValueForKey(key string, defaultValue string) string

	NewUnsignedTx(accountNumber int32, utxos []*UnspentOutput) error
	AddSendDestination(id int, address string, unitAmount int64, sendMax bool) error
	ComputeTxSizeEstimation(dstAddress string, utxos []*UnspentOutput) (int, error)
	Broadcast(passphrase, label string) ([]byte, error)
	EstimateFeeAndSize() (*TxFeeAndSize, error)
	IsUnsignedTxExist() bool
	RemoveSendDestination(id int)
	SendDestination(id int) *TransactionDestination
	UpdateSendDestination(id int, address string, atomAmount int64, sendMax bool) error
}

type AssetAmount interface {
	// ToCoin returns an asset formatted amount in float64.
	ToCoin() float64
	// String returns an asset formatted amount in string.
	String() string
	// MulF64 multiplies an Amount by a floating point value.
	MulF64(f float64) AssetAmount
	// ToInt() returns the complete int64 value without formatting.
	ToInt() int64
}

type AuthInfo struct {
	Name            string
	PrivatePass     string
	PrivatePassType int32
}

type Balance struct {
	// Fields common to all assets.
	Total          AssetAmount
	Spendable      AssetAmount
	ImmatureReward AssetAmount
	Locked         AssetAmount

	// DCR only fields
	ImmatureStakeGeneration AssetAmount
	LockedByTickets         AssetAmount
	VotingAuthority         AssetAmount
	UnConfirmed             AssetAmount
}

type BlockInfo struct {
	Height    int32
	Timestamp int64
}

type BlocksRescanProgressListener struct {
	OnBlocksRescanStarted  func(walletID int)
	OnBlocksRescanProgress func(*HeadersRescanProgressReport)
	OnBlocksRescanEnded    func(walletID int, err error)
}

type CFiltersFetchProgressReport struct {
	*GeneralSyncProgress
	BeginFetchCFiltersTimeStamp int64
	StartCFiltersHeight         int32
	CfiltersFetchTimeSpent      int64
	TotalFetchedCFiltersCount   int32
	TotalCFiltersToFetch        int32 `json:"totalCFiltersToFetch"`
	CurrentCFilterHeight        int32 `json:"currentCFilterHeight"`
	CFiltersFetchProgress       int32 `json:"headersFetchProgress"`
}

type ExchangeConfig struct {
	SourceAsset      utils.AssetType
	DestinationAsset utils.AssetType

	SourceWalletID      int32
	DestinationWalletID int32

	SourceAccountNumber      int32
	DestinationAccountNumber int32
}

type FeeEstimate struct {
	// Number of confirmed blocks that show the average fee rate represented below.
	ConfirmedBlocks int32
	// Feerate shows estimate fee rate in Sat/kvB or Lit/kvB.
	Feerate AssetAmount
}

type GeneralSyncProgress struct {
	TotalSyncProgress         int32 `json:"totalSyncProgress"`
	TotalTimeRemainingSeconds int64 `json:"totalTimeRemainingSeconds"`
}

type HeadersFetchProgressReport struct {
	*GeneralSyncProgress
	HeadersFetchTimeSpent int64
	BeginFetchTimeStamp   time.Time
	StartHeaderHeight     *int32
	TotalHeadersToFetch   int32 `json:"totalHeadersToFetch"`
	HeadersFetchProgress  int32 `json:"headersFetchProgress"`
}

type HeadersRescanProgressReport struct {
	*GeneralSyncProgress
	TotalHeadersToScan  int32 `json:"totalHeadersToScan"`
	CurrentRescanHeight int32 `json:"currentRescanHeight"`
	RescanProgress      int32 `json:"rescanProgress"`
	RescanTimeRemaining int64 `json:"rescanTimeRemaining"`
	WalletID            int   `json:"walletID"`
}

type InitParams struct {
	RootDir     string
	NetType     utils.NetworkType
	DB          *storm.DB
	DbDriver    string
	LogDir      string
	DEXTestAddr string
}

type KeyScope struct {
	// Purpose is the purpose of this key scope. This is the first child of
	// the master HD key.
	Purpose uint32

	// Coin is a value that represents the particular coin which is the
	// child of the purpose key. With this key, any accounts, or other
	// children can be derived at all.
	Coin uint32
}

type PeerInfo struct {
	ID             int32  `json:"id"`
	Addr           string `json:"addr"`
	AddrLocal      string `json:"addr_local"`
	Services       string `json:"services"`
	Version        uint32 `json:"version"`
	SubVer         string `json:"sub_ver"`
	StartingHeight int64  `json:"starting_height"`
	BanScore       int32  `json:"ban_score"`
}

type ScopeAddrSchema struct {
	// ExternalAddrType is the address type for all keys within branch 0.
	ExternalAddrType AddressType

	// InternalAddrType is the address type for all keys within branch 1
	// (change addresses).
	InternalAddrType AddressType
}

type SyncProgressListener struct {
	OnSyncStarted                 func()
	OnPeerConnectedOrDisconnected func(numberOfConnectedPeers int32)
	OnCFiltersFetchProgress       func(cfiltersFetchProgress *CFiltersFetchProgressReport)
	OnHeadersFetchProgress        func(headersFetchProgress *HeadersFetchProgressReport)
	OnAddressDiscoveryProgress    func(addressDiscoveryProgress *AddressDiscoveryProgressReport)
	OnHeadersRescanProgress       func(headersRescanProgress *HeadersRescanProgressReport)
	OnSyncCompleted               func()
	OnSyncCanceled                func(willRestart bool)
	OnSyncEndedWithError          func(err error)
}

type Transaction struct {
	Hash          string `storm:"id,unique" json:"hash"`
	Type          string `storm:"index" json:"type,omitempty"`
	Hex           string `json:"hex"`
	Timestamp     int64  `storm:"index" json:"timestamp"`
	BlockHeight   int32  `storm:"index" json:"block_height"`
	TicketSpender string `storm:"index" json:"ticket_spender,omitempty"` // (DCR Field)

	MixDenomination int64 `json:"mix_denom,omitempty"` // (DCR Field)
	MixCount        int32 `json:"mix_count,omitempty"` // (DCR Field)

	Version  int32  `json:"version"`
	LockTime int32  `json:"lock_time"`
	Expiry   int32  `json:"expiry,omitempty"` // (DCR Field)
	Fee      int64  `json:"fee"`
	FeeRate  int64  `json:"fee_rate"`
	Size     int    `json:"size"`
	Label    string `json:"label"`

	Direction int32       `storm:"index" json:"direction"`
	Amount    int64       `json:"amount"`
	Inputs    []*TxInput  `json:"inputs"`
	Outputs   []*TxOutput `json:"outputs"`

	// Vote Info (DCR fields)
	VoteVersion        int32  `json:"vote_version,omitempty"`
	LastBlockValid     bool   `json:"last_block_valid,omitempty"`
	VoteBits           string `json:"vote_bits,omitempty"`
	VoteReward         int64  `json:"vote_reward,omitempty"`
	TicketSpentHash    string `storm:"unique" json:"ticket_spent_hash,omitempty"`
	DaysToVoteOrRevoke int32  `json:"days_to_vote_revoke,omitempty"`
}

type TransactionDestination struct {
	// Shared fields.
	ID         int
	Address    string
	SendMax    bool
	UnitAmount int64
}

type TransactionOverview struct {
	All         int
	Sent        int
	Received    int
	Transferred int
	Mixed       int
	Staking     int
	Coinbase    int
}

type TxAndBlockNotificationListener struct {
	OnTransaction          func(walletID int, transaction *Transaction)
	OnBlockAttached        func(walletID int, blockHeight int32)
	OnTransactionConfirmed func(walletID int, hash string, blockHeight int32)
}

type TxFeeAndSize struct {
	Fee                 *Amount
	Change              *Amount
	FeeRate             int64 // calculated in Sat/kvB or Lit/kvB
	EstimatedSignedSize int
}

type TxInfoFromWallet struct {
	WalletID    int
	Hex         string
	Timestamp   int64
	BlockHeight int32
	Inputs      []*WInput
	Outputs     []*WOutput
}

type TxInput struct {
	PreviousTransactionHash  string `json:"previous_transaction_hash"`
	PreviousTransactionIndex int32  `json:"previous_transaction_index"`
	PreviousOutpoint         string `json:"previous_outpoint"`
	Amount                   int64  `json:"amount"`
	AccountNumber            int32  `json:"account_number"`
}

type TxOutput struct {
	Index         int32  `json:"index"`
	Amount        int64  `json:"amount"`
	Version       int32  `json:"version,omitempty"` // (DCR Field)
	ScriptType    string `json:"script_type"`
	Address       string `json:"address"`
	Internal      bool   `json:"internal"`
	AccountNumber int32  `json:"account_number"`
}

type UnsignedTransaction struct {
	UnsignedTransaction       []byte
	EstimatedSignedSize       int
	ChangeIndex               int
	TotalOutputAmount         int64
	TotalPreviousOutputAmount int64
}

type UnspentOutput struct {
	TxID          string
	Vout          uint32
	Address       string
	ScriptPubKey  string
	RedeemScript  string
	Amount        AssetAmount
	Confirmations int32
	Spendable     bool
	ReceiveTime   time.Time
	Tree          int8
}

type WAccount struct {
	AccountNumber int32  `json:"account_number"`
	AccountName   string `json:"account_name"`
}

type WConfig struct {
	// General
	GapLimit                uint32         // Allowed unused address gap between used addresses of accounts
	ManualTickets           bool           // Do not discover new tickets through network synchronization
	AllowHighFees           bool           // Do not perform high fee checks
	RelayFee                dcrutil.Amount // Transaction fee per kilobyte
	AccountGapLimit         int            // Allowed gap of unused accounts
	DisableCoinTypeUpgrades bool           // Never upgrade from legacy to SLIP0044 coin type keys

	// CSPP
	MixSplitLimit int // Connection limit to CoinShuffle++ server per change amount
}

type WInput struct {
	Index    int32 `json:"index"`
	AmountIn int64 `json:"amount_in"`
	*WAccount
}

type WOutput struct {
	Index     int32  `json:"index"`
	AmountOut int64  `json:"amount_out"`
	Internal  bool   `json:"internal"`
	Address   string `json:"address"`
	*WAccount
}

type Wallet struct {
	ID        int       `storm:"id,increment"`
	Name      string    `storm:"unique"`
	CreatedAt time.Time `storm:"index"`
	Type      utils.AssetType

	EncryptedSeed         []byte
	IsRestored            bool
	HasDiscoveredAccounts bool
	PrivatePassphraseType int32

	// Birthday holds the timestamp of the birthday block from where wallet
	// restoration begins from. CreatedAt is available for audit purposes
	// in relation to how long the wallet has been in existence.
	Birthday time.Time
	// contains filtered or unexported fields
}