search

dydxprotocol / v4-documentation

https://v4-teacher.vercel.app
Other
12 stars 34 forks source link

Add guides section #138

Closed 2dpetkov closed 6 months ago

2dpetkov commented 7 months ago

The dYdX Ops subDAO suggest that the dYdX Chain Software documentation starts hosting some of the guides are currently available at docs.dydx.trade (the subDAO's fork of this repository):

vercel[bot] commented 7 months ago

@2dpetkov is attempting to deploy a commit to the dYdX Trading Team on Vercel.

A member of the Team first needs to authorize it.

jiajames commented 6 months ago

Could you help to clarify the difference of instructions for the "DYDX token holder" deployment and testnet deployment? Thanks

2dpetkov commented 6 months ago

Thanks, @jiajames ! Here's what I think I can do for each guide, to make the guides align with your comment

How to send USDC from Ethereum to dYdX Chain

  1. reword the title to not be about USDC and any chain in particular, but rather be about sending over the collateral token
  2. add a "deployments" section in the beginning of the page, that points to the collateral token contracts for the different deployments
  3. make sure it's explicitly stated that the screenshots and example commands are for the dYdX Token Holders' deployment

How to set up a full node

  1. add a "deployments" section in the beginning of the page, that shows Chain ID, example home folder, example moniker, link to resources for seeds and RPC endpoints to download genesis.json from, - for the different deployments
  2. make sure it's explicitly stated that the screenshots and example commands are for the dYdX Token Holders' deployment

How to uncross the orderbook

I think this one is ready as is - it is already referring to Testnet

jiajames commented 6 months ago
  1. reword the title to not be about USDC and any chain in particular, but rather be about sending over the collateral token

sounds good, maybe "collateral/native" token is better

otherwise, sounds good! maybe one helpful thing would be to update the screenshot names also to indexer it is only for token holder deployment

vercel[bot] commented 6 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
v4-documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 11, 2024 11:21pm
2dpetkov commented 6 months ago

Hey, @jiajames Thanks for the suggestions!

How to send USDC from Ethereum to dYdX

Since the guide is not for depositing native token, and USDC is available on Sepolia, I've added the related Sepolia contract address in the Deployments section and only removed "chain" from the guide title: commit

How to set up a full node

Adding a Deployments would be very confusing, since it would contain links to the same pages - Network Constants and Resources. So instead, I added disclaimer note at the beginning of each step: commit

Comments on this new approach are welcome!