mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-06 13:55:49 +00:00
facc513a52
- See https://github.com/ripple/rippled/pull/2245 * Add support for depositAuth flag * Upgrade ripple-binary-codec to 0.1.13
31 lines
878 B
Plaintext
31 lines
878 B
Plaintext
## prepareCheckCreate
|
|
|
|
`prepareCheckCreate(address: string, checkCreate: Object, instructions: Object): Promise<Object>`
|
|
|
|
Prepare a Check creation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema('input/prepare-check-create.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 checkCreate = <%- importFile('test/fixtures/requests/prepare-check-create.json') %>;
|
|
return api.prepareCheckCreate(address, checkCreate).then(prepared =>
|
|
{/* ... */});
|
|
```
|
|
|
|
<%- renderFixture('responses/prepare-check-create.json') %>
|