feat: add function for getting a specific global batch (#1196)

* feat: add function for getting a specific global batch

* fix: merge issue

---------

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

Author: slapec93

src/bee.ts

@@ -2522,6 +2522,21 @@ export class Bee {
     )
   }
 
+  /**
+   * Returns details for specific globally available postage batch.
+   *
+   * @param postageBatchId Batch ID
+   * @param requestOptions Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
+   */
+  async getGlobalPostageBatch(
+    postageBatchId: BatchId | Uint8Array | string,
+    requestOptions?: BeeRequestOptions,
+  ): Promise<GlobalPostageBatch> {
+    postageBatchId = new BatchId(postageBatchId)
+
+    return stamps.getGlobalPostageBatch(this.getRequestOptionsForCall(requestOptions), postageBatchId)
+  }
+
   /**
    * Return detailed information related to buckets for specific postage batch.
    *

src/modules/debug/stamps.ts

@@ -11,9 +11,11 @@ import {
   BatchIdResponse,
   GetAllPostageBatchesResponse,
   GetGlobalPostageBatchesResponse,
+  GetGlobalPostageBatchResponse,
   GetPostageBatchBucketsResponse,
   GetPostageBatchResponse,
 } from '../../types/schema/stamps'
+
 import { http } from '../../utils/http'
 import { mapPostageBatch } from '../../utils/stamps'
 import { BatchId } from '../../utils/typed-bytes'
@@ -31,6 +33,19 @@ export async function getGlobalPostageBatches(requestOptions: BeeRequestOptions)
   return GetGlobalPostageBatchesResponse.parse(response.data).batches
 }
 
+export async function getGlobalPostageBatch(
+  requestOptions: BeeRequestOptions,
+  postageBatchId: BatchId,
+): Promise<GlobalPostageBatch> {
+  const response = await http<unknown>(requestOptions, {
+    method: 'get',
+    url: `${BATCHES_ENDPOINT}/${postageBatchId}`,
+    responseType: 'json',
+  })
+
+  return GetGlobalPostageBatchResponse.parse(response.data)
+}
+
 export async function getAllPostageBatches(requestOptions: BeeRequestOptions): Promise<PostageBatch[]> {
   const response = await http<unknown>(requestOptions, {
     method: 'get',

src/types/schema.ts

@@ -15,19 +15,19 @@ export const RawPostageBatchSchema = z.object({
   batchTTL: z.number(),
 })
 
+export const GetGlobalPostageBatchResponse = z.object({
+  batchID: z.string().transform(s => new BatchId(s)),
+  batchTTL: z.number(),
+  bucketDepth: z.number(),
+  depth: z.number(),
+  immutable: z.boolean(),
+  owner: z.string().transform(s => new EthAddress(s)),
+  start: z.number(),
+  value: z.string().transform(s => asNumberString(s, { name: 'value' })),
+})
+
 export const GetGlobalPostageBatchesResponse = z.object({
-  batches: z.array(
-    z.object({
-      batchID: z.string().transform(s => new BatchId(s)),
-      batchTTL: z.number(),
-      bucketDepth: z.number(),
-      depth: z.number(),
-      immutable: z.boolean(),
-      owner: z.string().transform(s => new EthAddress(s)),
-      start: z.number(),
-      value: z.string().transform(s => asNumberString(s, { name: 'value' })),
-    }),
-  ),
+  batches: z.array(GetGlobalPostageBatchResponse),
 })
 
 export const GetAllPostageBatchesResponse = z.object({

src/types/schema/stamps.ts

@@ -20,6 +20,14 @@ test('GET batches', async () => {
   expect(batches.length).toBeGreaterThan(0)
 })
 
+test('GET batch', async () => {
+  const batches = await bee.getGlobalPostageBatches()
+  expect(batches.length).toBeGreaterThan(0)
+
+  const batch = await bee.getGlobalPostageBatch(batches[0].batchID)
+  expect(Objects.deepEquals(batch, batches[0])).toBeTruthy()
+})
+
 test('POST stamps', async () => {
   const response = await bee.createPostageBatch('1098006401', 17, { waitForUsable: true })
   expect(response.toHex()).toHaveLength(64)