ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix prepareOrderCancellation documentation

Browse Source
This commit is contained in:
Chris Clark
2015-11-23 18:22:54 -08:00
parent 27ed1aadd5
commit 5e720891f5
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/index.md
View File

@@ -2864,7 +2864,7 @@ instructions | [instructions](#transaction-instructions) | *Optional* Instructio
This method returns a promise that resolves with an object with the following structure: This method returns a promise that resolves with an object with the following structure:
<aside class="notice"> <aside class="notice">
All "prepare" methods have the same return type. All "prepare*" methods have the same return type.
</aside> </aside>
Name | Type | Description Name | Type | Description
@@ -2912,7 +2912,7 @@ return api.prepareOrder(address, order)
## prepareOrderCancellation ## prepareOrderCancellation
`prepareOrderCancellation(address: string, sequence: number, instructions: Object): Promise<Object>` `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). Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
@@ -2929,7 +2929,7 @@ instructions | [instructions](#transaction-instructions) | *Optional* Instructio
This method returns a promise that resolves with an object with the following structure: This method returns a promise that resolves with an object with the following structure:
<aside class="notice"> <aside class="notice">
All "prepare" methods have the same return type. All "prepare*" methods have the same return type.
</aside> </aside>
Name | Type | Description Name | Type | Description

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

@@ -13,7 +13,7 @@ Prepare an order transaction. The prepared transaction must subsequently be [sig
This method returns a promise that resolves with an object with the following structure: This method returns a promise that resolves with an object with the following structure:
<aside class="notice"> <aside class="notice">
All "prepare" methods have the same return type. All "prepare*" methods have the same return type.
</aside> </aside>
<%- renderSchema('output/prepare.json') %> <%- renderSchema('output/prepare.json') %>

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

@@ -1,6 +1,6 @@
## prepareOrderCancellation ## prepareOrderCancellation
`prepareOrderCancellation(address: string, sequence: number, instructions: Object): Promise<Object>` `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). Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
@@ -13,7 +13,7 @@ Prepare an order cancellation transaction. The prepared transaction must subsequ
This method returns a promise that resolves with an object with the following structure: This method returns a promise that resolves with an object with the following structure:
<aside class="notice"> <aside class="notice">
All "prepare" methods have the same return type. All "prepare*" methods have the same return type.
</aside> </aside>
<%- renderSchema("output/prepare.json") %> <%- renderSchema("output/prepare.json") %>