feat: filter out tokens with zero amounts on output build

Author: arobsn

.changeset/ten-dryers-end.md

@@ -0,0 +1,5 @@
+---
+"@fleet-sdk/core": patch
+---
+
+Filter out tokens with zero amounts on output build

packages/common/src/models/collection.ts

@@ -92,7 +92,6 @@ export abstract class Collection<InternalType, ExternalType> implements Iterable
     if (isDefined(options) && isDefined(options.index)) {
       if (options.index === this.length) {
         this._items.push(this._map(item));
-
         return this.length;
       }
 
@@ -101,12 +100,10 @@ export abstract class Collection<InternalType, ExternalType> implements Iterable
       }
 
       this._items.splice(options.index, 0, this._map(item));
-
       return this.length;
     }
 
     this._items.push(this._map(item));
-
     return this._items.length;
   }
 

packages/core/src/builder/outputBuilder.spec.ts

@@ -581,6 +581,20 @@ describe("Building", () => {
     expect(output.value).toBe(29000n);
   });
 
+  it("Should filter out token with zero amounts on build", () => {
+    const output = new OutputBuilder(SAFE_MIN_BOX_VALUE, address, height)
+      .addTokens({ tokenId: tokenA, amount: 50n })
+      .addTokens({ tokenId: tokenB, amount: 0n });
+    expect(output.assets).toHaveLength(2);
+    expect(output.assets.toArray().find((x) => x.tokenId === tokenA)?.amount).toEqual(50n);
+    expect(output.assets.toArray().find((x) => x.tokenId === tokenB)?.amount).toEqual(0n);
+
+    const candidate = output.build();
+
+    expect(candidate.assets).toHaveLength(1);
+    expect(candidate.assets).to.deep.equal([{ tokenId: tokenA, amount: 50n }]);
+  });
+
   it("Should replace dynamic value estimation by fixed value", () => {
     const output = new OutputBuilder(estimateMinBoxValue(), address, height);
     expect(output.value).toBe(28440n);

packages/core/src/builder/outputBuilder.ts

@@ -198,7 +198,7 @@ export class OutputBuilder {
         });
       }
     } else {
-      tokens = this.assets.toArray();
+      tokens = this.assets.toArray().filter((x) => x.amount > _0n);
     }
 
     if (isUndefined(this.creationHeight)) throw new UndefinedCreationHeight();