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

docs: [StarkGate] Add procedures for Depositing and Withdrawing. #1236

Merged
merged 17 commits into from
May 9, 2024

Conversation

stoobie
Copy link
Collaborator

@stoobie stoobie commented Apr 30, 2024

Description of the Changes

This PR adds procedures for Depositing and Withdrawing using StarkGate with a block explorer.

PR Preview URL

Depositing funds
Withdrawing funds

Check List

  • Changes have been done against main branch, and PR does not conflict
  • PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is Reviewable

@stoobie stoobie requested a review from natan-granit April 30, 2024 12:47
@stoobie stoobie self-assigned this Apr 30, 2024
Copy link

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

Copy link
Collaborator

@natan-granit natan-granit left a comment

Choose a reason for hiding this comment

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

Few comments:

  1. In the case of initiate withdrawal, we should change back to the function that includes the token as a parameter.
  2. Lets add an bridge addresses section in the overview, before the tokens.
  3. Would be nice to have an example with a block explorer also in smart deposit.

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

@stoobie
Copy link
Collaborator Author

stoobie commented May 5, 2024

  1. In the case of initiate withdrawal, we should change back to the function that includes the token as a parameter.

Wiil do.

  1. Lets add an bridge addresses section in the overview, before the tokens.

See #1241

  1. Would be nice to have an example with a block explorer also in smart deposit.

Let's make this a separate PR so as to expedite this one without delay. WDYT?

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

2 similar comments
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: recipent should be recipient
--> ./components/Starknet/modules/tools/pages/starkgate-withdrawing.adoc:11:54
|
11 | Subsequently, the funds should be transferred to the recipent's Ethereum address.
| ^^^^^^^^
|

Please fix the typo, commit and push!

1 similar comment
@starknet-bot
Copy link
Collaborator

Oops, your pull request failed to pass the Typo tests stage :( . see the result:
error: recipent should be recipient
--> ./components/Starknet/modules/tools/pages/starkgate-withdrawing.adoc:11:54
|
11 | Subsequently, the funds should be transferred to the recipent's Ethereum address.
| ^^^^^^^^
|

Please fix the typo, commit and push!

@stoobie stoobie force-pushed the steve/starkgate/add_deposit_withdrawal branch from 5aca145 to fd31263 Compare May 8, 2024 14:06
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

@stoobie stoobie force-pushed the steve/starkgate/add_deposit_withdrawal branch from 0aa8061 to da3681c Compare May 8, 2024 15:16
@starknet-bot
Copy link
Collaborator

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1236/documentation/ .

Copy link
Collaborator

@natan-granit natan-granit left a comment

Choose a reason for hiding this comment

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

LGTM

@stoobie stoobie merged commit a24cdda into main May 9, 2024
1 check passed
@stoobie stoobie deleted the steve/starkgate/add_deposit_withdrawal branch May 9, 2024 07:20
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.

3 participants