BN serialization fix (#347)

* BN serialization fix
GalaChain · Aug 29, 2024 · 9d23aca · 9d23aca
1 parent 88d2c96
commit 9d23aca
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/chain-api/src/ethers/utils/utf8.ts b/chain-api/src/ethers/utils/utf8.ts
@@ -6,6 +6,8 @@
  *
  *  @_subsection api/utils:Strings and UTF-8  [about-strings]
  */
+import BigNumber from "bignumber.js";
+
 import { assertArgument, assertNormalize } from "../errors.js";
 import { BytesLike, getBytes } from "./data.js";
 
@@ -278,8 +280,17 @@ function getUtf8CodePoints(_bytes: BytesLike, onError?: Utf8ErrorFunc): Array<nu
  *
  *  If %%form%% is specified, the string is normalized.
  */
-export function toUtf8Bytes(str: string, form?: UnicodeNormalizationForm): Uint8Array {
-  assertArgument(typeof str === "string", "invalid string value", "str", str);
+export function toUtf8Bytes(str: string | BigNumber, form?: UnicodeNormalizationForm): Uint8Array {
+  assertArgument(
+    typeof str === "string" || BigNumber.isBigNumber(str),
+    `invalid string or bignumber value`,
+    "str or BN",
+    str
+  );
+
+  if (BigNumber.isBigNumber(str)) {
+    str = str.toFixed();
+  }
 
   if (form != null) {
     assertNormalize(form);

diff --git a/chain-api/src/utils/serialize.spec.ts b/chain-api/src/utils/serialize.spec.ts
@@ -15,6 +15,7 @@
 import BigNumber from "bignumber.js";
 import { ArrayMinSize, IsString } from "class-validator";
 
+import { toUtf8Bytes } from "../ethers/utils/utf8";
 import { ChainCallDTO, ChainObject } from "../types";
 import { BigNumberProperty } from "../validators";
 import serialize from "./serialize";
@@ -122,3 +123,8 @@ it("should handle very large numbers with no decimals", () => {
   expect(chainObjectS).toEqual(expectedClassS);
   expect(plainS).toEqual(expectedPlainS);
 });
+
+it("Bignumber toUtf8Bytes", () => {
+  const bigNumber = BigNumber("300");
+  expect(toUtf8Bytes(bigNumber)).toEqual(toUtf8Bytes("300"));
+});