feat: add postage batch label update endpoint (#1193)

* feat: wip add stamp label update

* test: finish spec

* test: add specs for alias method

* test: fix test cases

---------

Co-authored-by: Gergely Békési <gergely.bekesi@ethswarm.org>

Author: slapec93

src/bee.ts

@@ -2076,9 +2076,9 @@ export class Bee {
    * to buying storage for a certain size and duration on the Swarm network.
    *
    * Use {@link getStorageCost} to calculate the cost of creating a postage batch.
-   * 
+   *
    * For the low level API, use {@link createPostageBatch}.
-   * 
+   *
    * @example const batchId = await bee.buyStorage(Size.fromGigabytes(8), Duration.fromDays(31))
 
    * @param size
@@ -2374,6 +2374,38 @@ export class Bee {
     return getStampCost(batch.depth, amount)
   }
 
+  /**
+   * Updates the label of a certain postage batch.
+   *
+   * @param postageBatchId Batch ID of the postage batch to update.
+   * @param label New label for the postage batch.
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   */
+  async updatePostageBatchLabel(
+    postageBatchId: BatchId | Uint8Array | string,
+    label: string,
+    requestOptions?: BeeRequestOptions,
+  ): Promise<void> {
+    postageBatchId = new BatchId(postageBatchId)
+
+    return stamps.updatePostageBatchLabel(this.getRequestOptionsForCall(requestOptions), postageBatchId, label)
+  }
+
+  /**
+   * Renames a storage. This is a convenience method that calls {@link updatePostageBatchLabel}.
+   *
+   * @param postageBatchId Batch ID of the postage batch to update.
+   * @param newName New name for the storage.
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   */
+  async renameStorage(
+    postageBatchId: BatchId | Uint8Array | string,
+    newLabel: string,
+    requestOptions?: BeeRequestOptions,
+  ): Promise<void> {
+    return this.updatePostageBatchLabel(postageBatchId, newLabel, requestOptions)
+  }
+
   /**
    * Calculates the `amount` and expected duration extension for topping up a postage batch with a given BZZ value.
    *

src/modules/debug/stamps.ts

@@ -122,6 +122,19 @@ export async function createPostageBatch(
   return new BatchId(Types.asString(body.batchID, { name: 'batchID' }))
 }
 
+export async function updatePostageBatchLabel(
+  requestOptions: BeeRequestOptions,
+  id: BatchId,
+  label: string,
+): Promise<void> {
+  await http<unknown>(requestOptions, {
+    method: 'patch',
+    url: `${STAMPS_ENDPOINT}/${id}`,
+    responseType: 'json',
+    data: { label },
+  })
+}
+
 export async function topUpBatch(
   requestOptions: BeeRequestOptions,
   id: BatchId,

test/integration/stamp.spec.ts

@@ -57,6 +57,24 @@ test('POST stamps rejections', async () => {
   await expect(bee.createPostageBatch('500000000', 256)).rejects.toThrow()
 })
 
+test('PATCH stamp label (updatePostageBatchLabel)', async () => {
+  const response = await bee.createPostageBatch('1098006401', 17, { waitForUsable: true })
+  expect(response.toHex()).toHaveLength(64)
+
+  const label = 'test-label'
+  await expect(bee.updatePostageBatchLabel(response, label)).resolves.not.toThrow()
+  await expect(bee.getPostageBatch(response)).resolves.toMatchObject({ label })
+})
+
+test('PATCH stamp label (renameStorage)', async () => {
+  const response = await bee.createPostageBatch('1098006401', 17, { waitForUsable: true })
+  expect(response.toHex()).toHaveLength(64)
+
+  const label = 'test-label'
+  await expect(bee.renameStorage(response, label)).resolves.not.toThrow()
+  await expect(bee.getPostageBatch(response)).resolves.toMatchObject({ label })
+})
+
 test('POST envelope', async () => {
   const data = Strings.randomAlphanumeric(40)
   const cac = makeContentAddressedChunk(data)