-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
content(docs): adding contribution guide, and getting tokens referenc…
…e, and minors (#144) Co-authored-by: josh <[email protected]>
- Loading branch information
Showing
5 changed files
with
99 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Contribution Guidelines | ||
|
||
This Documentation cannot be built without your skills and knowledge. | ||
|
||
- [Question or Problem?](#question) | ||
- [Issues and Bugs](#issue) | ||
- [Feature Requests](#feature) | ||
- [Submission Guidelines](#submit) | ||
|
||
## <a name="question"></a> Question or Problem? | ||
|
||
Ideally reach out to us on the dev-advocacy-slack channel. | ||
|
||
## <a name="issue"></a> Found a Bug? Or something missing? | ||
|
||
If there is something not right, whether it be the code, grammar or worse a broken link open up an issue and we'll allocate time to fix in upcomming sprints. You of course can also [submit a Pull Request](#submit-pr) with a fix. | ||
|
||
## <a name="feature"></a> Missing a Feature? | ||
|
||
You can _request_ a new feature by creating a feature request issue. | ||
|
||
## <a name="submit-issue"></a> Updating Docs: | ||
|
||
Please create a branch from master, update or add files into the directory you think they're best placed. Open a PR, and someone from the docs team will review. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Token Faucet | ||
|
||
For our test networks, we have a simple token faucet implemented to allow users of the network to get started quickly. You can send it an account address, and it will transfer some test token on it. | ||
|
||
Token Faucets are network specific, depending on the network type they may or may not be deployed. Please check the [networks](../live-networks/) page for specific details. | ||
|
||
The Token Faucet itself is available from the network block explorer (`GET FUNDS` button on the homepage). | ||
|
||
Enter your `fetch...` address in the popup and click *Add funds* button. Wait a few blocks for the transaction to be processed, and you should see it appear along with some funds on your account. | ||
|
||
## Add funds to Wallet using faucet APIs: | ||
|
||
You can also request and get testnet tokens in your wallet using the APIs. | ||
|
||
### Get some atestfet | ||
|
||
```bash | ||
curl -X POST -H 'Content-Type: application/json' -d '{"address":"<address>"}' https://faucet-dorado.fetch.ai/api/v3/claims | ||
``` | ||
|
||
### Get some nanomobx | ||
|
||
```bash | ||
curl -X POST -H 'Content-Type: application/json' -d '{"address":"<address>"}' https://faucet-mobx-dorado.fetch.ai/api/v3/claims | ||
``` | ||
|
||
### Get some ulrn | ||
|
||
```bash | ||
curl -X POST -H 'Content-Type: application/json' -d '{"address":"<address>"}' https://faucet-lrn-dorado.fetch.ai/api/v3/claims | ||
``` | ||
|
||
### Sample response for fund request to faucet | ||
|
||
```text | ||
{"status":"ok","uuid":"<uuid>","target":"<address>"} | ||
``` | ||
|
||
### Check the wallet balance | ||
|
||
```bash | ||
fetchd query bank balances <address> | ||
``` | ||
|
||
```text | ||
balances: | ||
- amount: "<balance>" | ||
denom: atestfet | ||
pagination: | ||
next_key: null | ||
total: "0" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters