Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

[asset-buyer][monorepo-scripts][website] Add asset-buyer documentation #1139

Merged
merged 8 commits into from
Oct 17, 2018

Conversation

BMillman19
Copy link
Contributor

Add documentation for @0xproject/asset-buyer to the website.

Testing instructions

http://staging-0xproject.s3-website-us-east-1.amazonaws.com/docs/asset-buyer

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist:

  • Prefix PR title with [WIP] if necessary.
  • Prefix PR title with bracketed package name(s) corresponding to the changed package(s). For example: [sol-cov] Fixed bug.
  • Add tests to cover changes as needed.
  • Update documentation as needed.
  • Add new entries to the relevant CHANGELOG.jsons.

@BMillman19 BMillman19 force-pushed the feature/website/asset-buyer-docs branch from f562dfa to aa1085c Compare October 16, 2018 17:11
Copy link
Contributor

@fragosti fragosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link didn't work... maybe someone deployed to staging?

A [BuyQuote](#types-BuyQuote) object contains enough information to display buy information to an end user

```typescript
const erc20TokenAddress = '0x5fa3c....';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not the entire address? The rest of the code looks like it works.

Pass the [BuyQuote](#types-BuyQuote) object from above back to the assetBuyer in order to initiate the buy transaction

```typescript
const txHash = await assetBuyer.executeBuyQuoteAsync(buyQuote); // the hash of the transaction submitted to the Ethereum network
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think it would be nice to have a executeBuyQuoteAsyncAndWaitForTransactionMined or something.

Copy link
Contributor

@fragosti fragosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway looks good to me. Maybe @fabioberger has some comments.

@coveralls
Copy link

coveralls commented Oct 16, 2018

Coverage Status

Coverage remained the same at 84.688% when pulling 81505ba on feature/website/asset-buyer-docs into c767404 on development.

* development: (31 commits)
  Update CODEOWNERS
  Update CODEOWNERS
  Update CODEOWNERS
  Add leo to CODEOWNERS on some packages
  fix(monorepo-scripts): Format date as UTC not local time.
  Bump max bundle size for instant
  fix: dont use enum string as type as typedoc gets confused
  feat: export AssetData from order-utils
  feat: export AssetData from utils
  chore: temporarily increase the bundle size for instant
  Remove order-utils from dependencies
  Run tests on circle CI
  Add tests for format and use toFixed instead of round for usd
  Remove expiry buffer seconds option from AssetBuyer init
  Add ts-optchain and use it instead of lodash get
  Hide USD price when ETH-USD price is not available
  Rename OrderDetailsRow to EthAmountRow
  fix: add Steve's github account to about page, and capitalize AppFolio correctly
  Put boundNoop in a util file
  Add tnxHash to buy button callbacks
  ...
@BMillman19 BMillman19 merged commit b2012bf into development Oct 17, 2018
@BMillman19 BMillman19 deleted the feature/website/asset-buyer-docs branch October 17, 2018 17:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants