mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-06 17:27:59 +00:00
e1964ac5ed
* Update schema-validator * Update to ripple-address-codec 4.0.0 * Update ./src/common/hashes/index.ts * Add generateXAddress method * Deprecate generateAddress method * Add unit tests * Add documentation
26 lines
595 B
Plaintext
26 lines
595 B
Plaintext
## generateAddress
|
|
|
|
`generateAddress(options?: object): {address: string, secret: string}`
|
|
|
|
Deprecated: This method returns a classic address. If you do not need the classic address, use `generateXAddress` instead.
|
|
|
|
Generate a new XRP Ledger address and corresponding secret.
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema('input/generate-address.json') %>
|
|
|
|
### Return Value
|
|
|
|
This method returns an object with the following structure:
|
|
|
|
<%- renderSchema('output/generate-address.json') %>
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
return api.generateAddress();
|
|
```
|
|
|
|
<%- renderFixture('responses/generate-address.json') %>
|