types

type AssetStore interface {
	GetAsset(ctx context.Context, assetId string) (*types.AssetInfo, error)
	UpsertAsset(ctx context.Context, asset types.AssetInfo) error
	Clean(ctx context.Context) error
}

type Balance struct {
	OnchainBalance  OnchainBalance    `json:"onchain_balance"`
	OffchainBalance OffchainBalance   `json:"offchain_balance"`
	Total           uint64            `json:"total"`
	AssetBalances   map[string]uint64 `json:"asset_balances,omitempty"`
}

type Contract struct {
	Type      ContractType
	Label     string
	Params    map[string]string
	Script    string
	Address   string
	State     ContractState
	CreatedAt time.Time
	Metadata  map[string]string
}

type ContractState string

type ContractStore interface {
	AddContract(ctx context.Context, c Contract, keyIndex uint32) error
	ListContracts(ctx context.Context) ([]Contract, error)
	GetContractsByScripts(ctx context.Context, scripts []string) ([]Contract, error)
	GetContractsByState(ctx context.Context, state ContractState) ([]Contract, error)
	GetContractsByType(ctx context.Context, contractType ContractType) ([]Contract, error)
	GetLatestContract(ctx context.Context, contractType ContractType) (*Contract, error)
	UpdateContractState(ctx context.Context, script string, state ContractState) error
	Clean(ctx context.Context) error
}

type ContractType string

type Cursor struct {
	CreatedAt int64
	Txid      string
	VOut      uint32
}

type GetVtxoFilter struct {
	Status  VtxoStatusFilter
	AssetID string  // "" = no asset filter
	After   *Cursor // nil = first page
	Limit   int     // number of VTXOs to return
}

type LockedOnchainBalance struct {
	SpendableAt string `json:"spendable_at"`
	Amount      uint64 `json:"amount"`
}

type OffchainBalance struct {
	Total          uint64        `json:"total"`
	NextExpiration string        `json:"next_expiration,omitempty"`
	Details        []VtxoDetails `json:"details"`
	Available      uint64        `json:"available"`
	Preconfirmed   uint64        `json:"preconfirmed"`
	Recoverable    uint64        `json:"recoverable"`
	Settled        uint64        `json:"settled"`
}

type OnchainAddressEvent struct {
	Error          error
	SpentUtxos     []clientTypes.OnchainOutput
	NewUtxos       []clientTypes.OnchainOutput
	ConfirmedUtxos []clientTypes.OnchainOutput
	Replacements   map[string]string // replacedTxid -> replacementTxid
}

type OnchainBalance struct {
	Confirmed       uint64                 `json:"confirmed"`
	Unconfirmed     uint64                 `json:"unconfirmed"`
	Total           uint64                 `json:"total"`
	SpendableAmount uint64                 `json:"spendable_amount"`
	LockedAmount    []LockedOnchainBalance `json:"locked_amount,omitempty"`
}

type Store interface {
	TransactionStore() TransactionStore
	UtxoStore() UtxoStore
	VtxoStore() VtxoStore
	AssetStore() AssetStore
	ContractStore() ContractStore
	Clean(ctx context.Context)
	Close()
}

type SyncEvent struct {
	Synced bool
	Err    error
}

type TransactionEvent struct {
	Type         TxEventType
	Txs          []clientTypes.Transaction
	Replacements map[string]string
}

type TransactionStore interface {
	AddTransactions(ctx context.Context, txs []types.Transaction) (int, error)
	SettleTransactions(ctx context.Context, txids []string, settledBy string) (int, error)
	ConfirmTransactions(ctx context.Context, txids []string, timestamp time.Time) (int, error)
	RbfTransactions(ctx context.Context, rbfTxs map[string]string) (int, error)
	GetAllTransactions(ctx context.Context) ([]types.Transaction, error)
	GetTransactions(ctx context.Context, txids []string) ([]types.Transaction, error)
	UpdateTransactions(ctx context.Context, txs []types.Transaction) (int, error)
	Clean(ctx context.Context) error
	GetEventChannel() <-chan TransactionEvent
}

type TxEventType int

type UtxoEvent struct {
	Type  UtxoEventType
	Utxos []clientTypes.Utxo
}

type UtxoEventType int

type UtxoStore interface {
	AddUtxos(ctx context.Context, utxos []types.Utxo) (int, error)
	ReplaceUtxo(ctx context.Context, from, to types.Outpoint) error
	ConfirmUtxos(ctx context.Context, confirmedUtxos map[types.Outpoint]int64) (int, error)
	SpendUtxos(ctx context.Context, spentUtxos map[types.Outpoint]string) (int, error)
	DeleteUtxos(ctx context.Context, outpoints []types.Outpoint) (int, error)
	GetAllUtxos(ctx context.Context) (spendable, spent []types.Utxo, err error)
	GetUtxos(ctx context.Context, keys []types.Outpoint) ([]types.Utxo, error)
	GetUtxosByTxid(ctx context.Context, txid string) ([]types.Utxo, error)
	Clean(ctx context.Context) error
	GetEventChannel() <-chan UtxoEvent
}

type VtxoDetails struct {
	ExpiryTime string `json:"expiry_time"`
	Amount     uint64 `json:"amount"`
}

type VtxoEvent struct {
	Type  VtxoEventType
	Vtxos []clientTypes.Vtxo
}

type VtxoEventType int

type VtxoPageResult struct {
	Vtxos []types.Vtxo
	Next  *Cursor
}

type VtxoStatusFilter int

type VtxoStore interface {
	AddVtxos(ctx context.Context, vtxos []types.Vtxo) (int, error)
	SpendVtxos(
		ctx context.Context, spentVtxos map[types.Outpoint]string, arkTxid string,
	) (int, error)
	SettleVtxos(
		ctx context.Context, spentVtxos map[types.Outpoint]string, settledBy string,
	) (int, error)
	SweepVtxos(ctx context.Context, vtxosToSweep []types.Vtxo) (int, error)
	UnrollVtxos(ctx context.Context, vtxosToUnroll []types.Vtxo) (int, error)

	// GetSpendableOrRecoverableVtxos returns all VTXOs where spent = false AND
	// unrolled = false. This is the union of strictly spendable VTXOs and
	// recoverable VTXOs (swept or expired, but not spent). Callers needing to
	// distinguish use IsRecoverable on each returned VTXO.
	GetSpendableOrRecoverableVtxos(ctx context.Context) ([]types.Vtxo, error)

	// GetVtxosByOutpoints returns VTXOs matching the given outpoints.
	GetVtxosByOutpoints(ctx context.Context, keys []types.Outpoint) ([]types.Vtxo, error)

	// GetVtxos returns one page of VTXOs according to q. When the returned
	// cursor is nil, the page is the end of the result set. The cursor is an
	// internal keyset position used by the public Wallet.ListVtxos API.
	GetVtxos(ctx context.Context, q GetVtxoFilter) ([]types.Vtxo, *Cursor, error)

	Clean(ctx context.Context) error
	GetEventChannel() <-chan VtxoEvent
}