(refactor): Filter out destination chain bridgeable tokens that are not configured on pricegetter #686
Conversation
justinkaseman
force-pushed
the
CCIP-1945-offchain-2
branch
from
df543db
to
7c03179
Compare
| // IsTokenConfigured implements the PriceGetter interface. | ||
| // It returns if a token has a pipeline job configured on the TokenPricesUSDPipeline | ||
| func (d *PipelineGetter) IsTokenConfigured(ctx context.Context, token cciptypes.Address) (bool, error) { | ||
| contains := strings.Contains(d.source, string(token)) |
There was a problem hiding this comment.
@dimkouv are the addresses in token pipeline definition always in checksum format, or there isn't a case requirement?
There was a problem hiding this comment.
Based on what Piotr says about old job specs, I'll normalize casing just to be defensive
There was a problem hiding this comment.
They are 100% random and could be checksummed and not checksummed in the same pipeline
| // GetChainTokens returns union of all tokens supported on the destination chain, including fee tokens from the provided price registry | ||
| // and the bridgeable tokens from all the offRamps living on the chain. | ||
| func getSortedChainTokensWithBatchLimit(ctx context.Context, offRamps []ccipdata.OffRampReader, priceRegistry cciptypes.PriceRegistryReader, batchSize int) (chainTokens []cciptypes.Address, err error) { | ||
| // Bridgeable tokens are only included if they are configured on the pricegetter | ||
| func GetSortedChainTokens(ctx context.Context, offRamps []ccipdata.OffRampReader, priceRegistry cciptypes.PriceRegistryReader, priceGetter cciptypes.PriceGetter) (chainTokens []cciptypes.Address, err error) { |
There was a problem hiding this comment.
let's extra it into a separate function, like FilterForPricedTokens(), and let this just stay as a function that gets all chain tokens
…ot configured on pricegetter
…okenConfigured more robust
justinkaseman
force-pushed
the
CCIP-1945-offchain-2
branch
from
954bdd4
to
bc4ca4e
Compare
justinkaseman
force-pushed
the
CCIP-1945-offchain-2
branch
from
30b40f7
to
a8992a5
Compare
GNUmakefile
Outdated
| @@ -149,7 +149,7 @@ telemetry-protobuf: $(telemetry-protobuf) ## Generate telemetry protocol buffers | |||
| config-docs: ## Generate core node configuration documentation | |||
| go run ./core/config/docs/cmd/generate -o ./docs/ | |||
|
|
|||
| .PHONY: golangci-lint | |||
| .PHONY: golintlangci- | |||
There was a problem hiding this comment.
Shouldn't be there. Removed
| // IsTokenConfigured implements the PriceGetter interface. | ||
| // It returns if a token has a pipeline job configured on the TokenPricesUSDPipeline | ||
| func (d *PipelineGetter) IsTokenConfigured(ctx context.Context, token cciptypes.Address) (bool, error) { | ||
| contains := strings.Contains(d.source, string(token)) |
There was a problem hiding this comment.
Per Rens' comment: #686 (comment) ,
lets's be a bit paranoid and defensive, pls make this a case-insenstive match
Also, can we make the PriceGetter interface become something like filterForConfiguredTokens(ctx, tokens) tokens? Not certain about LOOPPS migration, the call to PriceGetter could be migrated to a grpc call, in that case loop with call per token is not ideal.
There was a problem hiding this comment.
lets's be a bit paranoid and defensive, pls make this a case-insenstive match
Weird, had a commit for that which didn't get pushed up. Adding.
justinkaseman
force-pushed
the
CCIP-1945-offchain-2
branch
from
b55d2ef
to
5822f17
Compare
justinkaseman
force-pushed
the
CCIP-1945-offchain-2
branch
from
26cfa2b
to
7abde98
Compare
Motivation
Self serve token pools will enable many new TransferTokens to be used across CCIP, most of which may not have a readily available price.
Context
The current procedure (as of batched price updates) is for a single lane to be designated as the "leader lane". It reports all prices that other lanes use. Other lanes have their price reporting disabled. To enable this, the leader lane has all supported tokens configured in the CommitJobSpec.
The source of truth for which tokens are supported comes from on-chain: queried from the leader lane's destination price registry (FeeTokens) and from each OffRamp's
supportedTokens. The combined set is given to theprice getter, and if the number of resulting prices is different from the CommitJobSpec's tokens then the observation is thrown out.Solution
For v1.4 (current) contracts:
Use the
CommitJobSpec's configured tokens as the source of truth for which TransferTokens need a price update. Filter out TransferTokens that are not configured on thepricegetterbefore they reachpricegetter.TokenPricesUSD().