Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New analyzer to fetch runtime bytecode of EVM contracts
- Loading branch information
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| package evmcontractcode | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "golang.org/x/sync/errgroup" | ||
|
|
||
| "github.com/oasisprotocol/oasis-indexer/analyzer" | ||
| "github.com/oasisprotocol/oasis-indexer/analyzer/queries" | ||
| "github.com/oasisprotocol/oasis-indexer/analyzer/util" | ||
| "github.com/oasisprotocol/oasis-indexer/common" | ||
| "github.com/oasisprotocol/oasis-indexer/log" | ||
| "github.com/oasisprotocol/oasis-indexer/storage" | ||
| "github.com/oasisprotocol/oasis-indexer/storage/oasis/nodeapi" | ||
| ) | ||
|
|
||
| // This analyzer checks the list of addresses with an unknown is_contract status, | ||
| // and determines it by calling `getCode()` on the address. | ||
| // If the code is returned, it is also stored in the DB. | ||
| // Every address that is the recipient of a call is a potential contract address. | ||
| // Candidate addresses are inserted into the DB by the block analyzer. | ||
| // Each candidate address only needs to be checked once. | ||
|
|
||
| const ( | ||
| EvmContractCodeAnalyzerPrefix = "evm_contract_code_" | ||
| MaxDownloadBatch = 20 | ||
| DownloadTimeout = 61 * time.Second | ||
| ) | ||
|
|
||
| type EthAddress []byte | ||
| type OasisAddress string | ||
|
|
||
| type Main struct { | ||
| runtime common.Runtime | ||
| source nodeapi.RuntimeApiLite | ||
| target storage.TargetStorage | ||
| logger *log.Logger | ||
| } | ||
|
|
||
| var _ analyzer.Analyzer = (*Main)(nil) | ||
|
|
||
| func NewMain( | ||
| runtime common.Runtime, | ||
| sourceClient nodeapi.RuntimeApiLite, | ||
| target storage.TargetStorage, | ||
| logger *log.Logger, | ||
| ) (*Main, error) { | ||
| return &Main{ | ||
| runtime: runtime, | ||
| source: sourceClient, | ||
| target: target, | ||
| logger: logger.With("analyzer", EvmContractCodeAnalyzerPrefix+runtime), | ||
| }, nil | ||
| } | ||
|
|
||
| type ContractCandidate struct { | ||
| Addr OasisAddress | ||
| EthAddr EthAddress | ||
| DownloadRound uint64 | ||
| } | ||
|
|
||
| func (m Main) getContractCandidates(ctx context.Context, limit int) ([]ContractCandidate, error) { | ||
| var candidates []ContractCandidate | ||
| rows, err := m.target.Query(ctx, queries.RuntimeEVMContractCodeAnalysisStale, m.runtime, limit) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("querying contract candidates: %w", err) | ||
| } | ||
| defer rows.Close() | ||
| for rows.Next() { | ||
| var cc ContractCandidate | ||
| if err = rows.Scan( | ||
| &cc.Addr, | ||
| &cc.EthAddr, | ||
| &cc.DownloadRound, | ||
| ); err != nil { | ||
| return nil, fmt.Errorf("scanning contract candidate: %w", err) | ||
| } | ||
| candidates = append(candidates, cc) | ||
| } | ||
| return candidates, nil | ||
| } | ||
|
|
||
| func (m Main) processContractCandidate(ctx context.Context, batch *storage.QueryBatch, candidate ContractCandidate) error { | ||
| m.logger.Info("downloading code", "addr", candidate.Addr, "eth_addr", fmt.Sprintf("%x", candidate.EthAddr)) | ||
| code, err := m.source.EVMGetCode(ctx, candidate.DownloadRound, candidate.EthAddr) | ||
| if err != nil { | ||
| // Write nothing into the DB; we'll try again later. | ||
| return fmt.Errorf("downloading code for %x: %w", candidate.EthAddr, err) | ||
| } | ||
| if code == nil { | ||
| batch.Queue( | ||
| queries.RuntimeEVMContractCodeAnalysisSetIsContract, | ||
| m.runtime, | ||
| candidate.Addr, | ||
| false, // is_contract | ||
| ) | ||
| } else { | ||
| batch.Queue( | ||
| queries.RuntimeEVMContractCodeAnalysisSetIsContract, | ||
| m.runtime, | ||
| candidate.Addr, | ||
| true, // is_contract | ||
| ) | ||
| batch.Queue( | ||
| queries.RuntimeEVMContractSetRuntimeBytecode, | ||
| m.runtime, | ||
| candidate.Addr, | ||
| code, | ||
| ) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (m Main) processBatch(ctx context.Context) (int, error) { | ||
| contractCandidates, err := m.getContractCandidates(ctx, MaxDownloadBatch) | ||
| if err != nil { | ||
| return 0, fmt.Errorf("getting contract candidates: %w", err) | ||
| } | ||
| m.logger.Info("processing", "num_contract_candidates", len(contractCandidates)) | ||
| if len(contractCandidates) == 0 { | ||
| return 0, nil | ||
| } | ||
|
|
||
| ctxWithTimeout, cancel := context.WithTimeout(ctx, DownloadTimeout) | ||
| defer cancel() | ||
| group, groupCtx := errgroup.WithContext(ctxWithTimeout) | ||
|
|
||
| batches := make([]*storage.QueryBatch, 0, len(contractCandidates)) | ||
|
|
||
| for _, cc := range contractCandidates { | ||
| // Redeclare `st` for unclobbered use within goroutine. | ||
| cc := cc | ||
| batch := &storage.QueryBatch{} | ||
| batches = append(batches, batch) | ||
| group.Go(func() error { | ||
| return m.processContractCandidate(groupCtx, batch, cc) | ||
| }) | ||
| } | ||
|
|
||
| if err := group.Wait(); err != nil { | ||
| return 0, err | ||
| } | ||
|
|
||
| batch := &storage.QueryBatch{} | ||
| for _, b := range batches { | ||
| batch.Extend(b) | ||
| } | ||
| if err := m.target.SendBatch(ctx, batch); err != nil { | ||
| return 0, fmt.Errorf("sending batch: %w", err) | ||
| } | ||
| return len(contractCandidates), nil | ||
| } | ||
|
|
||
| func (m Main) Start(ctx context.Context) { | ||
| backoff, err := util.NewBackoff( | ||
| 100*time.Millisecond, | ||
| // Cap the timeout at the expected round time. All runtimes currently have the same round time. | ||
| 6*time.Second, | ||
| ) | ||
| if err != nil { | ||
| m.logger.Error("error configuring indexer backoff policy", | ||
| "err", err, | ||
| ) | ||
| return | ||
| } | ||
|
|
||
| for { | ||
| select { | ||
| case <-time.After(backoff.Timeout()): | ||
| // Process next block. | ||
| case <-ctx.Done(): | ||
| m.logger.Warn("shutting down evm_contract_code analyzer", "reason", ctx.Err()) | ||
| return | ||
| } | ||
|
|
||
| numProcessed, err := m.processBatch(ctx) | ||
| if err != nil { | ||
| m.logger.Error("error processing batch", "err", err) | ||
| backoff.Failure() | ||
| continue | ||
| } | ||
|
|
||
| if numProcessed == 0 { | ||
| // Count this as a failure to reduce the polling when we are | ||
| // running faster than the block analyzer can find new contract candidates. | ||
| backoff.Failure() | ||
| continue | ||
| } | ||
|
|
||
| backoff.Success() | ||
| } | ||
| } | ||
|
|
||
| func (m Main) Name() string { | ||
| return EvmContractCodeAnalyzerPrefix + string(m.runtime) | ||
| } | ||
GitHub Actions
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
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