@ethersphere/bee-js 6.2.0 → 6.3.0

package/dist/mjs/utils/expose.js

@@ -1,9 +1,9 @@
 export { getCollectionSize } from "./collection.js";
 export { getFolderSize } from "./collection.node.js";
-export { isBytes, assertBytes, isFlexBytes, assertFlexBytes, bytesAtOffset, flexBytesAtOffset, bytesEqual } from "./bytes.js";
-export { makeHexString, hexToBytes, bytesToHex, intToHex, isHexString, assertHexString, assertPrefixedHexString } from "./hex.js";
-export { makeEthAddress, makeHexEthAddress, isHexEthAddress, ethToSwarmAddress, toLittleEndian, fromLittleEndian, makeEthereumWalletSigner } from "./eth.js";
-export { readableWebToNode, readableNodeToWeb, isReadableStream, isNodeReadable, normalizeToReadableStream, isReadable } from "./stream.js";
+export { assertBytes, assertFlexBytes, bytesAtOffset, bytesEqual, flexBytesAtOffset, isBytes, isFlexBytes } from "./bytes.js";
+export { assertHexString, assertPrefixedHexString, bytesToHex, hexToBytes, intToHex, isHexString, makeHexString } from "./hex.js";
+export { ethToSwarmAddress, fromLittleEndian, isHexEthAddress, makeEthAddress, makeEthereumWalletSigner, makeHexEthAddress, toLittleEndian } from "./eth.js";
+export { isNodeReadable, isReadable, isReadableStream, normalizeToReadableStream, readableNodeToWeb, readableWebToNode } from "./stream.js";
 export { keccak256Hash } from "./hash.js";
 export { makeMaxTarget } from "./pss.js";
-export { getStampUsage } from "./stamps.js";
+export { getStampCostInBzz, getStampCostInPlur, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage } from "./stamps.js";

package/dist/mjs/utils/stamps.js

@@ -1,17 +1,47 @@
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
  *
- * Be aware for small depths (17, 18) this does not provide that much information as the provided set of distinct values
- * is small.
+ * For smaller depths (up to 20), this may provide less accurate results.
  *
- * @param utilization
- * @param depth
- * @param bucketDepth
+ * @returns {number} A number between 0 and 1 representing the usage of the postage batch.
  */
-export function getStampUsage({
-  utilization,
-  depth,
-  bucketDepth
-}) {
+export function getStampUsage(utilization, depth, bucketDepth) {
   return utilization / Math.pow(2, depth - bucketDepth);
+}
+/**
+ * Utility function that calculates the theoritical maximum capacity of a postage batch based on its depth.
+ *
+ * For smaller depths (up to 20), this may provide less accurate results.
+ *
+ * @returns {number} The maximum capacity of the postage batch in bytes.
+ */
+export function getStampMaximumCapacityBytes(depth) {
+  return 2 ** depth * 4096;
+}
+/**
+ * Utility function that calculates the cost of a postage batch based on its depth and amount.
+ *
+ * @returns {number} The cost of the postage batch in PLUR (10000000000000000 [1e16] PLUR = 1 BZZ)
+ */
+export function getStampCostInPlur(depth, amount) {
+  return 2 ** depth * amount;
+}
+/**
+ * Utility function that calculates the cost of a postage batch based on its depth and amount.
+ *
+ * @returns {number} The cost of the postage batch in BZZ (1 BZZ = 10000000000000000 [1e16] PLUR)
+ */
+export function getStampCostInBzz(depth, amount) {
+  const BZZ_UNIT = 10 ** 16;
+  return getStampCostInPlur(depth, amount) / BZZ_UNIT;
+}
+/**
+ * Utility function that calculates the TTL of a postage batch based on its amount, price per block and block time.
+ *
+ * For more accurate results, get the price per block and block time from the Bee node or the blockchain.
+ *
+ * @returns {number} The TTL of the postage batch in seconds.
+ */
+export function getStampTtlSeconds(amount, pricePerBlock = 24000, blockTime = 5) {
+  return amount * blockTime / pricePerBlock;
 }

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

@@ -1,9 +1,9 @@
 export { getCollectionSize } from './collection';
 export { getFolderSize } from './collection.node';
-export { Bytes, FlexBytes, isBytes, assertBytes, isFlexBytes, assertFlexBytes, bytesAtOffset, flexBytesAtOffset, bytesEqual, } from './bytes';
-export { HexString, PrefixedHexString, makeHexString, hexToBytes, bytesToHex, intToHex, isHexString, assertHexString, assertPrefixedHexString, } from './hex';
-export { EthAddress, makeEthAddress, makeHexEthAddress, isHexEthAddress, ethToSwarmAddress, toLittleEndian, fromLittleEndian, makeEthereumWalletSigner, } from './eth';
-export { readableWebToNode, readableNodeToWeb, isReadableStream, isNodeReadable, normalizeToReadableStream, isReadable, } from './stream';
+export { Bytes, FlexBytes, assertBytes, assertFlexBytes, bytesAtOffset, bytesEqual, flexBytesAtOffset, isBytes, isFlexBytes, } from './bytes';
+export { HexString, PrefixedHexString, assertHexString, assertPrefixedHexString, bytesToHex, hexToBytes, intToHex, isHexString, makeHexString, } from './hex';
+export { EthAddress, ethToSwarmAddress, fromLittleEndian, isHexEthAddress, makeEthAddress, makeEthereumWalletSigner, makeHexEthAddress, toLittleEndian, } from './eth';
+export { isNodeReadable, isReadable, isReadableStream, normalizeToReadableStream, readableNodeToWeb, readableWebToNode, } from './stream';
 export { keccak256Hash } from './hash';
 export { makeMaxTarget } from './pss';
-export { getStampUsage } from './stamps';
+export { getStampCostInBzz, getStampCostInPlur, getStampMaximumCapacityBytes, getStampTtlSeconds, getStampUsage, } from './stamps';

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

@@ -1,12 +1,36 @@
-import { PostageBatch } from '../types';
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
  *
- * Be aware for small depths (17, 18) this does not provide that much information as the provided set of distinct values
- * is small.
+ * For smaller depths (up to 20), this may provide less accurate results.
  *
- * @param utilization
- * @param depth
- * @param bucketDepth
+ * @returns {number} A number between 0 and 1 representing the usage of the postage batch.
  */
-export declare function getStampUsage({ utilization, depth, bucketDepth }: PostageBatch): number;
+export declare function getStampUsage(utilization: number, depth: number, bucketDepth: number): number;
+/**
+ * Utility function that calculates the theoritical maximum capacity of a postage batch based on its depth.
+ *
+ * For smaller depths (up to 20), this may provide less accurate results.
+ *
+ * @returns {number} The maximum capacity of the postage batch in bytes.
+ */
+export declare function getStampMaximumCapacityBytes(depth: number): number;
+/**
+ * Utility function that calculates the cost of a postage batch based on its depth and amount.
+ *
+ * @returns {number} The cost of the postage batch in PLUR (10000000000000000 [1e16] PLUR = 1 BZZ)
+ */
+export declare function getStampCostInPlur(depth: number, amount: number): number;
+/**
+ * Utility function that calculates the cost of a postage batch based on its depth and amount.
+ *
+ * @returns {number} The cost of the postage batch in BZZ (1 BZZ = 10000000000000000 [1e16] PLUR)
+ */
+export declare function getStampCostInBzz(depth: number, amount: number): number;
+/**
+ * Utility function that calculates the TTL of a postage batch based on its amount, price per block and block time.
+ *
+ * For more accurate results, get the price per block and block time from the Bee node or the blockchain.
+ *
+ * @returns {number} The TTL of the postage batch in seconds.
+ */
+export declare function getStampTtlSeconds(amount: number, pricePerBlock?: number, blockTime?: number): number;

package/package.json

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