domain

type Asset struct {
	Id             string
	ControlAssetId string
	Metadata       []asset.Metadata
	Supply         big.Int
}

type AssetDenomination = asset.Asset

type AssetRepository interface {
	AddAssets(ctx context.Context, assetsByTx map[string][]Asset) (int, error)
	GetAssets(ctx context.Context, assetIds []string) ([]Asset, error)
	GetControlAsset(ctx context.Context, assetID string) (string, error)
	AssetExists(ctx context.Context, assetID string) (bool, error)
	Close()
}

type BaseConviction struct {
	ID        string
	Type      ConvictionType
	CreatedAt time.Time
	ExpiresAt *time.Time
	Crime     Crime
	Pardoned  bool
}

type BatchFees struct {
	OnchainInputFee   string
	OffchainInputFee  string
	OnchainOutputFee  string
	OffchainOutputFee string
}

type BatchFeesUpdate struct {
	OnchainInputFee   *string
	OffchainInputFee  *string
	OnchainOutputFee  *string
	OffchainOutputFee *string
}

type BatchSwept struct {
	RoundEvent
	LeafVtxos         []Outpoint
	PreconfirmedVtxos []Outpoint
	Txid              string
	Tx                string
	FullySwept        bool
}

type Conviction interface {
	GetType() ConvictionType
	GetID() string
	GetCreatedAt() time.Time
	GetExpiresAt() *time.Time
	GetCrime() Crime
	String() string
	IsPardoned() bool
}

type ConvictionRepository interface {
	Get(ctx context.Context, id string) (Conviction, error)
	GetAll(ctx context.Context, from, to time.Time) ([]Conviction, error)
	GetByRoundID(ctx context.Context, roundID string) ([]Conviction, error)
	// GetActiveScriptConviction returns all not-expired convictions associated with a given script
	GetActiveScriptConvictions(ctx context.Context, script string) ([]ScriptConviction, error)
	Add(ctx context.Context, convictions ...Conviction) error
	Pardon(ctx context.Context, id string) error
	Close()
}

type ConvictionType uint8

type Crime struct {
	Type    CrimeType
	RoundID string
	Reason  string
}

type CrimeType uint8

type Event interface {
	GetTopic() string
	GetType() EventType
}

type EventRepository interface {
	Save(ctx context.Context, topic, id string, events []Event) error
	RegisterEventsHandler(topic string, handler func(events []Event))
	ClearRegisteredHandlers(topic ...string)
	Close()
}

type EventType int

type ExpiredRound struct {
	RoundId        string
	CommitmentTxid string
	ExpiredAt      int64
}

type ForfeitTx struct {
	Txid string
	Tx   string
}

type Intent struct {
	Id        string
	Inputs    []Vtxo
	Receivers []Receiver
	Proof     string
	Message   string
	Txid      string
	// hex-encoded extension OP_RETURN script to be added as output of the vtxo tree leaf transaction
	LeafTxExtension string
}

type Intents []Intent

type IntentsRegistered struct {
	RoundEvent
	Intents []Intent
}

type OffchainTx struct {
	Stage              Stage
	StartingTimestamp  int64
	EndingTimestamp    int64
	ArkTxid            string
	ArkTx              string
	CheckpointTxs      map[string]string
	CommitmentTxids    map[string]string
	RootCommitmentTxId string
	ExpiryTimestamp    int64
	FailReason         string
	Version            uint
	// contains filtered or unexported fields
}

type OffchainTxAccepted struct {
	OffchainTxEvent
	CommitmentTxids     map[string]string
	RootCommitmentTxid  string
	FinalArkTx          string
	SignedCheckpointTxs map[string]string
	ExpiryTimestamp     int64
}

type OffchainTxEvent struct {
	Id   string
	Type EventType
}

type OffchainTxFailed struct {
	OffchainTxEvent
	Reason    string
	Timestamp int64
}

type OffchainTxFinalized struct {
	OffchainTxEvent
	FinalCheckpointTxs map[string]string
	Timestamp          int64
}

type OffchainTxRepository interface {
	AddOrUpdateOffchainTx(ctx context.Context, offchainTx *OffchainTx) error
	GetOffchainTx(ctx context.Context, txid string) (*OffchainTx, error)
	Close()
}

type OffchainTxRequested struct {
	OffchainTxEvent
	ArkTx                 string
	UnsignedCheckpointTxs map[string]string
	StartingTimestamp     int64
}

type OffchainTxStage int

type Outpoint struct {
	Txid string
	VOut uint32
}

type Receiver struct {
	Amount         uint64
	OnchainAddress string // onchain
	PubKey         string // offchain
}

type Round struct {
	Id                 string
	StartingTimestamp  int64
	EndingTimestamp    int64
	Stage              Stage
	Intents            map[string]Intent
	CommitmentTxid     string
	CommitmentTx       string
	ForfeitTxs         []ForfeitTx
	VtxoTree           tree.FlatTxTree
	Connectors         tree.FlatTxTree
	ConnectorAddress   string
	Version            uint
	Swept              bool
	VtxoTreeExpiration int64
	CollectedFees      uint64
	SweepTxs           map[string]string
	FailReason         string
	Changes            []Event
}

type RoundEvent struct {
	Id   string
	Type EventType
}

type RoundFailed struct {
	RoundEvent
	Reason    string
	Timestamp int64
}

type RoundFinalizationStarted struct {
	RoundEvent
	VtxoTree           tree.FlatTxTree
	Connectors         tree.FlatTxTree
	ConnectorAddress   string
	CommitmentTxid     string
	CommitmentTx       string
	VtxoTreeExpiration int64
}

type RoundFinalized struct {
	RoundEvent
	ForfeitTxs        []ForfeitTx
	FinalCommitmentTx string
	Fees              uint64
	Timestamp         int64
}

type RoundRepository interface {
	AddOrUpdateRound(ctx context.Context, round Round) error
	GetRoundWithId(ctx context.Context, id string) (*Round, error)
	GetRoundWithCommitmentTxid(ctx context.Context, txid string) (*Round, error)
	GetRoundStats(ctx context.Context, commitmentTxid string) (*RoundStats, error)
	GetRoundForfeitTxs(ctx context.Context, commitmentTxid string) ([]ForfeitTx, error)
	GetSweepTxs(ctx context.Context, commitmentTxid string) (map[string]string, error)
	GetRoundConnectorTree(ctx context.Context, commitmentTxid string) (tree.FlatTxTree, error)
	GetRoundVtxoTree(ctx context.Context, txid string) (tree.FlatTxTree, error)
	GetSweepableRounds(ctx context.Context) ([]string, error)
	// GetExpiredRounds returns the list of info about batches that expired but haven't been
	// swept because of uneconomical conditions (amount too low to cover network fees)
	GetExpiredRounds(ctx context.Context, expiredBefore int64) ([]ExpiredRound, error)
	GetRoundIds(
		ctx context.Context,
		startedAfter, startedBefore int64,
		withFailed, withCompleted bool,
	) ([]string, error)
	// TODO return only connector addresses with unspent utxos
	GetSweptRoundsConnectorAddress(ctx context.Context) ([]string, error)
	GetTxsWithTxids(ctx context.Context, txids []string) ([]string, error)
	GetRoundsWithCommitmentTxids(ctx context.Context, txids []string) (map[string]any, error)
	GetIntentByTxid(ctx context.Context, txid string) (*Intent, error)
	// PatchCollectedFees sets the collected fees of the given rounds (by id),
	// used to lazily persist fees recomputed for rounds finalized before fee
	// persistence was introduced (https://github.com/arkade-os/arkd/pull/933).
	PatchCollectedFees(ctx context.Context, feesByRoundId map[string]uint64) error
	Close()
}

type RoundStage int

type RoundStarted struct {
	RoundEvent
	Timestamp int64
}

type RoundStats struct {
	Swept              bool
	TotalForfeitAmount uint64
	TotalInputVtxos    int32
	TotalBatchAmount   uint64
	TotalOutputVtxos   int32
	ExpiresAt          int64
	Started            int64
	Ended              int64
}

type ScheduledSession struct {
	StartTime                 time.Time
	EndTime                   time.Time
	Period                    time.Duration
	Duration                  time.Duration
	RoundMinParticipantsCount int64
	RoundMaxParticipantsCount int64
}

type ScheduledSessionUpdate struct {
	StartTime                 *time.Time
	EndTime                   *time.Time
	Period                    *time.Duration
	Duration                  *time.Duration
	RoundMinParticipantsCount *int64
	RoundMaxParticipantsCount *int64
}

type ScriptConviction struct {
	BaseConviction
	Script string
}

type Settings struct {
	SessionDuration               time.Duration
	UnrolledVtxoMinExpiryMargin   time.Duration
	BanThreshold                  uint64
	BanDuration                   time.Duration
	UnilateralExitDelay           arklib.RelativeLocktime
	PublicUnilateralExitDelay     arklib.RelativeLocktime
	CheckpointExitDelay           arklib.RelativeLocktime
	BoardingExitDelay             arklib.RelativeLocktime
	VtxoTreeExpiry                arklib.RelativeLocktime
	RoundMinParticipantsCount     int64
	RoundMaxParticipantsCount     int64
	VtxoMinAmount                 int64
	VtxoMaxAmount                 int64
	UtxoMinAmount                 int64
	UtxoMaxAmount                 int64
	SettlementMinExpiryGap        time.Duration
	VtxoNoCsvValidationCutoffDate time.Time
	MaxTxWeight                   uint64
	MaxOpReturnOutputs            uint64
	AssetTxMaxWeightRatio         float32
	NoteUriPrefix                 string
	ScheduledSession              *ScheduledSession
	BatchFees                     BatchFees
	BuildVersionHeader            string
	BuildVersionHeaderRequired    bool
	DigestHeaderRequired          bool
	UpdatedAt                     time.Time
}

type SettingsRepository interface {
	Get(ctx context.Context) (*Settings, error)
	Upsert(ctx context.Context, settings Settings, changelog []string) error
	RegisterUpdatesHandler(handler func(Settings, []string))
	Close()
}

type SettingsUpdate struct {
	SessionDuration               *time.Duration
	UnrolledVtxoMinExpiryMargin   *time.Duration
	BanThreshold                  *uint64
	BanDuration                   *time.Duration
	UnilateralExitDelay           *arklib.RelativeLocktime
	PublicUnilateralExitDelay     *arklib.RelativeLocktime
	CheckpointExitDelay           *arklib.RelativeLocktime
	BoardingExitDelay             *arklib.RelativeLocktime
	VtxoTreeExpiry                *arklib.RelativeLocktime
	RoundMinParticipantsCount     *int64
	RoundMaxParticipantsCount     *int64
	VtxoMinAmount                 *int64
	VtxoMaxAmount                 *int64
	UtxoMinAmount                 *int64
	UtxoMaxAmount                 *int64
	SettlementMinExpiryGap        *time.Duration
	VtxoNoCsvValidationCutoffDate *time.Time
	MaxTxWeight                   *uint64
	MaxOpReturnOutputs            *uint64
	AssetTxMaxWeightRatio         *float32
	NoteUriPrefix                 *string
	BuildVersionHeader            *string
	BuildVersionHeaderRequired    *bool
	DigestHeaderRequired          *bool
}

type Stage struct {
	Code   int
	Ended  bool
	Failed bool
}

type Tx struct {
	Txid string
	Str  string
}

type Vtxo struct {
	Outpoint
	Amount             uint64
	PubKey             string
	CommitmentTxids    []string
	RootCommitmentTxid string
	SettledBy          string // commitment txid
	SpentBy            string // forfeit txid or checkpoint txid
	ArkTxid            string // the link to the ark txid that spent the vtxos
	Spent              bool
	Unrolled           bool
	Swept              bool
	Preconfirmed       bool
	ExpiresAt          int64
	CreatedAt          int64
	Assets             []AssetDenomination
}

type VtxoRepository interface {
	AddVtxos(ctx context.Context, vtxos []Vtxo) error
	SettleVtxos(ctx context.Context, spentVtxos map[Outpoint]string, commitmentTxid string) error
	SpendVtxos(ctx context.Context, spentVtxos map[Outpoint]string, arkTxid string) error
	UnrollVtxos(ctx context.Context, outpoints []Outpoint) error
	SweepVtxos(ctx context.Context, outpoints []Outpoint) (int, error)
	GetVtxos(ctx context.Context, outpoints []Outpoint) ([]Vtxo, error)
	GetAllNonUnrolledVtxos(ctx context.Context, pubkey string) ([]Vtxo, []Vtxo, error)
	GetAllSweepableUnrolledVtxos(ctx context.Context) ([]Vtxo, error)
	GetAllVtxos(ctx context.Context) ([]Vtxo, error)
	GetAllVtxosWithPubKeys(
		ctx context.Context,
		pubkeys []string,
		after, before int64,
	) ([]Vtxo, error)
	GetExpiringLiquidity(ctx context.Context, after, before int64) (uint64, error)
	GetRecoverableLiquidity(ctx context.Context) (uint64, error)
	UpdateVtxosExpiration(ctx context.Context, outpoints []Outpoint, expiresAt int64) error
	GetLeafVtxosForBatch(ctx context.Context, txid string) ([]Vtxo, error)
	GetSweepableVtxosByCommitmentTxid(
		ctx context.Context, commitmentTxid string,
	) ([]Outpoint, error)
	GetAllChildrenVtxos(ctx context.Context, txid string) ([]Outpoint, error)
	GetVtxoPubKeysByCommitmentTxid(
		ctx context.Context, commitmentTxid string, withMinimumAmount uint64,
	) (
		[]string, error,
	)
	GetVtxoPubKeysByCommitmentTxids(
		ctx context.Context, commitmentTxids []string, withMinimumAmount uint64,
	) (
		[]string, error,
	)
	GetPendingSpentVtxosWithPubKeys(
		ctx context.Context,
		pubkeys []string,
		after, before int64,
	) ([]Vtxo, error)
	GetPendingSpentVtxosWithOutpoints(ctx context.Context, outpoints []Outpoint) ([]Vtxo, error)
	Close()
}