@dydxprotocol/v4-client-js 1.16.2 → 1.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dydxprotocol/v4-client-js",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "description": "General client library for the new dYdX system (v4 decentralized)",
   "main": "build/src/index.js",
   "scripts": {

package/src/clients/modules/account.ts

@@ -265,6 +265,7 @@ export default class AccountClient extends RestClient {
     });
   }
 
+  // limit applies to the subaccount ticks, so expect number of results to be much lower than limit
   async getParentSubaccountNumberHistoricalPNLs(
     address: string,
     parentSubaccountNumber: number,

package/src/clients/modules/utility.ts

@@ -1,4 +1,9 @@
-import type { ComplianceResponse, HeightResponse, TimeResponse } from '../types';
+import type {
+  ComplianceResponse,
+  ComplianceV2Response,
+  HeightResponse,
+  TimeResponse,
+} from '../types';
 import RestClient from './rest';
 
 export default class UtilityClient extends RestClient {
@@ -29,4 +34,14 @@ export default class UtilityClient extends RestClient {
     const uri = '/v4/screen';
     return this.get(uri, { address });
   }
+
+  /**
+   * @description Screen an address to see if it is restricted
+   * @param {string} address evm or dydx address
+   * @returns {ComplianceResponse} whether the specified address is restricted
+   */
+  async complianceScreen(address: string): Promise<ComplianceV2Response> {
+    const uri = `/v4/compliance/screen/${address}`;
+    return this.get(uri);
+  }
 }

package/src/clients/types.ts

@@ -105,6 +105,30 @@ export interface HeightResponse {
 
 export interface ComplianceResponse {
   restricted: boolean;
+  reason?: string;
+}
+
+export enum ComplianceReason {
+  MANUAL = 'MANUAL',
+  US_GEO = 'US_GEO',
+  CA_GEO = 'CA_GEO',
+  GB_GEO = 'GB_GEO',
+  SANCTIONED_GEO = 'SANCTIONED_GEO',
+  COMPLIANCE_PROVIDER = 'COMPLIANCE_PROVIDER',
+}
+
+export enum ComplianceStatus {
+  COMPLIANT = 'COMPLIANT',
+  FIRST_STRIKE_CLOSE_ONLY = 'FIRST_STRIKE_CLOSE_ONLY',
+  FIRST_STRIKE = 'FIRST_STRIKE',
+  CLOSE_ONLY = 'CLOSE_ONLY',
+  BLOCKED = 'BLOCKED',
+}
+
+export interface ComplianceV2Response {
+  status: ComplianceStatus;
+  reason?: ComplianceReason;
+  updatedAt?: string;
 }
 
 // ------------ Squid ------------ //