core/txpool: add more docs for reserver

This commit is contained in:
lightclient 2025-04-08 07:21:31 -06:00
parent 38783b7e1b
commit 9602d6cdfc
No known key found for this signature in database
GPG key ID: 657913021EF45A6A

View file

@ -50,12 +50,16 @@ func NewReservationTracker() *ReservationTracker {
} }
} }
// NewHandle creates a named handle on the ReservationTracker. // NewHandle creates a named handle on the ReservationTracker. The handle
// identifies the subpool so ownership of reservations can be determined.
func (r *ReservationTracker) NewHandle(id int) *Reserver { func (r *ReservationTracker) NewHandle(id int) *Reserver {
return &Reserver{r, id} return &Reserver{r, id}
} }
// Reserver is a named handle on ReservationTracker. // Reserver is a named handle on ReservationTracker. It is held by subpools to
// make reservations for accounts it is tracking. The id is used to determine
// which pool owns an address and disallows non-owners to hold or release
// addresses it doesn't own.
type Reserver struct { type Reserver struct {
tracker *ReservationTracker tracker *ReservationTracker
id int id int