ainsleys / derivadex-api-docs Goto Github PK

Making a deposit

• Language examples for making a deposit will be very helpful.
• Improve the documentation around finding the deposit ABI and DerivaDEX contract address. The ABI is somewhat TBD since we don't currently include this within our packages, but we can include the raw JSON at a minimum.
• I think the copy in this section could be clarified a bit. Not high priority, and I'm happy to provide more detailed suggestions when time permits
• We should make a note of the fact that valid deposit collateral is curated by the smart contract and is managed by governance. Ultimately, we should include details about how to find the list of valid collateral within this section.

Place Order

This is low-priority, but ultimately we should have a section that clearly outlines the validation that is performed on orders in plain english (basically a really clear primer on OMF and IMF calculations).

Feedback: We are now using the verifyingContract field at your suggestion :)

currently:

Domain separator for mainnet. DO NOT modify these parameters.

{
    "name": "DerivaDEX",
    "version": "1",
    "chainId":  1
}

I don't know where to modify this.

Strategy Update

A few words detailing how strategy update updates should be processed by end users would be helpful in differentiating Partial and Update events.

Connecting to the Websocket API

• "DerivaDEX API" should be abi-encoded before hashing, not encoded into a bytes32 value as we do elsewhere.
• We should link to some documentation/providers for eth_sign
• We should outline the format of the signature query parameter: R, S, V