extended

type API interface {
	// GetAccountTransactions returns a paginated list of transactions for the given account address.
	// Results are ordered descending by block height (newest first).
	//
	// If the account is found but has no transactions, the response will include an empty array and no error.
	//
	// Expected error returns during normal operations:
	//   - [codes.NotFound] if the account is not found
	//   - [codes.FailedPrecondition] if the account transaction index has not been initialized
	//   - [codes.OutOfRange] if the cursor references a height outside the indexed range
	//   - [codes.InvalidArgument] if the query parameters are invalid
	GetAccountTransactions(
		ctx context.Context,
		address flow.Address,
		limit uint32,
		cursor *accessmodel.AccountTransactionCursor,
		filter AccountTransactionFilter,
		expandOptions AccountTransactionExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.AccountTransactionsPage, error)

	// GetAccountFungibleTokenTransfers returns a paginated list of fungible token transfers for
	// the given account address. Results are ordered descending by block height (newest first).
	//
	// If the account has no transfers, the response will include an empty array and no error.
	//
	// Expected error returns during normal operations:
	//   - [codes.NotFound] if the account is not found
	//   - [codes.FailedPrecondition] if the fungible token transfer index has not been initialized
	//   - [codes.OutOfRange] if the cursor references a height outside the indexed range
	//   - [codes.InvalidArgument] if the query parameters are invalid
	GetAccountFungibleTokenTransfers(
		ctx context.Context,
		address flow.Address,
		limit uint32,
		cursor *accessmodel.TransferCursor,
		filter AccountTransferFilter,
		expandOptions AccountTransferExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.FungibleTokenTransfersPage, error)

	// GetAccountNonFungibleTokenTransfers returns a paginated list of non-fungible token transfers
	// for the given account address. Results are ordered descending by block height (newest first).
	//
	// If the account has no transfers, the response will include an empty array and no error.
	//
	// Expected error returns during normal operations:
	//   - [codes.NotFound] if the account is not found
	//   - [codes.FailedPrecondition] if the non-fungible token transfer index has not been initialized
	//   - [codes.OutOfRange] if the cursor references a height outside the indexed range
	//   - [codes.InvalidArgument] if the query parameters are invalid
	GetAccountNonFungibleTokenTransfers(
		ctx context.Context,
		address flow.Address,
		limit uint32,
		cursor *accessmodel.TransferCursor,
		filter AccountTransferFilter,
		expandOptions AccountTransferExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.NonFungibleTokenTransfersPage, error)

	// GetScheduledTransaction returns a single scheduled transaction by its scheduler-assigned ID.
	//
	// Expected error returns during normal operations:
	//   - [codes.NotFound]: if no transaction with the given ID exists
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	GetScheduledTransaction(
		ctx context.Context,
		id uint64,
		expandOptions ScheduledTransactionExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ScheduledTransaction, error)

	// GetScheduledTransactions returns a paginated list of scheduled transactions.
	//
	// Expected error returns during normal operations:
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	//   - [codes.InvalidArgument]: if the query parameters are invalid
	GetScheduledTransactions(
		ctx context.Context,
		limit uint32,
		cursor *accessmodel.ScheduledTransactionCursor,
		filter ScheduledTransactionFilter,
		expandOptions ScheduledTransactionExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ScheduledTransactionsPage, error)

	// GetScheduledTransactionsByAddress returns a paginated list of scheduled transactions for the given address.
	//
	// Expected error returns during normal operations:
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	//   - [codes.InvalidArgument]: if the query parameters are invalid
	GetScheduledTransactionsByAddress(
		ctx context.Context,
		address flow.Address,
		limit uint32,
		cursor *accessmodel.ScheduledTransactionCursor,
		filter ScheduledTransactionFilter,
		expandOptions ScheduledTransactionExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ScheduledTransactionsPage, error)

	// GetContract returns the most recent deployment of the given contract.
	//
	// Expected error returns during normal operations:
	//   - [codes.NotFound]: if no contract with the given identifier exists
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	GetContract(
		ctx context.Context,
		id string,
		filter ContractDeploymentFilter,
		expandOptions ContractDeploymentExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ContractDeployment, error)

	// GetContractDeployments returns a paginated list of all deployments of the given contract,
	// most recent first.
	//
	// Expected error returns during normal operations:
	//   - [codes.NotFound]: if no contract with the given identifier exists
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	//   - [codes.InvalidArgument]: if query parameters are invalid
	GetContractDeployments(
		ctx context.Context,
		id string,
		limit uint32,
		cursor *accessmodel.ContractDeploymentsCursor,
		filter ContractDeploymentFilter,
		expandOptions ContractDeploymentExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ContractDeploymentPage, error)

	// GetContracts returns a paginated list of contracts at their latest deployment.
	//
	// Expected error returns during normal operations:
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	//   - [codes.InvalidArgument]: if query parameters are invalid
	GetContracts(
		ctx context.Context,
		limit uint32,
		cursor *accessmodel.ContractDeploymentsCursor,
		filter ContractDeploymentFilter,
		expandOptions ContractDeploymentExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ContractDeploymentPage, error)

	// GetContractsByAddress returns a paginated list of contracts at their latest deployment for
	// the given address.
	//
	// Expected error returns during normal operations:
	//   - [codes.FailedPrecondition]: if the index has not been initialized
	//   - [codes.InvalidArgument]: if query parameters are invalid
	GetContractsByAddress(
		ctx context.Context,
		address flow.Address,
		limit uint32,
		cursor *accessmodel.ContractDeploymentsCursor,
		filter ContractDeploymentFilter,
		expandOptions ContractDeploymentExpandOptions,
		encodingVersion entities.EventEncodingVersion,
	) (*accessmodel.ContractDeploymentPage, error)
}

type AccountTransactionExpandOptions struct {
	Result      bool
	Transaction bool
}

type AccountTransactionFilter struct {
	Roles []accessmodel.TransactionRole
}

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

type AccountTransferExpandOptions struct {
	Transaction bool
	Result      bool
}

type AccountTransferFilter struct {
	TokenType        string
	SourceAddress    flow.Address
	RecipientAddress flow.Address
}

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

type Backend struct {
	*AccountTransactionsBackend
	*AccountTransfersBackend
	*ScheduledTransactionsBackend
	*ContractsBackend
	// contains filtered or unexported fields
}

type Config struct {
	DefaultPageSize uint32 // Page size used when limit is 0.
	MaxPageSize     uint32 // Maximum allowed page size.
}

type ContractDeploymentExpandOptions struct {
	Code        bool
	Transaction bool
	Result      bool
}

type ContractDeploymentFilter struct {
	// ContractName is a partial match against the name component of the contract identifier
	// (e.g. "A.{addr}.{name}").
	ContractName string
	// StartBlock is an inclusive block height lower bound.
	StartBlock *uint64
	// EndBlock is an inclusive block height upper bound.
	EndBlock *uint64
}

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

type ScheduledTransactionExpandOptions struct {
	Result          bool
	Transaction     bool
	HandlerContract bool
}

type ScheduledTransactionFilter struct {
	Statuses                 []accessmodel.ScheduledTransactionStatus
	Priority                 *accessmodel.ScheduledTransactionPriority
	StartTime                *uint64 // inclusive UFix64 timestamp lower bound
	EndTime                  *uint64 // inclusive UFix64 timestamp upper bound
	TransactionHandlerOwner  *flow.Address
	TransactionHandlerTypeID *string
	TransactionHandlerUUID   *uint64
}

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