Improve deploy chain sequence by creating a generic deploy contract operation (#265)

* generic deploy contract operation

* self-review-I

* self-review-II

* self-review-III

* Update deployment/ccip/sequence/retrieve_compiled_ton_contracts.go

Co-authored-by: Copilot <[email protected]>

* Update deployment/ccip/sequence/retrieve_compiled_ton_contracts.go

Co-authored-by: Copilot <[email protected]>

* Update deployment/ccip/sequence/retrieve_compiled_ton_contracts.go

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: nicolasgnr

deployment/ccip/cs_deploy_ton_chain.go

@@ -2,6 +2,7 @@ package ops
 
 import (
 	"fmt"
+
 	"github.com/Masterminds/semver/v3"
 	ds "github.com/smartcontractkit/chainlink-deployments-framework/datastore"
 
@@ -69,9 +70,10 @@ func (cs DeployCCIPContracts) Apply(env cldf.Environment, config DeployCCIPContr
 	ccipSeqInput := sequence.DeployCCIPSeqInput{
 		// MCMSAddress:      mcmsSeqReport.Output.MCMSAddress,
 		// LinkTokenAddress: linkTokenAddress,
-		CCIPConfig:       config.Params,
-		ContractsVersion: config.ContractsVersion,
-		ChainSelector:    selector,
+		CCIPConfig:          config.Params,
+		ContractsVersionSha: config.ContractsVersion,
+		ContractsSemver:     semver.MustParse("1.6.0"), // TODO Move to the change input. Will do in a later PR given that this will be a breaking change for CLD
+		ChainSelector:       selector,
 	}
 	ccipSeqReport, err := operations.ExecuteSequence(env.OperationsBundle, sequence.DeployCCIPSequence, deps, ccipSeqInput)
 	if err != nil {
@@ -86,38 +88,29 @@ func (cs DeployCCIPContracts) Apply(env cldf.Environment, config DeployCCIPContr
 
 	// Use data store to track new deployed addresses
 	dataStore := ds.NewMemoryDataStore()
-	// Keep address book for backward compatibility. TODO remove it once we adopted this version in CLD
-	ab := cldf.NewMemoryAddressBook()
-	contractsVersion := *semver.MustParse("1.6.0")
 	if ccipSeqReport.Output.RouterAddress != nil {
 		// FYI Add method will never fail given that the dataStore is empty
 		_ = dataStore.Addresses().Add(ccipSeqReport.Output.RouterAddress.CLDFAddressRef)
-		_ = ab.Save(selector, state.Router.String(), cldf.NewTypeAndVersion(cldf.ContractType(state.Router.String()), contractsVersion))
 		s.Router = ccipSeqReport.Output.RouterAddress.TONAddress
 	}
 	if ccipSeqReport.Output.FeeQuoterAddress != nil {
 		_ = dataStore.Addresses().Add(ccipSeqReport.Output.FeeQuoterAddress.CLDFAddressRef)
-		_ = ab.Save(selector, state.FeeQuoter.String(), cldf.NewTypeAndVersion(cldf.ContractType(state.FeeQuoter.String()), contractsVersion))
 		s.FeeQuoter = ccipSeqReport.Output.FeeQuoterAddress.TONAddress
 	}
 	if ccipSeqReport.Output.OnRampAddress != nil {
 		_ = dataStore.Addresses().Add(ccipSeqReport.Output.OnRampAddress.CLDFAddressRef)
-		_ = ab.Save(selector, state.OnRamp.String(), cldf.NewTypeAndVersion(cldf.ContractType(state.OnRamp.String()), contractsVersion))
 		s.OnRamp = ccipSeqReport.Output.OnRampAddress.TONAddress
 	}
 	if ccipSeqReport.Output.OffRampAddress != nil {
 		_ = dataStore.Addresses().Add(ccipSeqReport.Output.OffRampAddress.CLDFAddressRef)
-		_ = ab.Save(selector, state.OffRamp.String(), cldf.NewTypeAndVersion(cldf.ContractType(state.OffRamp.String()), contractsVersion))
 		s.OffRamp = ccipSeqReport.Output.OffRampAddress.TONAddress
 	}
 	if ccipSeqReport.Output.ReceiverAddress != nil {
 		_ = dataStore.Addresses().Add(ccipSeqReport.Output.ReceiverAddress.CLDFAddressRef)
-		_ = ab.Save(selector, state.TonReceiver.String(), cldf.NewTypeAndVersion(cldf.ContractType(state.TonReceiver.String()), contractsVersion))
 		s.ReceiverAddress = ccipSeqReport.Output.ReceiverAddress.TONAddress
 	}
 	if ccipSeqReport.Output.TimelockAddress != nil {
 		_ = dataStore.Addresses().Add(ccipSeqReport.Output.TimelockAddress.CLDFAddressRef)
-		_ = ab.Save(selector, state.Timelock.String(), cldf.NewTypeAndVersion(cldf.ContractType(state.Timelock.String()), contractsVersion))
 		s.Timelock = ccipSeqReport.Output.TimelockAddress.TONAddress
 	}
 
@@ -148,6 +141,9 @@ func (cs DeployCCIPContracts) Apply(env cldf.Environment, config DeployCCIPContr
 		return cldf.ChangesetOutput{}, err
 	}
 
+	// Keep address book for backward compatibility. TODO remove it once we adopted this version in CLD
+	ab, _ := dataStoreToAddressBook(dataStore)
+
 	// TODO: generate MCMS proposal or execute
 	return cldf.ChangesetOutput{
 		MCMSTimelockProposals: proposals,
@@ -156,3 +152,20 @@ func (cs DeployCCIPContracts) Apply(env cldf.Environment, config DeployCCIPContr
 		AddressBook:           ab,
 	}, nil
 }
+
+// Temp function to transform a DataStore to the legacy AddressBook. Couldn't find any utility function to do this.
+// Once we adopt this new change set in CLD we can remove returning AddressBook at all :)
+func dataStoreToAddressBook(ds *ds.MemoryDataStore) (*cldf.AddressBookMap, error) {
+	ab := cldf.NewMemoryAddressBook()
+	addresses, err := ds.Addresses().Fetch()
+	if err != nil {
+		return nil, fmt.Errorf("failed to list addresses from datastore: %w", err)
+	}
+	for _, addrRef := range addresses {
+		err := ab.Save(addrRef.ChainSelector, addrRef.Address, cldf.NewTypeAndVersion(cldf.ContractType(addrRef.Type), *addrRef.Version))
+		if err != nil {
+			return nil, fmt.Errorf("failed to save address %s to address book: %w", addrRef.Type, err)
+		}
+	}
+	return ab, nil
+}

deployment/ccip/operation/deploy_ton_contract.go

@@ -0,0 +1,100 @@
+package operation
+
+import (
+	"encoding/hex"
+	"errors"
+	"fmt"
+	"math/big"
+	"strings"
+
+	"github.com/xssnick/tonutils-go/tvm/cell"
+
+	"github.com/Masterminds/semver/v3"
+	"github.com/xssnick/tonutils-go/address"
+	"github.com/xssnick/tonutils-go/tlb"
+
+	"github.com/smartcontractkit/chainlink-deployments-framework/operations"
+
+	"github.com/smartcontractkit/chainlink-ton/pkg/ton/tracetracking"
+	"github.com/smartcontractkit/chainlink-ton/pkg/ton/wrappers"
+)
+
+type DeployContractInput struct {
+	Name         string
+	Storage      any
+	MessageBody  any
+	ContractCode *cell.Cell
+	Coins        string
+}
+
+type DeployContractOutput struct {
+	Address *address.Address
+}
+
+var DeployTONContractOp = operations.NewOperation(
+	"deploy-ton-contract-op",
+	semver.MustParse("0.1.0"),
+	"Deploys a TON contract in a generic way",
+	deployTONContract,
+)
+
+func (i *DeployContractInput) Validate() error {
+	if strings.TrimSpace(i.Name) == "" {
+		return errors.New("name field is required")
+	}
+	if i.ContractCode == nil {
+		return errors.New("contract code field is required")
+	}
+	if i.Storage == nil {
+		return errors.New("storage field is required")
+	}
+	if _, ok := new(big.Rat).SetString(i.Coins); !ok {
+		return fmt.Errorf("invalid TON amount %s", i.Coins)
+	}
+
+	return nil
+}
+
+func deployTONContract(b operations.Bundle, deps TonDeps, in DeployContractInput) (DeployContractOutput, error) {
+	output := DeployContractOutput{}
+
+	if err := in.Validate(); err != nil {
+		return output, err
+	}
+
+	b.Logger.Infow("Deploy contract with generic deploy operation", "contract name", in.Name)
+
+	conn := tracetracking.NewSignedAPIClient(deps.TonChain.Client, *deps.TonChain.Wallet)
+
+	initData, err := tlb.ToCell(in.Storage)
+	if err != nil {
+		return output, fmt.Errorf("failed to pack initData: %w", err)
+	}
+	b.Logger.Infow("Setting initial storage for contract", "contract name", in.Name, "storage data hash", hex.EncodeToString(initData.Hash()), "storage bits size", initData.BitsSize())
+
+	bodyCell := cell.BeginCell().EndCell()
+
+	if in.MessageBody != nil {
+		bodyCell, err = tlb.ToCell(in.MessageBody)
+		if err != nil {
+			return output, fmt.Errorf("failed to pack message body: %w", err)
+		}
+	}
+
+	b.Logger.Infow("Initializing contract with body", "contract name", in.Name, "body data hash", hex.EncodeToString(bodyCell.Hash()), "body bits size", bodyCell.BitsSize())
+
+	contract, _, err := wrappers.Deploy(
+		&conn,
+		in.ContractCode,
+		initData,
+		tlb.MustFromTON(in.Coins),
+		bodyCell,
+	)
+	if err != nil {
+		return output, fmt.Errorf("failed to deploy contract: %w", err)
+	}
+	b.Logger.Infow("Contract deployed", "contract name", in.Name, "addr", contract.Address, "deployer wallet addr", deps.TonChain.WalletAddress.String())
+
+	output.Address = contract.Address
+	return output, nil
+}