Neg Risk Flag Resolution (#119)

* neg risk flag resolution

* update createMarketBuyOrder

* update version

Makefile

@@ -2,7 +2,7 @@
 build:
 	@echo "Building ts code..."
 	rm -rf dist
-	tsc --module commonjs
+	yarn tsc --module commonjs
 
 .PHONY: test
 test:

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@polymarket/clob-client",
     "description": "Typescript client for Polymarket's CLOB",
-    "version": "4.8.0",
+    "version": "4.8.1",
     "contributors": [
         {
             "name": "Jonathan Amenechi",

src/client.ts

@@ -38,6 +38,7 @@ import {
     MarketReward,
     UserRewardsEarning,
     TotalUserEarning,
+    NegRisk,
 } from "./types";
 import { createL1Headers, createL2Headers } from "./headers";
 import {
@@ -83,6 +84,7 @@ import {
     GET_BALANCE_ALLOWANCE,
     IS_ORDER_SCORING,
     GET_TICK_SIZE,
+    GET_NEG_RISK,
     ARE_ORDERS_SCORING,
     GET_SIMPLIFIED_MARKETS,
     GET_SAMPLING_SIMPLIFIED_MARKETS,
@@ -121,6 +123,8 @@ export class ClobClient {
 
     readonly tickSizes: TickSizes;
 
+    readonly negRisk: NegRisk;
+
     readonly geoBlockToken?: string;
 
     constructor(
@@ -148,6 +152,7 @@ export class ClobClient {
             funderAddress,
         );
         this.tickSizes = {};
+        this.negRisk = {};
         this.geoBlockToken = geoBlockToken;
     }
 
@@ -215,6 +220,19 @@ export class ClobClient {
         return this.tickSizes[tokenID];
     }
 
+    public async getNegRisk(tokenID: string): Promise<boolean> {
+        if (tokenID in this.negRisk) {
+            return this.negRisk[tokenID];
+        }
+
+        const result = await this.get(`${this.host}${GET_NEG_RISK}`, {
+            params: { token_id: tokenID },
+        });
+        this.negRisk[tokenID] = result.neg_risk as boolean;
+
+        return this.negRisk[tokenID];
+    }
+
     /**
      * Calculates the hash for the given orderbook
      * @param orderbook
@@ -524,7 +542,6 @@ export class ClobClient {
         const { tokenID } = userOrder;
 
         const tickSize = await this._resolveTickSize(tokenID, options?.tickSize);
-        const negRisk = options?.negRisk ?? false;
 
         if (!priceValid(userOrder.price, tickSize)) {
             throw new Error(
@@ -534,6 +551,8 @@ export class ClobClient {
             );
         }
 
+        const negRisk = options?.negRisk ?? await this.getNegRisk(tokenID);
+
         return this.orderBuilder.buildOrder(userOrder, {
             tickSize,
             negRisk,
@@ -542,14 +561,13 @@ export class ClobClient {
 
     public async createMarketBuyOrder(
         userMarketOrder: UserMarketOrder,
-        options?: CreateOrderOptions,
+        options?: Partial<CreateOrderOptions>,
     ): Promise<SignedOrder> {
         this.canL1Auth();
 
         const { tokenID } = userMarketOrder;
 
         const tickSize = await this._resolveTickSize(tokenID, options?.tickSize);
-        const negRisk = options?.negRisk ?? false;
 
         if (!userMarketOrder.price) {
             userMarketOrder.price = await this.calculateMarketPrice(
@@ -567,6 +585,8 @@ export class ClobClient {
             );
         }
 
+        const negRisk = options?.negRisk ?? await this.getNegRisk(tokenID);
+
         return this.orderBuilder.buildMarketOrder(userMarketOrder, {
             tickSize,
             negRisk,

src/endpoints.ts

@@ -24,6 +24,7 @@ export const GET_SPREADS = "/spreads";
 export const GET_LAST_TRADE_PRICE = "/last-trade-price";
 export const GET_LAST_TRADES_PRICES = "/last-trades-prices";
 export const GET_TICK_SIZE = "/tick-size";
+export const GET_NEG_RISK = "/neg-risk";
 
 // Order endpoints
 export const POST_ORDER = "/order";

src/types.ts

@@ -332,6 +332,10 @@ export interface TickSizes {
     [tokenId: string]: TickSize;
 }
 
+export interface NegRisk {
+    [tokenId: string]: boolean;
+}
+
 export interface PaginationPayload {
     readonly limit: number;
     readonly count: number;