search

dydxprotocol / perpetual

Ethereum Smart Contracts and TypeScript library used for the dYdX Perpetual Contracts
Apache License 2.0
170 stars 66 forks source link

Documentation seems to contain minor errors #255

Open michael-spengler opened 3 years ago

michael-spengler commented 3 years ago 
const result = await perpetual.api.getAccountBalances({
  account: '0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5',
});

--> "account" shall be replaced by "accountOwner"

see https://docs.dydx.exchange/#perpetual-get-account-balances

If you let me know where I shall change such things, I can do so as a contributor as I like DyDx. If you would like to support the general DeFi Package, feel free to fix stuff like that: https://github.com/michael-spengler/decentralized-finance/issues/7#issuecomment-764050448

:)

michael-spengler commented 3 years ago

@BrendanChou It would be cool, if we could provide role model usage examples instead of pseudo code like when it comes to order matching.

I can offer to provide that within the DeFi Package. It would be cool if you could link to the DeFi Package in return in order to foster a mutually supportive collaboration.