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

Update sdk docs #63

Merged
merged 3 commits into from
Jun 21, 2022
Merged

Conversation

ly0va
Copy link
Member

@ly0va ly0va commented Jun 21, 2022

No description provided.

@github-actions
Copy link

github-actions bot commented Jun 21, 2022

Visit the preview URL for this PR (updated for commit 02c6b90):

https://aqwzx-zksync-v2-docs--pr63-lyova-update-sdk-doc-jl3oxvtj.web.app

(expires Tue, 28 Jun 2022 21:46:59 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

docs/api/hardhat/getting-started.md Show resolved Hide resolved
docs/api/js/accounts.md Outdated Show resolved Hide resolved
@StanislavBreadless StanislavBreadless merged commit c1c2f1e into sb-docs-for-new-release Jun 21, 2022
@StanislavBreadless StanislavBreadless deleted the lyova-update-sdk-docs branch June 21, 2022 22:07
StanislavBreadless added a commit that referenced this pull request Jun 22, 2022
* Starting writing up

* Start to change the docs

* Some more basic documentation

* basic AA documentation

* Add some basic description of the system contracts

* Update sdk docs (#63)

* Update changed methods

* Add new methods to the docs

* Use USDC_L2_ADDRESS

* Update docs/api/js/getting-started.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/aa.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* More appropriate use of AA/account

* Vb docs new realease (#62)

* Add base info about L2 -> L1

* Update L1 -> L2 communication section

* Write a couple of words about L2 -> L1 communication

* Add description of the L2 -> L1 communication interfaces

* Set todos

* Remove method for getting l1 withdraw tx

* Fix l1 -> l2 communication guide

* Remove examples from the l2 -> l1 guide

* Update docs/dev/guide/l2-l1.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Fix typos & fix imports in code examples

* Add basic solitiy example of using l2 -> l1 messaging

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Fix comments

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>
Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Vb docs new realease (#64)

* Add base info about L2 -> L1

* Update L1 -> L2 communication section

* Write a couple of words about L2 -> L1 communication

* Add description of the L2 -> L1 communication interfaces

* Set todos

* Remove method for getting l1 withdraw tx

* Fix l1 -> l2 communication guide

* Remove examples from the l2 -> l1 guide

* Update docs/dev/guide/l2-l1.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Fix typos & fix imports in code examples

* Add basic solitiy example of using l2 -> l1 messaging

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Fix comments

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Fix comments

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Apply more suggestions

* Fix issue & add typescript example

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>
Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* fmt + new api endpoint

* Slightly better description of L2->L1 proffs

* Disclaimer for the l1 governance tutorial

* change warning

* Fix typos & add dummy section of bridging

* Use less confusing titles

* mark tutorials as non-working

* capital letters

* Update docs/api/api.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/api/api.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>
Co-authored-by: Lyova Potyomkin <lyova.potyomkin@gmail.com>
Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>
Co-authored-by: Vlad Bochok <41153528+vladbochok@users.noreply.github.com>
Co-authored-by: vladbochok <vladbochok1@gmail.com>
StanislavBreadless added a commit that referenced this pull request Jun 24, 2022
* Starting writing up

* Start to change the docs

* Some more basic documentation

* basic AA documentation

* Add some basic description of the system contracts

* Update sdk docs (#63)

* Update changed methods

* Add new methods to the docs

* Use USDC_L2_ADDRESS

* Update docs/api/js/getting-started.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/aa.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* More appropriate use of AA/account

* Vb docs new realease (#62)

* Add base info about L2 -> L1

* Update L1 -> L2 communication section

* Write a couple of words about L2 -> L1 communication

* Add description of the L2 -> L1 communication interfaces

* Set todos

* Remove method for getting l1 withdraw tx

* Fix l1 -> l2 communication guide

* Remove examples from the l2 -> l1 guide

* Update docs/dev/guide/l2-l1.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Fix typos & fix imports in code examples

* Add basic solitiy example of using l2 -> l1 messaging

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Fix comments

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>
Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Vb docs new realease (#64)

* Add base info about L2 -> L1

* Update L1 -> L2 communication section

* Write a couple of words about L2 -> L1 communication

* Add description of the L2 -> L1 communication interfaces

* Set todos

* Remove method for getting l1 withdraw tx

* Fix l1 -> l2 communication guide

* Remove examples from the l2 -> l1 guide

* Update docs/dev/guide/l2-l1.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>

* Fix typos & fix imports in code examples

* Add basic solitiy example of using l2 -> l1 messaging

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Fix comments

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Fix comments

* Update docs/dev/guide/l2-l1.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Update docs/dev/zksync-v2/l1-l2-interop.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Apply more suggestions

* Fix issue & add typescript example

Co-authored-by: Stanislav Bezkorovainyi <stanislavbezkor@gmail.com>
Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* fmt + new api endpoint

* Slightly better description of L2->L1 proffs

* Disclaimer for the l1 governance tutorial

* change warning

* Fix typos & add dummy section of bridging

* Use less confusing titles

* mark tutorials as non-working

* capital letters

* Basic tutorial

* Complete and tested full example

* basic fixes

* Light description of the bootloader

* Update docs/dev/guide/custom-aa-tutorial.md

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>

* fix some review comments

* Use more present tense

* minor fix

Co-authored-by: Lyova Potyomkin <lyova.potyomkin@gmail.com>
Co-authored-by: barakshani <35497694+barakshani@users.noreply.github.com>
Co-authored-by: Vlad Bochok <41153528+vladbochok@users.noreply.github.com>
Co-authored-by: vladbochok <vladbochok1@gmail.com>
gitbook-com bot pushed a commit to defigeneration/zksync-web-v2-docs that referenced this pull request Nov 26, 2022
gitbook-com bot pushed a commit to defigeneration/zksync-web-v2-docs that referenced this pull request Dec 20, 2022
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

2 participants