fix: use bigint in PDP auth, clientDataSetId now needs to be large

Author: rvagg

packages/synapse-sdk/src/pdp/auth.ts

@@ -204,7 +204,7 @@ export class PDPAuthHelper {
    * ```
    */
   async signCreateDataSet(
-    clientDataSetId: number | bigint,
+    clientDataSetId: bigint,
     payee: string,
     metadata: MetadataEntry[] = []
   ): Promise<AuthSignature> {
@@ -226,7 +226,7 @@ export class PDPAuthHelper {
     } else {
       // Use standard ethers.js signing (for private keys, etc)
       const value = {
-        clientDataSetId: BigInt(clientDataSetId),
+        clientDataSetId,
         metadata,
         payee,
       }
@@ -241,7 +241,7 @@ export class PDPAuthHelper {
 
     // For EIP-712, signedData contains the actual message hash that was signed
     const signedData = ethers.TypedDataEncoder.hash(this.domain, types, {
-      clientDataSetId: BigInt(clientDataSetId),
+      clientDataSetId,
       metadata,
       payee,
     })
@@ -282,8 +282,8 @@ export class PDPAuthHelper {
    * ```
    */
   async signAddPieces(
-    clientDataSetId: number | bigint,
-    firstPieceId: number | bigint,
+    clientDataSetId: bigint,
+    firstPieceId: bigint,
     pieceDataArray: PieceCID[] | string[],
     metadata: MetadataEntry[][] = []
   ): Promise<AuthSignature> {
@@ -341,8 +341,8 @@ export class PDPAuthHelper {
     } else {
       // Use standard ethers.js signing with bigint values
       const value = {
-        clientDataSetId: BigInt(clientDataSetId),
-        firstAdded: BigInt(firstPieceId),
+        clientDataSetId,
+        firstAdded: firstPieceId,
         pieceData: formattedPieceData,
         pieceMetadata: pieceMetadata,
       }
@@ -357,8 +357,8 @@ export class PDPAuthHelper {
 
     // For EIP-712, signedData contains the actual message hash that was signed
     const signedData = ethers.TypedDataEncoder.hash(this.domain, types, {
-      clientDataSetId: BigInt(clientDataSetId),
-      firstAdded: BigInt(firstPieceId),
+      clientDataSetId,
+      firstAdded: firstPieceId,
       pieceData: formattedPieceData,
       pieceMetadata: pieceMetadata,
     })
@@ -392,13 +392,7 @@ export class PDPAuthHelper {
    * )
    * ```
    */
-  async signSchedulePieceRemovals(
-    clientDataSetId: number | bigint,
-    pieceIds: Array<number | bigint>
-  ): Promise<AuthSignature> {
-    // Convert pieceIds to BigInt array for proper encoding
-    const pieceIdsBigInt = pieceIds.map((id) => BigInt(id))
-
+  async signSchedulePieceRemovals(clientDataSetId: bigint, pieceIds: Array<bigint>): Promise<AuthSignature> {
     let signature: string
 
     // Check if we should use MetaMask-friendly signing
@@ -408,16 +402,13 @@ export class PDPAuthHelper {
       // Use MetaMask-friendly signing for better UX
       const value = {
         clientDataSetId: clientDataSetId.toString(), // Keep as string for MetaMask display
-        pieceIds: pieceIdsBigInt.map((id) => id.toString()), // Convert to string array for display
+        pieceIds: pieceIds.map((id) => id.toString()), // Convert to string array for display
       }
 
       signature = await this.signWithMetaMask({ SchedulePieceRemovals: EIP712_TYPES.SchedulePieceRemovals }, value)
     } else {
       // Use standard ethers.js signing with BigInt values
-      const value = {
-        clientDataSetId: BigInt(clientDataSetId),
-        pieceIds: pieceIdsBigInt,
-      }
+      const value = { clientDataSetId, pieceIds }
 
       // Use underlying signer for typed data signing (handles NonceManager)
       const actualSigner = this.getUnderlyingSigner()
@@ -434,10 +425,7 @@ export class PDPAuthHelper {
     const signedData = ethers.TypedDataEncoder.hash(
       this.domain,
       { SchedulePieceRemovals: EIP712_TYPES.SchedulePieceRemovals },
-      {
-        clientDataSetId: BigInt(clientDataSetId),
-        pieceIds: pieceIdsBigInt,
-      }
+      { clientDataSetId, pieceIds }
     )
 
     return {
@@ -467,7 +455,7 @@ export class PDPAuthHelper {
    * )
    * ```
    */
-  async signDeleteDataSet(clientDataSetId: number | bigint): Promise<AuthSignature> {
+  async signDeleteDataSet(clientDataSetId: bigint): Promise<AuthSignature> {
     let signature: string
 
     // Check if we should use MetaMask-friendly signing
@@ -482,9 +470,7 @@ export class PDPAuthHelper {
       signature = await this.signWithMetaMask({ DeleteDataSet: EIP712_TYPES.DeleteDataSet }, value)
     } else {
       // Use standard ethers.js signing
-      const value = {
-        clientDataSetId: BigInt(clientDataSetId),
-      }
+      const value = { clientDataSetId }
 
       // Use underlying signer for typed data signing (handles NonceManager)
       const actualSigner = this.getUnderlyingSigner()
@@ -497,9 +483,7 @@ export class PDPAuthHelper {
     const signedData = ethers.TypedDataEncoder.hash(
       this.domain,
       { DeleteDataSet: EIP712_TYPES.DeleteDataSet },
-      {
-        clientDataSetId: BigInt(clientDataSetId),
-      }
+      { clientDataSetId }
     )
 
     return {

packages/synapse-sdk/src/pdp/server.ts

@@ -182,7 +182,7 @@ export class PDPServer {
    * @returns Promise that resolves with transaction hash and status URL
    */
   async createDataSet(
-    clientDataSetId: number | bigint,
+    clientDataSetId: bigint,
     payee: string,
     payer: string,
     metadata: MetadataEntry[],
@@ -264,7 +264,7 @@ export class PDPServer {
    */
   async addPieces(
     dataSetId: number,
-    clientDataSetId: number,
+    clientDataSetId: bigint,
     nextPieceId: number,
     pieceDataArray: PieceCID[] | string[],
     metadata?: MetadataEntry[][]
@@ -305,7 +305,7 @@ export class PDPServer {
     // Generate the EIP-712 signature for adding pieces
     const authData = await this.getAuthHelper().signAddPieces(
       clientDataSetId,
-      nextPieceId,
+      BigInt(nextPieceId),
       pieceDataArray, // Pass PieceData[] directly to auth helper
       finalMetadata
     )
@@ -644,8 +644,8 @@ export class PDPServer {
    * @param pieceID -  The ID of the piece to delete
    * @returns Promise for transaction hash of the delete operation
    */
-  async deletePiece(dataSetId: number, clientDataSetId: number, pieceID: number): Promise<string> {
-    const authData = await this.getAuthHelper().signSchedulePieceRemovals(clientDataSetId, [pieceID])
+  async deletePiece(dataSetId: number, clientDataSetId: bigint, pieceID: number): Promise<string> {
+    const authData = await this.getAuthHelper().signSchedulePieceRemovals(clientDataSetId, [BigInt(pieceID)])
     const payload = {
       extraData: `0x${authData.signature}`,
     }
@@ -672,7 +672,7 @@ export class PDPServer {
    */
   private _encodeDataSetCreateData(data: {
     payer: string
-    clientDataSetId: number | bigint
+    clientDataSetId: bigint
     metadata: MetadataEntry[]
     signature: string
   }): string {

packages/synapse-sdk/src/test/metadata.test.ts

@@ -64,7 +64,7 @@ describe('Metadata Support', () => {
       )
 
       const result = await pdpServer.createDataSet(
-        1,
+        1n,
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payee
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payer
         dataSetMetadata,
@@ -103,7 +103,7 @@ describe('Metadata Support', () => {
       )
 
       // Test with matching metadata
-      const result = await pdpServer.addPieces(dataSetId, 1, 1, pieces, metadata)
+      const result = await pdpServer.addPieces(dataSetId, 1n, 1, pieces, metadata)
       assert.equal(result.txHash, mockTxHash)
       assert.exists(capturedPieceMetadata)
       assert.isNotNull(capturedPieceMetadata)
@@ -117,15 +117,15 @@ describe('Metadata Support', () => {
       ]
 
       try {
-        await pdpServer.addPieces(dataSetId, 1, 1, pieces, mismatchedMetadata)
+        await pdpServer.addPieces(dataSetId, 1n, 1, pieces, mismatchedMetadata)
         assert.fail('Should have thrown an error')
       } catch (error: any) {
         assert.match(error.message, /Metadata length \(2\) must match pieces length \(1\)/)
       }
 
       // Test without metadata (should create empty arrays)
       capturedPieceMetadata = null
-      const resultNoMetadata = await pdpServer.addPieces(dataSetId, 1, 1, pieces)
+      const resultNoMetadata = await pdpServer.addPieces(dataSetId, 1n, 1, pieces)
       assert.equal(resultNoMetadata.txHash, mockTxHash)
       assert.exists(capturedPieceMetadata)
       assert.isNotNull(capturedPieceMetadata)
@@ -156,7 +156,7 @@ describe('Metadata Support', () => {
       ]
 
       await pdpServer.createDataSet(
-        1,
+        1n,
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payee
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payer
         metadataWithCDN,
@@ -171,7 +171,7 @@ describe('Metadata Support', () => {
       const metadataWithoutCDN: MetadataEntry[] = [{ key: 'project', value: 'test' }]
 
       await pdpServer.createDataSet(
-        1,
+        1n,
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payee
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payer
         metadataWithoutCDN,

packages/synapse-sdk/src/test/pdp-auth.test.ts

@@ -36,16 +36,16 @@ const FIXTURES = {
       signature:
         '0xc77965e2b6efd594629c44eb61127bc3133b65d08c25f8aa33e3021e7f46435845ab67ffbac96afc4b4671ecbd32d4869ca7fe1c0eaa5affa942d0abbfd98d601b',
       digest: '0xd89be6a725302e66575d7a9c730191a84e2a624d0f0f3976194d0bd6f2927640',
-      clientDataSetId: 12345,
+      clientDataSetId: 12345n,
       payee: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
       metadata: [{ key: 'title', value: 'TestDataSet' }],
     },
     addPieces: {
       signature:
         '0x215d2d6ea06c7daad46e3e636b305885c7d09aa34420e8dbace032af03cae06224cf678da808c7f1026b08ccf51f3d5d53351b935f5eee9750b80e78caffaaa91c',
       digest: '0xa690b5f3c6400833822aa3fd63ad1f0e4c1f70e5cc132cfd898c2993169d23bf',
-      clientDataSetId: 12345,
-      firstAdded: 1,
+      clientDataSetId: 12345n,
+      firstAdded: 1n,
       pieceCidBytes: [
         '0x01559120220500de6815dcb348843215a94de532954b60be550a4bec6e74555665e9a5ec4e0f3c',
         '0x01559120227e03642a607ef886b004bf2c1978463ae1d4693ac0f410eb2d1b7a47fe205e5e750f',
@@ -56,14 +56,14 @@ const FIXTURES = {
       signature:
         '0xcb8e645f2894fde89de54d4a54eb1e0d9871901c6fa1c2ee8a0390dc3a29e6cb2244d0561e3eca6452fa59efaab3d4b18a0b5b59ab52e233b3469422556ae9c61c',
       digest: '0xef55929f8dd724ef4b43c5759db26878608f7e1277d168e3e621d3cd4ba682dd',
-      clientDataSetId: 12345,
-      pieceIds: [1, 3, 5],
+      clientDataSetId: 12345n,
+      pieceIds: [1n, 3n, 5n],
     },
     deleteDataSet: {
       signature:
         '0x94e366bd2f9bfc933a87575126715bccf128b77d9c6937e194023e13b54272eb7a74b7e6e26acf4341d9c56e141ff7ba154c37ea03e9c35b126fff1efe1a0c831c',
       digest: '0x79df79ba922d913eccb0f9a91564ba3a1a81a0ea81d99a7cecf23cc3f425cafb',
-      clientDataSetId: 12345,
+      clientDataSetId: 12345n,
     },
   },
 }

packages/synapse-sdk/src/test/pdp-server.test.ts

@@ -83,7 +83,7 @@ describe('PDPServer', () => {
       )
 
       const result = await pdpServer.createDataSet(
-        0, // clientDataSetId
+        0n, // clientDataSetId
         '0x70997970C51812dc3A010C7d01b50e0d17dc79C8', // payee
         await signer.getAddress(), // payer
         [], // metadata (empty for no CDN)
@@ -193,7 +193,7 @@ describe('PDPServer', () => {
     it('should validate input parameters', async () => {
       // Test empty piece entries
       try {
-        await pdpServer.addPieces(1, 0, 0, [])
+        await pdpServer.addPieces(1, 0n, 0, [])
         assert.fail('Should have thrown error for empty piece entries')
       } catch (error) {
         assert.include((error as Error).message, 'At least one piece must be provided')
@@ -203,7 +203,7 @@ describe('PDPServer', () => {
       const invalidPieceCid = 'invalid-piece-link-string'
 
       try {
-        await pdpServer.addPieces(1, 0, 0, [invalidPieceCid])
+        await pdpServer.addPieces(1, 0n, 0, [invalidPieceCid])
         assert.fail('Should have thrown error for invalid PieceCID')
       } catch (error) {
         assert.include((error as Error).message, 'Invalid PieceCID')
@@ -238,7 +238,7 @@ describe('PDPServer', () => {
       )
 
       // Should not throw
-      const result = await pdpServer.addPieces(1, 0, 0, validPieceCid)
+      const result = await pdpServer.addPieces(1, 0n, 0, validPieceCid)
       assert.isDefined(result)
       assert.isDefined(result.message)
     })
@@ -256,7 +256,7 @@ describe('PDPServer', () => {
       )
 
       try {
-        await pdpServer.addPieces(1, 0, 0, validPieceCid)
+        await pdpServer.addPieces(1, 0n, 0, validPieceCid)
         assert.fail('Should have thrown error for server error')
       } catch (error) {
         assert.include(
@@ -302,7 +302,7 @@ describe('PDPServer', () => {
           }
         )
       )
-      const result = await pdpServer.addPieces(1, 0, 0, multiplePieceCid)
+      const result = await pdpServer.addPieces(1, 0n, 0, multiplePieceCid)
       assert.isDefined(result)
       assert.isDefined(result.message)
     })
@@ -322,7 +322,7 @@ describe('PDPServer', () => {
         })
       )
 
-      const result = await pdpServer.addPieces(1, 0, 0, validPieceCid)
+      const result = await pdpServer.addPieces(1, 0n, 0, validPieceCid)
       assert.isDefined(result)
       assert.isDefined(result.message)
       assert.strictEqual(result.txHash, mockTxHash)
@@ -346,7 +346,7 @@ describe('PDPServer', () => {
         })
       )
 
-      const result = await pdpServer.addPieces(1, 0, 0, validPieceCid)
+      const result = await pdpServer.addPieces(1, 0n, 0, validPieceCid)
       assert.isDefined(result)
       assert.strictEqual(result.txHash, mockTxHashWith0x) // Should have 0x prefix added
     })
@@ -365,7 +365,7 @@ describe('PDPServer', () => {
         })
       )
 
-      const result = await pdpServer.addPieces(1, 0, 0, validPieceCid)
+      const result = await pdpServer.addPieces(1, 0n, 0, validPieceCid)
       assert.isDefined(result)
       assert.isDefined(result.message)
       assert.isUndefined(result.txHash) // No txHash for malformed Location
@@ -389,7 +389,7 @@ describe('PDPServer', () => {
           })
         })
       )
-      const result = await pdpServer.deletePiece(1, 0, 2)
+      const result = await pdpServer.deletePiece(1, 0n, 2)
       assert.strictEqual(result, mockTxHash)
     })
 
@@ -402,7 +402,7 @@ describe('PDPServer', () => {
         })
       )
       try {
-        await pdpServer.deletePiece(1, 0, 2)
+        await pdpServer.deletePiece(1, 0n, 2)
         assert.fail('Should have thrown error for server error')
       } catch (error: any) {
         assert.include(error.message, 'Failed to delete piece')