Add PausableSapient support to Trails intents

intent_config.go

@@ -186,20 +186,60 @@ func CreateAnyAddressSubdigestTree(calls []*v3.CallsPayload) ([]v3.WalletConfigT
 	return leaves, nil
 }
 
-func createIntentTree(mainSigner common.Address, calls []*v3.CallsPayload, additionalLeaves ...v3.WalletConfigTree) (*v3.WalletConfigTree, error) {
+// wrapPayloadGate requires both payloadGateLeaf and protectedLeaves' own threshold to be
+// satisfied (weight 1 each, gate threshold 2), so withholding payloadGateLeaf's signature
+// blocks protectedLeaves regardless of their own weight. payloadGateLeaf must carry weight
+// 1. Safe to call more than once with the same payloadGateLeaf: one signature satisfies
+// every occurrence.
+func wrapPayloadGate(payloadGateLeaf v3.WalletConfigTree, protectedLeaves ...v3.WalletConfigTree) v3.WalletConfigTree {
+	inner := &v3.WalletConfigTreeNestedLeaf{
+		Weight:    1,
+		Threshold: 1,
+		Tree:      v3.WalletConfigTreeNodes(protectedLeaves...),
+	}
+	gate := v3.WalletConfigTreeNodes(payloadGateLeaf, inner)
+	return &v3.WalletConfigTreeNestedLeaf{
+		Weight:    1,
+		Threshold: 2,
+		Tree:      gate,
+	}
+}
+
+func createIntentTree(
+	mainSigner common.Address,
+	calls []*v3.CallsPayload,
+	payloadGateLeafNode v3.WalletConfigTree,
+	sapientSignerLeafNode v3.WalletConfigTree,
+) (*v3.WalletConfigTree, error) {
 	// Create the subdigest leaves from the batched transactions.
-	leaves, err := CreateAnyAddressSubdigestTree(calls)
+	subdigestLeaves, err := CreateAnyAddressSubdigestTree(calls)
 	if err != nil {
 		return nil, err
 	}
 
-	for _, leaf := range additionalLeaves {
-		if leaf != nil {
-			leaves = append(leaves, leaf)
+	var leaves []v3.WalletConfigTree
+
+	if payloadGateLeafNode != nil {
+		// calls && payloadGateLeafNode must match together.
+		leaves = append(leaves, wrapPayloadGate(payloadGateLeafNode, subdigestLeaves...))
+	} else {
+		// No gate: preserve the exact flat structure of the original (pre-gating) tree so
+		// already-derived counterfactual addresses do not change.
+		leaves = append(leaves, subdigestLeaves...)
+	}
+
+	if sapientSignerLeafNode != nil {
+		if payloadGateLeafNode != nil {
+			// Gated the same way as the calls leaves. mainSignerLeaf below is the only
+			// leaf left unaffected by the gate.
+			leaves = append(leaves, wrapPayloadGate(payloadGateLeafNode, sapientSignerLeafNode))
+		} else {
+			leaves = append(leaves, sapientSignerLeafNode)
 		}
 	}
 
-	// Create the main signer leaf (with weight 1).
+	// Create the main signer leaf (with weight 1). Never gated: the owner must remain able
+	// to act (e.g. recover funds) regardless of the gate's paused state.
 	mainSignerLeaf := &v3.WalletConfigTreeAddressLeaf{
 		Weight:  1,
 		Address: mainSigner,
@@ -220,13 +260,28 @@ func createIntentTree(mainSigner common.Address, calls []*v3.CallsPayload, addit
 	return &fullTree, nil
 }
 
-// `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) {
-	return createIntentTree(mainSigner, calls, sapientSignerLeafNode)
+// `CreateIntentTree` creates a tree from a list of intent operations and a main signer
+// address. When payloadGateLeafNode is set, the calls leaves and sapientSignerLeafNode (if
+// provided) are each gated behind it in their own 2-of-2 subtree (see wrapPayloadGate).
+// mainSigner is never gated. Passing nil for payloadGateLeafNode preserves the legacy tree
+// shape.
+func CreateIntentTree(
+	mainSigner common.Address,
+	calls []*v3.CallsPayload,
+	payloadGateLeafNode v3.WalletConfigTree,
+	sapientSignerLeafNode v3.WalletConfigTree,
+) (*v3.WalletConfigTree, error) {
+	return createIntentTree(mainSigner, calls, payloadGateLeafNode, sapientSignerLeafNode)
 }
 
-func createIntentConfiguration(mainSigner common.Address, calls []*v3.CallsPayload, checkpoint uint64, additionalLeaves ...v3.WalletConfigTree) (*v3.WalletConfig, error) {
-	tree, err := createIntentTree(mainSigner, calls, additionalLeaves...)
+func createIntentConfiguration(
+	mainSigner common.Address,
+	calls []*v3.CallsPayload,
+	checkpoint uint64,
+	payloadGateLeafNode v3.WalletConfigTree,
+	sapientSignerLeafNode v3.WalletConfigTree,
+) (*v3.WalletConfig, error) {
+	tree, err := createIntentTree(mainSigner, calls, payloadGateLeafNode, sapientSignerLeafNode)
 	if err != nil {
 		return nil, err
 	}
@@ -238,9 +293,17 @@ func createIntentConfiguration(mainSigner common.Address, calls []*v3.CallsPaylo
 	}, nil
 }
 
-// `CreateIntentConfiguration` creates a wallet configuration where the intent's transaction batches are grouped into the initial subdigest.
-func CreateIntentConfiguration(mainSigner common.Address, calls []*v3.CallsPayload, checkpoint uint64, sapientSignerLeafNode v3.WalletConfigTree) (*v3.WalletConfig, error) {
-	return createIntentConfiguration(mainSigner, calls, checkpoint, sapientSignerLeafNode)
+// `CreateIntentConfiguration` creates a wallet configuration where the intent's transaction
+// batches are grouped into the initial subdigest. See CreateIntentTree for
+// payloadGateLeafNode and sapientSignerLeafNode semantics.
+func CreateIntentConfiguration(
+	mainSigner common.Address,
+	calls []*v3.CallsPayload,
+	checkpoint uint64,
+	payloadGateLeafNode v3.WalletConfigTree,
+	sapientSignerLeafNode v3.WalletConfigTree,
+) (*v3.WalletConfig, error) {
+	return createIntentConfiguration(mainSigner, calls, checkpoint, payloadGateLeafNode, sapientSignerLeafNode)
 }
 
 // `BuildIntentConfigurationSignature` creates a signature for an already-built intent configuration
@@ -287,7 +350,7 @@ func GetIntentConfigurationSignature(
 	sapientSignerLeafNode v3.WalletConfigTree,
 	signerSignatures []*core.SignerSignature,
 ) ([]byte, error) {
-	config, err := createIntentConfiguration(mainSigner, calls, checkpoint, sapientSignerLeafNode)
+	config, err := createIntentConfiguration(mainSigner, calls, checkpoint, nil, sapientSignerLeafNode)
 	if err != nil {
 		return nil, err
 	}