YNU-508 & YNU-509: Adding, Intro, getting started and core concepts section to Learn #84
Conversation
ihsraham
changed the title
ihsraham
changed the title
docs/learn/index.md
Outdated
|
|
||
| - **[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.
Don't mention it, as it's outdated
There was a problem hiding this comment.
| @@ -0,0 +1,9 @@ | |||
| { | |||
There was a problem hiding this comment.
@philanton @nksazonov I think we can remove deprecated docs completely from here
| 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.
It should be either prod (wss://clearnet.yellow.com/ws) or sandbox (wss://clearnet-sandbox.yellow.com/ws)
There was a problem hiding this comment.
| npx tsx scripts/create-wallet.ts | ||
| ``` | ||
|
|
||
| ### Get Test Tokens |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
| # 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.
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
There was a problem hiding this comment.
|
|
||
| --- | ||
|
|
||
| ## Supported Networks |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
| weights: [40, 40, 50], // Voting power | ||
| quorum: 80, // Required weight for state updates | ||
| challenge: 3600, // Dispute window |
There was a problem hiding this comment.
Comments are not aligned
There was a problem hiding this comment.
| console.log('✓ Channel prepared:', channel_id); | ||
|
|
||
| // Sign the state with your participant key | ||
| const userSignature = await signPackedState(channel_id, state); |
There was a problem hiding this comment.
A real function for this signPackedState rather than a theoretical placeholder might help people even more.
Uh oh!
There was an error while loading. Please reload this page.