fix(typehash)!: rename DeleteDataSet typehash param (#757)

Renames EIP-712 DeleteDataSet field clientDataSetId to dataSetId, changing the typehash and the derived DeleteDataSetPermission value. Restores signDeleteDataSet typed-data helper.

BREAKING CHANGE: existing session keys for DeleteDataSetPermission must be re-minted. Passing a stale session key to Synapse.create() throws because the permission hash no longer matches.

Author: rvagg

packages/synapse-core/src/typed-data/index.ts

@@ -11,6 +11,7 @@
 export * from './sign-add-pieces.ts'
 export * from './sign-create-dataset.ts'
 export * from './sign-create-dataset-add-pieces.ts'
+export * from './sign-delete-data-set.ts'
 export * from './sign-erc20-permit.ts'
 export * from './sign-schedule-piece-removals.ts'
 export * from './type-definitions.ts'

packages/synapse-core/src/typed-data/sign-delete-data-set.ts

@@ -0,0 +1,29 @@
+import { type Account, type Chain, type Client, encodeAbiParameters, type Transport } from 'viem'
+import { signTypedData } from 'viem/actions'
+import { asChain } from '../chains.ts'
+import { EIP712Types, getStorageDomain } from './type-definitions.ts'
+
+export type SignDeleteDataSetOptions = {
+  dataSetId: bigint
+}
+
+/**
+ * Sign the delete data set message and abi encode the signature.
+ *
+ * @param client - The client to use to sign the message.
+ * @param options - The options for the delete data set message.
+ */
+export async function signDeleteDataSet(client: Client<Transport, Chain, Account>, options: SignDeleteDataSetOptions) {
+  const chain = asChain(client.chain)
+  const signature = await signTypedData(client, {
+    account: client.account,
+    domain: getStorageDomain({ chain }),
+    types: EIP712Types,
+    primaryType: 'DeleteDataSet',
+    message: {
+      dataSetId: options.dataSetId,
+    },
+  })
+  const extraData = encodeAbiParameters([{ type: 'bytes' }], [signature])
+  return extraData
+}

packages/synapse-core/src/typed-data/type-definitions.ts

@@ -28,7 +28,7 @@ export const EIP712Types = {
     { name: 'clientDataSetId', type: 'uint256' },
     { name: 'pieceIds', type: 'uint256[]' },
   ],
-  DeleteDataSet: [{ name: 'clientDataSetId', type: 'uint256' }],
+  DeleteDataSet: [{ name: 'dataSetId', type: 'uint256' }],
 
   /**
    * ERC-2612: Permit Extension for EIP-20 Signed Approvals

packages/synapse-core/test/typed-data.test.ts

@@ -33,6 +33,11 @@ const FIXTURES = {
       clientDataSetId: 12345n,
       pieceIds: [1n, 3n, 5n],
     },
+    deleteDataSet: {
+      extraData:
+        '0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000004182d85f7517c3ebcf68b9ebe200a46627d451219a3a71a95ea7ffce1cd661cc6d553db47958d27c33ccf1105388e1b640cf575a966b0bd4814ed0ec428daa628a1b00000000000000000000000000000000000000000000000000000000000000' as Hex,
+      dataSetId: 67890n,
+    },
   },
 }
 
@@ -127,6 +132,18 @@ describe('Typed Data', () => {
     )
   })
 
+  it('should sign delete data set', async () => {
+    const extraDataActual = await TypedData.signDeleteDataSet(client, {
+      dataSetId: FIXTURES.signatures.deleteDataSet.dataSetId,
+    })
+
+    assert.strictEqual(
+      extraDataActual,
+      FIXTURES.signatures.deleteDataSet.extraData,
+      'DeleteDataSet extraData should match Solidity reference'
+    )
+  })
+
   it('should sign create data set and add pieces', async () => {
     const extraDataActual = await TypedData.signCreateDataSetAndAddPieces(client, {
       clientDataSetId: FIXTURES.signatures.createDataSet.clientDataSetId,