Update write instruction in JS client

Author: lorisleiva

clients/js/src/createMetadata.ts

@@ -132,6 +132,7 @@ export function getCreateMetadataInstructionPlanUsingBuffer(
       getWriteInstructionPlan({
         buffer: input.metadata,
         authority: input.authority,
+        offset,
         data: input.data.slice(offset, offset + input.chunkSize),
         priorityFees: input.priorityFees,
       })

clients/js/src/generated/instructions/write.ts

@@ -12,6 +12,8 @@ import {
   getBytesEncoder,
   getStructDecoder,
   getStructEncoder,
+  getU32Decoder,
+  getU32Encoder,
   getU8Decoder,
   getU8Encoder,
   transformEncoder,
@@ -60,15 +62,22 @@ export type WriteInstruction<
 
 export type WriteInstructionData = {
   discriminator: number;
+  /** The offset to write to. */
+  offset: number;
   data: ReadonlyUint8Array;
 };
 
-export type WriteInstructionDataArgs = { data: ReadonlyUint8Array };
+export type WriteInstructionDataArgs = {
+  /** The offset to write to. */
+  offset: number;
+  data: ReadonlyUint8Array;
+};
 
 export function getWriteInstructionDataEncoder(): Encoder<WriteInstructionDataArgs> {
   return transformEncoder(
     getStructEncoder([
       ['discriminator', getU8Encoder()],
+      ['offset', getU32Encoder()],
       ['data', getBytesEncoder()],
     ]),
     (value) => ({ ...value, discriminator: WRITE_DISCRIMINATOR })
@@ -78,6 +87,7 @@ export function getWriteInstructionDataEncoder(): Encoder<WriteInstructionDataAr
 export function getWriteInstructionDataDecoder(): Decoder<WriteInstructionData> {
   return getStructDecoder([
     ['discriminator', getU8Decoder()],
+    ['offset', getU32Decoder()],
     ['data', getBytesDecoder()],
   ]);
 }
@@ -100,6 +110,7 @@ export type WriteInput<
   buffer: Address<TAccountBuffer>;
   /** The authority of the buffer. */
   authority: TransactionSigner<TAccountAuthority>;
+  offset: WriteInstructionDataArgs['offset'];
   data: WriteInstructionDataArgs['data'];
 };
 

clients/js/src/internals.ts

@@ -162,7 +162,11 @@ export function calculateMaxChunkSize(
     priorityFees?: MicroLamports;
   }
 ) {
-  const plan = getWriteInstructionPlan({ ...input, data: new Uint8Array(0) });
+  const plan = getWriteInstructionPlan({
+    ...input,
+    offset: 0,
+    data: new Uint8Array(0),
+  });
   const message = getTransactionMessageFromPlan(defaultMessage, plan);
   return getRemainingTransactionSpaceFromMessage(message);
 }
@@ -193,6 +197,7 @@ function getTransactionSizeFromMessage(
 export function getWriteInstructionPlan(input: {
   buffer: Address;
   authority: TransactionSigner;
+  offset: number;
   data: ReadonlyUint8Array;
   priorityFees?: MicroLamports;
 }): MessageInstructionPlan {
@@ -203,7 +208,7 @@ export function getWriteInstructionPlan(input: {
         computeUnitPrice: input.priorityFees,
         computeUnitLimit: 'simulated',
       }),
-      getWriteInstruction(input),
+      getWriteInstruction({ ...input }),
     ],
   };
 }

clients/js/src/updateMetadata.ts

@@ -209,6 +209,7 @@ export function getUpdateMetadataInstructionPlanUsingBuffer(
       getWriteInstructionPlan({
         buffer: input.buffer.address,
         authority: input.buffer,
+        offset,
         data: input.data.slice(offset, offset + input.chunkSize),
         priorityFees: input.priorityFees,
       })

clients/js/test/_setup.ts

@@ -220,7 +220,9 @@ export async function createBuffer(
   });
   const instructions: IInstruction[] = [preFundIx, allocateIx];
   if (data) {
-    instructions.push(getWriteInstruction({ buffer, authority, data }));
+    instructions.push(
+      getWriteInstruction({ buffer, authority, offset: 0, data })
+    );
   }
   await pipe(
     defaultTransaction,

clients/js/test/write.test.ts

@@ -41,7 +41,7 @@ test('it writes to canonical PDA buffers', async (t) => {
   });
 
   // When we write some data to the buffer account.
-  const writeIx = getWriteInstruction({ buffer, authority, data });
+  const writeIx = getWriteInstruction({ buffer, authority, offset: 0, data });
   await pipe(
     await createDefaultTransaction(client, authority),
     (tx) => appendTransactionMessageInstruction(writeIx, tx),
@@ -74,7 +74,7 @@ test('it writes to non-canonical PDA buffers', async (t) => {
   });
 
   // When we write some data to the buffer account.
-  const writeIx = getWriteInstruction({ buffer, authority, data });
+  const writeIx = getWriteInstruction({ buffer, authority, offset: 0, data });
   await pipe(
     await createDefaultTransaction(client, authority),
     (tx) => appendTransactionMessageInstruction(writeIx, tx),
@@ -106,6 +106,7 @@ test('it writes to keypair buffers', async (t) => {
   const writeIx = getWriteInstruction({
     buffer: buffer.address,
     authority: buffer,
+    offset: 0,
     data,
   });
   await pipe(
@@ -139,11 +140,13 @@ test('it appends to the end of buffers when doing multiple writes', async (t) =>
   const firstWriteIx = getWriteInstruction({
     buffer: buffer.address,
     authority: buffer,
+    offset: 0,
     data: dataChunk1,
   });
   const secondWriteIx = getWriteInstruction({
     buffer: buffer.address,
     authority: buffer,
+    offset: dataChunk1.length,
     data: dataChunk2,
   });
   await pipe(

program/idl.json

@@ -326,6 +326,16 @@
             "defaultValueStrategy": "omitted",
             "defaultValue": { "kind": "numberValueNode", "number": 0 }
           },
+          {
+            "kind": "instructionArgumentNode",
+            "name": "offset",
+            "docs": ["The offset to write to."],
+            "type": {
+              "kind": "numberTypeNode",
+              "format": "u32",
+              "endian": "le"
+            }
+          },
           {
             "kind": "instructionArgumentNode",
             "name": "data",