Skip to content
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.

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

fix: add context on when to use createAddress and create2Address #1032

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

PatrickAlphaC
Copy link
Contributor

@PatrickAlphaC PatrickAlphaC commented Apr 25, 2024

What 💻

  • added context to working with createaddress and create2address.
  • updated a link pointing to the differences between createAddress and create2Address and address creation in general in the EVM

Why ✋

Added context to when to use create2Address

@PatrickAlphaC PatrickAlphaC requested review from a team as code owners April 25, 2024 23:39
- Always use the [`createAddress`](../../../sdks/js/utils.md#createaddress) and [`create2Address`](../../../sdks/js/utils.md#create2address) utility functions of the `zksync-ethers` SDK.
- Read the documentation for more information on [address derivation differences between Ethereum and zkSync](../../../developer-reference/differences-with-ethereum.md).
- Always use the [`createAddress`](../../../sdks/js/utils.md#createaddress) and [`create2Address`](../../../sdks/js/utils.md#create2address) utility functions of the `zksync-ethers` SDK when looking to determine a contract's address.
- Read the documentation for more information on [address derivation differences between Ethereum and zkSync](<[../../../developer-reference/differences-with-ethereum.md](https://docs.zksync.io/build/developer-reference/differences-with-ethereum.html#create-create2)>).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Read the documentation for more information on [address derivation differences between Ethereum and zkSync](<[../../../developer-reference/differences-with-ethereum.md](https://docs.zksync.io/build/developer-reference/differences-with-ethereum.html#create-create2)>).
- Read the documentation for more information on [address derivation differences between Ethereum and zkSync](<[../../../developer-reference/differences-with-ethereum.md](https://docs.zksync.io/build/developer-reference/differences-with-ethereum.md#create-create2)>).

this breaks the CI job 😉

Copy link
Collaborator

Choose a reason for hiding this comment

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

We should be adding links directly to the header within the Markdown file and not use reference links (especially when this is already a link)

Suggested change
- Read the documentation for more information on [address derivation differences between Ethereum and zkSync](<[../../../developer-reference/differences-with-ethereum.md](https://docs.zksync.io/build/developer-reference/differences-with-ethereum.html#create-create2)>).
- Read the documentation for more information on [address derivation differences between Ethereum and zkSync](../../../developer-reference/differences-with-ethereum.md#create-create2).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants