@ethersphere/bee-js 6.6.0 → 6.7.0

package/dist/mjs/utils/expose.js

@@ -6,4 +6,4 @@ export { ethToSwarmAddress, fromLittleEndian, isHexEthAddress, makeEthAddress, m
 export { isNodeReadable, isReadable, isReadableStream, normalizeToReadableStream, readableNodeToWeb, readableWebToNode } from "./stream.js";
 export { keccak256Hash } from "./hash.js";
 export { makeMaxTarget } from "./pss.js";
-export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage } from "./stamps.js";
+export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampMaximumCapacityBytes, getStampEffectiveBytes, getStampTtlSeconds, getStampUsage } from "./stamps.js";

package/dist/mjs/utils/stamps.js

@@ -18,6 +18,39 @@ export function getStampUsage(utilization, depth, bucketDepth) {
 export function getStampMaximumCapacityBytes(depth) {
   return 2 ** depth * 4096;
 }
+/**
+ * Based on https://docs.ethswarm.org/docs/learn/technology/contracts/postage-stamp/#effective-utilisation-table
+ */
+const utilisationRateMap = {
+  22: 0.2867,
+  23: 0.4956,
+  24: 0.6433,
+  25: 0.7478,
+  26: 0.8217,
+  27: 0.8739,
+  28: 0.9108,
+  29: 0.9369,
+  30: 0.9554,
+  31: 0.9685,
+  32: 0.9777,
+  33: 0.9842,
+  34: 0.9889
+};
+/**
+ * Utility function that calculates the effective volume of a postage batch based on its depth.
+ *
+ * Below 22 depth the effective volume is 0
+ * Above 34 it's always > 99%
+ *
+ * @returns {number} The effective volume of the postage batch in bytes.
+ */
+export function getStampEffectiveBytes(depth) {
+  if (depth < 22) {
+    return 0;
+  }
+  const utilRate = utilisationRateMap[depth] ?? 0.99;
+  return getStampMaximumCapacityBytes(depth) * utilRate;
+}
 /**
  * Utility function that calculates the cost of a postage batch based on its depth and amount.
  *

package/dist/types/utils/expose.d.ts

@@ -6,4 +6,4 @@ export { EthAddress, ethToSwarmAddress, fromLittleEndian, isHexEthAddress, makeE
 export { isNodeReadable, isReadable, isReadableStream, normalizeToReadableStream, readableNodeToWeb, readableWebToNode, } from './stream';
 export { keccak256Hash } from './hash';
 export { makeMaxTarget } from './pss';
-export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage, } from './stamps';
+export { getAmountForTtl, getDepthForCapacity, getStampCostInBzz, getStampCostInPlur, getStampMaximumCapacityBytes, getStampEffectiveBytes, getStampTtlSeconds, getStampUsage, } from './stamps';

package/dist/types/utils/stamps.d.ts

@@ -15,6 +15,15 @@ export declare function getStampUsage(utilization: number, depth: number, bucket
  * @returns {number} The maximum capacity of the postage batch in bytes.
  */
 export declare function getStampMaximumCapacityBytes(depth: number): number;
+/**
+ * Utility function that calculates the effective volume of a postage batch based on its depth.
+ *
+ * Below 22 depth the effective volume is 0
+ * Above 34 it's always > 99%
+ *
+ * @returns {number} The effective volume of the postage batch in bytes.
+ */
+export declare function getStampEffectiveBytes(depth: number): number;
 /**
  * Utility function that calculates the cost of a postage batch based on its depth and amount.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethersphere/bee-js",
-  "version": "6.6.0",
+  "version": "6.7.0",
   "description": "Javascript client for Bee",
   "keywords": [
     "bee",