crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(website): asset-buyer usage documentation formatting

Browse Source
This commit is contained in:
Brandon Millman 2018-10-22 15:33:55 -07:00
parent be97eebe02
commit 1ba207f1fe
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/website/md/docs/asset_buyer/installation.md
View File

@ -1,10 +1,10 @@
**Install** #### Install
```bash ```bash
yarn add @0x/asset-buyer yarn add @0x/asset-buyer
``` ```
**Import** #### Import
```javascript ```javascript
import { AssetBuyer } from '@0x/asset-buyer'; import { AssetBuyer } from '@0x/asset-buyer';

6
packages/website/md/docs/asset_buyer/usage.md
View File

@ -1,4 +1,4 @@
**Construction** #### Construction
Connecting to a standard relayer API compliant url: Connecting to a standard relayer API compliant url:
@ -16,7 +16,7 @@ const orders = []; // get these from your own API, a relayer, a friend, from any
const assetBuyer = AssetBuyer.getAssetBuyerForProvidedOrders(provider, orders); const assetBuyer = AssetBuyer.getAssetBuyerForProvidedOrders(provider, orders);
``` ```
**Get a quote** #### Get a quote
A [BuyQuote](#types-BuyQuote) object contains enough information to display buy information to an end user A [BuyQuote](#types-BuyQuote) object contains enough information to display buy information to an end user
@ -30,7 +30,7 @@ console.log(quoteInfo.feeAmount); // a portion of the total ethAmount above that
console.log(quoteInfo.ethPerAssetPrice); // the rate that this quote provides (e.g. 0.0035ETH / REP) console.log(quoteInfo.ethPerAssetPrice); // the rate that this quote provides (e.g. 0.0035ETH / REP)
``` ```
**Perform a buy** #### Perform a buy
Pass the [BuyQuote](#types-BuyQuote) object from above back to the assetBuyer in order to initiate the buy transaction Pass the [BuyQuote](#types-BuyQuote) object from above back to the assetBuyer in order to initiate the buy transaction