@ethersphere/bee-js 8.1.0 → 8.2.0

package/dist/cjs/bee.js

@@ -46,6 +46,7 @@ const states = __importStar(require("./modules/debug/states"));
 const debugStatus = __importStar(require("./modules/debug/status"));
 const debugTag = __importStar(require("./modules/debug/tag"));
 const transactions = __importStar(require("./modules/debug/transactions"));
+const envelope_1 = require("./modules/envelope");
 const feed_2 = require("./modules/feed");
 const grantee = __importStar(require("./modules/grantee"));
 const pinning = __importStar(require("./modules/pinning"));
@@ -110,6 +111,16 @@ class Bee {
         }
         return bytes.upload(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options);
     }
+    /**
+     * Requests content length for a `/bytes` reference
+     *
+     * @see [Bee API reference - `HEAD /bytes/`](https://docs.ethswarm.org/api/#tag/Bytes/paths/~1bytes~1%7Breference%7D/head)
+     */
+    async probeData(reference, options) {
+        (0, type_2.assertRequestOptions)(options);
+        (0, type_2.assertReferenceOrEns)(reference);
+        return bytes.head(this.getRequestOptionsForCall(options), reference);
+    }
     /**
      * Download data as a byte array
      *
@@ -151,8 +162,7 @@ class Bee {
      * @see [Bee docs - Upload and download](https://docs.ethswarm.org/docs/develop/access-the-swarm/upload-and-download)
      * @see [Bee API reference - `POST /chunks`](https://docs.ethswarm.org/api/#tag/Chunk/paths/~1chunks/post)
      */
-    async uploadChunk(postageBatchId, data, options, requestOptions) {
-        (0, type_2.assertBatchId)(postageBatchId);
+    async uploadChunk(stamp, data, options, requestOptions) {
         (0, type_2.assertRequestOptions)(requestOptions);
         if (!(data instanceof Uint8Array)) {
             throw new TypeError('Data has to be Uint8Array instance!');
@@ -166,7 +176,7 @@ class Bee {
         if (options) {
             (0, type_2.assertUploadOptions)(options);
         }
-        return chunk.upload(this.getRequestOptionsForCall(requestOptions), data, postageBatchId, options);
+        return chunk.upload(this.getRequestOptionsForCall(requestOptions), data, stamp, options);
     }
     /**
      * Download chunk as a byte array
@@ -727,13 +737,12 @@ class Bee {
      * @see [Bee docs - Feeds](https://docs.ethswarm.org/docs/develop/tools-and-features/feeds)
      * @see [Bee API reference - `POST /feeds`](https://docs.ethswarm.org/api/#tag/Feed/paths/~1feeds~1{owner}~1{topic}/post)
      */
-    async createFeedManifest(postageBatchId, type, topic, owner, options) {
+    async createFeedManifest(stamp, type, topic, owner, options) {
         (0, type_2.assertRequestOptions)(options);
         (0, type_1.assertFeedType)(type);
-        (0, type_2.assertBatchId)(postageBatchId);
         const canonicalTopic = (0, topic_1.makeTopic)(topic);
         const canonicalOwner = (0, eth_1.makeHexEthAddress)(owner);
-        const reference = await (0, feed_2.createFeedManifest)(this.getRequestOptionsForCall(options), canonicalOwner, canonicalTopic, postageBatchId);
+        const reference = await (0, feed_2.createFeedManifest)(this.getRequestOptionsForCall(options), canonicalOwner, canonicalTopic, stamp);
         return (0, type_2.addCidConversionFunction)({ reference }, swarm_cid_1.ReferenceType.FEED);
     }
     /**
@@ -883,6 +892,10 @@ class Bee {
             upload: soc_1.uploadSingleOwnerChunkData.bind(null, this.getRequestOptionsForCall(options), canonicalSigner),
         };
     }
+    async createEnvelope(postageBatchId, reference, options) {
+        (0, type_2.assertRequestOptions)(options);
+        return (0, envelope_1.postEnvelope)(this.getRequestOptionsForCall(options), postageBatchId, reference);
+    }
     /**
      * Ping the Bee node to see if there is a live Bee node on the given URL.
      *

package/dist/cjs/chunk/soc.js

@@ -31,7 +31,6 @@ const bytes_1 = require("../utils/bytes");
 const error_1 = require("../utils/error");
 const hash_1 = require("../utils/hash");
 const hex_1 = require("../utils/hex");
-const type_1 = require("../utils/type");
 const bmt_1 = require("./bmt");
 const cac_1 = require("./cac");
 const signer_1 = require("./signer");
@@ -119,12 +118,12 @@ exports.makeSingleOwnerChunk = makeSingleOwnerChunk;
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Upload options
  */
-async function uploadSingleOwnerChunk(requestOptions, chunk, postageBatchId, options) {
+async function uploadSingleOwnerChunk(requestOptions, chunk, stamp, options) {
     const owner = (0, hex_1.bytesToHex)(chunk.owner());
     const identifier = (0, hex_1.bytesToHex)(chunk.identifier());
     const signature = (0, hex_1.bytesToHex)(chunk.signature());
     const data = cafe_utility_1.Binary.concatBytes(chunk.span(), chunk.payload());
-    return socAPI.upload(requestOptions, owner, identifier, signature, data, postageBatchId, options);
+    return socAPI.upload(requestOptions, owner, identifier, signature, data, stamp, options);
 }
 exports.uploadSingleOwnerChunk = uploadSingleOwnerChunk;
 /**
@@ -137,11 +136,10 @@ exports.uploadSingleOwnerChunk = uploadSingleOwnerChunk;
  * @param data            The chunk data
  * @param options
  */
-async function uploadSingleOwnerChunkData(requestOptions, signer, postageBatchId, identifier, data, options) {
-    (0, type_1.assertAddress)(postageBatchId);
+async function uploadSingleOwnerChunkData(requestOptions, signer, stamp, identifier, data, options) {
     const cac = (0, cac_1.makeContentAddressedChunk)(data);
     const soc = await makeSingleOwnerChunk(cac, identifier, signer);
-    return uploadSingleOwnerChunk(requestOptions, soc, postageBatchId, options);
+    return uploadSingleOwnerChunk(requestOptions, soc, stamp, options);
 }
 exports.uploadSingleOwnerChunkData = uploadSingleOwnerChunkData;
 /**

package/dist/cjs/modules/bytes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadReadable = exports.download = exports.upload = void 0;
+exports.downloadReadable = exports.download = exports.head = exports.upload = void 0;
 const bytes_1 = require("../utils/bytes");
 const headers_1 = require("../utils/headers");
 const http_1 = require("../utils/http");
@@ -32,6 +32,23 @@ async function upload(requestOptions, data, postageBatchId, options) {
     };
 }
 exports.upload = upload;
+/**
+ * Requests content length for a reference
+ *
+ * @param requestOptions Options for making requests
+ * @param hash Bee content reference
+ */
+async function head(requestOptions, hash) {
+    const response = await (0, http_1.http)(requestOptions, {
+        url: `${endpoint}/${hash}`,
+        method: 'head',
+        responseType: 'json',
+    });
+    return {
+        contentLength: parseInt(response.headers['content-length']),
+    };
+}
+exports.head = head;
 /**
  * Download data as a byte array
  *

package/dist/cjs/modules/chunk.js

@@ -14,18 +14,18 @@ const endpoint = 'chunks';
  * Upload expects the chuck data to be set accordingly.
  *
  * @param requestOptions Options for making requests
- * @param data    Chunk data to be uploaded
- * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
+ * @param data Chunk data to be uploaded
+ * @param stamp BatchId or marshaled stamp to be used for the upload
  * @param options Additional options like tag, encryption, pinning
  */
-async function upload(requestOptions, data, postageBatchId, options) {
+async function upload(requestOptions, data, stamp, options) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'post',
         url: `${endpoint}`,
         data,
         headers: {
             'content-type': 'application/octet-stream',
-            ...(0, headers_1.extractUploadHeaders)(postageBatchId, options),
+            ...(0, headers_1.extractUploadHeaders)(stamp, options),
         },
         responseType: 'json',
     });

package/dist/cjs/modules/envelope.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postEnvelope = void 0;
+const cafe_utility_1 = require("cafe-utility");
+const http_1 = require("../utils/http");
+const ENVELOPE_ENDPOINT = 'envelope';
+async function postEnvelope(requestOptions, postageBatchId, reference) {
+    const { data } = await (0, http_1.http)(requestOptions, {
+        method: 'post',
+        responseType: 'json',
+        url: `${ENVELOPE_ENDPOINT}/${reference}`,
+        headers: {
+            'swarm-postage-batch-id': postageBatchId,
+        },
+    });
+    return {
+        issuer: cafe_utility_1.Binary.hexToUint8Array(cafe_utility_1.Types.asHexString(data.issuer, { name: 'issuer', byteLength: 20 })),
+        index: cafe_utility_1.Binary.hexToUint8Array(cafe_utility_1.Types.asHexString(data.index, { name: 'index', byteLength: 8 })),
+        timestamp: cafe_utility_1.Binary.hexToUint8Array(cafe_utility_1.Types.asHexString(data.timestamp, { name: 'timestamp', byteLength: 8 })),
+        signature: cafe_utility_1.Binary.hexToUint8Array(cafe_utility_1.Types.asHexString(data.signature, { name: 'signature', byteLength: 65 })),
+    };
+}
+exports.postEnvelope = postEnvelope;

package/dist/cjs/modules/feed.js

@@ -14,12 +14,12 @@ const feedEndpoint = 'feeds';
  * @param postageBatchId  Postage BatchId to be used to create the Feed Manifest
  * @param options         Additional options, like type (default: 'sequence')
  */
-async function createFeedManifest(requestOptions, owner, topic, postageBatchId) {
+async function createFeedManifest(requestOptions, owner, topic, stamp) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'post',
         responseType: 'json',
         url: `${feedEndpoint}/${owner}/${topic}`,
-        headers: (0, headers_1.extractUploadHeaders)(postageBatchId),
+        headers: (0, headers_1.extractUploadHeaders)(stamp),
     });
     return response.data.reference;
 }

package/dist/cjs/modules/soc.js

@@ -16,14 +16,14 @@ const socEndpoint = 'soc';
  * @param postageBatchId  Postage BatchId that will be assigned to uploaded data
  * @param options         Additional options like tag, encryption, pinning
  */
-async function upload(requestOptions, owner, identifier, signature, data, postageBatchId, options) {
+async function upload(requestOptions, owner, identifier, signature, data, stamp, options) {
     const response = await (0, http_1.http)(requestOptions, {
         method: 'post',
         url: `${socEndpoint}/${owner}/${identifier}`,
         data,
         headers: {
             'content-type': 'application/octet-stream',
-            ...(0, headers_1.extractUploadHeaders)(postageBatchId, options),
+            ...(0, headers_1.extractUploadHeaders)(stamp, options),
         },
         responseType: 'json',
         params: { sig: signature },

package/dist/cjs/utils/expose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampMaximumCapacityBytes = exports.getStampEffectiveBytes = exports.getStampCostInPlur = exports.getStampCostInBzz = exports.getDepthForCapacity = exports.getAmountForTtl = exports.makeMaxTarget = exports.keccak256Hash = exports.toLittleEndian = exports.makeHexEthAddress = exports.makeEthereumWalletSigner = exports.makeEthAddress = exports.isHexEthAddress = exports.fromLittleEndian = exports.ethToSwarmAddress = exports.capitalizeAddressERC55 = exports.makeHexString = exports.isHexString = exports.intToHex = exports.hexToBytes = exports.bytesToHex = exports.assertPrefixedHexString = exports.assertHexString = exports.isFlexBytes = exports.isBytes = exports.flexBytesAtOffset = exports.bytesEqual = exports.bytesAtOffset = exports.assertFlexBytes = exports.assertBytes = exports.getFolderSize = exports.getCollectionSize = void 0;
+exports.NULL_TOPIC = exports.NULL_STAMP = exports.getRedundancyStats = exports.getRedundancyStat = exports.approximateOverheadForRedundancyLevel = exports.getStampUsage = exports.getStampTtlSeconds = exports.getStampMaximumCapacityBytes = exports.getStampEffectiveBytes = exports.getStampCostInPlur = exports.getStampCostInBzz = exports.getDepthForCapacity = exports.getAmountForTtl = exports.makeMaxTarget = exports.keccak256Hash = exports.toLittleEndian = exports.makeHexEthAddress = exports.makeEthereumWalletSigner = exports.makeEthAddress = exports.isHexEthAddress = exports.fromLittleEndian = exports.ethToSwarmAddress = exports.capitalizeAddressERC55 = exports.makeHexString = exports.isHexString = exports.intToHex = exports.hexToBytes = exports.bytesToHex = exports.assertPrefixedHexString = exports.assertHexString = exports.isFlexBytes = exports.isBytes = exports.flexBytesAtOffset = exports.bytesEqual = exports.bytesAtOffset = exports.assertFlexBytes = exports.assertBytes = exports.getFolderSize = exports.getCollectionSize = void 0;
 var collection_1 = require("./collection");
 Object.defineProperty(exports, "getCollectionSize", { enumerable: true, get: function () { return collection_1.getCollectionSize; } });
 var collection_node_1 = require("./collection.node");
@@ -47,3 +47,5 @@ var redundancy_1 = require("./redundancy");
 Object.defineProperty(exports, "approximateOverheadForRedundancyLevel", { enumerable: true, get: function () { return redundancy_1.approximateOverheadForRedundancyLevel; } });
 Object.defineProperty(exports, "getRedundancyStat", { enumerable: true, get: function () { return redundancy_1.getRedundancyStat; } });
 Object.defineProperty(exports, "getRedundancyStats", { enumerable: true, get: function () { return redundancy_1.getRedundancyStats; } });
+exports.NULL_STAMP = '0000000000000000000000000000000000000000000000000000000000000000';
+exports.NULL_TOPIC = '0000000000000000000000000000000000000000000000000000000000000000';

package/dist/cjs/utils/headers.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractDownloadHeaders = exports.extractRedundantUploadHeaders = exports.extractUploadHeaders = exports.readFileHeaders = void 0;
+const cafe_utility_1 = require("cafe-utility");
 const error_1 = require("./error");
 /**
  * Read the filename from the content-disposition header
@@ -39,13 +40,17 @@ function readFileHeaders(headers) {
     };
 }
 exports.readFileHeaders = readFileHeaders;
-function extractUploadHeaders(postageBatchId, options) {
-    if (!postageBatchId) {
-        throw new error_1.BeeError('Postage BatchID has to be specified!');
+function extractUploadHeaders(stamp, options) {
+    if (!stamp) {
+        throw new error_1.BeeError('Stamp has to be specified!');
+    }
+    const headers = {};
+    if (stamp instanceof Uint8Array) {
+        headers['swarm-postage-stamp'] = cafe_utility_1.Binary.uint8ArrayToHex(stamp);
+    }
+    else {
+        headers['swarm-postage-batch-id'] = stamp;
     }
-    const headers = {
-        'swarm-postage-batch-id': postageBatchId,
-    };
     if (options?.act) {
         headers['swarm-act'] = String(options.act);
     }

package/dist/cjs/utils/stamps.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDepthForCapacity = exports.getAmountForTtl = exports.getStampTtlSeconds = exports.getStampCostInBzz = exports.getStampCostInPlur = exports.getStampEffectiveBytes = exports.getStampMaximumCapacityBytes = exports.getStampUsage = void 0;
+exports.marshalStamp = exports.convertEnvelopeToMarshaledStamp = exports.getDepthForCapacity = exports.getAmountForTtl = exports.getStampTtlSeconds = exports.getStampCostInBzz = exports.getStampCostInPlur = exports.getStampEffectiveBytes = exports.getStampMaximumCapacityBytes = exports.getStampUsage = void 0;
+const cafe_utility_1 = require("cafe-utility");
 /**
  * Utility function that calculates usage of postage batch based on its utilization, depth and bucket depth.
  *
@@ -112,3 +113,23 @@ function getDepthForCapacity(gigabytes) {
     return gigabytes <= 1 ? 18 : Math.ceil(Math.log2(Math.ceil(gigabytes)) + 18);
 }
 exports.getDepthForCapacity = getDepthForCapacity;
+function convertEnvelopeToMarshaledStamp(batchID, envelope) {
+    return marshalStamp(envelope.signature, cafe_utility_1.Binary.hexToUint8Array(batchID), envelope.timestamp, envelope.index);
+}
+exports.convertEnvelopeToMarshaledStamp = convertEnvelopeToMarshaledStamp;
+function marshalStamp(signature, batchID, timestamp, index) {
+    if (signature.length !== 65) {
+        throw Error('invalid signature length');
+    }
+    if (batchID.length !== 32) {
+        throw Error('invalid batch ID length');
+    }
+    if (timestamp.length !== 8) {
+        throw Error('invalid timestamp length');
+    }
+    if (index.length !== 8) {
+        throw Error('invalid index length');
+    }
+    return cafe_utility_1.Binary.concatBytes(batchID, index, timestamp, signature);
+}
+exports.marshalStamp = marshalStamp;

package/dist/cjs/utils/type.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertTransactionHash = exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertTransactionOptions = exports.assertPostageBatchOptions = exports.assertPublicKey = exports.assertPssMessageHandler = exports.assertAddressPrefix = exports.assertTag = exports.isTag = exports.assertCollectionUploadOptions = exports.assertFileUploadOptions = exports.assertUploadOptions = exports.assertRequestOptions = exports.assertBatchId = exports.assertAddress = exports.addCidConversionFunction = exports.makeReferenceOrEns = exports.assertReferenceOrEns = exports.assertReference = exports.assertPositiveInteger = exports.assertNonNegativeInteger = exports.assertInteger = exports.assertBoolean = exports.assertStrictlyObject = exports.isError = exports.isStrictlyObject = exports.isObject = exports.isInteger = exports.isUint8Array = exports.isReadable = void 0;
+exports.assertTransactionHash = exports.makeTagUid = exports.assertAllTagsOptions = exports.assertFileData = exports.assertData = exports.assertCashoutOptions = exports.assertTransactionOptions = exports.assertPostageBatchOptions = exports.assertPublicKey = exports.assertPssMessageHandler = exports.assertAddressPrefix = exports.assertTag = exports.isTag = exports.assertCollectionUploadOptions = exports.assertFileUploadOptions = exports.assertUploadOptions = exports.assertRequestOptions = exports.assertBatchId = exports.assertAddress = exports.addCidConversionFunction = exports.makeReferenceOrEns = exports.assertReferenceOrEns = exports.assertReference = exports.assertPositiveInteger = exports.assertNonNegativeInteger = exports.assertInteger = exports.assertBoolean = exports.assertStrictlyObject = exports.isError = exports.isStrictlyObject = exports.isObject = exports.isInteger = exports.isReadable = void 0;
 const swarm_cid_1 = require("@ethersphere/swarm-cid");
 const stream_1 = require("stream");
 const types_1 = require("../types");
@@ -11,10 +11,6 @@ function isReadable(obj) {
     return typeof stream_1.Readable !== 'undefined' && obj instanceof stream_1.Readable;
 }
 exports.isReadable = isReadable;
-function isUint8Array(obj) {
-    return obj instanceof Uint8Array;
-}
-exports.isUint8Array = isUint8Array;
 function isInteger(value) {
     return ((typeof value === 'string' && /^-?(0|[1-9][0-9]*)$/g.test(value)) ||
         (typeof value === 'number' &&