Skip to content

document ethereum.js package#268

Merged
ludamad merged 6 commits into
AztecProtocol:masterfrom
Orloaft:master
Apr 19, 2023
Merged

document ethereum.js package#268
ludamad merged 6 commits into
AztecProtocol:masterfrom
Orloaft:master

Conversation

@Orloaft

@Orloaft Orloaft commented Apr 13, 2023

Copy link
Copy Markdown
Contributor

Description

Documentation added to Ethereum.js package.

Checklist:

  • I have reviewed my diff in github, line by line.
  • Every change is related to the PR description.
  • I have linked this pull request to the issue(s) that it resolves.
  • There are no unexpected formatting changes, superfluous debug logs, or commented-out code.
  • The branch has been merged or rebased against the head of its merge target.
  • I'm happy for the PR to be merged at the reviewer's next convenience.

ludamad
ludamad reviewed Apr 13, 2023
View reviewed changes
Comment thread yarn-project/ethereum.js/src/contract/bytes.ts Outdated
* a specific fixed-length byte array, allowing for optimized memory management and type safety.
*/
export class Bytes extends Buffer {}
/**

@ludamad ludamad Apr 13, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's many ByteN classes, can you replace these all with the line
// eslint-disable-next-line jsdoc/require-jsdoc?

@ludamad

ludamad commented Apr 13, 2023

Copy link
Copy Markdown
Collaborator

Needs a yarn formatting:fix run

ludamad
ludamad reviewed Apr 13, 2023
View reviewed changes
Comment thread yarn-project/ethereum.js/src/retry/index.ts
*
* @yields {number} The next value in the backoff sequence.
*/
export function* backoffGenerator() {

@ludamad ludamad Apr 13, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these utilities are redundant, likely better off deduplicated with the foundation package, but that is best a separate PR

ludamad
ludamad reviewed Apr 13, 2023
View reviewed changes
Comment thread yarn-project/ethereum.js/src/contract/contract_tx_receipt.ts

/**
* Represents a parsed Ethereum event log specific to Aztec contracts.
* Contains information about the event, such as its name, address, arguments, block data, and signature.

@ludamad ludamad Apr 13, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, these need a look, this is not specific to aztec contracts

@Orloaft Orloaft Apr 14, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replaced Aztec instances with Ethereum

@ludamad ludamad Apr 14, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still says 'specific to Aztec contracts.'? (it's not, this is general ethereum stuff)

@ludamad ludamad Apr 14, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see it now

@ludamad

ludamad commented Apr 13, 2023

Copy link
Copy Markdown
Collaborator

LGTM for most of it, although I definitely started to powerread ;)

@ludamad

ludamad commented Apr 14, 2023 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Biggest thing I see left is that this won't pass CI, 300+ tiny linter warnings (which actually, we treat as errors). Would love if you could take a stab at those, if you hit trouble let me know!

For the foundation files which we plan to deduplicate, you can maybe just up the max-warnings for now in package.json

ludamad
ludamad reviewed Apr 19, 2023
View reviewed changes
Comment thread yarn-project/ethereum.js/src/timer/index.ts
constructor() {
this.start = new Date().getTime();
}

@ludamad ludamad Apr 19, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this! Think there's a whole file option for the future

@ludamad

ludamad commented Apr 19, 2023

Copy link
Copy Markdown
Collaborator

LGTM. Tests pass locally for me after merging :)

@ludamad ludamad merged commit 7362195 into AztecProtocol:master Apr 19, 2023
ludamad added a commit that referenced this pull request Jul 14, 2023
@suyash67 @dbanks12
@iAmMichaelConnor @spalladino @ludamad @Maddiaa0
Aztec3 Specific Work in Barretenberg (#142)
c3d461f 
* Split Pedersen Hash & Commitment Gadgets (#95)

* [SQUASHED] Pedersen refactor into hash and commitment.

Use lookup pedersen for merkle tree, fixed-base pedersen for commitments.
---------
Co-authored-by: Suyash Bagad <suyashnbagad1997@gmail.com>

Port `copy_as_new_witness`.

Port `must_imply`.

`operator++`.

Port changes from `common`.

Port `ecc/groups`.

* [CPM] add missing dependencies to libbarretenberg.a (#154)
---------

* Increase Pedersen Generator indices and subindices. (#169)

* Remove a3 specific types. (#252)

* Address Luke's Comments on `aztec3 -> master` (#263)

* Add must_imply tests.

* Added a test for `field_t::copy_as_new_witness`

* add test for `conditional_assign`

* Added `infinity` test.

* Add `add_affine_test`.

* Tests for Array Object in `stdlib` (#262)

* basic array tests.

* Add `composer_type` while hashing/compressing a vkey.

* Add `contains_recursive_proof` to Recursive VK (#268)

* feat: debug utility for serialization (#290)

* feat: enable asan config

* `array_push` for Generic Type (#291)

* Add Indexed Merkle Tree  (#281)

* remove ts (consulted with Adam and we're good to go). (#292)

* Add cout for verification_key struct (#295)

* compute tree (#298)

* [SQUASHED] fixing `push_array_to_array` method. (#304)

* feat(memory_tree|a3): add sibling path calculations (#301)

* feat(memory_tree): frontier paths

* fix array and resolve merge conflicts (#305)

* Mc/hash vk (#306)

* Increase number of sub-generators to 128.

* Build a3crypto.wasm (#311)

* More Tests on A3 `stdlib` methods (#316)

* test: more vk tests to compare circuit/native/vk_data (#310)

* Mc/hash vk (#306)

* inc num_generators_per_hash_index to 128. (#309)

* fix. (#318)

* Added test for `compute_tree_native`. (#319)

* Install instructions for apt on ubuntu (#312)

* Fix address compilation. (#329)

---------

Co-authored-by: David Banks <47112877+dbanks12@users.noreply.github.com>
Co-authored-by: Michael Connor <mike@aztecprotocol.com>
Co-authored-by: dbanks12 <david@aztecprotocol.com>
Co-authored-by: Santiago Palladino <spalladino@gmail.com>
Co-authored-by: ludamad <adam.domurad@gmail.com>
Co-authored-by: Maddiaa <47148561+cheethas@users.noreply.github.com>
Co-authored-by: Santiago Palladino <santiago@aztecprotocol.com>
Co-authored-by: ludamad <domuradical@gmail.com>
Co-authored-by: cheethas <urmasurda@gmail.com>
codygunton pushed a commit that referenced this pull request Jan 23, 2024
@suyash67 @dbanks12
@iAmMichaelConnor @spalladino @ludamad @Maddiaa0
Aztec3 Specific Work in Barretenberg (#142)
2c569cf 
* Split Pedersen Hash & Commitment Gadgets (#95)

* [SQUASHED] Pedersen refactor into hash and commitment.

Use lookup pedersen for merkle tree, fixed-base pedersen for commitments.
---------
Co-authored-by: Suyash Bagad <suyashnbagad1997@gmail.com>

Port `copy_as_new_witness`.

Port `must_imply`.

`operator++`.

Port changes from `common`.

Port `ecc/groups`.

* [CPM] add missing dependencies to libbarretenberg.a (#154)
---------

* Increase Pedersen Generator indices and subindices. (#169)

* Remove a3 specific types. (#252)

* Address Luke's Comments on `aztec3 -> master` (#263)

* Add must_imply tests.

* Added a test for `field_t::copy_as_new_witness`

* add test for `conditional_assign`

* Added `infinity` test.

* Add `add_affine_test`.

* Tests for Array Object in `stdlib` (#262)

* basic array tests.

* Add `composer_type` while hashing/compressing a vkey.

* Add `contains_recursive_proof` to Recursive VK (#268)

* feat: debug utility for serialization (#290)

* feat: enable asan config

* `array_push` for Generic Type (#291)

* Add Indexed Merkle Tree  (#281)

* remove ts (consulted with Adam and we're good to go). (#292)

* Add cout for verification_key struct (#295)

* compute tree (#298)

* [SQUASHED] fixing `push_array_to_array` method. (#304)

* feat(memory_tree|a3): add sibling path calculations (#301)

* feat(memory_tree): frontier paths

* fix array and resolve merge conflicts (#305)

* Mc/hash vk (#306)

* Increase number of sub-generators to 128.

* Build a3crypto.wasm (#311)

* More Tests on A3 `stdlib` methods (#316)

* test: more vk tests to compare circuit/native/vk_data (#310)

* Mc/hash vk (#306)

* inc num_generators_per_hash_index to 128. (#309)

* fix. (#318)

* Added test for `compute_tree_native`. (#319)

* Install instructions for apt on ubuntu (#312)

* Fix address compilation. (#329)

---------

Co-authored-by: David Banks <47112877+dbanks12@users.noreply.github.com>
Co-authored-by: Michael Connor <mike@aztecprotocol.com>
Co-authored-by: dbanks12 <david@aztecprotocol.com>
Co-authored-by: Santiago Palladino <spalladino@gmail.com>
Co-authored-by: ludamad <adam.domurad@gmail.com>
Co-authored-by: Maddiaa <47148561+cheethas@users.noreply.github.com>
Co-authored-by: Santiago Palladino <santiago@aztecprotocol.com>
Co-authored-by: ludamad <domuradical@gmail.com>
Co-authored-by: cheethas <urmasurda@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ludamad ludamad ludamad left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Orloaft @ludamad