fix: allow unmarshaling encrypted manifests (#1052)

* fix: allow unmarshaling encrypted manifests

* test: improve testability

Author: Cafe137

jest.config.ts

@@ -7,11 +7,11 @@ import type { Config } from '@jest/types'
 import { Dates, Types } from 'cafe-utility'
 
 export default async (): Promise<Config.InitialOptions> => {
-  Types.asString(process.env.JEST_BEE_FULL_URL, { name: 'JEST_BEE_FULL_URL' })
-  Types.asString(process.env.JEST_BEE_LIGHT_URL, { name: 'JEST_BEE_LIGHT_URL' })
-  Types.asString(process.env.JEST_BEE_ULTRA_LIGHT_URL, { name: 'JEST_BEE_ULTRA_LIGHT_URL' })
-  Types.asHexString(process.env.JEST_FULL_BATCH_ID, { name: 'JEST_FULL_BATCH_ID', byteLength: 32 })
-  Types.asHexString(process.env.JEST_LIGHT_BATCH_ID, { name: 'JEST_LIGHT_BATCH_ID', byteLength: 32 })
+  Types.asString(process.env.JEST_BEE_URL, { name: 'JEST_BEE_URL' })
+  Types.asString(process.env.JEST_BEE_SIGNER, { name: 'JEST_BEE_SIGNER' })
+  Types.asHexString(process.env.JEST_MANAGED_BATCH_ID, { name: 'JEST_MANAGED_BATCH_ID', byteLength: 32 })
+  Types.asHexString(process.env.JEST_EXTERNAL_BATCH_ID, { name: 'JEST_EXTERNAL_BATCH_ID', byteLength: 32 })
+  Types.asString(process.env.JEST_WITHDRAW_ADDRESS, { name: 'JEST_WITHDRAW_ADDRESS' })
 
   return {
     collectCoverage: true,

src/manifest/manifest.ts

@@ -92,12 +92,12 @@ export class Fork {
     return Binary.concatBytes(...data)
   }
 
-  static unmarshal(reader: Uint8ArrayReader): Fork {
+  static unmarshal(reader: Uint8ArrayReader, addressLength: number): Fork {
     const type = Binary.uint8ToNumber(reader.read(1))
     const prefixLength = Binary.uint8ToNumber(reader.read(1))
     const prefix = reader.read(prefixLength)
     reader.read(30 - prefixLength)
-    const selfAddress = reader.read(32)
+    const selfAddress = reader.read(addressLength)
     let metadata: Record<string, string> | undefined = undefined
 
     if (isType(type, TYPE_WITH_METADATA)) {
@@ -292,7 +292,7 @@ export class MantarayNode {
     const forkBitmap = reader.read(32)
     for (let i = 0; i < 256; i++) {
       if (Binary.getBit(forkBitmap, i, 'LE')) {
-        const newFork = Fork.unmarshal(reader)
+        const newFork = Fork.unmarshal(reader, targetAddressLength)
         node.forks.set(i, newFork)
         newFork.node.parent = node
       }

src/modules/debug/status.ts

@@ -5,9 +5,9 @@ import type { DebugStatus, Health, NodeInfo, Readiness } from '../../types/debug
 import { BeeVersions, toBeeMode } from '../../types/debug'
 import { http } from '../../utils/http'
 
-export const SUPPORTED_BEE_VERSION_EXACT = '2.4.0-390a402e'
+export const SUPPORTED_BEE_VERSION_EXACT = '2.6.0-d0aa8b93'
 export const SUPPORTED_BEE_VERSION = SUPPORTED_BEE_VERSION_EXACT.split('-')[0]
-export const SUPPORTED_API_VERSION = '7.2.0'
+export const SUPPORTED_API_VERSION = '7.3.0'
 
 const NODE_INFO_URL = 'node'
 const STATUS_URL = 'status'

test/integration/encrypted-manifest.spec.ts

@@ -0,0 +1,16 @@
+import { MantarayNode } from '../../src'
+import { makeBee } from '../utils'
+
+test('decrypt a manifest that is encrypted and obfuscated', async () => {
+  const bee = makeBee()
+  const reference =
+    '2874296904931ffea2ae85c7a2646756e2c475d5d5983c14c1002a510a4a3ca0b53ee9d62fd060b58cab6b47d3f26b4f3f3c614c74bd689af2bfa756d80152ca'
+
+  const node = await MantarayNode.unmarshal(bee, reference)
+  await node.loadRecursively(bee)
+
+  const items = node.collectAndMap()
+  expect(items['.editorconfig']).toBe(
+    'ef7b55dd0059af17c861e4b7b81b62d32d131b510eae1f21e8b550f864305ebca4546334599af9a91052cc183216e336e9fc815ebc3f7fc8cc88004a5e81f426',
+  )
+})

test/integration/stake.spec.ts

@@ -8,7 +8,7 @@ test('GET stake', async () => {
   const stake = await bee.getStake()
 
   if (currentBeeMode() === 'full') {
-    expect(parseFloat(stake.toDecimalString())).toBeGreaterThan(200)
+    expect(parseFloat(stake.toDecimalString())).toBeGreaterThan(10)
   } else {
     expect(parseFloat(stake.toDecimalString())).toBe(0)
   }

test/integration/stamp.spec.ts

@@ -21,10 +21,10 @@ test('GET batches', async () => {
 })
 
 test('POST stamps', async () => {
-  const response = await bee.createPostageBatch('580000000', 17, { waitForUsable: true })
+  const response = await bee.createPostageBatch('1098006401', 17, { waitForUsable: true })
   expect(response.toHex()).toHaveLength(64)
 
-  await bee.topUpBatch(response, '580000000')
+  await bee.topUpBatch(response, '1098006401')
 
   await System.waitFor(
     async () => {

test/integration/stamper.spec.ts

@@ -6,8 +6,8 @@ test('Stamper', async () => {
   const bee = makeBee()
 
   const stamper = Stamper.fromBlank(
-    Types.asString(process.env.JEST_BEE_FULL_PK),
-    'b24b3f3ac5c7727cb9ad17b15167e75df33708f201c947f3cc6658348c2df31d',
+    Types.asString(process.env.JEST_BEE_SIGNER),
+    Types.asString(process.env.JEST_EXTERNAL_BATCH_ID),
     17,
   )
 
@@ -25,8 +25,8 @@ test('Stamper', async () => {
   expect(state.reduce((a, b) => a + b)).toBe(1)
 
   const nextStamper = Stamper.fromState(
-    Types.asString(process.env.JEST_BEE_FULL_PK),
-    'ae0b4d8548d17fb70672c5e7a9717de5f855d3f398a3cc2f0e445e2eecca2622',
+    Types.asString(process.env.JEST_BEE_SIGNER),
+    Types.asString(process.env.JEST_EXTERNAL_BATCH_ID),
     state,
     17,
   )

test/integration/status.spec.ts

@@ -71,8 +71,8 @@ test('GET wallet', async () => {
   const wallet = await bee.getWalletBalance()
   expect(parseFloat(wallet.bzzBalance.toDecimalString())).toBeGreaterThan(20)
   expect(parseFloat(wallet.bzzBalance.toDecimalString())).toBeLessThan(200)
-  expect(parseFloat(wallet.nativeTokenBalance.toDecimalString())).toBeGreaterThan(4)
-  expect(parseFloat(wallet.nativeTokenBalance.toDecimalString())).toBeLessThan(5)
+  expect(parseFloat(wallet.nativeTokenBalance.toDecimalString())).toBeGreaterThan(1)
+  expect(parseFloat(wallet.nativeTokenBalance.toDecimalString())).toBeLessThan(2)
 })
 
 test('GET status', async () => {

test/integration/withdraw.spec.ts

@@ -1,12 +1,12 @@
-import { Dates, System } from 'cafe-utility'
+import { Dates, System, Types } from 'cafe-utility'
 import { makeBee } from '../utils'
 
 const bee = makeBee()
 
 test('withdraw to external wallet', async () => {
   const walletBefore = await bee.getWalletBalance()
 
-  await bee.withdrawBZZToExternalWallet('1', process.env.JEST_WITHDRAW_ADDRESS!)
+  await bee.withdrawBZZToExternalWallet('1', Types.asString(process.env.JEST_WITHDRAW_ADDRESS))
   await System.waitFor(
     async () => {
       const pendingTransactions = await bee.getAllPendingTransactions()
@@ -16,7 +16,7 @@ test('withdraw to external wallet', async () => {
     60,
   )
 
-  await bee.withdrawDAIToExternalWallet('1', process.env.JEST_WITHDRAW_ADDRESS!)
+  await bee.withdrawDAIToExternalWallet('1', Types.asString(process.env.JEST_WITHDRAW_ADDRESS))
   await System.waitFor(
     async () => {
       const pendingTransactions = await bee.getAllPendingTransactions()

test/regression/bee-js-986.spec.ts

@@ -1,3 +1,4 @@
+import { Types } from 'cafe-utility'
 import { mocked } from '../mocks'
 import { batch } from '../utils'
 
@@ -32,7 +33,7 @@ test('bee-js/986 - Headers not merging properly', async () => {
       host: 'localhost:11633',
       'swarm-act': 'true',
       'swarm-encrypt': 'true',
-      'swarm-postage-batch-id': 'b961413232c96eedae48947a71c99e454e51c4b5bf93a77c59f958af1229a932',
+      'swarm-postage-batch-id': Types.asString(process.env.JEST_MANAGED_BATCH_ID),
       'swarm-tag': '1337',
       'user-agent': 'axios/0.30.0',
     },
@@ -49,7 +50,7 @@ test('bee-js/986 - Headers not merging properly', async () => {
       host: 'localhost:11633',
       'swarm-act': 'true',
       'swarm-encrypt': 'true',
-      'swarm-postage-batch-id': 'f8b2ad296d64824a8fe51a33ff15fe8668df13a20ad3d4eea4bb97ca600029aa',
+      'swarm-postage-batch-id': Types.asString(process.env.JEST_MANAGED_BATCH_ID),
       'swarm-tag': '1338',
       'user-agent': 'axios/0.30.0',
     },