feat: add network option, require explicit block time (#998)

Author: Cafe137

.github/workflows/check.yaml

@@ -32,15 +32,15 @@ jobs:
         uses: wagoid/commitlint-github-action@v2
 
       - name: Code linting
-        run: npm run lint:check
+        run: npm run lint
         env:
           CI: true
 
       - name: Dependency check
         run: npm run depcheck
 
       - name: Check typings
-        run: npm run check:types
+        run: npm run check
 
       - name: Check build
         run: npm run build

jest.config.ts

@@ -10,7 +10,6 @@ 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.asString(process.env.JEST_BEE_SECRET, { name: 'JEST_BEE_SECRET' })
   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 })
 

package.json

@@ -56,9 +56,8 @@
     "build:types": "tsc --emitDeclarationOnly --declaration --outDir dist/types",
     "build:browser": "webpack --progress",
     "test": "jest --config=jest.config.ts --runInBand --verbose",
-    "check:types": "tsc --project tsconfig.test.json",
-    "lint": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\" && prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "lint:check": "eslint \"src/**/*.ts\" \"test/**/*.ts\" && prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
+    "check": "tsc --project tsconfig.test.json",
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" && prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
     "depcheck": "depcheck ."
   },
   "dependencies": {

src/bee.ts

@@ -149,6 +149,11 @@ export class Bee {
    */
   public readonly signer?: PrivateKey
 
+  /**
+   * Network on which the Bee node is running
+   */
+  public readonly network: 'gnosis' | 'sepolia'
+
   /**
    * Options for making requests
    * @private
@@ -171,6 +176,8 @@ export class Bee {
       this.signer = new PrivateKey(options.signer)
     }
 
+    this.network = options?.network ?? 'gnosis'
+
     this.requestOptions = {
       baseURL: this.url,
       timeout: options?.timeout ?? 0,
@@ -1035,6 +1042,7 @@ export class Bee {
       const signer = new PrivateKey(Binary.numberToUint256(start + i, 'BE'))
       const socAddress = makeSOCAddress(identifier, signer.publicKey().address())
       const actualProximity = 256 - Binary.proximity(socAddress.toUint8Array(), targetOverlay.toUint8Array(), 256)
+
       if (actualProximity <= 256 - proximity) {
         return signer
       }
@@ -1637,7 +1645,7 @@ export class Bee {
     requestOptions?: BeeRequestOptions,
   ): Promise<BatchId> {
     const chainState = await this.getChainState(requestOptions)
-    const amount = getAmountForDuration(duration, chainState.currentPrice)
+    const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15)
     const depth = getDepthForSize(size)
 
     if (options) {
@@ -1649,7 +1657,7 @@ export class Bee {
 
   async getStorageCost(size: Size, duration: Duration, options?: BeeRequestOptions): Promise<BZZ> {
     const chainState = await this.getChainState(options)
-    const amount = getAmountForDuration(duration, chainState.currentPrice)
+    const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15)
     const depth = getDepthForSize(size)
 
     return getStampCost(depth, amount)
@@ -1676,7 +1684,7 @@ export class Bee {
   ) {
     const batch = await this.getPostageBatch(postageBatchId, options)
     const chainState = await this.getChainState(options)
-    const amount = getAmountForDuration(duration, chainState.currentPrice)
+    const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15)
 
     return this.topUpBatch(batch.batchID, amount, options)
   }
@@ -1689,7 +1697,7 @@ export class Bee {
   ): Promise<BZZ> {
     const batch = await this.getPostageBatch(postageBatchId, options)
     const chainState = await this.getChainState(options)
-    const amount = getAmountForDuration(duration, chainState.currentPrice)
+    const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15)
     const depth = getDepthForSize(size)
 
     const currentValue = getStampCost(batch.depth, batch.amount)
@@ -1713,6 +1721,7 @@ export class Bee {
 
     const currentPaid = getStampCost(batch.depth, batch.amount)
     const newPaid = getStampCost(depth, batch.amount)
+
     return newPaid.minus(currentPaid)
   }
 
@@ -1723,7 +1732,7 @@ export class Bee {
   ): Promise<BZZ> {
     const batch = await this.getPostageBatch(postageBatchId, options)
     const chainState = await this.getChainState(options)
-    const amount = getAmountForDuration(duration, chainState.currentPrice)
+    const amount = getAmountForDuration(duration, chainState.currentPrice, this.network === 'gnosis' ? 5 : 15)
 
     return getStampCost(batch.depth, amount)
   }

src/feed/index.ts

@@ -101,6 +101,7 @@ export async function updateFeedWithPayload(
   if (data.length > 4096) {
     const uploadResult = await bytes.upload(requestOptions, data, postageBatchId, options)
     const rootChunk = await chunkAPI.download(requestOptions, uploadResult.reference)
+
     return uploadSingleOwnerChunkWithWrappedChunk(
       requestOptions,
       signer,

src/manifest/manifest.ts

@@ -248,6 +248,7 @@ export class MantarayNode {
     requestOptions?: BeeRequestOptions,
   ): Promise<MantarayNode> {
     const data = (await bee.downloadData(reference, options, requestOptions)).toUint8Array()
+
     return this.unmarshalFromData(data)
   }
 

src/stamper/stamper.ts

@@ -39,6 +39,7 @@ export class Stamper {
     const address = chunk.hash()
     const bucket = Binary.uint16ToNumber(address, 'BE')
     const height = this.buckets[bucket]
+
     if (height >= this.maxSlot) {
       throw Error('Bucket is full')
     }

src/types/index.ts

@@ -55,6 +55,10 @@ export interface BeeOptions extends BeeRequestOptions {
    * Signer object or private key of the Signer in form of either hex string or Uint8Array that will be default signer for the instance.
    */
   signer?: PrivateKey | Uint8Array | string
+  /**
+   * Default gnosis when unspecified.
+   */
+  network?: 'gnosis' | 'sepolia'
 }
 
 export interface GranteesResult {

src/utils/duration.ts

@@ -3,6 +3,7 @@ export class Duration {
 
   private constructor(seconds: number) {
     this.seconds = Math.ceil(seconds)
+
     if (seconds <= 0) {
       throw Error('Duration must be greater than 0')
     }

src/utils/http.ts

@@ -29,6 +29,7 @@ export async function http<T>(options: BeeRequestOptions, config: AxiosRequestCo
     const keys = Object.keys(requestConfig.params)
     for (const key of keys) {
       const value = requestConfig.params[key]
+
       if (value === undefined) {
         delete requestConfig.params[key]
       }