clientlib

type AcceptedOffchainTx struct {
	Txid                string
	FinalArkTx          string
	SignedCheckpointTxs []string
}

type Address struct {
	// KeyID identifies which wallet key produced this address.
	// Single-key wallets populate it with their fixed key handle; HD wallets can
	// use the derivation path.
	KeyID      string
	Tapscripts []string
	Address    string
	// contains filtered or unexported fields
}

type Asset struct {
	AssetId string
	Amount  uint64
}

type AssetInfo struct {
	AssetId        string
	Supply         uint64
	ControlAssetId string
	Metadata       []asset.Metadata
}

type Batch struct {
	TotalOutputAmount uint64
	TotalOutputVtxos  int32
	ExpiresAt         int64
	Swept             bool
}

type BatchEventChannel struct {
	Event      any
	Connection *StreamConnectionEvent
	Err        error
}

type BatchFailedEvent struct {
	Id     string
	Reason string
}

type BatchFinalizationEvent struct {
	Id string
	Tx string
}

type BatchFinalizedEvent struct {
	Id   string
	Txid string
}

type BatchStartedEvent struct {
	Id              string
	HashedIntentIds []string
	BatchExpiry     int64
}

type ChainWithExpiry struct {
	Txid      string
	ExpiresAt int64
	Type      IndexerChainedTxType
	Spends    []string
}

type Client interface {
	GetInfo(ctx context.Context) (*Info, error)
	RegisterIntent(ctx context.Context, proof, message string) (string, error)
	DeleteIntent(ctx context.Context, proof, message string) error
	EstimateIntentFee(ctx context.Context, proof, message string) (int64, error)
	ConfirmRegistration(ctx context.Context, intentID string) error
	SubmitTreeNonces(
		ctx context.Context, batchId, cosignerPubkey string, nonces tree.TreeNonces,
	) error
	SubmitTreeSignatures(
		ctx context.Context, batchId, cosignerPubkey string, signatures tree.TreePartialSigs,
	) error
	SubmitSignedForfeitTxs(
		ctx context.Context, signedForfeitTxs []string, signedCommitmentTx string,
	) error
	GetEventStream(ctx context.Context, topics []string) (<-chan BatchEventChannel, func(), error)
	SubmitTx(ctx context.Context, signedArkTx string, checkpointTxs []string) (

		arkTxid, finalArkTx string, signedCheckpointTxs []string, err error,
	)
	FinalizeTx(ctx context.Context, arkTxid string, finalCheckpointTxs []string) error
	GetPendingTx(ctx context.Context, proof, message string) ([]AcceptedOffchainTx, error)
	GetTransactionsStream(ctx context.Context) (<-chan TransactionEvent, func(), error)
	ModifyStreamTopics(
		ctx context.Context, addTopics, removeTopics []string,
	) (addedTopics, removedTopics, allTopics []string, err error)
	OverwriteStreamTopics(
		ctx context.Context, topics []string,
	) (addedTopics, removedTopics, allTopics []string, err error)
	Close()
}

type CommitmentTx struct {
	StartedAt         int64
	EndedAt           int64
	TotalInputAmount  uint64
	TotalInputVtxos   int32
	TotalOutputAmount uint64
	TotalOutputVtxos  int32
	Batches           map[uint32]*Batch
}

type ConfirmedStatus struct {
	Confirmed bool
	BlockTime int64
}

type ConnectorsResponse struct {
	Tree []TxNode
	Page *PageResponse
}

type ControlAsset interface {
	// contains filtered or unexported methods
}

type DeprecatedSigner struct {
	PubKey     *btcec.PublicKey
	CutoffDate time.Time
}

type DeprecatedSignerInfo struct {
	PubKey     string
	CutoffDate int64
}

type ExistingControlAsset struct {
	Id     string
	Amount uint64
}

type Explorer interface {
	// Start must be used when using the explorer with tracking enabled.
	Start()

	// GetTxHex retrieves the raw transaction hex for a given transaction ID.
	GetTxHex(txid string) (string, error)

	// Broadcast broadcasts one or more raw transactions to the network.
	// Returns the transaction ID of the first transaction on success.
	Broadcast(txs ...string) (string, error)

	// GetBlockHeight returns the current block height.
	GetBlockHeight() (int64, error)

	// GetTxs retrieves all transactions associated with a given address.
	GetTxs(addr string) ([]Tx, error)

	// GetTxOutspends returns the spent status of all outputs for a given transaction.
	GetTxOutspends(tx string) ([]SpentStatus, error)

	// GetUtxos retrieves all unspent transaction outputs (UTXOs) for the given addresses.
	GetUtxos(addresses []string) ([]ExplorerUtxo, error)

	// GetRedeemedVtxosBalance calculates the redeemed virtual UTXO balance for an address
	// considering the unilateral exit delay.
	GetRedeemedVtxosBalance(
		addr string, unilateralExitDelay arklib.RelativeLocktime,
	) (uint64, map[int64]uint64, error)

	// GetTxBlockTime returns whether a transaction is confirmed and its block time.
	GetTxBlockTime(txid string) (confirmed bool, blocktime int64, err error)

	// BaseUrl returns the base URL of the explorer service.
	BaseUrl() string

	// GetFeeRate retrieves the current recommended fee rate in sat/vB.
	GetFeeRate() (float64, error)

	// GetConnectionCount returns the number of active WebSocket connections.
	GetConnectionCount() int

	// GetSubscribedAddresses returns a list of all currently subscribed addresses.
	GetSubscribedAddresses() []string

	// IsAddressSubscribed checks if a specific address is currently subscribed.
	IsAddressSubscribed(address string) bool

	// GetAddressesEvents returns a channel that receives onchain address events
	// (new UTXOs, spent UTXOs, confirmed UTXOs) for all subscribed addresses.
	GetAddressesEvents() <-chan OnchainAddressEvent

	// SubscribeForAddresses subscribes to address updates via WebSocket connections.
	// Addresses are automatically distributed across multiple connections using hash-based routing.
	// Subscriptions are batched to prevent overwhelming individual connections.
	// Duplicate subscriptions are automatically prevented via instance-scoped deduplication.
	SubscribeForAddresses(addresses []string) error

	// UnsubscribeForAddresses removes address subscriptions and updates the WebSocket connections.
	UnsubscribeForAddresses(addresses []string) error

	// Stop gracefully shuts down the explorer, closing all WebSocket connections and channels.
	Stop()
}

type ExplorerUtxo struct {
	Txid   string
	Vout   uint32
	Amount uint64
	Script string
	Status ConfirmedStatus
}

type FeeInfo struct {
	IntentFees arkfee.Config
	TxFeeRate  float64
}

type ForfeitTxsResponse struct {
	Txids []string
	Page  *PageResponse
}

type GetTxHistoryOption func(*getTxHistoryOption) error

type GetVtxosOption func(*getVtxosOption) error

type Identity interface {
	GetType() string
	Create(
		ctx context.Context, network arklib.Network, password, seed string,
	) (autoGeneratedSeed string, err error)
	Lock(ctx context.Context) (err error)
	Unlock(ctx context.Context, password string) (alreadyUnlocked bool, err error)
	IsLocked() bool
	NextKeyId(ctx context.Context, id string) (string, error)
	GetKeyIndex(ctx context.Context, id string) (index uint32, err error)
	NewKey(ctx context.Context) (key *KeyRef, err error)
	GetXpub(ctx context.Context) (xpub string, err error)
	GetKey(ctx context.Context, id string) (key *KeyRef, err error)
	ListKeys(ctx context.Context) (keys []KeyRef, err error)
	SignTransaction(
		ctx context.Context, tx string, keys map[string]string,
	) (signedTx string, err error)
	SignMessage(ctx context.Context, message []byte) (signature string, err error)
	Dump(ctx context.Context) (seed string, err error)
}

type Indexer interface {
	GetCommitmentTx(ctx context.Context, txid string) (*CommitmentTx, error)
	GetVtxoTree(
		ctx context.Context, batchOutpoint Outpoint, opts ...PageOption,
	) (*VtxoTreeResponse, error)
	GetFullVtxoTree(
		ctx context.Context, batchOutpoint Outpoint, opts ...PageOption,
	) ([]tree.TxTreeNode, error)
	GetVtxoTreeLeaves(
		ctx context.Context, batchOutpoint Outpoint, opts ...PageOption,
	) (*VtxoTreeLeavesResponse, error)
	GetForfeitTxs(
		ctx context.Context, txid string, opts ...PageOption,
	) (*ForfeitTxsResponse, error)
	GetConnectors(
		ctx context.Context, txid string, opts ...PageOption,
	) (*ConnectorsResponse, error)
	GetVtxos(ctx context.Context, opts ...GetVtxosOption) (*VtxosResponse, error)
	GetVtxoChain(
		ctx context.Context, outpoint Outpoint, opts ...PageOption,
	) (*VtxoChainResponse, error)
	GetVirtualTxs(
		ctx context.Context, txids []string, opts ...PageOption,
	) (*VirtualTxsResponse, error)
	GetBatchSweepTxs(ctx context.Context, batchOutpoint Outpoint) ([]string, error)
	NewSubscription(
		ctx context.Context, scripts []string,
	) (string, <-chan ScriptEvent, func(), error)
	UpdateSubscription(
		ctx context.Context, subscriptionId string, scriptsToAdd, scriptsToRemove []string,
	) error
	GetAsset(ctx context.Context, assetID string) (*AssetInfo, error)

	Close()
}

type IndexerChainedTxType string

type Info struct {
	Version                   string
	SignerPubKey              string
	ForfeitPubKey             string
	UnilateralExitDelay       int64
	BoardingExitDelay         int64
	SessionDuration           int64
	Network                   string
	Dust                      uint64
	ForfeitAddress            string
	ScheduledSessionStartTime int64
	ScheduledSessionEndTime   int64
	ScheduledSessionPeriod    int64
	ScheduledSessionDuration  int64
	ScheduledSessionFees      FeeInfo
	UtxoMinAmount             int64
	UtxoMaxAmount             int64
	VtxoMinAmount             int64
	VtxoMaxAmount             int64
	CheckpointTapscript       string
	MaxTxWeight               int64
	MaxOpReturnOutputs        int64
	Fees                      FeeInfo
	DeprecatedSignerPubKeys   []DeprecatedSignerInfo
	ServiceStatus             map[string]string
	Digest                    string
}

type Input struct {
	Output
	Txid string
	Vout uint32
}

type KeyRef struct {
	// Id can be anything and it's up to implementation whether it is, for example, a derivation
	// path or just a derivation index
	Id     string
	PubKey *btcec.PublicKey
}

type NewControlAsset struct {
	Amount uint64
}

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

type OnchainOutput struct {
	Outpoint
	Script    string
	Amount    uint64
	CreatedAt time.Time
	Spent     bool
	SpentBy   string
}

type Outpoint struct {
	Txid string
	VOut uint32
}

type Output struct {
	Script  string
	Address string
	Amount  uint64
}

type PageOption func(*pageOption) error

type PageRequest struct {
	Size  int32
	Index int32
}

type PageResponse struct {
	Current int32
	Next    int32
	Total   int32
}

type Receiver struct {
	To     string
	Amount uint64
	Assets []Asset
}

type ScriptEvent struct {
	Data       *ScriptEventData
	Connection *StreamConnectionEvent
	Err        error
}

type ScriptEventData struct {
	Txid          string
	Tx            string
	Scripts       []string
	NewVtxos      []Vtxo
	SpentVtxos    []Vtxo
	CheckpointTxs map[string]TxData
}

type ServerParams struct {
	ServerUrl           string
	SignerPubKey        *btcec.PublicKey
	ForfeitPubKey       *btcec.PublicKey
	Network             arklib.Network
	SessionDuration     int64
	UnilateralExitDelay arklib.RelativeLocktime
	Dust                uint64
	BoardingExitDelay   arklib.RelativeLocktime
	ExplorerURL         string
	ForfeitAddress      string
	UtxoMinAmount       int64
	UtxoMaxAmount       int64
	VtxoMinAmount       int64
	VtxoMaxAmount       int64
	CheckpointTapscript string
	Fees                FeeInfo
	DeprecatedSigners   []DeprecatedSigner
}

type SignFn func(ctx context.Context, tx string) (string, error)

type SpentStatus struct {
	Spent   bool
	SpentBy string
}

type StreamConnectionEvent struct {
	State          StreamConnectionState
	At             time.Time
	DisconnectedAt time.Time
	Err            error
}

type StreamConnectionState string

type StreamStartedEvent struct {
	Id string
}

type SyncEvent struct {
	Synced bool
	Err    error
}

type Transaction struct {
	TransactionKey
	Amount      uint64
	Type        TxType
	CreatedAt   time.Time
	Hex         string
	SettledBy   string
	AssetPacket asset.Packet
	// Assets is the per-asset breakdown for this transaction, expressed as
	// net amounts (gross inputs minus own change). Populated at construction
	// by any code path that has the source vtxos in hand — notably
	// funding.vtxosToTxs (for reconciled history) and the wallet-side
	// send/batch handlers (for just-signed sends). Nil for pure-BTC
	// transactions.
	Assets []Asset
}

type TransactionEvent struct {
	CommitmentTx *TxNotification
	ArkTx        *TxNotification
	SweepTx      *TxNotification
	Connection   *StreamConnectionEvent
	Err          error
}

type TransactionKey struct {
	BoardingTxid   string
	CommitmentTxid string
	ArkTxid        string
}

type TreeNoncesAggregatedEvent struct {
	Id     string
	Nonces tree.TreeNonces
}

type TreeNoncesEvent struct {
	Id     string
	Topic  []string
	Txid   string
	Nonces map[string]*tree.Musig2Nonce
}

type TreeSignatureEvent struct {
	Id         string
	Topic      []string
	BatchIndex int32
	Txid       string
	Signature  string
}

type TreeSigningStartedEvent struct {
	Id                   string
	UnsignedCommitmentTx string
	CosignersPubkeys     []string
}

type TreeTxEvent struct {
	Id         string
	Topic      []string
	BatchIndex int32
	Node       tree.TxTreeNode
}

type Tx struct {
	Txid   string
	Vin    []Input
	Vout   []Output
	Status ConfirmedStatus
}

type TxData struct {
	Txid string
	Tx   string
}

type TxHistoryResponse struct {
	History []Transaction
	Page    *PageResponse
}

type TxNode struct {
	Txid     string
	Children map[uint32]string
}

type TxNodes []TxNode

type TxNotification struct {
	TxData
	SpentVtxos     []Vtxo
	SpendableVtxos []Vtxo
	CheckpointTxs  map[Outpoint]TxData
	SweptVtxos     []Outpoint
}

type TxType string

type Utxo struct {
	Outpoint
	Amount         uint64
	Script         string
	Delay          arklib.RelativeLocktime
	RedeemableAt   time.Time
	CreatedAt      time.Time
	Spent          bool
	SpentBy        string
	Tx             string
	Assets         []Asset
	Tapscripts     []string
	SigningClosure script.Closure
}

type VirtualTxsResponse struct {
	Txs  []string
	Page *PageResponse
}

type Vtxo struct {
	Outpoint
	Script          string
	Amount          uint64
	CommitmentTxids []string
	ExpiresAt       time.Time
	CreatedAt       time.Time
	Preconfirmed    bool
	Swept           bool
	Unrolled        bool
	Spent           bool
	SpentBy         string
	SettledBy       string
	ArkTxid         string
	Assets          []Asset
	Tapscripts      []string
	SigningClosure  script.Closure
}

type VtxoChainResponse struct {
	Chain []ChainWithExpiry
	Page  *PageResponse
}

type VtxoTreeLeavesResponse struct {
	Leaves []Outpoint
	Page   *PageResponse
}

type VtxoTreeResponse struct {
	Tree []TxNode
	Page *PageResponse
}

type VtxosResponse struct {
	Vtxos []Vtxo
	Page  *PageResponse
}