Fix #145: Remove encodePermissionContexts and decodePermissionContexts functions from public interface (#148)

* Remove encodePermissionContexts and decodePermissionContexts wrappers

* Remove remaining references to encodePermissionContexts

* Fix linting errors

* Fix e2e tests that relied on the removed functino

---------

Co-authored-by: Patchy Bot <patchy@localhost>
Co-authored-by: Jeff Smale <6363749+jeffsmale90@users.noreply.github.com>

Author: 3 people

packages/delegator-e2e/test/delegateAndRedeem.test.ts

@@ -22,7 +22,7 @@ import {
   type PartialSignature,
 } from '@metamask/smart-accounts-kit';
 import {
-  encodePermissionContexts,
+  encodeDelegations,
   encodeExecutionCalldatas,
 } from '@metamask/smart-accounts-kit/utils';
 import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts';
@@ -123,7 +123,7 @@ test('maincase: Bob increments the counter with a delegation from Alice', async
     abi: bobSmartAccount.abi,
     functionName: 'redeemDelegations',
     args: [
-      encodePermissionContexts([[signedDelegation]]),
+      [encodeDelegations([signedDelegation])],
       [ExecutionMode.SingleDefault],
       encodeExecutionCalldatas([[execution]]),
     ],
@@ -232,7 +232,7 @@ test("Bob attempts to increment the counter with a delegation from Alice that do
     abi: bobSmartAccount.abi,
     functionName: 'redeemDelegations',
     args: [
-      encodePermissionContexts([[signedDelegation]]),
+      [encodeDelegations([signedDelegation])],
       [ExecutionMode.SingleDefault],
       encodeExecutionCalldatas([[execution]]),
     ],
@@ -335,7 +335,7 @@ test('Bob increments the counter with a delegation from a multisig account', asy
     abi: bobSmartAccount.abi,
     functionName: 'redeemDelegations',
     args: [
-      encodePermissionContexts([[signedDelegation]]),
+      [encodeDelegations([signedDelegation])],
       [ExecutionMode.SingleDefault],
       encodeExecutionCalldatas([[execution]]),
     ],
@@ -366,4 +366,4 @@ test('Bob increments the counter with a delegation from a multisig account', asy
 
   const countAfter = await counterContract.read.count();
   expect(countAfter, 'Expected final count to have incremented').toEqual(1n);
-});
+});

packages/smart-accounts-kit/src/DelegationFramework/DelegationManager/methods/redeemDelegations.ts

@@ -3,7 +3,7 @@ import type { Address, Client } from 'viem';
 import { encodeFunctionData } from 'viem';
 import { simulateContract, writeContract } from 'viem/actions';
 
-import { encodePermissionContexts } from '../../../delegation';
+import { encodeDelegations } from '../../../delegation';
 import { encodeExecutionCalldatas } from '../../../executions';
 import type { ExecutionMode, ExecutionStruct } from '../../../executions';
 import type { Delegation } from '../../../types';
@@ -37,7 +37,7 @@ export const simulate = async ({
     abi: DelegationManager,
     functionName: 'redeemDelegations',
     args: [
-      encodePermissionContexts(delegations),
+      delegations.map((delegationChain) => encodeDelegations(delegationChain)),
       modes,
       encodeExecutionCalldatas(executions),
     ],
@@ -71,7 +71,7 @@ export const encode = ({
     abi: DelegationManager,
     functionName: 'redeemDelegations',
     args: [
-      encodePermissionContexts(delegations),
+      delegations.map((delegationChain) => encodeDelegations(delegationChain)),
       modes,
       encodeExecutionCalldatas(executions),
     ],

packages/smart-accounts-kit/src/delegation.ts

@@ -116,20 +116,6 @@ export const encodeDelegation = (delegation: Delegation): Hex => {
   return encodeDelegationCore(delegationStruct);
 };
 
-/**
- * Abi encodes permission contexts.
- *
- * @param delegations - The delegation chains to encode.
- * @returns The encoded permission contexts.
- */
-export const encodePermissionContexts = (delegations: Delegation[][]) => {
-  const encodedDelegations = delegations.map((delegationChain) =>
-    encodeDelegations(delegationChain),
-  );
-
-  return encodedDelegations;
-};
-
 /**
  * Decodes an array of delegations from its ABI-encoded representation.
  *
@@ -152,18 +138,6 @@ export const decodeDelegation = (encoded: Hex): Delegation => {
   return toDelegation(decodeDelegationCore(encoded));
 };
 
-/**
- * Decodes an array of encoded permission contexts into an array of delegation chains.
- *
- * @param encoded - The hex-encoded permission context to decode.
- * @returns An array of decoded delegations.
- */
-export const decodePermissionContexts = (encoded: Hex[]): Delegation[][] => {
-  const delegationChains = encoded.map(decodeDelegations);
-
-  return delegationChains;
-};
-
 /**
  * TypedData to be used when signing a Delegation. Delegation value for `signature` and Caveat values for `args` are omitted as they cannot be known at signing time.
  */

packages/smart-accounts-kit/src/utils/index.ts

@@ -5,8 +5,6 @@ export {
   decodeDelegation,
   toDelegationStruct,
   toDelegation,
-  encodePermissionContexts,
-  decodePermissionContexts,
   DELEGATION_ARRAY_ABI_TYPE,
   DELEGATION_ABI_TYPE,
   DELEGATION_ABI_TYPE_COMPONENTS,

packages/smart-accounts-kit/test/delegation.test.ts

@@ -14,8 +14,6 @@ import {
   decodeDelegations,
   encodeDelegation,
   decodeDelegation,
-  encodePermissionContexts,
-  decodePermissionContexts,
   signDelegation,
 } from '../src/delegation';
 import type {
@@ -711,128 +709,6 @@ describe('decodeDelegation', () => {
   });
 });
 
-describe('encodePermissionContexts', () => {
-  const mockDelegation1: Delegation = {
-    delegate: mockDelegate,
-    delegator: mockDelegator,
-    authority: ROOT_AUTHORITY,
-    caveats: [mockCaveat],
-    salt: '0x123' as Hex,
-    signature: mockSignature,
-  };
-
-  const mockDelegation2: Delegation = {
-    delegate: '0x2222222222222222222222222222222222222222',
-    delegator: '0x3333333333333333333333333333333333333333',
-    authority: ROOT_AUTHORITY,
-    caveats: [
-      {
-        enforcer: '0x1111111111111111111111111111111111111111',
-        terms: '0x',
-        args: '0x00',
-      },
-    ],
-    salt: '0x456' as Hex,
-    signature: mockSignature,
-  };
-
-  it('should encode a single permission context', () => {
-    const permissionContexts = [[mockDelegation1]];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(1);
-    expect(decoded).to.deep.equal([[mockDelegation1]]);
-  });
-
-  it('should encode multiple permission contexts', () => {
-    const permissionContexts = [[mockDelegation1], [mockDelegation2]];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(2);
-    expect(decoded).to.deep.equal([[mockDelegation1], [mockDelegation2]]);
-  });
-
-  it('should handle permission contexts with multiple delegations', () => {
-    const permissionContexts = [[mockDelegation1, mockDelegation2]];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(1);
-    expect(decoded).to.deep.equal([[mockDelegation1, mockDelegation2]]);
-  });
-
-  it('should handle empty permission contexts', () => {
-    const permissionContexts: Delegation[][] = [];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(0);
-  });
-});
-
-describe('decodePermissionContexts', () => {
-  const mockDelegation1: Delegation = {
-    delegate: mockDelegate,
-    delegator: mockDelegator,
-    authority: ROOT_AUTHORITY,
-    caveats: [mockCaveat],
-    salt: '0x123' as Hex,
-    signature: mockSignature,
-  };
-
-  const mockDelegation2: Delegation = {
-    delegate: '0x2222222222222222222222222222222222222222',
-    delegator: '0x3333333333333333333333333333333333333333',
-    authority: ROOT_AUTHORITY,
-    caveats: [
-      {
-        enforcer: '0x1111111111111111111111111111111111111111',
-        terms: '0x',
-        args: '0x00',
-      },
-    ],
-    salt: '0x456' as Hex,
-    signature: mockSignature,
-  };
-
-  it('should decode a single permission context', () => {
-    const permissionContexts = [[mockDelegation1]];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(1);
-    expect(decoded).to.deep.equal([[mockDelegation1]]);
-  });
-
-  it('should decode multiple permission contexts', () => {
-    const permissionContexts = [[mockDelegation1], [mockDelegation2]];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(2);
-    expect(decoded).to.deep.equal([[mockDelegation1], [mockDelegation2]]);
-  });
-
-  it('should handle permission contexts with multiple delegations', () => {
-    const permissionContexts = [[mockDelegation1, mockDelegation2]];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(1);
-    expect(decoded).to.deep.equal([[mockDelegation1, mockDelegation2]]);
-  });
-
-  it('should handle empty permission contexts', () => {
-    const permissionContexts: Delegation[][] = [];
-    const encoded = encodePermissionContexts(permissionContexts);
-    const decoded = decodePermissionContexts(encoded);
-
-    expect(decoded).to.have.length(0);
-  });
-});
-
 describe('signDelegation', () => {
   const mockPrivateKey: Hex =
     '0x1234567890123456789012345678901234567890123456789012345678901234';