Add TrailsUtils for MalleableSigner support for intents

Author: ScreamingHawk

contracts/artifacts/trails-contracts/TrailsUtils.sol/TrailsUtils.json

@@ -18,6 +18,7 @@ import (
 	seqsale721v0 "github.com/0xsequence/go-sequence/contracts/gen/seq_sale/erc721v0"
 	"github.com/0xsequence/go-sequence/contracts/gen/supply"
 	"github.com/0xsequence/go-sequence/contracts/gen/tokens"
+	trailsutils "github.com/0xsequence/go-sequence/contracts/gen/trailsutils"
 	v1Factory "github.com/0xsequence/go-sequence/contracts/gen/v1/walletfactory"
 	v1Estimator "github.com/0xsequence/go-sequence/contracts/gen/v1/walletgasestimator"
 	v1Guest "github.com/0xsequence/go-sequence/contracts/gen/v1/walletguest"
@@ -43,6 +44,7 @@ var GasEstimator,
 	IERC1271,
 	ISapient,
 	ISapientCompact,
+	TrailsUtils,
 	ERC20Mock,
 	IERC20,
 	IERC721,
@@ -131,6 +133,7 @@ func init() {
 	IERC1271 = artifact("IERC1271", ierc1271.IERC1271ABI, "")
 	ISapient = artifact("ISapient", isapient.ISapientABI, "")
 	ISapientCompact = artifact("ISapientCompact", isapient.ISapientCompactABI, "")
+	TrailsUtils = artifact("TRAILS_UTILS", trailsutils.TrailsUtilsABI, trailsutils.TrailsUtilsBin)
 
 	IERC20 = artifact("IERC20", tokens.IERC20ABI, "")
 	IERC721 = artifact("IERC721", tokens.IERC721ABI, "")

contracts/contracts.go

@@ -76,6 +76,11 @@
 //go:generate go run github.com/0xsequence/ethkit/cmd/ethkit abigen --pkg=isapient --type=ISapient --outFile=./isapient/isapient.gen.go --artifactsFile=../artifacts/wallet-contracts-v3/ISapient.sol/ISapient.json
 //go:generate go run github.com/0xsequence/ethkit/cmd/ethkit abigen --pkg=isapient --type=ISapientCompact --outFile=./isapient/isapientcompact.gen.go --artifactsFile=../artifacts/wallet-contracts-v3/ISapient.sol/ISapientCompact.json
 
+//
+// trails
+//
+//go:generate go run github.com/0xsequence/ethkit/cmd/ethkit abigen --pkg=trailsutils --type=TrailsUtils --outFile=./trailsutils/trails_utils.gen.go --artifactsFile=../artifacts/trails-contracts/TrailsUtils.sol/TrailsUtils.json
+
 //
 // sequence marketplace
 //

contracts/gen/gen.go

@@ -6,6 +6,7 @@ import (
 	"math/big"
 
 	"github.com/0xsequence/ethkit/ethcoder"
+	"github.com/0xsequence/ethkit/ethrpc"
 	"github.com/0xsequence/ethkit/go-ethereum/accounts/abi"
 	"github.com/0xsequence/ethkit/go-ethereum/common"
 	"github.com/0xsequence/go-sequence/core"
@@ -24,6 +25,14 @@ type DestinationToken struct {
 	Amount  *big.Int       `abi:"amount"`
 }
 
+// MalleableSapientConfig contains the configuration for a MalleableSapient signer for a single call payload.
+// Each call payload can have its own sapient address, signature, and provider (for different chains).
+type MalleableSapientConfig struct {
+	Address   common.Address   // The MalleableSapient contract address
+	Signature []byte           // Signature describing which parts are static vs malleable
+	Provider  *ethrpc.Provider // Provider for the chain this call is on
+}
+
 // IntentParams is a new version of intent parameters that uses CallsPayload for destination calls.
 type IntentParams struct {
 	UserAddress       common.Address
@@ -188,10 +197,15 @@ func CreateAnyAddressSubdigestTree(calls []*v3.CallsPayload) ([]v3.WalletConfigT
 
 // `CreateIntentTree` creates a tree from a list of intent operations and a main signer address.
 func CreateIntentTree(mainSigner common.Address, calls []*v3.CallsPayload, sapientSignerLeafNode v3.WalletConfigTree) (*v3.WalletConfigTree, error) {
-	// Create the subdigest leaves from the batched transactions.
-	leaves, err := CreateAnyAddressSubdigestTree(calls)
-	if err != nil {
-		return nil, err
+	var leaves []v3.WalletConfigTree
+
+	if len(calls) > 0 {
+		// Create the subdigest leaves from the batched transactions.
+		subdigestLeaves, err := CreateAnyAddressSubdigestTree(calls)
+		if err != nil {
+			return nil, err
+		}
+		leaves = append(leaves, subdigestLeaves...)
 	}
 
 	// If the sapient signer leaf is not nil, add it to the leaves.
@@ -205,6 +219,10 @@ func CreateIntentTree(mainSigner common.Address, calls []*v3.CallsPayload, sapie
 		Address: mainSigner,
 	}
 
+	if len(leaves) == 0 {
+		return nil, fmt.Errorf("no leaves to create tree from")
+	}
+
 	// If the length of the leaves is 1
 	if len(leaves) == 1 {
 		tree := v3.WalletConfigTreeNodes(mainSignerLeaf, leaves[0])
@@ -238,6 +256,61 @@ func CreateIntentConfiguration(mainSigner common.Address, calls []*v3.CallsPaylo
 	return config, nil
 }
 
+// `CreateIntentConfigurationWithMalleableSapient` creates a wallet configuration with optional MalleableSapient configuration
+func CreateIntentConfigurationWithMalleableSapient(
+	ctx context.Context,
+	mainSigner common.Address,
+	calls []*v3.CallsPayload,
+	configs []MalleableSapientConfig,
+) (*v3.WalletConfig, error) {
+	if len(calls) == 0 {
+		return nil, fmt.Errorf("calls cannot be empty")
+	}
+
+	if len(configs) != len(calls) {
+		return nil, fmt.Errorf("configs length (%d) must match calls length (%d)", len(configs), len(calls))
+	}
+
+	var callsWithoutMalleableSapient []*v3.CallsPayload
+	var sapientSignerLeaves []v3.WalletConfigTree
+	for i, callPayload := range calls {
+		config := configs[i]
+
+		// Skip if address is zero address. Will be handled by CreateIntentConfiguration.
+		if config.Address == (common.Address{}) {
+			callsWithoutMalleableSapient = append(callsWithoutMalleableSapient, callPayload)
+			continue
+		}
+
+		if config.Provider == nil {
+			return nil, fmt.Errorf("provider is required for configs[%d]", i)
+		}
+
+		// Recover the image hash for the payload and configuration
+		imageHash, err := v3.RecoverSapientSignature(ctx, config.Address, *callPayload, config.Signature, config.Provider)
+		if err != nil {
+			return nil, fmt.Errorf("failed to recover sapient signature for configs[%d]: %w", i, err)
+		}
+
+		// Create a SapientSignerLeaf for this payload
+		sapientSignerLeaf := &v3.WalletConfigTreeSapientSignerLeaf{
+			Weight:     1,
+			Address:    config.Address,
+			ImageHash_: imageHash,
+		}
+		sapientSignerLeaves = append(sapientSignerLeaves, sapientSignerLeaf)
+	}
+
+	// Create a tree from all the SapientSignerLeaves
+	var sapientSignerTree v3.WalletConfigTree
+	if len(sapientSignerLeaves) > 0 {
+		sapientSignerTree = v3.WalletConfigTreeNodes(sapientSignerLeaves...)
+	}
+
+	// Remaining calls go to CreateIntentConfiguration
+	return CreateIntentConfiguration(mainSigner, callsWithoutMalleableSapient, sapientSignerTree)
+}
+
 // `GetIntentConfigurationSignature` creates a signature for the intent configuration that can be used to bypass chain ID validation.
 // The signature is based on the transaction bundle digests only.
 func GetIntentConfigurationSignature(