mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-06 17:27:59 +00:00
31 lines
883 B
Plaintext
31 lines
883 B
Plaintext
## prepareOrderCancellation
|
|
|
|
`prepareOrderCancellation(address: string, orderCancellation: object, instructions: object): Promise<object>`
|
|
|
|
Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema("input/prepare-order-cancellation.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 orderCancellation = {orderSequence: 123};
|
|
return api.prepareOrderCancellation(address, orderCancellation)
|
|
.then(prepared => {/* ... */});
|
|
```
|
|
|
|
<%- renderFixture("responses/prepare-order-cancellation.json") %>
|