Skip to content

document ethereum.js package #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ludamad merged 6 commits into from
Apr 19, 2023
Merged

document ethereum.js package #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
55d7e3b
document ethereum.js package
Orloaft Apr 13, 2023
f6ab79f
deduplicate docs for utilities from foundation package
Orloaft Apr 13, 2023
e9025a1
clean up mistakes in comments
Orloaft Apr 14, 2023
031688f
remove extra characters, replace redundant byte class comments, fix f…
Orloaft Apr 14, 2023
583f0f1
fix jsdocs warnings
Orloaft Apr 19, 2023
4bdcfcc
Merge branch 'master' into master
ludamad Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion yarn-project/ethereum.js/.eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
module.exports = require('@aztec/foundation/eslint-legacy');
module.exports = require('@aztec/foundation/eslint');
14 changes: 7 additions & 7 deletions yarn-project/ethereum.js/src/bigint_buffer/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand Down
Loading