ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-20 04:05:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

BREAKING CHANGE: prepareOrderCancellation now takes orderCancellation specification instead of sequence

Browse Source
This commit is contained in:
Chris Clark
2015-11-23 12:45:44 -08:00
parent ef1e9e1b70
commit 7f33d8a71e
6 changed files with 21 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/index.md
View File

@@ -378,7 +378,9 @@ orderSequence | [sequence](#account-sequence-number) | The [account sequence num
```json
23
{
"orderSequence": 23
}
```
@@ -2904,7 +2906,7 @@ Prepare an order cancellation transaction. The prepared transaction must subsequ
Name | Type | Description
---- | ---- | -----------
address | [address](#ripple-address) | The address of the account that is creating the transaction.
sequence | [sequence](#account-sequence-number) | The account sequence number of the transaction that created the order to cancel.
orderCancellation | [orderCancellation](#order-cancellation) | The specification of the order cancellation to prepare.
instructions | [instructions](#transaction-instructions) | *Optional* Instructions for executing the transaction
### Return Value
@@ -2927,7 +2929,7 @@ instructions | object | The instructions for how to execute the transaction afte
```javascript
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
const sequence = 123;
const orderCancellation = {orderSequence: 123};
return api.prepareOrderCancellation(address, sequence)
.then(prepared => {/* ... */});
```

2
docs/src/prepareOrderCancellation.md.ejs
View File

@@ -22,7 +22,7 @@ All "prepare" methods have the same return type.
```javascript
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
const sequence = 123;
const orderCancellation = {orderSequence: 123};
return api.prepareOrderCancellation(address, sequence)
.then(prepared => {/* ... */});
```