feat(docs): upgrade-bn

Dan Forbes · Dan Forbes · commit 9e02d007acf8 · 2024-09-03T12:19:18.000-04:00
Add a section in "Upgrade from 1.x" for `BN` vs `BigInt` Closes #6705
diff --git a/docs/docs/guides/web3_upgrade_guide/1.x/web3_utils_migration_guide.md b/docs/docs/guides/web3_upgrade_guide/1.x/web3_utils_migration_guide.md
@@ -17,6 +17,18 @@ import web3Utils from 'web3-utils';
 import * as web3Utils from 'web3-utils';
 ```
 
+## No `BN` property
+
+The `web3-utils` package no longer includes a `BN` property for using the [the `bn.js` package](https://github.com/indutny/bn.js/) for working with (big) numbers. In 4.x, [the native JavaScript `BigInt` type](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) is used.
+
+```ts
+// 1.x
+new Web3.utils.BN(1);
+
+// 4.x
+BigInt(4);
+```
+
 ## Unit conversion functions
 
 The `toWei` does not have an optional second parameter. You have to pass the source unit explicitly.
