document ethereum.js package (#268)

* document ethereum.js package

* deduplicate docs for utilities from foundation package

* clean up mistakes in comments

* remove extra characters, replace redundant byte class comments, fix formatting

* fix jsdocs warnings

---------

Co-authored-by: ludamad <[email protected]>

yarn-project/ethereum.js/.eslintrc.cjs

@@ -1 +1 @@
-module.exports = require('@aztec/foundation/eslint-legacy');
+module.exports = require('@aztec/foundation/eslint');

yarn-project/ethereum.js/src/bigint_buffer/index.ts

@@ -1,6 +1,6 @@
 /**
  * Convert a little-endian buffer into a BigInt.
- * @param buf The little-endian buffer to convert
+ * @param buf - The little-endian buffer to convert.
  * @returns A BigInt with the little-endian representation of buf.
  */
 export function toBigIntLE(buf: Buffer): bigint {
@@ -14,8 +14,8 @@ export function toBigIntLE(buf: Buffer): bigint {
 }
 
 /**
- * Convert a big-endian buffer into a BigInt
- * @param buf The big-endian buffer to convert.
+ * Convert a big-endian buffer into a BigInt.
+ * @param buf - The big-endian buffer to convert.
  * @returns A BigInt with the big-endian representation of buf.
  */
 export function toBigIntBE(buf: Buffer): bigint {
@@ -28,8 +28,8 @@ export function toBigIntBE(buf: Buffer): bigint {
 
 /**
  * Convert a BigInt to a little-endian buffer.
- * @param num   The BigInt to convert.
- * @param width The number of bytes that the resulting buffer should be.
+ * @param num  - The BigInt to convert.
+ * @param width - The number of bytes that the resulting buffer should be.
  * @returns A little-endian buffer representation of num.
  */
 export function toBufferLE(num: bigint, width: number): Buffer {
@@ -41,8 +41,8 @@ export function toBufferLE(num: bigint, width: number): Buffer {
 
 /**
  * Convert a BigInt to a big-endian buffer.
- * @param num   The BigInt to convert.
- * @param width The number of bytes that the resulting buffer should be.
+ * @param num  - The BigInt to convert.
+ * @param width - The number of bytes that the resulting buffer should be.
  * @returns A big-endian buffer representation of num.
  */
 export function toBufferBE(num: bigint, width: number): Buffer {