feat!: enable waiting for postage batch to be usable by default (#746)

ethersphere · Jul 28, 2022 · cb05d22 · cb05d22
1 parent 37c5b55
commit cb05d22
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 15 deletions.
diff --git a/src/bee-debug.ts b/src/bee-debug.ts
@@ -527,7 +527,7 @@ export class BeeDebug {
 
     const stamp = await stamps.createPostageBatch(this.getKy(options), amount, depth, options)
 
-    if (options?.waitForUsable) {
+    if (options?.waitForUsable !== false) {
       await this.waitForUsablePostageStamp(stamp, options?.waitForUsableTimeout)
     }
 

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -567,12 +567,12 @@ export interface PostageBatchOptions extends RequestOptions {
   /**
    * The returned Promise will await until the purchased Postage Batch is usable.
    * In other word, it has to have enough block confirmations that Bee pronounce it usable.
-   * If turned on, this significantly prolong the creation of postage batch!
+   * When turned on, this significantly prolongs the creation of postage batch!
+   *
    * If you plan to use the stamp right away for some action with Bee (like uploading using this stamp) it is
    * highly recommended to use this option, otherwise you might get errors "stamp not usable" from Bee.
    *
-   * In next breaking release this option will be turned on by default.
-   * @default false
+   * @default true
    */
   waitForUsable?: boolean
 

diff --git a/test/integration/bee-debug-class.spec.ts b/test/integration/bee-debug-class.spec.ts
@@ -16,26 +16,26 @@ describe('Bee Debug class', () => {
 
   describe('PostageBatch', () => {
     it(
-      'should create a new postage batch with zero amount',
+      'should create a new postage batch with zero amount and be usable',
       async () => {
         const batchId = await beeDebug.createPostageBatch('10', 17)
         const stamp = await beeDebug.getPostageBatch(batchId)
-        expect(stamp.usable).toEqual(false)
+        expect(stamp.usable).toEqual(true)
 
         const allBatches = await beeDebug.getAllPostageBatch()
         expect(allBatches.find(batch => batch.batchID === batchId)).toBeTruthy()
       },
-      BLOCKCHAIN_TRANSACTION_TIMEOUT,
+      WAITING_USABLE_STAMP_TIMEOUT + BLOCKCHAIN_TRANSACTION_TIMEOUT,
     )
 
     it(
-      'should wait for the stamp to be usable',
+      'should not wait for the stamp to be usable if specified',
       async () => {
-        const batchId = await beeDebug.createPostageBatch('1000', 17, { waitForUsable: true })
+        const batchId = await beeDebug.createPostageBatch('1000', 17, { waitForUsable: false })
         const stamp = await beeDebug.getPostageBatch(batchId)
-        expect(stamp.usable).toEqual(true)
+        expect(stamp.usable).toEqual(false)
       },
-      WAITING_USABLE_STAMP_TIMEOUT + BLOCKCHAIN_TRANSACTION_TIMEOUT,
+      BLOCKCHAIN_TRANSACTION_TIMEOUT,
     )
 
     // TODO: Finish topup and dilute testing https://github.com/ethersphere/bee-js/issues/427
@@ -70,8 +70,8 @@ describe('Bee Debug class', () => {
     it(
       'should have both immutable true and false',
       async () => {
-        await beeDebug.createPostageBatch('1', 17, { immutableFlag: true })
-        await beeDebug.createPostageBatch('1', 17, { immutableFlag: false })
+        await beeDebug.createPostageBatch('1', 17, { immutableFlag: true, waitForUsable: false })
+        await beeDebug.createPostageBatch('1', 17, { immutableFlag: false, waitForUsable: false })
         const allBatches = await beeDebug.getAllPostageBatch()
 
         expect(allBatches.find(batch => batch.immutableFlag === true)).toBeTruthy()

diff --git a/test/unit/bee-debug-class.spec.ts b/test/unit/bee-debug-class.spec.ts
@@ -366,15 +366,17 @@ describe('BeeDebug class', () => {
       createPostageBatchMock('10', '17').reply(201, BATCH_RESPONSE)
 
       const bee = new BeeDebug(MOCK_SERVER_URL)
-      await expect(bee.createPostageBatch('10', 17)).resolves.toEqual(BATCH_ID)
+      await expect(bee.createPostageBatch('10', 17, { waitForUsable: false })).resolves.toEqual(BATCH_ID)
       assertAllIsDone()
     })
 
     it('should pass headers if gas price is specified', async () => {
       createPostageBatchMock('10', '17', '100').reply(201, BATCH_RESPONSE)
 
       const bee = new BeeDebug(MOCK_SERVER_URL)
-      await expect(bee.createPostageBatch('10', 17, { gasPrice: '100' })).resolves.toEqual(BATCH_ID)
+      await expect(bee.createPostageBatch('10', 17, { waitForUsable: false, gasPrice: '100' })).resolves.toEqual(
+        BATCH_ID,
+      )
       assertAllIsDone()
     })