Skip to content

feat(ccip/v1_5_1): make Inbound/Outbound optional in RateLimiterPerChain #22504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
athegaul wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

feat(ccip/v1_5_1): make Inbound/Outbound optional in RateLimiterPerChain #22504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions deployment/ccip/changeset/solana_v0_1_1/cs_token_pool_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,12 +724,12 @@ func TestAddTokenPoolE2EWithMcms(t *testing.T) {
SolChainUpdates: map[uint64]v1_5_1.SolChainUpdate{
solChain: {
RateLimiterConfig: v1_5_1.RateLimiterConfig{
Inbound: token_pool.RateLimiterConfig{
Inbound: &token_pool.RateLimiterConfig{
IsEnabled: false,
Capacity: big.NewInt(0),
Rate: big.NewInt(0),
},
Outbound: token_pool.RateLimiterConfig{
Outbound: &token_pool.RateLimiterConfig{
IsEnabled: false,
Capacity: big.NewInt(0),
Rate: big.NewInt(0),
Expand Down
4 changes: 2 additions & 2 deletions deployment/ccip/changeset/testhelpers/test_token_helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ const (
// CreateSymmetricRateLimits is a utility to quickly create a rate limiter config with equal inbound and outbound values.
func CreateSymmetricRateLimits(rate int64, capacity int64) v1_5_1.RateLimiterConfig {
return v1_5_1.RateLimiterConfig{
Inbound: token_pool.RateLimiterConfig{
Inbound: &token_pool.RateLimiterConfig{
IsEnabled: rate != 0 || capacity != 0,
Rate: big.NewInt(rate),
Capacity: big.NewInt(capacity),
},
Outbound: token_pool.RateLimiterConfig{
Outbound: &token_pool.RateLimiterConfig{
IsEnabled: rate != 0 || capacity != 0,
Rate: big.NewInt(rate),
Capacity: big.NewInt(capacity),
Expand Down
187 changes: 157 additions & 30 deletions deployment/ccip/changeset/v1_5_1/cs_configure_token_pools.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,24 @@ var (
)

// RateLimiterConfig defines the inbound and outbound rate limits for a remote chain.
//
// Inbound and Outbound are pointer-typed and optional at the input layer:
// - For EVM ChainUpdates (RateLimiterPerChain): at least one of Inbound or Outbound must be
// provided. When the remote chain is already supported by the pool, the missing side is
// read from on-chain at apply time and left unchanged. When the remote chain is not yet
// supported, both sides MUST be provided (we have no on-chain value to fall back to).
// - For Solana, Aptos, and Sui chain updates the partial-update semantics do NOT apply;
// both Inbound and Outbound are required.
type RateLimiterConfig struct {
// Inbound is the rate limiter config for inbound transfers from a remote chain.
Inbound token_pool.RateLimiterConfig `json:"inbound"`
// When nil for an EVM ChainUpdates entry against an already-supported remote chain, the
// existing on-chain inbound config is preserved.
Inbound *token_pool.RateLimiterConfig `json:"inbound,omitempty"`

// Outbound is the rate limiter config for outbound transfers to a remote chain.
Outbound token_pool.RateLimiterConfig `json:"outbound"`
// When nil for an EVM ChainUpdates entry against an already-supported remote chain, the
// existing on-chain outbound config is preserved.
Outbound *token_pool.RateLimiterConfig `json:"outbound,omitempty"`
}

// validateRateLimterConfig validates rate and capacity in accordance with on-chain code.
Expand All @@ -77,18 +89,101 @@ func validateRateLimiterConfig(rateLimiterConfig token_pool.RateLimiterConfig) e
return nil
}

// validateBidirectional ensures both Inbound and Outbound are set and individually valid.
// Used by chain families (Solana, Aptos, Sui) that require both sides to be supplied.
func (c RateLimiterConfig) validateBidirectional() error {
if c.Inbound == nil {
return errors.New("inbound rate limiter config must be set")
}

if c.Outbound == nil {
return errors.New("outbound rate limiter config must be set")
}

if err := validateRateLimiterConfig(*c.Inbound); err != nil {
return fmt.Errorf("validation of inbound rate limiter config failed: %w", err)
}

if err := validateRateLimiterConfig(*c.Outbound); err != nil {
return fmt.Errorf("validation of outbound rate limiter config failed: %w", err)
}

return nil
}

// resolvePartialRateLimiterConfig returns the inbound and outbound rate limiter configs to
// pass to SetChainRateLimiterConfigs for an already-supported remote chain. When either side
// of the supplied chainUpdate is nil, the corresponding side is fetched from on-chain so that
// it remains unchanged after the call. At least one of Inbound/Outbound MUST be non-nil; this
// is enforced by RateLimiterPerChain.Validate prior to reaching this point, but we re-check
// defensively to surface a clear error if invoked elsewhere.
func resolvePartialRateLimiterConfig(
ctx context.Context,
tokenPool *token_pool.TokenPool,
remoteChainSelector uint64,
chainUpdate RateLimiterConfig,
) (token_pool.RateLimiterConfig, token_pool.RateLimiterConfig, error) {
if chainUpdate.Inbound == nil && chainUpdate.Outbound == nil {
return token_pool.RateLimiterConfig{}, token_pool.RateLimiterConfig{}, errors.New("at least one of inbound or outbound rate limiter config must be set")
}

var inboundCfg token_pool.RateLimiterConfig
if chainUpdate.Inbound != nil {
inboundCfg = *chainUpdate.Inbound
} else {
state, err := tokenPool.GetCurrentInboundRateLimiterState(&bind.CallOpts{Context: ctx}, remoteChainSelector)
if err != nil {
return token_pool.RateLimiterConfig{}, token_pool.RateLimiterConfig{}, fmt.Errorf("failed to fetch on-chain inbound rate limiter state: %w", err)
}

inboundCfg = token_pool.RateLimiterConfig{
IsEnabled: state.IsEnabled,
Capacity: state.Capacity,
Rate: state.Rate,
}
}

var outboundCfg token_pool.RateLimiterConfig
if chainUpdate.Outbound != nil {
outboundCfg = *chainUpdate.Outbound
} else {
state, err := tokenPool.GetCurrentOutboundRateLimiterState(&bind.CallOpts{Context: ctx}, remoteChainSelector)
if err != nil {
return token_pool.RateLimiterConfig{}, token_pool.RateLimiterConfig{}, fmt.Errorf("failed to fetch on-chain outbound rate limiter state: %w", err)
}

outboundCfg = token_pool.RateLimiterConfig{
IsEnabled: state.IsEnabled,
Capacity: state.Capacity,
Rate: state.Rate,
}
}

return inboundCfg, outboundCfg, nil
}

// RateLimiterPerChain defines rate limits for remote chains.
type RateLimiterPerChain map[uint64]RateLimiterConfig

func (c RateLimiterPerChain) Validate() error {
for chainSelector, chainConfig := range c {
if err := validateRateLimiterConfig(chainConfig.Inbound); err != nil {
return fmt.Errorf("validation of inbound rate limiter config for remote chain with selector %d failed: %w", chainSelector, err)
if chainConfig.Inbound == nil && chainConfig.Outbound == nil {
return fmt.Errorf("rate limiter config for remote chain with selector %d must define at least one of inbound or outbound", chainSelector)
}
if err := validateRateLimiterConfig(chainConfig.Outbound); err != nil {
return fmt.Errorf("validation of outbound rate limiter config for remote chain with selector %d failed: %w", chainSelector, err)

if chainConfig.Inbound != nil {
if err := validateRateLimiterConfig(*chainConfig.Inbound); err != nil {
return fmt.Errorf("validation of inbound rate limiter config for remote chain with selector %d failed: %w", chainSelector, err)
}
}

if chainConfig.Outbound != nil {
if err := validateRateLimiterConfig(*chainConfig.Outbound); err != nil {
return fmt.Errorf("validation of outbound rate limiter config for remote chain with selector %d failed: %w", chainSelector, err)
}
}
}

return nil
}

Expand Down Expand Up @@ -147,12 +242,10 @@ func (c SolChainUpdate) GetSolanaTokenAndTokenPool(state solanastateview.CCIPCha
}

func (c SolChainUpdate) Validate(state solanastateview.CCIPChainState) error {
if err := validateRateLimiterConfig(c.RateLimiterConfig.Inbound); err != nil {
return fmt.Errorf("validation of inbound rate limiter config for solana chain failed: %w", err)
}
if err := validateRateLimiterConfig(c.RateLimiterConfig.Outbound); err != nil {
return fmt.Errorf("validation of outbound rate limiter config for solana chain failed: %w", err)
if err := c.RateLimiterConfig.validateBidirectional(); err != nil {
return fmt.Errorf("rate limiter config for solana chain is invalid: %w", err)
}

_, _, err := c.GetSolanaTokenAndTokenPool(state)
if err != nil {
return fmt.Errorf("failed to get solana token and token pool: %w", err)
Expand Down Expand Up @@ -494,6 +587,15 @@ func configureTokenPool(
remotePoolAddressAdditions := make(map[uint64][]byte)

for remoteChainSelector, chainUpdate := range poolUpdate.SolChainUpdates {
// Solana does not support partial rate limiter updates; both Inbound and Outbound
// are required.
if chainUpdate.RateLimiterConfig.Inbound == nil || chainUpdate.RateLimiterConfig.Outbound == nil {
return fmt.Errorf("both inbound and outbound rate limiter configs must be set for solana remote chain with selector %d", remoteChainSelector)
}

inboundCfg := *chainUpdate.RateLimiterConfig.Inbound
outboundCfg := *chainUpdate.RateLimiterConfig.Outbound

remoteTokenAddress, remotePoolAddress, err := chainUpdate.GetSolanaTokenAndTokenPool(state.SolChains[remoteChainSelector])
if err != nil {
return fmt.Errorf("failed to get solana token and token pool for chain with selector %d: %w", remoteChainSelector, err)
Expand Down Expand Up @@ -534,8 +636,8 @@ func configureTokenPool(
remotePoolAddressAdditions[remoteChainSelector] = common.LeftPadBytes(remotePoolAddress.Bytes(), 32)
// Also update rate limits
remoteChainSelectorsToUpdate = append(remoteChainSelectorsToUpdate, remoteChainSelector)
updatedOutboundConfigs = append(updatedOutboundConfigs, chainUpdate.RateLimiterConfig.Outbound)
updatedInboundConfigs = append(updatedInboundConfigs, chainUpdate.RateLimiterConfig.Inbound)
updatedOutboundConfigs = append(updatedOutboundConfigs, outboundCfg)
updatedInboundConfigs = append(updatedInboundConfigs, inboundCfg)
} else {
// Default behavior: Remove & later re-add the chain (spot replacement)
chainRemovals = append(chainRemovals, remoteChainSelector)
Expand All @@ -544,23 +646,30 @@ func configureTokenPool(
default:
// Remote pool is already supported, just update the rate limits
remoteChainSelectorsToUpdate = append(remoteChainSelectorsToUpdate, remoteChainSelector)
updatedOutboundConfigs = append(updatedOutboundConfigs, chainUpdate.RateLimiterConfig.Outbound)
updatedInboundConfigs = append(updatedInboundConfigs, chainUpdate.RateLimiterConfig.Inbound)
updatedOutboundConfigs = append(updatedOutboundConfigs, outboundCfg)
updatedInboundConfigs = append(updatedInboundConfigs, inboundCfg)
}
}

if addChain {
chainAdditions = append(chainAdditions, token_pool.TokenPoolChainUpdate{
RemoteChainSelector: remoteChainSelector,
InboundRateLimiterConfig: chainUpdate.RateLimiterConfig.Inbound,
OutboundRateLimiterConfig: chainUpdate.RateLimiterConfig.Outbound,
InboundRateLimiterConfig: inboundCfg,
OutboundRateLimiterConfig: outboundCfg,
RemoteTokenAddress: common.LeftPadBytes(remoteTokenAddress.Bytes(), 32),
RemotePoolAddresses: [][]byte{common.LeftPadBytes(remotePoolAddress.Bytes(), 32)},
})
}
}

for remoteChainSelector, chainUpdate := range poolUpdate.AptosChainUpdates {
// Aptos does not support partial rate limiter updates; both Inbound and Outbound are required.
if chainUpdate.RateLimiterConfig.Inbound == nil || chainUpdate.RateLimiterConfig.Outbound == nil {
return fmt.Errorf("both inbound and outbound rate limiter configs must be set for aptos remote chain with selector %d", remoteChainSelector)
}
inboundCfg := *chainUpdate.RateLimiterConfig.Inbound
outboundCfg := *chainUpdate.RateLimiterConfig.Outbound

remoteTokenAddress, remotePoolAddress, err := chainUpdate.GetAptosTokenAndTokenPool(state.AptosChains[remoteChainSelector])
if err != nil {
return fmt.Errorf("failed to get Aptos token and token pool for chain with selector %d: %w", remoteChainSelector, err)
Expand All @@ -572,8 +681,8 @@ func configureTokenPool(
if isSupportedChain {
// Just update the rate limits if the chain is already supported
remoteChainSelectorsToUpdate = append(remoteChainSelectorsToUpdate, remoteChainSelector)
updatedOutboundConfigs = append(updatedOutboundConfigs, chainUpdate.RateLimiterConfig.Outbound)
updatedInboundConfigs = append(updatedInboundConfigs, chainUpdate.RateLimiterConfig.Inbound)
updatedOutboundConfigs = append(updatedOutboundConfigs, outboundCfg)
updatedInboundConfigs = append(updatedInboundConfigs, inboundCfg)

// Also, add a new remote pool if the token pool on the remote chain is being updated
configuredRemotePools, err := tokenPool.GetRemotePools(&bind.CallOpts{Context: ctx}, remoteChainSelector)
Expand All @@ -594,15 +703,22 @@ func configureTokenPool(
} else {
chainAdditions = append(chainAdditions, token_pool.TokenPoolChainUpdate{
RemoteChainSelector: remoteChainSelector,
InboundRateLimiterConfig: chainUpdate.RateLimiterConfig.Inbound,
OutboundRateLimiterConfig: chainUpdate.RateLimiterConfig.Outbound,
InboundRateLimiterConfig: inboundCfg,
OutboundRateLimiterConfig: outboundCfg,
RemoteTokenAddress: common.LeftPadBytes(remoteTokenAddress[:], 32),
RemotePoolAddresses: [][]byte{common.LeftPadBytes(remotePoolAddress[:], 32)},
})
}
}

for remoteChainSelector, chainUpdate := range poolUpdate.SuiChainUpdates {
// Sui does not support partial rate limiter updates; both Inbound and Outbound are required.
if chainUpdate.RateLimiterConfig.Inbound == nil || chainUpdate.RateLimiterConfig.Outbound == nil {
return fmt.Errorf("both inbound and outbound rate limiter configs must be set for sui remote chain with selector %d", remoteChainSelector)
}
inboundCfg := *chainUpdate.RateLimiterConfig.Inbound
outboundCfg := *chainUpdate.RateLimiterConfig.Outbound

remoteTokenAddressStr, remotePoolAddressStr, err := chainUpdate.GetSuiTokenAndTokenPool(state.SuiChains[remoteChainSelector])
if err != nil {
return fmt.Errorf("failed to get Sui token and token pool for chain with selector %d: %w", remoteChainSelector, err)
Expand All @@ -625,8 +741,8 @@ func configureTokenPool(
if isSupportedChain {
// Just update the rate limits if the chain is already supported
remoteChainSelectorsToUpdate = append(remoteChainSelectorsToUpdate, remoteChainSelector)
updatedOutboundConfigs = append(updatedOutboundConfigs, chainUpdate.RateLimiterConfig.Outbound)
updatedInboundConfigs = append(updatedInboundConfigs, chainUpdate.RateLimiterConfig.Inbound)
updatedOutboundConfigs = append(updatedOutboundConfigs, outboundCfg)
updatedInboundConfigs = append(updatedInboundConfigs, inboundCfg)

// Also, add a new remote pool if the token pool on the remote chain is being updated
configuredRemotePools, err := tokenPool.GetRemotePools(&bind.CallOpts{Context: ctx}, remoteChainSelector)
Expand All @@ -649,8 +765,8 @@ func configureTokenPool(
} else {
chainAdditions = append(chainAdditions, token_pool.TokenPoolChainUpdate{
RemoteChainSelector: remoteChainSelector,
InboundRateLimiterConfig: chainUpdate.RateLimiterConfig.Inbound,
OutboundRateLimiterConfig: chainUpdate.RateLimiterConfig.Outbound,
InboundRateLimiterConfig: inboundCfg,
OutboundRateLimiterConfig: outboundCfg,
RemoteTokenAddress: common.LeftPadBytes(remoteTokenAddress, 32),
RemotePoolAddresses: [][]byte{common.LeftPadBytes(remotePoolAddress, 32)},
})
Expand Down Expand Up @@ -704,15 +820,26 @@ func configureTokenPool(
}

if isSupportedChain {
// Just update the rate limits if the chain is already supported
// Just update the rate limits if the chain is already supported.
// If only one of Inbound/Outbound is provided, fetch the other from on-chain so
// that the unspecified side is left unchanged.
inboundCfg, outboundCfg, err := resolvePartialRateLimiterConfig(ctx, tokenPool, remoteChainSelector, chainUpdate)
if err != nil {
return fmt.Errorf("failed to resolve rate limiter config for chain with selector %d on pool with address %s on %s: %w", remoteChainSelector, tokenPool.Address(), chain.String(), err)
}

remoteChainSelectorsToUpdate = append(remoteChainSelectorsToUpdate, remoteChainSelector)
updatedOutboundConfigs = append(updatedOutboundConfigs, chainUpdate.Outbound)
updatedInboundConfigs = append(updatedInboundConfigs, chainUpdate.Inbound)
updatedOutboundConfigs = append(updatedOutboundConfigs, outboundCfg)
updatedInboundConfigs = append(updatedInboundConfigs, inboundCfg)
// Also, add a new remote pool if the token pool on the remote chain is being updated
if remoteTokenConfig.TokenPool != utils.ZeroAddress && remoteTokenConfig.TokenPool != remoteTokenPool.Address() {
remotePoolAddressAdditions[remoteChainSelector] = common.LeftPadBytes(remoteTokenPool.Address().Bytes(), 32)
}
} else {
// Adding chain support requires both sides; we have no on-chain value to fall back to.
if chainUpdate.Inbound == nil || chainUpdate.Outbound == nil {
return fmt.Errorf("both inbound and outbound rate limiter configs must be set when adding new chain support for remote chain with selector %d on pool with address %s on %s", remoteChainSelector, tokenPool.Address(), chain.String())
}
// Add chain support if it doesn't yet exist
// First, we need to assemble a list of valid remote pools
// The desired token pool on the remote chain is added by default
Expand All @@ -737,8 +864,8 @@ func configureTokenPool(
}
chainAdditions = append(chainAdditions, token_pool.TokenPoolChainUpdate{
RemoteChainSelector: remoteChainSelector,
InboundRateLimiterConfig: chainUpdate.Inbound,
OutboundRateLimiterConfig: chainUpdate.Outbound,
InboundRateLimiterConfig: *chainUpdate.Inbound,
OutboundRateLimiterConfig: *chainUpdate.Outbound,
RemoteTokenAddress: common.LeftPadBytes(remoteTokenAddress.Bytes(), 32),
RemotePoolAddresses: remotePoolAddresses,
})
Expand Down
Loading
Loading