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

@@ -69,6 +69,11 @@ jobs:
       contents: read
       actions: read
     steps:
+      - name: Install Nix
+        uses: cachix/install-nix-action@02a151ada4993995686f9ed4f1be7cfbb229e56f # v31
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
       - name: Install Rust
         uses: moonrepo/setup-rust@ede6de059f8046a5e236c94046823e2af11ca670 # v1.2.2
 
@@ -114,6 +119,14 @@ jobs:
         run: |
           ./e2e/tests/solana/compile-mcm-contracts.sh
 
+      - name: Build TON contracts
+        id: ton-contracts-build
+        shell: bash
+        run: |
+          PATH_CONTRACTS_TON_PKG="$(nix build .#chainlink-ton-contracts --print-out-paths)/"
+          PATH_CONTRACTS_TON="$PATH_CONTRACTS_TON_PKG/lib/node_modules/@chainlink/contracts-ton/build/"
+          echo "path=$PATH_CONTRACTS_TON" >> "$GITHUB_OUTPUT"
+
       - name: Run e2e tests
         uses: smartcontractkit/.github/actions/ci-test-go@ci-test-go/1.0.0
         with:
@@ -138,11 +151,17 @@ 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"
+            export PATH_CONTRACTS_TON="${{ steps.ton-contracts-build.outputs.path }}"
+            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,18 @@
+[settings]
+private_keys = [
+    "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
+    "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
+    "0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a"
+]
+
+[ton_config]
+chain_id = "-217"
+type = "ton"
+image = "ghcr.io/neodix42/mylocalton-docker:v3.97"
+
+[ton_config.out]
+family = "ton"
+
+[ton_config.custom_env]
+NEXT_BLOCK_GENERATION_DELAY = "0.5"
+VERSION_CAPABILITIES = "12"

e2e/tests/aptos/set_config.go

@@ -4,7 +4,6 @@ package aptos
 
 import (
 	"slices"
-	"strings"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
@@ -30,7 +29,7 @@ func (a *TestSuite) TestSetConfig() {
 		signers[i] = crypto.PubkeyToAddress(key.PublicKey)
 	}
 	slices.SortFunc(signers[:], func(a, b common.Address) int {
-		return strings.Compare(strings.ToLower(a.Hex()), strings.ToLower(b.Hex()))
+		return a.Cmp(b)
 	})
 
 	bypasserConfig := &types.Config{

e2e/tests/runner_test.go

@@ -11,6 +11,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) {
@@ -39,3 +40,12 @@ 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.SigningTestSuite))
+	suite.Run(t, new(tone2e.SetConfigTestSuite))
+	suite.Run(t, new(tone2e.SetRootTestSuite))
+	suite.Run(t, new(tone2e.InspectionTestSuite))
+	suite.Run(t, new(tone2e.ExecutionTestSuite))
+	suite.Run(t, new(tone2e.TimelockInspectionTestSuite))
+}

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,
 		}
 	})

e2e/tests/sui/set_config.go

@@ -4,7 +4,6 @@ package sui
 
 import (
 	"slices"
-	"strings"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/crypto"
@@ -26,7 +25,7 @@ func (s *TestSuite) TestSetConfig() {
 		signers[i] = crypto.PubkeyToAddress(key.PublicKey)
 	}
 	slices.SortFunc(signers[:], func(a, b common.Address) int {
-		return strings.Compare(strings.ToLower(a.Hex()), strings.ToLower(b.Hex()))
+		return a.Cmp(b)
 	})
 
 	bypasserConfig := &types.Config{

e2e/tests/ton/common.go

@@ -0,0 +1,122 @@
+//go:build e2e
+
+package tone2e
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/ethereum/go-ethereum/common"
+
+	"github.com/xssnick/tonutils-go/address"
+	"github.com/xssnick/tonutils-go/tlb"
+	"github.com/xssnick/tonutils-go/ton"
+	"github.com/xssnick/tonutils-go/ton/wallet"
+	"github.com/xssnick/tonutils-go/tvm/cell"
+
+	"github.com/smartcontractkit/chainlink-ton/pkg/bindings/mcms/mcms"
+	"github.com/smartcontractkit/chainlink-ton/pkg/bindings/mcms/timelock"
+	"github.com/smartcontractkit/chainlink-ton/pkg/ton/tracetracking"
+	"github.com/smartcontractkit/chainlink-ton/pkg/ton/wrappers"
+
+	"github.com/smartcontractkit/mcms/internal/testutils"
+	"github.com/smartcontractkit/mcms/types"
+)
+
+const (
+	EnvPathContracts = "PATH_CONTRACTS_TON"
+
+	PathContractsMCMS     = "mcms.MCMS.compiled.json"
+	PathContractsTimelock = "mcms.RBACTimelock.compiled.json"
+)
+
+func must[E any](out E, err error) E {
+	if err != nil {
+		panic(err)
+	}
+
+	return out
+}
+
+type DeployOpts struct {
+	// Connection
+	Client *ton.APIClient
+	Wallet *wallet.Wallet
+
+	// Deployment info
+	ContractPath string
+
+	Amount tlb.Coins
+	Data   any
+	Body   any
+}
+
+func DeployContract(ctx context.Context, opts DeployOpts) (*address.Address, error) {
+	contractCode, err := wrappers.ParseCompiledContract(opts.ContractPath)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse compiled contract: %w", err)
+	}
+
+	contractData, ok := opts.Data.(*cell.Cell) // Cell or we try to decode
+	if !ok {
+		contractData, err = tlb.ToCell(opts.Data)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create contract data cell: %w", err)
+		}
+	}
+
+	bodyCell, ok := opts.Body.(*cell.Cell) // Cell or we try to decode
+	if !ok {
+		bodyCell, err = tlb.ToCell(opts.Body)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create contract body cell: %w", err)
+		}
+	}
+
+	_client := tracetracking.NewSignedAPIClient(opts.Client, *opts.Wallet)
+	contract, _, err := wrappers.Deploy(ctx, &_client, contractCode, contractData, opts.Amount, bodyCell)
+	if err != nil {
+		return nil, fmt.Errorf("failed to deploy contract: %w", err)
+	}
+
+	return contract.Address, nil
+}
+
+func DeployMCMSContract(ctx context.Context, client *ton.APIClient, w *wallet.Wallet, amount tlb.Coins, data mcms.Data) (*address.Address, error) {
+	return DeployContract(ctx, DeployOpts{
+		Client:       client,
+		Wallet:       w,
+		ContractPath: filepath.Join(os.Getenv(EnvPathContracts), PathContractsMCMS),
+		Amount:       amount,
+		Data:         data,
+		Body:         cell.BeginCell().EndCell(), // empty cell, top up
+	})
+}
+
+func DeployTimelockContract(ctx context.Context, client *ton.APIClient, w *wallet.Wallet, amount tlb.Coins, data timelock.Data, body timelock.Init) (*address.Address, error) {
+	return DeployContract(ctx, DeployOpts{
+		Client:       client,
+		Wallet:       w,
+		ContractPath: filepath.Join(os.Getenv(EnvPathContracts), PathContractsTimelock),
+		Amount:       amount,
+		Data:         data,
+		Body:         body,
+	})
+}
+
+// GenSimpleTestMCMSConfig generates a simple test configuration that's used in e2e tests.
+func GenSimpleTestMCMSConfig(signers []testutils.ECDSASigner) *types.Config {
+	return &types.Config{
+		Quorum:  1,
+		Signers: []common.Address{signers[0].Address()},
+		GroupSigners: []types.Config{
+			{
+				Quorum:       1,
+				Signers:      []common.Address{signers[1].Address()},
+				GroupSigners: []types.Config{},
+			},
+		},
+	}
+}