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: Add new topic on migrating from DAI v0 to DAI. #1181

Merged
merged 4 commits into from
Mar 17, 2024

Conversation

stoobie
Copy link
Collaborator

@stoobie stoobie commented Mar 14, 2024

Description of the Changes

Please add a detailed description of the change, whether it's an enhancement or a bugfix.
If the PR is related to an open issue please link to it.

PR Preview URL

After you push a commit to this PR, a preview is built and a URL to the root of the preview appears in the comment feed.

Paste here the specific URL(s) of the content that this PR addresses.

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 March 14, 2024 13:57
Copy link

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1181/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.

I left some comments


You can withdraw old DAI tokens (DAI v0) without any limitation. Depositing using the DAI v0 bridge are disabled. You are encouraged to migrate to the new DAI token. You can use swap services on Starknet to swap DAI v0 for DAI.

You are encouraged to migrate your old DAI (DAI v0) tokens for new DAI tokens.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should be deleted, it is repeated

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

[id="dai_token_migration"]
= Migrating DAI tokens on Starknet to the new DAI contract

Following link:https://twitter.com/MakerDAO/status/1746977683190251591?s=20
Copy link
Collaborator

Choose a reason for hiding this comment

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

In the preview, the link was not working, it was just there as text

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

@@ -23,6 +23,7 @@
**** xref:starkgate-adding_a_token.adoc[Adding a token]
**** xref:starkgate-cancelling a deposit.adoc[Cancelling a deposit]
**** xref:starkgate-estimating_fees.adoc[Estimating StarkGate fees]
**** xref:dai_token_migration.adoc[Migrating DAI tokens on Starknet to the new DAI contract]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Lets change the title to:
DAI Migration

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done. Although I'm not thrilled. This topic the way it was originally written is more of an announcement. If we're adding it to technical documentation, telling people how to migrated, it should really be a procedural heading like other procedural headings that end with "ing".

Copy link
Collaborator

Choose a reason for hiding this comment

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

About the title - I found the one you suggested a bit clumsy. Can you think of a compromise?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How about "Migrating DAI v0 to DAI" for the topic title, and I'll change the procedure heading to "Procedure", like other Procedures?

On January 25th, StarkWare launched a new set of DAI bridge and token contracts under StarkGate, written in Cairo. This new DAI token will retain the same contract ’symbol’ and ’name’ as the existing one. To differentiate between the two on Apps and other UIs, we refer to the old DAI as “DAI v0” and the new DAI simply as “DAI.”


== Migrate from v0 Starknet DAI tokens to new Starknet DAI tokens
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would prefer:
Migrate DAI v0 to DAI or Migrate your DAI v0
I don't like to refer to the new DAI as such. It is just DAI. Also, it is not Starknet DAI. It is just DAI. We chose names, I want to use them.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ok, but I think it would be better to be as specific as possible. The naming you chose might be appropriate for conversations and targeted communications, but this page will show up in search results, and it'll probably generate false positives if we don't specify that it's referring to Starknet. I'll add more details in the :description: metadata.

Copy link
Collaborator Author

@stoobie stoobie left a comment

Choose a reason for hiding this comment

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

@natan-granit I made several fixes and comments.

[id="dai_token_migration"]
= Migrating DAI tokens on Starknet to the new DAI contract

Following link:https://twitter.com/MakerDAO/status/1746977683190251591?s=20
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.


You can withdraw old DAI tokens (DAI v0) without any limitation. Depositing using the DAI v0 bridge are disabled. You are encouraged to migrate to the new DAI token. You can use swap services on Starknet to swap DAI v0 for DAI.

You are encouraged to migrate your old DAI (DAI v0) tokens for new DAI tokens.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

On January 25th, StarkWare launched a new set of DAI bridge and token contracts under StarkGate, written in Cairo. This new DAI token will retain the same contract ’symbol’ and ’name’ as the existing one. To differentiate between the two on Apps and other UIs, we refer to the old DAI as “DAI v0” and the new DAI simply as “DAI.”


== Migrate from v0 Starknet DAI tokens to new Starknet DAI tokens
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ok, but I think it would be better to be as specific as possible. The naming you chose might be appropriate for conversations and targeted communications, but this page will show up in search results, and it'll probably generate false positives if we don't specify that it's referring to Starknet. I'll add more details in the :description: metadata.

+
StarkGate automatically issues the new DAI.

* Swap your DAI v0 for DAI using an L2 swap app or aggregator within the Starknet ecosystem.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@natan-granit Are there any more details than this? Is there an existing swap app or aggregator that we can point to? Or a page that lists all of them?

Copy link
Collaborator

@natan-granit natan-granit Mar 17, 2024

Choose a reason for hiding this comment

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

There are at least 2 I know of - should we add and be responsible for changing in the future?
LayerSwap - https://www.layerswap.io/migration/DAI
Ekubo - https://app.ekubo.org/?amount=1000&inputCurrency=DAI&outputCurrency=DAIv2

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think that we need to give some guidance. Are there, or do you think there will be, more than these two?

Do you anticipate that these two will change?

Is there a search term that we can suggest to locate apps like this?

Copy link

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

Copy link

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

Copy link

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1181/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 ccfc4aa into main Mar 17, 2024
3 checks passed
@stoobie stoobie deleted the steve/starkgate/new_DAI branch March 17, 2024 12:30
xiaolou86 pushed a commit to xiaolou86/starknet-docs that referenced this pull request Apr 7, 2024
* Add new topic on migrating from DAI v0 to DAI.

* SME comments + meta info

* Playing with title

* Added Ekubo and Layerswap as sample swap apps
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.

2 participants