domain

type Account struct {
	AccountInfo
	Index                  uint32
	BirthdayBlock          uint32
	NextExternalIndex      uint
	NextInternalIndex      uint
	DerivationPathByScript map[string]string
	Unconf                 bool
}

type AccountInfo struct {
	Namespace      string
	Label          string
	Xpub           string
	DerivationPath string
}

type AddressInfo struct {
	Account        string
	Address        string
	BlindingKey    []byte
	DerivationPath string
	Script         string
}

type Balance struct {
	Confirmed   uint64
	Unconfirmed uint64
	Locked      uint64
}

type ExternalScriptEvent struct {
	EventType ExternalScriptEventType
	Info      AddressInfo
}

type ExternalScriptEventType int

type ExternalScriptRepository interface {
	// AddScripts persists the given external script by preventing duplicates.
	AddScript(ctx context.Context, script AddressInfo) (bool, error)
	// GetAllScripts returns all the persisted external scripts.
	GetAllScripts(ctx context.Context) ([]AddressInfo, error)
	// DeleteScript removes an external script idenitified by its hash from the store.
	DeleteScript(ctx context.Context, scriptHash string) (bool, error)
}

type IMnemonicCypher interface {
	Encrypt(mnemonic, password []byte) ([]byte, error)
	Decrypt(encryptedMnemonic, password []byte) ([]byte, error)
}

type IMnemonicStore interface {
	Set(mnemonic string)
	Unset()
	IsSet() bool
	Get() []string
}

type Transaction struct {
	TxID        string
	TxHex       string
	BlockHash   string
	BlockHeight uint64
	Accounts    map[string]struct{}
}

type TransactionEvent struct {
	EventType   TransactionEventType
	Transaction *Transaction
}

type TransactionEventType int

type TransactionRepository interface {
	// AddTransaction adds the provided transaction to the repository by
	// preventing duplicates.
	// Generates a TransactionAdded event if successful.
	AddTransaction(ctx context.Context, tx *Transaction) (bool, error)
	// ConfirmTransaction adds the given blockhash and block height to the
	// Transaction identified by the given txid.
	// Generates a TransactionConfirmed event if successful.
	ConfirmTransaction(
		ctx context.Context, txid, blockHash string, blockheight uint64,
	) (bool, error)
	// GetTransaction returns the Transaction identified by the given txid.
	GetTransaction(ctx context.Context, txid string) (*Transaction, error)
	// UpdateTransaction allows to commit multiple changes to the same
	// Transaction in a transactional way.
	UpdateTransaction(
		ctx context.Context, txid string,
		updateFn func(tx *Transaction) (*Transaction, error),
	) error
	// GetEventChannel retunrs the channel of TransactionEvents.
	GetEventChannel() chan TransactionEvent
}

type Utxo struct {
	UtxoKey
	Value               uint64
	Asset               string
	ValueCommitment     []byte
	AssetCommitment     []byte
	ValueBlinder        []byte
	AssetBlinder        []byte
	Script              []byte
	Nonce               []byte
	RangeProof          []byte
	SurjectionProof     []byte
	AccountName         string
	LockTimestamp       int64
	LockExpiryTimestamp int64
	SpentStatus         UtxoStatus
	ConfirmedStatus     UtxoStatus
}

type UtxoEvent struct {
	EventType UtxoEventType
	Utxos     []UtxoInfo
}

type UtxoEventType int

type UtxoInfo struct {
	UtxoKey
	Value           uint64
	Asset           string
	Script          []byte
	ValueBlinder    []byte
	AssetBlinder    []byte
	AccountName     string
	SpentStatus     UtxoStatus
	ConfirmedStatus UtxoStatus
}

type UtxoKey struct {
	TxID string
	VOut uint32
}

type UtxoRepository interface {
	// AddUtxos adds the provided utxos to the repository by preventing
	// duplicates.
	// Generates a UtxoAdded event if successfull.
	AddUtxos(ctx context.Context, utxos []*Utxo) (int, error)
	// GetUtxosByKey returns the utxos identified by the given keys.
	GetUtxosByKey(ctx context.Context, utxoKeys []UtxoKey) ([]*Utxo, error)
	// GetAllUtxos returns the entire UTXO set, included those locked or
	// already spent.
	GetAllUtxos(ctx context.Context) ([]*Utxo, error)
	// GetSpendableUtxos returns all unlocked utxo UTXOs.
	GetSpendableUtxos(ctx context.Context) ([]*Utxo, error)
	// GetAllUtxosForAccount returns the list of all utxos for the given
	// account.
	GetAllUtxosForAccount(ctx context.Context, account string) ([]*Utxo, error)
	// GetSpendableUtxosForAccount returns the list of spendable utxos for the
	// given account. The list incldues only confirmed and unlocked utxos.
	GetSpendableUtxosForAccount(ctx context.Context, account string) ([]*Utxo, error)
	// GetLockedUtxosForAccount returns the list of all currently locked utxos
	// for the given account.
	GetLockedUtxosForAccount(ctx context.Context, account string) ([]*Utxo, error)
	// GetBalanceForAccount returns the confirmed, unconfirmed and locked
	// balances per each asset for the given account.
	GetBalanceForAccount(ctx context.Context, account string) (map[string]*Balance, error)
	// SpendUtxos updates the status of the given list of utxos to "spent".
	// Generates a UtxoSpent event if successfull.
	SpendUtxos(ctx context.Context, utxoKeys []UtxoKey, status UtxoStatus) (int, error)
	// ConfirmUtxos updates the status of the given list of utxos to "confirmed".
	// Generates a UtxoConfirmed event if successfull.
	ConfirmUtxos(ctx context.Context, utxoKeys []UtxoKey, status UtxoStatus) (int, error)
	// LockUtxos updates the status of the given list of utxos to "locked".
	// Generates a UtxoLocked event if successfull.
	LockUtxos(ctx context.Context, utxoKeys []UtxoKey, timestamp, expiryTimestamp int64) (int, error)
	// UnlockUtxos updates the status of the given list of utxos to "unlocked".
	// Generates a UtxoUnlocked event if successfull.
	UnlockUtxos(ctx context.Context, utxoKeys []UtxoKey) (int, error)
	// DeleteUtxosForAccount deletes every utxo associated to the given account
	// from the repository.
	DeleteUtxosForAccount(ctx context.Context, accountName string) error
	// GetEventChannel returns the channel of UtxoEvents.
	GetEventChannel() chan UtxoEvent
}

type UtxoStatus struct {
	Txid        string
	BlockHeight uint64
	BlockTime   int64
	BlockHash   string
}

type Wallet struct {
	EncryptedMnemonic   []byte
	PasswordHash        []byte
	BirthdayBlockHeight uint32
	RootPath            string
	NetworkName         string
	Accounts            map[string]*Account
	AccountsByLabel     map[string]string
	NextAccountIndex    uint32
}

type WalletEvent struct {
	EventType            WalletEventType
	AccountName          string
	AccountBirthdayBlock uint32
	AccountAddresses     []AddressInfo
}

type WalletEventType int

type WalletRepository interface {
	// CreateWallet stores a new Wallet if not yet existing.
	// Generates a WalletCreated event if successfull.
	CreateWallet(ctx context.Context, wallet *Wallet) error
	// GetWallet returns the stored wallet, if existing.
	GetWallet(ctx context.Context) (*Wallet, error)
	// UnlockWallet attempts to update the status of the Wallet to "unlocked".
	// Generates a WalletUnlocked event if successfull.
	UnlockWallet(ctx context.Context, password string) error
	// LockkWallet updates the status of the Wallet to "locked".
	// Generates a WalletLocked event if successfull.
	LockWallet(ctx context.Context, password string) error
	// UpdateWallet allows to make multiple changes to the Wallet in a
	// transactional way.
	UpdateWallet(
		ctx context.Context, updateFn func(v *Wallet) (*Wallet, error),
	) error
	// CreateAccount creates a new wallet account with the given name and returns
	// its basic info.
	// Generates a WalletAccountCreated event if successfull.
	CreateAccount(
		ctx context.Context, accountName string, birthdayBlock uint32, unconf bool,
	) (*AccountInfo, error)
	// DeriveNextExternalAddressesForAccount returns one or more new receiving
	// addresses for the given account.
	// Generates a WalletAccountAddressesDerived event if successfull.
	DeriveNextExternalAddressesForAccount(
		ctx context.Context, accountName string, numOfAddresses uint64,
	) ([]AddressInfo, error)
	// DeriveNextInternalAddressesForAccount returns one or more new change
	// addresses for the given account.
	// Generates a WalletAccountAddressesDerived event if successfull.
	DeriveNextInternalAddressesForAccount(
		ctx context.Context, accountName string, numOfAddresses uint64,
	) ([]AddressInfo, error)
	// DeleteAccount deletes the wallet account with the given name.
	// Generates a WalletAccountDeleted event if successfull.
	DeleteAccount(ctx context.Context, accountName string) error
	// GetEventChannel returns the channel of WalletEvents.
	GetEventChannel() chan WalletEvent
}