edgeX

A perpetual-futures DEX (V2 API), with contracts quoted in USDC. Private endpoints are authenticated by HMAC with the edgeX Perps V2 API Key, API Secret and API Passphrase, and orders are additionally EIP-712-signed with the trading private key (SDK Signer); create both sets of credentials on edgeX and note the account ID before configuring the exchange object. Configurations from the old V1 scheme (only AccountID and the StarkEx private key Secret Key) no longer work: private endpoints report missing V2 credentials, so create V2 API credentials on edgeX and fill in all five fields.

Names and Configuration

exchange.GetName(): Futures_EdgeX (Futures); aliases: EdgeX.

Trading Pairs and Contract Codes

Pair examples: BTC_USDC, ETH_USDC

All edgeX perpetuals are quoted in USDC: write the trading pair as BTC_USDC and so on, with full symbols such as BTC_USDC.swap; BTC_USDT or BTC_USD fails with the error symbol not found: BTCUSDT (or BTCUSD). exchange.SetCurrency() keeps the case as given (exchange.GetCurrency() returns it unchanged), contracts are looked up case-insensitively; symbols in data returned by the exchange (orders, positions, etc.) are upper case, while the Symbol of exchange.GetTicker() keeps the case passed in or currently set, so upper case is recommended.

edgeX lists perpetuals only; contract codes other than swap are rejected.

Exchange-specific IO Commands

The rest of the longer descriptions in the table:

• calcOrderHashAndSign: The argument is a JSON string or object with 10 keys, see the notes. edgeX V2 orders use EIP-712 signatures and do not accept this signature, and this exchange object does not use it when placing orders.
• api: By default the request is HMAC-signed with the API Key, API Secret and API Passphrase (these three V2 credentials must be filled in); with sign set to false (it may also be given directly as the 4th argument) it is sent unsigned, which only works for GET. GET parameters go into the query string, other methods send a JSON body. raw is not a request body but a parameter table (a JSON object, a JSON string or a=1&b=2) that replaces params entirely when non-empty. Orders are not EIP-712-signed for the caller.

For the common commands base and currency see exchange.IO.

Common Usage

Call public endpoints and signed account endpoints with api

            javascript
            
            
function main() {
    // Public endpoints: false as the 4th argument sends the request unsigned (GET only);
    // the data of the response is returned
    var meta = exchange.IO("api", "GET", "/api/v2/public/meta/getMetaData", {}, false)
    var c = null
    for (var i = 0; i < meta.contractList.length; i++) {
        if (meta.contractList[i].contractName == "BTCUSDC") {
            c = meta.contractList[i]
        }
    }
    var p = {contractId: c.contractId}
    var t = exchange.IO("api", "GET", "/api/v2/public/quote/getTicker", p, false)
    Log(c.contractName, "contract ID:", c.contractId, "last:", t[0].lastPrice)
    // Account endpoints are HMAC-signed by default; accountId is in the Info of GetAccount()
    var accountId = exchange.GetAccount().Info.account.id
    var params = {accountId: accountId, size: "50"}
    var orders = exchange.IO("api", "GET", "/api/v2/private/order/getActiveOrderPage", params)
    Log("Open orders:", orders.dataList.length)
}

Compute a legacy (StarkEx) limit-order signature for an old strategy

            javascript
            
            
function main() {
    // Exactly 10 keys; an accountID beyond JavaScript integer precision is a decimal string
    var sig = exchange.IO("calcOrderHashAndSign", JSON.stringify({
        assetIdSynthetic: "0x4554482d3900000000000000000000",
        assetIdCollateral: "0x2ce625e94458d39dd0bf3b45a843544dd4a14b8169045a3a3d15aa564b936c5",
        assetIdFee: "0x2ce625e94458d39dd0bf3b45a843544dd4a14b8169045a3a3d15aa564b936c5",
        isBuyingSynthetic: true,
        amountSynthetic: 10000000,
        amountCollateral: 13020000,
        amountFee: 6250,
        nonce: 676432751,
        accountID: "601416704693633632",
        expirationTimestamp: 484831
    }))
    // 128 hex characters: the first 64 are r, the last 64 are s
    Log("r:", sig.slice(0, 64), "s:", sig.slice(64))
}

Function Support

Not supported (the call fails with an error and returns null): exchange.GetTickers, exchange.GetTrades, exchange.ModifyOrder, exchange.ModifyConditionOrder, exchange.SetMarginLevel.

Served through a fallback:

• exchange.GetRecords: Native periods are 1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 1w, 1M; other periods that are a multiple of 60 seconds are synthesized by the docker from native bars, and the rest (such as second-level periods) are not available (the exchange has no trades endpoint).

Margin, Account and Simulation

Margin mode: edgeX uses cross margin; a position's MarginLevel is the current leverage reported by the exchange. exchange.SetMarginLevel() is not supported; set leverage on edgeX yourself.

Position mode: One-way (net) positions.

Account: The account, positions and orders are queried by the configured AccountID. exchange.GetAssets() lists collateral assets per coin, and exchange.GetAccount() takes the row of the current pair's quote currency (USDC).

Notes

The argument of exchange.IO("calcOrderHashAndSign", json) must have exactly 10 keys: assetIdSynthetic, assetIdCollateral, assetIdFee (hex), isBuyingSynthetic (bool), amountSynthetic, amountCollateral, amountFee, nonce, accountID and expirationTimestamp (integers, or decimal strings; an accountID beyond JavaScript integer precision must be a string). A missing or malformed key reports argument X error, and extra keys report argument error. The signing key is the configured TradingPrivateKey (used as a Stark private key), not the Stark key of an old account; the signing nonce is deterministic (RFC 6979), so the same input always gives the same signature, which differs from the old docker's but is equally valid.