arksdk

type ArkClient interface {
	Wallet() wallet.WalletService
	Transport() client.TransportClient
	Indexer() indexer.Indexer
	Explorer() explorer.Explorer

	GetVersion() string
	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
	Dump(ctx context.Context) (seed string, err error)
	SignTransaction(ctx context.Context, tx string) (string, error)
	Reset(ctx context.Context)
	Stop()
	// ** Funding **
	Receive(
		ctx context.Context,
	) (onchainAddr string, offchainAddr, boardingAddr *types.Address, err error)
	GetAddresses(ctx context.Context) (
		onchainAddresses, offchainAddresses, boardingAddresses, redemptionAddresses []string,
		err error,
	)
	Balance(ctx context.Context) (*Balance, error)
	ListVtxos(ctx context.Context, opts ...ListVtxosOption) (spendable, spent []types.Vtxo, err error)
	GetTransactionHistory(ctx context.Context) ([]types.Transaction, error)
	NotifyIncomingFunds(ctx context.Context, address string) ([]types.Vtxo, error)
	// ** Assets **
	IssueAsset(
		ctx context.Context, amount uint64, controlAsset types.ControlAsset,
		metadata []asset.Metadata, opts ...SendOption,
	) (*IssueAssetRes, error)
	ReissueAsset(
		ctx context.Context, assetId string, amount uint64, opts ...SendOption,
	) (*ReissueAssetRes, error)
	BurnAsset(
		ctx context.Context, assetID string, amount uint64, opts ...SendOption,
	) (*BurnAssetRes, error)
	// ** Offchain txs **
	SendOffChain(
		ctx context.Context, receivers []types.Receiver, opts ...SendOption,
	) (*SendOffChainRes, error)
	FinalizePendingTxs(ctx context.Context, createdAfter *time.Time) ([]string, error)
	// ** Batch session **
	Settle(ctx context.Context, opts ...BatchSessionOption) (*SettleRes, error)
	CollaborativeExit(
		ctx context.Context, addr string, amount uint64, opts ...BatchSessionOption,
	) (*CollaborativeExitRes, error)
	RedeemNotes(ctx context.Context, notes []string, opts ...BatchSessionOption) (*RedeemNotesRes, error)
	RegisterIntent(
		ctx context.Context, vtxos []types.Vtxo, boardingUtxos []types.Utxo, notes []string,
		outputs []types.Receiver, cosignersPublicKeys []string,
	) (intentID string, err error)
	DeleteIntent(
		ctx context.Context, vtxos []types.Vtxo, boardingUtxos []types.Utxo, notes []string,
	) error
	// ** Unroll **
	Unroll(ctx context.Context, opts ...UnrollOption) ([]UnrollRes, error)
	CompleteUnroll(ctx context.Context, to string) (string, error)
	OnboardAgainAllExpiredBoardings(ctx context.Context) (string, error)
	WithdrawFromAllExpiredBoardings(ctx context.Context, to string) (string, error)
}

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

type BatchEventHandlerOption func(*options)

type BatchEventsHandler interface {
	OnBatchStarted(
		ctx context.Context, event client.BatchStartedEvent,
	) (bool, time.Duration, error)
	OnBatchFinalized(ctx context.Context, event client.BatchFinalizedEvent) error
	OnBatchFailed(ctx context.Context, event client.BatchFailedEvent) error
	OnTreeTxEvent(ctx context.Context, event client.TreeTxEvent) error
	OnTreeSignatureEvent(ctx context.Context, event client.TreeSignatureEvent) error
	OnTreeSigningStarted(
		ctx context.Context, event client.TreeSigningStartedEvent, vtxoTree *tree.TxTree,
	) (bool, error)
	OnTreeNoncesAggregated(
		ctx context.Context,
		event client.TreeNoncesAggregatedEvent,
	) (signed bool, err error)
	OnTreeNonces(ctx context.Context, event client.TreeNoncesEvent) (signed bool, err error)
	OnBatchFinalization(
		ctx context.Context,
		event client.BatchFinalizationEvent, vtxoTree, connectorTree *tree.TxTree,
	) ([]string, error)
	OnStreamStarted(
		ctx context.Context, event client.StreamStartedEvent,
	) error
}

type BatchSessionOption func(options *batchSessionOptions) error

type BatchTxRes struct {
	CommitmentTxid string
	CommitmentTx   string
	IntentTx       string
	ForfeitTxs     []string
	VtxoInputs     []types.Vtxo
	UtxoInputs     []types.Utxo
	VtxoOutputs    []types.Vtxo
	UtxoOutputs    []types.Receiver
	Extension      extension.Extension
}

type BurnAssetRes = OffchainTxRes

type CollaborativeExitRes = BatchTxRes

type FinalizePendingTxsRes = []OffchainTxRes

type InitArgs struct {
	WalletType  string
	ServerUrl   string
	Seed        string
	Password    string
	ExplorerURL string
	Explorer    explorer.Explorer
}

type InitWithWalletArgs struct {
	Wallet      wallet.WalletService
	ServerUrl   string
	Seed        string
	Password    string
	ExplorerURL string
	Explorer    explorer.Explorer
}

type IssueAssetRes struct {
	OffchainTxRes
	IssuedAssets []asset.AssetId
}

type ListVtxosOption func(options *listVtxosOptions) error

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 OffchainTxRes struct {
	Txid        string
	Tx          string
	Checkpoints []string
	Inputs      []types.Vtxo
	Outputs     []types.Receiver
	Extension   extension.Extension
}

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

type RedeemNotesRes = BatchTxRes

type ReissueAssetRes = OffchainTxRes

type SendOffChainRes = OffchainTxRes

type SendOption func(options *sendOptions) error

type ServiceOption func(*service)

type SettleRes = BatchTxRes

type UnrollOption func(options *unrollOptions) error

type UnrollRes struct {
	ParentTx   string
	ParentTxid string
	ChildTx    string
	ChildTxid  string
}

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