-
Notifications
You must be signed in to change notification settings - Fork 465
[asset-buyer][monorepo-scripts][website] Add asset-buyer documentation #1139
Conversation
f562dfa
to
aa1085c
Compare
There was a problem hiding this 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....'; |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
* 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 ...
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
Checklist:
[WIP]
if necessary.[sol-cov] Fixed bug
.