-
Notifications
You must be signed in to change notification settings - Fork 3
YNU-508 & YNU-509: Adding, Intro, getting started and core concepts section to Learn #84
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
base: master
Are you sure you want to change the base?
Conversation
|
|
||
| - **[Build](/docs/build/quick-start)** — Implement complete Yellow Applications | ||
| - **[Protocol Reference](/docs/protocol/introduction)** — Authoritative protocol specification | ||
| - **[API Reference](/docs/api-reference)** — SDK and RPC method documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't mention it, as it's outdated
| @@ -0,0 +1,9 @@ | |||
| { | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@philanton @nksazonov I think we can remove deprecated docs completely from here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't hesitate
| BASE_RPC_URL=https://base-sepolia.g.alchemy.com/v2/YOUR_KEY | ||
|
|
||
| # Clearnode WebSocket endpoint | ||
| CLEARNODE_WS_URL=wss://clearnode.yellow.com/ws |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be either prod (wss://clearnet.yellow.com/ws) or sandbox (wss://clearnet-sandbox.yellow.com/ws)
| npx tsx scripts/create-wallet.ts | ||
| ``` | ||
|
|
||
| ### Get Test Tokens |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test tokens are available only on Sandbox deployment. The following command can be used to request ytest.USD on user's unified balance:
curl -XPOST https://clearnet-sandbox.yellow.com/faucet/requestTokens -d '{"userAddress":"<user_address>"}'
Once requested, you won't need to perform any off-chain operation as tokens are already on unified balance.
| # Clearnode WebSocket endpoint | ||
| CLEARNODE_WS_URL=wss://clearnode.yellow.com/ws | ||
|
|
||
| # Contract addresses (get from Yellow Network docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are not necessary to be specified here, as once connected to clearnode get_config endpoint can be used to find all supported chains and addresses of the contracts deployed there
|
|
||
| --- | ||
|
|
||
| ## Supported Networks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do not mention them here, they should be either on the separate page or you can just say that they can find all supported chains by calling get_config endpoint on Clearnode
| weights: [40, 40, 50], // Voting power | ||
| quorum: 80, // Required weight for state updates | ||
| challenge: 3600, // Dispute window |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments are not aligned
Uh oh!
There was an error while loading. Please reload this page.