mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-04-29 15:37:50 +00:00
4e49b6a99c
Use example.com instead of ripple.com Co-authored-by: Elliot Lee <github.public@intelliot.com>
31 lines
833 B
Plaintext
31 lines
833 B
Plaintext
## prepareSettings
|
|
|
|
`prepareSettings(address: string, settings: object, instructions: object): Promise<object>`
|
|
|
|
Prepare a settings transaction. The prepared transaction can then be [signed](#sign) and [submitted](#submit).
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema('input/prepare-settings.json') %>
|
|
|
|
### Return Value
|
|
|
|
This method returns a promise that resolves with an object with the following structure:
|
|
|
|
<aside class="notice">
|
|
All "prepare*" methods have the same return type.
|
|
</aside>
|
|
|
|
<%- renderSchema('output/prepare.json') %>
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
|
|
const settings = <%- importFile('test/fixtures/requests/prepare-settings.json') %>;
|
|
return api.prepareSettings(address, settings)
|
|
.then(prepared => {/* ... */});
|
|
```
|
|
|
|
<%- renderFixture('requests/prepare-settings.json') %>
|