-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: block history estimator (#688)
* block history estimator
* tidy + lint
* fix broken txm tests
* replace {} (empty = finalized) with confirmed commitment
* add blockhistory estimator config- Loading branch information
Showing
16 changed files
with
119,769 additions
and
685 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| package fees | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/logger" | ||
| "github.com/smartcontractkit/chainlink-common/pkg/services" | ||
| "github.com/smartcontractkit/chainlink-common/pkg/utils" | ||
| "github.com/smartcontractkit/chainlink-common/pkg/utils/mathutil" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-solana/pkg/solana/client" | ||
| "github.com/smartcontractkit/chainlink-solana/pkg/solana/config" | ||
| ) | ||
|
|
||
| var _ Estimator = &blockHistoryEstimator{} | ||
|
|
||
| type blockHistoryEstimator struct { | ||
| starter services.StateMachine | ||
| chStop chan struct{} | ||
| done sync.WaitGroup | ||
|
|
||
| client *utils.LazyLoad[client.ReaderWriter] | ||
| cfg config.Config | ||
| lgr logger.Logger | ||
|
|
||
| price uint64 | ||
| lock sync.RWMutex | ||
| } | ||
|
|
||
| // NewBlockHistoryEstimator creates a new fee estimator that parses historical fees from a fetched block | ||
| // Note: getRecentPrioritizationFees is not used because it provides the lowest prioritization fee for an included tx in the block | ||
| // which is not effective enough for increasing the chances of block inclusion | ||
| func NewBlockHistoryEstimator(c *utils.LazyLoad[client.ReaderWriter], cfg config.Config, lgr logger.Logger) (*blockHistoryEstimator, error) { | ||
| return &blockHistoryEstimator{ | ||
| chStop: make(chan struct{}), | ||
| client: c, | ||
| cfg: cfg, | ||
| lgr: lgr, | ||
| price: cfg.ComputeUnitPriceDefault(), // use default value | ||
| }, nil | ||
| } | ||
|
|
||
| func (bhe *blockHistoryEstimator) Start(ctx context.Context) error { | ||
| return bhe.starter.StartOnce("solana_blockHistoryEstimator", func() error { | ||
| bhe.done.Add(1) | ||
| go bhe.run() | ||
| bhe.lgr.Debugw("BlockHistoryEstimator: started") | ||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| func (bhe *blockHistoryEstimator) run() { | ||
| defer bhe.done.Done() | ||
|
|
||
| tick := time.After(0) | ||
| for { | ||
| select { | ||
| case <-bhe.chStop: | ||
| return | ||
| case <-tick: | ||
| if err := bhe.calculatePrice(); err != nil { | ||
| bhe.lgr.Error(fmt.Errorf("BlockHistoryEstimator failed to fetch price: %w", err)) | ||
| } | ||
| } | ||
|
|
||
| tick = time.After(utils.WithJitter(bhe.cfg.BlockHistoryPollPeriod())) | ||
| } | ||
| } | ||
|
|
||
| func (bhe *blockHistoryEstimator) Close() error { | ||
| close(bhe.chStop) | ||
| bhe.done.Wait() | ||
| bhe.lgr.Debugw("BlockHistoryEstimator: stopped") | ||
| return nil | ||
| } | ||
|
|
||
| func (bhe *blockHistoryEstimator) BaseComputeUnitPrice() uint64 { | ||
| price := bhe.readRawPrice() | ||
| if price >= bhe.cfg.ComputeUnitPriceMin() && price <= bhe.cfg.ComputeUnitPriceMax() { | ||
| return price | ||
| } | ||
|
|
||
| if price < bhe.cfg.ComputeUnitPriceMin() { | ||
| bhe.lgr.Warnw("BlockHistoryEstimator: estimation below minimum consider lowering ComputeUnitPriceMin", "min", bhe.cfg.ComputeUnitPriceMin(), "calculated", price) | ||
| return bhe.cfg.ComputeUnitPriceMin() | ||
| } | ||
|
|
||
| bhe.lgr.Warnw("BlockHistoryEstimator: estimation above maximum consider increasing ComputeUnitPriceMax", "min", bhe.cfg.ComputeUnitPriceMax(), "calculated", price) | ||
| return bhe.cfg.ComputeUnitPriceMax() | ||
| } | ||
|
|
||
| func (bhe *blockHistoryEstimator) readRawPrice() uint64 { | ||
| bhe.lock.RLock() | ||
| defer bhe.lock.RUnlock() | ||
| return bhe.price | ||
| } | ||
|
|
||
| func (bhe *blockHistoryEstimator) calculatePrice() error { | ||
| // fetch client | ||
| c, err := bhe.client.Get() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get client in blockHistoryEstimator.getFee: %w", err) | ||
| } | ||
|
|
||
| // get latest block based on configured confirmation | ||
| block, err := c.GetLatestBlock() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get block in blockHistoryEstimator.getFee: %w", err) | ||
| } | ||
|
|
||
| // parse block for fee data | ||
| feeData, err := ParseBlock(block) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to parse block in blockHistoryEstimator.getFee: %w", err) | ||
| } | ||
|
|
||
| // take median of returned fee values | ||
| v, err := mathutil.Median(feeData.Prices...) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to find median in blockHistoryEstimator.getFee: %w", err) | ||
| } | ||
|
|
||
| // set data | ||
| bhe.lock.Lock() | ||
| bhe.price = uint64(v) // ComputeUnitPrice is uint64 underneath | ||
| bhe.lock.Unlock() | ||
| bhe.lgr.Debugw("BlockHistoryEstimator: updated", | ||
| "computeUnitPrice", v, | ||
| "blockhash", block.Blockhash, | ||
| "slot", block.ParentSlot+1, | ||
| "count", len(feeData.Prices), | ||
| ) | ||
| return nil | ||
| } |
Oops, something went wrong.