core

type ActionAllowance struct {
	GatedAction GatedAction
	TimeWindow  string
	Allowance   uint64
	Used        uint64
}

type AppRegistryClient interface {
	ApproveToken(amount decimal.Decimal) (string, error)
	GetBalance(user string) (decimal.Decimal, error)
	GetTokenDecimals() (uint8, error)

	Lock(targetWallet string, amount decimal.Decimal) (string, error)
	Relock() (string, error)
	Unlock() (string, error)
	Withdraw(destinationWallet string) (string, error)
}

type Asset struct {
	Name                  string  `json:"name"`                    // Asset name
	Decimals              uint8   `json:"decimals"`                // Number of decimal places at YN
	Symbol                string  `json:"symbol"`                  // Asset symbol
	SuggestedBlockchainID uint64  `json:"suggested_blockchain_id"` // Suggested blockchain network ID for this asset
	Tokens                []Token `json:"tokens"`                  // Supported tokens for the asset
}

type AssetStore interface {
	// GetAssetDecimals checks if an asset exists and returns its decimals in YN
	GetAssetDecimals(asset string) (uint8, error)

	// GetTokenDecimals returns the decimals for a token on a specific blockchain
	GetTokenDecimals(blockchainID uint64, tokenAddress string) (uint8, error)
}

type BalanceEntry struct {
	Asset   string          `json:"asset"`   // Asset symbol
	Balance decimal.Decimal `json:"balance"` // Balance amount
}

type Blockchain struct {
	Name                   string `json:"name"`                     // Blockchain name
	ID                     uint64 `json:"id"`                       // Blockchain network ID
	ChannelHubAddress      string `json:"channel_hub_address"`      // Address of the ChannelHub contract on this blockchain
	LockingContractAddress string `json:"locking_contract_address"` // Address of the Locking contract on this blockchain
	BlockStep              uint64 `json:"block_step"`               // Number of blocks between each channel update
}

type BlockchainClient interface {
	// Getters - IVault
	GetAccountsBalances(accounts []string, tokens []string) ([][]decimal.Decimal, error)

	// Getters - Token Balance & Approval
	GetTokenBalance(asset string, walletAddress string) (decimal.Decimal, error)
	Approve(asset string, amount decimal.Decimal) (string, error)

	// Getters - ChannelsHub
	GetNodeBalance(token string) (decimal.Decimal, error)
	GetOpenChannels(user string) ([]string, error)
	GetHomeChannelData(homeChannelID string) (HomeChannelDataResponse, error)
	GetEscrowDepositData(escrowChannelID string) (EscrowDepositDataResponse, error)
	GetEscrowWithdrawalData(escrowChannelID string) (EscrowWithdrawalDataResponse, error)

	// IVault functions
	Deposit(node, token string, amount decimal.Decimal) (string, error)
	Withdraw(node, token string, amount decimal.Decimal) (string, error)

	// Node lifecycle
	EnsureSigValidatorRegistered(validatorID uint8, validatorAddress string, checkOnly bool) error

	// Channel lifecycle
	Create(def ChannelDefinition, initCCS State) (string, error)
	MigrateChannelHere(def ChannelDefinition, candidate State) (string, error)
	Checkpoint(candidate State) (string, error)
	Challenge(candidate State, challengerSig []byte, challengerIdx ChannelParticipant) (string, error)
	Close(candidate State) (string, error)

	// Escrow deposit
	InitiateEscrowDeposit(def ChannelDefinition, initCCS State) (string, error)
	ChallengeEscrowDeposit(candidate State, challengerSig []byte, challengerIdx ChannelParticipant) (string, error)
	FinalizeEscrowDeposit(candidate State) (string, error)

	// Escrow withdrawal
	InitiateEscrowWithdrawal(def ChannelDefinition, initCCS State) (string, error)
	ChallengeEscrowWithdrawal(candidate State, challengerSig []byte, challengerIdx ChannelParticipant) (string, error)
	FinalizeEscrowWithdrawal(candidate State) (string, error)
}

type BlockchainEvent struct {
	ContractAddress string `json:"contract_address"`
	BlockchainID    uint64 `json:"blockchain_id"`
	Name            string `json:"name"`
	BlockNumber     uint64 `json:"block_number"`
	TransactionHash string `json:"transaction_hash"`
	LogIndex        uint32 `json:"log_index"`
}

type Channel struct {
	ChannelID             string        `json:"channel_id"`                     // Unique identifier for the channel
	UserWallet            string        `json:"user_wallet"`                    // User wallet address
	Asset                 string        `json:"asset"`                          // Asset symbol (e.g. USDC, ETH)
	Type                  ChannelType   `json:"type"`                           // Type of the channel (home, escrow)
	BlockchainID          uint64        `json:"blockchain_id"`                  // Unique identifier for the blockchain
	TokenAddress          string        `json:"token_address"`                  // Address of the token used in the channel
	ChallengeDuration     uint32        `json:"challenge_duration"`             // Challenge period for the channel in seconds
	ChallengeExpiresAt    *time.Time    `json:"challenge_expires_at,omitempty"` // Timestamp when the challenge period elapses
	Nonce                 uint64        `json:"nonce"`                          // Nonce for the channel
	ApprovedSigValidators string        `json:"approved_sig_validators"`        // Bitmask representing approved signature validators for the channel
	Status                ChannelStatus `json:"status"`                         // Current status of the channel (void, open, challenged, closed)
	StateVersion          uint64        `json:"state_version"`                  // On-chain state version of the channel
}

type ChannelDefaultSigner struct {
	sign.Signer
}

type ChannelDefinition struct {
	Nonce                 uint64 `json:"nonce"`                   // A unique number to prevent replay attacks
	Challenge             uint32 `json:"challenge"`               // Challenge period for the channel in seconds
	ApprovedSigValidators string `json:"approved_sig_validators"` // Bitmask representing approved signature validators for the channel
}

type ChannelHubEventHandler interface {
	HandleHomeChannelCreated(context.Context, *HomeChannelCreatedEvent) error
	HandleHomeChannelMigrated(context.Context, *HomeChannelMigratedEvent) error
	HandleHomeChannelCheckpointed(context.Context, *HomeChannelCheckpointedEvent) error
	HandleHomeChannelChallenged(context.Context, *HomeChannelChallengedEvent) error
	HandleHomeChannelClosed(context.Context, *HomeChannelClosedEvent) error
	HandleEscrowDepositInitiated(context.Context, *EscrowDepositInitiatedEvent) error
	HandleEscrowDepositChallenged(context.Context, *EscrowDepositChallengedEvent) error
	HandleEscrowDepositFinalized(context.Context, *EscrowDepositFinalizedEvent) error
	HandleEscrowWithdrawalInitiated(context.Context, *EscrowWithdrawalInitiatedEvent) error
	HandleEscrowWithdrawalChallenged(context.Context, *EscrowWithdrawalChallengedEvent) error
	HandleEscrowWithdrawalFinalized(context.Context, *EscrowWithdrawalFinalizedEvent) error
}

type ChannelParticipant uint8

type ChannelSessionKeySignerV1 struct {
	sign.Signer
	// contains filtered or unexported fields
}

type ChannelSessionKeyStateV1 struct {
	// ID Hash(user_address + session_key + version)
	UserAddress string    `json:"user_address"` // UserAddress is the user wallet address
	SessionKey  string    `json:"session_key"`  // SessionKey is the session key address for delegation
	Version     uint64    `json:"version"`      // Version is the version of the session key format
	Assets      []string  `json:"assets"`       // Assets associated with this session key
	ExpiresAt   time.Time `json:"expires_at"`   // Expiration time as unix timestamp of this session key
	UserSig     string    `json:"user_sig"`     // UserSig is the user's signature over the session key metadata to authorize the registration/update of the session key
}

type ChannelSigValidator struct {
	// contains filtered or unexported fields
}

type ChannelSigner interface {
	sign.Signer
	Type() ChannelSignerType
}

type ChannelSignerType uint8

type ChannelStatus uint8

type ChannelType uint8

type EscrowDepositChallengedEvent channelChallengedEvent

type EscrowDepositDataResponse struct {
	EscrowChannelID string `json:"escrow_channel_id"`
	Node            string `json:"node"`
	LastState       State  `json:"last_state"`
	UnlockExpiry    uint64 `json:"unlock_expiry"`
	ChallengeExpiry uint64 `json:"challenge_expiry"`
}

type EscrowDepositFinalizedEvent channelEvent

type EscrowDepositInitiatedEvent channelEvent

type EscrowWithdrawalChallengedEvent channelChallengedEvent

type EscrowWithdrawalDataResponse struct {
	EscrowChannelID string `json:"escrow_channel_id"`
	Node            string `json:"node"`
	LastState       State  `json:"last_state"`
}

type EscrowWithdrawalFinalizedEvent channelEvent

type EscrowWithdrawalInitiatedEvent channelEvent

type GatedAction string

type HomeChannelChallengedEvent channelChallengedEvent

type HomeChannelCheckpointedEvent channelEvent

type HomeChannelClosedEvent channelEvent

type HomeChannelCreatedEvent channelEvent

type HomeChannelDataResponse struct {
	Definition      ChannelDefinition `json:"definition"`
	Node            string            `json:"node"`
	LastState       State             `json:"last_state"`
	ChallengeExpiry uint64            `json:"challenge_expiry"`
}

type HomeChannelMigratedEvent channelEvent

type Ledger struct {
	TokenAddress string          `json:"token_address"` // Address of the token used in this channel
	BlockchainID uint64          `json:"blockchain_id"` // Unique identifier for the blockchain
	UserBalance  decimal.Decimal `json:"user_balance"`  // User balance in the channel
	UserNetFlow  decimal.Decimal `json:"user_net_flow"` // User net flow in the channel
	NodeBalance  decimal.Decimal `json:"node_balance"`  // Node balance in the channel
	NodeNetFlow  decimal.Decimal `json:"node_net_flow"` // Node net flow in the channel
}

type LockingContractEventHandler interface {
	HandleUserLockedBalanceUpdated(context.Context, *UserLockedBalanceUpdatedEvent) error
}

type NodeConfig struct {
	// NodeAddress is the Ethereum address of the clearnode operator
	NodeAddress string

	// NodeVersion is the software version of the clearnode instance
	NodeVersion string

	// SupportedSigValidators is the list of supported signature validator types
	SupportedSigValidators []ChannelSignerType

	// Blockchains is the list of supported blockchain networks
	Blockchains []Blockchain
}

type PaginationMetadata struct {
	Page       uint32 `json:"page"`        // Current page number
	PerPage    uint32 `json:"per_page"`    // Number of items per page
	TotalCount uint32 `json:"total_count"` // Total number of items
	PageCount  uint32 `json:"page_count"`  // Total number of pages
}

type PaginationParams struct {
	Offset *uint32
	Limit  *uint32
	Sort   *string
}

type State struct {
	ID              string     `json:"id"`                          // Deterministic ID (hash) of the state
	Transition      Transition `json:"transition"`                  // The transition that led to this state
	Asset           string     `json:"asset"`                       // Asset type of the state
	UserWallet      string     `json:"user_wallet"`                 // User wallet address
	Epoch           uint64     `json:"epoch"`                       // User Epoch Index
	Version         uint64     `json:"version"`                     // Version of the state
	HomeChannelID   *string    `json:"home_channel_id,omitempty"`   // Identifier for the home Channel ID
	EscrowChannelID *string    `json:"escrow_channel_id,omitempty"` // Identifier for the escrow Channel ID
	HomeLedger      Ledger     `json:"home_ledger"`                 // User and node balances for the home channel
	EscrowLedger    *Ledger    `json:"escrow_ledger,omitempty"`     // User and node balances for the escrow channel
	UserSig         *string    `json:"user_sig,omitempty"`          // User signature for the state
	NodeSig         *string    `json:"node_sig,omitempty"`          // Node signature for the state
}

type StateAdvancer interface {
	ValidateAdvancement(currentState, proposedState State) error
}

type StateAdvancerV1 struct {
	// contains filtered or unexported fields
}

type StatePacker interface {
	PackState(state State) ([]byte, error)
}

type StatePackerV1 struct {
	// contains filtered or unexported fields
}

type Token struct {
	Name         string `json:"name"`          // Token name
	Symbol       string `json:"symbol"`        // Token symbol
	Address      string `json:"address"`       // Token contract address
	BlockchainID uint64 `json:"blockchain_id"` // Blockchain network ID
	Decimals     uint8  `json:"decimals"`      // Number of decimal places
}

type Transaction struct {
	ID                 string          `json:"id"`                              // Unique transaction reference
	Asset              string          `json:"asset"`                           // Asset symbol
	TxType             TransactionType `json:"tx_type"`                         // Transaction type
	FromAccount        string          `json:"from_account"`                    // The account that sent the funds
	ToAccount          string          `json:"to_account"`                      // The account that received the funds
	SenderNewStateID   *string         `json:"sender_new_state_id,omitempty"`   // The ID of the new sender's channel state
	ReceiverNewStateID *string         `json:"receiver_new_state_id,omitempty"` // The ID of the new receiver's channel state
	Amount             decimal.Decimal `json:"amount"`                          // Transaction amount
	CreatedAt          time.Time       `json:"created_at"`                      // When the transaction was created
}

type TransactionType uint8

type Transition struct {
	Type      TransitionType  `json:"type"`       // Type of state transition
	TxID      string          `json:"tx_id"`      // Transaction ID associated with the transition
	AccountID string          `json:"account_id"` // Account identifier (varies based on transition type)
	Amount    decimal.Decimal `json:"amount"`     // Amount involved in the transition
}

type TransitionType uint8

type UserLockedBalanceUpdatedEvent struct {
	UserAddress  string          `json:"user_address"`
	BlockchainID uint64          `json:"blockchain_id"`
	Balance      decimal.Decimal `json:"balance"`
}

type VerifyChannelSessionKePermissionsV1 func(walletAddr, sessionKeyAddr, metadataHash string) (bool, error)