diff --git a/.github/actionlint.yml b/.github/actionlint.yml index feabce5b59b..4aab4cda4ad 100644 --- a/.github/actionlint.yml +++ b/.github/actionlint.yml @@ -1,14 +1,22 @@ -# See https://github.com/rhysd/actionlint/blob/main/docs/config.md +# See https://github.com/kjanat/actionlint/blob/main/docs/config.md + +# Self-hosted / runs-on.com runner labels. +# Runs-on selectors (https://runs-on.com/) are `key=value` pairs; GitHub-hosted +# runners are matched exactly. Glob patterns are supported. +self-hosted-runner: + labels: + - ubuntu24.04-16cores-64GB + - runs-on=* + - cpu=* + - ram=* + - family=* + - image=* + - spot=* + - volume=* + - extras=* paths: .github/workflows/**/*.{yml,yaml}: ignore: - # ignore unknown runner labels, as we have fully custom runners - - 'label ".*" is unknown. available labels are .*' - # https://www.shellcheck.net/wiki/SC2129 - - '.*SC2129:style:.*' - # https://www.shellcheck.net/wiki/SC2002 - - '.*SC2002:style:.*' # ignore if: false, as it's a common pattern to temporarily disable a job or step - 'constant expression "false" in condition.*' - diff --git a/.github/workflows/ccip-release-changelog.yml b/.github/workflows/ccip-release-changelog.yml index e9accd06ae1..4af18004aba 100644 --- a/.github/workflows/ccip-release-changelog.yml +++ b/.github/workflows/ccip-release-changelog.yml @@ -45,12 +45,14 @@ jobs: echo "::error::old_ref and new_ref are required" exit 1 fi - echo "old_ref=$old" >> "$GITHUB_OUTPUT" - echo "new_ref=$new" >> "$GITHUB_OUTPUT" - echo "slack_thread_url=$thread" >> "$GITHUB_OUTPUT" - # Artifact names may not contain / : " < > | * ? etc. - echo "safe_old=${old//[^a-zA-Z0-9._-]/-}" >> "$GITHUB_OUTPUT" - echo "safe_new=${new//[^a-zA-Z0-9._-]/-}" >> "$GITHUB_OUTPUT" + { + echo "old_ref=$old" + echo "new_ref=$new" + echo "slack_thread_url=$thread" + # Artifact names may not contain / : " < > | * ? etc. + echo "safe_old=${old//[^a-zA-Z0-9._-]/-}" + echo "safe_new=${new//[^a-zA-Z0-9._-]/-}" + } | tee -a "$GITHUB_OUTPUT" - uses: actions/checkout@v7 with: diff --git a/.github/workflows/ci-core.yml b/.github/workflows/ci-core.yml index 7efb2a8e3cf..e999b7a8c46 100644 --- a/.github/workflows/ci-core.yml +++ b/.github/workflows/ci-core.yml @@ -452,9 +452,11 @@ jobs: # Increase timeouts for scheduled runs only if: ${{ github.event.schedule != '' && matrix.type.should-run == 'true' }} run: | - echo "TIMEOUT=10m" >> "$GITHUB_ENV" - echo "COUNT=50" >> "$GITHUB_ENV" - echo "FUZZ_TIMEOUT_MINUTES=10" >> "$GITHUB_ENV" + { + echo "TIMEOUT=10m" + echo "COUNT=50" + echo "FUZZ_TIMEOUT_MINUTES=10" + } | tee -a "$GITHUB_ENV" - name: Run tests if: ${{ matrix.type.should-run == 'true' }} diff --git a/.github/workflows/cre-local-env-tests.yaml b/.github/workflows/cre-local-env-tests.yaml index c1535828828..324603a3b1a 100644 --- a/.github/workflows/cre-local-env-tests.yaml +++ b/.github/workflows/cre-local-env-tests.yaml @@ -385,10 +385,12 @@ jobs: fi fi - echo "duration_minutes=$duration_minutes" >> "${GITHUB_OUTPUT}" - echo "conclusion=$conclusion" >> "${GITHUB_OUTPUT}" - echo "reason=$reason" >> "${GITHUB_OUTPUT}" - echo "should_notify=$should_notify" >> "${GITHUB_OUTPUT}" + { + echo "duration_minutes=$duration_minutes" + echo "conclusion=$conclusion" + echo "reason=$reason" + echo "should_notify=$should_notify" + } | tee -a "${GITHUB_OUTPUT}" - name: Send slack notification if: steps.check-timeout.outputs.should_notify == 'true' diff --git a/.github/workflows/cre-system-tests.yaml b/.github/workflows/cre-system-tests.yaml index 9c77b222255..1a59dd0ff94 100644 --- a/.github/workflows/cre-system-tests.yaml +++ b/.github/workflows/cre-system-tests.yaml @@ -126,6 +126,9 @@ jobs: "Test_CRE_V2_ShardManualAssignment": [ {"topology":"workflow-gateway-sharded-manual","configs":"configs/workflow-gateway-sharded-manual.toml"} ], + "Test_CRE_V2_ShardManualAssignmentBothSpecs": [ + {"topology":"workflow-gateway-sharded-manual","configs":"configs/workflow-gateway-sharded-manual.toml"} + ], "Test_CRE_V2_ShardedCapabilitiesManualEVMLogTrigger": [ {"topology":"workflow-sharded-capabilities","configs":"configs/workflow-sharded-capabilities-don.toml"} ], diff --git a/.github/workflows/lint-gh-workflows.yml b/.github/workflows/lint-gh-workflows.yml index 0d96276acc6..9d3ac8b52a8 100644 --- a/.github/workflows/lint-gh-workflows.yml +++ b/.github/workflows/lint-gh-workflows.yml @@ -24,4 +24,7 @@ jobs: persist-credentials: false - name: Run actionlint - uses: reviewdog/action-actionlint@50842263c20a7c46bd0065b9e624d3c569db061e # v1.73.0 + uses: reviewdog/action-actionlint@2085657ab2c7f48c58edcc767fba576f63bea76b # v1.77.0 + with: + fail_level: error + filter_mode: nofilter diff --git a/.github/workflows/run-nightly-in-memory-integration-tests.yml b/.github/workflows/run-nightly-in-memory-integration-tests.yml index 38ea09a170a..bae50e3845b 100644 --- a/.github/workflows/run-nightly-in-memory-integration-tests.yml +++ b/.github/workflows/run-nightly-in-memory-integration-tests.yml @@ -15,6 +15,7 @@ on: permissions: contents: read + pull-requests: read # A called workflow cannot elevate above the caller's permissions, and # integration-in-memory-tests.yml's compile-tests job needs id-token: write to mint an # OIDC token for GATI. diff --git a/core/cmd/shell.go b/core/cmd/shell.go index 42057d37e8b..64468775e00 100644 --- a/core/cmd/shell.go +++ b/core/cmd/shell.go @@ -56,6 +56,7 @@ import ( "github.com/smartcontractkit/chainlink/v2/core/services/chainlink" "github.com/smartcontractkit/chainlink/v2/core/services/cre" gatewayv2metrics "github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers/capabilities/v2/metrics" + gatewaymonitoring "github.com/smartcontractkit/chainlink/v2/core/services/gateway/monitoring" gatewaynetwork "github.com/smartcontractkit/chainlink/v2/core/services/gateway/network" "github.com/smartcontractkit/chainlink/v2/core/services/keystore" "github.com/smartcontractkit/chainlink/v2/core/services/llo" @@ -85,6 +86,8 @@ func metricViews() []sdkmetric.View { ocr3beholderwrapper.MetricViews(), ocr3_1beholderwrapper.MetricViews(), gatewaynetwork.HTTPClientMetricViews(), + gatewaynetwork.WSConnectionMetricViews(), + gatewaymonitoring.MetricViews(), gatewayv2metrics.MetricViews(), ) } diff --git a/core/scripts/go.mod b/core/scripts/go.mod index 27a10f620d0..4e6f72719aa 100644 --- a/core/scripts/go.mod +++ b/core/scripts/go.mod @@ -499,12 +499,13 @@ require ( github.com/sirupsen/logrus v1.9.4 // indirect github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 // indirect github.com/smartcontractkit/ccip-owner-contracts v0.2.1 // indirect - github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 // indirect + github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 // indirect github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c // indirect github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 // indirect github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50 // indirect + github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0 // indirect github.com/smartcontractkit/chainlink-common/pkg/chipingress v0.0.11-0.20260915184316-2730f1867c92 // indirect github.com/smartcontractkit/chainlink-confidential-compute v1.3.0 // indirect @@ -534,14 +535,14 @@ require ( github.com/smartcontractkit/chainlink-solana/contracts v0.0.0-20260513123719-d347eaf314e1 // indirect github.com/smartcontractkit/chainlink-stellar v0.0.7 // indirect github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f // indirect - github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 // indirect + github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 // indirect github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 // indirect github.com/smartcontractkit/chainlink-testing-framework/framework/components/chiprouter v1.0.4 // indirect github.com/smartcontractkit/chainlink-testing-framework/framework/components/fake v0.15.0 // indirect github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 // indirect github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 // indirect - github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff // indirect - github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 // indirect + github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 // indirect + github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 // indirect github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a // indirect github.com/smartcontractkit/cld-changesets v0.9.1-0.20260911120037-95e1c8bcb265 // indirect github.com/smartcontractkit/freeport v0.1.3-0.20250828155247-add56fa28aad // indirect @@ -642,7 +643,7 @@ require ( go.yaml.in/yaml/v3 v3.0.5 // indirect go.yaml.in/yaml/v4 v4.0.0-rc.6 // indirect golang.org/x/arch v0.22.0 // indirect - golang.org/x/crypto v0.55.0 // indirect + golang.org/x/crypto v0.56.0 // indirect golang.org/x/exp v0.0.0-20260820142414-ca536658362e // indirect golang.org/x/mod v0.39.0 // indirect golang.org/x/net v0.58.0 // indirect diff --git a/core/scripts/go.sum b/core/scripts/go.sum index 77eb2a31486..8da9be8c9a7 100644 --- a/core/scripts/go.sum +++ b/core/scripts/go.sum @@ -1667,8 +1667,8 @@ github.com/smartcontractkit/ccip-owner-contracts v0.2.1 h1:HgrVtzpyqrPCQiyIeoUKc github.com/smartcontractkit/ccip-owner-contracts v0.2.1/go.mod h1:dpKtlTVEKohsbhnPe/r1oLFqfq7TP7iKvMaUOiidAaM= github.com/smartcontractkit/chain-selectors v1.0.111 h1:urb/qOyRanxDn+Wras+LULHEHSlJ4tYnfeAHzeMBn5U= github.com/smartcontractkit/chain-selectors v1.0.111/go.mod h1:qy7whtgG5g+7z0jt0nRyii9bLND9m15NZTzuQPkMZ5w= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 h1:gIlepiEA6cYoYtIYHV0dsGwrarU5LlXhIZ+AhhPFtRY= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2/go.mod h1:zxbSVfmTCjxN2LdXeOhZS8T5wh6TVDGC40iliRsF62o= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 h1:oOXfhXgp3WjmwMLKwwHbsMPPHUN5aWbrb0SI0WCGbmY= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26/go.mod h1:sblxFnXTTAeDlOgbmEsWN2ubISm50mnAf8nQkWpvMB4= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c h1:aDS7I+SK9mWkDcWlfP5JrDY4NnicC/4KVm30dG7HQaw= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c/go.mod h1:/ABThVk5DzhpsO1A4io8C6cAmqpF8RzgQDlGj98hke0= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 h1:ZjWiy0PXyoQ44HzdcMNKxOa5KB2FcdwHaCga8oMQuho= @@ -1681,6 +1681,8 @@ github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-7 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50/go.mod h1:5snE6Mg2+wYIddLZ5NIUPno3mYa9edyV3EyXJnE54vw= github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50 h1:lSfiz7zcWO4c41yoSoz/50s0y+7UwrRtePgh/GppaKo= github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50/go.mod h1:c++Ed0jeYn4w8WIfiAboRwN6ClRRVGglL0qwB/QjJvM= +github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 h1:mWPykzwWOnWyWfBp//A4hXurwVz1kn+o2rPKydaOSZM= +github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50/go.mod h1:Dm/Abz0vr7F2v9TygUX947q8HIwJEJikDfSdanX1Cic= github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0 h1:3f+Ijgr0vghawMUAitgFILQpt4KsoYHGv1Zb/YBeeQM= github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0/go.mod h1:gX7FJzSnGQx4RAlsn2rRW8IQBlEFZYiXFXEEB5jnQgA= github.com/smartcontractkit/chainlink-common v0.11.2-0.20260921174556-538f4bf0cb6f h1:mj37sJTagtZwTVhU7IIxu6/XCGiK740XmcwXihdKtvk= @@ -1755,8 +1757,8 @@ github.com/smartcontractkit/chainlink-stellar v0.0.7 h1:1rQtIzA4/9BAdpeLa8CfAwCh github.com/smartcontractkit/chainlink-stellar v0.0.7/go.mod h1:qKAB+TGrVJmEJjK2JF2/Upr//2bS0p9xJ8eXhQug0Sc= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f h1:L4Sl9v4OC4DT4BhZdpKsXyNHUTeJPMYf4dqj1Bl8bKY= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f/go.mod h1:IYBZArxwOQRlcx0Udx/VfFjqJpAs4NrjKsBoNITKAMg= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 h1:EPCKKMypUPDgmTXeBV5Fd3yhwcDjVR6EP1tHoK+XUrU= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695/go.mod h1:PruXFX6Np9pGTRX2gvNe+HphUW7oh6APpBqee/CvB8w= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 h1:b5sxBLD5CBP78zMAgIylaB30rucGN2HudxejW+HGFDc= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:hfe/tfHT/SwMSgVs2bu6gcFoZhbj5+av2vZsN3/FUQo= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 h1:3R9f6pguDIjei+nKx5dUT9j6fX8urGmlZA7Ad3x9UBs= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96/go.mod h1:pSW9q0/YqQE5R65Z/2zsyD9c50JZf+yRJJvN6Jo3LCU= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.7 h1:2j1AcRVb1xlec5PxS77IazC2AJoK2Y6QBq2LN+rmlF0= @@ -1773,10 +1775,10 @@ github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 h1:cWUHB6Q github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2/go.mod h1:Z4K5VJLjsfqIIaBcZ1Sfccxu0xsCxBjPa6zF+5gtQaM= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 h1:RwZXxdIAOyjp6cwc9Quxgr38k8r7ACz+Lxh9o/A6oH0= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5/go.mod h1:kHYJnZUqiPF7/xN5273prV+srrLJkS77GbBXHLKQpx0= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff h1:a0Z9NlZLwP7wClk84lP3iZpKFKzLGkS0U0VReIThaT4= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff/go.mod h1:40yDOuuKaXDBWCbkJBQUeUmgpjOWHpQrs61y5Dch+zA= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 h1:ots2WddFOQJL/tDFGmvrhRrVu2iRXCd0XEAxhpkAE/Y= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 h1:D5Sea6RDF9S4uyooSxw/Zhh3oGoDJQmbxgbXAI4F2vc= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150/go.mod h1:1RCKAzvGOLC/51vbJUOPPjx5uxTCxeL0QXU32UvQeug= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 h1:fl7VPhcgZA3r3eFg5/xEUDZ/BU6Z/9TfdEhPkZSEIuM= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a h1:Xu8iBnBQEibWIXTCwKYf8okXjFtzJ0KochjL03h+T40= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a/go.mod h1:1eaXR+Fe6TlpP+CKXozfYlFM8QgN/N5C7OMvTRWNT8I= github.com/smartcontractkit/chainlink-tron/relayer/gotron-sdk v0.0.5-0.20260218133534-cbd44da2856b h1:RarA5fTnBzQY9wHhl6g7Ac7Nv0d/izr2/zuSWhveB4c= @@ -2157,8 +2159,8 @@ golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0 golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.20.0/go.mod h1:Xwo95rrVNIoSMx9wa1JroENMToLWn3RNVrTBpLHgZPQ= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= +golang.org/x/crypto v0.56.0 h1:GUh5Ii4J5jtcseSMiRqr1jXCNHoxjeV9Fmekc2oLy6Y= +golang.org/x/crypto v0.56.0/go.mod h1:OMW5y6CY9l38uPLmxU6l6pwcXp1obtLo3e6gT7gQR2I= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= diff --git a/core/services/gateway/connectionmanager.go b/core/services/gateway/connectionmanager.go index 939eec02776..260ec517030 100644 --- a/core/services/gateway/connectionmanager.go +++ b/core/services/gateway/connectionmanager.go @@ -3,6 +3,7 @@ package gateway import ( "context" "crypto/rand" + "encoding/base64" "encoding/hex" "encoding/json" "errors" @@ -10,11 +11,14 @@ import ( "sort" "strings" "sync" + "sync/atomic" "time" "github.com/gorilla/websocket" "github.com/jonboulle/clockwork" + "go.opentelemetry.io/otel/attribute" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" jsonrpc "github.com/smartcontractkit/chainlink-common/pkg/jsonrpc2" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/services" @@ -76,6 +80,26 @@ type donConnectionManager struct { type nodeState struct { name string conn network.WSConnectionWrapper + // pingTracker correlates the latest keepalive ping probe with its pong so a + // round-trip duration can be recorded. Replaced on every handshake so pongs + // from a replaced connection can never match the new connection's probes. + pingTracker atomic.Pointer[pingProbeTracker] +} + +// sendPing writes a keepalive ping carrying a fresh random correlation token, +// registering the probe on the current connection's tracker immediately before +// the write because the matching pong can arrive before Write returns. The +// token is internal state and is never used as a metric label. +func (ns *nodeState) sendPing(ctx context.Context) error { + raw := make([]byte, pingTokenLen) + if _, err := rand.Read(raw); err != nil { + return fmt.Errorf("failed to generate ping correlation token: %w", err) + } + token := base64.StdEncoding.EncodeToString(raw) + if tracker := ns.pingTracker.Load(); tracker != nil { + tracker.register(token, time.Now()) + } + return ns.conn.Write(ctx, websocket.PingMessage, []byte(token)) } // immutable @@ -87,6 +111,10 @@ type connAttempt struct { } func NewConnectionManager(gwConfig *config.GatewayConfig, clock clockwork.Clock, gMetrics *monitoring.GatewayMetrics, lggr logger.Logger, lf limits.Factory) (ConnectionManager, error) { + wsMetrics, err := network.NewWSConnectionMetrics(beholder.GetMeter()) + if err != nil { + return nil, fmt.Errorf("failed to create websocket connection metrics: %w", err) + } dons := make(map[string]*donConnectionManager) for _, shardedDON := range gwConfig.ShardedDONs { for shardIdx, shard := range shardedDON.Shards { @@ -94,9 +122,9 @@ func NewConnectionManager(gwConfig *config.GatewayConfig, clock clockwork.Clock, if _, ok := dons[donID]; ok { return nil, fmt.Errorf("duplicate DON ID %s", donID) } - nodes, err := buildNodeStates(shard.Nodes, donID, lggr) - if err != nil { - return nil, err + nodes, ierr := buildNodeStates(shard.Nodes, donID, lggr, wsMetrics) + if ierr != nil { + return nil, ierr } dons[donID] = &donConnectionManager{ donConfig: &config.DONConfig{ @@ -128,18 +156,23 @@ func NewConnectionManager(gwConfig *config.GatewayConfig, clock clockwork.Clock, return connMgr, nil } -func buildNodeStates(members []config.NodeConfig, donID string, lggr logger.Logger) (map[string]*nodeState, error) { +func buildNodeStates(members []config.NodeConfig, donID string, lggr logger.Logger, wsMetrics *network.WSConnectionMetrics) (map[string]*nodeState, error) { nodes := make(map[string]*nodeState) for _, nodeConfig := range members { nodeAddress := strings.ToLower(nodeConfig.Address) if _, ok := nodes[nodeAddress]; ok { return nil, fmt.Errorf("duplicate node address %s in DON %s", nodeAddress, donID) } - connWrapper := network.NewWSConnectionWrapper(lggr) - nodes[nodeAddress] = &nodeState{ + connWrapper := network.NewWSConnectionWrapperWithObserver(lggr, wsMetrics.Observer( + attribute.String("nodeAddress", nodeAddress), + attribute.String("nodeName", nodeConfig.Name), + )) + ns := &nodeState{ name: nodeConfig.Name, conn: connWrapper, } + ns.pingTracker.Store(&pingProbeTracker{}) + nodes[nodeAddress] = ns } return nodes, nil } @@ -247,6 +280,11 @@ func (m *connectionManager) FinalizeHandshake(attemptID string, response []byte, // The deadline is reset every time a pong is received. If PongTimeoutSec is // 0, deadline enforcement is disabled. pongWait := time.Duration(m.config.PongTimeoutSec) * time.Second + // Install a fresh probe tracker scoped to this connection. The pong handler + // below closes over it, so pongs arriving on a replaced connection are matched + // against its own stale tracker and can never record against this one. + tracker := &pingProbeTracker{} + attempt.nodeState.pingTracker.Store(tracker) if conn != nil { if pongWait > 0 { if err := conn.SetReadDeadline(time.Now().Add(pongWait)); err != nil { @@ -263,18 +301,32 @@ func (m *connectionManager) FinalizeHandshake(attemptID string, response []byte, } m.lggr.Debugw("received keepalive pong from node", "nodeAddress", attempt.nodeAddress) m.gMetrics.RecordKeepalivePongsReceived(context.Background(), attempt.nodeAddress, attempt.nodeState.name) + // Only a pong echoing this connection's latest probe token yields a + // round-trip observation. Superseded, duplicate, or old-connection + // pongs produce no sample but still refresh the deadline above. + // The node's default ping handler echoes the ping payload, so the + // pong carries our token unchanged. + if start, ok := tracker.consume(data); ok { + m.gMetrics.RecordWSPingRoundTrip(context.Background(), attempt.nodeAddress, attempt.nodeState.name, time.Since(start)) + } return nil }) } - attempt.nodeState.conn.Reset(conn) + // A nil *websocket.Conn must not be passed as a WSConnection: the interface + // would be non-nil and Reset would start a readPump on a nil conn. + if conn != nil { + attempt.nodeState.conn.Reset(conn) + } else { + attempt.nodeState.conn.Reset(nil) + } if conn != nil && pongWait > 0 { // Send an immediate ping so the first pong arrives quickly (within // milliseconds on a healthy connection) rather than waiting up to one // full heartbeat interval for the keepalive ticker to fire. ctx := context.Background() - if err := attempt.nodeState.conn.Write(ctx, websocket.PingMessage, []byte{}); err != nil { + if ierr := attempt.nodeState.sendPing(ctx); ierr != nil { m.lggr.Debugw("unable to send post-handshake ping to node", - "nodeAddress", attempt.nodeAddress, "name", attempt.nodeState.name, "err", err) + "nodeAddress", attempt.nodeAddress, "name", attempt.nodeState.name, "err", ierr) } } m.lggr.Infof("node %s connected", attempt.nodeAddress) @@ -431,7 +483,7 @@ func (m *donConnectionManager) nodeKeepalive(addr string, ns *nodeState, interva case <-ticker.C: // Per-node write with a timeout context pingCtx, pingCancel := context.WithTimeout(ctx, 5*time.Second) - err := ns.conn.Write(pingCtx, websocket.PingMessage, []byte{}) + err := ns.sendPing(pingCtx) pingCancel() m.gMetrics.RecordKeepalivePingsSent(ctx, addr, ns.name, err == nil) if err != nil { diff --git a/core/services/gateway/connectionmanager_test.go b/core/services/gateway/connectionmanager_test.go index 1fd21bf94cf..492d7ffda94 100644 --- a/core/services/gateway/connectionmanager_test.go +++ b/core/services/gateway/connectionmanager_test.go @@ -8,6 +8,7 @@ import ( "net/http/httptest" "sort" "strings" + "sync/atomic" "testing" "time" @@ -15,8 +16,12 @@ import ( "github.com/jonboulle/clockwork" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" + "go.opentelemetry.io/otel/attribute" + sdkmetric "go.opentelemetry.io/otel/sdk/metric" + "go.opentelemetry.io/otel/sdk/metric/metricdata" "go.uber.org/zap/zapcore" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" jsonrpc "github.com/smartcontractkit/chainlink-common/pkg/jsonrpc2" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/settings/limits" @@ -110,7 +115,7 @@ Address = "0x68902D681c28119f9b2531473a417088bf008E59" [nodeServerConfig] Path = "/node"` + config lggr := logger.Test(t) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) _, err = gateway.NewConnectionManager(parseTOMLConfig(t, fullConfig), clockwork.NewFakeClock(), gMetrics, lggr, limits.Factory{Logger: lggr}) require.Error(t, err) @@ -371,7 +376,7 @@ Address = "0x0001020304050607080900010203040506070809" cfg := parseTOMLConfig(t, tomlConfig) lggr := logger.Test(t) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) _, err = gateway.NewConnectionManager(cfg, clockwork.NewFakeClock(), gMetrics, lggr, limits.Factory{Logger: lggr}) require.Error(t, err) @@ -547,7 +552,7 @@ func TestConnectionManager_ReadyForTrafficLogsDisconnectedNodes(t *testing.T) { cfg, nodes := newTestConfig(t, 4) cfg.ShardedDONs[0].F = 1 lggr, logs := logger.TestObserved(t, zapcore.DebugLevel) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) mgr, err := gateway.NewConnectionManager(cfg, clockwork.NewFakeClock(), gMetrics, lggr, limits.Factory{Logger: lggr}) require.NoError(t, err) @@ -576,7 +581,7 @@ func TestConnectionManager_ReadyForTrafficFailsClosedAndSortsErrors(t *testing.T t.Parallel() lggr := logger.Test(t) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) lf := limits.Factory{Logger: lggr} @@ -717,9 +722,105 @@ func TestConnectionManager_ReadDeadline_DisabledWhenZero(t *testing.T) { func newConnectionManager(t *testing.T, gwConfig *config.GatewayConfig, clock clockwork.Clock) gateway.ConnectionManager { lggr := logger.Test(t) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) mgr, err := gateway.NewConnectionManager(gwConfig, clock, gMetrics, lggr, limits.Factory{Logger: lggr}) require.NoError(t, err) return mgr } + +// findHistogramDataPoint returns the histogram data point for the metric with +// the given name whose attributes match all of the given key/value pairs. +func findHistogramDataPoint(rm metricdata.ResourceMetrics, name string, attrs map[string]string) (metricdata.HistogramDataPoint[int64], bool) { + for _, scopeMetrics := range rm.ScopeMetrics { + for _, metric := range scopeMetrics.Metrics { + if metric.Name != name { + continue + } + histogram, ok := metric.Data.(metricdata.Histogram[int64]) + if !ok { + continue + } + for _, dp := range histogram.DataPoints { + matches := true + for k, v := range attrs { + attributeValue, ok := dp.Attributes.Value(attribute.Key(k)) + if !ok || attributeValue.AsString() != v { + matches = false + break + } + } + if matches { + return dp, true + } + } + } + } + return metricdata.HistogramDataPoint[int64]{}, false +} + +// TestConnectionManager_PingRoundTripMetric verifies that a delayed pong yields +// a correspondingly large observed ping round trip, that the node echoes the +// correlation token, and that the sample is attributed to the right node. +func TestConnectionManager_PingRoundTripMetric(t *testing.T) { //nolint:paralleltest // replaces the process-global Beholder client + if testing.Short() { + t.Skip("too slow for testing.Short") + } + + reader := sdkmetric.NewManualReader() + meterProvider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(reader)) + meter := meterProvider.Meter("connection-manager-test") + t.Cleanup(func() { require.NoError(t, meterProvider.Shutdown(t.Context())) }) + + cfg, nodes := newTestConfig(t, 1) + cfg.ConnectionManagerConfig.HeartbeatIntervalSec = 1 + cfg.ConnectionManagerConfig.PongTimeoutSec = 5 + clock := clockwork.NewRealClock() + lggr := logger.Test(t) + gMetrics, err := monitoring.NewGatewayMetrics(meter) + require.NoError(t, err) + mgr, err := gateway.NewConnectionManager(cfg, clock, gMetrics, lggr, limits.Factory{Logger: lggr}) + require.NoError(t, err) + require.NoError(t, mgr.Start(t.Context())) + t.Cleanup(func() { require.NoError(t, mgr.Close()) }) + + serverConn, clientConn := newWebSocketPair(t) + + // Node side: echo the ping's correlation token after a controlled delay. + // The existing default ping handler echoes the payload unchanged; this + // custom handler only adds the delay and asserts the token is present. + const pongDelay = 200 * time.Millisecond + var sawToken atomic.Bool + clientConn.SetPingHandler(func(appData string) error { + if appData != "" { + sawToken.Store(true) + } + time.Sleep(pongDelay) + return clientConn.WriteControl(websocket.PongMessage, []byte(appData), time.Now().Add(5*time.Second)) + }) + // The client must read so that ping control frames are processed. + go func() { + for { + if _, _, err := clientConn.ReadMessage(); err != nil { + return + } + } + }() + + doHandshake(t, mgr, clock, nodes[0], serverConn) + + require.Eventually(t, func() bool { + var rm metricdata.ResourceMetrics + if err := reader.Collect(t.Context(), &rm); err != nil { + return false + } + dp, ok := findHistogramDataPoint(rm, "platform_gateway_ws_ping_round_trip_ms", map[string]string{ + "nodeAddress": strings.ToLower(nodes[0].Address), + "nodeName": "node_0", + }) + return ok && dp.Count >= 1 && dp.Sum >= 150 + }, 10*time.Second, 100*time.Millisecond, + "a pong delayed by %s must produce an observed ping round trip of at least ~150ms", pongDelay) + + require.True(t, sawToken.Load(), "node's ping handler must receive the correlation token and echo it") +} diff --git a/core/services/gateway/connector/config_test.go b/core/services/gateway/connector/config_test.go index bf1b47e7963..e36266d8ce3 100644 --- a/core/services/gateway/connector/config_test.go +++ b/core/services/gateway/connector/config_test.go @@ -15,28 +15,24 @@ func TestConnectorConfig_From(t *testing.T) { t.Parallel() cfg, err := (&chainlink.GeneralConfigOpts{ - Config: chainlink.Config{ - Core: toml.Core{ - Capabilities: toml.Capabilities{ - GatewayConnector: toml.GatewayConnector{ - ChainIDForNodeKey: new("1"), - NodeAddress: new("0x68902d681c28119f9b2531473a417088bf008e59"), - DonID: new("example_don"), - WSHandshakeTimeoutMillis: new(uint32(100)), - AuthMinChallengeLen: new(10), - AuthTimestampToleranceSec: new(uint32(5)), - Gateways: []toml.ConnectorGateway{ - { - ID: new("example_gateway"), - DonID: new("example_gateway_don"), - URL: new("wss://localhost:8081/node"), - }, - { - ID: new("another_gateway"), - DonID: new("another_gateway_don"), - URL: new("wss://example.com:8090/node"), - }, - }, + Capabilities: toml.Capabilities{ + GatewayConnector: toml.GatewayConnector{ + ChainIDForNodeKey: new("1"), + NodeAddress: new("0x68902d681c28119f9b2531473a417088bf008e59"), + DonID: new("example_don"), + WSHandshakeTimeoutMillis: new(uint32(100)), + AuthMinChallengeLen: new(10), + AuthTimestampToleranceSec: new(uint32(5)), + Gateways: []toml.ConnectorGateway{ + { + ID: new("example_gateway"), + DonID: new("example_gateway_don"), + URL: new("wss://localhost:8081/node"), + }, + { + ID: new("another_gateway"), + DonID: new("another_gateway_don"), + URL: new("wss://example.com:8090/node"), }, }, }, diff --git a/core/services/gateway/connector/connector.go b/core/services/gateway/connector/connector.go index e6bbf9c88c2..095034c33f0 100644 --- a/core/services/gateway/connector/connector.go +++ b/core/services/gateway/connector/connector.go @@ -11,7 +11,9 @@ import ( "github.com/gorilla/websocket" "github.com/jonboulle/clockwork" + "go.opentelemetry.io/otel/attribute" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" jsonrpc "github.com/smartcontractkit/chainlink-common/pkg/jsonrpc2" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/services" @@ -117,6 +119,10 @@ func NewGatewayConnector(config *Config, signer Signer, clock clockwork.Clock, l if err != nil { return nil, fmt.Errorf("failed to create gateway connector metrics: %w", err) } + wsMetrics, err := network.NewWSConnectionMetrics(beholder.GetMeter()) + if err != nil { + return nil, fmt.Errorf("failed to create websocket connection metrics: %w", err) + } connector := &gatewayConnector{ config: config, clock: clock, @@ -143,7 +149,7 @@ func NewGatewayConnector(config *Config, signer Signer, clock clockwork.Clock, l } l := logger.With(lggr, "URL", parsedURL) gateway := &gatewayState{ - conn: network.NewWSConnectionWrapper(l), + conn: network.NewWSConnectionWrapperWithObserver(l, wsMetrics.Observer(attribute.String("gateway_id", gw.ID))), config: gw, url: parsedURL, wsClient: network.NewWebSocketClient(config.WsClientConfig, connector, lggr), diff --git a/core/services/gateway/gateway.go b/core/services/gateway/gateway.go index c10167b0b94..727a1e83f5e 100644 --- a/core/services/gateway/gateway.go +++ b/core/services/gateway/gateway.go @@ -13,6 +13,7 @@ import ( "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promauto" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" "github.com/smartcontractkit/chainlink-common/pkg/jsonrpc2" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/services" @@ -74,7 +75,7 @@ func NewGatewayFromConfig(cfg *config.GatewayConfig, handlerFactory HandlerFacto } codec := &api.JSONRPCCodec{} - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) if err != nil { return nil, fmt.Errorf("error creating gateway metrics: %w", err) } diff --git a/core/services/gateway/gateway_internal_test.go b/core/services/gateway/gateway_internal_test.go index f29130ebfac..635199b71e8 100644 --- a/core/services/gateway/gateway_internal_test.go +++ b/core/services/gateway/gateway_internal_test.go @@ -7,6 +7,7 @@ import ( "github.com/jonboulle/clockwork" "github.com/stretchr/testify/require" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/settings/limits" "github.com/smartcontractkit/chainlink/v2/core/services/gateway/config" @@ -33,7 +34,7 @@ func TestSetupFromNewConfig_SharedDONAndLegacyMethodRouting(t *testing.T) { t.Parallel() lggr := logger.Test(t) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) cfg := &config.GatewayConfig{ diff --git a/core/services/gateway/gateway_test.go b/core/services/gateway/gateway_test.go index ec1f48a95b3..25e4f99d9bc 100644 --- a/core/services/gateway/gateway_test.go +++ b/core/services/gateway/gateway_test.go @@ -14,6 +14,7 @@ import ( "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" jsonrpc "github.com/smartcontractkit/chainlink-common/pkg/jsonrpc2" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/services/servicetest" @@ -431,7 +432,7 @@ func newGatewayWithMockHandler(t *testing.T) (gateway.Gateway, *handlermocks.Han handlersObj := map[string]handlers.Handler{ "testDON": handler, } - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) gw := gateway.NewGateway(&api.JSONRPCCodec{}, httpServer, handlersObj, map[string]string{"testDON": "testDON"}, nil, nil, gMetrics, logger.Test(t)) return gw, handler @@ -644,7 +645,7 @@ func TestGateway_NewStyleConfig_UserMessageRouting(t *testing.T) { // Set up gateway with serviceToMultiHandler (new-style config) httpServer := netmocks.NewHTTPServer(t) httpServer.On("SetHTTPRequestHandler", mock.Anything).Return(nil) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) // Map services to their handlers (as would be created by setupFromNewConfig) @@ -715,7 +716,7 @@ func TestGateway_NewStyleConfig_NodeResponseRouting(t *testing.T) { httpServer := netmocks.NewHTTPServer(t) httpServer.On("SetHTTPRequestHandler", mock.Anything).Return(nil) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) // Map services to their handlers diff --git a/core/services/gateway/handlers/capabilities/v2/http_handler.go b/core/services/gateway/handlers/capabilities/v2/http_handler.go index 849f81d20ef..ceb6ba60c2b 100644 --- a/core/services/gateway/handlers/capabilities/v2/http_handler.go +++ b/core/services/gateway/handlers/capabilities/v2/http_handler.go @@ -288,13 +288,11 @@ func (h *gatewayHandler) HandleNodeMessage(ctx context.Context, resp *jsonrpc.Re methodName := parts[0] switch methodName { case gateway_common.MethodHTTPAction: - start := time.Now() h.metrics.IncrementActionRequestCount(ctx, nodeAddr, h.lggr) err := h.makeOutgoingRequest(ctx, resp, nodeAddr) if err != nil { h.metrics.IncrementActionRequestFailures(ctx, nodeAddr, h.lggr) } - h.metrics.RecordActionRequestLatency(ctx, time.Since(start).Milliseconds(), h.lggr) return err case gateway_common.MethodPushWorkflowMetadata: h.metrics.IncrementMetadataRequestCount(ctx, nodeAddr, gateway_common.MethodPushWorkflowMetadata, h.lggr) @@ -360,13 +358,16 @@ func (h *gatewayHandler) send(ctx context.Context, httpReq network.HTTPRequest, } // createHTTPRequestCallback creates a callback function that makes the actual HTTP request -func (h *gatewayHandler) createHTTPRequestCallback(ctx context.Context, requestID string, httpReq network.HTTPRequest, req gateway_common.OutboundHTTPRequest) func() gateway_common.OutboundHTTPResponse { +func (h *gatewayHandler) createHTTPRequestCallback(ctx context.Context, requestID string, httpReq network.HTTPRequest, req gateway_common.OutboundHTTPRequest, nodeAddr string) func() gateway_common.OutboundHTTPResponse { return func() gateway_common.OutboundHTTPResponse { l := logger.With(h.lggr, "requestID", requestID, "method", req.Method, "timeout", req.TimeoutMs) l.Debugw("Sending request to client", "requestBodySize", len(httpReq.Body), "numHeaders", len(httpReq.Headers)) start := time.Now() resp, err := h.send(ctx, httpReq, req) externalEndpointLatency := time.Since(start) + // Record the actual outbound-call duration for both success and failure. + // Cache hits never invoke this callback, so they emit no observation here. + h.metrics.RecordCustomerEndpointRequestLatency(ctx, nodeAddr, externalEndpointLatency.Milliseconds(), h.lggr) if err != nil { isBlockedRequest := errors.Is(err, network.ErrBlockedRequest) isHTTPSendError := errors.Is(err, network.ErrHTTPSend) @@ -396,7 +397,6 @@ func (h *gatewayHandler) createHTTPRequestCallback(ctx context.Context, requestI } l.Debugw("Received HTTP response", "responseBodySize", len(resp.Body), "statusCode", resp.StatusCode, "numHeaders", len(resp.Headers)) h.metrics.IncrementCustomerEndpointResponseCount(ctx, strconv.Itoa(resp.StatusCode), h.lggr) - h.metrics.RecordCustomerEndpointRequestLatency(ctx, time.Since(start).Milliseconds(), h.lggr) return gateway_common.OutboundHTTPResponse{ StatusCode: resp.StatusCode, Headers: resp.Headers, //nolint:staticcheck // Headers is deprecated in OutboundHTTPResponse, but populated for backwards compatibility @@ -459,7 +459,14 @@ func (h *gatewayHandler) makeOutgoingRequest(ctx context.Context, resp *jsonrpc. defer httpCancel() l := logger.With(h.lggr, "requestID", requestID, "method", req.Method, "timeout", req.TimeoutMs) var outboundResp gateway_common.OutboundHTTPResponse - callback := h.createHTTPRequestCallback(httpCtx, requestID, httpReq, req) + // The gateway-side request timer starts here, immediately before the + // callback is created: it covers cache/HTTP processing plus the response + // send for each admitted request. Parsing, admission, and goroutine + // scheduling happen earlier and are intentionally excluded. Requests + // rejected synchronously (before this goroutine runs) are represented by + // the failure counters, not by request-duration samples. + requestStart := time.Now() + callback := h.createHTTPRequestCallback(httpCtx, requestID, httpReq, req, nodeAddr) if req.CacheSettings.MaxAgeMs > 0 { h.metrics.IncrementCacheReadCount(ctx, h.lggr) outboundResp = h.responseCache.Fetch(httpCtx, req, callback, req.CacheSettings.Store) @@ -474,7 +481,10 @@ func (h *gatewayHandler) makeOutgoingRequest(ctx context.Context, resp *jsonrpc. // expired HTTP request timeout does not prevent delivering the result. sendCtx, sendCancel := context.WithTimeout(baseCtx, sendResponseTimeout) defer sendCancel() + sendStart := time.Now() err := h.sendResponseToNode(sendCtx, requestID, outboundResp, nodeAddr) + h.metrics.RecordActionResponseSendLatency(ctx, nodeAddr, time.Since(sendStart).Milliseconds(), h.lggr) + h.metrics.RecordActionRequestLatency(ctx, nodeAddr, time.Since(requestStart).Milliseconds(), h.lggr) if err != nil { l.Errorw("error sending response to node", "err", err, "nodeAddr", nodeAddr, "requestID", requestID) h.metrics.IncrementActionCapabilityFailures(ctx, nodeAddr, h.lggr) diff --git a/core/services/gateway/handlers/capabilities/v2/http_handler_test.go b/core/services/gateway/handlers/capabilities/v2/http_handler_test.go index feec27543a6..f46fae5d4b6 100644 --- a/core/services/gateway/handlers/capabilities/v2/http_handler_test.go +++ b/core/services/gateway/handlers/capabilities/v2/http_handler_test.go @@ -13,6 +13,10 @@ import ( "github.com/google/uuid" "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" + "go.opentelemetry.io/otel/attribute" + "go.opentelemetry.io/otel/metric" + sdkmetric "go.opentelemetry.io/otel/sdk/metric" + "go.opentelemetry.io/otel/sdk/metric/metricdata" jsonrpc "github.com/smartcontractkit/chainlink-common/pkg/jsonrpc2" "github.com/smartcontractkit/chainlink-common/pkg/logger" @@ -20,6 +24,7 @@ import ( gateway_common "github.com/smartcontractkit/chainlink-common/pkg/types/gateway" "github.com/smartcontractkit/chainlink/v2/core/services/gateway/config" "github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers" + "github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers/capabilities/v2/metrics" triggermocks "github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers/capabilities/v2/mocks" handlermocks "github.com/smartcontractkit/chainlink/v2/core/services/gateway/handlers/mocks" "github.com/smartcontractkit/chainlink/v2/core/services/gateway/network" @@ -82,7 +87,7 @@ func TestNewGatewayHandler(t *testing.T) { } func TestHandleNodeMessage(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) t.Run("successful node message handling", func(t *testing.T) { mockDon := handler.shards[0].connMgr.(*handlermocks.DON) @@ -322,7 +327,7 @@ func TestHandleNodeMessage(t *testing.T) { } func TestServiceLifecycle(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) t.Run("start and stop", func(t *testing.T) { ctx := t.Context() @@ -344,7 +349,7 @@ func TestHandleNodeMessage_RoutesToTriggerHandler(t *testing.T) { // This test covers the case where the response ID does not contain a "/" // and should be routed to the triggerHandler.HandleNodeTriggerResponse. mockTriggerHandler := triggermocks.NewHTTPTriggerHandler(t) - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.triggerHandler = mockTriggerHandler rawRes := json.RawMessage([]byte(`{}`)) @@ -365,7 +370,7 @@ func TestHandleNodeMessage_RoutesToTriggerHandler(t *testing.T) { } func TestHandleNodeMessage_UnsupportedMethod(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) rawRes := json.RawMessage([]byte(`{}`)) resp := &jsonrpc.Response[json.RawMessage]{ ID: "unsupportedMethod/123", @@ -379,7 +384,7 @@ func TestHandleNodeMessage_UnsupportedMethod(t *testing.T) { } func TestHandleNodeMessage_EmptyID(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) rawRes := json.RawMessage([]byte(`{}`)) resp := &jsonrpc.Response[json.RawMessage]{ ID: "", @@ -396,6 +401,9 @@ type mockResponseCache struct { deleteExpiredCh chan struct{} setCallCount int fetchCallCount int + // fetchResp, when non-nil, is returned by Fetch without calling fetchFn, + // simulating a cache hit. + fetchResp *gateway_common.OutboundHTTPResponse } func newMockResponseCache() *mockResponseCache { @@ -412,6 +420,9 @@ func (m *mockResponseCache) Set(req gateway_common.OutboundHTTPRequest, response func (m *mockResponseCache) Fetch(ctx context.Context, req gateway_common.OutboundHTTPRequest, fetchFn func() gateway_common.OutboundHTTPResponse, storeOnFetch bool) gateway_common.OutboundHTTPResponse { m.fetchCallCount++ + if m.fetchResp != nil { + return *m.fetchResp + } return fetchFn() } @@ -470,7 +481,7 @@ func shardedArgs(donConfig *config.DONConfig, mockDon *handlermocks.DON) ([]conf }, [][]handlers.DON{{mockDon}} } -func createTestHandler(t *testing.T) *gatewayHandler { +func createTestHandler(t *testing.T) (*gatewayHandler, *sdkmetric.ManualReader) { cfg := serviceCfg() return createTestHandlerWithConfig(t, cfg) } @@ -483,7 +494,7 @@ func verifyBackwardCompatibility(t *testing.T, headers map[string]string, multiH } } -func createTestHandlerWithConfig(t *testing.T, cfg ServiceConfig) *gatewayHandler { +func createTestHandlerWithConfig(t *testing.T, cfg ServiceConfig) (*gatewayHandler, *sdkmetric.ManualReader) { configBytes, err := json.Marshal(cfg) require.NoError(t, err) @@ -501,9 +512,12 @@ func createTestHandlerWithConfig(t *testing.T, cfg ServiceConfig) *gatewayHandle shardedDONs, connMgrs := shardedArgs(donConfig, mockDon) handler, err := NewGatewayHandler(configBytes, shardedDONs, connMgrs, mockHTTPClient, lggr, limits.Factory{Logger: lggr}, defaultTestHTTPClientFactory, nil) require.NoError(t, err) + meter, reader := newBeholderReader(t) + handler.metrics, err = metrics.NewMetricsWithMeter(allMembers(handler.shards), meter) + require.NoError(t, err) require.NotNil(t, handler) - return handler + return handler, reader } func TestCreateHTTPRequestCallback(t *testing.T) { @@ -526,7 +540,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { } t.Run("successful HTTP request with latency measurement", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) expectedResp := &network.HTTPResponse{ @@ -537,7 +551,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).Return(expectedResp, nil) - callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq, "node1") response := callback() require.Equal(t, expectedResp.StatusCode, response.StatusCode) @@ -549,12 +563,12 @@ func TestCreateHTTPRequestCallback(t *testing.T) { }) t.Run("HTTP send error sets IsExternalEndpointError to true", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).Return(nil, network.ErrHTTPSend) - callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq, "node1") response := callback() @@ -568,7 +582,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { }) t.Run("response with MultiHeaders is passed through correctly", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) expectedResp := &network.HTTPResponse{ @@ -592,7 +606,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).Return(expectedResp, nil) - callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq, "node1") response := callback() require.Equal(t, expectedResp.StatusCode, response.StatusCode) @@ -618,7 +632,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { }) t.Run("response with empty MultiHeaders still sets Headers", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) expectedResp := &network.HTTPResponse{ @@ -632,7 +646,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).Return(expectedResp, nil) - callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq, "node1") response := callback() require.Equal(t, expectedResp.StatusCode, response.StatusCode) @@ -645,12 +659,12 @@ func TestCreateHTTPRequestCallback(t *testing.T) { }) t.Run("HTTP read error sets IsExternalEndpointError to true", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).Return(nil, network.ErrHTTPRead) - callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq, "node1") response := callback() @@ -664,13 +678,13 @@ func TestCreateHTTPRequestCallback(t *testing.T) { }) t.Run("other errors set IsExternalEndpointError to false", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) genericError := errors.New("some other network error") mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).Return(nil, genericError) - callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(ctx, requestID, httpReq, outboundReq, "node1") response := callback() @@ -685,7 +699,7 @@ func TestCreateHTTPRequestCallback(t *testing.T) { } func TestMakeOutgoingRequest_SendResponseUsesIndependentContext(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockDon := handler.shards[0].connMgr.(*handlermocks.DON) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) @@ -725,10 +739,176 @@ func TestMakeOutgoingRequest_SendResponseUsesIndependentContext(t *testing.T) { handler.wg.Wait() } +// setupBeholderReader swaps the process-global Beholder client for one backed +// by a ManualReader so emitted metrics can be asserted, and returns the reader. +func newBeholderReader(t *testing.T) (metric.Meter, *sdkmetric.ManualReader) { + t.Helper() + reader := sdkmetric.NewManualReader() + meterProvider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(reader)) + t.Cleanup(func() { require.NoError(t, meterProvider.Shutdown(t.Context())) }) + return meterProvider.Meter("http-handler-test"), reader +} + +// findInt64HistogramDataPoint returns the histogram data point for the metric +// with the given name whose attributes match all of the given key/value pairs. +func findInt64HistogramDataPoint(rm metricdata.ResourceMetrics, name string, attrs map[string]string) (metricdata.HistogramDataPoint[int64], bool) { + for _, scopeMetrics := range rm.ScopeMetrics { + for _, m := range scopeMetrics.Metrics { + if m.Name != name { + continue + } + histogram, ok := m.Data.(metricdata.Histogram[int64]) + if !ok { + continue + } + for _, dp := range histogram.DataPoints { + matches := true + for k, v := range attrs { + attributeValue, ok := dp.Attributes.Value(attribute.Key(k)) + if !ok || attributeValue.AsString() != v { + matches = false + break + } + } + if matches { + return dp, true + } + } + } + } + return metricdata.HistogramDataPoint[int64]{}, false +} + +func newHTTPActionNodeMessage(t *testing.T) *jsonrpc.Response[json.RawMessage] { + t.Helper() + outboundReq := gateway_common.OutboundHTTPRequest{ + Method: "GET", + URL: "https://example.com/api", + TimeoutMs: 5000, + } + reqBytes, err := json.Marshal(outboundReq) + require.NoError(t, err) + rawRequest := json.RawMessage(reqBytes) + return &jsonrpc.Response[json.RawMessage]{ + ID: fmt.Sprintf("%s/%s", gateway_common.MethodHTTPAction, uuid.New().String()), + Result: &rawRequest, + } +} + +func TestHTTPActionLatencyMetrics(t *testing.T) { + t.Parallel() + + t.Run("async timer covers HTTP work plus response send; send has its own timer", func(t *testing.T) { + t.Parallel() + handler, reader := createTestHandler(t) + mockDon := handler.shards[0].connMgr.(*handlermocks.DON) + mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) + + const httpDelay = 120 * time.Millisecond + const sendDelay = 60 * time.Millisecond + mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).RunAndReturn( + func(ctx context.Context, req network.HTTPRequest) (*network.HTTPResponse, error) { + time.Sleep(httpDelay) + return &network.HTTPResponse{StatusCode: 200, Body: []byte("ok")}, nil + }) + mockDon.EXPECT().SendToNode(mock.Anything, "node1", mock.Anything).RunAndReturn( + func(ctx context.Context, nodeAddress string, req *jsonrpc.Request[json.RawMessage]) error { + time.Sleep(sendDelay) + return nil + }) + + require.NoError(t, handler.HandleNodeMessage(t.Context(), newHTTPActionNodeMessage(t), "node1")) + handler.wg.Wait() + + var rm metricdata.ResourceMetrics + require.NoError(t, reader.Collect(t.Context(), &rm)) + + reqLatency, ok := findInt64HistogramDataPoint(rm, "http_action_gateway_request_latency_ms", map[string]string{"node_address": "node1"}) + require.True(t, ok, "async request latency must be recorded") + require.Equal(t, uint64(1), reqLatency.Count, "async request latency must record exactly once per admitted request") + require.GreaterOrEqual(t, reqLatency.Sum, int64(150), "request latency must cover HTTP work plus response send") + + sendLatency, ok := findInt64HistogramDataPoint(rm, "http_action_gateway_response_send_latency_ms", map[string]string{"node_address": "node1"}) + require.True(t, ok, "response send latency must be recorded") + require.Equal(t, uint64(1), sendLatency.Count, "response send latency must record exactly once") + require.GreaterOrEqual(t, sendLatency.Sum, int64(50), "response send timer must include the delayed send") + require.Less(t, sendLatency.Sum, reqLatency.Sum, "send timer is nested inside the request timer") + + endpointLatency, ok := findInt64HistogramDataPoint(rm, "http_action_customer_endpoint_request_latency_ms", map[string]string{"node_address": "node1"}) + require.True(t, ok, "customer endpoint latency must be recorded") + require.Equal(t, uint64(1), endpointLatency.Count, "customer endpoint latency must record exactly once") + require.GreaterOrEqual(t, endpointLatency.Sum, int64(100), "endpoint latency must include the delayed HTTP call") + }) + + t.Run("failed outbound call still records endpoint latency", func(t *testing.T) { + t.Parallel() + handler, reader := createTestHandler(t) + mockDon := handler.shards[0].connMgr.(*handlermocks.DON) + mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) + + const httpDelay = 100 * time.Millisecond + mockHTTPClient.EXPECT().Send(mock.Anything, mock.Anything).RunAndReturn( + func(ctx context.Context, req network.HTTPRequest) (*network.HTTPResponse, error) { + time.Sleep(httpDelay) + return nil, network.ErrHTTPSend + }) + mockDon.EXPECT().SendToNode(mock.Anything, "node1", mock.Anything).Return(nil) + + require.NoError(t, handler.HandleNodeMessage(t.Context(), newHTTPActionNodeMessage(t), "node1")) + handler.wg.Wait() + + var rm metricdata.ResourceMetrics + require.NoError(t, reader.Collect(t.Context(), &rm)) + + endpointLatency, ok := findInt64HistogramDataPoint(rm, "http_action_customer_endpoint_request_latency_ms", map[string]string{"node_address": "node1"}) + require.True(t, ok, "failed outbound calls must still record endpoint latency") + require.Equal(t, uint64(1), endpointLatency.Count) + require.GreaterOrEqual(t, endpointLatency.Sum, int64(80)) + }) + + t.Run("cache hit emits no outbound-call observation", func(t *testing.T) { + t.Parallel() + handler, reader := createTestHandler(t) + mockDon := handler.shards[0].connMgr.(*handlermocks.DON) + + mockCache := newMockResponseCache() + mockCache.fetchResp = &gateway_common.OutboundHTTPResponse{StatusCode: 200} + handler.responseCache = mockCache + + outboundReq := gateway_common.OutboundHTTPRequest{ + Method: "GET", + URL: "https://example.com/cached", + TimeoutMs: 5000, + CacheSettings: gateway_common.CacheSettings{ + MaxAgeMs: 60000, + Store: true, + }, + } + reqBytes, err := json.Marshal(outboundReq) + require.NoError(t, err) + rawRequest := json.RawMessage(reqBytes) + resp := &jsonrpc.Response[json.RawMessage]{ + ID: fmt.Sprintf("%s/%s", gateway_common.MethodHTTPAction, uuid.New().String()), + Result: &rawRequest, + } + + mockDon.EXPECT().SendToNode(mock.Anything, "node1", mock.Anything).Return(nil) + + require.NoError(t, handler.HandleNodeMessage(t.Context(), resp, "node1")) + handler.wg.Wait() + + var rm metricdata.ResourceMetrics + require.NoError(t, reader.Collect(t.Context(), &rm)) + + _, ok := findInt64HistogramDataPoint(rm, "http_action_customer_endpoint_request_latency_ms", map[string]string{"node_address": "node1"}) + require.False(t, ok, "cache hits make no outbound call and must not record endpoint latency") + }) +} + // TestMakeOutgoingRequestCachingBehavior tests the specific caching logic in makeOutgoingRequest func TestMakeOutgoingRequestCachingBehavior(t *testing.T) { t.Run("MaxAgeMs=0 and Store=true calls Set", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockCache := newMockResponseCache() handler.responseCache = mockCache @@ -772,7 +952,7 @@ func TestMakeOutgoingRequestCachingBehavior(t *testing.T) { }) t.Run("MaxAgeMs=0 and Store=false does not call Set", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockCache := newMockResponseCache() handler.responseCache = mockCache @@ -816,7 +996,7 @@ func TestMakeOutgoingRequestCachingBehavior(t *testing.T) { }) t.Run("MaxAgeMs>0 calls CachedFetch", func(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockCache := newMockResponseCache() handler.responseCache = mockCache @@ -862,7 +1042,7 @@ func TestMakeOutgoingRequestCachingBehavior(t *testing.T) { // setupRateLimitingTest creates common test setup for rate limiting tests func setupRateLimitingTest(t *testing.T, cfg ServiceConfig) (*gatewayHandler, *jsonrpc.Response[json.RawMessage], *httpmocks.HTTPClient, *handlermocks.DON) { - handler := createTestHandlerWithConfig(t, cfg) + handler, _ := createTestHandlerWithConfig(t, cfg) outboundReq := gateway_common.OutboundHTTPRequest{ Method: "GET", @@ -945,7 +1125,7 @@ var defaultTestHTTPClientFactory network.HTTPClientFactory = func(config network } func TestGatewayHandler_Send_NoMtls_UsesDefaultClient(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) httpReq := network.HTTPRequest{Method: "GET", URL: "https://example.com/api"} @@ -960,7 +1140,7 @@ func TestGatewayHandler_Send_NoMtls_UsesDefaultClient(t *testing.T) { } func TestGatewayHandler_Send_MtlsBlockedByRateLimit(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(0, 0) handler.httpClientFactory = func(config network.HTTPClientConfig) (network.HTTPClient, error) { return httpmocks.NewHTTPClient(t), nil @@ -988,7 +1168,7 @@ func TestGatewayHandler_Send_MtlsBlockedByRateLimit(t *testing.T) { // limiter is enforced inside the HTTP client (on the request's capped-timeout // context); that enforcement is covered by the network package tests. func TestGatewayHandler_Send_MtlsPassesConcurrencyLimiterToFactory(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(100, 100) httpReq := network.HTTPRequest{Method: "GET", URL: "https://example.com/api"} @@ -1019,7 +1199,7 @@ func TestGatewayHandler_Send_MtlsPassesConcurrencyLimiterToFactory(t *testing.T) } func TestGatewayHandler_Send_MtlsUsesFactory(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(100, 100) httpReq := network.HTTPRequest{Method: "GET", URL: "https://example.com/api"} @@ -1058,7 +1238,7 @@ func TestGatewayHandler_Send_MtlsUsesFactory(t *testing.T) { } func TestGatewayHandler_Send_MtlsFactoryError(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(100, 100) httpReq := network.HTTPRequest{Method: "GET", URL: "https://example.com/api"} @@ -1085,7 +1265,7 @@ func TestGatewayHandler_Send_MtlsFactoryError(t *testing.T) { // requests with bogus certificates. It uses the real HTTP client factory so that the // production code path is what rejects the certificate as invalid. func TestGatewayHandler_Send_InvalidMtlsCertDoesNotConsumeGlobalTokens(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) // Burst of exactly 1: only a single mtls request may pass the rate limiter. handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(1, 1) handler.httpClientFactory = network.NewHTTPClientFactory(network.HTTPClientConfig{}, logger.Test(t)) @@ -1116,7 +1296,7 @@ func TestGatewayHandler_Send_InvalidMtlsCertDoesNotConsumeGlobalTokens(t *testin // client. This is the core property that prevents auth'd connections from // leaking between users. func TestGatewayHandler_Send_MtlsRoutesThroughCallbackOnly_DefaultClientUntouched(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(100, 100) httpReq := network.HTTPRequest{Method: "GET", URL: "https://example.com/api", Timeout: 5 * time.Second} @@ -1133,7 +1313,7 @@ func TestGatewayHandler_Send_MtlsRoutesThroughCallbackOnly_DefaultClientUntouche return mtlsClient, nil } - callback := handler.createHTTPRequestCallback(t.Context(), "req-id", httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(t.Context(), "req-id", httpReq, outboundReq, "node1") resp := callback() require.Empty(t, resp.ErrorMessage) require.Equal(t, 200, resp.StatusCode) @@ -1144,7 +1324,7 @@ func TestGatewayHandler_Send_MtlsRoutesThroughCallbackOnly_DefaultClientUntouche } func TestGatewayHandler_Send_MtlsBlockedRequestIsValidationError(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.mtlsRequestRateLimiter = limits.GlobalRateLimiter(0, 0) handler.httpClientFactory = func(config network.HTTPClientConfig) (network.HTTPClient, error) { return httpmocks.NewHTTPClient(t), nil @@ -1157,7 +1337,7 @@ func TestGatewayHandler_Send_MtlsBlockedRequestIsValidationError(t *testing.T) { Mtls: &gateway_common.MtlsAuth{PrivateKey: []byte("k"), Certificate: []byte("c")}, } - callback := handler.createHTTPRequestCallback(t.Context(), "req-id", httpReq, outboundReq) + callback := handler.createHTTPRequestCallback(t.Context(), "req-id", httpReq, outboundReq, "node1") resp := callback() require.NotEmpty(t, resp.ErrorMessage) require.True(t, resp.IsValidationError, "blocked mtls should be reported as a validation error") @@ -1171,7 +1351,7 @@ func TestGatewayHandler_Send_MtlsBlockedRequestIsValidationError(t *testing.T) { // rate (cresettings.Default.GatewayHTTPActionMtlsRequestRate) has a zero burst, // meaning mtls is blocked out of the box. func TestGatewayHandler_Send_MtlsRateLimitEnabledByDefault(t *testing.T) { - handler := createTestHandler(t) + handler, _ := createTestHandler(t) handler.httpClientFactory = func(config network.HTTPClientConfig) (network.HTTPClient, error) { return httpmocks.NewHTTPClient(t), nil } @@ -1316,7 +1496,7 @@ func TestGatewayHandler_SendResponseToNode_MultiShardRouting(t *testing.T) { func TestGatewayHandler_HandleNodeMessage_UnknownNodeRejected(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) rawRes := json.RawMessage([]byte(`{}`)) resp := &jsonrpc.Response[json.RawMessage]{ diff --git a/core/services/gateway/handlers/capabilities/v2/metrics/metrics.go b/core/services/gateway/handlers/capabilities/v2/metrics/metrics.go index 8a6e3d2adeb..25fa51da7cc 100644 --- a/core/services/gateway/handlers/capabilities/v2/metrics/metrics.go +++ b/core/services/gateway/handlers/capabilities/v2/metrics/metrics.go @@ -43,6 +43,7 @@ type ActionMetrics struct { requestCount metric.Int64Counter requestFailures metric.Int64Counter requestLatency metric.Int64Histogram + responseSendLatency metric.Int64Histogram customerEndpointRequestLatency metric.Int64Histogram customerEndpointResponseCount metric.Int64Counter cacheReadCount metric.Int64Counter @@ -90,8 +91,10 @@ type Metrics struct { // NewMetrics creates a new instance of Metrics with all metrics initialized. // members is the union of node configs across all DON shards. func NewMetrics(members []config.NodeConfig) (*Metrics, error) { - meter := beholder.GetMeter() + return NewMetricsWithMeter(members, beholder.GetMeter()) +} +func NewMetricsWithMeter(members []config.NodeConfig, meter metric.Meter) (*Metrics, error) { common, err := newCommonMetrics(meter) if err != nil { return nil, fmt.Errorf("failed to create common metrics: %w", err) @@ -167,15 +170,23 @@ func newActionMetrics(meter metric.Meter) (*ActionMetrics, error) { m.requestLatency, err = meter.Int64Histogram( "http_action_gateway_request_latency_ms", - metric.WithDescription("HTTP action request latency in milliseconds in the gateway"), + metric.WithDescription("HTTP action request latency in milliseconds in the gateway, measured inside the async worker: cache/HTTP processing plus response send for each admitted request. Parsing, admission, and goroutine scheduling are excluded; synchronously rejected requests appear in failure counters, not here"), ) if err != nil { return nil, fmt.Errorf("failed to create HTTP action gateway request latency metric: %w", err) } + m.responseSendLatency, err = meter.Int64Histogram( + "http_action_gateway_response_send_latency_ms", + metric.WithDescription("Time in milliseconds for the gateway to send an HTTP action response to the node (sendResponseToNode), including send failures. Separates response-write contention from cache/HTTP processing"), + ) + if err != nil { + return nil, fmt.Errorf("failed to create HTTP action gateway response send latency metric: %w", err) + } + m.customerEndpointRequestLatency, err = meter.Int64Histogram( "http_action_customer_endpoint_request_latency_ms", - metric.WithDescription("Request latency while calling customer endpoint in milliseconds"), + metric.WithDescription("Request latency while calling customer endpoint in milliseconds, including failed calls. Cache hits make no outbound call and emit no observation"), ) if err != nil { return nil, fmt.Errorf("failed to create HTTP action customer endpoint request latency metric: %w", err) @@ -463,12 +474,31 @@ func (m *Metrics) IncrementOutboundConcurrencyThrottled(ctx context.Context, nod )) } -func (m *Metrics) RecordActionRequestLatency(ctx context.Context, latencyMs int64, lggr logger.Logger) { - m.action.requestLatency.Record(ctx, latencyMs) +// RecordActionRequestLatency records the async work duration of one admitted +// HTTP action request: from callback construction (inside the makeOutgoingRequest +// goroutine) until sendResponseToNode returns. Synchronously rejected requests +// produce no sample here. +func (m *Metrics) RecordActionRequestLatency(ctx context.Context, nodeAddress string, latencyMs int64, lggr logger.Logger) { + m.action.requestLatency.Record(ctx, latencyMs, metric.WithAttributes( + attribute.String(AttrNodeAddress, nodeAddress), + )) +} + +// RecordActionResponseSendLatency records the duration of sendResponseToNode, +// including send failures. +func (m *Metrics) RecordActionResponseSendLatency(ctx context.Context, nodeAddress string, latencyMs int64, lggr logger.Logger) { + m.action.responseSendLatency.Record(ctx, latencyMs, metric.WithAttributes( + attribute.String(AttrNodeAddress, nodeAddress), + )) } -func (m *Metrics) RecordCustomerEndpointRequestLatency(ctx context.Context, latencyMs int64, lggr logger.Logger) { - m.action.customerEndpointRequestLatency.Record(ctx, latencyMs) +// RecordCustomerEndpointRequestLatency records the duration of an actual +// outbound call to the customer endpoint, including failures. Cache hits make +// no outbound call and emit no observation. +func (m *Metrics) RecordCustomerEndpointRequestLatency(ctx context.Context, nodeAddress string, latencyMs int64, lggr logger.Logger) { + m.action.customerEndpointRequestLatency.Record(ctx, latencyMs, metric.WithAttributes( + attribute.String(AttrNodeAddress, nodeAddress), + )) } func (m *Metrics) IncrementCustomerEndpointResponseCount(ctx context.Context, statusCode string, lggr logger.Logger) { @@ -620,13 +650,19 @@ func (m *Metrics) RecordLoadedMetadataSize(ctx context.Context, size int64, lggr // MetricViews returns histogram bucket definitions for this package's metrics. // Due to the OTEL specification, all histogram buckets must be defined when the beholder client is created. func MetricViews() []sdkmetric.View { - return []sdkmetric.View{ - sdkmetric.NewView( - sdkmetric.Instrument{Name: "http_trigger_gateway_capability_request_latency_ms"}, + latencyBoundaries := []float64{10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 90000} + histogramView := func(name string) sdkmetric.View { + return sdkmetric.NewView( + sdkmetric.Instrument{Name: name}, sdkmetric.Stream{Aggregation: sdkmetric.AggregationExplicitBucketHistogram{ - // 10ms up to 90s (max trigger request duration is on this order), with finer granularity at the lower end - Boundaries: []float64{10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, 50000, 90000}, + Boundaries: latencyBoundaries, }}, - ), + ) + } + return []sdkmetric.View{ + histogramView("http_trigger_gateway_capability_request_latency_ms"), + histogramView("http_action_gateway_request_latency_ms"), + histogramView("http_action_gateway_response_send_latency_ms"), + histogramView("http_action_customer_endpoint_request_latency_ms"), } } diff --git a/core/services/gateway/handlers/capabilities/v2/outbound_bounds_test.go b/core/services/gateway/handlers/capabilities/v2/outbound_bounds_test.go index d6c97516540..5c76b42e902 100644 --- a/core/services/gateway/handlers/capabilities/v2/outbound_bounds_test.go +++ b/core/services/gateway/handlers/capabilities/v2/outbound_bounds_test.go @@ -52,7 +52,7 @@ func okHTTPResponse() *network.HTTPResponse { // With every global slot taken, a further request must be refused before any outbound call. func TestMakeOutgoingRequest_RejectsWhenGlobalConcurrencyExhausted(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) for range globalOutboundLimit { require.NoError(t, handler.outboundConcurrencyLimiter.Use(t.Context(), 1)) } @@ -64,7 +64,7 @@ func TestMakeOutgoingRequest_RejectsWhenGlobalConcurrencyExhausted(t *testing.T) // One node must not be able to occupy more than its share func TestMakeOutgoingRequest_RejectsWhenNodeLimitReached(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) for range perNodeOutboundLimit { require.NoError(t, handler.perNodeOutboundLimiters["node1"].Use(t.Context(), 1)) } @@ -81,7 +81,7 @@ func TestMakeOutgoingRequest_RejectsWhenNodeLimitReached(t *testing.T) { // A node at its per-node bound must not consume capacity belonging to its peers. func TestMakeOutgoingRequest_NodeLimitIsolatesPeers(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) mockDon := handler.shards[0].connMgr.(*handlermocks.DON) @@ -104,7 +104,7 @@ func TestMakeOutgoingRequest_NodeLimitIsolatesPeers(t *testing.T) { // Slots must be returned when a request finishes func TestMakeOutgoingRequest_ReleasesSlotOnCompletion(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) mockDon := handler.shards[0].connMgr.(*handlermocks.DON) @@ -131,7 +131,7 @@ func TestMakeOutgoingRequest_ReleasesSlotOnCompletion(t *testing.T) { // A failed outbound request must still release its slots on both bounds func TestMakeOutgoingRequest_ReleasesSlotOnFailure(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) mockHTTPClient := handler.httpClient.(*httpmocks.HTTPClient) mockDon := handler.shards[0].connMgr.(*handlermocks.DON) @@ -153,7 +153,7 @@ func TestMakeOutgoingRequest_ReleasesSlotOnFailure(t *testing.T) { // A node with no per-node limiter is not a DON member and must be refused func TestAcquireOutboundSlot_RejectsUnknownNode(t *testing.T) { t.Parallel() - handler := createTestHandler(t) + handler, _ := createTestHandler(t) release, err := handler.acquireOutboundSlot(t.Context(), "not-a-member") require.ErrorContains(t, err, "unexpected node") diff --git a/core/services/gateway/handlers/vault/aggregator_test_helpers.go b/core/services/gateway/handlers/vault/aggregator_test_helpers.go index e1e5e4599e2..a452ba967c5 100644 --- a/core/services/gateway/handlers/vault/aggregator_test_helpers.go +++ b/core/services/gateway/handlers/vault/aggregator_test_helpers.go @@ -76,11 +76,9 @@ func makeSignedVaultResponse(t *testing.T, method, requestID string, payload jso round := ctx[63] fullHash := ocr2key.ReportToSigData(ocr2types.ReportContext{ - ReportTimestamp: ocr2types.ReportTimestamp{ - ConfigDigest: configDigest, - Epoch: epoch, - Round: round, - }, + ConfigDigest: configDigest, + Epoch: epoch, + Round: round, }, []byte(payload)) signatures := make([][]byte, numSigners) diff --git a/core/services/gateway/keepalive_loop_internal_test.go b/core/services/gateway/keepalive_loop_internal_test.go index e1d9935b050..35d026db0bd 100644 --- a/core/services/gateway/keepalive_loop_internal_test.go +++ b/core/services/gateway/keepalive_loop_internal_test.go @@ -2,6 +2,7 @@ package gateway import ( "context" + "fmt" "sync" "sync/atomic" "testing" @@ -10,6 +11,7 @@ import ( "github.com/gorilla/websocket" "github.com/stretchr/testify/require" + "github.com/smartcontractkit/chainlink-common/pkg/beholder" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/services" "github.com/smartcontractkit/chainlink/v2/core/services/gateway/config" @@ -25,14 +27,14 @@ type mockPingConn struct { unblock chan struct{} // if non-nil, Write blocks until closed } -func (m *mockPingConn) Start(context.Context) error { return nil } -func (m *mockPingConn) HealthReport() map[string]error { return nil } -func (m *mockPingConn) Name() string { return "mockPingConn" } -func (m *mockPingConn) Ready() error { return nil } -func (m *mockPingConn) Reset(*websocket.Conn) <-chan error { return nil } -func (m *mockPingConn) ReadChannel() <-chan network.ReadItem { return nil } -func (m *mockPingConn) IsConnected() bool { return true } -func (m *mockPingConn) Close() error { return nil } +func (m *mockPingConn) Start(context.Context) error { return nil } +func (m *mockPingConn) HealthReport() map[string]error { return nil } +func (m *mockPingConn) Name() string { return "mockPingConn" } +func (m *mockPingConn) Ready() error { return nil } +func (m *mockPingConn) Reset(network.WSConnection) <-chan error { return nil } +func (m *mockPingConn) ReadChannel() <-chan network.ReadItem { return nil } +func (m *mockPingConn) IsConnected() bool { return true } +func (m *mockPingConn) Close() error { return nil } func (m *mockPingConn) Write(ctx context.Context, msgType int, _ []byte) error { if msgType == websocket.PingMessage { @@ -64,7 +66,7 @@ func TestKeepAliveLoop_StuckNodeBlocksAll(t *testing.T) { t.Parallel() lggr := logger.Test(t) - gMetrics, err := monitoring.NewGatewayMetrics() + gMetrics, err := monitoring.NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) unblock := make(chan struct{}) @@ -128,3 +130,88 @@ func TestKeepAliveLoop_StuckNodeBlocksAll(t *testing.T) { close(donMgr.shutdownCh) donMgr.closeWait.Wait() } + +func TestPingProbeTracker_Matching(t *testing.T) { + t.Parallel() + + tracker := &pingProbeTracker{} + + // No probe registered: no observation. + _, ok := tracker.consume("unknown") + require.False(t, ok) + + // Wrong token (e.g. a pong for a superseded probe): no observation, and the + // pending probe stays registered. + start := time.Now() + tracker.register("token-a", start) + _, ok = tracker.consume("token-b") + require.False(t, ok) + + // Matching token: exactly one observation. + got, ok := tracker.consume("token-a") + require.True(t, ok) + require.Equal(t, start, got) + + // Duplicate pong: no second observation. + _, ok = tracker.consume("token-a") + require.False(t, ok) + + // A superseded probe produces no observation: only the latest is retained. + tracker.register("token-old", time.Now()) + newStart := time.Now() + tracker.register("token-new", newStart) + _, ok = tracker.consume("token-old") + require.False(t, ok, "superseded probe must not record") + got, ok = tracker.consume("token-new") + require.True(t, ok) + require.Equal(t, newStart, got) +} + +func TestPingProbeTracker_StaleConnectionCannotMatchReplacement(t *testing.T) { + t.Parallel() + + // nodeState carries the current connection's tracker; FinalizeHandshake + // replaces it on every handshake. + ns := &nodeState{name: "node"} + stale := &pingProbeTracker{} + ns.pingTracker.Store(stale) + + // Connection replaced: a fresh tracker is installed and receives new probes. + fresh := &pingProbeTracker{} + ns.pingTracker.Store(fresh) + start := time.Now() + fresh.register("token-replacement", start) + + // A pong arriving on the old connection is matched against the stale tracker + // via its pong-handler closure: it can never record against the replacement. + _, ok := stale.consume("token-replacement") + require.False(t, ok, "stale connection's tracker must not match the replacement's probe") + + // The replacement connection's tracker still matches its own probe, once. + got, ok := fresh.consume("token-replacement") + require.True(t, ok) + require.Equal(t, start, got) +} + +func TestPingProbeTracker_Concurrent(t *testing.T) { + t.Parallel() + + tracker := &pingProbeTracker{} + var wg sync.WaitGroup + for i := range 8 { + wg.Add(2) + go func() { + defer wg.Done() + for j := range 100 { + tracker.register(fmt.Sprintf("token-%d-%d", i, j), time.Now()) + } + }() + go func() { + defer wg.Done() + for j := range 100 { + tracker.consume(fmt.Sprintf("token-%d", j)) + } + }() + } + wg.Wait() +} diff --git a/core/services/gateway/monitoring/metrics.go b/core/services/gateway/monitoring/metrics.go index 1bae37016c6..cbb0badf8a3 100644 --- a/core/services/gateway/monitoring/metrics.go +++ b/core/services/gateway/monitoring/metrics.go @@ -5,8 +5,10 @@ import ( "strconv" "time" + "github.com/prometheus/client_golang/prometheus" "go.opentelemetry.io/otel/attribute" "go.opentelemetry.io/otel/metric" + sdkmetric "go.opentelemetry.io/otel/sdk/metric" "github.com/smartcontractkit/chainlink-common/pkg/beholder" ) @@ -21,6 +23,7 @@ type GatewayMetrics struct { nodeConnectedEvents metric.Int64Counter keepalivePingsSent metric.Int64Counter keepalivePongsReceived metric.Int64Counter + wsPingRoundTrip metric.Int64Histogram donConnectedNodes metric.Int64Gauge donRequiredNodes metric.Int64Gauge donConfiguredNodes metric.Int64Gauge @@ -84,6 +87,16 @@ func (m *GatewayMetrics) RecordKeepalivePongsReceived(ctx context.Context, nodeA )) } +// RecordWSPingRoundTrip records the observed round trip of a keepalive ping: +// the time from registering the probe (immediately before the ping write) until +// the pong echoing its correlation token arrives +func (m *GatewayMetrics) RecordWSPingRoundTrip(ctx context.Context, nodeAddress string, nodeName string, duration time.Duration) { + m.wsPingRoundTrip.Record(ctx, duration.Milliseconds(), metric.WithAttributes( + attribute.String("nodeAddress", nodeAddress), + attribute.String("nodeName", nodeName), + )) +} + func (m *GatewayMetrics) RecordDONConnectionState(ctx context.Context, donID string, connected, required, configured int) { attrs := metric.WithAttributes(attribute.String("donID", donID)) m.donConnectedNodes.Record(ctx, int64(connected), attrs) @@ -99,58 +112,66 @@ func (m *GatewayMetrics) RecordUserReady(ctx context.Context, ready bool) { m.userReady.Record(ctx, value) } -func NewGatewayMetrics() (*GatewayMetrics, error) { - nodeMsgHandleDuration, err := beholder.GetMeter().Int64Histogram("platform_gateway_node_msg_handler_duration_ms") +func NewGatewayMetrics(meter metric.Meter) (*GatewayMetrics, error) { + nodeMsgHandleDuration, err := meter.Int64Histogram("platform_gateway_node_msg_handler_duration_ms") + if err != nil { + return nil, err + } + + nodeMsgHandleCount, err := meter.Int64Counter("platform_gateway_node_msgs_handled_total") if err != nil { return nil, err } - nodeMsgHandleCount, err := beholder.GetMeter().Int64Counter("platform_gateway_node_msgs_handled_total") + userMsgHandleDuration, err := meter.Int64Histogram("platform_gateway_user_msg_handler_duration_ms") if err != nil { return nil, err } - userMsgHandleDuration, err := beholder.GetMeter().Int64Histogram("platform_gateway_user_msg_handler_duration_ms") + userMsgHandleCount, err := meter.Int64Counter("platform_gateway_user_msgs_handled_total") if err != nil { return nil, err } - userMsgHandleCount, err := beholder.GetMeter().Int64Counter("platform_gateway_user_msgs_handled_total") + nodeConnectedEvents, err := meter.Int64Counter("platform_gateway_node_connected_events_total") if err != nil { return nil, err } - nodeConnectedEvents, err := beholder.GetMeter().Int64Counter("platform_gateway_node_connected_events_total") + keepalivePingsSent, err := meter.Int64Counter("platform_gateway_keepalive_pings_sent_total") if err != nil { return nil, err } - keepalivePingsSent, err := beholder.GetMeter().Int64Counter("platform_gateway_keepalive_pings_sent_total") + keepalivePongsReceived, err := meter.Int64Counter("platform_gateway_keepalive_pongs_received_total") if err != nil { return nil, err } - keepalivePongsReceived, err := beholder.GetMeter().Int64Counter("platform_gateway_keepalive_pongs_received_total") + wsPingRoundTrip, err := meter.Int64Histogram("platform_gateway_ws_ping_round_trip_ms", + metric.WithUnit("ms"), + metric.WithDescription("Observed websocket ping round trip in milliseconds, from ping enqueue to receipt of the pong echoing its correlation token. Includes local write-pump queue wait, transport, and peer control-frame processing; it is not a pure network RTT. Only the connection's latest probe yields a sample"), + ) if err != nil { return nil, err } - donConnectedNodes, err := beholder.GetMeter().Int64Gauge("platform_gateway_don_connected_nodes") + donConnectedNodes, err := meter.Int64Gauge("platform_gateway_don_connected_nodes") if err != nil { return nil, err } - donRequiredNodes, err := beholder.GetMeter().Int64Gauge("platform_gateway_don_required_nodes") + donRequiredNodes, err := meter.Int64Gauge("platform_gateway_don_required_nodes") if err != nil { return nil, err } - donConfiguredNodes, err := beholder.GetMeter().Int64Gauge("platform_gateway_don_configured_nodes") + donConfiguredNodes, err := meter.Int64Gauge("platform_gateway_don_configured_nodes") if err != nil { return nil, err } - userReady, err := beholder.GetMeter().Int64Gauge("platform_gateway_user_ready") + userReady, err := meter.Int64Gauge("platform_gateway_user_ready") if err != nil { return nil, err } @@ -163,6 +184,7 @@ func NewGatewayMetrics() (*GatewayMetrics, error) { nodeConnectedEvents: nodeConnectedEvents, keepalivePingsSent: keepalivePingsSent, keepalivePongsReceived: keepalivePongsReceived, + wsPingRoundTrip: wsPingRoundTrip, donConnectedNodes: donConnectedNodes, donRequiredNodes: donRequiredNodes, donConfiguredNodes: donConfiguredNodes, @@ -194,3 +216,18 @@ func NewHTTPServerMetrics() (*HTTPServerMetrics, error) { } return &HTTPServerMetrics{requestDuration: requestDuration, requestCount: requestCount}, nil } + +// MetricViews returns histogram bucket definitions for this package's metrics. +// Due to the OTEL specification, all histogram buckets must be defined when the beholder client is created. +func MetricViews() []sdkmetric.View { + return []sdkmetric.View{ + sdkmetric.NewView( + sdkmetric.Instrument{Name: "platform_gateway_ws_ping_round_trip_ms"}, + sdkmetric.Stream{Aggregation: sdkmetric.AggregationExplicitBucketHistogram{ + // 1ms up to ~32s: healthy pongs return in milliseconds, but the + // read deadline lets a slow round trip stretch to tens of seconds. + Boundaries: prometheus.ExponentialBuckets(1, 2, 16), + }}, + ), + } +} diff --git a/core/services/gateway/monitoring/metrics_test.go b/core/services/gateway/monitoring/metrics_test.go index af1baae26f7..26a6f2085eb 100644 --- a/core/services/gateway/monitoring/metrics_test.go +++ b/core/services/gateway/monitoring/metrics_test.go @@ -24,7 +24,7 @@ func TestGatewayMetrics_RecordReadiness(t *testing.T) { //nolint:paralleltest // client.MeterProvider = meterProvider beholder.SetClient(client) - metrics, err := NewGatewayMetrics() + metrics, err := NewGatewayMetrics(beholder.GetMeter()) require.NoError(t, err) metrics.RecordDONConnectionState(t.Context(), "workflow_1_zone-a", 5, 7, 10) metrics.RecordUserReady(t.Context(), true) diff --git a/core/services/gateway/network/wsconnection.go b/core/services/gateway/network/wsconnection.go index 4617c733367..fc77cf9e96c 100644 --- a/core/services/gateway/network/wsconnection.go +++ b/core/services/gateway/network/wsconnection.go @@ -4,8 +4,7 @@ import ( "context" "errors" "sync/atomic" - - "github.com/gorilla/websocket" + "time" "github.com/smartcontractkit/chainlink-common/pkg/logger" "github.com/smartcontractkit/chainlink-common/pkg/services" @@ -32,7 +31,10 @@ type WSConnectionWrapper interface { // Update underlying connection object. Return a channel that gets an error on connection close. // Cannot be called after Close(). - Reset(newConn *websocket.Conn) <-chan error + // To disconnect, pass an untyped nil. A nil pointer wrapped in the interface + // (e.g. a nil *websocket.Conn) is non-nil, so it is treated as a live + // connection and the read pump will panic when it reads from it. + Reset(newConn WSConnection) <-chan error Write(ctx context.Context, msgType int, data []byte) error @@ -41,16 +43,27 @@ type WSConnectionWrapper interface { IsConnected() bool } +type WSConnection interface { + ReadMessage() (messageType int, p []byte, err error) + WriteMessage(messageType int, data []byte) error + Close() error +} + +type wsConnectionHolder struct { + WSConnection +} + type wsConnectionWrapper struct { services.StateMachine lggr logger.Logger - conn atomic.Pointer[websocket.Conn] + conn atomic.Pointer[wsConnectionHolder] writeCh chan writeItem readCh chan ReadItem shutdownCh chan struct{} wg services.WaitGroup + metrics WSConnectionObserver } func (c *wsConnectionWrapper) HealthReport() map[string]error { @@ -78,11 +91,22 @@ var ( ) func NewWSConnectionWrapper(lggr logger.Logger) WSConnectionWrapper { + return NewWSConnectionWrapperWithObserver(lggr, nil) +} + +// NewWSConnectionWrapperWithObserver is NewWSConnectionWrapper with a metrics +// observer for the wrapper's blocking operations. A nil observer discards all +// observations. +func NewWSConnectionWrapperWithObserver(lggr logger.Logger, observer WSConnectionObserver) WSConnectionWrapper { + if observer == nil { + observer = noopWSConnectionObserver{} + } cw := &wsConnectionWrapper{ lggr: logger.Named(lggr, "WSConnectionWrapper"), writeCh: make(chan writeItem), readCh: make(chan ReadItem), shutdownCh: make(chan struct{}), + metrics: observer, } return cw } @@ -102,8 +126,13 @@ func (c *wsConnectionWrapper) Start(_ context.Context) error { // 1. replaces the underlying connection and shuts the old one down // 2. starts a new read goroutine that pushes received messages to readCh // 3. returns channel that closes when connection closes, or nil if closed or newConn is nil. -func (c *wsConnectionWrapper) Reset(newConn *websocket.Conn) <-chan error { - oldConn := c.conn.Swap(newConn) +func (c *wsConnectionWrapper) Reset(newConn WSConnection) <-chan error { + var conn *wsConnectionHolder + if newConn != nil { + conn = &wsConnectionHolder{newConn} + } + + oldConn := c.conn.Swap(conn) if oldConn != nil { oldConn.Close() @@ -116,19 +145,26 @@ func (c *wsConnectionWrapper) Reset(newConn *websocket.Conn) <-chan error { } closeCh := make(chan error, 1) // readPump goroutine is tied to the lifecycle of the underlying conn object - go c.readPump(newConn, closeCh) + go c.readPump(conn, closeCh) return closeCh } func (c *wsConnectionWrapper) Write(ctx context.Context, msgType int, data []byte) error { errCh := make(chan error, 1) // push to write channel + c.metrics.AddPendingWriters(ctx, 1) + queueStart := time.Now() select { case c.writeCh <- writeItem{msgType, data, errCh}: - break + c.metrics.AddPendingWriters(ctx, -1) + // The queue wait ends when the write pump accepts the item; the second + // select below (waiting for the write result) is intentionally excluded. + c.metrics.RecordWriteQueueWait(ctx, time.Since(queueStart)) case <-c.shutdownCh: + c.metrics.AddPendingWriters(ctx, -1) return ErrWrapperShutdown case <-ctx.Done(): + c.metrics.AddPendingWriters(ctx, -1) return ctx.Err() } // wait for write result @@ -171,7 +207,11 @@ func (c *wsConnectionWrapper) writePump() { close(wsMsg.ErrCh) break } + // Time exactly the socket write, recording on return (including + // on error) so a stalled write still reports its full duration. + writeStart := time.Now() err := conn.WriteMessage(wsMsg.MsgType, wsMsg.Data) + c.metrics.RecordSocketWrite(context.Background(), time.Since(writeStart)) if err != nil { c.lggr.Errorw("failed to write message", "msgType", wsMsg.MsgType, "dataLen", len(wsMsg.Data), "error", err) // A write failure (e.g. i/o timeout on a half-open TCP session) does not @@ -194,7 +234,7 @@ func (c *wsConnectionWrapper) writePump() { } } -func (c *wsConnectionWrapper) readPump(conn *websocket.Conn, closeCh chan<- error) { +func (c *wsConnectionWrapper) readPump(conn *wsConnectionHolder, closeCh chan<- error) { defer c.wg.Done() for { msgType, data, err := conn.ReadMessage() @@ -211,8 +251,12 @@ func (c *wsConnectionWrapper) readPump(conn *websocket.Conn, closeCh chan<- erro close(closeCh) return } + // Time only the handoff to the read channel consumer; ReadMessage above + // is excluded because it blocks for normal idle time between messages. + dispatchStart := time.Now() select { case c.readCh <- ReadItem{msgType, data}: + c.metrics.RecordReadDispatchWait(context.Background(), time.Since(dispatchStart)) case <-c.shutdownCh: var closeErr error if c.conn.CompareAndSwap(conn, nil) { diff --git a/core/services/gateway/network/wsconnection_metrics.go b/core/services/gateway/network/wsconnection_metrics.go new file mode 100644 index 00000000000..3b929a74ea8 --- /dev/null +++ b/core/services/gateway/network/wsconnection_metrics.go @@ -0,0 +1,142 @@ +package network + +import ( + "context" + "fmt" + "time" + + "github.com/prometheus/client_golang/prometheus" + "go.opentelemetry.io/otel/attribute" + "go.opentelemetry.io/otel/metric" + sdkmetric "go.opentelemetry.io/otel/sdk/metric" +) + +// WSConnectionObserver observes the blocking operations of a single +// WSConnectionWrapper: how long writes wait to be accepted by the write pump, +// how long each socket write takes, how long read messages wait to be handed to +// the consumer, and how many writers are currently queued. Implementations must +// be cheap and non-blocking. +type WSConnectionObserver interface { + // RecordWriteQueueWait records the time a Write call spent in the first + // select, up to the moment the write pump accepted the item. It excludes + // the subsequent wait for the write result. + RecordWriteQueueWait(ctx context.Context, d time.Duration) + // RecordSocketWrite records the duration of a single conn.WriteMessage + // call in the write pump, including failed writes. + RecordSocketWrite(ctx context.Context, d time.Duration) + // RecordReadDispatchWait records the time a successfully read message spent + // waiting to be delivered to the read channel consumer. ReadMessage itself + // is excluded because it blocks for normal idle time. + RecordReadDispatchWait(ctx context.Context, d time.Duration) + // AddPendingWriters adjusts the count of goroutines blocked in Write's + // first select. Every increment must be paired with a decrement on exit, + // including cancellation and shutdown paths. + AddPendingWriters(ctx context.Context, delta int64) +} + +type noopWSConnectionObserver struct{} + +func (noopWSConnectionObserver) RecordWriteQueueWait(context.Context, time.Duration) {} +func (noopWSConnectionObserver) RecordSocketWrite(context.Context, time.Duration) {} +func (noopWSConnectionObserver) RecordReadDispatchWait(context.Context, time.Duration) {} +func (noopWSConnectionObserver) AddPendingWriters(context.Context, int64) {} + +type WSConnectionMetrics struct { + writeQueueWait metric.Int64Histogram + socketWrite metric.Int64Histogram + readDispatchWait metric.Int64Histogram + pendingWriters metric.Int64UpDownCounter +} + +func NewWSConnectionMetrics(meter metric.Meter) (*WSConnectionMetrics, error) { + writeQueueWait, err := meter.Int64Histogram( + "platform_gateway_ws_write_queue_wait_ms", + metric.WithUnit("ms"), + metric.WithDescription("Time a websocket write spent waiting for the write pump to accept it (the first select in Write), in milliseconds. Excludes the subsequent wait for the write result"), + ) + if err != nil { + return nil, fmt.Errorf("failed to create platform_gateway_ws_write_queue_wait_ms histogram: %w", err) + } + + socketWrite, err := meter.Int64Histogram( + "platform_gateway_ws_socket_write_ms", + metric.WithUnit("ms"), + metric.WithDescription("Duration of a blocking websocket conn.WriteMessage call in the write pump, in milliseconds, including errors. Only completed writes produce samples; a write that never returns leaves no observation"), + ) + if err != nil { + return nil, fmt.Errorf("failed to create platform_gateway_ws_socket_write_ms histogram: %w", err) + } + + readDispatchWait, err := meter.Int64Histogram( + "platform_gateway_ws_read_dispatch_wait_ms", + metric.WithUnit("ms"), + metric.WithDescription("Time a successfully read websocket message spent waiting to be handed to the read channel consumer, in milliseconds. ReadMessage blocking time is excluded because it includes normal idle time"), + ) + if err != nil { + return nil, fmt.Errorf("failed to create platform_gateway_ws_read_dispatch_wait_ms histogram: %w", err) + } + + pendingWriters, err := meter.Int64UpDownCounter( + "platform_gateway_ws_pending_writers", + metric.WithDescription("Number of goroutines currently blocked waiting to enqueue a websocket write. The write channel is unbuffered, so this cannot be derived from its length"), + ) + if err != nil { + return nil, fmt.Errorf("failed to create platform_gateway_ws_pending_writers up-down counter: %w", err) + } + + return &WSConnectionMetrics{ + writeQueueWait: writeQueueWait, + socketWrite: socketWrite, + readDispatchWait: readDispatchWait, + pendingWriters: pendingWriters, + }, nil +} + +func (m *WSConnectionMetrics) Observer(attrs ...attribute.KeyValue) WSConnectionObserver { + if m == nil { + return noopWSConnectionObserver{} + } + return &wsConnectionObserver{metrics: m, attrs: metric.WithAttributes(attrs...)} +} + +type wsConnectionObserver struct { + metrics *WSConnectionMetrics + attrs metric.MeasurementOption +} + +func (o *wsConnectionObserver) RecordWriteQueueWait(ctx context.Context, d time.Duration) { + o.metrics.writeQueueWait.Record(ctx, d.Milliseconds(), o.attrs) +} + +func (o *wsConnectionObserver) RecordSocketWrite(ctx context.Context, d time.Duration) { + o.metrics.socketWrite.Record(ctx, d.Milliseconds(), o.attrs) +} + +func (o *wsConnectionObserver) RecordReadDispatchWait(ctx context.Context, d time.Duration) { + o.metrics.readDispatchWait.Record(ctx, d.Milliseconds(), o.attrs) +} + +func (o *wsConnectionObserver) AddPendingWriters(ctx context.Context, delta int64) { + o.metrics.pendingWriters.Add(ctx, delta, o.attrs) +} + +// WSConnectionMetricViews returns histogram bucket definitions for the +// websocket connection wrapper metrics. Due to the OTEL specification, all +// histogram buckets must be defined when the beholder client is created. +func WSConnectionMetricViews() []sdkmetric.View { + histogramView := func(name string) sdkmetric.View { + return sdkmetric.NewView( + sdkmetric.Instrument{Name: name}, + sdkmetric.Stream{Aggregation: sdkmetric.AggregationExplicitBucketHistogram{ + // 1ms up to ~32s: queue waits and socket writes are normally + // sub-second, but degraded peers can block for many seconds. + Boundaries: prometheus.ExponentialBuckets(1, 2, 16), + }}, + ) + } + return []sdkmetric.View{ + histogramView("platform_gateway_ws_write_queue_wait_ms"), + histogramView("platform_gateway_ws_socket_write_ms"), + histogramView("platform_gateway_ws_read_dispatch_wait_ms"), + } +} diff --git a/core/services/gateway/network/wsconnection_test.go b/core/services/gateway/network/wsconnection_test.go index b815f507172..f8a594d23ab 100644 --- a/core/services/gateway/network/wsconnection_test.go +++ b/core/services/gateway/network/wsconnection_test.go @@ -1,14 +1,13 @@ package network_test import ( - "net/http" - "net/http/httptest" - "strings" + "context" + "errors" + "sync" "testing" "time" "github.com/gorilla/websocket" - "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/smartcontractkit/chainlink-common/pkg/logger" @@ -16,48 +15,77 @@ import ( "github.com/smartcontractkit/chainlink/v2/core/services/gateway/network" ) -var upgrader = websocket.Upgrader{} +var errConnClosed = errors.New("connection closed") -func newWebSocketPair(t *testing.T) (*websocket.Conn, *websocket.Conn) { - t.Helper() +type mockConnection struct { + readChan chan msg + writeChan chan msg + closed chan struct{} + closeOnce *sync.Once + readErr error + writeErr error + // when non-nil, WriteMessage blocks until it is closed + writeGate chan struct{} +} + +type msg struct { + messageType int + p []byte +} - type upgradeResult struct { - conn *websocket.Conn - err error +func (m *mockConnection) ReadMessage() (messageType int, p []byte, err error) { + select { + case <-m.closed: + return 0, nil, errConnClosed + case message := <-m.readChan: + return message.messageType, message.p, m.readErr } - serverConnCh := make(chan upgradeResult, 1) - server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - conn, err := upgrader.Upgrade(w, r, nil) - serverConnCh <- upgradeResult{conn: conn, err: err} - })) - t.Cleanup(server.Close) - - clientConn, resp, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(server.URL, "http"), nil) - if resp != nil { - defer resp.Body.Close() +} + +func (m *mockConnection) WriteMessage(messageType int, data []byte) error { + if m.writeGate != nil { + select { + case <-m.closed: + return errConnClosed + case <-m.writeGate: + } + } + + if m.writeErr != nil { + return m.writeErr + } + + // Checked first because a select would pick randomly between a closed + // conn and a writeChan with buffer space. + select { + case <-m.closed: + return errConnClosed + default: + } + + message := msg{messageType: messageType, p: data} + select { + case <-m.closed: + return errConnClosed + case m.writeChan <- message: + return nil } - require.NoError(t, err) - result := <-serverConnCh - require.NoError(t, result.err) - serverConn := result.conn - t.Cleanup(func() { - _ = clientConn.Close() - _ = serverConn.Close() - }) - return serverConn, clientConn } -type serverSideLogic struct { - connWrapper network.WSConnectionWrapper +func (m *mockConnection) Close() error { + m.closeOnce.Do(func() { close(m.closed) }) + return nil } -func (ssl *serverSideLogic) wsHandler(w http.ResponseWriter, r *http.Request) { - c, err := upgrader.Upgrade(w, r, nil) - if err != nil { - return - } - // one wsConnWrapper per client - ssl.connWrapper.Reset(c) +// newWebSocketPair returns two connected ends that share a close signal, so +// closing either end unblocks reads on both, like a real socket. +func newWebSocketPair(t *testing.T) (*mockConnection, *mockConnection) { + t.Helper() + chAtoB, chBtoA := make(chan msg, 10), make(chan msg, 10) + closed, closeOnce := make(chan struct{}), &sync.Once{} + + return &mockConnection{closed: closed, closeOnce: closeOnce, readChan: chBtoA, writeChan: chAtoB}, + &mockConnection{closed: closed, closeOnce: closeOnce, readChan: chAtoB, writeChan: chBtoA} } // TestWSConnectionWrapper_WriteError_TriggersClose verifies that a write error @@ -67,28 +95,14 @@ func TestWSConnectionWrapper_WriteError_TriggersClose(t *testing.T) { t.Parallel() lggr := logger.Test(t) - // server — accepts one connection - serverConn := network.NewWSConnectionWrapper(lggr) - servicetest.Run(t, serverConn) - ssl := &serverSideLogic{connWrapper: serverConn} - s := httptest.NewServer(http.HandlerFunc(ssl.wsHandler)) - serverURL := "ws" + strings.TrimPrefix(s.URL, "http") - defer s.Close() + _, clientConn := newWebSocketPair(t) // client clientConnWrapper := network.NewWSConnectionWrapper(lggr) servicetest.Run(t, clientConnWrapper) + closeCh := clientConnWrapper.Reset(clientConn) - conn, resp, err := websocket.DefaultDialer.Dial(serverURL, nil) - require.NoError(t, err) - defer resp.Body.Close() - - closeCh := clientConnWrapper.Reset(conn) - - // Set the write deadline to the past to simulate a write i/o timeout without - // affecting the read side — this mimics a half-open / zombie TCP connection - // where writes time out but the kernel hasn't detected a read error yet. - require.NoError(t, conn.SetWriteDeadline(time.Now().Add(-time.Second))) + clientConn.writeErr = errors.New("write error") // The write must fail (write deadline already expired). writeErr := clientConnWrapper.Write(t.Context(), websocket.BinaryMessage, []byte("data")) @@ -153,42 +167,209 @@ func TestWSConnectionWrapper_OldReadPumpCannotClearReplacement(t *testing.T) { func TestWSConnectionWrapper_ClientReconnect(t *testing.T) { t.Parallel() - lggr := logger.Test(t) - // server - wsConn := network.NewWSConnectionWrapper(lggr) - servicetest.Run(t, wsConn) - ssl := &serverSideLogic{connWrapper: wsConn} - s := httptest.NewServer(http.HandlerFunc(ssl.wsHandler)) - serverURL := "ws" + strings.TrimPrefix(s.URL, "http") - defer s.Close() - // client - clientConnWrapper := network.NewWSConnectionWrapper(lggr) + clientConnWrapper := network.NewWSConnectionWrapper(logger.Test(t)) servicetest.Run(t, clientConnWrapper) // connect, write a message, disconnect - conn, resp, err := websocket.DefaultDialer.Dial(serverURL, nil) + serverConn, clientConn := newWebSocketPair(t) + clientConnWrapper.Reset(clientConn) + require.NoError(t, clientConnWrapper.Write(t.Context(), websocket.TextMessage, []byte("hello"))) + _, got, err := serverConn.ReadMessage() require.NoError(t, err) - defer resp.Body.Close() - func() { - defer func() { assert.NoError(t, conn.Close()) }() - clientConnWrapper.Reset(conn) - writeErr := clientConnWrapper.Write(t.Context(), websocket.TextMessage, []byte("hello")) - require.NoError(t, writeErr) - <-ssl.connWrapper.ReadChannel() // consumed by server - }() + require.Equal(t, []byte("hello"), got) + require.NoError(t, clientConn.Close()) // try to write without a connection writeErr := clientConnWrapper.Write(t.Context(), websocket.TextMessage, []byte("failed send")) require.Error(t, writeErr) - // re-connect, write another message, disconnect - conn, resp, err = websocket.DefaultDialer.Dial(serverURL, nil) + // re-connect, write another message + serverConn, clientConn = newWebSocketPair(t) + clientConnWrapper.Reset(clientConn) + require.NoError(t, clientConnWrapper.Write(t.Context(), websocket.TextMessage, []byte("hello again"))) + _, got, err = serverConn.ReadMessage() require.NoError(t, err) - defer resp.Body.Close() - t.Cleanup(func() { assert.NoError(t, conn.Close()) }) - clientConnWrapper.Reset(conn) - writeErr = clientConnWrapper.Write(t.Context(), websocket.TextMessage, []byte("hello again")) - require.NoError(t, writeErr) - <-ssl.connWrapper.ReadChannel() // consumed by server + require.Equal(t, []byte("hello again"), got) +} + +// recordingObserver is a WSConnectionObserver that captures every observation +// for assertions. +type recordingObserver struct { + mu sync.Mutex + queueWaits []time.Duration + socketWrites []time.Duration + dispatchWaits []time.Duration + pending int64 +} + +func (o *recordingObserver) RecordWriteQueueWait(_ context.Context, d time.Duration) { + o.mu.Lock() + defer o.mu.Unlock() + o.queueWaits = append(o.queueWaits, d) +} + +func (o *recordingObserver) RecordSocketWrite(_ context.Context, d time.Duration) { + o.mu.Lock() + defer o.mu.Unlock() + o.socketWrites = append(o.socketWrites, d) +} + +func (o *recordingObserver) RecordReadDispatchWait(_ context.Context, d time.Duration) { + o.mu.Lock() + defer o.mu.Unlock() + o.dispatchWaits = append(o.dispatchWaits, d) +} + +func (o *recordingObserver) AddPendingWriters(_ context.Context, delta int64) { + o.mu.Lock() + defer o.mu.Unlock() + o.pending += delta +} + +func (o *recordingObserver) queueWaitSamples() []time.Duration { + o.mu.Lock() + defer o.mu.Unlock() + return append([]time.Duration(nil), o.queueWaits...) +} + +func (o *recordingObserver) socketWriteSamples() []time.Duration { + o.mu.Lock() + defer o.mu.Unlock() + return append([]time.Duration(nil), o.socketWrites...) +} + +func (o *recordingObserver) dispatchWaitSamples() []time.Duration { + o.mu.Lock() + defer o.mu.Unlock() + return append([]time.Duration(nil), o.dispatchWaits...) +} + +func (o *recordingObserver) pendingWriters() int64 { + o.mu.Lock() + defer o.mu.Unlock() + return o.pending +} + +// newGatedWebSocketPair is newWebSocketPair with the server end's writes +// blocked until the returned unblock func is called. +func newGatedWebSocketPair(t *testing.T) (serverConn *mockConnection, unblock func()) { + t.Helper() + serverConn, _ = newWebSocketPair(t) + gate := make(chan struct{}) + serverConn.writeGate = gate + unblock = sync.OnceFunc(func() { close(gate) }) + t.Cleanup(unblock) + return serverConn, unblock +} + +// TestWSConnectionWrapper_Metrics_WriteQueueWaitAndSocketWrite blocks the write +// pump inside the socket write and verifies that a queued writer's queue wait +// grows by the blocked time, that the blocked socket write records its full +// duration once it returns, and that each operation records exactly once. +func TestWSConnectionWrapper_Metrics_WriteQueueWaitAndSocketWrite(t *testing.T) { + t.Parallel() + + obs := &recordingObserver{} + connWrapper := network.NewWSConnectionWrapperWithObserver(logger.Test(t), obs) + servicetest.Run(t, connWrapper) + + serverConn, unblock := newGatedWebSocketPair(t) + connWrapper.Reset(serverConn) + + // The pump accepts the first write, then blocks in WriteMessage. + firstErr := make(chan error, 1) + go func() { firstErr <- connWrapper.Write(t.Context(), websocket.BinaryMessage, []byte("first")) }() + require.Eventually(t, func() bool { return len(obs.queueWaitSamples()) == 1 }, + 5*time.Second, time.Millisecond, "write pump should accept the first write and block in the socket write") + + // The second write cannot be accepted while the pump is blocked, so it + // waits in Write's first select and is counted as a pending writer. + secondErr := make(chan error, 1) + go func() { secondErr <- connWrapper.Write(t.Context(), websocket.BinaryMessage, []byte("second")) }() + require.Eventually(t, func() bool { return obs.pendingWriters() == 1 }, + 5*time.Second, time.Millisecond, "queued writer should be counted as pending") + + const blockFor = 250 * time.Millisecond + time.Sleep(blockFor) + unblock() + + require.NoError(t, <-firstErr) + require.NoError(t, <-secondErr) + + // One queue-wait sample per write; the blocked writer's wait includes the delay. + queueWaits := obs.queueWaitSamples() + require.Len(t, queueWaits, 2, "each completed write must record its queue wait exactly once") + require.Less(t, queueWaits[0], queueWaits[1]) + require.GreaterOrEqual(t, queueWaits[1], 200*time.Millisecond, "blocked writer's queue wait must include the pump blockage") + + // One socket-write sample per message; the blocked write includes the delay. + socketWrites := obs.socketWriteSamples() + require.Len(t, socketWrites, 2, "each WriteMessage must record its duration exactly once") + require.GreaterOrEqual(t, socketWrites[0], 200*time.Millisecond, "blocked socket write must record its full duration") + + require.Zero(t, obs.pendingWriters(), "pending writers must return to zero") +} + +// TestWSConnectionWrapper_Metrics_PendingWritersCanceled verifies that a writer +// leaving the first select via context cancellation decrements the pending +// writer count, records no queue-wait sample, and still returns the context error. +func TestWSConnectionWrapper_Metrics_PendingWritersCanceled(t *testing.T) { + t.Parallel() + + obs := &recordingObserver{} + connWrapper := network.NewWSConnectionWrapperWithObserver(logger.Test(t), obs) + servicetest.Run(t, connWrapper) + + serverConn, unblock := newGatedWebSocketPair(t) + connWrapper.Reset(serverConn) + + firstErr := make(chan error, 1) + go func() { firstErr <- connWrapper.Write(t.Context(), websocket.BinaryMessage, []byte("first")) }() + require.Eventually(t, func() bool { return len(obs.queueWaitSamples()) == 1 }, + 5*time.Second, time.Millisecond, "write pump should accept the first write and block in the socket write") + + ctx, cancel := context.WithCancel(t.Context()) + writeErr := make(chan error, 1) + go func() { writeErr <- connWrapper.Write(ctx, websocket.BinaryMessage, []byte("canceled")) }() + require.Eventually(t, func() bool { return obs.pendingWriters() == 1 }, + 5*time.Second, time.Millisecond, "queued writer should be counted as pending") + + cancel() + require.ErrorIs(t, <-writeErr, context.Canceled) + require.Eventually(t, func() bool { return obs.pendingWriters() == 0 }, + 5*time.Second, time.Millisecond, "cancellation must decrement the pending writer count") + require.Len(t, obs.queueWaitSamples(), 1, "a canceled writer must not record a queue-wait sample") + + unblock() + require.NoError(t, <-firstErr) +} + +// TestWSConnectionWrapper_Metrics_ReadDispatchWait verifies that a message that +// was read successfully but not consumed promptly records a dispatch wait equal +// to the consumer blockage, exactly once. +func TestWSConnectionWrapper_Metrics_ReadDispatchWait(t *testing.T) { + t.Parallel() + + obs := &recordingObserver{} + connWrapper := network.NewWSConnectionWrapperWithObserver(logger.Test(t), obs) + servicetest.Run(t, connWrapper) + + serverConn, clientConn := newWebSocketPair(t) + connWrapper.Reset(serverConn) + + require.NoError(t, clientConn.WriteMessage(websocket.TextMessage, []byte("hello"))) + + // Do not consume from ReadChannel for a controlled delay: the read pump is + // blocked handing the item to readCh. + const holdFor = 250 * time.Millisecond + time.Sleep(holdFor) + item := <-connWrapper.ReadChannel() + require.Equal(t, websocket.TextMessage, item.MsgType) + require.Equal(t, []byte("hello"), item.Data) + + require.Eventually(t, func() bool { + waits := obs.dispatchWaitSamples() + return len(waits) == 1 && waits[0] >= 200*time.Millisecond + }, 5*time.Second, time.Millisecond, "blocked read consumer must produce one dispatch-wait sample covering the delay") } diff --git a/core/services/gateway/network/wsserver_test.go b/core/services/gateway/network/wsserver_test.go index b4013a873e2..9d175d2f38d 100644 --- a/core/services/gateway/network/wsserver_test.go +++ b/core/services/gateway/network/wsserver_test.go @@ -32,17 +32,15 @@ func startNewWSServer(t *testing.T, readTimeoutMillis uint32) (server network.We func startNewWSServerWithPath(t *testing.T, readTimeoutMillis uint32, path string) (server network.WebSocketServer, acceptor *mocks.ConnectionAcceptor, url string) { config := &network.WebSocketServerConfig{ - HTTPServerConfig: network.HTTPServerConfig{ - Host: WSTestHost, - Port: 0, - Path: path, - TLSEnabled: false, - ContentTypeHeader: "application/jsonrpc", - ReadTimeoutMillis: readTimeoutMillis, - WriteTimeoutMillis: 10_000, - RequestTimeoutMillis: 10_000, - MaxRequestBytes: 10_000, - }, + Host: WSTestHost, + Port: 0, + Path: path, + TLSEnabled: false, + ContentTypeHeader: "application/jsonrpc", + ReadTimeoutMillis: readTimeoutMillis, + WriteTimeoutMillis: 10_000, + RequestTimeoutMillis: 10_000, + MaxRequestBytes: 10_000, HandshakeTimeoutMillis: 10_000, } @@ -103,7 +101,7 @@ func TestWSServer_RejectsHealthCheckRequestPath(t *testing.T) { t.Parallel() lggr := logger.Test(t) - config := &network.WebSocketServerConfig{HTTPServerConfig: network.HTTPServerConfig{Path: network.HealthCheckPath}} + config := &network.WebSocketServerConfig{Path: network.HealthCheckPath} _, err := network.NewWebSocketServer(config, mocks.NewConnectionAcceptor(t), lggr, limits.Factory{Logger: lggr}) require.EqualError(t, err, `WebSocket request path "/health" conflicts with health check path`) } diff --git a/core/services/gateway/pingtracker.go b/core/services/gateway/pingtracker.go new file mode 100644 index 00000000000..8144eab1209 --- /dev/null +++ b/core/services/gateway/pingtracker.go @@ -0,0 +1,42 @@ +package gateway + +import ( + "sync" + "time" +) + +const pingTokenLen = 8 + +// token aware ping tracker for o11y +type pingProbeTracker struct { + mu sync.Mutex + token string + start time.Time + pending bool +} + +// register stores the token and start time of the probe about to be written. +// It must be called before the ping is written, because the matching pong can +// arrive before Write returns. Registering a new probe supersedes any previous +// unclaimed one. +func (t *pingProbeTracker) register(token string, start time.Time) { + t.mu.Lock() + defer t.mu.Unlock() + t.token = token + t.start = start + t.pending = true +} + +// consume returns the probe start time iff token matches the latest registered +// probe, clearing it so a duplicate pong cannot record a second observation. +// Superseded or unknown tokens yield no observation. +func (t *pingProbeTracker) consume(token string) (time.Time, bool) { + t.mu.Lock() + defer t.mu.Unlock() + if !t.pending || t.token != token { + return time.Time{}, false + } + t.pending = false + t.token = "" + return t.start, true +} diff --git a/core/services/ocr2/plugins/vault/metrics.go b/core/services/ocr2/plugins/vault/metrics.go index e23a4e18fbf..10ad07080c7 100644 --- a/core/services/ocr2/plugins/vault/metrics.go +++ b/core/services/ocr2/plugins/vault/metrics.go @@ -22,6 +22,7 @@ type pluginMetrics struct { observationPrefixCoverageSpread metric.Int64Histogram pendingQueueStallSignals metric.Int64Counter pendingQueuePurges metric.Int64Counter + pendingQueueItemOversized metric.Int64Counter } func newPluginMetrics(configDigest string) (*pluginMetrics, error) { @@ -101,6 +102,15 @@ func newPluginMetrics(configDigest string) (*pluginMetrics, error) { return nil, fmt.Errorf("failed to create pending queue purge counter: %w", err) } + pendingQueueItemOversized, err := beholder.GetMeter().Int64Counter( + "platform_vault_plugin_pending_queue_item_oversized", + metric.WithUnit("{request}"), + metric.WithDescription("Count of local-queue requests skipped in Observation because their marshaled blob payload exceeds VaultMaxBlobPayloadSizeLimit. Nonzero means a request was admitted that can never enter the pending queue and will expire unanswered."), + ) + if err != nil { + return nil, fmt.Errorf("failed to create pending queue item oversized counter: %w", err) + } + return &pluginMetrics{ configDigest: configDigest, queueOverflow: queueOverflow, @@ -112,6 +122,7 @@ func newPluginMetrics(configDigest string) (*pluginMetrics, error) { observationPrefixCoverageSpread: observationPrefixCoverageSpread, pendingQueueStallSignals: pendingQueueStallSignals, pendingQueuePurges: pendingQueuePurges, + pendingQueueItemOversized: pendingQueueItemOversized, }, nil } @@ -200,3 +211,14 @@ func (m *pluginMetrics) trackPendingQueuePurge(ctx context.Context) { attribute.String("configDigest", m.configDigest), )) } + +func (m *pluginMetrics) trackPendingQueueItemOversized(ctx context.Context, payloadBytes int, maxBlobBytes int) { + if m == nil { + return + } + m.pendingQueueItemOversized.Add(ctx, 1, metric.WithAttributes( + attribute.String("configDigest", m.configDigest), + attribute.Int("payloadBytes", payloadBytes), + attribute.Int("maxBlobBytes", maxBlobBytes), + )) +} diff --git a/core/services/ocr2/plugins/vault/plugin.go b/core/services/ocr2/plugins/vault/plugin.go index 3d8e7eb8406..94b8073afaf 100644 --- a/core/services/ocr2/plugins/vault/plugin.go +++ b/core/services/ocr2/plugins/vault/plugin.go @@ -556,7 +556,15 @@ func (r *ReportingPlugin) prepareObservationPendingQueueBlobs( if len(payload) > maxBlobBytes { if len(currentBatch) == 0 { - return pendingQueueBlobPack{}, fmt.Errorf("single pending queue item exceeds max blob payload size (%d > %d)", len(payload), maxBlobBytes) + // The item can never be advertised so skip it + r.lggr.Warnw("single pending queue item exceeds max blob payload size; skipping", + "seqNr", seqNr, + "requestID", queueItem.ID(), + "payloadBytes", len(payload), + "maxBlobBytes", maxBlobBytes, + ) + r.metrics.trackPendingQueueItemOversized(ctx, len(payload), maxBlobBytes) + continue } // Current batch is full; flush it and retry the same item on the next iteration. var ferr error diff --git a/core/services/ocr2/plugins/vault/plugin_test.go b/core/services/ocr2/plugins/vault/plugin_test.go index 0a768bfe040..184141e5090 100644 --- a/core/services/ocr2/plugins/vault/plugin_test.go +++ b/core/services/ocr2/plugins/vault/plugin_test.go @@ -736,7 +736,8 @@ func TestPrepareObservationPendingQueueBlobs_truncatesWhenHandleCountExceeded(t require.Equal(t, maxBlobHandleCount, pack.packedItemCount) } -func TestPrepareObservationPendingQueueBlobs_errorWhenSingleItemTooLarge(t *testing.T) { +func TestPrepareObservationPendingQueueBlobs_shedsSingleItemTooLarge(t *testing.T) { + t.Parallel() store := requests.NewStore[*vaulttypes.Request]() r := newTestReportingPlugin(t, withStore(store)) @@ -752,9 +753,12 @@ func TestPrepareObservationPendingQueueBlobs_errorWhenSingleItemTooLarge(t *test localQueueItems, err := store.All() require.NoError(t, err) - _, err = r.prepareObservationPendingQueueBlobs(t.Context(), 1, localQueueItems, map[string]bool{}, 1, 10) - require.Error(t, err) - require.Contains(t, err.Error(), "single pending queue item exceeds max blob payload size") + // A single item over the blob cap is shed (log + metric), not an error: failing the + // whole Observation would wedge request processing on every node holding the item. + out, err := r.prepareObservationPendingQueueBlobs(t.Context(), 1, localQueueItems, map[string]bool{}, 1, 10) + require.NoError(t, err) + require.Empty(t, out.blobPayloads) + require.Zero(t, out.packedItemCount) } type blockingBlobBroadcastFetcher struct { @@ -8575,7 +8579,8 @@ func TestPlugin_broadcastBlobPayloads(t *testing.T) { }) } -func TestProperty_broadcastBlobPayloads_MaxSizePayloadsWithinBlobLimit(t *testing.T) { +func TestProperty_broadcastBlobPayloads_MaxSizeRequestBlobCapBoundaries(t *testing.T) { + t.Parallel() maxRequestBatchSize := cresettings.Default.VaultRequestBatchSizeLimit.DefaultValue maxCiphertextBytes := cresettings.Default.PerOwner.VaultCiphertextSizeLimit.DefaultValue maxIDKeySize := cresettings.Default.VaultIdentifierKeySizeLimit.DefaultValue @@ -8591,7 +8596,10 @@ func TestProperty_broadcastBlobPayloads_MaxSizePayloadsWithinBlobLimit(t *testin maxIDKeyField := strings.Repeat("a", int(maxIDKeySize)) maxIDOwnerField := strings.Repeat("a", int(maxIDOwnerSize)) maxIDNamespaceField := strings.Repeat("a", int(maxIDNamespaceSize)) - maxCiphertext := strings.Repeat("a", int(maxCiphertextBytes)) + // EncryptedValue is hex-encoded on the wire (2 chars per decoded byte) while ingress + // validates the DECODED size, so a ciphertext at VaultCiphertextSizeLimit occupies + // 2x that many wire bytes inside the marshaled pending-queue item. + maxCiphertext := strings.Repeat("a", 2*int(maxCiphertextBytes)) maxIdentifier := func() *vaultcommon.SecretIdentifier { return &vaultcommon.SecretIdentifier{ @@ -8636,8 +8644,9 @@ func TestProperty_broadcastBlobPayloads_MaxSizePayloadsWithinBlobLimit(t *testin } requestTypes := []struct { - name string - payload proto.Message + name string + payload proto.Message + exceedsBlobLimit bool }{ { name: "GetSecretsRequest", @@ -8646,11 +8655,17 @@ func TestProperty_broadcastBlobPayloads_MaxSizePayloadsWithinBlobLimit(t *testin }, }, { + // Max create/update shapes exceed the blob cap: EncryptedValue is hex-encoded + // on the wire, so a full batch of cap-size ciphertexts overflows + // VaultMaxBlobPayloadSizeLimit. These shapes are rejected at ingress + // (capability handleRequest blob-size check) and shed by the reporting plugin + // (prepareObservationPendingQueueBlobs) instead of failing the Observation. name: "CreateSecretsRequest", payload: &vaultcommon.CreateSecretsRequest{ RequestId: "req", EncryptedSecrets: buildMaxEncryptedSecrets(), }, + exceedsBlobLimit: true, }, { name: "UpdateSecretsRequest", @@ -8658,6 +8673,7 @@ func TestProperty_broadcastBlobPayloads_MaxSizePayloadsWithinBlobLimit(t *testin RequestId: "req", EncryptedSecrets: buildMaxEncryptedSecrets(), }, + exceedsBlobLimit: true, }, { name: "DeleteSecretsRequest", @@ -8687,9 +8703,156 @@ func TestProperty_broadcastBlobPayloads_MaxSizePayloadsWithinBlobLimit(t *testin } itemBytes := protoMarshal(t, item) + if rt.exceedsBlobLimit { + assert.Greaterf(t, len(itemBytes), maxBlobPayloadBytes, + "marshaled %s StoredPendingQueueItem (%d bytes) no longer exceeds VaultMaxBlobPayloadSizeLimit (%d bytes); update the wire-size expectations", + rt.name, len(itemBytes), maxBlobPayloadBytes) + return + } assert.LessOrEqualf(t, len(itemBytes), maxBlobPayloadBytes, "marshaled %s StoredPendingQueueItem (%d bytes) exceeds VaultMaxBlobPayloadSizeLimit (%d bytes)", rt.name, len(itemBytes), maxBlobPayloadBytes) }) } } + +// calibratedCiphertextHex returns the hex-encoded TDH2 ciphertext of a plaintext sized so +// the decoded ciphertext sits at the ingress cap (VaultCiphertextSizeLimit, 2KB decoded). +// Ingress checks the decoded size; the wire format is the hex string (2x decoded). +func calibratedCiphertextHex(t *testing.T, pk *tdh2easy.PublicKey, owner common.Address) string { + t.Helper() + limit := int(cresettings.Default.PerOwner.VaultCiphertextSizeLimit.DefaultValue) + + // Measure fixed TDH2+proto overhead with a probe, then shrink the plaintext so the + // marshaled ciphertext lands at or under the limit. + probe, err := vaultutils.EncryptSecretWithWorkflowOwner(strings.Repeat("x", limit), pk, owner) + require.NoError(t, err) + probeRaw, err := hex.DecodeString(probe) + require.NoError(t, err) + plaintextLen := limit - (len(probeRaw) - limit) + require.Positive(t, plaintextLen) + + for { + out, err := vaultutils.EncryptSecretWithWorkflowOwner(strings.Repeat("s", plaintextLen), pk, owner) + require.NoError(t, err) + raw, err := hex.DecodeString(out) + require.NoError(t, err) + if len(raw) <= limit { + return out + } + plaintextLen -= len(raw) - limit + require.Positive(t, plaintextLen, "could not size plaintext under ciphertext limit") + } +} + +func buildBatchedCreateRequest(requestID string, n int, cipherHex string, owner common.Address) *vaultcommon.CreateSecretsRequest { + secrets := make([]*vaultcommon.EncryptedSecret, n) + for i := range secrets { + secrets[i] = &vaultcommon.EncryptedSecret{ + Id: &vaultcommon.SecretIdentifier{ + Owner: owner.Hex(), + Namespace: "main", + Key: fmt.Sprintf("secret_%d", i), + }, + EncryptedValue: cipherHex, + } + } + return &vaultcommon.CreateSecretsRequest{RequestId: requestID, EncryptedSecrets: secrets} +} + +// pendingQueueBlobPayloadLen returns the size of the blob payload the plugin would broadcast +// for a single local-queue item, using the production marshal path. +func pendingQueueBlobPayloadLen(t *testing.T, req *vaultcommon.CreateSecretsRequest) int { + t.Helper() + anyMsg, err := anypb.New(req) + require.NoError(t, err) + payload, err := marshalPendingQueueBlobPayload([]*vaultcommon.StoredPendingQueueItem{ + {Id: req.RequestId, Item: anyMsg}, + }) + require.NoError(t, err) + return len(payload) +} + +// TestPlugin_Observation_ShedsOversizedLocalQueueItem verifies that a local-queue +// request whose marshaled blob payload exceeds VaultMaxBlobPayloadSizeLimit (25.6KB) — +// despite passing ingress limits (batch <= 10, per-secret ciphertext <= 2KB decoded) — +// is shed with a log+metric instead of failing the whole Observation. Erroring here +// would stall request processing DON-wide on every node holding the request, until the +// request expired. +func TestPlugin_Observation_ShedsOversizedLocalQueueItem(t *testing.T) { + t.Parallel() + _, pk, shares, err := tdh2easy.GenerateKeys(1, 3) + require.NoError(t, err) + owner := common.HexToAddress("0xA07D569a8EbF58c09bFae64b2Fa85b0e0Dcb1dFb") + cipherHex := calibratedCiphertextHex(t, pk, owner) + + maxBlob := int(cresettings.Default.VaultMaxBlobPayloadSizeLimit.DefaultValue) + batchLimit := cresettings.Default.VaultRequestBatchSizeLimit.DefaultValue + + // Find the minimal ingress-valid batch size whose blob payload exceeds the cap. + triggerCount := 0 + for n := 1; n <= batchLimit; n++ { + if pendingQueueBlobPayloadLen(t, buildBatchedCreateRequest("request-big", n, cipherHex, owner)) > maxBlob { + triggerCount = n + break + } + } + require.Positive(t, triggerCount, "no batch size <= %d exceeds the blob cap; test premise no longer holds", batchLimit) + t.Logf("oversized request: %d max-size secrets (%d wire bytes/cipher) exceed the %d-byte blob cap", + triggerCount, len(cipherHex), maxBlob) + + // The oversized request passes every ingress limit on this branch (the gateway-side + // blob payload size check lives on the vault_ingress_blob_cap branch), so the plugin + // shed below is the only protection: the queued representation of the batch exceeds + // VaultMaxBlobPayloadSizeLimit because EncryptedValue is hex-encoded on the wire + // (2x its decoded size). + validator, err := vaultcap.NewRequestValidatorFromLimitsFactory(limits.Factory{Settings: cresettings.DefaultGetter}) + require.NoError(t, err) + oversized := buildBatchedCreateRequest("request-big", triggerCount, cipherHex, owner) + require.NoError(t, validator.ValidateCreateSecretsRequest(t.Context(), pk, oversized, false), + "ingress rejected the request; the plugin-level shed is unreachable via the normal path") + + // The plugin independently sheds such an item if one ever reaches a local store + // (defense in depth: version skew, direct store writes). + // Inject the oversized item plus a well-formed sibling into the local queue. + store := requests.NewStore[*vaulttypes.Request]() + r := newTestReportingPlugin(t, withStore(store), withKeys(pk, shares[0])) + require.NoError(t, store.Add(&vaulttypes.Request{Payload: oversized, IDVal: "request-big"})) + sibling := buildBatchedCreateRequest("request-small", 1, cipherHex, owner) + require.NoError(t, store.Add(&vaulttypes.Request{Payload: sibling, IDVal: "request-small"})) + + rdr := &kv{m: make(map[string]response)} + data, err := r.Observation(t.Context(), 1, types.AttributedQuery{}, rdr, &blobber{}) + require.NoError(t, err, "Observation must not fail on an oversized local-queue item") + + obs := &vaultcommon.Observations{} + require.NoError(t, proto.Unmarshal(data, obs)) + require.Len(t, obs.PendingQueueItems, 1, "expected only the sibling item to be broadcast; the oversized item must be shed, not wedge the round") +} + +// TestPlugin_Observation_SubCapBatchObservesCleanly verifies the same request shape with +// fewer secrets observes cleanly, isolating the shed behavior to the blob-cap boundary +// rather than the request shape itself. +func TestPlugin_Observation_SubCapBatchObservesCleanly(t *testing.T) { + t.Parallel() + _, pk, shares, err := tdh2easy.GenerateKeys(1, 3) + require.NoError(t, err) + owner := common.HexToAddress("0xA07D569a8EbF58c09bFae64b2Fa85b0e0Dcb1dFb") + cipherHex := calibratedCiphertextHex(t, pk, owner) + + maxBlob := int(cresettings.Default.VaultMaxBlobPayloadSizeLimit.DefaultValue) + req := buildBatchedCreateRequest("request-1", 4, cipherHex, owner) + require.LessOrEqual(t, pendingQueueBlobPayloadLen(t, req), maxBlob) + + store := requests.NewStore[*vaulttypes.Request]() + r := newTestReportingPlugin(t, withStore(store), withKeys(pk, shares[0])) + require.NoError(t, store.Add(&vaulttypes.Request{Payload: req, IDVal: req.RequestId})) + + rdr := &kv{m: make(map[string]response)} + data, err := r.Observation(t.Context(), 1, types.AttributedQuery{}, rdr, &blobber{}) + require.NoError(t, err) + + obs := &vaultcommon.Observations{} + require.NoError(t, proto.Unmarshal(data, obs)) + require.Len(t, obs.PendingQueueItems, 1, "expected one broadcast blob for the local item") +} diff --git a/deployment/ccip/changeset/ccip-attestation/cs_configure_evm_signer_registry_test.go b/deployment/ccip/changeset/ccip-attestation/cs_configure_evm_signer_registry_test.go index c90b15fd136..62b7c453ab1 100644 --- a/deployment/ccip/changeset/ccip-attestation/cs_configure_evm_signer_registry_test.go +++ b/deployment/ccip/changeset/ccip-attestation/cs_configure_evm_signer_registry_test.go @@ -11,6 +11,7 @@ import ( "github.com/smartcontractkit/chainlink-evm/pkg/utils" cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/runtime" @@ -27,10 +28,13 @@ const ( ) // Helper to deploy signer registry directly for testing -func deployTestSignerRegistry(t *testing.T, env cldf.Environment, selector uint64, initialSigners []signer_registry.ISignerRegistrySigner) common.Address { +func deployTestSignerRegistry(t *testing.T, env cldf.Environment, selector uint64, initialSigners []signer_registry.ISignerRegistrySigner) (common.Address, datastore.MutableDataStore) { chain := env.BlockChains.EVMChains()[selector] + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(env.DataStore)) - signerRegistry, err := cldf.DeployContract(env.Logger, chain, env.ExistingAddresses, + signerRegistry, err := shared.DeployContractAndRecord(env.Logger, chain, env.ExistingAddresses, ds, + cldf.NewTypeAndVersion(shared.EVMSignerRegistry, deployment.Version1_0_0), "", func(chain cldf_evm.Chain) cldf.ContractDeploy[*signer_registry.SignerRegistry] { address, tx, signerRegistry, err := signer_registry.DeploySignerRegistry( chain.DeployerKey, @@ -48,7 +52,7 @@ func deployTestSignerRegistry(t *testing.T, env cldf.Environment, selector uint6 }, ) require.NoError(t, err) - return signerRegistry.Address + return signerRegistry.Address, ds } func TestEVMSignerRegistryConfiguration_Preconditions(t *testing.T) { @@ -139,9 +143,9 @@ func TestEVMSignerRegistryConfiguration_StateValidation(t *testing.T) { t.Parallel() selector := uint64(ccip_attestation.BaseMainnetSelector) - rt, err := runtime.New(t.Context(), runtime.WithEnvOpts( + e, err := environment.New(t.Context(), environment.WithEVMSimulated(t, []uint64{selector}), - )) + ) require.NoError(t, err) // Deploy registry with known signers @@ -151,7 +155,9 @@ func TestEVMSignerRegistryConfiguration_StateValidation(t *testing.T) { {EvmAddress: signer1, NewEVMAddress: utils.ZeroAddress}, {EvmAddress: signer2, NewEVMAddress: utils.ZeroAddress}, } - deployTestSignerRegistry(t, rt.Environment(), selector, initialSigners) + _, ds := deployTestSignerRegistry(t, *e, selector, initialSigners) + e.DataStore = ds.Seal() + rt := runtime.NewFromEnvironment(*e) // Test updating non-existent signer nonExistent := utils.RandomAddress() @@ -188,13 +194,13 @@ func TestEVMSignerRegistryConfiguration_DirectExecution(t *testing.T) { t.Parallel() selector := uint64(ccip_attestation.BaseMainnetSelector) - rt, err := runtime.New(t.Context(), runtime.WithEnvOpts( + e, err := environment.New(t.Context(), environment.WithEVMSimulated(t, []uint64{selector}), environment.WithLogger(logger.Test(t)), - )) + ) require.NoError(t, err) - chain := rt.Environment().BlockChains.EVMChains()[selector] + chain := e.BlockChains.EVMChains()[selector] // Deploy registry with signers signer1 := utils.RandomAddress() @@ -203,7 +209,9 @@ func TestEVMSignerRegistryConfiguration_DirectExecution(t *testing.T) { {EvmAddress: signer1, NewEVMAddress: utils.ZeroAddress}, {EvmAddress: signer2, NewEVMAddress: utils.ZeroAddress}, } - registryAddr := deployTestSignerRegistry(t, rt.Environment(), selector, initialSigners) + registryAddr, ds := deployTestSignerRegistry(t, *e, selector, initialSigners) + e.DataStore = ds.Seal() + rt := runtime.NewFromEnvironment(*e) // Configure valid updates config := ccip_attestation.SetNewSignerAddressesConfig{ diff --git a/deployment/ccip/changeset/cs_prerequisites_test.go b/deployment/ccip/changeset/cs_prerequisites_test.go index a22445e2bca..3ede172221f 100644 --- a/deployment/ccip/changeset/cs_prerequisites_test.go +++ b/deployment/ccip/changeset/cs_prerequisites_test.go @@ -9,6 +9,7 @@ import ( "github.com/smartcontractkit/chainlink-common/pkg/logger" cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" @@ -45,6 +46,10 @@ func testDeployPrerequisitesWithEnv(t *testing.T, e cldf.Environment) { require.NoError(t, err) err = e.ExistingAddresses.Merge(output.AddressBook) require.NoError(t, err) + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.DataStore)) + require.NoError(t, ds.Merge(output.DataStore.Seal())) + e.DataStore = ds.Seal() state, err := stateview.LoadOnchainState(e) require.NoError(t, err) chainState, _ := state.EVMChainState(newChain) diff --git a/deployment/ccip/changeset/solana_v0_1_0/cs_deploy_chain.go b/deployment/ccip/changeset/solana_v0_1_0/cs_deploy_chain.go index 689283e6e1f..f551128c055 100644 --- a/deployment/ccip/changeset/solana_v0_1_0/cs_deploy_chain.go +++ b/deployment/ccip/changeset/solana_v0_1_0/cs_deploy_chain.go @@ -121,7 +121,7 @@ func (cfg UpgradeConfig) Validate(e cldf.Environment, chainSelector uint64) erro return errors.New("upgrade authority must be set for fee quoter and router upgrades") } if cfg.MCMS != nil { - return cfg.MCMS.ValidateSolana(e, chainSelector) + return stateview.ValidateSolanaTimelockConfig(e, chainSelector, cfg.MCMS) } return nil } diff --git a/deployment/ccip/changeset/solana_v0_1_0/utils.go b/deployment/ccip/changeset/solana_v0_1_0/utils.go index 8ceede38ac9..2b615f43d66 100644 --- a/deployment/ccip/changeset/solana_v0_1_0/utils.go +++ b/deployment/ccip/changeset/solana_v0_1_0/utils.go @@ -20,6 +20,7 @@ import ( proposeutils "github.com/smartcontractkit/cld-changesets/legacy/mcms/proposeutils" "github.com/smartcontractkit/chainlink/deployment/ccip/shared" + "github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview" solanastateview "github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview/solana" ) @@ -32,7 +33,7 @@ func ValidateMCMSConfigSolana( tokenPoolMetadata string, contractsToValidate map[cldf.ContractType]bool) error { if mcms != nil { - if err := mcms.ValidateSolana(e, chain.Selector); err != nil { + if err := stateview.ValidateSolanaTimelockConfig(e, chain.Selector, mcms); err != nil { return fmt.Errorf("failed to validate MCMS config: %w", err) } } diff --git a/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain.go b/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain.go index f6a499279a3..740ada75fc7 100644 --- a/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain.go +++ b/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain.go @@ -123,7 +123,7 @@ func (cfg UpgradeConfig) Validate(e cldf.Environment, chainSelector uint64) erro return errors.New("upgrade authority must be set for fee quoter and router upgrades") } if cfg.MCMS != nil { - return cfg.MCMS.ValidateSolana(e, chainSelector) + return stateview.ValidateSolanaTimelockConfig(e, chainSelector, cfg.MCMS) } return nil } diff --git a/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain_test.go b/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain_test.go index 2c1660c8009..3ec0735213e 100644 --- a/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain_test.go +++ b/deployment/ccip/changeset/solana_v0_1_1/cs_deploy_chain_test.go @@ -120,7 +120,7 @@ func TestDeployChainContractsChangesetPreload(t *testing.T) { require.NoError(t, err) testhelpers.RegisterNodes(t, env, 4, homeChainSel) - err = testhelpers.SavePreloadedSolAddresses(*env, solSelector) + err = testhelpers.SavePreloadedSolAddresses(env, solSelector) require.NoError(t, err) e := *env diff --git a/deployment/ccip/changeset/solana_v0_1_1/save_existing_test.go b/deployment/ccip/changeset/solana_v0_1_1/save_existing_test.go index aee0c344170..515708487df 100644 --- a/deployment/ccip/changeset/solana_v0_1_1/save_existing_test.go +++ b/deployment/ccip/changeset/solana_v0_1_1/save_existing_test.go @@ -9,6 +9,7 @@ import ( cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" cldf_solana "github.com/smartcontractkit/chainlink-deployments-framework/chain/solana" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" @@ -52,6 +53,10 @@ func TestSaveExistingCCIP(t *testing.T) { require.NoError(t, err) err = e.ExistingAddresses.Merge(output.AddressBook) //nolint:staticcheck // AddressBook is deprecated but still in use for this changeset require.NoError(t, err) + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.DataStore)) + require.NoError(t, ds.Merge(output.DataStore.Seal())) + e.DataStore = ds.Seal() state, err := stateview.LoadOnchainState(*e) require.NoError(t, err) require.Equal(t, state.SolChains[selector].Router.String(), solAddr1) diff --git a/deployment/ccip/changeset/solana_v0_1_1/transfer_ccip_to_mcms_with_timelock_test.go b/deployment/ccip/changeset/solana_v0_1_1/transfer_ccip_to_mcms_with_timelock_test.go index 6ad1d86bf55..ab6d855cbe0 100644 --- a/deployment/ccip/changeset/solana_v0_1_1/transfer_ccip_to_mcms_with_timelock_test.go +++ b/deployment/ccip/changeset/solana_v0_1_1/transfer_ccip_to_mcms_with_timelock_test.go @@ -221,7 +221,7 @@ func prepareEnvironmentForOwnershipTransfer(t *testing.T) (cldf.Environment, sta // Fund account for fees testutils.FundAccounts(env.GetContext(), []solana.PrivateKey{*solChain.DeployerKey}, solChain.Client, t) - err = testhelpers.SavePreloadedSolAddresses(*env, solChainSel) + err = testhelpers.SavePreloadedSolAddresses(env, solChainSel) require.NoError(t, err) solLinkTokenPrivKey, _ := solana.NewRandomPrivateKey() diff --git a/deployment/ccip/changeset/solana_v0_1_1/utils.go b/deployment/ccip/changeset/solana_v0_1_1/utils.go index 7434729d271..faa731db752 100644 --- a/deployment/ccip/changeset/solana_v0_1_1/utils.go +++ b/deployment/ccip/changeset/solana_v0_1_1/utils.go @@ -21,6 +21,7 @@ import ( proposeutils "github.com/smartcontractkit/cld-changesets/legacy/mcms/proposeutils" "github.com/smartcontractkit/chainlink/deployment/ccip/shared" + "github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview" solanastateview "github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview/solana" ) @@ -45,7 +46,7 @@ func ValidateMCMSConfigSolana( tokenPoolMetadata string, contractsToValidate map[cldf.ContractType]bool) error { if mcms != nil { - if err := mcms.ValidateSolana(e, chain.Selector); err != nil { + if err := stateview.ValidateSolanaTimelockConfig(e, chain.Selector, mcms); err != nil { return fmt.Errorf("failed to validate MCMS config: %w", err) } } diff --git a/deployment/ccip/changeset/testhelpers/test_environment.go b/deployment/ccip/changeset/testhelpers/test_environment.go index 107bbf40df3..0980f295581 100644 --- a/deployment/ccip/changeset/testhelpers/test_environment.go +++ b/deployment/ccip/changeset/testhelpers/test_environment.go @@ -823,11 +823,11 @@ func NewEnvironmentWithJobsAndContracts(t *testing.T, tEnv TestEnvironment) Depl return e } -func DeployChainContractsToSolChainCSV0_1_1(e DeployedEnv, solChainSelector uint64, preload bool, buildSolConfig *ccipChangeSetSolanaV0_1_1.BuildSolanaConfig) ([]commonchangeset.ConfiguredChangeSet, error) { +func DeployChainContractsToSolChainCSV0_1_1(e *DeployedEnv, solChainSelector uint64, preload bool, buildSolConfig *ccipChangeSetSolanaV0_1_1.BuildSolanaConfig) ([]commonchangeset.ConfiguredChangeSet, error) { var mcmsCfg *cldfproposalutils.MCMSWithTimelockConfig if preload { // Pre load default programs - err := SavePreloadedSolAddresses(e.Env, solChainSelector) + err := SavePreloadedSolAddresses(&e.Env, solChainSelector) if err != nil { return nil, err } @@ -896,11 +896,11 @@ func DeployChainContractsToSolChainCSV0_1_1(e DeployedEnv, solChainSelector uint }, nil } -func DeployChainContractsToSolChainCS(e DeployedEnv, solChainSelector uint64, preload bool, buildSolConfig *ccipChangeSetSolanaV0_1_1.BuildSolanaConfig) ([]commonchangeset.ConfiguredChangeSet, error) { +func DeployChainContractsToSolChainCS(e *DeployedEnv, solChainSelector uint64, preload bool, buildSolConfig *ccipChangeSetSolanaV0_1_1.BuildSolanaConfig) ([]commonchangeset.ConfiguredChangeSet, error) { var mcmsCfg *cldfproposalutils.MCMSWithTimelockConfig if preload { // Pre load default programs - err := SavePreloadedSolAddresses(e.Env, solChainSelector) + err := SavePreloadedSolAddresses(&e.Env, solChainSelector) if err != nil { return nil, err } @@ -1034,13 +1034,13 @@ func AddCCIPContractsToEnvironment(t *testing.T, allChains []uint64, tEnv TestEn SolanaContractVersion: ccipChangeSetSolanaV0_1_1.VersionSolanaV0_1_1, DestinationDir: programsPath, } - solCs, err := DeployChainContractsToSolChainCSV0_1_1(e, solChains[0], true, buildSolConfig) + solCs, err := DeployChainContractsToSolChainCSV0_1_1(&e, solChains[0], true, buildSolConfig) require.NoError(t, err) apps = append(apps, solCs...) } else { // If no version is specified, we will use the default one - solCs, err := DeployChainContractsToSolChainCS(e, solChains[0], true, nil) + solCs, err := DeployChainContractsToSolChainCS(&e, solChains[0], true, nil) require.NoError(t, err) apps = append(apps, solCs...) } diff --git a/deployment/ccip/changeset/testhelpers/test_helpers_aptos.go b/deployment/ccip/changeset/testhelpers/test_helpers_aptos.go index df7be504f9a..a5b70303c3b 100644 --- a/deployment/ccip/changeset/testhelpers/test_helpers_aptos.go +++ b/deployment/ccip/changeset/testhelpers/test_helpers_aptos.go @@ -33,6 +33,7 @@ import ( "github.com/smartcontractkit/chainlink-aptos/bindings/test_token/test_token" "github.com/smartcontractkit/chainlink-ccip/chains/evm/gobindings/generated/v1_5_1/burn_mint_token_pool" "github.com/smartcontractkit/chainlink-common/pkg/logger" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils" cldftesthelpers "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils/testhelpers" @@ -259,7 +260,7 @@ func SendRequestAptos( func DeployTransferableTokenAptos( t *testing.T, lggr logger.Logger, - e cldf.Environment, + e *cldf.Environment, evmChainSel, aptosChainSel uint64, tokenName string, mintAmount *config.TokenMint, @@ -279,15 +280,17 @@ func DeployTransferableTokenAptos( // EVM evmDeployerKey := e.BlockChains.EVMChains()[evmChainSel].DeployerKey - state, err := stateview.LoadOnchainState(e) + state, err := stateview.LoadOnchainState(*e) require.NoError(t, err) - evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, tokenName) + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, ds, tokenName) + require.NoError(t, mergeDataStoreIntoEnv(e, ds)) require.NoError(t, err) err = attachTokenToTheRegistry(e.BlockChains.EVMChains()[evmChainSel], state.MustGetEVMChainState(evmChainSel), evmDeployerKey, evmToken.Address(), evmPool.Address()) require.NoError(t, err) // Aptos - e, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.AddTokenPool{}, config.AddTokenPoolConfig{ ChainSelector: aptosChainSel, @@ -363,7 +366,7 @@ func DeployTransferableTokenAptos( func DeployRegulatedTransferableTokenAptos( t *testing.T, lggr logger.Logger, - e cldf.Environment, + e *cldf.Environment, evmChainSel, aptosChainSel uint64, tokenName string, @@ -384,16 +387,18 @@ func DeployRegulatedTransferableTokenAptos( // EVM evmDeployerKey := e.BlockChains.EVMChains()[evmChainSel].DeployerKey - state, err := stateview.LoadOnchainState(e) + state, err := stateview.LoadOnchainState(*e) require.NoError(t, err) - evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, tokenName) + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, ds, tokenName) + require.NoError(t, mergeDataStoreIntoEnv(e, ds)) require.NoError(t, err) err = attachTokenToTheRegistry(e.BlockChains.EVMChains()[evmChainSel], state.MustGetEVMChainState(evmChainSel), evmDeployerKey, evmToken.Address(), evmPool.Address()) require.NoError(t, err) // Deploy + initialize regulated token, transfer ownership/admin to mcms via the changeset. const tokenSymbol shared.TokenSymbol = "TKN" - e, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.DeployRegulatedToken{}, config.DeployRegulatedTokenConfig{ ChainSelector: aptosChainSel, @@ -433,7 +438,7 @@ func DeployRegulatedTransferableTokenAptos( require.NotEqualf(t, aptos.AccountAddress{}, tokenMetadata, "regulated token metadata address not found") // Deploy lane (also finalizes the 3-step ownership handoff via FinalizeRegulatedTokenOwnershipSequence). - e, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.AddTokenPool{}, config.AddTokenPoolConfig{ ChainSelector: aptosChainSel, @@ -442,6 +447,9 @@ func DeployRegulatedTransferableTokenAptos( TokenPoolAddress: aptos.AccountAddress{}, // Will be deployed PoolType: shared.AptosRegulatedTokenPoolType, // Use regulated token pool type TokenTransferFeeByRemoteChainConfig: nil, + TokenParams: config.TokenParams{ + Symbol: tokenSymbol, + }, EVMRemoteConfigs: map[uint64]config.EVMRemoteConfig{ evmChainSel: { TokenAddress: evmToken.Address(), @@ -485,10 +493,11 @@ func DeployRegulatedTransferableTokenAptos( return evmToken, evmPool, tokenMetadata, aptosTokenPool, nil } -// DeployAptosCCIPReceiver deploys the ccip_dummy_receiver package to all Aptos chains, saving the resulting address in the address book for future use -func DeployAptosCCIPReceiver(t *testing.T, e cldf.Environment) { - state, err := aptosstate.LoadOnchainState(e) +// DeployAptosCCIPReceiver deploys the ccip_dummy_receiver package to all Aptos chains. +func DeployAptosCCIPReceiver(t *testing.T, e *cldf.Environment) { + state, err := aptosstate.LoadOnchainState(*e) require.NoError(t, err) + ds := datastore.NewMemoryDataStore() for selector, onchainState := range state { // ccip_dummy_receiver includes ptt_dummy_receiver, which requires resource-account deployment. seed := fmt.Sprintf("%s_%d", ccip_dummy_receiver.DefaultSeed, selector) @@ -502,9 +511,10 @@ func DeployAptosCCIPReceiver(t *testing.T, e cldf.Environment) { require.NoError(t, err) t.Logf("(Aptos) CCIPDummyReceiver(ccip: %s, mcms: %s) deployed to %s in tx %s", onchainState.CCIPAddress.StringLong(), onchainState.MCMSAddress.StringLong(), addr.StringLong(), tx.Hash) require.NoError(t, e.BlockChains.AptosChains()[selector].Confirm(tx.Hash)) - err = e.ExistingAddresses.Save(selector, addr.StringLong(), cldf.NewTypeAndVersion(shared.AptosReceiverType, deployment.Version1_0_0)) + err = shared.RecordAddress(e.ExistingAddresses, ds, selector, addr.StringLong(), cldf.NewTypeAndVersion(shared.AptosReceiverType, deployment.Version1_0_0), "") require.NoError(t, err) } + require.NoError(t, mergeDataStoreIntoEnv(e, ds)) } // DeployBnMTokenAptos deploys two tokens on to the EVM and Aptos chain and sets up a lane between them. @@ -512,7 +522,7 @@ func DeployAptosCCIPReceiver(t *testing.T, e cldf.Environment) { func DeployBnMTokenAptos( t *testing.T, lggr logger.Logger, - e cldf.Environment, + e *cldf.Environment, evmChainSel, aptosChainSel uint64, tokenName string, mintAmount *config.TokenMint, @@ -523,6 +533,8 @@ func DeployBnMTokenAptos( aptos_burn_mint_token_pool.BurnMintTokenPool, error, ) { + const aptosTokenSymbol shared.TokenSymbol = "TKN" + selectorFamily, err := chainsel.GetSelectorFamily(evmChainSel) require.NoError(t, err) require.Equal(t, chainsel.FamilyEVM, selectorFamily) @@ -532,9 +544,11 @@ func DeployBnMTokenAptos( // EVM evmDeployerKey := e.BlockChains.EVMChains()[evmChainSel].DeployerKey - state, err := stateview.LoadOnchainState(e) + state, err := stateview.LoadOnchainState(*e) require.NoError(t, err) - evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, tokenName) + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, ds, tokenName) + require.NoError(t, mergeDataStoreIntoEnv(e, ds)) require.NoError(t, err) err = attachTokenToTheRegistry(e.BlockChains.EVMChains()[evmChainSel], state.MustGetEVMChainState(evmChainSel), evmDeployerKey, evmToken.Address(), evmPool.Address()) require.NoError(t, err) @@ -545,6 +559,7 @@ func DeployBnMTokenAptos( signerAddress := signer.AccountAddress() client := e.BlockChains.AptosChains()[aptosChainSel].Client opts := &aptosBind.TransactOpts{Signer: signer} + aptosDS := datastore.NewMemoryDataStore() aptosAddresses, err := e.ExistingAddresses.AddressesForChain(aptosChainSel) require.NoError(t, err) mcmsAddress := aptosstate.FindAptosAddress( @@ -571,7 +586,7 @@ func DeployBnMTokenAptos( require.NoError(t, err) require.True(t, data.Success, "failed to deploy test_token: %v", data.VmStatus) - tx, err = testToken.TestToken().Initialize(opts, nil, "Test Token", "TKN", 8, "", "", true) + tx, err = testToken.TestToken().Initialize(opts, nil, "Test Token", aptosTokenSymbol.String(), 8, "", "", true) require.NoError(t, err) data, err = client.WaitForTransaction(tx.Hash) require.NoError(t, err) @@ -589,13 +604,14 @@ func DeployBnMTokenAptos( tokenAddress, err := testToken.TestToken().TokenMetadata(nil) require.NoError(t, err) - // Save addresses in address book + // Record manually deployed addresses in both stores; AddTokenPool does not re-record + // addresses supplied as pre-existing. typeAndVersion := cldf.NewTypeAndVersion(shared.AptosTestTokenType, deployment.Version1_6_0) - typeAndVersion.AddLabel("TKN") - err = e.ExistingAddresses.Save(aptosChainSel, tokenObjectAddress.StringLong(), typeAndVersion) + typeAndVersion.AddLabel(aptosTokenSymbol.String()) + err = shared.RecordAddress(e.ExistingAddresses, aptosDS, aptosChainSel, tokenObjectAddress.StringLong(), typeAndVersion, shared.TokenQualifier(aptosTokenSymbol.String())) require.NoError(t, err) - typeAndVersion = cldf.NewTypeAndVersion(cldf.ContractType("TKN"), deployment.Version1_6_0) - err = e.ExistingAddresses.Save(aptosChainSel, tokenAddress.StringLong(), typeAndVersion) + typeAndVersion = cldf.NewTypeAndVersion(cldf.ContractType(aptosTokenSymbol), deployment.Version1_6_0) + err = shared.RecordAddress(e.ExistingAddresses, aptosDS, aptosChainSel, tokenAddress.StringLong(), typeAndVersion, shared.TokenQualifier(aptosTokenSymbol.String())) require.NoError(t, err) // Deploy BnM Token Pool @@ -613,8 +629,9 @@ func DeployBnMTokenAptos( typeAndVersion = cldf.NewTypeAndVersion(shared.BurnMintTokenPool, deployment.Version1_6_0) typeAndVersion.AddLabel(tokenAddress.StringLong()) - err = e.ExistingAddresses.Save(aptosChainSel, tokenPoolAddress.StringLong(), typeAndVersion) + err = shared.RecordAddress(e.ExistingAddresses, aptosDS, aptosChainSel, tokenPoolAddress.StringLong(), typeAndVersion, shared.TokenQualifier(aptosTokenSymbol.String())) require.NoError(t, err) + require.NoError(t, mergeDataStoreIntoEnv(e, aptosDS)) // Deploy BnM registrar tx, bnmRegistrar, err := bnm_registrar.DeployToExistingObject(signer, client, tokenObjectAddress, tokenPoolAddress, ccipAddress, tokenPoolAddress, mcmsAddress, tokenAddress) @@ -659,7 +676,7 @@ func DeployBnMTokenAptos( require.NoError(t, err) require.True(t, data.Success, "failed to initiate ownership transfer of BnM token pool to %v: %v", tokenPoolOwnerAddress, data.VmStatus) - _, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.AcceptTokenPoolOwnership{}, config.AcceptTokenPoolOwnershipInput{ ChainSelector: aptosChainSel, @@ -683,7 +700,7 @@ func DeployBnMTokenAptos( require.NoError(t, err) require.True(t, data.Success, "failed to execute ownership transfer of BnM token pool to %v: %", tokenPoolOwnerAddress, data.VmStatus) - e, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.AddTokenPool{}, config.AddTokenPoolConfig{ ChainSelector: aptosChainSel, @@ -692,6 +709,9 @@ func DeployBnMTokenAptos( TokenPoolAddress: tokenPoolAddress, PoolType: shared.BurnMintTokenPool, TokenTransferFeeByRemoteChainConfig: nil, + TokenParams: config.TokenParams{ + Symbol: aptosTokenSymbol, + }, EVMRemoteConfigs: map[uint64]config.EVMRemoteConfig{ evmChainSel: { TokenAddress: evmToken.Address(), @@ -756,7 +776,7 @@ func DeployBnMTokenAptos( func DeployLnRTokenAptos( t *testing.T, lggr logger.Logger, - e cldf.Environment, + e *cldf.Environment, evmChainSel, aptosChainSel uint64, tokenName string, mintAmount *config.TokenMint, @@ -768,6 +788,8 @@ func DeployLnRTokenAptos( lock_release_token_pool.LockReleaseTokenPool, error, ) { + const aptosTokenSymbol shared.TokenSymbol = "TKN" + selectorFamily, err := chainsel.GetSelectorFamily(evmChainSel) require.NoError(t, err) require.Equal(t, chainsel.FamilyEVM, selectorFamily) @@ -777,9 +799,11 @@ func DeployLnRTokenAptos( // EVM evmDeployerKey := e.BlockChains.EVMChains()[evmChainSel].DeployerKey - state, err := stateview.LoadOnchainState(e) + state, err := stateview.LoadOnchainState(*e) require.NoError(t, err) - evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, tokenName) + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployerKey, e.ExistingAddresses, ds, tokenName) + require.NoError(t, mergeDataStoreIntoEnv(e, ds)) require.NoError(t, err) err = attachTokenToTheRegistry(e.BlockChains.EVMChains()[evmChainSel], state.MustGetEVMChainState(evmChainSel), evmDeployerKey, evmToken.Address(), evmPool.Address()) require.NoError(t, err) @@ -790,6 +814,7 @@ func DeployLnRTokenAptos( signerAddress := signer.AccountAddress() client := e.BlockChains.AptosChains()[aptosChainSel].Client opts := &aptosBind.TransactOpts{Signer: signer} + aptosDS := datastore.NewMemoryDataStore() aptosAddresses, err := e.ExistingAddresses.AddressesForChain(aptosChainSel) require.NoError(t, err) mcmsAddress := aptosstate.FindAptosAddress( @@ -816,7 +841,7 @@ func DeployLnRTokenAptos( require.NoError(t, err) require.True(t, data.Success, "failed to deploy test_token: %v", data.VmStatus) - tx, err = testToken.TestToken().Initialize(opts, nil, "Test Token", "TKN", 8, "", "", withDispatchHooks) + tx, err = testToken.TestToken().Initialize(opts, nil, "Test Token", aptosTokenSymbol.String(), 8, "", "", withDispatchHooks) require.NoError(t, err) data, err = client.WaitForTransaction(tx.Hash) require.NoError(t, err) @@ -834,13 +859,14 @@ func DeployLnRTokenAptos( tokenAddress, err := testToken.TestToken().TokenMetadata(nil) require.NoError(t, err) - // Save addresses in address book + // Record manually deployed addresses in both stores; AddTokenPool does not re-record + // addresses supplied as pre-existing. typeAndVersion := cldf.NewTypeAndVersion(shared.AptosTestTokenType, deployment.Version1_6_0) - typeAndVersion.AddLabel("TKN") - err = e.ExistingAddresses.Save(aptosChainSel, tokenObjectAddress.StringLong(), typeAndVersion) + typeAndVersion.AddLabel(aptosTokenSymbol.String()) + err = shared.RecordAddress(e.ExistingAddresses, aptosDS, aptosChainSel, tokenObjectAddress.StringLong(), typeAndVersion, shared.TokenQualifier(aptosTokenSymbol.String())) require.NoError(t, err) - typeAndVersion = cldf.NewTypeAndVersion(cldf.ContractType("TKN"), deployment.Version1_6_0) - err = e.ExistingAddresses.Save(aptosChainSel, tokenAddress.StringLong(), typeAndVersion) + typeAndVersion = cldf.NewTypeAndVersion(cldf.ContractType(aptosTokenSymbol), deployment.Version1_6_0) + err = shared.RecordAddress(e.ExistingAddresses, aptosDS, aptosChainSel, tokenAddress.StringLong(), typeAndVersion, shared.TokenQualifier(aptosTokenSymbol.String())) require.NoError(t, err) // Deploy LnR Token Pool @@ -858,8 +884,9 @@ func DeployLnRTokenAptos( typeAndVersion = cldf.NewTypeAndVersion(shared.LockReleaseTokenPool, deployment.Version1_6_0) typeAndVersion.AddLabel(tokenAddress.StringLong()) - err = e.ExistingAddresses.Save(aptosChainSel, tokenPoolAddress.StringLong(), typeAndVersion) + err = shared.RecordAddress(e.ExistingAddresses, aptosDS, aptosChainSel, tokenPoolAddress.StringLong(), typeAndVersion, shared.TokenQualifier(aptosTokenSymbol.String())) require.NoError(t, err) + require.NoError(t, mergeDataStoreIntoEnv(e, aptosDS)) // Deploy LnR registrar tx, lnrRegistrar, err := lnr_registrar.DeployToExistingObject(signer, client, tokenObjectAddress, tokenPoolAddress, ccipAddress, tokenPoolAddress, mcmsAddress, tokenAddress) @@ -912,7 +939,7 @@ func DeployLnRTokenAptos( require.NoError(t, err) require.True(t, data.Success, "failed to initiate ownership transfer of BnM token pool to %v: %v", tokenPoolOwnerAddress, data.VmStatus) - _, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.AcceptTokenPoolOwnership{}, config.AcceptTokenPoolOwnershipInput{ ChainSelector: aptosChainSel, @@ -936,7 +963,7 @@ func DeployLnRTokenAptos( require.NoError(t, err) require.True(t, data.Success, "failed to execute ownership transfer of LnR token pool to %v: %", tokenPoolOwnerAddress, data.VmStatus) - e, err = commoncs.Apply(t, e, + *e, err = commoncs.Apply(t, *e, commoncs.Configure(aptoscs.AddTokenPool{}, config.AddTokenPoolConfig{ ChainSelector: aptosChainSel, @@ -945,6 +972,9 @@ func DeployLnRTokenAptos( TokenPoolAddress: tokenPoolAddress, PoolType: shared.LockReleaseTokenPool, TokenTransferFeeByRemoteChainConfig: nil, + TokenParams: config.TokenParams{ + Symbol: aptosTokenSymbol, + }, EVMRemoteConfigs: map[uint64]config.EVMRemoteConfig{ evmChainSel: { TokenAddress: evmToken.Address(), diff --git a/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_0.go b/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_0.go index e03244bbb40..d5a797c4d6a 100644 --- a/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_0.go +++ b/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_0.go @@ -1390,7 +1390,7 @@ func AddLanesForAll(t *testing.T, e *DeployedEnv, state stateview.CCIPOnChainSta for _, source := range chains { for _, dest := range chains { if source != dest { - AddLaneWithDefaultPricesAndFeeQuoterConfig(t, e, state, source, dest, false) + require.NoError(t, AddLaneWithDefaultPricesAndFeeQuoterConfig(t, e, state, source, dest, false)) } } } @@ -1494,37 +1494,43 @@ func deploySingleFeed( return mockTokenFeed.Address, desc, nil } +// DeployTransferableToken deploys and configures token/pool pairs on both EVM chains. func DeployTransferableToken( lggr logger.Logger, chains map[uint64]cldf_evm.Chain, src, dst uint64, srcActor, dstActor *bind.TransactOpts, state stateview.CCIPOnChainState, - addresses cldf.AddressBook, + e *cldf.Environment, token string, ) (*burn_mint_erc677.BurnMintERC677, *burn_mint_token_pool.BurnMintTokenPool, *burn_mint_erc677.BurnMintERC677, *burn_mint_token_pool.BurnMintTokenPool, error) { // Deploy token and pools - srcToken, srcPool, dstToken, dstPool, err := deployTokenPoolsInParallel(lggr, chains, src, dst, srcActor, dstActor, state, addresses, token) + srcDS := datastore.NewMemoryDataStore() + dstDS := datastore.NewMemoryDataStore() + srcToken, srcPool, dstToken, dstPool, err := deployTokenPoolsInParallel(lggr, chains, src, dst, srcActor, dstActor, state, e.ExistingAddresses, srcDS, dstDS, token) if err != nil { return nil, nil, nil, nil, err } + if err := mergeDataStoreIntoEnv(e, srcDS); err != nil { + return nil, nil, nil, nil, err + } + if err := mergeDataStoreIntoEnv(e, dstDS); err != nil { + return nil, nil, nil, nil, err + } // Configure pools in parallel configurePoolGrp := errgroup.Group{} configurePoolGrp.Go(func() error { - err := setTokenPoolCounterPart(chains[src], srcPool, srcActor, dst, dstToken.Address().Bytes(), dstPool.Address().Bytes()) - if err != nil { + if err := setTokenPoolCounterPart(chains[src], srcPool, srcActor, dst, dstToken.Address().Bytes(), dstPool.Address().Bytes()); err != nil { return fmt.Errorf("failed to set token pool counter part chain %d: %w", src, err) } - err = grantMintBurnPermissions(lggr, chains[src], srcToken, srcActor, srcPool.Address()) - if err != nil { + if err := grantMintBurnPermissions(lggr, chains[src], srcToken, srcActor, srcPool.Address()); err != nil { return fmt.Errorf("failed to grant mint burn permissions chain %d: %w", src, err) } return nil }) configurePoolGrp.Go(func() error { - err := setTokenPoolCounterPart(chains[dst], dstPool, dstActor, src, srcToken.Address().Bytes(), srcPool.Address().Bytes()) - if err != nil { + if err := setTokenPoolCounterPart(chains[dst], dstPool, dstActor, src, srcToken.Address().Bytes(), srcPool.Address().Bytes()); err != nil { return fmt.Errorf("failed to set token pool counter part chain %d: %w", dst, err) } if err := grantMintBurnPermissions(lggr, chains[dst], dstToken, dstActor, dstPool.Address()); err != nil { @@ -1545,16 +1551,11 @@ func deployTokenPoolsInParallel( srcActor, dstActor *bind.TransactOpts, state stateview.CCIPOnChainState, addresses cldf.AddressBook, + srcDS, dstDS datastore.MutableDataStore, token string, -) ( - *burn_mint_erc677.BurnMintERC677, - *burn_mint_token_pool.BurnMintTokenPool, - *burn_mint_erc677.BurnMintERC677, - *burn_mint_token_pool.BurnMintTokenPool, - error, -) { - deployGrp := errgroup.Group{} +) (*burn_mint_erc677.BurnMintERC677, *burn_mint_token_pool.BurnMintTokenPool, *burn_mint_erc677.BurnMintERC677, *burn_mint_token_pool.BurnMintTokenPool, error) { // Deploy token and pools + deployGrp := errgroup.Group{} var srcToken *burn_mint_erc677.BurnMintERC677 var srcPool *burn_mint_token_pool.BurnMintTokenPool var dstToken *burn_mint_erc677.BurnMintERC677 @@ -1562,21 +1563,19 @@ func deployTokenPoolsInParallel( deployGrp.Go(func() error { var err error - srcToken, srcPool, err = deployTransferTokenOneEnd(lggr, chains[src], srcActor, addresses, token) + srcToken, srcPool, err = deployTransferTokenOneEnd(lggr, chains[src], srcActor, addresses, srcDS, token) if err != nil { return err } - err = attachTokenToTheRegistry(chains[src], state.MustGetEVMChainState(src), srcActor, srcToken.Address(), srcPool.Address()) - return err + return attachTokenToTheRegistry(chains[src], state.MustGetEVMChainState(src), srcActor, srcToken.Address(), srcPool.Address()) }) deployGrp.Go(func() error { var err error - dstToken, dstPool, err = deployTransferTokenOneEnd(lggr, chains[dst], dstActor, addresses, token) + dstToken, dstPool, err = deployTransferTokenOneEnd(lggr, chains[dst], dstActor, addresses, dstDS, token) if err != nil { return err } - err = attachTokenToTheRegistry(chains[dst], state.MustGetEVMChainState(dst), dstActor, dstToken.Address(), dstPool.Address()) - return err + return attachTokenToTheRegistry(chains[dst], state.MustGetEVMChainState(dst), dstActor, dstToken.Address(), dstPool.Address()) }) if err := deployGrp.Wait(); err != nil { return nil, nil, nil, nil, err @@ -1726,6 +1725,7 @@ func deployTransferTokenOneEnd( chain cldf_evm.Chain, deployer *bind.TransactOpts, addressBook cldf.AddressBook, + ds datastore.MutableDataStore, tokenSymbol string, ) (*burn_mint_erc677.BurnMintERC677, *burn_mint_token_pool.BurnMintTokenPool, error) { var rmnAddress, routerAddress string @@ -1747,7 +1747,8 @@ func deployTransferTokenOneEnd( tokenDecimals := uint8(18) - tokenContract, err := cldf.DeployContract(lggr, chain, addressBook, + tokenContract, err := shared.DeployContractAndRecord(lggr, chain, addressBook, ds, + cldf.NewTypeAndVersion(shared.BurnMintToken, deployment.Version1_0_0), tokenSymbol, func(chain cldf_evm.Chain) cldf.ContractDeploy[*burn_mint_erc677.BurnMintERC677] { tokenAddress, tx, token, err2 := burn_mint_erc677.DeployBurnMintERC677( deployer, @@ -1775,7 +1776,8 @@ func deployTransferTokenOneEnd( return nil, nil, err } - tokenPool, err := cldf.DeployContract(lggr, chain, addressBook, + tokenPool, err := shared.DeployContractAndRecord(lggr, chain, addressBook, ds, + cldf.NewTypeAndVersion(shared.BurnMintTokenPool, deployment.Version1_5_1), tokenSymbol, func(chain cldf_evm.Chain) cldf.ContractDeploy[*burn_mint_token_pool.BurnMintTokenPool] { tokenPoolAddress, tx, tokenPoolContract, err2 := burn_mint_token_pool.DeployBurnMintTokenPool( deployer, @@ -2283,62 +2285,36 @@ func DefaultRouterMessage(receiverAddress common.Address) router.ClientEVM2AnyMe } // TODO: this should be linked to the solChain function -func SavePreloadedSolAddresses(e cldf.Environment, solChainSelector uint64) error { - tv := cldf.NewTypeAndVersion(shared.Router, deployment.Version1_0_0) - err := e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgCCIPRouter), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.Receiver, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgTestCCIPReceiver), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.FeeQuoter, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgFeeQuoter), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.OffRamp, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgCCIPOfframp), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.BurnMintTokenPool, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgBurnMintTokenPool), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.LockReleaseTokenPool, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgLockReleaseTokenPool), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.CCTPTokenPool, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgCCTPTokenPool), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(commontypes.ManyChainMultisigProgram, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgMCM), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(commontypes.AccessControllerProgram, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgAccessController), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(commontypes.RBACTimelockProgram, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgTimelock), tv) - if err != nil { - return err - } - tv = cldf.NewTypeAndVersion(shared.RMNRemote, deployment.Version1_0_0) - err = e.ExistingAddresses.Save(solChainSelector, solutils.GetProgramID(solutils.ProgRMNRemote), tv) - if err != nil { - return err +func SavePreloadedSolAddresses(e *cldf.Environment, solChainSelector uint64) error { + ds := datastore.NewMemoryDataStore() + if e.DataStore != nil { + if err := ds.Merge(e.DataStore); err != nil { + return fmt.Errorf("merge environment datastore: %w", err) + } + } + + preloaded := []struct { + tv cldf.TypeAndVersion + address string + }{ + {cldf.NewTypeAndVersion(shared.Router, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgCCIPRouter)}, + {cldf.NewTypeAndVersion(shared.Receiver, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgTestCCIPReceiver)}, + {cldf.NewTypeAndVersion(shared.FeeQuoter, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgFeeQuoter)}, + {cldf.NewTypeAndVersion(shared.OffRamp, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgCCIPOfframp)}, + {cldf.NewTypeAndVersion(shared.BurnMintTokenPool, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgBurnMintTokenPool)}, + {cldf.NewTypeAndVersion(shared.LockReleaseTokenPool, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgLockReleaseTokenPool)}, + {cldf.NewTypeAndVersion(shared.CCTPTokenPool, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgCCTPTokenPool)}, + {cldf.NewTypeAndVersion(commontypes.ManyChainMultisigProgram, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgMCM)}, + {cldf.NewTypeAndVersion(commontypes.AccessControllerProgram, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgAccessController)}, + {cldf.NewTypeAndVersion(commontypes.RBACTimelockProgram, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgTimelock)}, + {cldf.NewTypeAndVersion(shared.RMNRemote, deployment.Version1_0_0), solutils.GetProgramID(solutils.ProgRMNRemote)}, + } + for _, item := range preloaded { + if err := shared.RecordAddress(e.ExistingAddresses, ds, solChainSelector, item.address, item.tv, ""); err != nil { + return err + } } + e.DataStore = ds.Seal() return nil } diff --git a/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_1.go b/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_1.go index 9e9535391bd..449db8e742b 100644 --- a/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_1.go +++ b/deployment/ccip/changeset/testhelpers/test_helpers_solana_v0_1_1.go @@ -40,6 +40,7 @@ import ( soltokens "github.com/smartcontractkit/chainlink-ccip/chains/solana/utils/tokens" "github.com/smartcontractkit/chainlink-common/pkg/logger" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-evm/gethwrappers/shared/generated/initial/burn_mint_erc677" @@ -114,7 +115,7 @@ func TransferOwnershipSolanaV0_1_1( // assuming one out of the src and dst is solana and the other is evm func DeployTransferableTokenSolanaV0_1_1( lggr logger.Logger, - e cldf.Environment, + e *cldf.Environment, evmChainSel, solChainSel uint64, evmDeployer *bind.TransactOpts, evmTokenName string, @@ -133,14 +134,21 @@ func DeployTransferableTokenSolanaV0_1_1( if selectorFamily != chainsel.FamilySolana { return nil, nil, solana.PublicKey{}, fmt.Errorf("solChainSel %d is not a solana chain", solChainSel) } - state, err := stateview.LoadOnchainState(e) + state, err := stateview.LoadOnchainState(*e) if err != nil { return nil, nil, solana.PublicKey{}, err } addresses := e.ExistingAddresses // deploy evm token and pool - evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployer, addresses, evmTokenName) + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(lggr, e.BlockChains.EVMChains()[evmChainSel], evmDeployer, addresses, ds, evmTokenName) + if err != nil { + return nil, nil, solana.PublicKey{}, err + } + if err := mergeDataStoreIntoEnv(e, ds); err != nil { + return nil, nil, solana.PublicKey{}, err + } if err != nil { return nil, nil, solana.PublicKey{}, err } @@ -152,7 +160,7 @@ func DeployTransferableTokenSolanaV0_1_1( // deploy solana token solTokenName := evmTokenName - e, err = commoncs.Apply(nil, e, + *e, err = commoncs.Apply(nil, *e, commoncs.Configure( // this makes the deployer the mint authority by default cldf.CreateLegacyChangeSet(ccipChangeSetSolanaV0_1_1.DeploySolanaToken), @@ -187,7 +195,7 @@ func DeployTransferableTokenSolanaV0_1_1( bnm := shared.BurnMintTokenPool // deploy and configure solana token pool - e, err = commoncs.Apply(nil, e, + *e, err = commoncs.Apply(nil, *e, commoncs.Configure( // deploy token pool and set the burn/mint authority to the tokenPool cldf.CreateLegacyChangeSet(ccipChangeSetSolanaV0_1_1.E2ETokenPool), diff --git a/deployment/ccip/changeset/testhelpers/test_sui_helpers.go b/deployment/ccip/changeset/testhelpers/test_sui_helpers.go index 05210c17eaf..656a0cc6c6a 100644 --- a/deployment/ccip/changeset/testhelpers/test_sui_helpers.go +++ b/deployment/ccip/changeset/testhelpers/test_sui_helpers.go @@ -26,6 +26,7 @@ import ( solLatestFeeQuoter "github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings/latest/fee_quoter" "github.com/smartcontractkit/chainlink-common/pkg/utils/tests" cldf_sui "github.com/smartcontractkit/chainlink-deployments-framework/chain/sui" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/operations" "github.com/smartcontractkit/chainlink-evm/gethwrappers/shared/generated/initial/burn_mint_erc677" @@ -766,7 +767,11 @@ func HandleTokenAndBurnMintTokenPoolDeploymentForSUI(e cldf.Environment, suiChai linkTokenTreasuryCapID := state.SuiChains[suiChainSel].LinkTokenTreasuryCapId // Deploy transferrable token on EVM - evmToken, evmPool, err := deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, "TOKEN") + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, ds, "TOKEN") + if err := mergeDataStoreIntoEnv(&e, ds); err != nil { + return cldf.Environment{}, nil, nil, err + } if err != nil { return cldf.Environment{}, nil, nil, errors.New("failed to deploy transfer token for evm chain " + err.Error()) } @@ -902,10 +907,14 @@ func HandleMaliciousBurnMintTokenPoolDeploymentForSUI( linkTokenTreasuryCapID := state.SuiChains[suiChainSel].LinkTokenTreasuryCapId // EVM: deploy transferrable token + burn-mint pool, attach to the registry. - evmToken, evmPool, err = deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, "TOKEN") + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err = deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, ds, "TOKEN") if err != nil { return cldf.Environment{}, nil, nil, "", "", errors.New("failed to deploy transfer token for evm chain " + err.Error()) } + if err := mergeDataStoreIntoEnv(&e, ds); err != nil { + return cldf.Environment{}, nil, nil, "", "", err + } err = attachTokenToTheRegistry(evmChain, state.MustGetEVMChainState(evmChain.Selector), evmDeployerKey, evmToken.Address(), evmPool.Address()) if err != nil { @@ -1002,7 +1011,11 @@ func HandleTokenAndManagedTokenPoolDeploymentForSUI(e cldf.Environment, suiChain } // Deploy transferrable token on EVM - evmToken, evmPool, err := deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, "TOKEN") + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, ds, "TOKEN") + if err := mergeDataStoreIntoEnv(&e, ds); err != nil { + return cldf.Environment{}, nil, nil, err + } if err != nil { return cldf.Environment{}, nil, nil, errors.New("failed to deploy transfer token for evm chain " + err.Error()) } @@ -1106,7 +1119,11 @@ func HandleTokenAndLockReleaseTokenPoolDeploymentForSUI(e cldf.Environment, suiC linkTokenTreasuryCapID := state.SuiChains[suiChainSel].LinkTokenTreasuryCapId // Deploy transferrable token on EVM - evmToken, evmPool, err := deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, "TOKEN") + ds := datastore.NewMemoryDataStore() + evmToken, evmPool, err := deployTransferTokenOneEnd(e.Logger, evmChain, evmDeployerKey, e.ExistingAddresses, ds, "TOKEN") + if err := mergeDataStoreIntoEnv(&e, ds); err != nil { + return cldf.Environment{}, nil, nil, err + } if err != nil { return cldf.Environment{}, nil, nil, errors.New("failed to deploy transfer token for evm chain " + err.Error()) } @@ -1337,3 +1354,19 @@ func extractFields[T any](configs []TokenPoolRateLimiterConfig, selector func(To } return result } + +// mergeDataStoreIntoEnv merges ds into the environment's datastore (the env's datastore is +// sealed, so rebuild and reassign). +func mergeDataStoreIntoEnv(e *cldf.Environment, ds datastore.MutableDataStore) error { + merged := datastore.NewMemoryDataStore() + if e.DataStore != nil { + if err := merged.Merge(e.DataStore); err != nil { + return err + } + } + if err := merged.Merge(ds.Seal()); err != nil { + return err + } + e.DataStore = merged.Seal() + return nil +} diff --git a/deployment/ccip/changeset/testhelpers/test_token_helpers.go b/deployment/ccip/changeset/testhelpers/test_token_helpers.go index 5462ded6e08..1d167c4235f 100644 --- a/deployment/ccip/changeset/testhelpers/test_token_helpers.go +++ b/deployment/ccip/changeset/testhelpers/test_token_helpers.go @@ -21,6 +21,7 @@ import ( cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/runtime" @@ -96,7 +97,9 @@ func SetupTwoChainEnvironmentWithTokens( for _, selector := range selectors { chain := rt.Environment().BlockChains.EVMChains()[selector] - token, err := cldf.DeployContract(lggr, chain, rt.State().AddressBook, + ds := datastore.NewMemoryDataStore() + token, err := shared.DeployContractAndRecord(lggr, chain, rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.BurnMintToken, deployment.Version1_0_0), string(TestTokenSymbol), func(chain cldf_evm.Chain) cldf.ContractDeploy[*burn_mint_erc677.BurnMintERC677] { tokenAddress, tx, token, err := burn_mint_erc677.DeployBurnMintERC677( chain.DeployerKey, @@ -116,6 +119,7 @@ func SetupTwoChainEnvironmentWithTokens( }, ) require.NoError(t, err) + require.NoError(t, rt.State().MergeChangesetOutput("test-deploy-token", cldf.ChangesetOutput{DataStore: ds})) tokens[selector] = token } diff --git a/deployment/ccip/changeset/testhelpers/v1_5/test_helpers.go b/deployment/ccip/changeset/testhelpers/v1_5/test_helpers.go index 1084eb68874..ffc0e94e8c1 100644 --- a/deployment/ccip/changeset/testhelpers/v1_5/test_helpers.go +++ b/deployment/ccip/changeset/testhelpers/v1_5/test_helpers.go @@ -7,6 +7,7 @@ import ( "errors" "fmt" "math/big" + "strconv" "testing" "time" @@ -25,6 +26,7 @@ import ( "github.com/smartcontractkit/chainlink-common/pkg/config" ccipcommontypes "github.com/smartcontractkit/chainlink-common/pkg/types/ccip" cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink/deployment" deploycciptesthelpers "github.com/smartcontractkit/chainlink/deployment/ccip/changeset/testhelpers" @@ -285,19 +287,22 @@ func DeployLanesChangeset(env cldf.Environment, c DeployLanesConfig) (cldf.Chang } } newAddresses := cldf.NewMemoryAddressBook() + ds := datastore.NewMemoryDataStore() for _, cfg := range c.Configs { - if err := deployLane(env, state, newAddresses, cfg); err != nil { + if err := deployLane(env, state, newAddresses, ds, cfg); err != nil { return cldf.ChangesetOutput{ AddressBook: newAddresses, + DataStore: ds, }, err } } return cldf.ChangesetOutput{ AddressBook: newAddresses, + DataStore: ds, }, nil } -func deployLane(e cldf.Environment, state stateview.CCIPOnChainState, ab cldf.AddressBook, cfg DeployLaneConfig) error { +func deployLane(e cldf.Environment, state stateview.CCIPOnChainState, ab cldf.AddressBook, ds datastore.MutableDataStore, cfg DeployLaneConfig) error { // update prices on the source price registry sourceChainState := state.MustGetEVMChainState(cfg.SourceChainSelector) destChainState := state.MustGetEVMChainState(cfg.DestinationChainSelector) @@ -321,7 +326,8 @@ func deployLane(e cldf.Environment, state stateview.CCIPOnChainState, ab cldf.Ad // Deploy onRamp on source chain onRamp, onRampExists := sourceChainState.EVM2EVMOnRamp[cfg.DestinationChainSelector] if !onRampExists { - onRampC, err := cldf.DeployContract(e.Logger, sourceChain, ab, + onRampC, err := shared.DeployContractAndRecord(e.Logger, sourceChain, ab, ds, + cldf.NewTypeAndVersion(shared.OnRamp, deployment.Version1_5_0), strconv.FormatUint(cfg.DestinationChainSelector, 10), func(chain cldf_evm.Chain) cldf.ContractDeploy[*evm_2_evm_onramp.EVM2EVMOnRamp] { onRampAddress, tx2, onRampC, err2 := evm_2_evm_onramp.DeployEVM2EVMOnRamp( sourceChain.DeployerKey, @@ -352,7 +358,8 @@ func deployLane(e cldf.Environment, state stateview.CCIPOnChainState, ab cldf.Ad // Deploy commit store on source chain commitStore, commitStoreExists := destChainState.CommitStore[cfg.SourceChainSelector] if !commitStoreExists { - commitStoreC, err := cldf.DeployContract(e.Logger, destChain, ab, + commitStoreC, err := shared.DeployContractAndRecord(e.Logger, destChain, ab, ds, + cldf.NewTypeAndVersion(shared.CommitStore, deployment.Version1_5_0), strconv.FormatUint(cfg.SourceChainSelector, 10), func(chain cldf_evm.Chain) cldf.ContractDeploy[*commit_store.CommitStore] { commitStoreAddress, tx2, commitStoreC, err2 := commit_store.DeployCommitStore( destChain.DeployerKey, @@ -383,7 +390,8 @@ func deployLane(e cldf.Environment, state stateview.CCIPOnChainState, ab cldf.Ad // Deploy offRamp on destination chain offRamp, offRampExists := destChainState.EVM2EVMOffRamp[cfg.SourceChainSelector] if !offRampExists { - offRampC, err := cldf.DeployContract(e.Logger, destChain, ab, + offRampC, err := shared.DeployContractAndRecord(e.Logger, destChain, ab, ds, + cldf.NewTypeAndVersion(shared.OffRamp, deployment.Version1_5_0), strconv.FormatUint(cfg.SourceChainSelector, 10), func(chain cldf_evm.Chain) cldf.ContractDeploy[*evm_2_evm_offramp.EVM2EVMOffRamp] { offRampAddress, tx2, offRampC, err2 := evm_2_evm_offramp.DeployEVM2EVMOffRamp( destChain.DeployerKey, diff --git a/deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_pausable_freezable_transparent_test.go b/deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_pausable_freezable_transparent_test.go index d7f45e6bdc2..e8484ddbf1f 100644 --- a/deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_pausable_freezable_transparent_test.go +++ b/deployment/ccip/changeset/v1_5/cs_burn_mint_erc20_pausable_freezable_transparent_test.go @@ -13,6 +13,7 @@ import ( "github.com/smartcontractkit/ccip-contract-examples/chains/evm/gobindings/generated/1_6_1/transparent_upgradeable_proxy" cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" chain_selectors "github.com/smartcontractkit/chain-selectors" @@ -94,6 +95,17 @@ func TestBurnMintERC20PausableFreezableTransparentValidate(t *testing.T) { err = e.Env.ExistingAddresses.Save(chainSelector, implementation.Address().String(), cldf.NewTypeAndVersion(shared.BurnMintERC20PausableFreezableTransparentToken, deployment.Version1_5_0)) require.NoError(t, err) + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.Env.DataStore)) + version := deployment.Version1_5_0 + require.NoError(t, ds.Addresses().Add(datastore.AddressRef{ + ChainSelector: chainSelector, + Address: implementation.Address().String(), + Type: datastore.ContractType(shared.BurnMintERC20PausableFreezableTransparentToken), + Version: &version, + Qualifier: token, + })) + e.Env.DataStore = ds.Seal() initData, err := parsedABI.Pack( "initialize", diff --git a/deployment/ccip/changeset/v1_5_1/cs_configure_token_pools_test.go b/deployment/ccip/changeset/v1_5_1/cs_configure_token_pools_test.go index 204dbae6e48..d7a8bd5b09e 100644 --- a/deployment/ccip/changeset/v1_5_1/cs_configure_token_pools_test.go +++ b/deployment/ccip/changeset/v1_5_1/cs_configure_token_pools_test.go @@ -716,6 +716,7 @@ func TestValidateConfigureTokenPoolContracts(t *testing.T) { func TestValidateConfigureTokenPoolContractsForSolana(t *testing.T) { t.Parallel() var err error + const redeployedTokenSymbol = "TEST_2" deployedEnvironment, _ := testhelpers.NewMemoryEnvironment(t, func(testCfg *testhelpers.TestConfigs) { testCfg.Chains = 2 @@ -898,7 +899,7 @@ func TestValidateConfigureTokenPoolContractsForSolana(t *testing.T) { ChainSelector: selector, TokenProgramName: shared.SPL2022Tokens, TokenDecimals: testhelpers.LocalTokenDecimals, - TokenSymbol: string(testhelpers.TestTokenSymbol), + TokenSymbol: redeployedTokenSymbol, }, ), ) diff --git a/deployment/ccip/changeset/v1_5_1/cs_deploy_token_pool_factory_test.go b/deployment/ccip/changeset/v1_5_1/cs_deploy_token_pool_factory_test.go index b36e699c492..d5554f581a8 100644 --- a/deployment/ccip/changeset/v1_5_1/cs_deploy_token_pool_factory_test.go +++ b/deployment/ccip/changeset/v1_5_1/cs_deploy_token_pool_factory_test.go @@ -15,6 +15,7 @@ import ( "github.com/smartcontractkit/chainlink-evm/pkg/utils" cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/runtime" @@ -106,6 +107,8 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { environment.WithLogger(lggr), )) require.NoError(t, err) + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(rt.Environment().DataStore)) if !test.ForgetPrerequisites { // NOTE: We don't use the DeployPrerequisites changeset because the TokenPoolFactory is a prerequisite in itself. @@ -113,7 +116,8 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { chain := rt.Environment().BlockChains.EVMChains()[selector] // Deploy token admin registry - tokenAdminRegistry, err := cldf.DeployContract(lggr, chain, rt.State().AddressBook, + tokenAdminRegistry, err := shared.DeployContractAndRecord(lggr, chain, rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.TokenAdminRegistry, deployment.Version1_5_0), "", func(chain cldf_evm.Chain) cldf.ContractDeploy[*token_admin_registry.TokenAdminRegistry] { tokenAdminRegistryAddr, tx2, tokenAdminRegistry, err2 := token_admin_registry.DeployTokenAdminRegistry( chain.DeployerKey, @@ -124,7 +128,8 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { }) require.NoError(t, err, "failed to deploy token admin registry") // Deploy RMN proxy - rmnProxy, err := cldf.DeployContract(lggr, chain, rt.State().AddressBook, + rmnProxy, err := shared.DeployContractAndRecord(lggr, chain, rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.ARMProxy, deployment.Version1_0_0), "", func(chain cldf_evm.Chain) cldf.ContractDeploy[*rmn_proxy_contract.RMNProxy] { rmnProxyAddr, tx2, rmnProxy2, err2 := rmn_proxy_contract.DeployRMNProxy( chain.DeployerKey, @@ -139,7 +144,8 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { }) require.NoError(t, err, "failed to deploy RMN proxy") // Deploy router - _, err = cldf.DeployContract(lggr, chain, rt.State().AddressBook, + _, err = shared.DeployContractAndRecord(lggr, chain, rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.Router, deployment.Version1_2_0), "", func(chain cldf_evm.Chain) cldf.ContractDeploy[*router.Router] { routerAddr, tx2, routerC, err2 := router.DeployRouter( chain.DeployerKey, @@ -155,7 +161,8 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { }) require.NoError(t, err, "failed to deploy router") // Deploy registry module - _, err = cldf.DeployContract(lggr, chain, rt.State().AddressBook, + _, err = shared.DeployContractAndRecord(lggr, chain, rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.RegistryModule, deployment.Version1_6_0), "registry-module-0", func(chain cldf_evm.Chain) cldf.ContractDeploy[*registry_module_owner_custom.RegistryModuleOwnerCustom] { regModAddr, tx2, regMod, err2 := registry_module_owner_custom.DeployRegistryModuleOwnerCustom( chain.DeployerKey, @@ -169,6 +176,9 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { require.NoError(t, err, "failed to deploy registry module") } } + env := rt.Environment() + env.DataStore = ds.Seal() + rt = runtime.NewFromEnvironment(env) if test.MultipleRegistryModules { // Add a new registry module to each chain @@ -176,7 +186,8 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { require.NoError(t, err, "failed to load onchain state") for _, selector := range selectors { chain := rt.Environment().BlockChains.EVMChains()[selector] - _, err := cldf.DeployContract(lggr, chain, rt.State().AddressBook, + _, err := shared.DeployContractAndRecord(lggr, chain, rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.RegistryModule, deployment.Version1_6_0), "registry-module-1", func(chain cldf_evm.Chain) cldf.ContractDeploy[*registry_module_owner_custom.RegistryModuleOwnerCustom] { regModAddr, tx2, regMod, err2 := registry_module_owner_custom.DeployRegistryModuleOwnerCustom( chain.DeployerKey, @@ -188,6 +199,9 @@ func TestDeployTokenPoolFactoryChangeset(t *testing.T) { }) require.NoError(t, err, "failed to deploy registry module") } + env = rt.Environment() + env.DataStore = ds.Seal() + rt = runtime.NewFromEnvironment(env) } state, err := stateview.LoadOnchainState(rt.Environment()) diff --git a/deployment/ccip/changeset/v1_6/cs_add_lane_test.go b/deployment/ccip/changeset/v1_6/cs_add_lane_test.go index 80beb5a4cc0..52cf503d20b 100644 --- a/deployment/ccip/changeset/v1_6/cs_add_lane_test.go +++ b/deployment/ccip/changeset/v1_6/cs_add_lane_test.go @@ -67,6 +67,6 @@ func TestAddLanesWithSolana(t *testing.T) { // which adds chain1 to solana // so we can not call AddRemoteChainToSolana again with chain1 again, hence using chain2 below testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, solChain, chain2, true) - _, _, _, err = testhelpers.DeployTransferableTokenSolanaV0_1_1(e.Env.Logger, e.Env, chain1, solChain, e.Env.BlockChains.EVMChains()[chain1].DeployerKey, "MY_TOKEN") + _, _, _, err = testhelpers.DeployTransferableTokenSolanaV0_1_1(e.Env.Logger, &e.Env, chain1, solChain, e.Env.BlockChains.EVMChains()[chain1].DeployerKey, "MY_TOKEN") require.NoError(t, err) } diff --git a/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e.go b/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e.go index 8be8a327566..1ef0a7a4190 100644 --- a/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e.go +++ b/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e.go @@ -262,6 +262,12 @@ func addCandidatesForNewChainPrecondition(e cldf.Environment, c AddCandidatesFor func addCandidatesForNewChainLogic(e cldf.Environment, c AddCandidatesForNewChainConfig) (cldf.ChangesetOutput, error) { newAddresses := cldf.NewMemoryAddressBook() finalDS := datastore.NewMemoryDataStore() + workingDS := datastore.NewMemoryDataStore() + if e.DataStore != nil { + if err := workingDS.Merge(e.DataStore); err != nil { + return cldf.ChangesetOutput{}, fmt.Errorf("failed to copy environment datastore: %w", err) + } + } var allProposals []mcmslib.TimelockProposal if !c.SkipDeployments { @@ -272,7 +278,8 @@ func addCandidatesForNewChainLogic(e cldf.Environment, c AddCandidatesForNewChai } err = runAndSaveAddresses(func() (cldf.ChangesetOutput, error) { return changeset.SaveExistingContractsChangeset(e, c.NewChain.ExistingContracts) - }, newAddresses, e.ExistingAddresses, finalDS) + }, newAddresses, e.ExistingAddresses, finalDS, workingDS) + e.DataStore = workingDS.Seal() if err != nil { return cldf.ChangesetOutput{}, fmt.Errorf("failed to run SaveExistingContractsChangeset on chain with selector %d: %w", c.NewChain.Selector, err) } @@ -280,7 +287,8 @@ func addCandidatesForNewChainLogic(e cldf.Environment, c AddCandidatesForNewChai // Deploy the prerequisite contracts to the new chain err = runAndSaveAddresses(func() (cldf.ChangesetOutput, error) { return changeset.DeployPrerequisitesChangeset(e, c.prerequisiteConfigForNewChain()) - }, newAddresses, e.ExistingAddresses, finalDS) + }, newAddresses, e.ExistingAddresses, finalDS, workingDS) + e.DataStore = workingDS.Seal() if err != nil { return cldf.ChangesetOutput{}, fmt.Errorf("failed to run DeployPrerequisitesChangeset on chain with selector %d: %w", c.NewChain.Selector, err) } @@ -291,7 +299,8 @@ func addCandidatesForNewChainLogic(e cldf.Environment, c AddCandidatesForNewChai return mcmschangesets.DeployMCMSWithTimelockV2(e, map[uint64]cldfproposalutils.MCMSWithTimelockConfig{ c.NewChain.Selector: *c.MCMSDeploymentConfig, }) - }, newAddresses, e.ExistingAddresses, finalDS) + }, newAddresses, e.ExistingAddresses, finalDS, workingDS) + e.DataStore = workingDS.Seal() if err != nil { return cldf.ChangesetOutput{}, fmt.Errorf("failed to run DeployMCMSWithTimelockV2 on chain with selector %d: %w", c.NewChain.Selector, err) } @@ -300,7 +309,8 @@ func addCandidatesForNewChainLogic(e cldf.Environment, c AddCandidatesForNewChai // Deploy chain contracts to the new chain err = runAndSaveAddresses(func() (cldf.ChangesetOutput, error) { return DeployChainContractsChangeset(e, c.deploymentConfigForNewChain()) - }, newAddresses, e.ExistingAddresses, finalDS) + }, newAddresses, e.ExistingAddresses, finalDS, workingDS) + e.DataStore = workingDS.Seal() if err != nil { return cldf.ChangesetOutput{}, fmt.Errorf("failed to run DeployChainContractsChangeset on chain with selector %d: %w", c.NewChain.Selector, err) } @@ -985,7 +995,13 @@ func connectRampsAndRouters( // END ConnectNewChainChangeset // ///////////////////////////////// -func runAndSaveAddresses(fn func() (cldf.ChangesetOutput, error), newAddresses cldf.AddressBook, existingAddresses cldf.AddressBook, finalDS *datastore.MemoryDataStore) error { +func runAndSaveAddresses( + fn func() (cldf.ChangesetOutput, error), + newAddresses cldf.AddressBook, + existingAddresses cldf.AddressBook, + finalDS *datastore.MemoryDataStore, + workingDS *datastore.MemoryDataStore, +) error { output, err := fn() if err != nil { return fmt.Errorf("failed to run changeset: %w", err) @@ -1002,6 +1018,9 @@ func runAndSaveAddresses(fn func() (cldf.ChangesetOutput, error), newAddresses c if err := finalDS.Merge(output.DataStore.Seal()); err != nil { return fmt.Errorf("failed to merge child datastore: %w", err) } + if err := workingDS.Merge(output.DataStore.Seal()); err != nil { + return fmt.Errorf("failed to update working datastore: %w", err) + } } return nil diff --git a/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e_test.go b/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e_test.go index 2ec1c4c2ed0..77c23a3ed95 100644 --- a/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e_test.go +++ b/deployment/ccip/changeset/v1_6/cs_add_new_chain_e2e_test.go @@ -317,6 +317,13 @@ func TestAddAndPromoteCandidatesForNewChain(t *testing.T) { } } } + linkVersion := deployment.Version1_0_0 + require.NoError(t, ds.Addresses().Add(datastore.AddressRef{ + ChainSelector: newChainSelector, + Address: linkAddress.Hex(), + Type: datastore.ContractType(types.LinkToken), + Version: &linkVersion, + })) e.ExistingAddresses = cldf.NewMemoryAddressBookFromMap(addressesByChain) e.DataStore = ds.Seal() state, err = stateview.LoadOnchainState(e) diff --git a/deployment/ccip/changeset/v1_6/cs_ccip_home_test.go b/deployment/ccip/changeset/v1_6/cs_ccip_home_test.go index 6907deef005..f49ea4fa1ee 100644 --- a/deployment/ccip/changeset/v1_6/cs_ccip_home_test.go +++ b/deployment/ccip/changeset/v1_6/cs_ccip_home_test.go @@ -567,6 +567,7 @@ func Test_SetCandidateAcceptsUSDCTokenPoolProxyFromDataStore(t *testing.T) { proxyAddress := common.HexToAddress("0x1000000000000000000000000000000000000001") ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(tenv.Env.DataStore)) require.NoError(t, ds.Addresses().Add(datastore.AddressRef{ ChainSelector: dest, Address: proxyAddress.Hex(), @@ -597,6 +598,7 @@ func Test_SetCandidateErrorsOnDuplicateUSDCTokenPoolProxyInDataStore(t *testing. ) ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(tenv.Env.DataStore)) for i, ref := range []struct { address string qualifier string diff --git a/deployment/ccip/changeset/v1_6/cs_chain_contracts_test.go b/deployment/ccip/changeset/v1_6/cs_chain_contracts_test.go index a8c984f1a05..5b51b731685 100644 --- a/deployment/ccip/changeset/v1_6/cs_chain_contracts_test.go +++ b/deployment/ccip/changeset/v1_6/cs_chain_contracts_test.go @@ -23,6 +23,7 @@ import ( "github.com/smartcontractkit/chainlink-evm/gethwrappers/shared/generated/initial/burn_mint_erc677" cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink/deployment" @@ -1079,8 +1080,11 @@ func TestApplyFeeTokensUpdatesFeeQuoterChangeset(t *testing.T) { allChains := maps.Keys(tenv.Env.BlockChains.EVMChains()) // deploy a new token ab := cldf.NewMemoryAddressBook() + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(tenv.Env.DataStore)) for _, selector := range allChains { - _, err := cldf.DeployContract(tenv.Env.Logger, tenv.Env.BlockChains.EVMChains()[selector], ab, + _, err := shared.DeployContractAndRecord(tenv.Env.Logger, tenv.Env.BlockChains.EVMChains()[selector], ab, ds, + cldf.NewTypeAndVersion(shared.BurnMintToken, deployment.Version1_0_0), string(testhelpers.TestTokenSymbol), func(chain cldf_evm.Chain) cldf.ContractDeploy[*burn_mint_erc677.BurnMintERC677] { tokenAddress, tx, token, err := burn_mint_erc677.DeployBurnMintERC677( tenv.Env.BlockChains.EVMChains()[selector].DeployerKey, @@ -1102,6 +1106,7 @@ func TestApplyFeeTokensUpdatesFeeQuoterChangeset(t *testing.T) { require.NoError(t, err) } require.NoError(t, tenv.Env.ExistingAddresses.Merge(ab)) + tenv.Env.DataStore = ds.Seal() state, err := stateview.LoadOnchainState(tenv.Env, stateview.WithLoadLegacyContracts(true)) require.NoError(t, err) source := allChains[0] @@ -1198,7 +1203,10 @@ func TestApplyPremiumMultiplierWeiPerEthUpdatesFeeQuoterChangeset(t *testing.T) require.Contains(t, err.Error(), "token TEST not found in state for chain") // deploy test new token ab := cldf.NewMemoryAddressBook() + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(tenv.Env.DataStore)) for _, selector := range allChains { + var deployedToken common.Address _, err := cldf.DeployContract(tenv.Env.Logger, tenv.Env.BlockChains.EVMChains()[selector], ab, func(chain cldf_evm.Chain) cldf.ContractDeploy[*burn_mint_erc677.BurnMintERC677] { tokenAddress, tx, token, err := burn_mint_erc677.DeployBurnMintERC677( @@ -1209,6 +1217,7 @@ func TestApplyPremiumMultiplierWeiPerEthUpdatesFeeQuoterChangeset(t *testing.T) testhelpers.LocalTokenDecimals, big.NewInt(0).Mul(big.NewInt(1e9), big.NewInt(1e18)), ) + deployedToken = tokenAddress return cldf.ContractDeploy[*burn_mint_erc677.BurnMintERC677]{ Address: tokenAddress, Contract: token, @@ -1219,8 +1228,16 @@ func TestApplyPremiumMultiplierWeiPerEthUpdatesFeeQuoterChangeset(t *testing.T) }, ) require.NoError(t, err) + version := deployment.Version1_0_0 + require.NoError(t, ds.Addresses().Add(datastore.AddressRef{ + ChainSelector: selector, + Address: deployedToken.Hex(), + Type: datastore.ContractType(shared.BurnMintToken), + Version: &version, + })) } require.NoError(t, tenv.Env.ExistingAddresses.Merge(ab)) + tenv.Env.DataStore = ds.Seal() state, err = stateview.LoadOnchainState(tenv.Env, stateview.WithLoadLegacyContracts(true)) require.NoError(t, err) // now try to apply the changeset for TEST token @@ -1278,7 +1295,10 @@ func TestUpdateTokenPriceFeedsFeeQuoterChangeset(t *testing.T) { dest := allChains[1] // deploy a new token ab := cldf.NewMemoryAddressBook() - _, err := cldf.DeployContract(tenv.Env.Logger, tenv.Env.BlockChains.EVMChains()[source], ab, + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(tenv.Env.DataStore)) + _, err := shared.DeployContractAndRecord(tenv.Env.Logger, tenv.Env.BlockChains.EVMChains()[source], ab, ds, + cldf.NewTypeAndVersion(shared.BurnMintToken, deployment.Version1_0_0), string(testhelpers.TestTokenSymbol), func(chain cldf_evm.Chain) cldf.ContractDeploy[*burn_mint_erc677.BurnMintERC677] { tokenAddress, tx, token, err := burn_mint_erc677.DeployBurnMintERC677( tenv.Env.BlockChains.EVMChains()[source].DeployerKey, @@ -1299,6 +1319,7 @@ func TestUpdateTokenPriceFeedsFeeQuoterChangeset(t *testing.T) { ) require.NoError(t, err) require.NoError(t, tenv.Env.ExistingAddresses.Merge(ab)) + tenv.Env.DataStore = ds.Seal() state, err := stateview.LoadOnchainState(tenv.Env, stateview.WithLoadLegacyContracts(true)) require.NoError(t, err) diff --git a/deployment/ccip/changeset/v1_6/cs_home_chain_test.go b/deployment/ccip/changeset/v1_6/cs_home_chain_test.go index 6a8bee5480c..324bf9dafc6 100644 --- a/deployment/ccip/changeset/v1_6/cs_home_chain_test.go +++ b/deployment/ccip/changeset/v1_6/cs_home_chain_test.go @@ -10,6 +10,7 @@ import ( "github.com/stretchr/testify/require" cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" @@ -57,6 +58,10 @@ func TestDeployHomeChain(t *testing.T) { output, err := v1_6.DeployHomeChainChangeset(e, homeChainCfg) require.NoError(t, err) require.NoError(t, e.ExistingAddresses.Merge(output.AddressBook)) + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.DataStore)) + require.NoError(t, ds.Merge(output.DataStore.Seal())) + e.DataStore = ds.Seal() state, err := stateview.LoadOnchainState(e) require.NoError(t, err) require.NotNil(t, state.Chains[homeChainSel].CapabilityRegistry) @@ -95,7 +100,10 @@ func TestDeployHomeChainIdempotent(t *testing.T) { // apply the changeset once again to ensure idempotency output, err := v1_6.DeployHomeChainChangeset(e.Env, homeChainCfg) require.NoError(t, err) - require.NoError(t, e.Env.ExistingAddresses.Merge(output.AddressBook)) //nolint:staticcheck // will be addressed when we migrate to data store + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.Env.DataStore)) + require.NoError(t, ds.Merge(output.DataStore.Seal())) + e.Env.DataStore = ds.Seal() _, err = stateview.LoadOnchainState(e.Env) require.NoError(t, err) } diff --git a/deployment/ccip/changeset/v1_6/cs_migration_from_v1_5_test.go b/deployment/ccip/changeset/v1_6/cs_migration_from_v1_5_test.go index 436cefeec1c..92ab9b9fdf2 100644 --- a/deployment/ccip/changeset/v1_6/cs_migration_from_v1_5_test.go +++ b/deployment/ccip/changeset/v1_6/cs_migration_from_v1_5_test.go @@ -2,6 +2,7 @@ package v1_6_test import ( "math/big" + "strconv" "testing" "time" @@ -18,6 +19,7 @@ import ( "github.com/smartcontractkit/chainlink-ccip/chains/evm/gobindings/generated/v1_5_0/evm_2_evm_onramp" cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf_deploy "github.com/smartcontractkit/chainlink-deployments-framework/deployment" cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils" "github.com/smartcontractkit/chainlink-evm/pkg/utils" @@ -96,6 +98,26 @@ func initMigrationEnvironment(t *testing.T, numChains int, mcmsCfg cldfproposalu testhelpers.WithDONConfigurationSkipped(), ) e := dEnv.Env + recordRef := func(chainSelector uint64, address common.Address, tv cldf_deploy.TypeAndVersion, qualifier string) error { + ds := datastore.NewMemoryDataStore() + if e.DataStore != nil { + if err := ds.Merge(e.DataStore); err != nil { + return err + } + } + version := tv.Version + if err := ds.Addresses().Add(datastore.AddressRef{ + ChainSelector: chainSelector, + Address: address.Hex(), + Type: datastore.ContractType(tv.Type), + Version: &version, + Qualifier: qualifier, + }); err != nil { + return err + } + e.DataStore = ds.Seal() + return nil + } chainSels := e.BlockChains.ListChainSelectors(cldf_chain.WithFamily("evm")) state, err := stateview.LoadOnchainState(e, stateview.WithLoadLegacyContracts(true)) @@ -210,13 +232,14 @@ func initMigrationEnvironment(t *testing.T, numChains int, mcmsCfg cldfproposalu if err != nil { t.Fatalf("Failed to deploy PriceRegistry 1.2.0 on chain %d: %v", sel, err) } + require.NoError(t, recordRef(sel, priceRegDeploy.Address, cldf_deploy.NewTypeAndVersion(shared.PriceRegistry, deployment.Version1_2_0), "")) // Deploy one EVM2EVMOnRamp 1.5.0 & one EVM2EVMOffRamp for each of the other chains for _, otherSel := range chainSels { if otherSel == sel { continue // Skip self } - _, err = cldf_deploy.DeployContract(e.Logger, e.BlockChains.EVMChains()[sel], e.ExistingAddresses, func(chain evm.Chain) cldf_deploy.ContractDeploy[*evm_2_evm_onramp.EVM2EVMOnRamp] { + onRampDeploy, err := cldf_deploy.DeployContract(e.Logger, e.BlockChains.EVMChains()[sel], e.ExistingAddresses, func(chain evm.Chain) cldf_deploy.ContractDeploy[*evm_2_evm_onramp.EVM2EVMOnRamp] { addr, tx, onRamp, err := evm_2_evm_onramp.DeployEVM2EVMOnRamp(chain.DeployerKey, chain.Client, evm_2_evm_onramp.EVM2EVMOnRampStaticConfig{ LinkToken: state.Chains[sel].LinkToken.Address(), @@ -287,6 +310,7 @@ func initMigrationEnvironment(t *testing.T, numChains int, mcmsCfg cldfproposalu if err != nil { t.Fatalf("Failed to deploy EVM2EVMOnRamp 1.5.0 on chain %d for %d: %v", sel, otherSel, err) } + require.NoError(t, recordRef(sel, onRampDeploy.Address, cldf_deploy.NewTypeAndVersion(shared.OnRamp, deployment.Version1_5_0), strconv.FormatUint(otherSel, 10))) commitStoreDeploy, err := cldf_deploy.DeployContract(e.Logger, e.BlockChains.EVMChains()[sel], e.ExistingAddresses, func(chain evm.Chain) cldf_deploy.ContractDeploy[*commit_store.CommitStore] { addr, tx, commitStore, err := commit_store.DeployCommitStore(chain.DeployerKey, chain.Client, @@ -308,8 +332,9 @@ func initMigrationEnvironment(t *testing.T, numChains int, mcmsCfg cldfproposalu if err != nil { t.Fatalf("Failed to deploy CommitStore 1.5.0 on chain %d for %d: %v", sel, otherSel, err) } + require.NoError(t, recordRef(sel, commitStoreDeploy.Address, cldf_deploy.NewTypeAndVersion(shared.CommitStore, deployment.Version1_5_0), strconv.FormatUint(otherSel, 10))) - _, err = cldf_deploy.DeployContract(e.Logger, e.BlockChains.EVMChains()[sel], e.ExistingAddresses, func(chain evm.Chain) cldf_deploy.ContractDeploy[*evm_2_evm_offramp.EVM2EVMOffRamp] { + offRampDeploy, err := cldf_deploy.DeployContract(e.Logger, e.BlockChains.EVMChains()[sel], e.ExistingAddresses, func(chain evm.Chain) cldf_deploy.ContractDeploy[*evm_2_evm_offramp.EVM2EVMOffRamp] { addr, tx, offRamp, err := evm_2_evm_offramp.DeployEVM2EVMOffRamp(chain.DeployerKey, chain.Client, evm_2_evm_offramp.EVM2EVMOffRampStaticConfig{ CommitStore: commitStoreDeploy.Address, @@ -337,6 +362,7 @@ func initMigrationEnvironment(t *testing.T, numChains int, mcmsCfg cldfproposalu if err != nil { t.Fatalf("Failed to deploy EVM2EVMOffRamp 1.5.0 on chain %d for %d: %v", sel, otherSel, err) } + require.NoError(t, recordRef(sel, offRampDeploy.Address, cldf_deploy.NewTypeAndVersion(shared.OffRamp, deployment.Version1_5_0), strconv.FormatUint(otherSel, 10))) } } diff --git a/deployment/ccip/changeset/v1_6/cs_update_bidirectional_lanes_test.go b/deployment/ccip/changeset/v1_6/cs_update_bidirectional_lanes_test.go index c31b03436f5..2c83d737458 100644 --- a/deployment/ccip/changeset/v1_6/cs_update_bidirectional_lanes_test.go +++ b/deployment/ccip/changeset/v1_6/cs_update_bidirectional_lanes_test.go @@ -454,10 +454,10 @@ func TestUpdateBidirectionalLanesChangesetWithV2FeeQuoter(t *testing.T) { _, err = evmChain.Confirm(tx) require.NoError(t, err, "must confirm v2 FeeQuoter deployment") - // AddressBook does NOT contain FeeQuoter v2 - // Add FeeQuoter v2 only to the DataStore. The existing chain singletons (incl. the v1 - // FeeQuoter) are read from e.ExistingAddresses by CollectAddressRefs at runtime. + // AddressBook does NOT contain FeeQuoter v2. Preserve the environment datastore and add + // the extra qualified FeeQuoter ref to it. ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.DataStore)) err = ds.Addresses().Add(datastore.AddressRef{ ChainSelector: v2FQChainSel, @@ -593,10 +593,10 @@ func TestUpdateBidirectionalLanesIdempotentWithV2FeeQuoter(t *testing.T) { _, err = evmChain.Confirm(tx) require.NoError(t, err, "must confirm v2 FeeQuoter deployment") - // AddressBook does NOT contain FeeQuoter v2; add it to the DataStore only. The existing - // chain singletons (incl. the v1 FeeQuoter) are read from e.ExistingAddresses by - // CollectAddressRefs at runtime. + // AddressBook does NOT contain FeeQuoter v2. Preserve the environment datastore and add + // the extra qualified FeeQuoter ref to it. ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.DataStore)) err = ds.Addresses().Add(datastore.AddressRef{ ChainSelector: v2FQChainSel, @@ -837,10 +837,10 @@ func TestUpdateBidirectionalLanesChangesetWithV2FeeQuoterWithMCMS(t *testing.T) _, err = evmChain.Confirm(tx) require.NoError(t, err, "must confirm v2 FeeQuoter deployment") - // AddressBook does NOT contain FeeQuoter v2 - // Add FeeQuoter v2 only to the DataStore. The existing chain singletons (incl. the v1 - // FeeQuoter) are read from e.ExistingAddresses by CollectAddressRefs at runtime. + // AddressBook does NOT contain FeeQuoter v2. Preserve the environment datastore and add + // the extra qualified FeeQuoter ref to it. ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.DataStore)) err = ds.Addresses().Add(datastore.AddressRef{ ChainSelector: v2FQChainSel, diff --git a/deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy_test.go b/deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy_test.go index bbd5321c89e..e0318e33403 100644 --- a/deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy_test.go +++ b/deployment/ccip/changeset/v1_6_1/cs_transparent_upgradeable_proxy_test.go @@ -14,6 +14,7 @@ import ( "github.com/smartcontractkit/ccip-contract-examples/chains/evm/gobindings/generated/1_6_1/transparent_upgradeable_proxy" cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" chain_selectors "github.com/smartcontractkit/chain-selectors" @@ -233,8 +234,6 @@ func TestTransparentUpgradeableProxyDeploy(t *testing.T) { } func TestTransparentUpgradeableProxyGrantRoleChangesetConfig(t *testing.T) { - t.Parallel() - e, _ := testhelpers.NewMemoryEnvironment(t) evmSelectors := e.Env.BlockChains.ListChainSelectors(cldf_chain.WithFamily(chain_selectors.FamilyEVM)) chain1, chain2 := evmSelectors[0], evmSelectors[1] @@ -294,8 +293,6 @@ func TestTransparentUpgradeableProxyGrantRoleChangesetConfig(t *testing.T) { for _, tc := range tests { t.Run(tc.name, func(t *testing.T) { - t.Parallel() - for chainSelector := range tc.cfg.Tokens { chain := e.Env.BlockChains.EVMChains()[chainSelector] @@ -345,6 +342,18 @@ func TestTransparentUpgradeableProxyGrantRoleChangesetConfig(t *testing.T) { err = e.Env.ExistingAddresses.Save(chainSelector, proxy.Address().String(), cldf.NewTypeAndVersion(shared.TransparentUpgradeableProxy, deployment.Version1_6_1)) require.NoError(t, err) + + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(e.Env.DataStore)) + version := deployment.Version1_6_1 + require.NoError(t, ds.Addresses().Add(datastore.AddressRef{ + ChainSelector: chainSelector, + Address: proxy.Address().String(), + Type: datastore.ContractType(shared.TransparentUpgradeableProxy), + Version: &version, + Qualifier: tc.token, + })) + e.Env.DataStore = ds.Seal() } err := tc.cfg.Validate(e.Env) diff --git a/deployment/ccip/shared/datastore_refs.go b/deployment/ccip/shared/datastore_refs.go new file mode 100644 index 00000000000..dee03c3d79b --- /dev/null +++ b/deployment/ccip/shared/datastore_refs.go @@ -0,0 +1,78 @@ +package shared + +import ( + "fmt" + "sort" + + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" + + deployutil "github.com/smartcontractkit/chainlink-ccip/deployment/utils" +) + +// DefaultMCMSQualifier qualifies the default CCIP MCMS bundle; further bundles (RMN, +// ultra-fast-curse, operator) resolve by their own qualifier. +const DefaultMCMSQualifier = deployutil.CLLQualifier + +// MCMSBundleRefs selects the active MCMS bundle rows for one chain and qualifier. +// For the default qualifier only, an empty-qualified bundle is accepted as a legacy +// fallback: singletons (and MCMS deployed by DeployMCMSWithTimelockV2 in test +// environments) are written with the empty qualifier. A non-empty selection under the +// requested qualifier always wins; the fallback never masks a qualifier mismatch for +// dedicated bundles (RMN, ultra-fast-curse, operator). +func MCMSBundleRefs(refs []datastore.AddressRef, selector uint64, qualifier string) ([]datastore.AddressRef, error) { + active := make([]datastore.AddressRef, 0, len(refs)) + for _, ref := range refs { + if ref.ChainSelector == selector && ref.Version != nil && !ref.Labels.Contains(SupersededLabel) { + active = append(active, ref) + } + } + qualifiers := []string{qualifier} + if qualifier == DefaultMCMSQualifier { + qualifiers = append(qualifiers, "") + } + for _, q := range qualifiers { + var bundle []datastore.AddressRef + for _, ref := range active { + if ref.Qualifier == q { + bundle = append(bundle, ref) + } + } + if len(bundle) > 0 { + sort.Slice(bundle, func(i, j int) bool { + a, b := bundle[i], bundle[j] + if a.Type != b.Type { + return a.Type < b.Type + } + if a.Qualifier != b.Qualifier { + return a.Qualifier < b.Qualifier + } + return a.Address < b.Address + }) + if err := CheckRefUniqueness(bundle); err != nil { + return nil, err + } + return bundle, nil + } + } + if qualifier != DefaultMCMSQualifier { + return nil, fmt.Errorf("no mcms refs for chain %d with qualifier %q", selector, qualifier) + } + return nil, nil +} + +// SupersededLabel marks rows an operator declared historical; they never load as active contracts. +const SupersededLabel = "superseded" + +// CheckRefUniqueness rejects two active refs claiming one (type, version, qualifier) identity +// with different addresses. +func CheckRefUniqueness(refs []datastore.AddressRef) error { + seen := make(map[string]string) + for _, ref := range refs { + key := fmt.Sprintf("%s %s %s", ref.Type, ref.Version, ref.Qualifier) + if prev, dup := seen[key]; dup && prev != ref.Address { + return fmt.Errorf("%s %s qualified %q resolves to both %s and %s", ref.Type, ref.Version, ref.Qualifier, prev, ref.Address) + } + seen[key] = ref.Address + } + return nil +} diff --git a/deployment/ccip/shared/deployergroup/deployer_group.go b/deployment/ccip/shared/deployergroup/deployer_group.go index ba79d3e1221..902d19aa672 100644 --- a/deployment/ccip/shared/deployergroup/deployer_group.go +++ b/deployment/ccip/shared/deployergroup/deployer_group.go @@ -8,8 +8,6 @@ import ( "slices" "strings" - evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm" - solstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/solana" pdasol "github.com/smartcontractkit/cld-changesets/pkg/family/solana" "golang.org/x/sync/errgroup" @@ -30,6 +28,7 @@ import ( "github.com/smartcontractkit/chainlink/deployment/ccip/shared" "github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview" + solanastateview "github.com/smartcontractkit/chainlink/deployment/ccip/shared/stateview/solana" ) type DeployerGroup struct { @@ -270,22 +269,12 @@ type DeployerForSVM func(solana.PublicKey) (solana.Instruction, string, cldf.Con func (d *DeployerGroup) GetDeployerForSVM(chain uint64) (func(DeployerForSVM) (solana.Instruction, error), error) { var authority = d.e.BlockChains.SolanaChains()[chain].DeployerKey.PublicKey() - var addresses map[string]cldf.TypeAndVersion - var err error if d.mcmConfig != nil { + qualifier := shared.DefaultMCMSQualifier if d.mcmConfig.TimelockQualifierPerChain != nil && d.mcmConfig.TimelockQualifierPerChain[chain] != "" { - addresses, err = addressForChainFromDatastore(d.e, chain, d.mcmConfig.TimelockQualifierPerChain[chain]) - if err != nil { - return nil, fmt.Errorf("failed to load addresses for chain %d: %w", chain, err) - } - } else { - addresses, err = addressForChain(d.e, chain) - if err != nil { - return nil, fmt.Errorf("failed to load addresses for chain %d: %w", chain, err) - } + qualifier = d.mcmConfig.TimelockQualifierPerChain[chain] } - - mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainState(d.e.BlockChains.SolanaChains()[chain], addresses) + mcmState, err := solanastateview.LoadMCMSWithTimelockFromDataStore(&d.e, d.e.BlockChains.SolanaChains()[chain], qualifier) if err != nil { return nil, fmt.Errorf("failed to load mcm state: %w", err) } @@ -356,7 +345,7 @@ func ValidateMCMSWithState(env cldf.Environment, selector uint64, mcmConfig *cld return fmt.Errorf("mcm config is invalid for chain %d: %w", selector, err) } case chain_selectors.FamilySolana: - if err := mcmConfig.ValidateSolana(env, selector); err != nil { + if err := stateview.ValidateSolanaTimelockConfig(env, selector, mcmConfig); err != nil { return fmt.Errorf("mcm config is invalid for chain %d: %w", selector, err) } case chain_selectors.FamilyTon: @@ -516,22 +505,16 @@ func BuildTimelockAddressPerChain(e cldf.Environment, onchainState stateview.CCI addressPerChain[chain.Selector] = onchainState.MustGetEVMChainState(chain.Selector).Timelock.Address().Hex() } - // TODO: This should come from the Solana chain state which should be enhanced to contain timlock and MCMS address + // TODO: expose MCMS addresses in the Solana chain state. for selector, chain := range e.BlockChains.SolanaChains() { - var addresses map[string]cldf.TypeAndVersion - var err error - // if we have a qualifier, we load the address from datastore - // this is useful when we want to use a different timelock than the one in the onchain state - // e.g. when a specific contract is owned by a different timelock + qualifier := shared.DefaultMCMSQualifier if addressQualifierPerChain != nil && addressQualifierPerChain[selector] != "" { - addresses, err = addressForChainFromDatastore(e, selector, addressQualifierPerChain[selector]) - } else { - addresses, err = addressForChain(e, selector) + qualifier = addressQualifierPerChain[selector] } + mcmState, err := solanastateview.LoadMCMSWithTimelockFromDataStore(&e, chain, qualifier) if err != nil { return nil, fmt.Errorf("failed to load addresses for chain %d: %w", selector, err) } - mcmState, _ := solstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses) addressPerChain[selector] = mcmsSolana.ContractAddress(mcmState.TimelockProgram, mcmsSolana.PDASeed(mcmState.TimelockSeed)) } @@ -551,28 +534,16 @@ func BuildMcmAddressesPerChainByAction(e cldf.Environment, onchainState statevie addressPerChain[chain.Selector] = mcmContract.Address().Hex() } - // TODO: This should come from the Solana chain state which should be enhanced to contain timlock and MCMS address + // TODO: expose MCMS addresses in the Solana chain state. for selector, chain := range e.BlockChains.SolanaChains() { - var addresses map[string]cldf.TypeAndVersion - var err error - // if we have a qualifier, we load the address from datastore - // this is useful when we want to use a different mcm than the one in the onchain state - // e.g. when a specific contract is owned by a different mcm + qualifier := shared.DefaultMCMSQualifier if mcmQualifier != nil && mcmQualifier[selector] != "" { - addresses, err = addressForChainFromDatastore(e, selector, mcmQualifier[selector]) - } else { - addresses, err = addressForChain(e, selector) - } - if err != nil { - return nil, fmt.Errorf("failed to load addresses for chain %d: %w", selector, err) + qualifier = mcmQualifier[selector] } + mcmState, err := solanastateview.LoadMCMSWithTimelockFromDataStore(&e, chain, qualifier) if err != nil { return nil, fmt.Errorf("failed to load addresses for chain %d: %w", selector, err) } - mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses) - if err != nil { - return nil, fmt.Errorf("failed to load mcm state: %w", err) - } address, err := mcmCfg.MCMBasedOnActionSolana(*mcmState) if err != nil { return nil, fmt.Errorf("failed to get mcms for action %s (chain: %d): %w", mcmCfg.MCMSAction, selector, err) @@ -582,11 +553,3 @@ func BuildMcmAddressesPerChainByAction(e cldf.Environment, onchainState statevie return addressPerChain, nil } - -func addressForChain(e cldf.Environment, selector uint64) (map[string]cldf.TypeAndVersion, error) { - return e.ExistingAddresses.AddressesForChain(selector) -} - -func addressForChainFromDatastore(e cldf.Environment, selector uint64, qualifier string) (map[string]cldf.TypeAndVersion, error) { - return evmstate.LoadAddressesFromDataStore(e.DataStore, selector, qualifier) //nolint:staticcheck // will be refactored once usages are removed -} diff --git a/deployment/ccip/shared/helpers.go b/deployment/ccip/shared/helpers.go index d5e37b0e4a2..739054280f1 100644 --- a/deployment/ccip/shared/helpers.go +++ b/deployment/ccip/shared/helpers.go @@ -2,7 +2,9 @@ package shared import ( "context" + "errors" "fmt" + "strconv" "strings" "github.com/Masterminds/semver/v3" @@ -100,12 +102,14 @@ func ResolveFeeQuoterAddressAndVersion( if ref.Type != datastore.ContractType(fqv2ops.ContractType) { continue } - if ref.Version == nil { + if ref.Version == nil || ref.Labels.Contains(SupersededLabel) { continue } if bestVersion == nil || ref.Version.GreaterThan(bestVersion) { bestVersion = ref.Version bestRef = ref + } else if ref.Version.Equal(bestVersion) && ref.Address != bestRef.Address { + return common.Address{}, semver.Version{}, fmt.Errorf("ambiguous fee quoter %s on chain %d: found at %s and %s", ref.Version, chainSel, bestRef.Address, ref.Address) } } @@ -120,6 +124,19 @@ func ResolveFeeQuoterAddressAndVersion( return common.HexToAddress(bestRef.Address), *bestVersion, nil } +// CollectDataStoreRefs returns the environment datastore's refs unkeyed, like +// CollectAddressRefs but without the address book leg. +func CollectDataStoreRefs(e deployment.Environment) ([]datastore.AddressRef, error) { + if e.DataStore == nil { + return nil, errors.New("datastore not available") + } + refs, err := e.DataStore.Addresses().Fetch() + if err != nil { + return nil, fmt.Errorf("failed to fetch address refs from environment datastore: %w", err) + } + return refs, nil +} + // CollectAddressRefs returns a plain (unkeyed) slice of address refs drawn from both the // environment's datastore and its existing address book, including labels. It does not key or // dedup, so duplicate/multi-instance refs are all retained. Use it to resolve chain-singleton @@ -173,13 +190,65 @@ func QualifierFromParts(parts ...string) string { return strings.Join(quoted, "/") } +// ParseQualifierParts decodes a qualifier written by QualifierFromParts. It also accepts the +// historical unquoted form so existing datastore entries remain readable during the migration. +func ParseQualifierParts(qualifier string) ([]string, error) { + if qualifier == "" { + return nil, nil + } + if qualifier[0] != '"' { + return strings.Split(qualifier, "/"), nil + } + + var parts []string + for remaining := qualifier; remaining != ""; { + if remaining[0] != '"' { + return nil, fmt.Errorf("invalid qualifier %q: expected quoted part", qualifier) + } + + closingQuote := -1 + escaped := false + for i := 1; i < len(remaining); i++ { + switch { + case escaped: + escaped = false + case remaining[i] == '\\': + escaped = true + case remaining[i] == '"': + closingQuote = i + } + if closingQuote >= 0 { + break + } + } + if closingQuote < 0 { + return nil, fmt.Errorf("invalid qualifier %q: unterminated quoted part", qualifier) + } + + part, err := strconv.Unquote(remaining[:closingQuote+1]) + if err != nil { + return nil, fmt.Errorf("invalid qualifier %q: %w", qualifier, err) + } + parts = append(parts, part) + + remaining = remaining[closingQuote+1:] + if remaining == "" { + break + } + if remaining[0] != '/' { + return nil, fmt.Errorf("invalid qualifier %q: expected separator", qualifier) + } + remaining = remaining[1:] + } + return parts, nil +} + // TokenPoolLookupTableQualifier returns the datastore qualifier for a Solana token-pool lookup // table, which is uniquely identified by (token mint, pool type, metadata). // // Each component is quoted rather than joined on a bare separator. metadata is caller-supplied // free-form text, so a plain "a/b/c" join would let ("A", "B/C") and ("A/B", "C") produce the same -// qualifier and collide in the datastore. Quoting escapes any separator inside a component, so -// distinct inputs always yield distinct qualifiers. +// qualifier and collide in the datastore. ParseQualifierParts restores the component boundaries. func TokenPoolLookupTableQualifier(tokenPubKey, poolType, metadata string) string { return QualifierFromParts(tokenPubKey, poolType, metadata) } diff --git a/deployment/ccip/shared/helpers_test.go b/deployment/ccip/shared/helpers_test.go new file mode 100644 index 00000000000..bce5186de9c --- /dev/null +++ b/deployment/ccip/shared/helpers_test.go @@ -0,0 +1,36 @@ +package shared + +import ( + "testing" + + "github.com/Masterminds/semver/v3" + "github.com/stretchr/testify/require" + + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" +) + +func TestResolveFeeQuoterAddressAndVersion(t *testing.T) { + version := semver.MustParse("2.0.0") + older := semver.MustParse("1.6.0") + refs := []datastore.AddressRef{ + {ChainSelector: 1, Type: datastore.ContractType("FeeQuoter"), Version: older, Address: "0x0000000000000000000000000000000000000001"}, + {ChainSelector: 1, Type: datastore.ContractType("FeeQuoter"), Version: version, Address: "0x0000000000000000000000000000000000000002"}, + {ChainSelector: 1, Type: datastore.ContractType("FeeQuoter"), Version: version, Address: "0x0000000000000000000000000000000000000003", Labels: datastore.NewLabelSet(SupersededLabel)}, + } + + address, gotVersion, err := ResolveFeeQuoterAddressAndVersion(refs, 1) + require.NoError(t, err) + require.Equal(t, "0x0000000000000000000000000000000000000002", address.Hex()) + require.Equal(t, *version, gotVersion) +} + +func TestResolveFeeQuoterAddressAndVersionRejectsAmbiguity(t *testing.T) { + version := semver.MustParse("2.0.0") + refs := []datastore.AddressRef{ + {ChainSelector: 1, Type: datastore.ContractType("FeeQuoter"), Version: version, Address: "0x0000000000000000000000000000000000000002"}, + {ChainSelector: 1, Type: datastore.ContractType("FeeQuoter"), Version: version, Address: "0x0000000000000000000000000000000000000003"}, + } + + _, _, err := ResolveFeeQuoterAddressAndVersion(refs, 1) + require.ErrorContains(t, err, "ambiguous fee quoter") +} diff --git a/deployment/ccip/shared/qualifier_test.go b/deployment/ccip/shared/qualifier_test.go index 5feabf5b6bb..c401a886966 100644 --- a/deployment/ccip/shared/qualifier_test.go +++ b/deployment/ccip/shared/qualifier_test.go @@ -29,3 +29,16 @@ func TestTokenPoolLookupTableQualifierIsUnambiguous(t *testing.T) { TokenPoolLookupTableQualifier(mint, "BurnMintTokenPool/a", "b"), ) } + +func TestParseQualifierParts(t *testing.T) { + t.Parallel() + parts := []string{"mint/with/slashes", `pool"type`, "metadata\\with/slashes"} + qualifier := QualifierFromParts(parts...) + decoded, err := ParseQualifierParts(qualifier) + require.NoError(t, err) + require.Equal(t, parts, decoded) + + decoded, err = ParseQualifierParts("mint/pool/metadata") + require.NoError(t, err) + require.Equal(t, []string{"mint", "pool", "metadata"}, decoded) +} diff --git a/deployment/ccip/shared/stateview/datastore_state.go b/deployment/ccip/shared/stateview/datastore_state.go new file mode 100644 index 00000000000..871f7dc402b --- /dev/null +++ b/deployment/ccip/shared/stateview/datastore_state.go @@ -0,0 +1,175 @@ +package stateview + +import ( + "fmt" + "sort" + + ccipshared "github.com/smartcontractkit/chainlink/deployment/ccip/shared" + + "github.com/smartcontractkit/ccip-owner-contracts/gethwrappers" + evmstate "github.com/smartcontractkit/cld-changesets/legacy/pkg/family/evm" + + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" + cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" +) + +// Aliases of the shared datastore helpers. +const ( + DefaultMCMSQualifier = ccipshared.DefaultMCMSQualifier + SupersededLabel = ccipshared.SupersededLabel +) + +// isActiveRef reports whether a ref may load into chain state. +func isActiveRef(ref datastore.AddressRef) bool { + return ref.Version != nil && !ref.Labels.Contains(SupersededLabel) +} + +// AddressRefsToTypeVersions reshapes refs into the slice-per-address form LoadChainState +// consumes, preserving labels and skipping versionless refs. +func AddressRefsToTypeVersions(refs []datastore.AddressRef) map[string][]cldf.TypeAndVersion { + addresses := make(map[string][]cldf.TypeAndVersion) + for _, ref := range refs { + if ref.Version == nil { + continue + } + tv := cldf.TypeAndVersion{ + Type: cldf.ContractType(ref.Type), + Version: *ref.Version, + } + if !ref.Labels.IsEmpty() { + tv.Labels = cldf.NewLabelSet(ref.Labels.List()...) + } + addresses[ref.Address] = append(addresses[ref.Address], tv) + } + return addresses +} + +func dataStoreRefsForChain(e cldf.Environment, selector uint64) ([]datastore.AddressRef, error) { + if e.DataStore == nil { + return nil, fmt.Errorf("datastore not available for chain %d", selector) + } + refs, err := e.DataStore.Addresses().Fetch() + if err != nil { + return nil, fmt.Errorf("failed to fetch address refs from datastore: %w", err) + } + chainRefs := make([]datastore.AddressRef, 0, len(refs)) + for _, ref := range refs { + if ref.ChainSelector == selector && isActiveRef(ref) { + chainRefs = append(chainRefs, ref) + } + } + if err := ccipshared.CheckRefUniqueness(chainRefs); err != nil { + return nil, fmt.Errorf("chain %d datastore is ambiguous: %w", selector, err) + } + return chainRefs, nil +} + +// DataStoreTypeVersionsForChain returns the chain's active refs in slice-per-address form. +// It fails when two active refs claim the same (type, version, qualifier) identity. +func DataStoreTypeVersionsForChain(e cldf.Environment, selector uint64) (map[string][]cldf.TypeAndVersion, error) { + refs, err := dataStoreRefsForChain(e, selector) + if err != nil { + return nil, err + } + return AddressRefsToTypeVersions(refs), nil +} + +// TypeVersionsToSlices reshapes a flat address→TypeAndVersion map into the slice-per-address +// form LoadChainState consumes. +func TypeVersionsToSlices(addresses map[string]cldf.TypeAndVersion) map[string][]cldf.TypeAndVersion { + sliced := make(map[string][]cldf.TypeAndVersion, len(addresses)) + for addr, tv := range addresses { + sliced[addr] = append(sliced[addr], tv) + } + return sliced +} + +// flattenTypeVersions collapses the slice-per-address form back to one TypeAndVersion per +// address, for helpers that still consume the address-book shape. +func flattenTypeVersions(addresses map[string][]cldf.TypeAndVersion) map[string]cldf.TypeAndVersion { + flat := make(map[string]cldf.TypeAndVersion, len(addresses)) + for addr, tvs := range addresses { + if len(tvs) > 0 { + flat[addr] = tvs[0] + } + } + return flat +} + +// loadMCMSWithTimelockForChain resolves the MCMS bundle for one chain from the datastore. +// Qualifier-isolated: only the requested qualifier is loaded. +func loadMCMSWithTimelockForChain(e cldf.Environment, selector uint64, qualifier string) (*evmstate.MCMSWithTimelockState, error) { + chain, ok := e.BlockChains.EVMChains()[selector] + if !ok { + return nil, fmt.Errorf("chain %d not found", selector) + } + if e.DataStore == nil { + return nil, fmt.Errorf("datastore not available for chain %d", selector) + } + refs, err := e.DataStore.Addresses().Fetch() + if err != nil { + return nil, fmt.Errorf("failed to fetch address refs from datastore: %w", err) + } + bundle, err := ccipshared.MCMSBundleRefs(refs, selector, qualifier) + if err != nil { + return nil, fmt.Errorf("failed to resolve mcms bundle for chain %d with qualifier %s: %w", selector, qualifier, err) + } + if len(bundle) == 0 { + return &evmstate.MCMSWithTimelockState{}, nil + } + state, err := evmstate.MaybeLoadMCMSWithTimelockChainStateFromRefs(chain, bundle) + if err != nil { + return nil, fmt.Errorf("failed to load mcms state from datastore for chain %d with qualifier %s: %w", selector, qualifier, err) + } + return state, nil +} + +// applyMCMSWithTimelockState writes a loaded MCMS state into the chain state, keeping the ABI +// registry in sync. +func (c CCIPOnChainState) applyMCMSWithTimelockState(selector uint64, mcmsState *evmstate.MCMSWithTimelockState) { + if mcmsState == nil { + return + } + chainState, ok := c.EVMChainState(selector) + if !ok { + return + } + chainState.MCMSWithTimelockState = *mcmsState + if mcmsState.ProposerMcm != nil { + chainState.ABIByAddress[mcmsState.ProposerMcm.Address().Hex()] = gethwrappers.ManyChainMultiSigABI + } + if mcmsState.CancellerMcm != nil { + chainState.ABIByAddress[mcmsState.CancellerMcm.Address().Hex()] = gethwrappers.ManyChainMultiSigABI + } + if mcmsState.BypasserMcm != nil { + chainState.ABIByAddress[mcmsState.BypasserMcm.Address().Hex()] = gethwrappers.ManyChainMultiSigABI + } + if mcmsState.Timelock != nil { + chainState.ABIByAddress[mcmsState.Timelock.Address().Hex()] = gethwrappers.RBACTimelockABI + } + if mcmsState.CallProxy != nil { + chainState.ABIByAddress[mcmsState.CallProxy.Address().Hex()] = gethwrappers.CallProxyABI + } + c.WriteEVMChainState(selector, chainState) +} + +// sortAddressRefs orders refs deterministically (chain, type, version, qualifier, address) so +// callers that pick one ref from many never depend on map iteration order. +func sortAddressRefs(refs []datastore.AddressRef) { + sort.Slice(refs, func(i, j int) bool { + a, b := refs[i], refs[j] + if a.ChainSelector != b.ChainSelector { + return a.ChainSelector < b.ChainSelector + } + if a.Type != b.Type { + return a.Type < b.Type + } + if a.Version != nil && b.Version != nil && !a.Version.Equal(b.Version) { + return a.Version.LessThan(b.Version) + } + if a.Qualifier != b.Qualifier { + return a.Qualifier < b.Qualifier + } + return a.Address < b.Address + }) +} diff --git a/deployment/ccip/shared/stateview/datastore_state_test.go b/deployment/ccip/shared/stateview/datastore_state_test.go new file mode 100644 index 00000000000..eae92077673 --- /dev/null +++ b/deployment/ccip/shared/stateview/datastore_state_test.go @@ -0,0 +1,283 @@ +package stateview + +import ( + "testing" + + "github.com/Masterminds/semver/v3" + "github.com/ethereum/go-ethereum/common" + "github.com/gagliardetto/solana-go" + "github.com/stretchr/testify/require" + + mcmsolana "github.com/smartcontractkit/mcms/sdk/solana" + mcmstypes "github.com/smartcontractkit/mcms/types" + + cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" + cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" + mcmscontracts "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/contracts/mcms" + cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils" + + "github.com/smartcontractkit/ccip-owner-contracts/gethwrappers" + + "github.com/smartcontractkit/chainlink/deployment" + ccipshared "github.com/smartcontractkit/chainlink/deployment/ccip/shared" + commontypes "github.com/smartcontractkit/chainlink/deployment/common/types" +) + +func testRef(chainSel uint64, addr string, t cldf.ContractType, ver *semver.Version, qualifier string, labels ...string) datastore.AddressRef { + ref := datastore.AddressRef{ + ChainSelector: chainSel, + Address: addr, + Type: datastore.ContractType(t), + Qualifier: qualifier, + } + if ver != nil { + v := *ver + ref.Version = &v + } + if len(labels) > 0 { + ref.Labels = datastore.NewLabelSet(labels...) + } + return ref +} + +func TestAddressRefsToTypeVersions(t *testing.T) { + v16 := deployment.Version1_6_0 + refs := []datastore.AddressRef{ + testRef(1, "0xA", "OnRamp", &v16, "123", "someLabel"), + testRef(1, "0xB", "WETH9", nil, ""), // versionless: skipped + } + got := AddressRefsToTypeVersions(refs) + require.Len(t, got, 1) + tvs := got["0xA"] + require.Len(t, tvs, 1) + require.Equal(t, "1.6.0", tvs[0].Version.String()) + require.True(t, tvs[0].Labels.Contains("someLabel")) +} + +func TestDataStoreTypeVersionsForChain_FiltersAndUniqueness(t *testing.T) { + v16 := deployment.Version1_6_0 + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Addresses().Add(testRef(1, "0xA", "Router", &v16, "", "legacy"))) + // the superseded twin lives under its pre-rekey qualifier (the store keys by + // (chain, type, version, qualifier)) + require.NoError(t, ds.Addresses().Add(testRef(1, "0xB", "Router", &v16, "old", SupersededLabel))) + require.NoError(t, ds.Addresses().Add(testRef(2, "0xD", "Router", &v16, ""))) // other chain + + got, err := DataStoreTypeVersionsForChain(cldf.Environment{DataStore: ds.Seal()}, 1) + require.NoError(t, err) + require.Contains(t, got, "0xA") + require.NotContains(t, got, "0xB") // superseded + require.NotContains(t, got, "0xD") // other chain + // versionless refs cannot even be Added here; AddressRefsToTypeVersions skips them + + // two active refs claiming one (type, version, qualifier) identity with different + // addresses — unreachable through this store's Add, possible in hand-loaded stores + err = ccipshared.CheckRefUniqueness([]datastore.AddressRef{ + testRef(1, "0xA", "Router", &v16, ""), + testRef(1, "0xB", "Router", &v16, ""), + }) + require.ErrorContains(t, err, "0xA") + require.ErrorContains(t, err, "0xB") + + // same (type, version) under different qualifiers is legitimate + ds3 := datastore.NewMemoryDataStore() + require.NoError(t, ds3.Addresses().Add(testRef(1, "0xA", "FeeQuoter", &v16, "instA"))) + require.NoError(t, ds3.Addresses().Add(testRef(1, "0xB", "FeeQuoter", &v16, "instB"))) + got, err = DataStoreTypeVersionsForChain(cldf.Environment{DataStore: ds3.Seal()}, 1) + require.NoError(t, err) + require.Len(t, got, 2) +} + +func TestMCMSBundleRefs_Isolation(t *testing.T) { + v10 := deployment.Version1_0_0 + refs := []datastore.AddressRef{ + testRef(1, "0xQualifiedTimelock", mcmscontracts.RBACTimelock, &v10, DefaultMCMSQualifier), + testRef(1, "0xQualifiedProposer", mcmscontracts.ProposerManyChainMultisig, &v10, DefaultMCMSQualifier), + testRef(1, "0xEmptyTimelock", mcmscontracts.RBACTimelock, &v10, ""), + testRef(1, "0xEmptyCallProxy", mcmscontracts.CallProxy, &v10, ""), + testRef(1, "0xVersionless", mcmscontracts.RBACTimelock, nil, DefaultMCMSQualifier), + testRef(1, "0xSuperseded", mcmscontracts.CallProxy, &v10, DefaultMCMSQualifier, SupersededLabel), + } + + bundle, err := ccipshared.MCMSBundleRefs(refs, 1, DefaultMCMSQualifier) + require.NoError(t, err) + require.Len(t, bundle, 2) // qualified rows only; versionless and superseded dropped + for _, ref := range bundle { + require.Equal(t, DefaultMCMSQualifier, ref.Qualifier) + } + + // custom qualifier with no rows fails closed — no empty-qualifier fallback + _, err = ccipshared.MCMSBundleRefs(refs, 1, "RMNMCMS") + require.ErrorContains(t, err, "no mcms refs for chain 1") + + // default qualifier with no rows yields an empty bundle (MaybeLoad semantics) + bundle, err = ccipshared.MCMSBundleRefs(refs, 7, DefaultMCMSQualifier) + require.NoError(t, err) + require.Empty(t, bundle) + + // An unqualified bundle IS the legacy fallback for the default qualifier + // (singletons and DeployMCMSWithTimelockV2 test deployments are empty-qualified); + // dedicated bundles (RMNMCMS etc.) never fall back. + emptyOnly := []datastore.AddressRef{testRef(1, "0xEmptyOnly", mcmscontracts.RBACTimelock, &v10, "")} + bundle, err = ccipshared.MCMSBundleRefs(emptyOnly, 1, DefaultMCMSQualifier) + require.NoError(t, err) + require.Len(t, bundle, 1) + require.Empty(t, bundle[0].Qualifier) + + // the fallback never fires for a custom qualifier + _, err = ccipshared.MCMSBundleRefs(emptyOnly, 1, "RMNMCMS") + require.ErrorContains(t, err, "no mcms refs for chain 1") + + // two active refs, one identity + dup := append([]datastore.AddressRef(nil), refs...) + dup = append(dup, testRef(1, "0xQualifiedTimelock2", mcmscontracts.RBACTimelock, &v10, DefaultMCMSQualifier)) + _, err = ccipshared.MCMSBundleRefs(dup, 1, DefaultMCMSQualifier) + require.ErrorContains(t, err, "both") +} + +func TestLoadChainState_LabeledRefDispatch(t *testing.T) { + // A labeled ref must dispatch like its unlabeled twin; String() would fold the label in. + chain := cldf_evm.Chain{Selector: 1} + addr := "0x00000000000000000000000000000000000000Ab" + addresses := map[string][]cldf.TypeAndVersion{ + addr: { + {Type: commontypes.RBACTimelock, Version: deployment.Version1_0_0, Labels: cldf.NewLabelSet("someLabel")}, + }, + } + state, err := LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier)) + require.NoError(t, err) + require.Equal(t, gethwrappers.RBACTimelockABI, state.ABIByAddress[addr]) +} + +func TestLoadChainState_SingularAmbiguity(t *testing.T) { + chain := cldf_evm.Chain{Selector: 1} + v12 := deployment.Version1_2_0 + refs := []datastore.AddressRef{ + {Address: "0x00000000000000000000000000000000000000A1", ChainSelector: 1, Type: datastore.ContractType("Router"), Version: &v12}, + {Address: "0x00000000000000000000000000000000000000B2", ChainSelector: 1, Type: datastore.ContractType("Router"), Version: &v12, Labels: datastore.NewLabelSet("other")}, + } + _, err := loadChainStateFromDataStore(t.Context(), chain, refs, WithMCMSQualifier(DefaultMCMSQualifier)) + require.ErrorContains(t, err, "datastore is ambiguous") +} + +func TestLoadChainState_UnmodeledDuplicatesSkipped(t *testing.T) { + // types the loader does not model are skipped in datastore mode, duplicates included — + // they load nowhere, so multiplicity cannot corrupt state + chain := cldf_evm.Chain{Selector: 1} + addresses := map[string][]cldf.TypeAndVersion{ + "0x00000000000000000000000000000000000000A1": {{Type: "BurnMintERC20WithDripToken", Version: deployment.Version1_0_0}}, + "0x00000000000000000000000000000000000000B2": {{Type: "BurnMintERC20WithDripToken", Version: deployment.Version1_0_0}}, + "0x00000000000000000000000000000000000000C3": {{Type: "BurnMintERC20WithDripToken", Version: deployment.Version1_0_0}}, + } + _, err := LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier), WithTolerateUnknownContractTypes()) + require.NoError(t, err) + + // without tolerance the unknown type still errors + _, err = LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier)) + require.ErrorContains(t, err, "unknown contract") +} + +func TestLoadChainState_RegistryModuleOrderDeterministic(t *testing.T) { + // RegistryModule appends in sorted address order, not map order + chain := cldf_evm.Chain{Selector: 1} + addresses := map[string][]cldf.TypeAndVersion{ + "0x00000000000000000000000000000000000000B2": {{Type: "RegistryModuleOwnerCustom", Version: deployment.Version1_6_0}}, + "0x00000000000000000000000000000000000000A1": {{Type: "RegistryModuleOwnerCustom", Version: deployment.Version1_6_0}}, + } + state, err := LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier)) + require.NoError(t, err) + require.Len(t, state.RegistryModules1_6, 2) + require.Equal(t, common.HexToAddress("0x00000000000000000000000000000000000000A1"), state.RegistryModules1_6[0].Address()) + require.Equal(t, common.HexToAddress("0x00000000000000000000000000000000000000B2"), state.RegistryModules1_6[1].Address()) +} + +func TestLoadChainState_PerTokenProxyDeterministic(t *testing.T) { + // USDCTokenPoolProxy is per-token multi-instance in the datastore; the legacy state keeps + // one deterministically (sorted order — here the address-book's own pick) + chain := cldf_evm.Chain{Selector: 1} + v20 := deployment.Version2_0_0 + addresses := map[string][]cldf.TypeAndVersion{ + "0x00000000000000000000000000000000000000B2": {{Type: "USDCTokenPoolProxy", Version: v20}}, + "0x00000000000000000000000000000000000000A1": {{Type: "USDCTokenPoolProxy", Version: v20}}, + } + state, err := LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier)) + require.NoError(t, err) + require.Equal(t, common.HexToAddress("0x00000000000000000000000000000000000000B2"), state.USDCTokenPoolProxies[deployment.Version2_0_0]) +} + +func TestLoadChainState_FeeQuoterEqualVersionAmbiguity(t *testing.T) { + chain := cldf_evm.Chain{Selector: 1} + v16 := deployment.Version1_6_0 + addresses := map[string][]cldf.TypeAndVersion{ + "0x00000000000000000000000000000000000000A1": {{Type: "FeeQuoter", Version: v16}}, + "0x00000000000000000000000000000000000000B2": {{Type: "FeeQuoter", Version: v16}}, + } + _, err := LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier)) + require.ErrorContains(t, err, "ambiguous FeeQuoter 1.6.0") + + // different versions still select the highest (MultipleFeeQuoters semantics) + addresses = map[string][]cldf.TypeAndVersion{ + "0x00000000000000000000000000000000000000A1": {{Type: "FeeQuoter", Version: v16}}, + "0x00000000000000000000000000000000000000B2": {{Type: "FeeQuoter", Version: deployment.Version1_2_0}}, + } + state, err := LoadChainState(t.Context(), chain, addresses, WithMCMSQualifier(DefaultMCMSQualifier)) + require.NoError(t, err) + require.Equal(t, common.HexToAddress("0x00000000000000000000000000000000000000A1"), state.FeeQuoter.Address()) +} + +func TestValidateSolanaTimelockConfig(t *testing.T) { + program := solana.MustPublicKeyFromBase58("9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM") + valid := mcmsolana.ContractAddress(program, mcmsolana.PDASeed{1, 2, 3}) + v16 := deployment.Version1_6_0 + + // configured qualifier resolves its own bundle, ignoring the default-qualified decoy + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Addresses().Add(testRef(1, valid, mcmscontracts.RBACTimelock, &v16, "RMNMCMS"))) + require.NoError(t, ds.Addresses().Add(testRef(1, valid, mcmscontracts.ProposerManyChainMultisig, &v16, "RMNMCMS"))) + require.NoError(t, ds.Addresses().Add(testRef(1, "not-a-program-address", mcmscontracts.RBACTimelock, &v16, DefaultMCMSQualifier))) + tc := &cldfproposalutils.TimelockConfig{TimelockQualifierPerChain: map[uint64]string{1: "RMNMCMS"}} + require.NoError(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: ds.Seal()}, 1, tc)) + + // default qualifier, action-specific contract; empty action defaults in place + // (framework validateCommon contract) + ds2 := datastore.NewMemoryDataStore() + require.NoError(t, ds2.Addresses().Add(testRef(1, valid, mcmscontracts.RBACTimelock, &v16, DefaultMCMSQualifier))) + require.NoError(t, ds2.Addresses().Add(testRef(1, valid, mcmscontracts.BypasserManyChainMultisig, &v16, DefaultMCMSQualifier))) + require.NoError(t, ds2.Addresses().Add(testRef(1, valid, mcmscontracts.ProposerManyChainMultisig, &v16, DefaultMCMSQualifier))) + tc2 := &cldfproposalutils.TimelockConfig{MCMSAction: mcmstypes.TimelockActionBypass} + require.NoError(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: ds2.Seal()}, 1, tc2)) + + tcDefault := &cldfproposalutils.TimelockConfig{} + require.NoError(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: ds2.Seal()}, 1, tcDefault)) + require.Equal(t, mcmstypes.TimelockActionSchedule, tcDefault.MCMSAction) + + // The default bundle may be stored without a qualifier by legacy deployments. + dsEmptyDefault := datastore.NewMemoryDataStore() + require.NoError(t, dsEmptyDefault.Addresses().Add(testRef(1, valid, mcmscontracts.RBACTimelock, &v16, ""))) + require.NoError(t, dsEmptyDefault.Addresses().Add(testRef(1, valid, mcmscontracts.ProposerManyChainMultisig, &v16, ""))) + require.NoError(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: dsEmptyDefault.Seal()}, 1, &cldfproposalutils.TimelockConfig{})) + + // Custom qualifiers remain strict and do not fall back to the unqualified bundle. + tcEmptyCustom := &cldfproposalutils.TimelockConfig{TimelockQualifierPerChain: map[uint64]string{1: "RMNMCMS"}} + require.Error(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: dsEmptyDefault.Seal()}, 1, tcEmptyCustom)) + + // missing contract + _, err := dataStoreSolanaContractAddress(cldf.Environment{DataStore: ds2.Seal()}, 1, mcmscontracts.CancellerManyChainMultisig, DefaultMCMSQualifier) + require.ErrorContains(t, err, "no CancellerManyChainMultiSig ref") + + // superseded refs are invisible + ds3 := datastore.NewMemoryDataStore() + require.NoError(t, ds3.Addresses().Add(testRef(1, valid, mcmscontracts.RBACTimelock, &v16, DefaultMCMSQualifier, SupersededLabel))) + _, err = dataStoreSolanaContractAddress(cldf.Environment{DataStore: ds3.Seal()}, 1, mcmscontracts.RBACTimelock, DefaultMCMSQualifier) + require.ErrorContains(t, err, "no RBACTimelock ref") + + // nil config and invalid action + require.Error(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: ds2.Seal()}, 1, nil)) + tcBad := &cldfproposalutils.TimelockConfig{MCMSAction: "nope"} + require.ErrorContains(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: ds2.Seal()}, 1, tcBad), "invalid MCMS action") + + // configured qualifier that holds nothing errors (strict, no fallback) + tc4 := &cldfproposalutils.TimelockConfig{TimelockQualifierPerChain: map[uint64]string{1: "OTHER"}} + require.Error(t, ValidateSolanaTimelockConfig(cldf.Environment{DataStore: ds2.Seal()}, 1, tc4)) +} diff --git a/deployment/ccip/shared/stateview/solana/state.go b/deployment/ccip/shared/stateview/solana/state.go index ce07aac821d..395b5cacbbe 100644 --- a/deployment/ccip/shared/stateview/solana/state.go +++ b/deployment/ccip/shared/stateview/solana/state.go @@ -4,6 +4,7 @@ import ( "context" "errors" "fmt" + "sort" "strconv" "github.com/Masterminds/semver/v3" @@ -29,6 +30,7 @@ import ( solState "github.com/smartcontractkit/chainlink-ccip/chains/solana/utils/state" solTokenUtil "github.com/smartcontractkit/chainlink-ccip/chains/solana/utils/tokens" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink/deployment/ccip/shared" @@ -71,6 +73,59 @@ type CCIPChainState struct { RMNRemoteCursesPDA solana.PublicKey } +// canonicalSolanaType maps contract-type aliases that populate the same state slot. +func canonicalSolanaType(contractType cldf.ContractType) cldf.ContractType { + if contractType == shared.TestReceiver { + return shared.Receiver + } + return contractType +} + +type solanaRefKey struct { + contractType cldf.ContractType + qualifier string +} + +func solanaRefKeyFor(ref datastore.AddressRef) solanaRefKey { + return solanaRefKey{ + contractType: canonicalSolanaType(cldf.ContractType(ref.Type)), + qualifier: ref.Qualifier, + } +} + +func selectSolanaRefs(refs []datastore.AddressRef) ([]datastore.AddressRef, error) { + selected := make(map[solanaRefKey]datastore.AddressRef) + for _, ref := range refs { + if ref.Version == nil || ref.Labels.Contains(shared.SupersededLabel) { + continue + } + key := solanaRefKeyFor(ref) + previous, exists := selected[key] + if !exists || ref.Version.GreaterThan(previous.Version) { + selected[key] = ref + continue + } + if ref.Version.Equal(previous.Version) && ref.Address != previous.Address { + return nil, fmt.Errorf("ambiguous %s %s: found at both %s and %s", ref.Type, ref.Version, previous.Address, ref.Address) + } + } + result := make([]datastore.AddressRef, 0, len(selected)) + for _, ref := range selected { + result = append(result, ref) + } + sort.Slice(result, func(i, j int) bool { + if result[i].Address != result[j].Address { + return result[i].Address < result[j].Address + } + a, b := solanaRefKeyFor(result[i]), solanaRefKeyFor(result[j]) + if a.contractType != b.contractType { + return a.contractType < b.contractType + } + return a.qualifier < b.qualifier + }) + return result, nil +} + func (s CCIPChainState) GetTokenPoolLookupTableAddress(tokenPubKey solana.PublicKey, poolType cldf.ContractType, metadata string) (solana.PublicKey, error) { poolToMeta, ok := s.TokenPoolLookupTable[tokenPubKey] if !ok { @@ -346,11 +401,8 @@ func (s CCIPChainState) GenerateView(e *cldf.Environment, selector uint64) (view } chainView.TokenPool[s.CCTPTokenPool.String()] = tokenPoolView } - addresses, err := e.ExistingAddresses.AddressesForChain(selector) - if err != nil { - return chainView, fmt.Errorf("failed to get existing addresses: %w", err) - } - chainView.MCMSWithTimelock, err = solanaview.GenerateMCMSWithTimelockView(e.BlockChains.SolanaChains()[selector], addresses) + mcmView, err := generateMCMSWithTimelockViewFromDataStore(e, selector) + chainView.MCMSWithTimelock = mcmView if err != nil { e.Logger.Error("failed to generate MCMS with timelock view: %w", err) return chainView, nil @@ -358,6 +410,30 @@ func (s CCIPChainState) GenerateView(e *cldf.Environment, selector uint64) (view return chainView, nil } +// generateMCMSWithTimelockViewFromDataStore resolves the chain's MCMS bundle from the +// environment datastore and builds its view. +func generateMCMSWithTimelockViewFromDataStore(e *cldf.Environment, selector uint64) (solanaview.MCMSWithTimelockView, error) { + if e.DataStore == nil { + return solanaview.MCMSWithTimelockView{}, fmt.Errorf("datastore not available for chain %d", selector) + } + refs, err := e.DataStore.Addresses().Fetch() + if err != nil { + return solanaview.MCMSWithTimelockView{}, fmt.Errorf("failed to fetch address refs: %w", err) + } + bundle, err := shared.MCMSBundleRefs(refs, selector, shared.DefaultMCMSQualifier) + if err != nil { + return solanaview.MCMSWithTimelockView{}, fmt.Errorf("failed to resolve mcms bundle: %w", err) + } + if len(bundle) == 0 { + return solanaview.MCMSWithTimelockView{}, fmt.Errorf("no mcms refs for chain %d", selector) + } + mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainStateV2(bundle) + if err != nil { + return solanaview.MCMSWithTimelockView{}, fmt.Errorf("failed to load mcms with timelock solana chain state: %w", err) + } + return solanaview.GenerateMCMSWithTimelockViewFromState(e.BlockChains.SolanaChains()[selector], mcmState) +} + func (s CCIPChainState) GetFeeAggregator(chain cldf_solana.Chain) solana.PublicKey { var config solRouter.Config configPDA, _, _ := solState.FindConfigPDA(s.Router) @@ -378,8 +454,8 @@ func FetchOfframpLookupTable(ctx context.Context, chain cldf_solana.Chain, offRa return referenceAddressesAccount.OfframpLookupTable, nil } -// LoadChainStateSolana Loads all state for a SolChain into state -func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.TypeAndVersion) (CCIPChainState, error) { +// LoadChainStateSolana loads state from datastore refs. +func LoadChainStateSolana(chain cldf_solana.Chain, refs []datastore.AddressRef) (CCIPChainState, error) { ccipChainState := CCIPChainState{ SourceChainStatePDAs: make(map[uint64]solana.PublicKey), DestChainStatePDAs: make(map[uint64]solana.PublicKey), @@ -390,10 +466,16 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ WSOL: solana.WrappedSol, TokenPoolLookupTable: make(map[solana.PublicKey]map[cldf.ContractType]map[string]solana.PublicKey), } - // Most programs upgraded in place, but some are not so we always want to - // load the latest version + selectedRefs, err := selectSolanaRefs(refs) + if err != nil { + return ccipChainState, err + } + // Most programs upgrade in place, but some do not; keep the latest active ref for each + // (type, qualifier) identity. versions := make(map[cldf.ContractType]semver.Version) - for address, tvStr := range addresses { + for _, ref := range selectedRefs { + address := ref.Address + tvStr := cldf.TypeAndVersion{Type: cldf.ContractType(ref.Type), Version: *ref.Version} switch tvStr.Type { case types.LinkToken: pub := solana.MustPublicKeyFromBase58(address) @@ -406,7 +488,7 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ return ccipChainState, err } ccipChainState.RouterConfigPDA = routerConfigPDA - case shared.Receiver: + case shared.Receiver, shared.TestReceiver: receiverVersion, ok := versions[shared.OffRamp] // if we have an receiver version, we need to make sure it's a newer version if ok { @@ -426,8 +508,7 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ ccipChainState.SPLTokens = append(ccipChainState.SPLTokens, pub) case shared.RemoteSource: pub := solana.MustPublicKeyFromBase58(address) - // Labels should only have one entry - for selStr := range tvStr.Labels { + for _, selStr := range solanaRefParts(ref) { selector, err := strconv.ParseUint(selStr, 10, 64) if err != nil { return ccipChainState, err @@ -436,8 +517,7 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ } case shared.RemoteDest: pub := solana.MustPublicKeyFromBase58(address) - // Labels should only have one entry - for selStr := range tvStr.Labels { + for _, selStr := range solanaRefParts(ref) { selector, err := strconv.ParseUint(selStr, 10, 64) if err != nil { return ccipChainState, err @@ -449,12 +529,20 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ var poolType cldf.ContractType var tokenPubKey solana.PublicKey var poolMetadata string - for label := range tvStr.Labels { - maybeTokenPubKey, err := solana.PublicKeyFromBase58(label) + parts := solanaRefParts(ref) + if ref.Qualifier != "" { + var err error + parts, err = shared.ParseQualifierParts(ref.Qualifier) + if err != nil { + return ccipChainState, fmt.Errorf("invalid token pool lookup table qualifier %q: %w", ref.Qualifier, err) + } + } + for _, part := range parts { + maybeTokenPubKey, err := solana.PublicKeyFromBase58(part) if err == nil { tokenPubKey = maybeTokenPubKey } else { - switch label { + switch part { case solTestTokenPool.BurnAndMint_PoolType.String(), shared.BurnMintTokenPool.String(): poolType = shared.BurnMintTokenPool case solTestTokenPool.LockAndRelease_PoolType.String(), shared.LockReleaseTokenPool.String(): @@ -462,7 +550,7 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ case shared.CCTPTokenPool.String(): poolType = shared.CCTPTokenPool default: - poolMetadata = label + poolMetadata = part } } } @@ -512,21 +600,13 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ ccipChainState.OffRampStatePDA = offRampStatePDA case shared.BurnMintTokenPool: pub := solana.MustPublicKeyFromBase58(address) - if len(tvStr.Labels) == 0 { - ccipChainState.BurnMintTokenPools[shared.CLLMetadata] = pub - } - // Labels should only have one entry - for metadataStr := range tvStr.Labels { - ccipChainState.BurnMintTokenPools[metadataStr] = pub + for _, metadata := range poolMetadata(ref) { + ccipChainState.BurnMintTokenPools[metadata] = pub } case shared.LockReleaseTokenPool: pub := solana.MustPublicKeyFromBase58(address) - if len(tvStr.Labels) == 0 { - ccipChainState.LockReleaseTokenPools[shared.CLLMetadata] = pub - } - // Labels should only have one entry - for metadataStr := range tvStr.Labels { - ccipChainState.LockReleaseTokenPools[metadataStr] = pub + for _, metadata := range poolMetadata(ref) { + ccipChainState.LockReleaseTokenPools[metadata] = pub } case shared.RMNRemote: pub := solana.MustPublicKeyFromBase58(address) @@ -555,6 +635,41 @@ func LoadChainStateSolana(chain cldf_solana.Chain, addresses map[string]cldf.Typ return ccipChainState, nil } +func solanaRefParts(ref datastore.AddressRef) []string { + if ref.Qualifier == "" { + return nil + } + return []string{ref.Qualifier} +} + +func poolMetadata(ref datastore.AddressRef) []string { + metas := solanaRefParts(ref) + if len(metas) == 0 { + return []string{shared.CLLMetadata} + } + return metas +} + +// LoadMCMSWithTimelockFromDataStore resolves a qualified MCMS bundle from the environment +// datastore. +func LoadMCMSWithTimelockFromDataStore(e *cldf.Environment, chain cldf_solana.Chain, qualifier string) (*solstate.MCMSWithTimelockState, error) { + if e.DataStore == nil { + return nil, fmt.Errorf("datastore not available for chain %d", chain.Selector) + } + refs, err := e.DataStore.Addresses().Fetch() + if err != nil { + return nil, fmt.Errorf("failed to fetch address refs: %w", err) + } + bundle, err := shared.MCMSBundleRefs(refs, chain.Selector, qualifier) + if err != nil { + return nil, fmt.Errorf("failed to resolve mcms bundle: %w", err) + } + if len(bundle) == 0 { + return nil, fmt.Errorf("no mcms refs for chain %d", chain.Selector) + } + return solstate.MaybeLoadMCMSWithTimelockChainStateV2(bundle) +} + func FindSolanaAddress(tv cldf.TypeAndVersion, addresses map[string]cldf.TypeAndVersion) solana.PublicKey { for address, tvStr := range addresses { if tv.String() == tvStr.String() { @@ -573,11 +688,7 @@ func ValidateOwnershipSolana( contractType cldf.ContractType, tokenAddress solana.PublicKey, // for token pools only ) error { - addresses, err := e.ExistingAddresses.AddressesForChain(chain.Selector) - if err != nil { - return fmt.Errorf("failed to get existing addresses: %w", err) - } - mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses) + mcmState, err := LoadMCMSWithTimelockFromDataStore(e, chain, shared.DefaultMCMSQualifier) if err != nil { return fmt.Errorf("failed to load MCMS with timelock chain state: %w", err) } @@ -683,11 +794,7 @@ func IsSolanaProgramOwnedByTimelock( tokenAddress solana.PublicKey, // for token pools only tokenPoolMetadata string, ) bool { - addresses, err := e.ExistingAddresses.AddressesForChain(chain.Selector) - if err != nil { - return false - } - mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses) + mcmState, err := LoadMCMSWithTimelockFromDataStore(e, chain, shared.DefaultMCMSQualifier) if err != nil { return false } diff --git a/deployment/ccip/shared/stateview/solana/state_test.go b/deployment/ccip/shared/stateview/solana/state_test.go new file mode 100644 index 00000000000..c14d88cdea7 --- /dev/null +++ b/deployment/ccip/shared/stateview/solana/state_test.go @@ -0,0 +1,79 @@ +package solana + +import ( + "testing" + + "github.com/Masterminds/semver/v3" + "github.com/gagliardetto/solana-go" + "github.com/stretchr/testify/require" + + cldf_solana "github.com/smartcontractkit/chainlink-deployments-framework/chain/solana" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" + "github.com/smartcontractkit/chainlink/deployment/ccip/shared" +) + +func TestSelectSolanaRefsSelectsNewestVersion(t *testing.T) { + v10 := semver.MustParse("1.0.0") + v11 := semver.MustParse("1.1.0") + refs := []datastore.AddressRef{ + {Address: "router-v1", Type: datastore.ContractType(shared.Router), Version: v10}, + {Address: "router-v2", Type: datastore.ContractType(shared.Router), Version: v11}, + } + + selected, err := selectSolanaRefs(refs) + require.NoError(t, err) + require.Len(t, selected, 1) + require.Equal(t, "router-v2", selected[0].Address) +} + +func TestSelectSolanaRefsRejectsEqualVersionAmbiguity(t *testing.T) { + v10 := semver.MustParse("1.0.0") + refs := []datastore.AddressRef{ + {Address: "router-a", Type: datastore.ContractType(shared.Router), Version: v10}, + {Address: "router-b", Type: datastore.ContractType(shared.Router), Version: v10}, + } + + _, err := selectSolanaRefs(refs) + require.Error(t, err) +} + +func TestSelectSolanaRefsTreatsReceiverSpellingsAsOneSlot(t *testing.T) { + v10 := semver.MustParse("1.0.0") + refs := []datastore.AddressRef{ + {Address: "receiver-a", Type: datastore.ContractType(shared.Receiver), Version: v10}, + {Address: "receiver-b", Type: datastore.ContractType(shared.TestReceiver), Version: v10}, + } + + _, err := selectSolanaRefs(refs) + require.Error(t, err) + require.ErrorContains(t, err, string(shared.Receiver)) +} + +func TestSelectSolanaRefsKeepsQualifiedInstances(t *testing.T) { + v10 := semver.MustParse("1.0.0") + refs := []datastore.AddressRef{ + {Address: "token-a", Type: datastore.ContractType(shared.SPLTokens), Version: v10, Qualifier: "a"}, + {Address: "token-b", Type: datastore.ContractType(shared.SPLTokens), Version: v10, Qualifier: "b"}, + } + + selected, err := selectSolanaRefs(refs) + require.NoError(t, err) + require.Len(t, selected, 2) +} + +func TestLoadChainStateSolanaDecodesLookupTableQualifier(t *testing.T) { + mint := solana.MustPublicKeyFromBase58("So11111111111111111111111111111111111111112") + lookupTable := solana.MustPublicKeyFromBase58("11111111111111111111111111111111") + metadata := "pool/with/slashes" + v10 := semver.MustParse("1.0.0") + + state, err := LoadChainStateSolana(cldf_solana.Chain{Selector: 1}, []datastore.AddressRef{{ + ChainSelector: 1, + Address: lookupTable.String(), + Type: datastore.ContractType(shared.TokenPoolLookupTable), + Version: v10, + Qualifier: shared.TokenPoolLookupTableQualifier(mint.String(), shared.BurnMintTokenPool.String(), metadata), + }}) + require.NoError(t, err) + require.Equal(t, lookupTable, state.TokenPoolLookupTable[mint][shared.BurnMintTokenPool][metadata]) +} diff --git a/deployment/ccip/shared/stateview/solana_timelock.go b/deployment/ccip/shared/stateview/solana_timelock.go new file mode 100644 index 00000000000..8841bd83f8a --- /dev/null +++ b/deployment/ccip/shared/stateview/solana_timelock.go @@ -0,0 +1,112 @@ +package stateview + +import ( + "errors" + "fmt" + + mcmssolanasdk "github.com/smartcontractkit/mcms/sdk/solana" + mcmstypes "github.com/smartcontractkit/mcms/types" + + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" + cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" + mcmscontracts "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/contracts/mcms" + cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils" +) + +// ValidateSolanaTimelockConfig validates a Solana timelock config against the environment +// datastore: the RBACTimelock account and the action-specific MCMS account must exist for the +// chain and parse as "programID.PDASeed" addresses. The bundle qualifier comes from +// tc.TimelockQualifierPerChain when configured, else the default CCIP bundle. +// +// CCIP-owned replacement for cldfproposalutils.TimelockConfig.ValidateSolana (address-book +// based); the framework is not patched. +func ValidateSolanaTimelockConfig(e cldf.Environment, chainSelector uint64, tc *cldfproposalutils.TimelockConfig) error { + if tc == nil { + return errors.New("timelock config is nil") + } + // default in place, mirroring the framework's validateCommon: callers observe the config + if tc.MCMSAction == "" { + tc.MCMSAction = mcmstypes.TimelockActionSchedule + } + switch tc.MCMSAction { + case mcmstypes.TimelockActionSchedule, mcmstypes.TimelockActionCancel, mcmstypes.TimelockActionBypass: + default: + return fmt.Errorf("invalid MCMS action %s", tc.MCMSAction) + } + + qualifier := DefaultMCMSQualifier + if q, ok := tc.TimelockQualifierPerChain[chainSelector]; ok && q != "" { + qualifier = q + } + + validateContract := func(contractType cldf.ContractType) error { + address, err := dataStoreSolanaContractAddress(e, chainSelector, contractType, qualifier) + if err != nil { + return fmt.Errorf("%s not present on the chain %w", contractType, err) + } + // Format is: "programID.PDASeed" + if _, _, parseErr := mcmssolanasdk.ParseContractAddress(address); parseErr != nil { + return fmt.Errorf("failed to parse timelock address: %w", parseErr) + } + return nil + } + + if err := validateContract(mcmscontracts.RBACTimelock); err != nil { + return err + } + + switch tc.MCMSAction { + case mcmstypes.TimelockActionSchedule: + return validateContract(mcmscontracts.ProposerManyChainMultisig) + case mcmstypes.TimelockActionCancel: + return validateContract(mcmscontracts.CancellerManyChainMultisig) + case mcmstypes.TimelockActionBypass: + return validateContract(mcmscontracts.BypasserManyChainMultisig) + } + return nil +} + +// dataStoreSolanaContractAddress resolves one Solana contract account of the given type and +// qualifier from the environment datastore. +func dataStoreSolanaContractAddress(e cldf.Environment, chainSelector uint64, contractType cldf.ContractType, qualifier string) (string, error) { + if e.DataStore == nil { + return "", fmt.Errorf("datastore not available for chain %d", chainSelector) + } + refs := e.DataStore.Addresses().Filter( + datastore.AddressRefByChainSelector(chainSelector), + datastore.AddressRefByType(datastore.ContractType(contractType)), + ) + var active []datastore.AddressRef + for _, ref := range refs { + if isActiveRef(ref) { + active = append(active, ref) + } + } + refs = active + if len(refs) == 0 { + return "", fmt.Errorf("no %s ref for chain %d", contractType, chainSelector) + } + qualifiers := []string{qualifier} + if qualifier == DefaultMCMSQualifier { + qualifiers = append(qualifiers, "") + } + var matching []datastore.AddressRef + for _, candidate := range qualifiers { + for _, ref := range refs { + if ref.Qualifier == candidate { + matching = append(matching, ref) + } + } + if len(matching) > 0 { + break + } + } + if len(matching) == 0 { + return "", fmt.Errorf("no %s ref for chain %d with qualifier %q", contractType, chainSelector, qualifier) + } + if len(matching) > 1 { + sortAddressRefs(matching) + return "", fmt.Errorf("ambiguous %s on chain %d: %d refs share qualifier %q", contractType, chainSelector, len(matching), qualifier) + } + return matching[0].Address, nil +} diff --git a/deployment/ccip/shared/stateview/state.go b/deployment/ccip/shared/stateview/state.go index 57dd67267cd..3d273a5d151 100644 --- a/deployment/ccip/shared/stateview/state.go +++ b/deployment/ccip/shared/stateview/state.go @@ -5,6 +5,7 @@ import ( "errors" "fmt" "reflect" + "sort" "strconv" "sync" @@ -33,6 +34,7 @@ import ( cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" cldf_chain_utils "github.com/smartcontractkit/chainlink-deployments-framework/chain/utils" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" cldfproposalutils "github.com/smartcontractkit/chainlink-deployments-framework/engine/cld/mcms/proposalutils" @@ -113,9 +115,7 @@ import ( const chainNotSupportedErr = "chain not supported" -// CCIPOnChainState state always derivable from an address book. -// Offchain state always derivable from a list of nodeIds. -// Note can translate this into Go struct needed for MCMS/Docs/UI. +// CCIPOnChainState is the datastore-backed loaded on-chain view used by MCMS, docs, and UI flows. type CCIPOnChainState struct { // Populated go bindings for the appropriate version for all contracts. // We would hold 2 versions of each contract here. Once we upgrade we can phase out the old one. @@ -175,21 +175,34 @@ func (c CCIPOnChainState) ValidatePostDeploymentStateWithoutMCMSOwnership(e cldf return c.runPostDeploymentValidation(e, validateHomeChain, false, nil) } -func (c CCIPOnChainState) resolveOnRampAddress(e cldf.Environment, chainSelector uint64) (common.Address, bool) { +func (c CCIPOnChainState) resolveOnRampAddress(e cldf.Environment, chainSelector uint64) (common.Address, bool, error) { if cs, ok := c.EVMChainState(chainSelector); ok && cs.OnRamp != nil { - return cs.OnRamp.Address(), true + return cs.OnRamp.Address(), true, nil } - addresses, err := e.ExistingAddresses.AddressesForChain(chainSelector) + if e.DataStore == nil { + return common.Address{}, false, errors.New("datastore not available") + } + refs, err := e.DataStore.Addresses().Fetch() if err != nil { - return common.Address{}, false + return common.Address{}, false, fmt.Errorf("failed to fetch datastore address refs: %w", err) } - onRampTV := cldf.NewTypeAndVersion(ccipshared.OnRamp, deployment.Version1_6_0).String() - for addr, tv := range addresses { - if tv.String() == onRampTV { - return common.HexToAddress(addr), true + onRampTV := dispatchKey(cldf.NewTypeAndVersion(ccipshared.OnRamp, deployment.Version1_6_0)) + var address string + for _, ref := range refs { + if ref.ChainSelector == chainSelector && + ref.Version != nil && + !ref.Labels.Contains(ccipshared.SupersededLabel) && + fmt.Sprintf("%s %s", ref.Type, ref.Version) == onRampTV { + if address != "" && address != ref.Address { + return common.Address{}, false, fmt.Errorf("ambiguous OnRamp %s on chain %d: found at %s and %s", onRampTV, chainSelector, address, ref.Address) + } + address = ref.Address } } - return common.Address{}, false + if address == "" { + return common.Address{}, false, nil + } + return common.HexToAddress(address), true, nil } func (c CCIPOnChainState) runPostDeploymentValidation(e cldf.Environment, validateHomeChain bool, validateOwnership bool, chainsToValidate map[uint64]bool) map[uint64][]error { @@ -298,16 +311,13 @@ func (c CCIPOnChainState) runSingleChainValidation( chainState.RMNRemote.Address().Hex(), isRMNEnabledInRMNHomeBySourceChain[sel], isRMNEnabledInRmnRemote)) } var fqV2 *fqv2ops.FeeQuoterContract - // Resolve FeeQuoter candidates from a plain ref slice drawn from both the environment - // DataStore (qualified refs) and the existing address book (chain-singleton refs). Using a - // slice rather than a keyed datastore avoids collisions among multi-instance refs and works - // even when the environment DataStore is nil/empty. - candidates, err := ccipshared.CollectAddressRefs(e) + // Resolve FeeQuoter from active environment datastore refs. Keep the refs in slice form so + // qualified instances remain distinct, and fail fast if the datastore cannot be read. + candidates, err := ccipshared.CollectDataStoreRefs(e) if err != nil { - // Return here rather than continuing with nil candidates: on a chain that does have a v2 - // FeeQuoter, falling through would silently take the v1-only path and bury the real cause - // under a cascade of unrelated v1-vs-v2 mismatch errors. - return append(errs, fmt.Errorf("failed to collect address refs: %w", err)) + // Do not continue with nil candidates: that could silently select the v1-only validation + // path and hide the datastore failure behind unrelated validation errors. + return append(errs, fmt.Errorf("failed to collect datastore refs: %w", err)) } if fqAddr, fqVer, fqErr := ccipshared.ResolveFeeQuoterAddressAndVersion(candidates, sel); fqErr == nil && fqVer.Major() >= 2 { if evmChain, ok := e.BlockChains.EVMChains()[sel]; ok { @@ -331,7 +341,9 @@ func (c CCIPOnChainState) runSingleChainValidation( if connectedChain == sel { continue } - if addr, ok := c.resolveOnRampAddress(e, connectedChain); ok { + if addr, ok, resolveErr := c.resolveOnRampAddress(e, connectedChain); resolveErr != nil { + errs = append(errs, fmt.Errorf("onramp resolution for connected chain %d: %w", connectedChain, resolveErr)) + } else if ok { otherOnRamps[connectedChain] = addr } } @@ -412,11 +424,18 @@ func (c CCIPOnChainState) EVMMCMSStateByChain() map[uint64]evmstate.MCMSWithTime func (c CCIPOnChainState) SolanaMCMSStateByChain(e cldf.Environment) map[uint64]solstate.MCMSWithTimelockState { mcmsStateByChain := make(map[uint64]solstate.MCMSWithTimelockState) for chainSelector := range e.BlockChains.SolanaChains() { - addresses, err := e.ExistingAddresses.AddressesForChain(chainSelector) + if e.DataStore == nil { + return mcmsStateByChain + } + refs, err := e.DataStore.Addresses().Fetch() if err != nil { return mcmsStateByChain } - mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainState(e.BlockChains.SolanaChains()[chainSelector], addresses) + bundle, err := ccipshared.MCMSBundleRefs(refs, chainSelector, DefaultMCMSQualifier) + if err != nil || len(bundle) == 0 { + return mcmsStateByChain + } + mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainStateV2(bundle) if err != nil { return mcmsStateByChain } @@ -1011,22 +1030,14 @@ func (c CCIPOnChainState) GetEVMChainState(env cldf.Environment, chainSelector u } func (c CCIPOnChainState) UpdateMCMSStateWithAddressFromDatastoreForChain(e cldf.Environment, selector uint64, qualifier string) error { - mcmsStateWithQualifier, err := evmstate.MaybeLoadMCMSWithTimelockStateDataStoreWithQualifier(e, []uint64{selector}, qualifier) + mcmsState, err := loadMCMSWithTimelockForChain(e, selector, qualifier) if err != nil { - return fmt.Errorf("failed to load mcms state from datastore with qualifier %s: %w", qualifier, err) + return err } - for chainSelector, mcmsState := range mcmsStateWithQualifier { - if chainState, ok := c.EVMChainState(chainSelector); ok { - chainState.MCMSWithTimelockState = *mcmsState - chainState.ABIByAddress[mcmsState.ProposerMcm.Address().Hex()] = gethwrappers.ManyChainMultiSigABI - chainState.ABIByAddress[mcmsState.CancellerMcm.Address().Hex()] = gethwrappers.ManyChainMultiSigABI - chainState.ABIByAddress[mcmsState.BypasserMcm.Address().Hex()] = gethwrappers.ManyChainMultiSigABI - chainState.ABIByAddress[mcmsState.Timelock.Address().Hex()] = gethwrappers.RBACTimelockABI - chainState.ABIByAddress[mcmsState.CallProxy.Address().Hex()] = gethwrappers.CallProxyABI - // write back to state - c.WriteEVMChainState(chainSelector, chainState) - } + if mcmsState.Timelock == nil { + return fmt.Errorf("no mcms bundle found for chain %d with qualifier %s", selector, qualifier) } + c.applyMCMSWithTimelockState(selector, mcmsState) return nil } @@ -1034,6 +1045,8 @@ type LoadOption func(*loadStateOpts) type loadStateOpts struct { loadLegacyContracts bool + mcmsQualifier string + tolerateUnknownTV bool } func WithLoadLegacyContracts(load bool) LoadOption { @@ -1042,7 +1055,29 @@ func WithLoadLegacyContracts(load bool) LoadOption { } } +// WithMCMSQualifier selects the MCMS bundle qualifier used by the datastore-backed loader. +func WithMCMSQualifier(qualifier string) LoadOption { + return func(c *loadStateOpts) { + c.mcmsQualifier = qualifier + } +} + +// WithTolerateUnknownContractTypes makes LoadChainState skip contract types it does not model +// instead of erroring. Datastore-sourced loads need this: the datastore is a superset that +// also serves the CCIP 2.0 loaders, so it holds types this legacy state loader never binds. +func WithTolerateUnknownContractTypes() LoadOption { + return func(c *loadStateOpts) { + c.tolerateUnknownTV = true + } +} + +// LoadOnchainState loads CCIP on-chain state resolving contract addresses from the +// environment datastore. func LoadOnchainState(e cldf.Environment, opts ...LoadOption) (CCIPOnChainState, error) { + return loadOnchainStateFromDataStore(e, opts...) +} + +func loadOnchainStateFromDataStore(e cldf.Environment, opts ...LoadOption) (CCIPOnChainState, error) { solanaState, err := LoadOnchainStateSolana(e) if err != nil { return CCIPOnChainState{}, err @@ -1068,25 +1103,40 @@ func LoadOnchainState(e cldf.Environment, opts ...LoadOption) (CCIPOnChainState, TonChains: tonChains, evmMu: &sync.RWMutex{}, } + config := &loadStateOpts{} + for _, opt := range opts { + opt(config) + } grp, ctx := errgroup.WithContext(e.GetContext()) grp.SetLimit(10) // parallel EVM chain loading with bounded concurrency for chainSelector, chain := range e.BlockChains.EVMChains() { sel := chainSelector ch := chain + chainOpts := make([]LoadOption, len(opts)) + copy(chainOpts, opts) + mcmsQualifier := config.mcmsQualifier + chainOpts = append(chainOpts, WithTolerateUnknownContractTypes()) + if mcmsQualifier == "" { + mcmsQualifier = DefaultMCMSQualifier + chainOpts = append(chainOpts, WithMCMSQualifier(mcmsQualifier)) + } grp.Go(func() error { - // get all addresses for chain from addressbook - // here we do not load addresses from datastore as there can be multiple - // contracts of the same type and version in datastore which can lead to - // ambiguity while loading the state - addresses, err := e.ExistingAddresses.AddressesForChain(sel) - if err != nil && !errors.Is(err, cldf.ErrChainNotFound) { - return fmt.Errorf("failed to get addresses for chain %d: %w", sel, err) - } - chainState, err := LoadChainState(ctx, ch, addresses, opts...) + refs, err := dataStoreRefsForChain(e, sel) + if err != nil { + return err + } + chainState, err := loadChainStateFromDataStore(ctx, ch, refs, chainOpts...) if err != nil { return err } state.WriteEVMChainState(sel, chainState) + if mcmsQualifier != "" { + mcmsState, err := loadMCMSWithTimelockForChain(e, sel, mcmsQualifier) + if err != nil { + return err + } + state.applyMCMSWithTimelockState(sel, mcmsState) + } return nil }) } @@ -1099,26 +1149,72 @@ func LoadOnchainState(e cldf.Environment, opts ...LoadOption) (CCIPOnChainState, return state, nil } -// LoadChainState Loads all state for a chain into state -func LoadChainState(ctx context.Context, chain cldf_evm.Chain, addresses map[string]cldf.TypeAndVersion, opts ...LoadOption) (evm.CCIPChainState, error) { +// dispatchKey is the loader's dispatch identity: type and version. +func dispatchKey(tv cldf.TypeAndVersion) string { + return fmt.Sprintf("%s %s", tv.Type, tv.Version.String()) +} + +type loadStateRef struct { + address string + tv cldf.TypeAndVersion + qualifier string +} + +// LoadChainState loads state from the legacy address-to-type map. Datastore-backed loads retain +// qualifiers through loadChainStateFromDataStore. +func LoadChainState(ctx context.Context, chain cldf_evm.Chain, addresses map[string][]cldf.TypeAndVersion, opts ...LoadOption) (evm.CCIPChainState, error) { + entries := make([]loadStateRef, 0, len(addresses)) + for address, tvs := range addresses { + for _, tv := range tvs { + entries = append(entries, loadStateRef{address: address, tv: tv, qualifier: tv.Labels.String()}) + } + } + return loadChainStateWithEntries(ctx, chain, addresses, entries, opts...) +} + +func loadChainStateFromDataStore(ctx context.Context, chain cldf_evm.Chain, refs []datastore.AddressRef, opts ...LoadOption) (evm.CCIPChainState, error) { + addresses := AddressRefsToTypeVersions(refs) + entries := make([]loadStateRef, 0, len(refs)) + for _, ref := range refs { + if ref.Version == nil { + continue + } + tv := cldf.TypeAndVersion{ + Type: cldf.ContractType(ref.Type), + Version: *ref.Version, + } + if !ref.Labels.IsEmpty() { + tv.Labels = cldf.NewLabelSet(ref.Labels.List()...) + } + entries = append(entries, loadStateRef{address: ref.Address, tv: tv, qualifier: ref.Qualifier}) + } + if err := ccipshared.CheckRefUniqueness(refs); err != nil { + return evm.CCIPChainState{}, fmt.Errorf("datastore is ambiguous: %w", err) + } + return loadChainStateWithEntries(ctx, chain, addresses, entries, opts...) +} + +func loadChainStateWithEntries(ctx context.Context, chain cldf_evm.Chain, addresses map[string][]cldf.TypeAndVersion, entries []loadStateRef, opts ...LoadOption) (evm.CCIPChainState, error) { config := &loadStateOpts{} for _, opt := range opts { opt(config) } var state evm.CCIPChainState - mcmsWithTimelock, err := evmstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses) - if err != nil { - return state, err + if config.mcmsQualifier == "" { + mcmsWithTimelock, err := evmstate.MaybeLoadMCMSWithTimelockChainState(chain, flattenTypeVersions(addresses)) + if err != nil { + return state, err + } + state.MCMSWithTimelockState = *mcmsWithTimelock } - state.MCMSWithTimelockState = *mcmsWithTimelock - linkState, err := evm.MaybeLoadLinkTokenChainState(chain, addresses) + linkState, err := evm.MaybeLoadLinkTokenChainState(chain, flattenTypeVersions(addresses)) if err != nil { return state, err } state.LinkTokenState = *linkState - staticLinkState, err := evm.MaybeLoadStaticLinkTokenState(chain, addresses) + staticLinkState, err := evm.MaybeLoadStaticLinkTokenState(chain, flattenTypeVersions(addresses)) if err != nil { return state, err } @@ -1127,8 +1223,22 @@ func LoadChainState(ctx context.Context, chain cldf_evm.Chain, addresses map[str state.ABIByAddress = make(map[string]string) var mu sync.Mutex var work []func(context.Context) error - for address, tvStr := range addresses { - switch tvStr.String() { + + // Keep dispatch deterministic; datastore qualifiers remain available for identity checks. + sort.Slice(entries, func(i, j int) bool { + if entries[i].address != entries[j].address { + return entries[i].address < entries[j].address + } + if dispatchKey(entries[i].tv) != dispatchKey(entries[j].tv) { + return dispatchKey(entries[i].tv) < dispatchKey(entries[j].tv) + } + return entries[i].qualifier < entries[j].qualifier + }) + + feeQuoterSelections := make(map[string]string) + for _, entry := range entries { + address, tvStr := entry.address, entry.tv + switch dispatchKey(tvStr) { case cldf.NewTypeAndVersion(commontypes.RBACTimelock, deployment.Version1_0_0).String(): state.ABIByAddress[address] = gethwrappers.RBACTimelockABI case cldf.NewTypeAndVersion(commontypes.CallProxy, deployment.Version1_0_0).String(): @@ -1893,6 +2003,12 @@ func LoadChainState(ctx context.Context, chain cldf_evm.Chain, addresses map[str if tvStr.Version.Major() != 1 { continue } + // one binding per version: a second ref of the same version at a different + // address is unresolved ambiguity, not a replacement + if prev, seen := feeQuoterSelections[tvStr.Version.String()]; seen && prev != address { + return state, fmt.Errorf("ambiguous FeeQuoter %s: found at both %s and %s", tvStr.Version, prev, address) + } + feeQuoterSelections[tvStr.Version.String()] = address if state.FeeQuoter == nil || state.FeeQuoterVersion == nil || tvStr.Version.GreaterThan(state.FeeQuoterVersion) { fq, err := fee_quoter.NewFeeQuoter(common.HexToAddress(address), chain.Client) if err != nil { @@ -1918,6 +2034,10 @@ func LoadChainState(ctx context.Context, chain cldf_evm.Chain, addresses map[str if tvStr.Type == ccipshared.BurnMintERC20TransparentToken || tvStr.Type == ccipshared.BurnMintERC20PausableFreezableTransparentToken { continue } + if config.tolerateUnknownTV { + // not modelled by this loader (e.g. CCIP 2.0 types served to their own loaders) + continue + } return state, fmt.Errorf("unknown contract %s", tvStr) } } @@ -1974,7 +2094,7 @@ func ValidateChain(env cldf.Environment, state CCIPOnChainState, chainSel uint64 return fmt.Errorf("%s does not exist in state", chain) } if mcmsCfg != nil { - err = mcmsCfg.ValidateSolana(env, chainSel) + err = ValidateSolanaTimelockConfig(env, chainSel, mcmsCfg) if err != nil { return err } @@ -2013,16 +2133,21 @@ func LoadOnchainStateSolana(e cldf.Environment) (CCIPOnChainState, error) { state := CCIPOnChainState{ SolChains: make(map[uint64]solana.CCIPChainState), } + if e.DataStore == nil { + return state, errors.New("datastore not available for solana state loading") + } + allRefs, err := e.DataStore.Addresses().Fetch() + if err != nil { + return state, fmt.Errorf("failed to fetch address refs from datastore: %w", err) + } for chainSelector, chain := range e.BlockChains.SolanaChains() { - addresses, err := e.ExistingAddresses.AddressesForChain(chainSelector) - if err != nil { - // Chain not found in address book, initialize empty - if !errors.Is(err, cldf.ErrChainNotFound) { - return state, err + var chainRefs []datastore.AddressRef + for _, ref := range allRefs { + if ref.ChainSelector == chainSelector { + chainRefs = append(chainRefs, ref) } - addresses = make(map[string]cldf.TypeAndVersion) } - chainState, err := solana.LoadChainStateSolana(chain, addresses) + chainState, err := solana.LoadChainStateSolana(chain, chainRefs) if err != nil { return state, err } diff --git a/deployment/ccip/shared/stateview/state_test.go b/deployment/ccip/shared/stateview/state_test.go index d42f5cc9e3f..5b0685c1abb 100644 --- a/deployment/ccip/shared/stateview/state_test.go +++ b/deployment/ccip/shared/stateview/state_test.go @@ -24,6 +24,7 @@ import ( cldf_chain "github.com/smartcontractkit/chainlink-deployments-framework/chain" cldf_evm "github.com/smartcontractkit/chainlink-deployments-framework/chain/evm" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/environment" "github.com/smartcontractkit/chainlink-deployments-framework/engine/test/runtime" @@ -41,10 +42,10 @@ func TestLoadChainState_MultipleFeeQuoters(t *testing.T) { tenv, _ := testhelpers.NewMemoryEnvironment(t, testhelpers.WithNumOfChains(3)) fq1 := utils.RandomAddress().Hex() fq2 := utils.RandomAddress().Hex() - state, err := stateview.LoadChainState(t.Context(), tenv.Env.BlockChains.EVMChains()[tenv.HomeChainSel], map[string]cldf.TypeAndVersion{ + state, err := stateview.LoadChainState(t.Context(), tenv.Env.BlockChains.EVMChains()[tenv.HomeChainSel], stateview.TypeVersionsToSlices(map[string]cldf.TypeAndVersion{ fq1: cldf.NewTypeAndVersion(shared.FeeQuoter, deployment.Version1_0_0), fq2: cldf.NewTypeAndVersion(shared.FeeQuoter, deployment.Version1_2_0), - }) + })) require.NoError(t, err) require.Equal(t, fq2, state.FeeQuoter.Address().Hex(), "expected latest fee quoter to be selected") @@ -132,10 +133,10 @@ func TestLoadChainState_LegacyV15EVM2EVMDatastoreKeys(t *testing.T) { _, err = cldf.ConfirmIfNoError(chain, tx, err) require.NoError(t, err) - evm2evmAddrs := map[string]cldf.TypeAndVersion{ + evm2evmAddrs := stateview.TypeVersionsToSlices(map[string]cldf.TypeAndVersion{ onRamp.Address().Hex(): cldf.NewTypeAndVersion(shared.EVM2EVMOnRamp, deployment.Version1_5_0), offRamp.Address().Hex(): cldf.NewTypeAndVersion(shared.EVM2EVMOffRamp, deployment.Version1_5_0), - } + }) legacyDisabled, err := stateview.LoadChainState(t.Context(), chain, evm2evmAddrs) require.NoError(t, err) @@ -151,10 +152,10 @@ func TestLoadChainState_LegacyV15EVM2EVMDatastoreKeys(t *testing.T) { require.Equal(t, evm_2_evm_onramp.EVM2EVMOnRampABI, lcs.ABIByAddress[onRamp.Address().Hex()]) require.Equal(t, evm_2_evm_offramp.EVM2EVMOffRampABI, lcs.ABIByAddress[offRamp.Address().Hex()]) - legacyNamesAddrs := map[string]cldf.TypeAndVersion{ + legacyNamesAddrs := stateview.TypeVersionsToSlices(map[string]cldf.TypeAndVersion{ onRamp.Address().Hex(): cldf.NewTypeAndVersion(shared.OnRamp, deployment.Version1_5_0), offRamp.Address().Hex(): cldf.NewTypeAndVersion(shared.OffRamp, deployment.Version1_5_0), - } + }) byLegacyKeys, err := stateview.LoadChainState(t.Context(), chain, legacyNamesAddrs, stateview.WithLoadLegacyContracts(true)) require.NoError(t, err) require.Equal(t, onRamp.Address(), byLegacyKeys.EVM2EVMOnRamp[dstSel].Address()) @@ -268,11 +269,11 @@ func TestLoadChainState_LegacyEVM2EVMAndV16OnRampCoexist(t *testing.T) { _, err = cldf.ConfirmIfNoError(chain, tx, err) require.NoError(t, err) - combined := map[string]cldf.TypeAndVersion{ + combined := stateview.TypeVersionsToSlices(map[string]cldf.TypeAndVersion{ evmOnRamp.Address().Hex(): cldf.NewTypeAndVersion(shared.EVM2EVMOnRamp, deployment.Version1_5_0), evmOffRamp.Address().Hex(): cldf.NewTypeAndVersion(shared.EVM2EVMOffRamp, deployment.Version1_5_0), v16Addr.Hex(): cldf.NewTypeAndVersion(shared.OnRamp, deployment.Version1_6_0), - } + }) withoutLegacy, err := stateview.LoadChainState(t.Context(), chain, combined) require.NoError(t, err) @@ -309,6 +310,22 @@ func TestMCMSState(t *testing.T) { addr := utils.RandomAddress() require.NoError(t, addressbook.Save(tenv.HomeChainSel, addr.String(), newTv)) require.NoError(t, tenv.Env.ExistingAddresses.Merge(addressbook)) + ds := datastore.NewMemoryDataStore() + require.NoError(t, ds.Merge(tenv.Env.DataStore)) + for _, mcmsType := range []cldf.ContractType{ + types.ProposerManyChainMultisig, + types.CancellerManyChainMultisig, + types.BypasserManyChainMultisig, + } { + version := newTv.Version + require.NoError(t, ds.Addresses().Add(datastore.AddressRef{ + ChainSelector: tenv.HomeChainSel, + Address: addr.String(), + Type: datastore.ContractType(mcmsType), + Version: &version, + })) + } + tenv.Env.DataStore = ds.Seal() state, err := stateview.LoadOnchainState(tenv.Env) require.NoError(t, err) require.Equal(t, addr.String(), state.Chains[tenv.HomeChainSel].BypasserMcm.Address().String()) @@ -436,7 +453,9 @@ func TestEnforceMCMSUsageIfProd(t *testing.T) { evmChains := rt.Environment().BlockChains.EVMChains() if test.DeployCCIPHome { - _, err = cldf.DeployContract(lggr, evmChains[homeChainSelector], rt.State().AddressBook, + ds := datastore.NewMemoryDataStore() + _, err = shared.DeployContractAndRecord(lggr, evmChains[homeChainSelector], rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.CCIPHome, deployment.Version1_6_0), "", func(chain cldf_evm.Chain) cldf.ContractDeploy[*ccip_home.CCIPHome] { address, tx2, contract, err2 := ccip_home.DeployCCIPHome( chain.DeployerKey, @@ -448,10 +467,13 @@ func TestEnforceMCMSUsageIfProd(t *testing.T) { } }) require.NoError(t, err, "failed to deploy CCIP home") + require.NoError(t, rt.State().MergeChangesetOutput("test-deploy-ccip-home", cldf.ChangesetOutput{DataStore: ds})) } if test.DeployCapReg { - _, err = cldf.DeployContract(lggr, evmChains[homeChainSelector], rt.State().AddressBook, + ds := datastore.NewMemoryDataStore() + _, err = shared.DeployContractAndRecord(lggr, evmChains[homeChainSelector], rt.State().AddressBook, ds, + cldf.NewTypeAndVersion(shared.CapabilitiesRegistry, deployment.Version1_0_0), "", func(chain cldf_evm.Chain) cldf.ContractDeploy[*capabilities_registry.CapabilitiesRegistry] { address, tx2, contract, err2 := capabilities_registry.DeployCapabilitiesRegistry( chain.DeployerKey, @@ -462,6 +484,7 @@ func TestEnforceMCMSUsageIfProd(t *testing.T) { } }) require.NoError(t, err, "failed to deploy capability registry") + require.NoError(t, rt.State().MergeChangesetOutput("test-deploy-cap-reg", cldf.ChangesetOutput{DataStore: ds})) } if test.DeployMCMS { diff --git a/deployment/ccip/shared/stateview/ton/state.go b/deployment/ccip/shared/stateview/ton/state.go index 4794f5237ee..1d861fa0e06 100644 --- a/deployment/ccip/shared/stateview/ton/state.go +++ b/deployment/ccip/shared/stateview/ton/state.go @@ -2,11 +2,13 @@ package ton import ( "errors" + "fmt" "github.com/Masterminds/semver/v3" "github.com/rs/zerolog/log" cldf_ton "github.com/smartcontractkit/chainlink-deployments-framework/chain/ton" + "github.com/smartcontractkit/chainlink-deployments-framework/datastore" cldf "github.com/smartcontractkit/chainlink-deployments-framework/deployment" "github.com/smartcontractkit/chainlink/deployment" @@ -72,16 +74,12 @@ func SaveOnchainState(chainSelector uint64, state CCIPChainState, e cldf.Environ func LoadOnchainState(e cldf.Environment) (map[uint64]CCIPChainState, error) { chains := make(map[uint64]CCIPChainState) + if e.DataStore == nil { + return chains, errors.New("TON state loading requires an environment datastore") + } for chainSelector, chain := range e.BlockChains.TonChains() { - addresses, err := e.ExistingAddresses.AddressesForChain(chainSelector) - if err != nil { - // Chain not found in address book, initialize empty - if !errors.Is(err, cldf.ErrChainNotFound) { - return chains, err - } - addresses = make(map[string]cldf.TypeAndVersion) - } - chainState, err := loadChainState(chain, addresses) + refs := e.DataStore.Addresses().Filter(datastore.AddressRefByChainSelector(chainSelector)) + chainState, err := loadChainState(chain, refs) if err != nil { return chains, err } @@ -90,21 +88,25 @@ func LoadOnchainState(e cldf.Environment) (map[uint64]CCIPChainState, error) { return chains, nil } -// loadChainState Loads all state for a TonChain into state -func loadChainState(chain cldf_ton.Chain, addressTypes map[string]cldf.TypeAndVersion) (CCIPChainState, error) { +// loadChainState loads all state for a TON chain from datastore refs. +func loadChainState(chain cldf_ton.Chain, refs []datastore.AddressRef) (CCIPChainState, error) { _ = chain // TODO: Use chain to access the client if needed state := CCIPChainState{} // Most programs upgraded in place, but some are not so we always want to // load the latest version versions := make(map[cldf.ContractType]semver.Version) - for addressStr, tvStr := range addressTypes { - address, err := address.ParseAddr(addressStr) + for _, ref := range refs { + if ref.Version == nil { + return state, fmt.Errorf("datastore ref for %s has no version", ref.Address) + } + address, err := address.ParseAddr(ref.Address) if err != nil { return state, err } + contractType := cldf.ContractType(ref.Type) - switch tvStr.Type { + switch contractType { case commontypes.LinkToken: state.LinkTokenAddress = *address case shared.TonReceiver: @@ -118,15 +120,15 @@ func loadChainState(chain cldf_ton.Chain, addressTypes map[string]cldf.TypeAndVe case shared.FeeQuoter: state.FeeQuoter = *address default: - log.Warn().Str("address", addressStr).Str("type", string(tvStr.Type)).Msg("Unknown TON address type") + log.Warn().Str("address", ref.Address).Str("type", string(contractType)).Msg("Unknown TON address type") continue } - existingVersion, ok := versions[tvStr.Type] + existingVersion, ok := versions[contractType] if ok { - log.Warn().Str("existingVersion", existingVersion.String()).Str("type", string(tvStr.Type)).Msg("Duplicate address type found") + log.Warn().Str("existingVersion", existingVersion.String()).Str("type", string(contractType)).Msg("Duplicate address type found") } - versions[tvStr.Type] = tvStr.Version + versions[contractType] = *ref.Version } return state, nil diff --git a/deployment/ccip/shared/types.go b/deployment/ccip/shared/types.go index 96e182f8289..a6ebcbda8e2 100644 --- a/deployment/ccip/shared/types.go +++ b/deployment/ccip/shared/types.go @@ -76,6 +76,7 @@ var ( // Solana Receiver deployment.ContractType = "Receiver" + TestReceiver deployment.ContractType = "TestReceiver" // same program; the deploy pipelines' spelling SPL2022Tokens deployment.ContractType = "SPL2022Tokens" SPLTokens deployment.ContractType = "SPLTokens" WSOL deployment.ContractType = "WSOL" diff --git a/deployment/ccip/view/solana/mcms.go b/deployment/ccip/view/solana/mcms.go index cc6a20d8198..ea77403708c 100644 --- a/deployment/ccip/view/solana/mcms.go +++ b/deployment/ccip/view/solana/mcms.go @@ -60,11 +60,17 @@ type MCMSConfig struct { } func GenerateMCMSWithTimelockView(chain cldf_solana.Chain, addresses map[string]cldf.TypeAndVersion) (MCMSWithTimelockView, error) { - view := MCMSWithTimelockView{} mcmState, err := solstate.MaybeLoadMCMSWithTimelockChainState(chain, addresses) if err != nil { - return view, fmt.Errorf("failed to load mcms with timelock solana chain state: %w", err) + return MCMSWithTimelockView{}, fmt.Errorf("failed to load mcms with timelock solana chain state: %w", err) } + return GenerateMCMSWithTimelockViewFromState(chain, mcmState) +} + +// GenerateMCMSWithTimelockViewFromState builds the MCMS view from an already-resolved +// datastore-backed MCMS state. +func GenerateMCMSWithTimelockViewFromState(chain cldf_solana.Chain, mcmState *solstate.MCMSWithTimelockState) (MCMSWithTimelockView, error) { + view := MCMSWithTimelockView{} timelockConfigPDA := pdasol.GetTimelockConfigPDA(mcmState.TimelockProgram, mcmState.TimelockSeed) progDataAddr, err := solutils.GetProgramDataAddress(chain.Client, mcmState.TimelockProgram) if err != nil { diff --git a/deployment/environment/crib/ccip_deployer.go b/deployment/environment/crib/ccip_deployer.go index e1b8269bac3..2f2d059ec4d 100644 --- a/deployment/environment/crib/ccip_deployer.go +++ b/deployment/environment/crib/ccip_deployer.go @@ -419,7 +419,7 @@ func setupChains(lggr logger.Logger, e *cldf.Environment, homeChainSel, feedChai ) lggr.Info("Starting changeset deployment, this will take long on first run due to anchor build for solana programs") - solCs, err := testhelpers.DeployChainContractsToSolChainCS(deployedEnv, solChainSelectors[0], false, &buildConfig) + solCs, err := testhelpers.DeployChainContractsToSolChainCS(&deployedEnv, solChainSelectors[0], false, &buildConfig) if err != nil { return *e, err } diff --git a/deployment/go.mod b/deployment/go.mod index 75ea00ca32f..a698ba1f784 100644 --- a/deployment/go.mod +++ b/deployment/go.mod @@ -37,9 +37,9 @@ require ( github.com/smartcontractkit/ccip-contract-examples/chains/evm v0.0.0-20260129135848-c86808ba5cb9 github.com/smartcontractkit/ccip-owner-contracts v0.2.1 github.com/smartcontractkit/chain-selectors v1.0.111 - github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 + github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c - github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754 + github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26 github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-ccip/chains/evm v0.0.0-20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50 @@ -60,13 +60,13 @@ require ( github.com/smartcontractkit/chainlink-solana/contracts v0.0.0-20260513123719-d347eaf314e1 github.com/smartcontractkit/chainlink-stellar v0.0.7 github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f - github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 + github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 - github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695 + github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3 github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 - github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff - github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260520103847-15ca4de9dba9 + github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 + github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150 // Using a separate inline `require` here to avoid surrounding line changes // creating potential merge conflicts. github.com/smartcontractkit/chainlink/v2 v2.29.0 @@ -84,7 +84,7 @@ require ( github.com/xssnick/tonutils-go v1.14.1 github.com/zksync-sdk/zksync2-go v1.1.1-0.20250620124214-2c742ee399c6 go.uber.org/zap v1.28.0 - golang.org/x/crypto v0.55.0 + golang.org/x/crypto v0.56.0 golang.org/x/exp v0.0.0-20260820142414-ca536658362e golang.org/x/mod v0.39.0 golang.org/x/oauth2 v0.36.0 @@ -457,7 +457,7 @@ require ( github.com/smartcontractkit/chainlink-protos/workflows/go v0.0.0-20260821155228-fa1d775e2138 // indirect github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 // indirect github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 // indirect - github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 // indirect + github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 // indirect github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a // indirect github.com/smartcontractkit/go-daml v0.0.0-20260702101944-3a593d4e8e19 // indirect github.com/smartcontractkit/grpc-proxy v0.0.0-20240830132753-a7e17fec5ab7 // indirect diff --git a/deployment/go.sum b/deployment/go.sum index adff72b822e..b682ecfd148 100644 --- a/deployment/go.sum +++ b/deployment/go.sum @@ -1383,12 +1383,12 @@ github.com/smartcontractkit/ccip-owner-contracts v0.2.1 h1:HgrVtzpyqrPCQiyIeoUKc github.com/smartcontractkit/ccip-owner-contracts v0.2.1/go.mod h1:dpKtlTVEKohsbhnPe/r1oLFqfq7TP7iKvMaUOiidAaM= github.com/smartcontractkit/chain-selectors v1.0.111 h1:urb/qOyRanxDn+Wras+LULHEHSlJ4tYnfeAHzeMBn5U= github.com/smartcontractkit/chain-selectors v1.0.111/go.mod h1:qy7whtgG5g+7z0jt0nRyii9bLND9m15NZTzuQPkMZ5w= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 h1:gIlepiEA6cYoYtIYHV0dsGwrarU5LlXhIZ+AhhPFtRY= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2/go.mod h1:zxbSVfmTCjxN2LdXeOhZS8T5wh6TVDGC40iliRsF62o= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 h1:oOXfhXgp3WjmwMLKwwHbsMPPHUN5aWbrb0SI0WCGbmY= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26/go.mod h1:sblxFnXTTAeDlOgbmEsWN2ubISm50mnAf8nQkWpvMB4= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c h1:aDS7I+SK9mWkDcWlfP5JrDY4NnicC/4KVm30dG7HQaw= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c/go.mod h1:/ABThVk5DzhpsO1A4io8C6cAmqpF8RzgQDlGj98hke0= -github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754 h1:bFgzlJz8H+y0TLyV0Z+ix2WqcvKRMhcS0SmMc9BRZ4g= -github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754/go.mod h1:FBy6zgPkTw4oScyLnU5DeG61dBZzIHrwJfbuYDrH2+k= +github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26 h1:OWIbNGr3drTtPcL6QFg6M0muZrFX0hVlcntNBJ3dtQA= +github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26/go.mod h1:f3oBArdAYosakjbo8n7E+ya9UsIcac+STIjyz7ST0bQ= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 h1:ZjWiy0PXyoQ44HzdcMNKxOa5KB2FcdwHaCga8oMQuho= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0/go.mod h1:uEuyzOQ1x3Ich/n/8EEnxyEoPshPrkQN6zKO+JSw/OQ= github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 h1:V9r1XjIx4XnsavQXjbaoR+FtnRclb0ul60FnGGe0fLQ= @@ -1475,12 +1475,12 @@ github.com/smartcontractkit/chainlink-stellar v0.0.7 h1:1rQtIzA4/9BAdpeLa8CfAwCh github.com/smartcontractkit/chainlink-stellar v0.0.7/go.mod h1:qKAB+TGrVJmEJjK2JF2/Upr//2bS0p9xJ8eXhQug0Sc= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f h1:L4Sl9v4OC4DT4BhZdpKsXyNHUTeJPMYf4dqj1Bl8bKY= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f/go.mod h1:IYBZArxwOQRlcx0Udx/VfFjqJpAs4NrjKsBoNITKAMg= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 h1:EPCKKMypUPDgmTXeBV5Fd3yhwcDjVR6EP1tHoK+XUrU= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695/go.mod h1:PruXFX6Np9pGTRX2gvNe+HphUW7oh6APpBqee/CvB8w= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 h1:b5sxBLD5CBP78zMAgIylaB30rucGN2HudxejW+HGFDc= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:hfe/tfHT/SwMSgVs2bu6gcFoZhbj5+av2vZsN3/FUQo= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 h1:3R9f6pguDIjei+nKx5dUT9j6fX8urGmlZA7Ad3x9UBs= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96/go.mod h1:pSW9q0/YqQE5R65Z/2zsyD9c50JZf+yRJJvN6Jo3LCU= -github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695 h1:8uDR3DXjGb10ENm8tKVF5gYk8qIlyNxi7Zk1AV2mTkE= -github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695/go.mod h1:XVwzVeAreJaJymb8G1s7+YELtvyjc1pFS4cVC8b4O0w= +github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3 h1:eKdEHBa7sHopqtNaUpcQzutZMSLYP76DJWGRwZX9eV0= +github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:7g+hK7EcfLlLAOJfBF4iO1EPweMHNVdz3iA89O9zKTE= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 h1:kndQqDVEVgVN4k1JKFZEi5XsXsMjKOjxi9gKQosj3ss= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8/go.mod h1:0AyKX9qZxTh2yLe/wyluhMESv9LxEB5KZrqcC4jvr9c= github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 h1:/5fgG2lZqqTJ7mr3mUtxbWiUxd/gmDHSEGUERIUPvyU= @@ -1489,12 +1489,12 @@ github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 h1:cWUHB6Q github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2/go.mod h1:Z4K5VJLjsfqIIaBcZ1Sfccxu0xsCxBjPa6zF+5gtQaM= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 h1:RwZXxdIAOyjp6cwc9Quxgr38k8r7ACz+Lxh9o/A6oH0= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5/go.mod h1:kHYJnZUqiPF7/xN5273prV+srrLJkS77GbBXHLKQpx0= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff h1:a0Z9NlZLwP7wClk84lP3iZpKFKzLGkS0U0VReIThaT4= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff/go.mod h1:40yDOuuKaXDBWCbkJBQUeUmgpjOWHpQrs61y5Dch+zA= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 h1:ots2WddFOQJL/tDFGmvrhRrVu2iRXCd0XEAxhpkAE/Y= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= -github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260520103847-15ca4de9dba9 h1:HYiHWl3cZ4XaZ3xt/UEBmn+cKvitTz4urhF2M8ngrBI= -github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260520103847-15ca4de9dba9/go.mod h1:n23plUZrveDJCog5dFj2jK4XD7XJgeCkPBffQy9iJjg= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 h1:D5Sea6RDF9S4uyooSxw/Zhh3oGoDJQmbxgbXAI4F2vc= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150/go.mod h1:1RCKAzvGOLC/51vbJUOPPjx5uxTCxeL0QXU32UvQeug= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 h1:fl7VPhcgZA3r3eFg5/xEUDZ/BU6Z/9TfdEhPkZSEIuM= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= +github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150 h1:ns1kSUTdP8a4h1zDfAAN/qOqdlJNjsF4YcAxR5sXcDg= +github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150/go.mod h1:N/VSMMb/2M3+HZDxBBnLgZ4KxQjbIXJ76SzHd6sNZN8= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a h1:Xu8iBnBQEibWIXTCwKYf8okXjFtzJ0KochjL03h+T40= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a/go.mod h1:1eaXR+Fe6TlpP+CKXozfYlFM8QgN/N5C7OMvTRWNT8I= github.com/smartcontractkit/chainlink-tron/relayer/gotron-sdk v0.0.5-0.20260218133534-cbd44da2856b h1:RarA5fTnBzQY9wHhl6g7Ac7Nv0d/izr2/zuSWhveB4c= @@ -1838,8 +1838,8 @@ golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0 golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.20.0/go.mod h1:Xwo95rrVNIoSMx9wa1JroENMToLWn3RNVrTBpLHgZPQ= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= +golang.org/x/crypto v0.56.0 h1:GUh5Ii4J5jtcseSMiRqr1jXCNHoxjeV9Fmekc2oLy6Y= +golang.org/x/crypto v0.56.0/go.mod h1:OMW5y6CY9l38uPLmxU6l6pwcXp1obtLo3e6gT7gQR2I= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= diff --git a/integration-tests/go.mod b/integration-tests/go.mod index db152dc26c5..74ea5146188 100644 --- a/integration-tests/go.mod +++ b/integration-tests/go.mod @@ -28,8 +28,8 @@ require ( github.com/rs/zerolog v1.35.1 github.com/segmentio/ksuid v1.0.4 github.com/smartcontractkit/chain-selectors v1.0.111 - github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 - github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754 + github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 + github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26 github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-ccip/chains/evm v0.0.0-20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50 @@ -40,9 +40,9 @@ require ( github.com/smartcontractkit/chainlink-evm v0.3.4-0.20260917132551-2a2b38e8b744 github.com/smartcontractkit/chainlink-evm/gethwrappers v0.0.0-20260713161920-de075095648b github.com/smartcontractkit/chainlink-protos/job-distributor v0.20.1-0.20260701185448-696c075849ea - github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 + github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 - github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695 + github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3 github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 @@ -438,9 +438,9 @@ require ( github.com/smartcontractkit/chainlink-solana v1.3.1-0.20260605202330-b5a89c32fdc1 // indirect github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f // indirect github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 // indirect - github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff // indirect - github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 // indirect - github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260601214705-1ab0adfd785f // indirect + github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 // indirect + github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 // indirect + github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150 // indirect github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a // indirect github.com/smartcontractkit/freeport v0.1.3-0.20250828155247-add56fa28aad // indirect github.com/smartcontractkit/go-daml v0.0.0-20260702101944-3a593d4e8e19 // indirect @@ -523,7 +523,7 @@ require ( go.yaml.in/yaml/v3 v3.0.5 // indirect go.yaml.in/yaml/v4 v4.0.0-rc.4 // indirect golang.org/x/arch v0.22.0 // indirect - golang.org/x/crypto v0.55.0 // indirect + golang.org/x/crypto v0.56.0 // indirect golang.org/x/mod v0.39.0 // indirect golang.org/x/net v0.58.0 // indirect golang.org/x/oauth2 v0.36.0 // indirect diff --git a/integration-tests/go.sum b/integration-tests/go.sum index 2589141dd72..f37e92a6dfd 100644 --- a/integration-tests/go.sum +++ b/integration-tests/go.sum @@ -1372,12 +1372,12 @@ github.com/smartcontractkit/ccip-owner-contracts v0.2.1 h1:HgrVtzpyqrPCQiyIeoUKc github.com/smartcontractkit/ccip-owner-contracts v0.2.1/go.mod h1:dpKtlTVEKohsbhnPe/r1oLFqfq7TP7iKvMaUOiidAaM= github.com/smartcontractkit/chain-selectors v1.0.111 h1:urb/qOyRanxDn+Wras+LULHEHSlJ4tYnfeAHzeMBn5U= github.com/smartcontractkit/chain-selectors v1.0.111/go.mod h1:qy7whtgG5g+7z0jt0nRyii9bLND9m15NZTzuQPkMZ5w= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 h1:gIlepiEA6cYoYtIYHV0dsGwrarU5LlXhIZ+AhhPFtRY= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2/go.mod h1:zxbSVfmTCjxN2LdXeOhZS8T5wh6TVDGC40iliRsF62o= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 h1:oOXfhXgp3WjmwMLKwwHbsMPPHUN5aWbrb0SI0WCGbmY= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26/go.mod h1:sblxFnXTTAeDlOgbmEsWN2ubISm50mnAf8nQkWpvMB4= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c h1:aDS7I+SK9mWkDcWlfP5JrDY4NnicC/4KVm30dG7HQaw= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c/go.mod h1:/ABThVk5DzhpsO1A4io8C6cAmqpF8RzgQDlGj98hke0= -github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754 h1:bFgzlJz8H+y0TLyV0Z+ix2WqcvKRMhcS0SmMc9BRZ4g= -github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754/go.mod h1:FBy6zgPkTw4oScyLnU5DeG61dBZzIHrwJfbuYDrH2+k= +github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26 h1:OWIbNGr3drTtPcL6QFg6M0muZrFX0hVlcntNBJ3dtQA= +github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26/go.mod h1:f3oBArdAYosakjbo8n7E+ya9UsIcac+STIjyz7ST0bQ= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 h1:ZjWiy0PXyoQ44HzdcMNKxOa5KB2FcdwHaCga8oMQuho= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0/go.mod h1:uEuyzOQ1x3Ich/n/8EEnxyEoPshPrkQN6zKO+JSw/OQ= github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 h1:V9r1XjIx4XnsavQXjbaoR+FtnRclb0ul60FnGGe0fLQ= @@ -1460,12 +1460,12 @@ github.com/smartcontractkit/chainlink-solana v1.3.1-0.20260605202330-b5a89c32fdc github.com/smartcontractkit/chainlink-solana v1.3.1-0.20260605202330-b5a89c32fdc1/go.mod h1:wi1QdXqhSJnADt9YRaRtEWomqknLcrdkTS0JotupuOQ= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f h1:L4Sl9v4OC4DT4BhZdpKsXyNHUTeJPMYf4dqj1Bl8bKY= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f/go.mod h1:IYBZArxwOQRlcx0Udx/VfFjqJpAs4NrjKsBoNITKAMg= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 h1:EPCKKMypUPDgmTXeBV5Fd3yhwcDjVR6EP1tHoK+XUrU= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695/go.mod h1:PruXFX6Np9pGTRX2gvNe+HphUW7oh6APpBqee/CvB8w= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 h1:b5sxBLD5CBP78zMAgIylaB30rucGN2HudxejW+HGFDc= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:hfe/tfHT/SwMSgVs2bu6gcFoZhbj5+av2vZsN3/FUQo= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 h1:3R9f6pguDIjei+nKx5dUT9j6fX8urGmlZA7Ad3x9UBs= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96/go.mod h1:pSW9q0/YqQE5R65Z/2zsyD9c50JZf+yRJJvN6Jo3LCU= -github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695 h1:8uDR3DXjGb10ENm8tKVF5gYk8qIlyNxi7Zk1AV2mTkE= -github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695/go.mod h1:XVwzVeAreJaJymb8G1s7+YELtvyjc1pFS4cVC8b4O0w= +github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3 h1:eKdEHBa7sHopqtNaUpcQzutZMSLYP76DJWGRwZX9eV0= +github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:7g+hK7EcfLlLAOJfBF4iO1EPweMHNVdz3iA89O9zKTE= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 h1:kndQqDVEVgVN4k1JKFZEi5XsXsMjKOjxi9gKQosj3ss= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8/go.mod h1:0AyKX9qZxTh2yLe/wyluhMESv9LxEB5KZrqcC4jvr9c= github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 h1:/5fgG2lZqqTJ7mr3mUtxbWiUxd/gmDHSEGUERIUPvyU= @@ -1474,12 +1474,12 @@ github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 h1:cWUHB6Q github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2/go.mod h1:Z4K5VJLjsfqIIaBcZ1Sfccxu0xsCxBjPa6zF+5gtQaM= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 h1:RwZXxdIAOyjp6cwc9Quxgr38k8r7ACz+Lxh9o/A6oH0= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5/go.mod h1:kHYJnZUqiPF7/xN5273prV+srrLJkS77GbBXHLKQpx0= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff h1:a0Z9NlZLwP7wClk84lP3iZpKFKzLGkS0U0VReIThaT4= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff/go.mod h1:40yDOuuKaXDBWCbkJBQUeUmgpjOWHpQrs61y5Dch+zA= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 h1:ots2WddFOQJL/tDFGmvrhRrVu2iRXCd0XEAxhpkAE/Y= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= -github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260601214705-1ab0adfd785f h1:dQltDzVCaeIR1+aOOTdiY6xW7qSXcv3NqZp9WkoVqbI= -github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260601214705-1ab0adfd785f/go.mod h1:n23plUZrveDJCog5dFj2jK4XD7XJgeCkPBffQy9iJjg= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 h1:D5Sea6RDF9S4uyooSxw/Zhh3oGoDJQmbxgbXAI4F2vc= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150/go.mod h1:1RCKAzvGOLC/51vbJUOPPjx5uxTCxeL0QXU32UvQeug= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 h1:fl7VPhcgZA3r3eFg5/xEUDZ/BU6Z/9TfdEhPkZSEIuM= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= +github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150 h1:ns1kSUTdP8a4h1zDfAAN/qOqdlJNjsF4YcAxR5sXcDg= +github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150/go.mod h1:N/VSMMb/2M3+HZDxBBnLgZ4KxQjbIXJ76SzHd6sNZN8= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a h1:Xu8iBnBQEibWIXTCwKYf8okXjFtzJ0KochjL03h+T40= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a/go.mod h1:1eaXR+Fe6TlpP+CKXozfYlFM8QgN/N5C7OMvTRWNT8I= github.com/smartcontractkit/chainlink-tron/relayer/gotron-sdk v0.0.5-0.20260218133534-cbd44da2856b h1:RarA5fTnBzQY9wHhl6g7Ac7Nv0d/izr2/zuSWhveB4c= @@ -1818,8 +1818,8 @@ golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0 golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.20.0/go.mod h1:Xwo95rrVNIoSMx9wa1JroENMToLWn3RNVrTBpLHgZPQ= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= +golang.org/x/crypto v0.56.0 h1:GUh5Ii4J5jtcseSMiRqr1jXCNHoxjeV9Fmekc2oLy6Y= +golang.org/x/crypto v0.56.0/go.mod h1:OMW5y6CY9l38uPLmxU6l6pwcXp1obtLo3e6gT7gQR2I= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= diff --git a/integration-tests/load/go.mod b/integration-tests/load/go.mod index fcda35ed4e6..2aadbe7a5c1 100644 --- a/integration-tests/load/go.mod +++ b/integration-tests/load/go.mod @@ -19,7 +19,7 @@ require ( github.com/gagliardetto/solana-go v1.23.0 github.com/rs/zerolog v1.35.1 github.com/smartcontractkit/chain-selectors v1.0.111 - github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 + github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-ccip/chains/evm v0.0.0-20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50 @@ -475,7 +475,7 @@ require ( github.com/smartcontractkit/ccip-contract-examples/chains/evm v0.0.0-20260129135848-c86808ba5cb9 // indirect github.com/smartcontractkit/ccip-owner-contracts v0.2.1 // indirect github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c // indirect - github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754 // indirect + github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26 // indirect github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 // indirect github.com/smartcontractkit/chainlink-ccip/chains/solana/deployment v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 // indirect @@ -510,15 +510,15 @@ require ( github.com/smartcontractkit/chainlink-protos/workflows/go v0.0.0-20260821155228-fa1d775e2138 // indirect github.com/smartcontractkit/chainlink-solana v1.3.1-0.20260605202330-b5a89c32fdc1 // indirect github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f // indirect - github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 // indirect + github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 // indirect github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 // indirect - github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695 // indirect + github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3 // indirect github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 // indirect github.com/smartcontractkit/chainlink-testing-framework/lib/grafana v1.51.0 // indirect github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 // indirect - github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff // indirect - github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 // indirect - github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260601214705-1ab0adfd785f // indirect + github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 // indirect + github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 // indirect + github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150 // indirect github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a // indirect github.com/smartcontractkit/cld-changesets v0.9.1-0.20260911120037-95e1c8bcb265 // indirect github.com/smartcontractkit/freeport v0.1.3-0.20250828155247-add56fa28aad // indirect @@ -628,7 +628,7 @@ require ( go.yaml.in/yaml/v4 v4.0.0-rc.4 // indirect go4.org/netipx v0.0.0-20230125063823-8449b0a6169f // indirect golang.org/x/arch v0.22.0 // indirect - golang.org/x/crypto v0.55.0 // indirect + golang.org/x/crypto v0.56.0 // indirect golang.org/x/exp v0.0.0-20260820142414-ca536658362e // indirect golang.org/x/mod v0.39.0 // indirect golang.org/x/net v0.58.0 // indirect diff --git a/integration-tests/load/go.sum b/integration-tests/load/go.sum index 474e73032ee..4df6d217e75 100644 --- a/integration-tests/load/go.sum +++ b/integration-tests/load/go.sum @@ -1610,12 +1610,12 @@ github.com/smartcontractkit/ccip-owner-contracts v0.2.1 h1:HgrVtzpyqrPCQiyIeoUKc github.com/smartcontractkit/ccip-owner-contracts v0.2.1/go.mod h1:dpKtlTVEKohsbhnPe/r1oLFqfq7TP7iKvMaUOiidAaM= github.com/smartcontractkit/chain-selectors v1.0.111 h1:urb/qOyRanxDn+Wras+LULHEHSlJ4tYnfeAHzeMBn5U= github.com/smartcontractkit/chain-selectors v1.0.111/go.mod h1:qy7whtgG5g+7z0jt0nRyii9bLND9m15NZTzuQPkMZ5w= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 h1:gIlepiEA6cYoYtIYHV0dsGwrarU5LlXhIZ+AhhPFtRY= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2/go.mod h1:zxbSVfmTCjxN2LdXeOhZS8T5wh6TVDGC40iliRsF62o= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 h1:oOXfhXgp3WjmwMLKwwHbsMPPHUN5aWbrb0SI0WCGbmY= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26/go.mod h1:sblxFnXTTAeDlOgbmEsWN2ubISm50mnAf8nQkWpvMB4= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c h1:aDS7I+SK9mWkDcWlfP5JrDY4NnicC/4KVm30dG7HQaw= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c/go.mod h1:/ABThVk5DzhpsO1A4io8C6cAmqpF8RzgQDlGj98hke0= -github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754 h1:bFgzlJz8H+y0TLyV0Z+ix2WqcvKRMhcS0SmMc9BRZ4g= -github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260706100550-d43558069754/go.mod h1:FBy6zgPkTw4oScyLnU5DeG61dBZzIHrwJfbuYDrH2+k= +github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26 h1:OWIbNGr3drTtPcL6QFg6M0muZrFX0hVlcntNBJ3dtQA= +github.com/smartcontractkit/chainlink-aptos/deployment v0.0.0-20260923062809-ca886ade4d26/go.mod h1:f3oBArdAYosakjbo8n7E+ya9UsIcac+STIjyz7ST0bQ= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 h1:ZjWiy0PXyoQ44HzdcMNKxOa5KB2FcdwHaCga8oMQuho= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0/go.mod h1:uEuyzOQ1x3Ich/n/8EEnxyEoPshPrkQN6zKO+JSw/OQ= github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 h1:V9r1XjIx4XnsavQXjbaoR+FtnRclb0ul60FnGGe0fLQ= @@ -1698,12 +1698,12 @@ github.com/smartcontractkit/chainlink-solana v1.3.1-0.20260605202330-b5a89c32fdc github.com/smartcontractkit/chainlink-solana v1.3.1-0.20260605202330-b5a89c32fdc1/go.mod h1:wi1QdXqhSJnADt9YRaRtEWomqknLcrdkTS0JotupuOQ= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f h1:L4Sl9v4OC4DT4BhZdpKsXyNHUTeJPMYf4dqj1Bl8bKY= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f/go.mod h1:IYBZArxwOQRlcx0Udx/VfFjqJpAs4NrjKsBoNITKAMg= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 h1:EPCKKMypUPDgmTXeBV5Fd3yhwcDjVR6EP1tHoK+XUrU= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695/go.mod h1:PruXFX6Np9pGTRX2gvNe+HphUW7oh6APpBqee/CvB8w= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 h1:b5sxBLD5CBP78zMAgIylaB30rucGN2HudxejW+HGFDc= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:hfe/tfHT/SwMSgVs2bu6gcFoZhbj5+av2vZsN3/FUQo= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 h1:3R9f6pguDIjei+nKx5dUT9j6fX8urGmlZA7Ad3x9UBs= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96/go.mod h1:pSW9q0/YqQE5R65Z/2zsyD9c50JZf+yRJJvN6Jo3LCU= -github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695 h1:8uDR3DXjGb10ENm8tKVF5gYk8qIlyNxi7Zk1AV2mTkE= -github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260827120130-362c4a408695/go.mod h1:XVwzVeAreJaJymb8G1s7+YELtvyjc1pFS4cVC8b4O0w= +github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3 h1:eKdEHBa7sHopqtNaUpcQzutZMSLYP76DJWGRwZX9eV0= +github.com/smartcontractkit/chainlink-sui/deployment v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:7g+hK7EcfLlLAOJfBF4iO1EPweMHNVdz3iA89O9zKTE= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 h1:kndQqDVEVgVN4k1JKFZEi5XsXsMjKOjxi9gKQosj3ss= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8/go.mod h1:0AyKX9qZxTh2yLe/wyluhMESv9LxEB5KZrqcC4jvr9c= github.com/smartcontractkit/chainlink-testing-framework/havoc v1.50.5 h1:S5HND0EDtlA+xp2E+mD11DlUTp2wD6uojwixye8ZB/k= @@ -1718,12 +1718,12 @@ github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 h1:RwZXxdIA github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5/go.mod h1:kHYJnZUqiPF7/xN5273prV+srrLJkS77GbBXHLKQpx0= github.com/smartcontractkit/chainlink-testing-framework/wasp v1.53.0 h1:Rko/32VBSd46XBUJoSpuWJKTOOaNYm+8VRorDiENoCI= github.com/smartcontractkit/chainlink-testing-framework/wasp v1.53.0/go.mod h1:YEXSf+gWyc8sy+yl9B5mDApeikcguQDlCZQ/TpnixxU= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff h1:a0Z9NlZLwP7wClk84lP3iZpKFKzLGkS0U0VReIThaT4= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff/go.mod h1:40yDOuuKaXDBWCbkJBQUeUmgpjOWHpQrs61y5Dch+zA= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 h1:ots2WddFOQJL/tDFGmvrhRrVu2iRXCd0XEAxhpkAE/Y= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= -github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260601214705-1ab0adfd785f h1:dQltDzVCaeIR1+aOOTdiY6xW7qSXcv3NqZp9WkoVqbI= -github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260601214705-1ab0adfd785f/go.mod h1:n23plUZrveDJCog5dFj2jK4XD7XJgeCkPBffQy9iJjg= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 h1:D5Sea6RDF9S4uyooSxw/Zhh3oGoDJQmbxgbXAI4F2vc= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150/go.mod h1:1RCKAzvGOLC/51vbJUOPPjx5uxTCxeL0QXU32UvQeug= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 h1:fl7VPhcgZA3r3eFg5/xEUDZ/BU6Z/9TfdEhPkZSEIuM= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= +github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150 h1:ns1kSUTdP8a4h1zDfAAN/qOqdlJNjsF4YcAxR5sXcDg= +github.com/smartcontractkit/chainlink-ton/deployment v0.0.0-20260824235525-aea7e0904150/go.mod h1:N/VSMMb/2M3+HZDxBBnLgZ4KxQjbIXJ76SzHd6sNZN8= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a h1:Xu8iBnBQEibWIXTCwKYf8okXjFtzJ0KochjL03h+T40= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a/go.mod h1:1eaXR+Fe6TlpP+CKXozfYlFM8QgN/N5C7OMvTRWNT8I= github.com/smartcontractkit/chainlink-tron/relayer/gotron-sdk v0.0.5-0.20260218133534-cbd44da2856b h1:RarA5fTnBzQY9wHhl6g7Ac7Nv0d/izr2/zuSWhveB4c= @@ -2146,8 +2146,8 @@ golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDf golang.org/x/crypto v0.20.0/go.mod h1:Xwo95rrVNIoSMx9wa1JroENMToLWn3RNVrTBpLHgZPQ= golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= +golang.org/x/crypto v0.56.0 h1:GUh5Ii4J5jtcseSMiRqr1jXCNHoxjeV9Fmekc2oLy6Y= +golang.org/x/crypto v0.56.0/go.mod h1:OMW5y6CY9l38uPLmxU6l6pwcXp1obtLo3e6gT7gQR2I= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= diff --git a/integration-tests/smoke/ccip/ccip_aptos_messaging_test.go b/integration-tests/smoke/ccip/ccip_aptos_messaging_test.go index 9f3fa697e7c..4c91d358987 100644 --- a/integration-tests/smoke/ccip/ccip_aptos_messaging_test.go +++ b/integration-tests/smoke/ccip/ccip_aptos_messaging_test.go @@ -44,7 +44,7 @@ func Test_CCIP_Messaging_EVM2Aptos(t *testing.T) { aptosChainSelectors := e.Env.BlockChains.ListChainSelectors(chain.WithFamily(chain_selectors.FamilyAptos)) // Deploy the dummy receiver contract - testhelpers.DeployAptosCCIPReceiver(t, e.Env) + testhelpers.DeployAptosCCIPReceiver(t, &e.Env) state, err := stateview.LoadOnchainState(e.Env) require.NoError(t, err) diff --git a/integration-tests/smoke/ccip/ccip_aptos_regulated_token_transfer_test.go b/integration-tests/smoke/ccip/ccip_aptos_regulated_token_transfer_test.go index a63540d7383..522284201f3 100644 --- a/integration-tests/smoke/ccip/ccip_aptos_regulated_token_transfer_test.go +++ b/integration-tests/smoke/ccip/ccip_aptos_regulated_token_transfer_test.go @@ -35,7 +35,7 @@ func Test_CCIP_RegulatedTokenTransfer_EVM2Aptos(t *testing.T) { aptosChainSelectors := e.Env.BlockChains.ListChainSelectors(chain.WithFamily(chain_selectors.FamilyAptos)) // Deploy the dummy receiver contract - testhelpers.DeployAptosCCIPReceiver(t, e.Env) + testhelpers.DeployAptosCCIPReceiver(t, &e.Env) state, err := stateview.LoadOnchainState(e.Env) require.NoError(t, err) @@ -51,7 +51,7 @@ func Test_CCIP_RegulatedTokenTransfer_EVM2Aptos(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployRegulatedTransferableTokenAptos(t, lggr, e.Env, sourceChain, destChain, "Regulated Token", nil) + evmToken, _, aptosToken, _, err := testhelpers.DeployRegulatedTransferableTokenAptos(t, lggr, &e.Env, sourceChain, destChain, "Regulated Token", nil) require.NoError(t, err) testhelpers.MintAndAllow( @@ -172,7 +172,7 @@ func Test_CCIP_RegulatedTokenTransfer_Aptos2EVM(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployRegulatedTransferableTokenAptos(t, lggr, e.Env, destChain, sourceChain, "Regulated Token", &config.TokenMint{ + evmToken, _, aptosToken, _, err := testhelpers.DeployRegulatedTransferableTokenAptos(t, lggr, &e.Env, destChain, sourceChain, "Regulated Token", &config.TokenMint{ To: deployerSourceChain, Amount: 10e8, }) diff --git a/integration-tests/smoke/ccip/ccip_aptos_token_transfer_test.go b/integration-tests/smoke/ccip/ccip_aptos_token_transfer_test.go index 66c660b7383..e0f7cb072b3 100644 --- a/integration-tests/smoke/ccip/ccip_aptos_token_transfer_test.go +++ b/integration-tests/smoke/ccip/ccip_aptos_token_transfer_test.go @@ -44,7 +44,7 @@ func Test_CCIP_TokenTransfer_EVM2Aptos(t *testing.T) { aptosChainSelectors := e.Env.BlockChains.ListChainSelectors(chain.WithFamily(chain_selectors.FamilyAptos)) // Deploy the dummy receiver contract - testhelpers.DeployAptosCCIPReceiver(t, e.Env) + testhelpers.DeployAptosCCIPReceiver(t, &e.Env) state, err := stateview.LoadOnchainState(e.Env) require.NoError(t, err) @@ -60,7 +60,7 @@ func Test_CCIP_TokenTransfer_EVM2Aptos(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployTransferableTokenAptos(t, lggr, e.Env, sourceChain, destChain, "TOKEN", nil) + evmToken, _, aptosToken, _, err := testhelpers.DeployTransferableTokenAptos(t, lggr, &e.Env, sourceChain, destChain, "TOKEN", nil) require.NoError(t, err) testhelpers.MintAndAllow( @@ -296,7 +296,7 @@ func Test_CCIP_TokenTransfer_Aptos2EVM(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployTransferableTokenAptos(t, lggr, e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ + evmToken, _, aptosToken, _, err := testhelpers.DeployTransferableTokenAptos(t, lggr, &e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ To: deployerSourceChain, Amount: 10e8, }) @@ -547,7 +547,7 @@ func Test_CCIP_TokenTransfer_BnM_EVM2Aptos(t *testing.T) { aptosChainSelectors := e.Env.BlockChains.ListChainSelectors(chain.WithFamily(chain_selectors.FamilyAptos)) // Deploy the dummy receiver contract - testhelpers.DeployAptosCCIPReceiver(t, e.Env) + testhelpers.DeployAptosCCIPReceiver(t, &e.Env) state, err := stateview.LoadOnchainState(e.Env) require.NoError(t, err) @@ -563,7 +563,7 @@ func Test_CCIP_TokenTransfer_BnM_EVM2Aptos(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployBnMTokenAptos(t, lggr, e.Env, sourceChain, destChain, "TOKEN", nil) + evmToken, _, aptosToken, _, err := testhelpers.DeployBnMTokenAptos(t, lggr, &e.Env, sourceChain, destChain, "TOKEN", nil) require.NoError(t, err) testhelpers.MintAndAllow( @@ -799,7 +799,7 @@ func Test_CCIP_TokenTransfer_BnM_Aptos2EVM(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployBnMTokenAptos(t, lggr, e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ + evmToken, _, aptosToken, _, err := testhelpers.DeployBnMTokenAptos(t, lggr, &e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ To: deployerSourceChain, Amount: 10e8, }) @@ -1050,7 +1050,7 @@ func Test_CCIP_TokenTransfer_LnR_EVM2Aptos(t *testing.T) { aptosChainSelectors := e.Env.BlockChains.ListChainSelectors(chain.WithFamily(chain_selectors.FamilyAptos)) // Deploy the dummy receiver contract - testhelpers.DeployAptosCCIPReceiver(t, e.Env) + testhelpers.DeployAptosCCIPReceiver(t, &e.Env) state, err := stateview.LoadOnchainState(e.Env) require.NoError(t, err) @@ -1068,7 +1068,7 @@ func Test_CCIP_TokenTransfer_LnR_EVM2Aptos(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, aptosTokenPool, err := testhelpers.DeployLnRTokenAptos(t, lggr, e.Env, sourceChain, destChain, "TOKEN", &config.TokenMint{ + evmToken, _, aptosToken, aptosTokenPool, err := testhelpers.DeployLnRTokenAptos(t, lggr, &e.Env, sourceChain, destChain, "TOKEN", &config.TokenMint{ To: deployerAddressDestChain, Amount: 100e8, }, @@ -1326,7 +1326,7 @@ func Test_CCIP_TokenTransfer_LnR_Aptos2EVM(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployLnRTokenAptos(t, lggr, e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ + evmToken, _, aptosToken, _, err := testhelpers.DeployLnRTokenAptos(t, lggr, &e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ To: deployerSourceChain, Amount: 110e8, }, @@ -1580,7 +1580,7 @@ func Test_CCIP_TokenTransfer_LnR_without_TransferRef_EVM2Aptos(t *testing.T) { aptosChainSelectors := e.Env.BlockChains.ListChainSelectors(chain.WithFamily(chain_selectors.FamilyAptos)) // Deploy the dummy receiver contract - testhelpers.DeployAptosCCIPReceiver(t, e.Env) + testhelpers.DeployAptosCCIPReceiver(t, &e.Env) state, err := stateview.LoadOnchainState(e.Env) require.NoError(t, err) @@ -1598,7 +1598,7 @@ func Test_CCIP_TokenTransfer_LnR_without_TransferRef_EVM2Aptos(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, aptosTokenPool, err := testhelpers.DeployLnRTokenAptos(t, lggr, e.Env, sourceChain, destChain, "TOKEN", &config.TokenMint{ + evmToken, _, aptosToken, aptosTokenPool, err := testhelpers.DeployLnRTokenAptos(t, lggr, &e.Env, sourceChain, destChain, "TOKEN", &config.TokenMint{ To: deployerAddressDestChain, Amount: 100e8, }, @@ -1856,7 +1856,7 @@ func Test_CCIP_TokenTransfer_LnR_without_TransferRef_Aptos2EVM(t *testing.T) { err = testhelpers.AddLaneWithDefaultPricesAndFeeQuoterConfig(t, &e, state, sourceChain, destChain, false) require.NoError(t, err) - evmToken, _, aptosToken, _, err := testhelpers.DeployLnRTokenAptos(t, lggr, e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ + evmToken, _, aptosToken, _, err := testhelpers.DeployLnRTokenAptos(t, lggr, &e.Env, destChain, sourceChain, "TOKEN", &config.TokenMint{ To: deployerSourceChain, Amount: 110e8, }, diff --git a/integration-tests/smoke/ccip/ccip_fees_test.go b/integration-tests/smoke/ccip/ccip_fees_test.go index 2fec0775b54..93f5d874dcc 100644 --- a/integration-tests/smoke/ccip/ccip_fees_test.go +++ b/integration-tests/smoke/ccip/ccip_fees_test.go @@ -116,7 +116,7 @@ func setupTokens( tenv.Env.BlockChains.EVMChains()[src].DeployerKey, tenv.Env.BlockChains.EVMChains()[dest].DeployerKey, state, - tenv.Env.ExistingAddresses, + &tenv.Env, "MY_TOKEN", ) require.NoError(t, err) diff --git a/integration-tests/smoke/ccip/ccip_lbtc_test.go b/integration-tests/smoke/ccip/ccip_lbtc_test.go index 6ed9987f1d6..8477a34054a 100644 --- a/integration-tests/smoke/ccip/ccip_lbtc_test.go +++ b/integration-tests/smoke/ccip/ccip_lbtc_test.go @@ -66,7 +66,7 @@ func TestLBTCTokenTransfer(t *testing.T) { ownerChainA, ownerChainC, state, - e.ExistingAddresses, //nolint:staticcheck // Addressbook is deprecated, but we still use it for the time being + &tenv.Env, "MY_TOKEN", ) require.NoError(t, err) diff --git a/integration-tests/smoke/ccip/ccip_ooo_execution_test.go b/integration-tests/smoke/ccip/ccip_ooo_execution_test.go index c4722f49d31..d619d571014 100644 --- a/integration-tests/smoke/ccip/ccip_ooo_execution_test.go +++ b/integration-tests/smoke/ccip/ccip_ooo_execution_test.go @@ -64,7 +64,7 @@ func Test_OutOfOrderExecution(t *testing.T) { ownerSourceChain, ownerDestChain, state, - e.ExistingAddresses, + &tenv.Env, "OWNER_TOKEN", ) require.NoError(t, err) diff --git a/integration-tests/smoke/ccip/ccip_token_transfer_test.go b/integration-tests/smoke/ccip/ccip_token_transfer_test.go index a95a0c54b6a..f5ab48fe13b 100644 --- a/integration-tests/smoke/ccip/ccip_token_transfer_test.go +++ b/integration-tests/smoke/ccip/ccip_token_transfer_test.go @@ -66,7 +66,7 @@ func TestTokenTransfer_EVM2EVM(t *testing.T) { ownerSourceChain, ownerDestChain, state, - e.ExistingAddresses, + &tenv.Env, "OWNER_TOKEN", ) require.NoError(t, err) @@ -80,7 +80,7 @@ func TestTokenTransfer_EVM2EVM(t *testing.T) { selfServeSrcTokenPoolDeployer, selfServeDestTokenPoolDeployer, state, - e.ExistingAddresses, + &tenv.Env, "SELF_SERVE_TOKEN", ) require.NoError(t, err) @@ -266,7 +266,7 @@ func TestTokenTransfer_EVM2Solana(t *testing.T) { // Deploy tokens and pool by CCIP Owner srcToken, _, destToken, err := testhelpers.DeployTransferableTokenSolanaV0_1_1( lggr, - e, + &e, sourceChain, destChain, ownerSourceChain, @@ -378,7 +378,7 @@ func TestTokenTransfer_Solana2EVM(t *testing.T) { // Deploy tokens and pool by CCIP Owner destToken, _, srcToken, err := testhelpers.DeployTransferableTokenSolanaV0_1_1( lggr, - e, + &e, destChain, sourceChain, ownerDestChain, diff --git a/integration-tests/smoke/ccip/ccip_usdc_test.go b/integration-tests/smoke/ccip/ccip_usdc_test.go index dedb7ff7681..eb1e48778e1 100644 --- a/integration-tests/smoke/ccip/ccip_usdc_test.go +++ b/integration-tests/smoke/ccip/ccip_usdc_test.go @@ -64,7 +64,7 @@ func TestUSDCTokenTransfer(t *testing.T) { ownerChainA, ownerChainC, state, - e.ExistingAddresses, + &tenv.Env, "MY_TOKEN", ) require.NoError(t, err) diff --git a/lefthook.yml b/lefthook.yml index dad9fc43f70..4e27a74c167 100644 --- a/lefthook.yml +++ b/lefthook.yml @@ -39,6 +39,15 @@ pre-commit: run: typos --force-exclude --format brief {staged_files} fail_text: "typos failed or missing. Install: https://github.com/crate-ci/typos#install" + # Lint GitHub Actions workflow files with actionlint + - name: actionlint + tags: [lint] + glob: + - ".github/**/*.yml" + - ".github/**/*.yaml" + run: tools/githooks/.bin/githooks actionlint {staged_files} + fail_text: "actionlint failed or missing. Install maintained fork: https://github.com/kjanat/actionlint#installation" + - name: fix-and-generate group: jobs: diff --git a/system-tests/lib/go.mod b/system-tests/lib/go.mod index 941aff922d3..5f3bb3c7041 100644 --- a/system-tests/lib/go.mod +++ b/system-tests/lib/go.mod @@ -35,7 +35,7 @@ require ( github.com/scylladb/go-reflectx v1.0.1 github.com/sethvargo/go-retry v0.3.0 github.com/smartcontractkit/chain-selectors v1.0.111 - github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 + github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-common v0.11.2-0.20260921174556-538f4bf0cb6f github.com/smartcontractkit/chainlink-common/keystore v1.3.1-0.20260903141829-ef07b52a737d @@ -64,7 +64,7 @@ require ( github.com/stretchr/testify v1.12.1 go.uber.org/ratelimit v0.3.1 go.uber.org/zap v1.28.0 - golang.org/x/crypto v0.55.0 + golang.org/x/crypto v0.56.0 golang.org/x/sync v0.22.0 google.golang.org/grpc v1.83.2 google.golang.org/protobuf v1.36.12 @@ -490,6 +490,7 @@ require ( github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/chains/evm v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50 // indirect + github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0 // indirect github.com/smartcontractkit/chainlink-common/pkg/chipingress v0.0.11-0.20260915184316-2730f1867c92 // indirect github.com/smartcontractkit/chainlink-data-streams v1.1.1 // indirect @@ -513,12 +514,12 @@ require ( github.com/smartcontractkit/chainlink-protos/storage-service v0.3.0 // indirect github.com/smartcontractkit/chainlink-protos/svr v1.3.0 // indirect github.com/smartcontractkit/chainlink-solana/contracts v0.0.0-20260513123719-d347eaf314e1 // indirect - github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 // indirect + github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 // indirect github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 // indirect github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 // indirect github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 // indirect - github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff // indirect - github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 // indirect + github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 // indirect + github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 // indirect github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a // indirect github.com/smartcontractkit/freeport v0.1.3-0.20250828155247-add56fa28aad // indirect github.com/smartcontractkit/go-daml v0.0.0-20260702101944-3a593d4e8e19 // indirect diff --git a/system-tests/lib/go.sum b/system-tests/lib/go.sum index eb1f55bc6d8..e3bf489d441 100644 --- a/system-tests/lib/go.sum +++ b/system-tests/lib/go.sum @@ -1638,8 +1638,8 @@ github.com/smartcontractkit/ccip-owner-contracts v0.2.1 h1:HgrVtzpyqrPCQiyIeoUKc github.com/smartcontractkit/ccip-owner-contracts v0.2.1/go.mod h1:dpKtlTVEKohsbhnPe/r1oLFqfq7TP7iKvMaUOiidAaM= github.com/smartcontractkit/chain-selectors v1.0.111 h1:urb/qOyRanxDn+Wras+LULHEHSlJ4tYnfeAHzeMBn5U= github.com/smartcontractkit/chain-selectors v1.0.111/go.mod h1:qy7whtgG5g+7z0jt0nRyii9bLND9m15NZTzuQPkMZ5w= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 h1:gIlepiEA6cYoYtIYHV0dsGwrarU5LlXhIZ+AhhPFtRY= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2/go.mod h1:zxbSVfmTCjxN2LdXeOhZS8T5wh6TVDGC40iliRsF62o= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 h1:oOXfhXgp3WjmwMLKwwHbsMPPHUN5aWbrb0SI0WCGbmY= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26/go.mod h1:sblxFnXTTAeDlOgbmEsWN2ubISm50mnAf8nQkWpvMB4= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c h1:aDS7I+SK9mWkDcWlfP5JrDY4NnicC/4KVm30dG7HQaw= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c/go.mod h1:/ABThVk5DzhpsO1A4io8C6cAmqpF8RzgQDlGj98hke0= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 h1:ZjWiy0PXyoQ44HzdcMNKxOa5KB2FcdwHaCga8oMQuho= @@ -1652,6 +1652,8 @@ github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-7 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50/go.mod h1:5snE6Mg2+wYIddLZ5NIUPno3mYa9edyV3EyXJnE54vw= github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50 h1:lSfiz7zcWO4c41yoSoz/50s0y+7UwrRtePgh/GppaKo= github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50/go.mod h1:c++Ed0jeYn4w8WIfiAboRwN6ClRRVGglL0qwB/QjJvM= +github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 h1:mWPykzwWOnWyWfBp//A4hXurwVz1kn+o2rPKydaOSZM= +github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50/go.mod h1:Dm/Abz0vr7F2v9TygUX947q8HIwJEJikDfSdanX1Cic= github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0 h1:3f+Ijgr0vghawMUAitgFILQpt4KsoYHGv1Zb/YBeeQM= github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0/go.mod h1:gX7FJzSnGQx4RAlsn2rRW8IQBlEFZYiXFXEEB5jnQgA= github.com/smartcontractkit/chainlink-common v0.11.2-0.20260921174556-538f4bf0cb6f h1:mj37sJTagtZwTVhU7IIxu6/XCGiK740XmcwXihdKtvk= @@ -1726,8 +1728,8 @@ github.com/smartcontractkit/chainlink-stellar v0.0.7 h1:1rQtIzA4/9BAdpeLa8CfAwCh github.com/smartcontractkit/chainlink-stellar v0.0.7/go.mod h1:qKAB+TGrVJmEJjK2JF2/Upr//2bS0p9xJ8eXhQug0Sc= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f h1:L4Sl9v4OC4DT4BhZdpKsXyNHUTeJPMYf4dqj1Bl8bKY= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f/go.mod h1:IYBZArxwOQRlcx0Udx/VfFjqJpAs4NrjKsBoNITKAMg= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 h1:EPCKKMypUPDgmTXeBV5Fd3yhwcDjVR6EP1tHoK+XUrU= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695/go.mod h1:PruXFX6Np9pGTRX2gvNe+HphUW7oh6APpBqee/CvB8w= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 h1:b5sxBLD5CBP78zMAgIylaB30rucGN2HudxejW+HGFDc= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:hfe/tfHT/SwMSgVs2bu6gcFoZhbj5+av2vZsN3/FUQo= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 h1:3R9f6pguDIjei+nKx5dUT9j6fX8urGmlZA7Ad3x9UBs= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96/go.mod h1:pSW9q0/YqQE5R65Z/2zsyD9c50JZf+yRJJvN6Jo3LCU= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 h1:kndQqDVEVgVN4k1JKFZEi5XsXsMjKOjxi9gKQosj3ss= @@ -1744,10 +1746,10 @@ github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 h1:cWUHB6Q github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2/go.mod h1:Z4K5VJLjsfqIIaBcZ1Sfccxu0xsCxBjPa6zF+5gtQaM= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 h1:RwZXxdIAOyjp6cwc9Quxgr38k8r7ACz+Lxh9o/A6oH0= github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5/go.mod h1:kHYJnZUqiPF7/xN5273prV+srrLJkS77GbBXHLKQpx0= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff h1:a0Z9NlZLwP7wClk84lP3iZpKFKzLGkS0U0VReIThaT4= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff/go.mod h1:40yDOuuKaXDBWCbkJBQUeUmgpjOWHpQrs61y5Dch+zA= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 h1:ots2WddFOQJL/tDFGmvrhRrVu2iRXCd0XEAxhpkAE/Y= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 h1:D5Sea6RDF9S4uyooSxw/Zhh3oGoDJQmbxgbXAI4F2vc= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150/go.mod h1:1RCKAzvGOLC/51vbJUOPPjx5uxTCxeL0QXU32UvQeug= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 h1:fl7VPhcgZA3r3eFg5/xEUDZ/BU6Z/9TfdEhPkZSEIuM= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a h1:Xu8iBnBQEibWIXTCwKYf8okXjFtzJ0KochjL03h+T40= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a/go.mod h1:1eaXR+Fe6TlpP+CKXozfYlFM8QgN/N5C7OMvTRWNT8I= github.com/smartcontractkit/chainlink-tron/relayer/gotron-sdk v0.0.5-0.20260218133534-cbd44da2856b h1:RarA5fTnBzQY9wHhl6g7Ac7Nv0d/izr2/zuSWhveB4c= @@ -2122,8 +2124,8 @@ golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0 golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.20.0/go.mod h1:Xwo95rrVNIoSMx9wa1JroENMToLWn3RNVrTBpLHgZPQ= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= +golang.org/x/crypto v0.56.0 h1:GUh5Ii4J5jtcseSMiRqr1jXCNHoxjeV9Fmekc2oLy6Y= +golang.org/x/crypto v0.56.0/go.mod h1:OMW5y6CY9l38uPLmxU6l6pwcXp1obtLo3e6gT7gQR2I= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= diff --git a/system-tests/tests/go.mod b/system-tests/tests/go.mod index 02682a849f9..8057161b687 100644 --- a/system-tests/tests/go.mod +++ b/system-tests/tests/go.mod @@ -74,7 +74,7 @@ require ( github.com/pkg/errors v0.9.1 github.com/rs/zerolog v1.35.1 github.com/smartcontractkit/chain-selectors v1.0.111 - github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 + github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50 github.com/smartcontractkit/chainlink-common v0.11.2-0.20260921174556-538f4bf0cb6f github.com/smartcontractkit/chainlink-common/keystore v1.3.1-0.20260903141829-ef07b52a737d @@ -623,6 +623,7 @@ require ( github.com/smartcontractkit/chainlink-ccip v0.1.1-solana.0.20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/chains/evm v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50 // indirect + github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 // indirect github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0 // indirect github.com/smartcontractkit/chainlink-data-streams v1.1.1 // indirect github.com/smartcontractkit/chainlink-evm v0.3.4-0.20260917132551-2a2b38e8b744 // indirect @@ -647,15 +648,15 @@ require ( github.com/smartcontractkit/chainlink-solana/contracts v0.0.0-20260513123719-d347eaf314e1 // indirect github.com/smartcontractkit/chainlink-stellar v0.0.7 // indirect github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f // indirect - github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 // indirect + github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 // indirect github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 // indirect github.com/smartcontractkit/chainlink-testing-framework/framework/components/dockercompose v0.1.23 // indirect github.com/smartcontractkit/chainlink-testing-framework/lib v1.54.9 // indirect github.com/smartcontractkit/chainlink-testing-framework/lib/grafana v1.50.0 // indirect github.com/smartcontractkit/chainlink-testing-framework/parrot v0.6.2 // indirect github.com/smartcontractkit/chainlink-testing-framework/wasp v1.53.0 // indirect - github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff // indirect - github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 // indirect + github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 // indirect + github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 // indirect github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a // indirect github.com/smartcontractkit/freeport v0.1.3-0.20250828155247-add56fa28aad // indirect github.com/smartcontractkit/go-daml v0.0.0-20260702101944-3a593d4e8e19 // indirect @@ -773,7 +774,7 @@ require ( go.yaml.in/yaml/v4 v4.0.0-rc.6 // indirect go4.org/netipx v0.0.0-20230125063823-8449b0a6169f // indirect golang.org/x/arch v0.22.0 // indirect - golang.org/x/crypto v0.55.0 // indirect + golang.org/x/crypto v0.56.0 // indirect golang.org/x/exp v0.0.0-20260820142414-ca536658362e // indirect golang.org/x/mod v0.39.0 // indirect golang.org/x/net v0.58.0 // indirect diff --git a/system-tests/tests/go.sum b/system-tests/tests/go.sum index d516a922be0..ed6c08db2c8 100644 --- a/system-tests/tests/go.sum +++ b/system-tests/tests/go.sum @@ -1817,8 +1817,8 @@ github.com/smartcontractkit/ccip-owner-contracts v0.2.1 h1:HgrVtzpyqrPCQiyIeoUKc github.com/smartcontractkit/ccip-owner-contracts v0.2.1/go.mod h1:dpKtlTVEKohsbhnPe/r1oLFqfq7TP7iKvMaUOiidAaM= github.com/smartcontractkit/chain-selectors v1.0.111 h1:urb/qOyRanxDn+Wras+LULHEHSlJ4tYnfeAHzeMBn5U= github.com/smartcontractkit/chain-selectors v1.0.111/go.mod h1:qy7whtgG5g+7z0jt0nRyii9bLND9m15NZTzuQPkMZ5w= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2 h1:gIlepiEA6cYoYtIYHV0dsGwrarU5LlXhIZ+AhhPFtRY= -github.com/smartcontractkit/chainlink-aptos v0.0.0-20260828090428-9828cc37ebc2/go.mod h1:zxbSVfmTCjxN2LdXeOhZS8T5wh6TVDGC40iliRsF62o= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26 h1:oOXfhXgp3WjmwMLKwwHbsMPPHUN5aWbrb0SI0WCGbmY= +github.com/smartcontractkit/chainlink-aptos v0.0.0-20260923062809-ca886ade4d26/go.mod h1:sblxFnXTTAeDlOgbmEsWN2ubISm50mnAf8nQkWpvMB4= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c h1:aDS7I+SK9mWkDcWlfP5JrDY4NnicC/4KVm30dG7HQaw= github.com/smartcontractkit/chainlink-aptos/codec v0.0.0-20260716230027-bd85997bc03c/go.mod h1:/ABThVk5DzhpsO1A4io8C6cAmqpF8RzgQDlGj98hke0= github.com/smartcontractkit/chainlink-canton/contracts/v2 v2.0.0 h1:ZjWiy0PXyoQ44HzdcMNKxOa5KB2FcdwHaCga8oMQuho= @@ -1831,6 +1831,8 @@ github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-7 github.com/smartcontractkit/chainlink-ccip/chains/solana v0.0.0-20260916222901-720a003dab50/go.mod h1:5snE6Mg2+wYIddLZ5NIUPno3mYa9edyV3EyXJnE54vw= github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50 h1:lSfiz7zcWO4c41yoSoz/50s0y+7UwrRtePgh/GppaKo= github.com/smartcontractkit/chainlink-ccip/chains/solana/gobindings v0.0.0-20260916222901-720a003dab50/go.mod h1:c++Ed0jeYn4w8WIfiAboRwN6ClRRVGglL0qwB/QjJvM= +github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50 h1:mWPykzwWOnWyWfBp//A4hXurwVz1kn+o2rPKydaOSZM= +github.com/smartcontractkit/chainlink-ccip/deployment v0.0.0-20260916222901-720a003dab50/go.mod h1:Dm/Abz0vr7F2v9TygUX947q8HIwJEJikDfSdanX1Cic= github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0 h1:3f+Ijgr0vghawMUAitgFILQpt4KsoYHGv1Zb/YBeeQM= github.com/smartcontractkit/chainlink-ccv v0.13.1-0.20260918171034-c93b0d2ef3c0/go.mod h1:gX7FJzSnGQx4RAlsn2rRW8IQBlEFZYiXFXEEB5jnQgA= github.com/smartcontractkit/chainlink-common v0.11.2-0.20260921174556-538f4bf0cb6f h1:mj37sJTagtZwTVhU7IIxu6/XCGiK740XmcwXihdKtvk= @@ -1909,8 +1911,8 @@ github.com/smartcontractkit/chainlink-stellar v0.0.7 h1:1rQtIzA4/9BAdpeLa8CfAwCh github.com/smartcontractkit/chainlink-stellar v0.0.7/go.mod h1:qKAB+TGrVJmEJjK2JF2/Upr//2bS0p9xJ8eXhQug0Sc= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f h1:L4Sl9v4OC4DT4BhZdpKsXyNHUTeJPMYf4dqj1Bl8bKY= github.com/smartcontractkit/chainlink-stellar/bindings v0.0.0-20260901125625-2d505ff46c8f/go.mod h1:IYBZArxwOQRlcx0Udx/VfFjqJpAs4NrjKsBoNITKAMg= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695 h1:EPCKKMypUPDgmTXeBV5Fd3yhwcDjVR6EP1tHoK+XUrU= -github.com/smartcontractkit/chainlink-sui v0.0.0-20260827120130-362c4a408695/go.mod h1:PruXFX6Np9pGTRX2gvNe+HphUW7oh6APpBqee/CvB8w= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3 h1:b5sxBLD5CBP78zMAgIylaB30rucGN2HudxejW+HGFDc= +github.com/smartcontractkit/chainlink-sui v0.0.0-20260922143238-46cc062ae5a3/go.mod h1:hfe/tfHT/SwMSgVs2bu6gcFoZhbj5+av2vZsN3/FUQo= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96 h1:3R9f6pguDIjei+nKx5dUT9j6fX8urGmlZA7Ad3x9UBs= github.com/smartcontractkit/chainlink-sui/codec v0.0.0-20260720132736-e99278bfdc96/go.mod h1:pSW9q0/YqQE5R65Z/2zsyD9c50JZf+yRJJvN6Jo3LCU= github.com/smartcontractkit/chainlink-testing-framework/framework v0.16.8 h1:kndQqDVEVgVN4k1JKFZEi5XsXsMjKOjxi9gKQosj3ss= @@ -1931,10 +1933,10 @@ github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5 h1:RwZXxdIA github.com/smartcontractkit/chainlink-testing-framework/seth v1.51.5/go.mod h1:kHYJnZUqiPF7/xN5273prV+srrLJkS77GbBXHLKQpx0= github.com/smartcontractkit/chainlink-testing-framework/wasp v1.53.0 h1:Rko/32VBSd46XBUJoSpuWJKTOOaNYm+8VRorDiENoCI= github.com/smartcontractkit/chainlink-testing-framework/wasp v1.53.0/go.mod h1:YEXSf+gWyc8sy+yl9B5mDApeikcguQDlCZQ/TpnixxU= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff h1:a0Z9NlZLwP7wClk84lP3iZpKFKzLGkS0U0VReIThaT4= -github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260713162202-124316cd10ff/go.mod h1:40yDOuuKaXDBWCbkJBQUeUmgpjOWHpQrs61y5Dch+zA= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490 h1:ots2WddFOQJL/tDFGmvrhRrVu2iRXCd0XEAxhpkAE/Y= -github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260716214810-db5ecc877490/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150 h1:D5Sea6RDF9S4uyooSxw/Zhh3oGoDJQmbxgbXAI4F2vc= +github.com/smartcontractkit/chainlink-ton v1.0.5-0.20260824235525-aea7e0904150/go.mod h1:1RCKAzvGOLC/51vbJUOPPjx5uxTCxeL0QXU32UvQeug= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8 h1:fl7VPhcgZA3r3eFg5/xEUDZ/BU6Z/9TfdEhPkZSEIuM= +github.com/smartcontractkit/chainlink-ton/cciplib v0.1.1-0.20260820224955-011a846f2fb8/go.mod h1:WjihFo64itMaOcaDMJ97iz0cJYO2zlLfPdUkF7/mQNo= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a h1:Xu8iBnBQEibWIXTCwKYf8okXjFtzJ0KochjL03h+T40= github.com/smartcontractkit/chainlink-tron/relayer v0.0.11-0.20260408092456-3c6369888d4a/go.mod h1:1eaXR+Fe6TlpP+CKXozfYlFM8QgN/N5C7OMvTRWNT8I= github.com/smartcontractkit/chainlink-tron/relayer/gotron-sdk v0.0.5-0.20260218133534-cbd44da2856b h1:RarA5fTnBzQY9wHhl6g7Ac7Nv0d/izr2/zuSWhveB4c= @@ -2394,8 +2396,8 @@ golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDf golang.org/x/crypto v0.20.0/go.mod h1:Xwo95rrVNIoSMx9wa1JroENMToLWn3RNVrTBpLHgZPQ= golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc= -golang.org/x/crypto v0.55.0 h1:+KWHjbgOaAQ66dh/YlkZKHlz9ZUlq61AFirAR9ntP8M= -golang.org/x/crypto v0.55.0/go.mod h1:uq0V9dE/fzQuJtbnL+2EhWOE63vo164FY8xqEnV9xis= +golang.org/x/crypto v0.56.0 h1:GUh5Ii4J5jtcseSMiRqr1jXCNHoxjeV9Fmekc2oLy6Y= +golang.org/x/crypto v0.56.0/go.mod h1:OMW5y6CY9l38uPLmxU6l6pwcXp1obtLo3e6gT7gQR2I= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= diff --git a/system-tests/tests/smoke/cre/cre_suite_test.go b/system-tests/tests/smoke/cre/cre_suite_test.go index c451d29c8e8..95286d2f1ec 100644 --- a/system-tests/tests/smoke/cre/cre_suite_test.go +++ b/system-tests/tests/smoke/cre/cre_suite_test.go @@ -371,6 +371,15 @@ func Test_CRE_V2_ShardManualAssignment(t *testing.T) { ExecuteManualShardAssignmentTest(t, testEnv) } +//nolint:paralleltest // mutates CRE settings and shard assignment on the shared environment +func Test_CRE_V2_ShardManualAssignmentBothSpecs(t *testing.T) { + testEnv := t_helpers.SetupTestEnvironmentWithConfig( + t, + t_helpers.GetTestConfig(t, "/configs/workflow-gateway-sharded-manual.toml"), + ) + ExecuteManualShardAssignmentBothSpecs(t, testEnv) +} + //nolint:paralleltest // the test owns the sharded topology it runs on func Test_CRE_V2_ShardedCapabilitiesManualEVMLogTrigger(t *testing.T) { testEnv := t_helpers.SetupTestEnvironmentWithConfig( diff --git a/system-tests/tests/smoke/cre/shard_assignment_test.go b/system-tests/tests/smoke/cre/shard_assignment_test.go index 4834fcf9ec5..0fada2bce14 100644 --- a/system-tests/tests/smoke/cre/shard_assignment_test.go +++ b/system-tests/tests/smoke/cre/shard_assignment_test.go @@ -11,6 +11,7 @@ import ( "github.com/ethereum/go-ethereum/crypto" "github.com/rs/zerolog" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "github.com/smartcontractkit/chainlink-deployments-framework/operations" @@ -109,6 +110,91 @@ hashed_default_assignment = false testLogger.Info().Int("executedCount", len(executedWorkflows)).Msg("All workflows executed on correct shards (manual-only mode)") } +func ExecuteManualShardAssignmentBothSpecs(t *testing.T, testEnv *ttypes.TestEnvironment) { + testLogger := framework.L + + shardDONs := testEnv.Dons.DonsWithFlag(cre.ShardDON) + require.GreaterOrEqual(t, len(shardDONs), 2, "Expected at least 2 shard DONs for manual assignment test") + + workflowFileLocation := "../../../../core/scripts/cre/environment/examples/workflows/cron/main.go" + workflowConfig := crontypes.WorkflowConfig{ + Schedule: "*/30 * * * * *", + } + expectedUserLog := "Amazing workflow user log" + + defaultOwner := "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266" + + linkingService, err := stvault.EnsureSharedTestLinkingServiceStarted() + require.NoError(t, err, "failed to start linking service") + linkingService.SetOwnerOrg(defaultOwner, "test_org_manual") + + shardLeaderDON := getShardZeroDon(t, testEnv) + shardZeroDonID := uint32(shardLeaderDON.ID) //nolint:gosec // G115: overflow is unrealistic + + var shardOneDON *cre.Don + for _, don := range shardDONs { + if don.ID != shardLeaderDON.ID { + shardOneDON = don + break + } + } + require.NotNil(t, shardOneDON, "Expected to find a second shard DON") + shardOneDonID := uint32(shardOneDON.ID) //nolint:gosec // G115: overflow is unrealistic + + // The static default points at shard zero, so the workflow only lands on shard one if the + // per-org entry is what routed it. + shardAssignmentTOML := fmt.Sprintf(` +static_default_assignment = [%d] +hashed_default_assignment = false + +[per_org_assignment] + non_existing_org= [%d] +`, shardZeroDonID, shardOneDonID) + + // Every shard resolves ownership from its own copy of the spec, so both the shard that must + // run the workflow and the shard that must not need it. + for _, don := range shardDONs { + proposeAndApproveShardAssignmentJob(t, testEnv, don, shardAssignmentTOML, testLogger) + } + + // The CRE limits job and the shard assignment job are both cresettings jobs; a node keeps one + // slot per config_type, so the two must run side by side. Propose a limits job for the org the + // workflows run under and check both are active before relying on the assignment below. + limits := t_helpers.ApplyCRESettings(t, testEnv, t_helpers.Org("test_org_manual", ` +[PerOrg] +WorkflowExecutionConcurrencyLimit = '42'`)) + for _, don := range shardDONs { + requireCRESettingsAndShardAssignmentJobsActive(t, don, limits.AppliedHash(don.Name)) + } + + workflowID := t_helpers.CompileAndDeployWorkflow(t, testEnv, testLogger, "manualshard0", &workflowConfig, workflowFileLocation) + workflowIDs := []string{workflowID} + workflowToShardIndex := map[string]uint32{workflowID: shardZeroDonID} + testLogger.Info().Str("workflowID", workflowID).Msg("Deployed workflow for manual shard assignment test") + + nodeP2PIDToShardIndex := buildNodeP2PIDToShardIndex(t, testEnv) + + userLogsCh := make(chan *workflowevents.UserLogs, 1000) + baseMessageCh := make(chan *commonevents.BaseMessage, 1000) + server := t_helpers.StartChipTestSink(t, t_helpers.GetPublishFn(testLogger, userLogsCh, baseMessageCh)) + t.Cleanup(func() { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + t_helpers.ShutdownChipSinkWithDrain(ctx, server, userLogsCh, baseMessageCh) + }) + + execTimeout := 3 * time.Minute + timeoutCtx, cancelTimeout := context.WithTimeout(t.Context(), execTimeout) + defer cancelTimeout() + execCtx, cancelCause := context.WithCancelCause(timeoutCtx) + defer cancelCause(nil) + go t_helpers.FailOnBaseMessage(execCtx, cancelCause, t, testLogger, baseMessageCh, t_helpers.WorkflowEngineInitErrorLog) + + executedWorkflows := waitForAllWorkflowsExecuted(execCtx, t, testLogger, userLogsCh, workflowIDs, workflowToShardIndex, nodeP2PIDToShardIndex, expectedUserLog, execTimeout) + require.Len(t, executedWorkflows, len(workflowIDs), "Not all workflows executed on correct shards") + testLogger.Info().Int("executedCount", len(executedWorkflows)).Msg("All workflows executed on correct shards (manual-only mode)") +} + // ExecuteManualShardAssignmentWithEVMLogTriggerTest exercises manual-only shard assignment on a // topology where the same capability is hosted by several capability DON shards and routed by DON // family (configs/workflow-sharded-capabilities-don.toml). @@ -503,3 +589,47 @@ func proposeAndApproveShardAssignmentJob(t *testing.T, testEnv *ttypes.TestEnvir testLogger.Info().Msg("Shard assignment job proposed and approved") } + +// requireCRESettingsAndShardAssignmentJobsActive asserts that every worker node of don has two +// distinct cresettings jobs approved and running: the shard assignment job and the CRE limits job +// whose spec carries settingsHash. +func requireCRESettingsAndShardAssignmentJobsActive(t *testing.T, don *cre.Don, settingsHash string) { + t.Helper() + require.NotEmpty(t, settingsHash, "no CRE settings were applied to DON %q", don.Name) + + workers, err := don.Workers() + require.NoError(t, err, "failed to get worker nodes of DON %q", don.Name) + + for _, node := range workers { + require.EventuallyWithTf(t, func(c *assert.CollectT) { + jd, jdErr := node.Clients.GQLClient.GetJobDistributor(t.Context(), node.JobDistributorDetails.JDID) + if !assert.NoError(c, jdErr, "failed to get job distributor") { + return + } + + // The node resolves a proposal's jobID from its jobs table by external job ID, so a + // non-empty jobID means the job was actually created. ListJobs can't be used here: the + // GQL client can't unmarshal cresettings job specs. + var limitsJobID, shardJobID string + for _, proposal := range jd.JobProposals { + spec := proposal.LatestSpec + if !strings.Contains(spec.Definition, `type = "cresettings"`) || string(spec.Status) != "APPROVED" { + continue + } + switch { + case strings.Contains(spec.Definition, `config_type = "shard_assignment"`): + shardJobID = proposal.JobID + case strings.Contains(spec.Definition, fmt.Sprintf("hash = %q", settingsHash)): + limitsJobID = proposal.JobID + } + } + if !assert.NotEmpty(c, shardJobID, "no running job for an approved shard assignment proposal") || + !assert.NotEmpty(c, limitsJobID, "no running job for an approved CRE limits proposal with hash %s", settingsHash) { + return + } + assert.NotEqual(c, shardJobID, limitsJobID, "limits and shard assignment jobs must be distinct") + }, 2*time.Minute, 3*time.Second, "node %s of DON %q does not run both CRE limits and shard assignment jobs", node.Name, don.Name) + } + + framework.L.Info().Str("don", don.Name).Int("nodes", len(workers)).Msg("CRE limits and shard assignment jobs are active on all worker nodes") +} diff --git a/system-tests/tests/test-helpers/cresettings_override.go b/system-tests/tests/test-helpers/cresettings_override.go index 96aac2f41ee..c9862775b5c 100644 --- a/system-tests/tests/test-helpers/cresettings_override.go +++ b/system-tests/tests/test-helpers/cresettings_override.go @@ -23,12 +23,15 @@ package helpers // disagree. Approve() below only returns once every targeted node accepted the job. import ( + "context" "crypto/sha256" "encoding/hex" "encoding/json" "errors" "fmt" "io/fs" + "regexp" + "strconv" "strings" "sync" "testing" @@ -55,6 +58,17 @@ const ( // how long to wait (best effort) for every targeted node to log the applied hash. creSettingsConvergenceTimeout = 60 * time.Second + + // the log scan reads only the DON's own node containers, only their last + // creSettingsLogScanTail lines, and only lines written since delivery started (minus + // creSettingsLogScanSkew for host/docker clock skew). A long-running environment has + // hundreds of MB of logs per node and docker reads the whole file unless tail is set, + // which makes a full scan of every container take minutes per poll. + creSettingsLogScanTail = "50000" + creSettingsLogScanSkew = time.Minute + + // how long reverting to the baseline may take across all targeted DONs. + creSettingsRevertTimeout = 5 * time.Minute ) // Only one CRE settings override may be active at a time. Overrides mutate settings on @@ -247,6 +261,7 @@ func ApplyCRESettings(t *testing.T, env *ttypes.TestEnvironment, opts ...Option) // a delivery below fails partway through. t.Cleanup(func() { h.restore(t, false /* not fatal: the test already finished */) }) + deliveredSince := time.Now() for _, don := range targets { baselineJSON := bootSettingsForDON(env, don.Name) baselineTOML, baselineHash := renderSettings(t, baselineJSON, nil) @@ -255,7 +270,7 @@ func ApplyCRESettings(t *testing.T, env *ttypes.TestEnvironment, opts ...Option) t.Logf("[cresettings] DON %q: applying override (hash %s) over baseline (hash %s)", don.Name, shortHash(appliedHash), shortHash(baselineHash)) - err := deliverCRESettings(env, don, appliedTOML) + err := deliverCRESettings(t.Context(), env, don, appliedTOML) require.NoErrorf(t, err, "failed to deliver CRE settings override to DON %q", don.Name) h.targets = append(h.targets, creSettingsTarget{ @@ -269,7 +284,7 @@ func ApplyCRESettings(t *testing.T, env *ttypes.TestEnvironment, opts ...Option) // Best-effort confirmation that every node actually logged the applied settings. for _, tg := range h.targets { - logSettingsConvergence(t, tg.don, tg.appliedHash, creSettingsConvergenceTimeout) + logSettingsConvergence(t, tg.don, tg.appliedHash, deliveredSince, creSettingsConvergenceTimeout) } return h @@ -295,6 +310,17 @@ func (h *CRESettingsHandle) AppliedTOML(donName string) string { return "" } +// AppliedHash returns the sha256 hash of AppliedTOML for the named DON. It is the hash the +// settings job spec carries and the node logs on apply. Empty if the DON was not targeted. +func (h *CRESettingsHandle) AppliedHash(donName string) string { + for _, tg := range h.targets { + if tg.don.Name == donName { + return tg.appliedHash + } + } + return "" +} + // BaselineTOML returns the pre-test baseline document captured for the named DON, i.e. // what the settings are restored to on cleanup. Empty if the DON was not targeted. func (h *CRESettingsHandle) BaselineTOML(donName string) string { @@ -316,9 +342,14 @@ func (h *CRESettingsHandle) restore(t *testing.T, fatal bool) { // claim it. Runs exactly once (guarded by h.reverted above). defer releaseCRESettingsOverride(h.owner) + // Not t.Context(): restore usually runs from t.Cleanup, after t.Context() is canceled. + ctx, cancel := context.WithTimeout(context.WithoutCancel(t.Context()), creSettingsRevertTimeout) + defer cancel() + + deliveredSince := time.Now() for _, tg := range h.targets { t.Logf("[cresettings] DON %q: reverting to baseline (hash %s)", tg.don.Name, shortHash(tg.baselineHash)) - err := deliverCRESettings(h.env, tg.don, tg.baselineTOML) + err := deliverCRESettings(ctx, h.env, tg.don, tg.baselineTOML) if err != nil { if fatal { require.NoErrorf(t, err, "failed to revert CRE settings on DON %q", tg.don.Name) @@ -327,7 +358,7 @@ func (h *CRESettingsHandle) restore(t *testing.T, fatal bool) { } continue } - logSettingsConvergence(t, tg.don, tg.baselineHash, creSettingsConvergenceTimeout) + logSettingsConvergence(t, tg.don, tg.baselineHash, deliveredSince, creSettingsConvergenceTimeout) } } @@ -338,10 +369,17 @@ func (h *CRESettingsHandle) restore(t *testing.T, fatal bool) { // JD proposal history on repeated deliveries (e.g. reverting to the same baseline twice, // which failed with "no job proposal found"). Application is confirmed best-effort via // the nodes' "Updated settings" logs (see logSettingsConvergence). -func deliverCRESettings(env *ttypes.TestEnvironment, don *cre.Don, settingsTOML string) error { +// +// The CLDF environment is used with ctx in place of its own context, which is bound to +// t.Context() of the test that built the environment. +func deliverCRESettings(ctx context.Context, env *ttypes.TestEnvironment, don *cre.Don, settingsTOML string) error { + cldfEnv := *env.CreEnvironment.CldfEnvironment + cldfEnv.GetContext = func() context.Context { return ctx } + cldfEnv.OperationsBundle.GetContext = cldfEnv.GetContext + input := cre_jobs.ProposeJobSpecInput{ Domain: offchain.ProductLabel, - Environment: env.CreEnvironment.CldfEnvironment.Name, + Environment: cldfEnv.Name, DONName: don.Name, JobName: "cre-settings", ExtraLabels: map[string]string{cre.CapabilityLabelKey: "cre-settings-override"}, @@ -352,10 +390,10 @@ func deliverCRESettings(env *ttypes.TestEnvironment, don *cre.Don, settingsTOML Inputs: job_types.JobSpecInput{"settings": settingsTOML}, } - if err := (cre_jobs.ProposeJobSpec{}).VerifyPreconditions(*env.CreEnvironment.CldfEnvironment, input); err != nil { + if err := (cre_jobs.ProposeJobSpec{}).VerifyPreconditions(cldfEnv, input); err != nil { return fmt.Errorf("verify settings job preconditions: %w", err) } - if _, err := (cre_jobs.ProposeJobSpec{}).Apply(*env.CreEnvironment.CldfEnvironment, input); err != nil { + if _, err := (cre_jobs.ProposeJobSpec{}).Apply(cldfEnv, input); err != nil { return fmt.Errorf("propose settings job: %w", err) } return nil @@ -411,14 +449,19 @@ func bootSettingsForDON(env *ttypes.TestEnvironment, donName string) string { } // logSettingsConvergence polls container logs (best effort) and reports how many nodes -// of the DON have logged the given settings hash. It never fails the test — the -// authoritative signal that the settings were delivered is that Approve succeeded. -func logSettingsConvergence(t *testing.T, don *cre.Don, hash string, timeout time.Duration) { +// of the DON have logged the given settings hash since the given time. It never fails the +// test — the authoritative signal that the settings were delivered is that Approve succeeded. +func logSettingsConvergence(t *testing.T, don *cre.Don, hash string, since time.Time, timeout time.Duration) { t.Helper() - want := len(don.Nodes) + workers, err := don.Workers() + if err != nil { + t.Logf("[cresettings] DON %q: skipping log scan: %v", don.Name, err) + return + } + want := len(workers) deadline := time.Now().Add(timeout) for { - got := countContainersWithSettingsHash(hash) + got := countContainersWithSettingsHash(workers, hash, since) if got >= want { t.Logf("[cresettings] DON %q: %d/%d nodes logged settings hash %s", don.Name, got, want, shortHash(hash)) return @@ -433,12 +476,22 @@ func logSettingsConvergence(t *testing.T, don *cre.Don, hash string, timeout tim } } -// countContainersWithSettingsHash returns the number of containers whose logs contain -// the settings-update marker together with the given hash. -func countContainersWithSettingsHash(hash string) int { +// countContainersWithSettingsHash returns the number of the given nodes' containers whose +// recent logs (see creSettingsLogScanTail) contain the settings-update marker together with +// the given hash. +func countContainersWithSettingsHash(nodes []*cre.Node, hash string, since time.Time) int { + nameFilters := client.Filters{} + for _, node := range nodes { + nameFilters.Add("name", "^/?"+regexp.QuoteMeta(node.Name)+"$") + } logStreams, err := framework.StreamContainerLogs( - client.ContainerListOptions{All: true}, - client.ContainerLogsOptions{ShowStdout: true, ShowStderr: true}, + client.ContainerListOptions{All: true, Filters: nameFilters}, + client.ContainerLogsOptions{ + ShowStdout: true, + ShowStderr: true, + Tail: creSettingsLogScanTail, + Since: strconv.FormatInt(since.Add(-creSettingsLogScanSkew).Unix(), 10), + }, ) if err != nil { framework.L.Warn().Err(err).Msg("[cresettings] could not stream container logs") diff --git a/tools/ci/internal/matrix/system.go b/tools/ci/internal/matrix/system.go index e1f15a0f668..7bbf400c5d6 100644 --- a/tools/ci/internal/matrix/system.go +++ b/tools/ci/internal/matrix/system.go @@ -79,6 +79,9 @@ var defaultCRESmokePerTestTopologies = map[string][]TopologyConfig{ "Test_CRE_V2_ShardManualAssignment": { {Topology: "workflow-gateway-sharded-manual", Configs: "configs/workflow-gateway-sharded-manual.toml"}, }, + "Test_CRE_V2_ShardManualAssignmentBothSpecs": { + {Topology: "workflow-gateway-sharded-manual", Configs: "configs/workflow-gateway-sharded-manual.toml"}, + }, "Test_CRE_V2_ShardedCapabilitiesManualEVMLogTrigger": { {Topology: "workflow-sharded-capabilities", Configs: "configs/workflow-sharded-capabilities-don.toml"}, }, diff --git a/tools/githooks/README.md b/tools/githooks/README.md index 69975e6c513..6f56e4aa449 100644 --- a/tools/githooks/README.md +++ b/tools/githooks/README.md @@ -10,6 +10,7 @@ - **Targeted Code Generation:** Runs `go generate` only for packages where `.proto` or generate files changed, updates config schema docs and `go.md` when relevant files change, and regenerates mocks via `mockery` when affected packages are listed in a `.mockery.yaml`. - **Parallel Module Tidy:** Runs `go mod tidy` in parallel across all affected modules. - **Targeted Linting:** Runs `golangci-lint` only against the exact changed packages within affected modules instead of scanning whole modules or the entire repository. +- **GitHub Actions Workflow Linting:** Runs `actionlint` (using maintained fork [kjanat/actionlint](https://github.com/kjanat/actionlint)) on affected workflow files when `.github` YAML files change. - **Targeted Unit Testing:** Discovers changed test packages and executes `tools/test` with `-short` directly on those packages (aligned with CI unit test scope). - **Dependency Changes:** Automatically runs on all packages (`./...`) if a module's `go.mod` or `go.sum` is modified. - **Lefthook Integration:** Seamlessly works with Lefthook staged/push file filters and `stage_fixed`. @@ -99,6 +100,32 @@ go -C tools/githooks run . lint core/services/app.go deployment/environment/env. go -C tools/githooks run . lint --fix=false --rev=origin/develop ``` +### `actionlint` (aliases: `al`) + +Runs [actionlint](https://github.com/kjanat/actionlint) on GitHub Actions workflow files when `.github` YAML files change. When specific workflow files are modified, only those files are linted; if non-workflow `.github` YAML files (e.g. `.github/actionlint.yml`, composite actions) change, all workflows are validated. + +Requires the maintained `kjanat/actionlint` fork: +```bash +go install actionlint.kjanat.dev/cmd/actionlint@latest +# or with mise: +mise use -g go:actionlint.kjanat.dev/cmd/actionlint@latest +``` + +```bash +# Run actionlint for workflow files changed since merge-base with default branch +go -C tools/githooks run . actionlint + +# Run actionlint for specific changed workflow files +go -C tools/githooks run . actionlint .github/workflows/auto-update.yml + +# Flags +# --rev string Show issues introduced since rev (default: merge-base with the origin default branch) +go -C tools/githooks run . actionlint --rev=origin/develop +``` + +> [!NOTE] +> `--rev` only applies when no file arguments are given — if files are passed explicitly (as the lefthook hook does with `{staged_files}`), `--rev` is ignored and only those files are linted. + ### `test` (aliases: `only-changed`, `short-test`) Runs unit tests (`tools/test`) in `-short` mode only on affected packages. diff --git a/tools/githooks/cmd/actionlint.go b/tools/githooks/cmd/actionlint.go new file mode 100644 index 00000000000..21ad38f152b --- /dev/null +++ b/tools/githooks/cmd/actionlint.go @@ -0,0 +1,54 @@ +package cmd + +import ( + "fmt" + + "github.com/spf13/cobra" + + "github.com/smartcontractkit/chainlink/v2/tools/githooks/internal/actionlint" + "github.com/smartcontractkit/chainlink/v2/tools/githooks/internal/modules" +) + +func newActionlintCmd() *cobra.Command { + var rev string + + cmd := &cobra.Command{ + Use: "actionlint [files...]", + Aliases: []string{"al"}, + Short: "Run actionlint on GitHub Actions workflows when .github YAML files change", + Long: "Executes actionlint (https://github.com/kjanat/actionlint) on GitHub Actions workflow files " + + "when any YAML files in .github are changed.", + RunE: func(cmd *cobra.Command, args []string) error { + ctx := cmd.Context() + + repoRoot, err := findRepoRoot(ctx) + if err != nil { + return fmt.Errorf("could not find repo root: %w", err) + } + + files := args + if len(files) == 0 { + if rev == "" { + rev = modules.GetMergeBase(ctx, repoRoot) + } + files, err = modules.GetChangedFilesSince(ctx, repoRoot, rev) + if err != nil { + return err + } + } + + cfg := actionlint.Config{ + RepoRoot: repoRoot, + Files: files, + Stdout: cmd.OutOrStdout(), + Stderr: cmd.ErrOrStderr(), + } + + return actionlint.Run(ctx, cfg) + }, + } + + cmd.Flags().StringVar(&rev, "rev", "", "Show issues introduced since rev (default: merge-base with the origin default branch)") + + return cmd +} diff --git a/tools/githooks/cmd/cmd_bench_test.go b/tools/githooks/cmd/cmd_bench_test.go index 3f0a8934892..068a8809b54 100644 --- a/tools/githooks/cmd/cmd_bench_test.go +++ b/tools/githooks/cmd/cmd_bench_test.go @@ -18,6 +18,7 @@ func BenchmarkCommandsHelp(b *testing.B) { {"generate", "--help"}, {"end-of-file-fixer", "--help"}, {"whitespace-fixer", "--help"}, + {"actionlint", "--help"}, } for _, args := range commands { diff --git a/tools/githooks/cmd/lint_test.go b/tools/githooks/cmd/lint_test.go index d552d4a6098..03837bfeaa7 100644 --- a/tools/githooks/cmd/lint_test.go +++ b/tools/githooks/cmd/lint_test.go @@ -28,6 +28,7 @@ func TestRootCmd(t *testing.T) { assert.Contains(t, buf.String(), "generate") assert.Contains(t, buf.String(), "end-of-file-fixer") assert.Contains(t, buf.String(), "whitespace-fixer") + assert.Contains(t, buf.String(), "actionlint") } func TestLintCmdHelp(t *testing.T) { diff --git a/tools/githooks/cmd/root.go b/tools/githooks/cmd/root.go index 64ee605715c..ff0488f5d29 100644 --- a/tools/githooks/cmd/root.go +++ b/tools/githooks/cmd/root.go @@ -24,6 +24,7 @@ func NewRootCmd() *cobra.Command { rootCmd.AddCommand(newGenerateCmd()) rootCmd.AddCommand(newEOFCmd()) rootCmd.AddCommand(newWhitespaceCmd()) + rootCmd.AddCommand(newActionlintCmd()) return rootCmd } diff --git a/tools/githooks/internal/actionlint/actionlint.go b/tools/githooks/internal/actionlint/actionlint.go new file mode 100644 index 00000000000..52ffa321bf0 --- /dev/null +++ b/tools/githooks/internal/actionlint/actionlint.go @@ -0,0 +1,154 @@ +package actionlint + +import ( + "context" + "errors" + "fmt" + "io" + "os" + "os/exec" + "path/filepath" + "strings" +) + +// Executor abstracts command execution and output capture for testability. +type Executor interface { + Run(ctx context.Context, dir, name string, args ...string) error + Output(ctx context.Context, dir, name string, args ...string) ([]byte, error) +} + +type osExecutor struct { + stdout io.Writer + stderr io.Writer +} + +func (e *osExecutor) Run(ctx context.Context, dir, name string, args ...string) error { + cmd := exec.CommandContext(ctx, name, args...) + cmd.Dir = dir + cmd.Stdout = e.stdout + cmd.Stderr = e.stderr + cmd.Stdin = os.Stdin + return cmd.Run() +} + +func (e *osExecutor) Output(ctx context.Context, dir, name string, args ...string) ([]byte, error) { + cmd := exec.CommandContext(ctx, name, args...) + cmd.Dir = dir + return cmd.CombinedOutput() +} + +// Config holds configuration for the actionlint runner. +type Config struct { + RepoRoot string + Files []string + Executor Executor + Stdout io.Writer + Stderr io.Writer +} + +// IsGithubYAML reports whether relPath is a YAML file within the .github directory. +func IsGithubYAML(relPath string) bool { + clean := filepath.ToSlash(filepath.Clean(relPath)) + clean = strings.TrimPrefix(clean, "./") + clean = strings.TrimPrefix(clean, "/") + + if !strings.HasPrefix(clean, ".github/") { + return false + } + + ext := strings.ToLower(filepath.Ext(clean)) + return ext == ".yml" || ext == ".yaml" +} + +// IsWorkflowYAML reports whether relPath is a YAML file within .github/workflows. +func IsWorkflowYAML(relPath string) bool { + clean := filepath.ToSlash(filepath.Clean(relPath)) + clean = strings.TrimPrefix(clean, "./") + clean = strings.TrimPrefix(clean, "/") + + if !strings.HasPrefix(clean, ".github/workflows/") { + return false + } + + ext := strings.ToLower(filepath.Ext(clean)) + return ext == ".yml" || ext == ".yaml" +} + +// filterGithubYAML classifies input files into workflow YAMLs and non-workflow .github YAMLs. +func filterGithubYAML(files []string) (workflowFiles []string, hasNonWorkflowYAML, hasAnyGithubYAML bool) { + for _, file := range files { + trimmed := strings.TrimSpace(file) + if trimmed == "" { + continue + } + + if !IsGithubYAML(trimmed) { + continue + } + + hasAnyGithubYAML = true + if IsWorkflowYAML(trimmed) { + workflowFiles = append(workflowFiles, trimmed) + } else { + hasNonWorkflowYAML = true + } + } + return workflowFiles, hasNonWorkflowYAML, hasAnyGithubYAML +} + +// validateFork ensures actionlint is available and belongs to the maintained kjanat/actionlint fork. +func validateFork(ctx context.Context, execRunner Executor, repoRoot string) error { + out, err := execRunner.Output(ctx, repoRoot, "actionlint", "-help") + if err != nil { + return fmt.Errorf("actionlint not found or failed: %w. Install maintained fork: go install actionlint.kjanat.dev/cmd/actionlint@latest (https://github.com/kjanat/actionlint)", err) + } + + outStr := string(out) + if strings.Contains(outStr, "rhysd/actionlint") || !strings.Contains(outStr, "kjanat") { + return errors.New("unmaintained actionlint detected (rhysd/actionlint). Upgrade to maintained fork: go install actionlint.kjanat.dev/cmd/actionlint@latest (https://github.com/kjanat/actionlint)") + } + + return nil +} + +// Run filters files, validates the actionlint fork, and runs actionlint on changed workflows. +func Run(ctx context.Context, cfg Config) error { + if len(cfg.Files) == 0 { + return nil + } + + workflowFiles, hasNonWorkflowYAML, hasAnyGithubYAML := filterGithubYAML(cfg.Files) + if !hasAnyGithubYAML { + return nil + } + + if cfg.Stdout == nil { + cfg.Stdout = io.Discard + } + if cfg.Stderr == nil { + cfg.Stderr = io.Discard + } + + execRunner := cfg.Executor + if execRunner == nil { + execRunner = &osExecutor{stdout: cfg.Stdout, stderr: cfg.Stderr} + } + + if err := validateFork(ctx, execRunner, cfg.RepoRoot); err != nil { + return err + } + + var args []string + if !hasNonWorkflowYAML && len(workflowFiles) > 0 { + args = workflowFiles + fmt.Fprintf(cfg.Stdout, "==> Running actionlint on: %s\n", strings.Join(args, " ")) + } else { + fmt.Fprintf(cfg.Stdout, "==> Running actionlint on all workflows\n") + } + + if err := execRunner.Run(ctx, cfg.RepoRoot, "actionlint", args...); err != nil { + return fmt.Errorf("actionlint failed: %w", err) + } + + return nil +} diff --git a/tools/githooks/internal/actionlint/actionlint_bench_test.go b/tools/githooks/internal/actionlint/actionlint_bench_test.go new file mode 100644 index 00000000000..eda17f86287 --- /dev/null +++ b/tools/githooks/internal/actionlint/actionlint_bench_test.go @@ -0,0 +1,45 @@ +package actionlint_test + +import ( + "context" + "io" + "testing" + + "github.com/stretchr/testify/require" + + "github.com/smartcontractkit/chainlink/v2/tools/githooks/internal/actionlint" +) + +type benchExecutor struct{} + +func (b *benchExecutor) Run(ctx context.Context, dir, name string, args ...string) error { + return nil +} + +func (b *benchExecutor) Output(ctx context.Context, dir, name string, args ...string) ([]byte, error) { + return []byte(validKjanatHelpOutput), nil +} + +func BenchmarkActionlintRun(b *testing.B) { + files := []string{ + ".github/workflows/ci.yml", + ".github/workflows/deploy.yaml", + "core/services/app.go", + "README.md", + } + + cfg := actionlint.Config{ + RepoRoot: "/test/repo", + Files: files, + Executor: &benchExecutor{}, + Stdout: io.Discard, + Stderr: io.Discard, + } + + b.ReportAllocs() + + for b.Loop() { + err := actionlint.Run(b.Context(), cfg) + require.NoError(b, err) + } +} diff --git a/tools/githooks/internal/actionlint/actionlint_test.go b/tools/githooks/internal/actionlint/actionlint_test.go new file mode 100644 index 00000000000..41709efc3b0 --- /dev/null +++ b/tools/githooks/internal/actionlint/actionlint_test.go @@ -0,0 +1,275 @@ +package actionlint_test + +import ( + "bytes" + "context" + "errors" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "github.com/smartcontractkit/chainlink/v2/tools/githooks/internal/actionlint" +) + +type mockExecutor struct { + helpOutput []byte + helpErr error + runErr error + runs []mockRun +} + +type mockRun struct { + dir string + name string + args []string +} + +func (m *mockExecutor) Run(ctx context.Context, dir, name string, args ...string) error { + m.runs = append(m.runs, mockRun{dir: dir, name: name, args: args}) + return m.runErr +} + +func (m *mockExecutor) Output(ctx context.Context, dir, name string, args ...string) ([]byte, error) { + m.runs = append(m.runs, mockRun{dir: dir, name: name, args: args}) + if m.helpErr != nil { + return nil, m.helpErr + } + return m.helpOutput, nil +} + +const validKjanatHelpOutput = `Usage: actionlint [FLAGS] [FILES...] [-] + + actionlint is a linter for GitHub Actions workflow files. + +Documents: + + - List of checks: https://github.com/kjanat/actionlint/tree/main/docs/checks.md + - Usage: https://github.com/kjanat/actionlint/tree/main/docs/usage.md + - Configuration: https://github.com/kjanat/actionlint/tree/main/docs/config.md +` + +const unmaintainedRhysdHelpOutput = `Usage: actionlint [FLAGS] [FILES...] [-] + + actionlint is a linter for GitHub Actions workflow files. + +Documents: + + - List of checks: https://github.com/rhysd/actionlint/tree/main/docs/checks.md + - Usage: https://github.com/rhysd/actionlint/tree/main/docs/usage.md + - Configuration: https://github.com/rhysd/actionlint/tree/main/docs/config.md +` + +func TestRun(t *testing.T) { + t.Parallel() + + t.Run("skips execution when no .github YAML files are changed", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(validKjanatHelpOutput), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + "core/services/app.go", + "README.md", + ".github/CODEOWNERS", + ".github/in-memory-tests.json", + ".github/scripts/test.sh", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.NoError(t, err) + assert.Empty(t, mock.runs) + }) + + t.Run("fails when unmaintained rhysd/actionlint is detected", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(unmaintainedRhysdHelpOutput), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/workflows/ci.yml", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.Error(t, err) + assert.Contains(t, err.Error(), "unmaintained") + assert.Contains(t, err.Error(), "rhysd/actionlint") + assert.Contains(t, err.Error(), "https://github.com/kjanat/actionlint") + }) + + t.Run("fails with install instructions when actionlint binary is missing", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpErr: errors.New("executable file not found in $PATH"), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/workflows/ci.yml", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.Error(t, err) + assert.Contains(t, err.Error(), "not found") + assert.Contains(t, err.Error(), "https://github.com/kjanat/actionlint") + }) + + t.Run("runs actionlint with specific files when only workflow files changed", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(validKjanatHelpOutput), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/workflows/ci.yml", + ".github/workflows/deploy.yaml", + "core/services/app.go", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.NoError(t, err) + + // 1 output call for help validation, 1 run call for linting + require.Len(t, mock.runs, 2) + assert.Equal(t, "actionlint", mock.runs[1].name) + assert.Equal(t, "/repo", mock.runs[1].dir) + assert.Equal(t, []string{".github/workflows/ci.yml", ".github/workflows/deploy.yaml"}, mock.runs[1].args) + }) + + t.Run("runs actionlint on all workflows when non-workflow .github YAML changed", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(validKjanatHelpOutput), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/actionlint.yml", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.NoError(t, err) + + require.Len(t, mock.runs, 2) + assert.Equal(t, "actionlint", mock.runs[1].name) + assert.Equal(t, "/repo", mock.runs[1].dir) + assert.Empty(t, mock.runs[1].args) // No file args = actionlint scans all workflows + }) + + t.Run("runs actionlint on all workflows when composite action YAML changed", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(validKjanatHelpOutput), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/actions/setup-go/action.yml", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.NoError(t, err) + + require.Len(t, mock.runs, 2) + assert.Equal(t, "actionlint", mock.runs[1].name) + assert.Empty(t, mock.runs[1].args) + }) + + t.Run("runs actionlint on all workflows when mixed workflow and non-workflow YAML changed", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(validKjanatHelpOutput), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/workflows/ci.yml", + ".github/actionlint.yml", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.NoError(t, err) + + require.Len(t, mock.runs, 2) + assert.Equal(t, "actionlint", mock.runs[1].name) + assert.Empty(t, mock.runs[1].args) + }) + + t.Run("propagates actionlint execution errors", func(t *testing.T) { + t.Parallel() + + mock := &mockExecutor{ + helpOutput: []byte(validKjanatHelpOutput), + runErr: errors.New("syntax error in workflow"), + } + var out bytes.Buffer + + cfg := actionlint.Config{ + RepoRoot: "/repo", + Files: []string{ + ".github/workflows/ci.yml", + }, + Executor: mock, + Stdout: &out, + Stderr: &out, + } + + err := actionlint.Run(t.Context(), cfg) + require.Error(t, err) + assert.Contains(t, err.Error(), "syntax error in workflow") + }) +}