feat: add utils function to map postage batch (#1130)

* feat: add utils function to map postage batch

* feat: add unmap function for symmetry

* test: update test coverage

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: Cafe137

src/index.ts

@@ -3,8 +3,8 @@ import { BeeDev } from './bee-dev'
 import { Stamper } from './stamper/stamper'
 
 export { MerkleTree } from 'cafe-utility'
-export { Chunk } from './chunk/cac'
-export { SingleOwnerChunk } from './chunk/soc'
+export type { Chunk } from './chunk/cac'
+export type { SingleOwnerChunk } from './chunk/soc'
 export { MantarayNode } from './manifest/manifest'
 export { SUPPORTED_BEE_VERSION, SUPPORTED_BEE_VERSION_EXACT } from './modules/debug/status'
 export * from './types'

src/modules/debug/stamps.ts

@@ -8,13 +8,10 @@ import type {
   PostageBatchOptions,
   RedundancyLevel,
 } from '../../types'
-import { Duration } from '../../utils/duration'
 import { http } from '../../utils/http'
-import { Size } from '../../utils/size'
-import { getStampEffectiveBytes, getStampTheoreticalBytes, getStampUsage } from '../../utils/stamps'
+import { mapPostageBatch, RawPostageBatch } from '../../utils/stamps'
 import { asNumberString } from '../../utils/type'
 import { BatchId, EthAddress } from '../../utils/typed-bytes'
-import { normalizeBatchTTL } from '../../utils/workaround'
 
 const STAMPS_ENDPOINT = 'stamps'
 const BATCHES_ENDPOINT = 'batches'
@@ -51,44 +48,7 @@ export async function getAllPostageBatches(requestOptions: BeeRequestOptions): P
   const body = Types.asObject(response.data, { name: 'response.data' })
   const stamps = Types.asArray(body.stamps, { name: 'stamps' }).map(x => Types.asObject(x, { name: 'stamp' }))
 
-  return stamps.map(x => {
-    const utilization = Types.asNumber(x.utilization, { name: 'utilization' })
-    const depth = Types.asNumber(x.depth, { name: 'depth' })
-    const bucketDepth = Types.asNumber(x.bucketDepth, { name: 'bucketDepth' })
-    const usage = getStampUsage(utilization, depth, bucketDepth)
-    const batchTTL = normalizeBatchTTL(Types.asNumber(x.batchTTL, { name: 'batchTTL' }))
-    const duration = Duration.fromSeconds(batchTTL)
-
-    const effectiveBytes = getStampEffectiveBytes(depth)
-
-    return {
-      batchID: new BatchId(Types.asString(x.batchID, { name: 'batchID' })),
-      utilization,
-      usable: Types.asBoolean(x.usable, { name: 'usable' }),
-      label: Types.asEmptiableString(x.label, { name: 'label' }),
-      depth,
-      amount: asNumberString(x.amount, { name: 'amount' }),
-      bucketDepth,
-      blockNumber: Types.asNumber(x.blockNumber, { name: 'blockNumber' }),
-      immutableFlag: Types.asBoolean(x.immutableFlag, { name: 'immutableFlag' }),
-      usage,
-      usageText: `${Math.round(usage * 100)}%`,
-      size: Size.fromBytes(effectiveBytes),
-      remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
-      theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(depth)),
-      duration,
-      calculateSize(encryption, redundancyLevel) {
-        const effectiveBytes = getStampEffectiveBytes(this.depth, encryption, redundancyLevel)
-
-        return Size.fromBytes(effectiveBytes)
-      },
-      calculateRemainingSize(encryption, redundancyLevel) {
-        const effectiveBytes = getStampEffectiveBytes(this.depth, encryption, redundancyLevel)
-
-        return Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)))
-      },
-    }
-  })
+  return stamps.map(x => mapPostageBatch(validateRawPostageBatch(x)))
 }
 
 export async function getPostageBatch(
@@ -105,42 +65,7 @@ export async function getPostageBatch(
 
   const body = Types.asObject(response.data, { name: 'response.data' })
 
-  const utilization = Types.asNumber(body.utilization, { name: 'utilization' })
-  const depth = Types.asNumber(body.depth, { name: 'depth' })
-  const bucketDepth = Types.asNumber(body.bucketDepth, { name: 'bucketDepth' })
-  const usage = getStampUsage(utilization, depth, bucketDepth)
-  const batchTTL = normalizeBatchTTL(Types.asNumber(body.batchTTL, { name: 'batchTTL' }))
-  const duration = Duration.fromSeconds(batchTTL)
-
-  const effectiveBytes = getStampEffectiveBytes(depth, encryption, erasureCodeLevel)
-
-  return {
-    batchID: new BatchId(Types.asString(body.batchID, { name: 'batchID' })),
-    utilization,
-    usable: Types.asBoolean(body.usable, { name: 'usable' }),
-    label: Types.asEmptiableString(body.label, { name: 'label' }),
-    depth,
-    amount: asNumberString(body.amount, { name: 'amount' }),
-    bucketDepth,
-    blockNumber: Types.asNumber(body.blockNumber, { name: 'blockNumber' }),
-    immutableFlag: Types.asBoolean(body.immutableFlag, { name: 'immutableFlag' }),
-    usage,
-    usageText: `${Math.round(usage * 100)}%`,
-    size: Size.fromBytes(effectiveBytes),
-    remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
-    theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(depth)),
-    duration,
-    calculateSize(encryption, redundancyLevel) {
-      const effectiveBytes = getStampEffectiveBytes(depth, encryption, redundancyLevel)
-
-      return Size.fromBytes(effectiveBytes)
-    },
-    calculateRemainingSize(encryption, redundancyLevel) {
-      const effectiveBytes = getStampEffectiveBytes(depth, encryption, redundancyLevel)
-
-      return Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage)))
-    },
-  }
+  return mapPostageBatch(validateRawPostageBatch(body), encryption, erasureCodeLevel)
 }
 
 export async function getPostageBatchBuckets(
@@ -224,3 +149,18 @@ export async function diluteBatch(requestOptions: BeeRequestOptions, id: BatchId
 
   return new BatchId(Types.asString(body.batchID, { name: 'batchID' }))
 }
+
+function validateRawPostageBatch(raw: Record<string, unknown>): RawPostageBatch {
+  return {
+    amount: asNumberString(raw.amount, { name: 'amount' }),
+    batchID: Types.asString(raw.batchID, { name: 'batchID' }),
+    batchTTL: Types.asNumber(raw.batchTTL, { name: 'batchTTL' }),
+    bucketDepth: Types.asNumber(raw.bucketDepth, { name: 'bucketDepth' }),
+    blockNumber: Types.asNumber(raw.blockNumber, { name: 'blockNumber' }),
+    depth: Types.asNumber(raw.depth, { name: 'depth' }),
+    immutableFlag: Types.asBoolean(raw.immutableFlag, { name: 'immutableFlag' }),
+    label: Types.asEmptiableString(raw.label, { name: 'label' }),
+    usable: Types.asBoolean(raw.usable, { name: 'usable' }),
+    utilization: Types.asNumber(raw.utilization, { name: 'utilization' }),
+  }
+}

src/utils/expose.ts

@@ -11,4 +11,6 @@ export {
   getStampEffectiveBytesBreakpoints,
   getStampTheoreticalBytes,
   getStampUsage,
+  mapPostageBatch,
+  unmapPostageBatch,
 } from './stamps'

src/utils/stamps.ts

@@ -1,10 +1,12 @@
 import { Binary } from 'cafe-utility'
-import { capacityBreakpoints, EnvelopeWithBatchId, NumberString, RedundancyLevel } from '../types'
+import { capacityBreakpoints, EnvelopeWithBatchId, NumberString, PostageBatch, RedundancyLevel } from '../types'
 import { Bytes, parseSizeToBytes } from './bytes'
 import { Duration } from './duration'
 import { Size } from './size'
 import { BZZ } from './tokens'
 import { asNumberString } from './type'
+import { BatchId } from './typed-bytes'
+import { normalizeBatchTTL } from './workaround'
 
 const MAX_UTILIZATION = 0.9
 
@@ -200,3 +202,70 @@ export function marshalStamp(
 
   return new Bytes(Binary.concatBytes(batchId, index, timestamp, signature))
 }
+
+export interface RawPostageBatch {
+  batchID: string
+  utilization: number
+  usable: boolean
+  label: string
+  depth: number
+  amount: string
+  bucketDepth: number
+  blockNumber: number
+  immutableFlag: boolean
+  batchTTL: number
+}
+
+export function mapPostageBatch(
+  raw: RawPostageBatch,
+  encryption?: boolean,
+  erasureCodeLevel?: RedundancyLevel,
+): PostageBatch {
+  const usage = getStampUsage(raw.utilization, raw.depth, raw.bucketDepth)
+  const batchTTL = normalizeBatchTTL(raw.batchTTL)
+  const duration = Duration.fromSeconds(batchTTL)
+  const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, erasureCodeLevel)
+
+  return {
+    batchID: new BatchId(raw.batchID),
+    utilization: raw.utilization,
+    usable: raw.usable,
+    label: raw.label,
+    depth: raw.depth,
+    amount: asNumberString(raw.amount),
+    bucketDepth: raw.bucketDepth,
+    blockNumber: raw.blockNumber,
+    immutableFlag: raw.immutableFlag,
+    usage,
+    usageText: `${Math.round(usage * 100)}%`,
+    size: Size.fromBytes(effectiveBytes),
+    remainingSize: Size.fromBytes(Math.ceil(effectiveBytes * (1 - usage))),
+    theoreticalSize: Size.fromBytes(getStampTheoreticalBytes(raw.depth)),
+    duration,
+    calculateSize(encryption, redundancyLevel) {
+      const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, redundancyLevel)
+
+      return Size.fromBytes(effectiveBytes)
+    },
+    calculateRemainingSize(encryption, redundancyLevel) {
+      const effectiveBytes = getStampEffectiveBytes(raw.depth, encryption, redundancyLevel)
+
+      return Size.fromBytes(Math.ceil(effectiveBytes * (1 - this.usage)))
+    },
+  }
+}
+
+export function unmapPostageBatch(batch: PostageBatch): RawPostageBatch {
+  return {
+    batchID: batch.batchID.toHex(),
+    utilization: batch.utilization,
+    usable: batch.usable,
+    label: batch.label,
+    depth: batch.depth,
+    amount: batch.amount,
+    bucketDepth: batch.bucketDepth,
+    blockNumber: batch.blockNumber,
+    immutableFlag: batch.immutableFlag,
+    batchTTL: batch.duration.toSeconds(),
+  }
+}

test/coverage/coverage-summary.json

@@ -1,4 +1,4 @@
-{"total": {"lines":{"total":2494,"covered":2045,"skipped":0,"pct":81.99},"statements":{"total":2538,"covered":2085,"skipped":0,"pct":82.15},"functions":{"total":608,"covered":484,"skipped":0,"pct":79.6},"branches":{"total":578,"covered":374,"skipped":0,"pct":64.7},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
+{"total": {"lines":{"total":2486,"covered":2040,"skipped":0,"pct":82.05},"statements":{"total":2531,"covered":2081,"skipped":0,"pct":82.22},"functions":{"total":611,"covered":486,"skipped":0,"pct":79.54},"branches":{"total":578,"covered":374,"skipped":0,"pct":64.7},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/bee-dev.ts": {"lines":{"total":14,"covered":5,"skipped":0,"pct":35.71},"functions":{"total":2,"covered":0,"skipped":0,"pct":0},"statements":{"total":14,"covered":5,"skipped":0,"pct":35.71},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/bee.ts": {"lines":{"total":453,"covered":377,"skipped":0,"pct":83.22},"functions":{"total":132,"covered":108,"skipped":0,"pct":81.81},"statements":{"total":456,"covered":380,"skipped":0,"pct":83.33},"branches":{"total":123,"covered":75,"skipped":0,"pct":60.97}}
 ,"/home/runner/work/bee-js/bee-js/src/index.ts": {"lines":{"total":16,"covered":16,"skipped":0,"pct":100},"functions":{"total":10,"covered":7,"skipped":0,"pct":70},"statements":{"total":25,"covered":25,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
@@ -28,7 +28,7 @@
 ,"/home/runner/work/bee-js/bee-js/src/modules/debug/connectivity.ts": {"lines":{"total":35,"covered":28,"skipped":0,"pct":80},"functions":{"total":11,"covered":7,"skipped":0,"pct":63.63},"statements":{"total":36,"covered":29,"skipped":0,"pct":80.55},"branches":{"total":2,"covered":2,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/modules/debug/settlements.ts": {"lines":{"total":18,"covered":18,"skipped":0,"pct":100},"functions":{"total":4,"covered":4,"skipped":0,"pct":100},"statements":{"total":18,"covered":18,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/modules/debug/stake.ts": {"lines":{"total":32,"covered":21,"skipped":0,"pct":65.62},"functions":{"total":6,"covered":3,"skipped":0,"pct":50},"statements":{"total":32,"covered":21,"skipped":0,"pct":65.62},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
-,"/home/runner/work/bee-js/bee-js/src/modules/debug/stamps.ts": {"lines":{"total":70,"covered":60,"skipped":0,"pct":85.71},"functions":{"total":17,"covered":13,"skipped":0,"pct":76.47},"statements":{"total":73,"covered":63,"skipped":0,"pct":86.3},"branches":{"total":2,"covered":0,"skipped":0,"pct":0}}
+,"/home/runner/work/bee-js/bee-js/src/modules/debug/stamps.ts": {"lines":{"total":45,"covered":43,"skipped":0,"pct":95.55},"functions":{"total":14,"covered":14,"skipped":0,"pct":100},"statements":{"total":49,"covered":47,"skipped":0,"pct":95.91},"branches":{"total":2,"covered":0,"skipped":0,"pct":0}}
 ,"/home/runner/work/bee-js/bee-js/src/modules/debug/states.ts": {"lines":{"total":29,"covered":24,"skipped":0,"pct":82.75},"functions":{"total":5,"covered":4,"skipped":0,"pct":80},"statements":{"total":29,"covered":24,"skipped":0,"pct":82.75},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/modules/debug/status.ts": {"lines":{"total":36,"covered":34,"skipped":0,"pct":94.44},"functions":{"total":7,"covered":6,"skipped":0,"pct":85.71},"statements":{"total":36,"covered":34,"skipped":0,"pct":94.44},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/modules/debug/transactions.ts": {"lines":{"total":27,"covered":18,"skipped":0,"pct":66.66},"functions":{"total":5,"covered":3,"skipped":0,"pct":60},"statements":{"total":27,"covered":18,"skipped":0,"pct":66.66},"branches":{"total":1,"covered":0,"skipped":0,"pct":0}}
@@ -48,7 +48,7 @@
 ,"/home/runner/work/bee-js/bee-js/src/utils/data.ts": {"lines":{"total":11,"covered":4,"skipped":0,"pct":36.36},"functions":{"total":3,"covered":1,"skipped":0,"pct":33.33},"statements":{"total":12,"covered":4,"skipped":0,"pct":33.33},"branches":{"total":7,"covered":1,"skipped":0,"pct":14.28}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/duration.ts": {"lines":{"total":22,"covered":20,"skipped":0,"pct":90.9},"functions":{"total":17,"covered":15,"skipped":0,"pct":88.23},"statements":{"total":22,"covered":20,"skipped":0,"pct":90.9},"branches":{"total":5,"covered":5,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/error.ts": {"lines":{"total":12,"covered":12,"skipped":0,"pct":100},"functions":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":12,"covered":12,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
-,"/home/runner/work/bee-js/bee-js/src/utils/expose.ts": {"lines":{"total":13,"covered":13,"skipped":0,"pct":100},"functions":{"total":15,"covered":14,"skipped":0,"pct":93.33},"statements":{"total":20,"covered":20,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
+,"/home/runner/work/bee-js/bee-js/src/utils/expose.ts": {"lines":{"total":15,"covered":15,"skipped":0,"pct":100},"functions":{"total":17,"covered":14,"skipped":0,"pct":82.35},"statements":{"total":22,"covered":22,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/file.ts": {"lines":{"total":12,"covered":8,"skipped":0,"pct":66.66},"functions":{"total":4,"covered":2,"skipped":0,"pct":50},"statements":{"total":13,"covered":8,"skipped":0,"pct":61.53},"branches":{"total":8,"covered":6,"skipped":0,"pct":75}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/headers.ts": {"lines":{"total":71,"covered":62,"skipped":0,"pct":87.32},"functions":{"total":5,"covered":5,"skipped":0,"pct":100},"statements":{"total":71,"covered":62,"skipped":0,"pct":87.32},"branches":{"total":39,"covered":31,"skipped":0,"pct":79.48}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/http.ts": {"lines":{"total":37,"covered":32,"skipped":0,"pct":86.48},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":37,"covered":32,"skipped":0,"pct":86.48},"branches":{"total":23,"covered":15,"skipped":0,"pct":65.21}}
@@ -57,7 +57,7 @@
 ,"/home/runner/work/bee-js/bee-js/src/utils/redundancy.ts": {"lines":{"total":44,"covered":32,"skipped":0,"pct":72.72},"functions":{"total":4,"covered":4,"skipped":0,"pct":100},"statements":{"total":45,"covered":33,"skipped":0,"pct":73.33},"branches":{"total":26,"covered":12,"skipped":0,"pct":46.15}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/resource-locator.ts": {"lines":{"total":7,"covered":7,"skipped":0,"pct":100},"functions":{"total":2,"covered":2,"skipped":0,"pct":100},"statements":{"total":7,"covered":7,"skipped":0,"pct":100},"branches":{"total":3,"covered":3,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/size.ts": {"lines":{"total":14,"covered":12,"skipped":0,"pct":85.71},"functions":{"total":10,"covered":9,"skipped":0,"pct":90},"statements":{"total":14,"covered":12,"skipped":0,"pct":85.71},"branches":{"total":1,"covered":0,"skipped":0,"pct":0}}
-,"/home/runner/work/bee-js/bee-js/src/utils/stamps.ts": {"lines":{"total":63,"covered":45,"skipped":0,"pct":71.42},"functions":{"total":13,"covered":11,"skipped":0,"pct":84.61},"statements":{"total":65,"covered":46,"skipped":0,"pct":70.76},"branches":{"total":22,"covered":8,"skipped":0,"pct":36.36}}
+,"/home/runner/work/bee-js/bee-js/src/utils/stamps.ts": {"lines":{"total":78,"covered":55,"skipped":0,"pct":70.51},"functions":{"total":17,"covered":12,"skipped":0,"pct":70.58},"statements":{"total":80,"covered":56,"skipped":0,"pct":70},"branches":{"total":22,"covered":8,"skipped":0,"pct":36.36}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/tar-uploader.browser.ts": {"lines":{"total":11,"covered":0,"skipped":0,"pct":0},"functions":{"total":1,"covered":0,"skipped":0,"pct":0},"statements":{"total":11,"covered":0,"skipped":0,"pct":0},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/tar-uploader.ts": {"lines":{"total":12,"covered":12,"skipped":0,"pct":100},"functions":{"total":1,"covered":1,"skipped":0,"pct":100},"statements":{"total":12,"covered":12,"skipped":0,"pct":100},"branches":{"total":0,"covered":0,"skipped":0,"pct":100}}
 ,"/home/runner/work/bee-js/bee-js/src/utils/tar-writer.browser.ts": {"lines":{"total":8,"covered":0,"skipped":0,"pct":0},"functions":{"total":1,"covered":0,"skipped":0,"pct":0},"statements":{"total":8,"covered":0,"skipped":0,"pct":0},"branches":{"total":2,"covered":0,"skipped":0,"pct":0}}