Add testnet docs #370
Add testnet docs #370
Conversation
docs/testnet.md
Outdated
| docker run -it -e NAME=YOUR_NAME interledgerrs/testnet-bundle | ||
| ``` | ||
|
|
||
| The above will configure and run the Interledger node, the ETH & XRP engines, and connect to the testnet. Try making some payments! |
There was a problem hiding this comment.
This should link to the bottom of the page and make it clearer that there are instructions for doing that after
docs/testnet.md
Outdated
|
|
||
| Testing is an absolute requirement when deploying software. Because of that, the Interledger.rs repository ensures that all its features are thoroughly tested. However, network conditions such as latency and bandwidth are not the same as in the real world when running unit and integration tests. In order to simulate that, we leverage test networks (testnets). | ||
|
|
||
| Testnets are networks where the topology is similar to the expected real world network topology, but the funds used are not "real" (i.e. do not hold any real-world value). Succesful testnet runs can greatly increase our confidence in the reliability of our software, before deploying it to mainnet where it will be able to control large amounts of money. |
There was a problem hiding this comment.
I'm not sure we need this section. The testnet is less about testing our software and more about allowing users to interact with the software and APIs without using real money
docs/testnet.md
Outdated
| |key|value| | ||
| |---|---| | ||
| |Username|user_qjex4cfk| | ||
| |PassKey|us5w0zt1br4ft| |
There was a problem hiding this comment.
That's a bit awkward because the API still uses the old variable names:
https://stage.xpring.io/api/accounts/xrp
{"http_endpoint": "https://rs3.xpring.dev/ilp", "passkey": "172thg05wk77y", "btp_endpoint": "btp+wss://rs3.xpring.dev/ilp/btp", "asset_scale": 9, "node": "rs3.xpring.dev", "asset_code": "XRP", "username": "user_1bpsi536", "payment_pointer": "$rs3.xpring.dev/accounts/user_1bpsi536/spsp"}
https://stage.xpring.io/ilp-testnet-creds
We should change the interpreter variable names If the API variable names change https://github.com/interledger-rs/interledger-rs/blob/dbe15247478d9ee6dfbef3127488441fd130d66d/crates/ilp-cli/src/interpreter.rs#L335
docs/testnet.md
Outdated
|
|
||
| ```bash | ||
| curl \ | ||
| -H "Authorization: Bearer ${Username}:${PassKey}" \ |
docs/testnet.md
Outdated
|
|
||
| You should now be able to send and receive payments through the testnet node. | ||
|
|
||
| ## Try Out Payments |
There was a problem hiding this comment.
Somewhere in here we should show how to get access to the ilp-cli
As title. Rewords the doc from #314 and uses the
ilp-cliinstead of manual curl requests.