Add TON support

.changeset/long-snakes-ring.md

@@ -0,0 +1,5 @@
+---
+"@smartcontractkit/mcms": minor
+---
+
+Add TON implementation and unit/e2e tests

.github/workflows/pull-request-main.yml

@@ -136,11 +136,16 @@ jobs:
             CTF_CONFIGS=../config.sui.toml go test -p=1 -tags=e2e -v ./e2e/tests/... -run=TestSuiSuite || sui_failure=true
             echo "::endgroup::"
 
+            echo "::group::TON"
+            CTF_CONFIGS=../config.ton.toml go test -p=1 -tags=e2e -v ./e2e/tests/... -run=TestTONSuite || ton_failure=true
+            echo "::endgroup::"
+
             [[ -n "${evm_failure}" ]] && echo "🚨 EVM e2e tests failed."
             [[ -n "${solana_failure}" ]] && echo "🚨 Solana e2e tests failed."
             [[ -n "${aptos_failure}" ]] && echo "🚨 Aptos e2e tests failed."
             [[ -n "${sui_failure}" ]] && echo "🚨 Sui e2e tests failed."
-            [[ -n "${evm_failure}" || -n "${solana_failure}" || -n "${aptos_failure}" || -n "${sui_failure}" ]] && {
+            [[ -n "${ton_failure}" ]] && echo "🚨 TON e2e tests failed."
+            [[ -n "${evm_failure}" || -n "${solana_failure}" || -n "${aptos_failure}" || -n "${sui_failure}" || -n "${ton_failure}" ]] && {
               exit 1
             } || {
               echo "Exiting"

.mockery.yaml

@@ -14,6 +14,24 @@ mockname: "{{.InterfaceName}}"
 inpackage: false
 outpkg: mocks
 packages:
+  github.com/xssnick/tonutils-go/ton/wallet:
+    config:
+      all: false
+      outpkg: "mock_ton"
+    interfaces:
+      TonAPI:
+        config:
+          dir: "./sdk/ton/mocks"
+          filename: "wallet.go"
+  github.com/xssnick/tonutils-go/ton:
+    config:
+      all: false
+      outpkg: "mock_ton"
+    interfaces:
+      APIClientWrapped:
+        config:
+          dir: "./sdk/ton/mocks"
+          filename: "api.go"
   github.com/smartcontractkit/mcms/sdk:
   github.com/smartcontractkit/mcms/sdk/evm:
   github.com/smartcontractkit/mcms/sdk/evm/bindings:

e2e/config.ton.toml

@@ -0,0 +1,15 @@
+[settings]
+private_keys = [
+    "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
+    "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
+    "0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a"
+]
+
+[ton_config]
+chain_id = "-217"
+type = "ton"
+image = "ghcr.io/neodix42/mylocalton-docker:v3.95"
+
+[ton_config.custom_env]
+GLOBAL_ID = "-217"
+NEXT_BLOCK_GENERATION_DELAY = "0.5"

e2e/tests/common/signing.go

@@ -0,0 +1,95 @@
+//go:build e2e
+// +build e2e
+
+package common
+
+import (
+	"encoding/json"
+	"io"
+	"os"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/stretchr/testify/suite"
+
+	"github.com/smartcontractkit/mcms"
+	"github.com/smartcontractkit/mcms/sdk"
+	"github.com/smartcontractkit/mcms/types"
+
+	e2e "github.com/smartcontractkit/mcms/e2e/tests"
+	testutils "github.com/smartcontractkit/mcms/e2e/utils"
+)
+
+// SigningTestSuite tests signing a proposal and converting back to a file
+type SigningTestSuite struct {
+	suite.Suite
+	e2e.TestSetup
+}
+
+// SetupSuite runs before the test suite
+func (s *SigningTestSuite) SetupSuite() {
+	s.TestSetup = *e2e.InitializeSharedTestSetup(s.T())
+}
+
+func (s *SigningTestSuite) TestReadAndSign() {
+	file, err := testutils.ReadFixture("proposal-testing.json")
+	s.Require().NoError(err, "Failed to read fixture") // Check immediately after ReadFixture
+	defer func(file *os.File) {
+		if file != nil {
+			err = file.Close()
+			s.Require().NoError(err, "Failed to close file")
+		}
+	}(file)
+	s.Require().NoError(err)
+	proposal, err := mcms.NewProposal(file)
+	s.Require().NoError(err)
+	s.Require().NotNil(proposal)
+
+	inspectors := map[types.ChainSelector]sdk.Inspector{} // empty
+	signable, err := mcms.NewSignable(proposal, inspectors)
+	s.Require().NoError(err)
+	signature, err := signable.SignAndAppend(
+		mcms.NewPrivateKeySigner(testutils.ParsePrivateKey(s.Settings.PrivateKeys[1])),
+	)
+	s.Require().NoError(err)
+	expected := types.Signature{
+		R: common.HexToHash("0x1ed7807767b09344df63797fa4986ce092730813922ce01563062cf51728ac34"),
+		S: common.HexToHash("0x556721244f77182c1130a5ee8d78ac7067cef52662dbb57b4132c6ec567ecbc8"),
+		V: 0,
+	}
+	s.Require().Equal(expected, signature)
+	// Write the proposal back to a temp file
+	tmpFile, err := os.CreateTemp("", "signed-proposal-*.json")
+	s.Require().NoError(err)
+	defer func(name string) {
+		err = os.Remove(name)
+		s.Require().NoError(err, "Failed to remove temp file")
+	}(tmpFile.Name())
+	err = mcms.WriteProposal(tmpFile, proposal)
+	s.Require().NoError(err)
+
+	// Read back the written proposal
+	_, err = tmpFile.Seek(0, io.SeekStart)
+	s.Require().NoError(err, "Failed to reset file pointer to the start")
+
+	writtenProposal, err := mcms.NewProposal(tmpFile)
+	s.Require().NoError(err)
+
+	// Validate the appended signature
+	signedProposalJSON, err := json.Marshal(writtenProposal)
+	s.Require().NoError(err)
+
+	var parsedProposal map[string]any
+	err = json.Unmarshal(signedProposalJSON, &parsedProposal)
+	s.Require().NoError(err)
+
+	// Ensure the signature is present and matches
+	signatures, ok := parsedProposal["signatures"].([]any)
+	s.Require().True(ok, "Signatures field is missing or of the wrong type")
+	s.Require().NotEmpty(signatures, "Signatures field is empty")
+
+	// Verify the appended signature matches the expected value
+	appendedSignature := signatures[len(signatures)-1].(map[string]any)
+	s.Require().Equal(expected.R.Hex(), appendedSignature["R"])
+	s.Require().Equal(expected.S.Hex(), appendedSignature["S"])
+	s.Require().InDelta(expected.V, appendedSignature["V"], 1e-9)
+}

e2e/tests/evm/signing.go

@@ -4,102 +4,10 @@
 package evme2e
 
 import (
-	"encoding/json"
-	"io"
-	"os"
-
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/ethclient"
-	cselectors "github.com/smartcontractkit/chain-selectors"
-	"github.com/stretchr/testify/suite"
-
-	"github.com/smartcontractkit/mcms"
-	e2e "github.com/smartcontractkit/mcms/e2e/tests"
-	testutils "github.com/smartcontractkit/mcms/e2e/utils"
-	"github.com/smartcontractkit/mcms/sdk"
-	"github.com/smartcontractkit/mcms/sdk/evm"
-	mcmtypes "github.com/smartcontractkit/mcms/types"
+	"github.com/smartcontractkit/mcms/e2e/tests/common"
 )
 
 // SigningTestSuite tests signing a proposal and converting back to a file
 type SigningTestSuite struct {
-	suite.Suite
-	e2e.TestSetup
-
-	client        *ethclient.Client
-	chainSelector mcmtypes.ChainSelector
-}
-
-// SetupSuite runs before the test suite
-func (s *SigningTestSuite) SetupSuite() {
-	s.TestSetup = *e2e.InitializeSharedTestSetup(s.T())
-
-	chainDetails, err := cselectors.GetChainDetailsByChainIDAndFamily(s.BlockchainA.Out.ChainID, s.BlockchainA.Out.Family)
-	s.Require().NoError(err)
-	s.chainSelector = mcmtypes.ChainSelector(chainDetails.ChainSelector)
-}
-
-func (s *SigningTestSuite) TestReadAndSign() {
-	file, err := testutils.ReadFixture("proposal-testing.json")
-	s.Require().NoError(err, "Failed to read fixture") // Check immediately after ReadFixture
-	defer func(file *os.File) {
-		if file != nil {
-			err = file.Close()
-			s.Require().NoError(err, "Failed to close file")
-		}
-	}(file)
-	s.Require().NoError(err)
-	proposal, err := mcms.NewProposal(file)
-	s.Require().NoError(err)
-	s.Require().NotNil(proposal)
-	inspectors := map[mcmtypes.ChainSelector]sdk.Inspector{
-		s.chainSelector: evm.NewInspector(s.client),
-	}
-	signable, err := mcms.NewSignable(proposal, inspectors)
-	s.Require().NoError(err)
-	signature, err := signable.SignAndAppend(
-		mcms.NewPrivateKeySigner(testutils.ParsePrivateKey(s.Settings.PrivateKeys[1])),
-	)
-	s.Require().NoError(err)
-	expected := mcmtypes.Signature{
-		R: common.HexToHash("0x1ed7807767b09344df63797fa4986ce092730813922ce01563062cf51728ac34"),
-		S: common.HexToHash("0x556721244f77182c1130a5ee8d78ac7067cef52662dbb57b4132c6ec567ecbc8"),
-		V: 0,
-	}
-	s.Require().Equal(expected, signature)
-	// Write the proposal back to a temp file
-	tmpFile, err := os.CreateTemp("", "signed-proposal-*.json")
-	s.Require().NoError(err)
-	defer func(name string) {
-		err = os.Remove(name)
-		s.Require().NoError(err, "Failed to remove temp file")
-	}(tmpFile.Name())
-	err = mcms.WriteProposal(tmpFile, proposal)
-	s.Require().NoError(err)
-
-	// Read back the written proposal
-	_, err = tmpFile.Seek(0, io.SeekStart)
-	s.Require().NoError(err, "Failed to reset file pointer to the start")
-
-	writtenProposal, err := mcms.NewProposal(tmpFile)
-	s.Require().NoError(err)
-
-	// Validate the appended signature
-	signedProposalJSON, err := json.Marshal(writtenProposal)
-	s.Require().NoError(err)
-
-	var parsedProposal map[string]any
-	err = json.Unmarshal(signedProposalJSON, &parsedProposal)
-	s.Require().NoError(err)
-
-	// Ensure the signature is present and matches
-	signatures, ok := parsedProposal["signatures"].([]any)
-	s.Require().True(ok, "Signatures field is missing or of the wrong type")
-	s.Require().NotEmpty(signatures, "Signatures field is empty")
-
-	// Verify the appended signature matches the expected value
-	appendedSignature := signatures[len(signatures)-1].(map[string]any)
-	s.Require().Equal(expected.R.Hex(), appendedSignature["R"])
-	s.Require().Equal(expected.S.Hex(), appendedSignature["S"])
-	s.Require().InDelta(expected.V, appendedSignature["V"], 1e-9)
+	common.SigningTestSuite
 }

e2e/tests/evm/timelock_inspection.go

@@ -32,7 +32,7 @@ type TimelockInspectionTestSuite struct {
 	e2e.TestSetup
 }
 
-func (s *TimelockInspectionTestSuite) granRole(role [32]byte, address common.Address) {
+func (s *TimelockInspectionTestSuite) grantRole(role [32]byte, address common.Address) {
 	ctx := context.Background()
 	tx, err := s.timelockContract.GrantRole(s.auth, role, address)
 	s.Require().NoError(err)
@@ -80,23 +80,23 @@ func (s *TimelockInspectionTestSuite) SetupSuite() {
 	// Proposers
 	role, err := s.timelockContract.PROPOSERROLE(&bind.CallOpts{})
 	s.Require().NoError(err)
-	s.granRole(role, s.signerAddresses[0])
+	s.grantRole(role, s.signerAddresses[0])
 	// Executors
 	role, err = s.timelockContract.EXECUTORROLE(&bind.CallOpts{})
 	s.Require().NoError(err)
-	s.granRole(role, s.signerAddresses[0])
-	s.granRole(role, s.signerAddresses[1])
+	s.grantRole(role, s.signerAddresses[0])
+	s.grantRole(role, s.signerAddresses[1])
 
 	// By passers
 	role, err = s.timelockContract.BYPASSERROLE(&bind.CallOpts{})
 	s.Require().NoError(err)
-	s.granRole(role, s.signerAddresses[1])
+	s.grantRole(role, s.signerAddresses[1])
 
 	// Cancellers
 	role, err = s.timelockContract.CANCELLERROLE(&bind.CallOpts{})
 	s.Require().NoError(err)
-	s.granRole(role, s.signerAddresses[0])
-	s.granRole(role, s.signerAddresses[1])
+	s.grantRole(role, s.signerAddresses[0])
+	s.grantRole(role, s.signerAddresses[1])
 }
 
 // TestGetProposers gets the list of proposers

e2e/tests/runner_test.go

@@ -12,6 +12,7 @@ import (
 	evme2e "github.com/smartcontractkit/mcms/e2e/tests/evm"
 	solanae2e "github.com/smartcontractkit/mcms/e2e/tests/solana"
 	suie2e "github.com/smartcontractkit/mcms/e2e/tests/sui"
+	tone2e "github.com/smartcontractkit/mcms/e2e/tests/ton"
 )
 
 func TestEVMSuite(t *testing.T) {
@@ -40,3 +41,9 @@ func TestSuiSuite(t *testing.T) {
 	suite.Run(t, new(suie2e.TimelockCancelProposalTestSuite))
 	suite.Run(t, new(suie2e.MCMSUserUpgradeTestSuite))
 }
+
+func TestTONSuite(t *testing.T) {
+	// suite.Run(t, new(tone2e.TimelockInspectionTestSuite))
+	suite.Run(t, new(tone2e.SigningTestSuite))
+	suite.Run(t, new(tone2e.SetConfigTestSuite))
+}

e2e/tests/setup.go

@@ -18,6 +18,9 @@ import (
 	"github.com/gagliardetto/solana-go/rpc/ws"
 	"github.com/joho/godotenv"
 	"github.com/stretchr/testify/require"
+	"github.com/xssnick/tonutils-go/ton"
+
+	tonchain "github.com/smartcontractkit/chainlink-ton/pkg/ton/chain"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
@@ -39,6 +42,7 @@ type Config struct {
 	SolanaChain *blockchain.Input `toml:"solana_config"`
 	AptosChain  *blockchain.Input `toml:"aptos_config"`
 	SuiChain    *blockchain.Input `toml:"sui_config"`
+	TonChain    *blockchain.Input `toml:"ton_config"`
 
 	Settings struct {
 		PrivateKeys     []string `toml:"private_keys"`
@@ -57,6 +61,8 @@ type TestSetup struct {
 	AptosBlockchain  *blockchain.Output
 	SuiClient        sui.ISuiAPI
 	SuiBlockchain    *blockchain.Output
+	TonClient        *ton.APIClient
+	TonBlockchain    *blockchain.Output
 	Config
 }
 
@@ -203,6 +209,30 @@ func InitializeSharedTestSetup(t *testing.T) *TestSetup {
 			t.Logf("Initialized Sui RPC client @ %s", nodeUrl)
 		}
 
+		var (
+			tonClient           *ton.APIClient
+			tonBlockchainOutput *blockchain.Output
+		)
+		if in.TonChain != nil {
+			// Use blockchain network setup (fallback)
+			ports := freeport.GetN(t, 2)
+			port := ports[0]
+			faucetPort := ports[1]
+			in.TonChain.Port = strconv.Itoa(port)
+			in.TonChain.FaucetPort = strconv.Itoa(faucetPort)
+
+			tonBlockchainOutput, err = blockchain.NewBlockchainNetwork(in.TonChain)
+			require.NoError(t, err, "Failed to initialize TON blockchain")
+
+			nodeUrl := tonBlockchainOutput.Nodes[0].ExternalHTTPUrl
+			pool, err := tonchain.CreateLiteserverConnectionPool(ctx, nodeUrl)
+			require.NoError(t, err, "Failed to initialize TON client - failed to create liteserver connection pool")
+			tonClient = ton.NewAPIClient(pool, ton.ProofCheckPolicyFast)
+
+			// Test liveness, will also fetch ChainID
+			t.Logf("Initialized TON RPC client @ %s", nodeUrl)
+		}
+
 		sharedSetup = &TestSetup{
 			ClientA:          ethClientA,
 			ClientB:          ethClientB,
@@ -213,6 +243,8 @@ func InitializeSharedTestSetup(t *testing.T) *TestSetup {
 			AptosBlockchain:  aptosBlockchainOutput,
 			SuiClient:        suiClient,
 			SuiBlockchain:    suiBlockchainOutput,
+			TonClient:        tonClient,
+			TonBlockchain:    tonBlockchainOutput,
 			Config:           *in,
 		}
 	})