Files
xahau.js/docs/src/generateFaucetWallet.md.ejs
Nathan Nichols ec121ee62d docs: Add documentation for generateFaucetWallet() (#1529)
* docs: Add documentation for generateFaucetWallet()
2021-08-17 14:32:06 -05:00

19 lines
419 B
Plaintext

## generateFaucetWallet
`generateFaucetWallet(onTestnet = true)`
Calls the Testnet or Devnet faucet API in order to generate a new, random wallet with some amount of test XRP. This is for testing purposes only.
### Example
**Request**
Create a new wallet on the Testnet:
```javascript
const wallet = await api.generateFaucetWallet()
```
**Response**
<%- renderFixture('responses/generate-faucet-wallet.json') %>