Client CI build fails: tbtc-v2 development npm package missing ReservationRouter.json

[piotr-roslaniec]

client-build-test-publish fails at make generate (_address/ReservationRouter target) because @keep-network/tbtc-v2@development on npm does not publish a ReservationRouter.json artifact for the ReservationRouter contract referenced in pkg/chain/ethereum/tbtc/gen/Makefile.

Confirmed:

• Present on the base branch (m1/keep-core-client) itself, independent of any keep-core PR — not introduced by any change here.
• Every currently published tbtc-v2 npm tag/version checked (development, latest 1.8.0, mainnet 1.8.2, sepolia, base, and the last 15 dev prereleases) lacks the artifact.
• Root cause is in the tbtc-v2 Solidity repo: ReservationRouter.sol needs to be compiled and published to the npm development tag.

Fix: publish an updated @keep-network/tbtc-v2@development build that includes artifacts/ReservationRouter.json, then remove the continue-on-error: true added to the client-build-test-publish job in .github/workflows/client.yml (added as a temporary CI-unblock workaround pending this fix).

[linear]

ENG-751

[piotr-roslaniec]

Investigated three workaround options while unblocking PR #4276; none is safe as a quick fix:

1. Job/step-level continue-on-error in .github/workflows/client.yml: job-level doesn't change the check's own reported conclusion and cascades a new failure into client-integration-test (previously a clean skip). Step-level on the Docker build step would report green, but that step also builds the image Run Go tests runs against in the same job - skipping it means the full client Go test suite silently stops running (for any future build breakage, not just this npm gap) while CI reports success. Rejected.
2. Excluding ReservationRouter from required_contracts in pkg/chain/ethereum/tbtc/gen/Makefile: its address file specifically is dead weight (never embedded via go:embed - see gen.go, the binding is constructed against the Bridge address instead), so that part is genuinely safe to drop. But its ABI/contract bindings are load-bearing (pkg/chain/ethereum/tbtc.go uses tbtccontract.ReservationRouter directly), and the shared clean: target in pkg/chain/ethereum/common/gen/Makefile (used by every contract package: ecdsa, threshold, random-beacon, tbtc) unconditionally wipes abi/*, contract/*, cmd/* before rebuild - it would delete the already-correct, currently-committed ReservationRouter bindings with nothing able to regenerate them. A real fix needs that shared clean step reworked to skip contracts whose artifact JSON is absent, leaving their committed bindings untouched. Bigger, shared-infra change; not attempted here.

Real fix is still: publish @keep-network/tbtc-v2@development with ReservationRouter.json included. client-build-test-publish is left red on #4276, tracked back to this issue; no branch protection requires that check on m1/keep-core-client, so it doesn't block merge once a maintainer decides to proceed.

[piotr-roslaniec]

Went a step further and empirically tested (not just reasoned about) two more workaround candidates - both confirmed infeasible:

Exclude ReservationRouter + restore committed bindings from git after clean: reproduced the exact CI failure locally (make get_artifacts && cd pkg/chain/ethereum/tbtc/gen && make environment=development), confirming clean deletes abi/ReservationRouter.go, contract/ReservationRouter.go, cmd/ReservationRouter.go before the missing-artifact error halts the build. But this path is dead regardless: .dockerignore excludes **/gen/**/*.go (only gen.go/cmd/cmd.go kept) and excludes .git from the Docker build context entirely - the committed bindings never reach the image, and there's no git history inside it to restore from.

Vendor a reconstructed ReservationRouter.json extracted from the ABI string already embedded in the committed abi/ReservationRouter.go (ReservationRouterMetaData.ABI): round-trip tested with a real abigen run. The embedded string has already lost every struct internalType qualifier during the original generation ("struct BitcoinTx.Info" became "structBitcoinTx.Info"), so regenerating from it produces wrong type names (Struct0/Struct2/Struct4 instead of BitcoinTxInfo/BitcoinTxProof/ReservationReservationRequest) that don't match what pkg/chain/ethereum/tbtc.go expects - not byte-identical against the committed file. The missing data can only legitimately come from an upstream solc compile of the real ReservationRouter.sol; hand-authoring it back in would be fabricating artifact content.

All four workaround classes now exhausted (2 CI-config-level, 2 artifact-level). Nothing in keep-core alone can turn this check green. Confirmed remaining path: wait for @keep-network/tbtc-v2@development to publish ReservationRouter.json.

[piotr-roslaniec]

Update: landed a fifth approach for the wholly-missing ReservationRouter.json - a development-only vendored fallback (PR #4276, commit 3298ae030). Verified byte-identical: the ABI was re-derived from the already-committed ReservationRouterMetaData.ABI with the internalType prefix space abigen's metadata packer strips ("structBitcoinTx.Info" -> "struct BitcoinTx.Info") put back - a deterministic, checkable normalization - then round-tripped through the same abigen + keep-common generator invocation CI uses. Diffed byte-identical against abi/ReservationRouter.go, contract/ReservationRouter.go, cmd/ReservationRouter.go. Confirmed on live CI: make generate now completes for all four contract packages.

That exposed a second, larger gap in the same underlying npm-lag issue: at the actual go build step, Bridge and WalletProposalValidator's live npm ABI has zero reservation-related methods (ValidateReservationAnchorProposal, ValidateReservationReanchorProposal, IsReservedDeposit - all missing), while the committed Go bindings for those two existing contracts already expect them. Confirmed via a direct check of the live-fetched artifact JSON.

Same root cause, different shape: this needs merging specific missing methods into a live-fetched ABI shared by dozens of unrelated existing methods on two contracts, not swapping a single self-contained missing artifact. No clean byte-identical verification path like ReservationRouter had. Not attempted. client-build-test-publish stays red on this second gap - the complete fix is still the upstream tbtc-v2 npm publish catching up on all three contracts (Bridge, WalletProposalValidator, ReservationRouter).

[piotr-roslaniec]

Resolved for PR #4276. Both gaps this issue tracks are now worked around with vendored, byte-identical-verified Makefile patches:

1. ReservationRouter.json wholly missing (commit 3298ae030) - development-only fallback artifact, its ABI round-tripped through the same abigen + keep-common invocation CI uses and diffed byte-identical against the committed abi/ReservationRouter.go, contract/ReservationRouter.go, cmd/ReservationRouter.go.
2. Bridge.json/WalletProposalValidator.json missing reservation methods (commit ee30610ea) - the live fetched artifact is patched in place with vendored method fragments extracted from the committed BridgeMetaData.ABI/WalletProposalValidatorMetaData.ABI, same internalType normalization technique.

Verified with a full clean end-to-end run (fresh npm fetch, fresh make generate for all four contract packages, go build/vet/test ./... - 1887 tests, 89 packages) before landing, then confirmed on live CI: 12/12 checks green, including client-build-test-publish and client-integration-test (previously always skipped, now passing).

This issue can stay open to track the real, complete fix (@keep-network/tbtc-v2 publishing a development-tag npm release with all three contracts' reservation additions), since the workaround is a maintenance burden until that lands - but it no longer blocks or affects CI on m1/keep-core-client.