arksdk

type ArkClient interface {
	GetConfigData(ctx context.Context) (*types.Config, error)
	Init(ctx context.Context, args InitArgs) error
	InitWithWallet(ctx context.Context, args InitWithWalletArgs) error
	IsLocked(ctx context.Context) bool
	Unlock(ctx context.Context, password string) error
	Lock(ctx context.Context) error
	Balance(ctx context.Context, computeExpiryDetails bool) (*Balance, error)
	Receive(ctx context.Context) (offchainAddr, boardingAddr string, err error)
	SendOffChain(
		ctx context.Context, withExpiryCoinselect bool, receivers []Receiver,
		withZeroFees bool,
	) (string, error)
	Settle(ctx context.Context, opts ...Option) (string, error)
	CollaborativeExit(
		ctx context.Context, addr string, amount uint64, withExpiryCoinselect bool,
		opts ...Option,
	) (string, error)
	StartUnilateralExit(ctx context.Context) error
	CompleteUnilateralExit(ctx context.Context, to string) (string, error)
	OnboardAgainAllExpiredBoardings(ctx context.Context) (string, error)
	WithdrawFromAllExpiredBoardings(ctx context.Context, to string) (string, error)
	ListVtxos(ctx context.Context) (spendable, spent []client.Vtxo, err error)
	Dump(ctx context.Context) (seed string, err error)
	GetTransactionHistory(ctx context.Context) ([]types.Transaction, error)
	GetTransactionEventChannel(ctx context.Context) chan types.TransactionEvent
	GetVtxoEventChannel(ctx context.Context) chan types.VtxoEvent
	RedeemNotes(ctx context.Context, notes []string, opts ...Option) (string, error)
	SignTransaction(ctx context.Context, tx string) (string, error)
	NotifyIncomingFunds(ctx context.Context, address string) ([]types.Vtxo, error)
	Reset(ctx context.Context)
	Stop()
}

type Balance struct {
	OnchainBalance  OnchainBalance  `json:"onchain_balance"`
	OffchainBalance OffchainBalance `json:"offchain_balance"`
}

type CoinSelectOptions struct {
	// If true, coin selector will select coins closest to expiry first.
	WithExpirySorting bool
	// If specified, coin selector will select only coins in the list.
	OutpointsFilter []client.Outpoint
	// If true, coin selector will select recoverable (swept but unspent) vtxos first.
	SelectRecoverableVtxos bool
}

type InitArgs struct {
	ClientType          string
	WalletType          string
	ServerUrl           string
	Seed                string
	Password            string
	ExplorerURL         string
	WithTransactionFeed bool
}

type InitWithWalletArgs struct {
	ClientType          string
	Wallet              wallet.WalletService
	ServerUrl           string
	Seed                string
	Password            string
	ExplorerURL         string
	WithTransactionFeed bool
}

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"`
}

type OnchainBalance struct {
	SpendableAmount uint64                 `json:"spendable_amount"`
	LockedAmount    []LockedOnchainBalance `json:"locked_amount,omitempty"`
}

type Option func(options interface{}) error

type Receiver interface {
	To() string
	Amount() uint64

	IsOnchain() bool
}

type SettleOptions struct {
	ExtraSignerSessions    []tree.SignerSession
	SigningType            *tree.SigningType
	WalletSignerDisabled   bool
	SelectRecoverableVtxos bool

	EventsCh chan<- client.RoundEvent
}

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