@drift-labs/common 1.0.0

package/lib/Config.d.ts

@@ -0,0 +1,26 @@
+import { SpotMarketConfig, DriftEnv, initialize, PerpMarketConfig } from '@drift-labs/sdk';
+export declare const Config: {
+    initialized: boolean;
+    spotMarketsLookup: SpotMarketConfig[];
+    perpMarketsLookup: PerpMarketConfig[];
+    sdkConfig: ReturnType<typeof initialize>;
+};
+export declare const Initialize: (env: DriftEnv) => {
+    ENV: DriftEnv;
+    PYTH_ORACLE_MAPPING_ADDRESS: string;
+    DRIFT_PROGRAM_ID: string;
+    JIT_PROXY_PROGRAM_ID?: string;
+    DRIFT_ORACLE_RECEIVER_ID: string;
+    USDC_MINT_ADDRESS: string;
+    SERUM_V3: string;
+    PHOENIX: string;
+    OPENBOOK: string;
+    V2_ALPHA_TICKET_MINT_ADDRESS: string;
+    PERP_MARKETS: PerpMarketConfig[];
+    SPOT_MARKETS: SpotMarketConfig[];
+    MARKET_LOOKUP_TABLE: string;
+    MARKET_LOOKUP_TABLES: string[];
+    SERUM_LOOKUP_TABLE?: string;
+    PYTH_PULL_ORACLE_LOOKUP_TABLE?: string;
+    SB_ON_DEMAND_PID: import("@solana/web3.js").PublicKey;
+};

package/lib/Config.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Initialize = exports.Config = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+exports.Config = {
+    initialized: false,
+    spotMarketsLookup: [],
+    perpMarketsLookup: [],
+    sdkConfig: undefined,
+};
+const Initialize = (env) => {
+    const SDKConfig = (0, sdk_1.initialize)({ env });
+    const maxSpotMarketIndex = Math.max(...SDKConfig.SPOT_MARKETS.map((market) => market.marketIndex));
+    const maxPerpMarketIndex = Math.max(...SDKConfig.PERP_MARKETS.map((market) => market.marketIndex));
+    const spotMarkets = new Array(maxSpotMarketIndex);
+    const markets = new Array(maxPerpMarketIndex);
+    SDKConfig.SPOT_MARKETS.forEach((spotMarket) => {
+        spotMarkets[spotMarket.marketIndex] = spotMarket;
+    });
+    SDKConfig.PERP_MARKETS.forEach((perpMarket) => {
+        markets[perpMarket.marketIndex] = perpMarket;
+    });
+    exports.Config.spotMarketsLookup = spotMarkets;
+    exports.Config.perpMarketsLookup = markets;
+    exports.Config.initialized = true;
+    return SDKConfig;
+};
+exports.Initialize = Initialize;
+//# sourceMappingURL=Config.js.map

package/lib/Config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.js","sourceRoot":"","sources":["../src/Config.ts"],"names":[],"mappings":";;;AAAA,yCAKyB;AAEZ,QAAA,MAAM,GAKf;IACH,WAAW,EAAE,KAAK;IAClB,iBAAiB,EAAE,EAAE;IACrB,iBAAiB,EAAE,EAAE;IACrB,SAAS,EAAE,SAAS;CACpB,CAAC;AAEK,MAAM,UAAU,GAAG,CAAC,GAAa,EAAE,EAAE;IAC3C,MAAM,SAAS,GAAG,IAAA,gBAAU,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAEtC,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAClC,GAAG,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAC7D,CAAC;IAEF,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAClC,GAAG,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAC7D,CAAC;IAEF,MAAM,WAAW,GAAG,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE9C,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC7C,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QAC7C,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,cAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC;IACvC,cAAM,CAAC,iBAAiB,GAAG,OAAO,CAAC;IAEnC,cAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IAE1B,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AA5BW,QAAA,UAAU,cA4BrB","sourcesContent":["import {\n\tSpotMarketConfig,\n\tDriftEnv,\n\tinitialize,\n\tPerpMarketConfig,\n} from '@drift-labs/sdk';\n\nexport const Config: {\n\tinitialized: boolean;\n\tspotMarketsLookup: SpotMarketConfig[];\n\tperpMarketsLookup: PerpMarketConfig[];\n\tsdkConfig: ReturnType<typeof initialize>;\n} = {\n\tinitialized: false,\n\tspotMarketsLookup: [],\n\tperpMarketsLookup: [],\n\tsdkConfig: undefined,\n};\n\nexport const Initialize = (env: DriftEnv) => {\n\tconst SDKConfig = initialize({ env });\n\n\tconst maxSpotMarketIndex = Math.max(\n\t\t...SDKConfig.SPOT_MARKETS.map((market) => market.marketIndex)\n\t);\n\n\tconst maxPerpMarketIndex = Math.max(\n\t\t...SDKConfig.PERP_MARKETS.map((market) => market.marketIndex)\n\t);\n\n\tconst spotMarkets = new Array(maxSpotMarketIndex);\n\tconst markets = new Array(maxPerpMarketIndex);\n\n\tSDKConfig.SPOT_MARKETS.forEach((spotMarket) => {\n\t\tspotMarkets[spotMarket.marketIndex] = spotMarket;\n\t});\n\n\tSDKConfig.PERP_MARKETS.forEach((perpMarket) => {\n\t\tmarkets[perpMarket.marketIndex] = perpMarket;\n\t});\n\n\tConfig.spotMarketsLookup = spotMarkets;\n\tConfig.perpMarketsLookup = markets;\n\n\tConfig.initialized = true;\n\n\treturn SDKConfig;\n};\n"]}

package/lib/EnvironmentConstants.d.ts

@@ -0,0 +1,40 @@
+export interface RpcEndpoint {
+    label: string;
+    value: string;
+    wsValue?: string;
+    allowAdditionalConnection: boolean;
+}
+export declare const EnvironmentConstants: {
+    rpcs: {
+        dev: RpcEndpoint[];
+        mainnet: RpcEndpoint[];
+    };
+    historyServerUrl: {
+        dev: string;
+        mainnet: string;
+        staging: string;
+    };
+    dataServerUrl: {
+        dev: string;
+        mainnet: string;
+        staging: string;
+    };
+    dlobServerHttpUrl: {
+        dev: string;
+        mainnet: string;
+        staging: string;
+    };
+    dlobServerWsUrl: {
+        dev: string;
+        mainnet: string;
+        staging: string;
+    };
+    eventsServerUrl: {
+        mainnet: string;
+        staging: string;
+    };
+    swiftServerUrl: {
+        mainnet: string;
+        staging: string;
+    };
+};

package/lib/EnvironmentConstants.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentConstants = void 0;
+exports.EnvironmentConstants = {
+    rpcs: {
+        dev: [
+            {
+                label: 'Helius',
+                value: 'https://detailed-sharleen-fast-devnet.helius-rpc.com',
+                wsValue: 'wss://detailed-sharleen-fast-devnet.helius-rpc.com',
+                allowAdditionalConnection: true,
+            },
+            {
+                label: 'RPC Pool',
+                value: 'https://drift-drift-a827.devnet.rpcpool.com/3639271b-6f0e-47c6-a643-1aaa0e498f58',
+                wsValue: 'wss://drift-drift-a827.devnet.rpcpool.com/3639271b-6f0e-47c6-a643-1aaa0e498f58/whirligig',
+                allowAdditionalConnection: false,
+            },
+        ],
+        mainnet: [
+            {
+                label: 'Triton RPC Pool 1',
+                value: 'https://drift-drift-951a.mainnet.rpcpool.com',
+                wsValue: 'wss://drift-drift-951a.mainnet.rpcpool.com/whirligig',
+                allowAdditionalConnection: true,
+            },
+            {
+                label: 'Helius 1',
+                value: 'https://kora-8cwrc2-fast-mainnet.helius-rpc.com/',
+                wsValue: 'wss://kora-8cwrc2-fast-mainnet.helius-rpc.com/',
+                allowAdditionalConnection: true,
+            },
+        ],
+    },
+    historyServerUrl: {
+        dev: 'https://master.api.drift.trade',
+        mainnet: 'https://mainnet-beta.api.drift.trade',
+        staging: 'https://staging.api.drift.trade',
+    },
+    dataServerUrl: {
+        dev: 'https://data-master.api.drift.trade',
+        mainnet: 'https://data.api.drift.trade',
+        staging: 'https://data-staging.api.drift.trade',
+    },
+    dlobServerHttpUrl: {
+        dev: 'https://master.dlob.drift.trade',
+        mainnet: 'https://dlob.drift.trade',
+        staging: 'https://staging.dlob.drift.trade',
+    },
+    dlobServerWsUrl: {
+        dev: 'wss://master.dlob.drift.trade/ws',
+        mainnet: 'wss://dlob.drift.trade/ws',
+        staging: 'wss://staging.dlob.drift.trade/ws',
+    },
+    eventsServerUrl: {
+        mainnet: 'wss://events.drift.trade/ws',
+        staging: 'wss://events.drift.trade/ws',
+    },
+    swiftServerUrl: {
+        mainnet: 'https://swift.drift.trade',
+        staging: 'https://master.swift.drift.trade',
+    },
+};
+//# sourceMappingURL=EnvironmentConstants.js.map

package/lib/EnvironmentConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvironmentConstants.js","sourceRoot":"","sources":["../src/EnvironmentConstants.ts"],"names":[],"mappings":";;;AAOa,QAAA,oBAAoB,GAAG;IACnC,IAAI,EAAE;QACL,GAAG,EAAE;YACJ;gBACC,KAAK,EAAE,QAAQ;gBACf,KAAK,EAAE,sDAAsD;gBAC7D,OAAO,EAAE,oDAAoD;gBAC7D,yBAAyB,EAAE,IAAI;aAC/B;YACD;gBACC,KAAK,EAAE,UAAU;gBACjB,KAAK,EACJ,kFAAkF;gBACnF,OAAO,EACN,0FAA0F;gBAC3F,yBAAyB,EAAE,KAAK;aAChC;SACgB;QAClB,OAAO,EAAE;YACR;gBACC,KAAK,EAAE,mBAAmB;gBAC1B,KAAK,EAAE,8CAA8C;gBACrD,OAAO,EAAE,sDAAsD;gBAC/D,yBAAyB,EAAE,IAAI;aAC/B;YACD;gBACC,KAAK,EAAE,UAAU;gBACjB,KAAK,EAAE,kDAAkD;gBACzD,OAAO,EAAE,gDAAgD;gBACzD,yBAAyB,EAAE,IAAI;aAC/B;SACgB;KAClB;IACD,gBAAgB,EAAE;QACjB,GAAG,EAAE,gCAAgC;QACrC,OAAO,EAAE,sCAAsC;QAC/C,OAAO,EAAE,iCAAiC;KAC1C;IACD,aAAa,EAAE;QACd,GAAG,EAAE,qCAAqC;QAC1C,OAAO,EAAE,8BAA8B;QACvC,OAAO,EAAE,sCAAsC;KAC/C;IACD,iBAAiB,EAAE;QAClB,GAAG,EAAE,iCAAiC;QACtC,OAAO,EAAE,0BAA0B;QACnC,OAAO,EAAE,kCAAkC;KAC3C;IACD,eAAe,EAAE;QAChB,GAAG,EAAE,kCAAkC;QACvC,OAAO,EAAE,2BAA2B;QACpC,OAAO,EAAE,mCAAmC;KAC5C;IACD,eAAe,EAAE;QAChB,OAAO,EAAE,6BAA6B;QACtC,OAAO,EAAE,6BAA6B;KACtC;IACD,cAAc,EAAE;QACf,OAAO,EAAE,2BAA2B;QACpC,OAAO,EAAE,kCAAkC;KAC3C;CACD,CAAC","sourcesContent":["export interface RpcEndpoint {\n\tlabel: string;\n\tvalue: string;\n\twsValue?: string;\n\tallowAdditionalConnection: boolean;\n}\n\nexport const EnvironmentConstants = {\n\trpcs: {\n\t\tdev: [\n\t\t\t{\n\t\t\t\tlabel: 'Helius',\n\t\t\t\tvalue: 'https://detailed-sharleen-fast-devnet.helius-rpc.com',\n\t\t\t\twsValue: 'wss://detailed-sharleen-fast-devnet.helius-rpc.com',\n\t\t\t\tallowAdditionalConnection: true,\n\t\t\t},\n\t\t\t{\n\t\t\t\tlabel: 'RPC Pool',\n\t\t\t\tvalue:\n\t\t\t\t\t'https://drift-drift-a827.devnet.rpcpool.com/3639271b-6f0e-47c6-a643-1aaa0e498f58',\n\t\t\t\twsValue:\n\t\t\t\t\t'wss://drift-drift-a827.devnet.rpcpool.com/3639271b-6f0e-47c6-a643-1aaa0e498f58/whirligig',\n\t\t\t\tallowAdditionalConnection: false,\n\t\t\t},\n\t\t] as RpcEndpoint[],\n\t\tmainnet: [\n\t\t\t{\n\t\t\t\tlabel: 'Triton RPC Pool 1',\n\t\t\t\tvalue: 'https://drift-drift-951a.mainnet.rpcpool.com',\n\t\t\t\twsValue: 'wss://drift-drift-951a.mainnet.rpcpool.com/whirligig',\n\t\t\t\tallowAdditionalConnection: true,\n\t\t\t},\n\t\t\t{\n\t\t\t\tlabel: 'Helius 1',\n\t\t\t\tvalue: 'https://kora-8cwrc2-fast-mainnet.helius-rpc.com/',\n\t\t\t\twsValue: 'wss://kora-8cwrc2-fast-mainnet.helius-rpc.com/',\n\t\t\t\tallowAdditionalConnection: true,\n\t\t\t},\n\t\t] as RpcEndpoint[],\n\t},\n\thistoryServerUrl: {\n\t\tdev: 'https://master.api.drift.trade',\n\t\tmainnet: 'https://mainnet-beta.api.drift.trade',\n\t\tstaging: 'https://staging.api.drift.trade',\n\t},\n\tdataServerUrl: {\n\t\tdev: 'https://data-master.api.drift.trade',\n\t\tmainnet: 'https://data.api.drift.trade',\n\t\tstaging: 'https://data-staging.api.drift.trade',\n\t},\n\tdlobServerHttpUrl: {\n\t\tdev: 'https://master.dlob.drift.trade',\n\t\tmainnet: 'https://dlob.drift.trade',\n\t\tstaging: 'https://staging.dlob.drift.trade',\n\t},\n\tdlobServerWsUrl: {\n\t\tdev: 'wss://master.dlob.drift.trade/ws',\n\t\tmainnet: 'wss://dlob.drift.trade/ws',\n\t\tstaging: 'wss://staging.dlob.drift.trade/ws',\n\t},\n\teventsServerUrl: {\n\t\tmainnet: 'wss://events.drift.trade/ws',\n\t\tstaging: 'wss://events.drift.trade/ws',\n\t},\n\tswiftServerUrl: {\n\t\tmainnet: 'https://swift.drift.trade',\n\t\tstaging: 'https://master.swift.drift.trade',\n\t},\n};\n"]}

package/lib/actions/actionHelpers/accountDeletionHelpers.d.ts

@@ -0,0 +1,16 @@
+import { DriftClient, User, UserStatsAccount } from '@drift-labs/sdk';
+type AccountDeletionStep = 'askToCloseAllPositionsOrdersBorrows' | 'sendAccountDeletionIx' | 'sendBalanceWithdrawalIx' | 'sendTriggerAccountIdleIx' | 'askToWait';
+type CanBeDeletedState = 'no' | 'yes' | 'no-wait-for-idle' | 'yes-after-making-idle';
+export declare const getIdleWaitTimeMinutes: (user: User, currentSlot: number) => number;
+export declare const ACCOUNT_DELETION_HELPERS: {
+    accountHasOpenOrders: (user: User) => boolean;
+    accountHasOpenPerpPositions: (user: User) => boolean;
+    accountHasOpenSpotPositions: (user: User) => boolean;
+    getAccountDeletionStepsToTake: (user: User, userStatsAccount: UserStatsAccount, currentSlot: number) => AccountDeletionStep[];
+    getAccountCanBeDeletedInstantly: (user: User, userStatsAccount: UserStatsAccount, currentSlot: number) => CanBeDeletedState;
+    getStatsAccountIsPastDeletionCutoff: (userStatsAccount: UserStatsAccount) => boolean;
+    tryDeleteUserAccount: (driftClient: DriftClient, user: User, userStatsAccount: UserStatsAccount, latestSlot: number) => Promise<string>;
+    getIdleWaitTimeMinutes: (user: User, currentSlot: number) => number;
+    getStatsAccountDeletionWaitTime: (userStatsAccount: UserStatsAccount) => number;
+};
+export {};

package/lib/actions/actionHelpers/accountDeletionHelpers.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACCOUNT_DELETION_HELPERS = exports.getIdleWaitTimeMinutes = void 0;
+const sdk_1 = require("@drift-labs/sdk");
+const getStatsAccountDeletionWaitTime = (userStatsAccount) => {
+    const estimatedAgeSeconds = Math.round(Date.now() / 1000) -
+        sdk_1.UserStats.getOldestActionTs(userStatsAccount);
+    return Math.max(sdk_1.ACCOUNT_AGE_DELETION_CUTOFF_SECONDS - estimatedAgeSeconds, 0);
+};
+const getStatsAccountIsPastDeletionCutoff = (userStatsAccount) => {
+    const estimatedAgeSeconds = Math.round(Date.now() / 1000) -
+        sdk_1.UserStats.getOldestActionTs(userStatsAccount);
+    return estimatedAgeSeconds >= sdk_1.ACCOUNT_AGE_DELETION_CUTOFF_SECONDS;
+};
+const accountHasOpenPerpPositions = (user) => {
+    const userAccount = user.getUserAccount();
+    for (const perpPosition of userAccount.perpPositions) {
+        if (!(0, sdk_1.positionIsAvailable)(perpPosition)) {
+            return true;
+        }
+    }
+    return false;
+};
+const accountHasOpenSpotPositions = (user) => {
+    const userAccount = user.getUserAccount();
+    for (const spotPosition of userAccount.spotPositions) {
+        if (spotPosition.scaledBalance.gt(sdk_1.ZERO)) {
+            return true;
+        }
+    }
+    return false;
+};
+const accountHasOpenOrders = (user) => {
+    const userAccount = user.getUserAccount();
+    return userAccount.orders.some((order) => (0, sdk_1.isVariant)(order.status, 'open'));
+};
+const accountHasOpenPositionsOrOrders = (user) => {
+    if (accountHasOpenPerpPositions(user)) {
+        return true;
+    }
+    if (accountHasOpenSpotPositions(user)) {
+        return true;
+    }
+    if (accountHasOpenOrders(user)) {
+        return true;
+    }
+    return false;
+};
+const getAccountCanBeDeletedInstantly = (user, userStatsAccount, currentSlot) => {
+    const statsAccountIsPastDeletionCutoff = getStatsAccountIsPastDeletionCutoff(userStatsAccount);
+    const userIsIdle = user.getUserAccount().idle;
+    const userCanBeMarkedIdle = user.canMakeIdle(new sdk_1.BN(currentSlot));
+    const accountHasNoOpenPositionsOrOrders = !accountHasOpenPositionsOrOrders(user);
+    if (!accountHasNoOpenPositionsOrOrders) {
+        return 'no';
+    }
+    if (statsAccountIsPastDeletionCutoff || userIsIdle) {
+        return 'yes';
+    }
+    if (!userCanBeMarkedIdle) {
+        return 'no-wait-for-idle';
+    }
+    return 'yes-after-making-idle';
+};
+/**
+ * To try improve the UX we want to abstract away the different account states and deletion compliance. This method returns the steps required to give the best UX for account deletion depending on the incoming account state. A short explanation of the logic:
+ *
+ * States that affect whether an account can be deleted:
+ * - A user stats account that is older than 13 days => All accounts can be deleted
+ * - A user account that is idle => The user account in question can be deleted
+ * - A user account that can be marked idle => The user account in question can be deleted after sending a markIdle instruction
+ * - A user that is not/can not be idle (yet), with no stats account older than 13 days => wait until the account is idle and then try again. If the user has open perp positions, orders or borrows, they need to be closed first as well.
+ * @param userAccount
+ * @param userStatsAccount
+ */
+const getAccountDeletionStepsToTake = (user, userStatsAccount, currentSlot) => {
+    const userAccount = user.getUserAccount();
+    const statsAccountIsPastDeletionCutoff = getStatsAccountIsPastDeletionCutoff(userStatsAccount);
+    // Account is past deletion cutoff
+    if (statsAccountIsPastDeletionCutoff) {
+        return ['sendAccountDeletionIx'];
+    }
+    // Account needs to be unwound first
+    const hasOpenPositionsOrOrders = accountHasOpenPositionsOrOrders(user);
+    if (hasOpenPositionsOrOrders) {
+        return ['askToCloseAllPositionsOrdersBorrows'];
+    }
+    // Account is idle and can be deleted
+    const userAccountIsIdle = userAccount.idle;
+    if (userAccountIsIdle) {
+        return ['sendAccountDeletionIx'];
+    }
+    // Account can be marked idle and then deleted
+    const canBeMarkedIdle = user.canMakeIdle(new sdk_1.BN(currentSlot));
+    if (canBeMarkedIdle) {
+        return ['sendTriggerAccountIdleIx', 'sendAccountDeletionIx'];
+    }
+    // Account is not idle and can not be marked idle yet, wait until it is (or can be marked) idle and then try again
+    return ['askToWait'];
+};
+/**
+ * Builds the necessary transaction to delete a user account. This method will throw an error if the account cannot be deleted instantly.
+ * @param driftClient
+ * @param user
+ * @param userStatsAccount
+ * @param latestSlot
+ * @returns
+ */
+const tryDeleteUserAccount = async (driftClient, user, userStatsAccount, latestSlot) => {
+    var _a;
+    const canBeDeleted = getAccountCanBeDeletedInstantly(user, userStatsAccount, latestSlot);
+    if (canBeDeleted === 'no' || canBeDeleted === 'no-wait-for-idle') {
+        throw new Error('Account cannot be deleted');
+    }
+    const Ixs = [];
+    if (canBeDeleted === 'yes-after-making-idle') {
+        // Create the make idle instruction
+        Ixs.push(await driftClient.getUpdateUserIdleIx(user.userAccountPublicKey, user.getUserAccount()));
+    }
+    // Create the delete account instruction
+    Ixs.push(await driftClient.getUserDeletionIx(user.userAccountPublicKey));
+    // Create a transaction from the instructions
+    const tx = await driftClient.buildTransaction(Ixs);
+    const { txSig } = await driftClient.sendTransaction(tx);
+    const userMapKey = driftClient.getUserMapKey(user.getUserAccount().subAccountId, driftClient.wallet.publicKey);
+    await ((_a = driftClient.users.get(userMapKey)) === null || _a === void 0 ? void 0 : _a.unsubscribe());
+    driftClient.users.delete(userMapKey);
+    return txSig;
+};
+const getIdleWaitTimeMinutes = (user, currentSlot) => {
+    const lastActiveSlot = user.getUserAccount().lastActiveSlot;
+    const inactiveAccountTime = Math.max(currentSlot - lastActiveSlot.toNumber(), 0);
+    const slotsToWait = sdk_1.IDLE_TIME_SLOTS - inactiveAccountTime;
+    const secondsPerSlot = sdk_1.SLOT_TIME_ESTIMATE_MS / 1000;
+    const timeEstimateSeconds = slotsToWait * secondsPerSlot;
+    const minutesEstimate = Math.ceil(timeEstimateSeconds / 60);
+    return minutesEstimate;
+};
+exports.getIdleWaitTimeMinutes = getIdleWaitTimeMinutes;
+exports.ACCOUNT_DELETION_HELPERS = {
+    accountHasOpenOrders,
+    accountHasOpenPerpPositions,
+    accountHasOpenSpotPositions,
+    getAccountDeletionStepsToTake,
+    getAccountCanBeDeletedInstantly,
+    getStatsAccountIsPastDeletionCutoff,
+    tryDeleteUserAccount,
+    getIdleWaitTimeMinutes: exports.getIdleWaitTimeMinutes,
+    getStatsAccountDeletionWaitTime,
+};
+//# sourceMappingURL=accountDeletionHelpers.js.map

package/lib/actions/actionHelpers/accountDeletionHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accountDeletionHelpers.js","sourceRoot":"","sources":["../../../src/actions/actionHelpers/accountDeletionHelpers.ts"],"names":[],"mappings":";;;AAAA,yCAYyB;AAUzB,MAAM,+BAA+B,GAAG,CACvC,gBAAkC,EACjC,EAAE;IACH,MAAM,mBAAmB,GACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QAC7B,eAAS,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAE/C,OAAO,IAAI,CAAC,GAAG,CAAC,yCAAmC,GAAG,mBAAmB,EAAE,CAAC,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,mCAAmC,GAAG,CAC3C,gBAAkC,EACjC,EAAE;IACH,MAAM,mBAAmB,GACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QAC7B,eAAS,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAE/C,OAAO,mBAAmB,IAAI,yCAAmC,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,IAAU,EAAE,EAAE;IAClD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1C,KAAK,MAAM,YAAY,IAAI,WAAW,CAAC,aAAa,EAAE,CAAC;QACtD,IAAI,CAAC,IAAA,yBAAmB,EAAC,YAAY,CAAC,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,IAAU,EAAE,EAAE;IAClD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1C,KAAK,MAAM,YAAY,IAAI,WAAW,CAAC,aAAa,EAAE,CAAC;QACtD,IAAI,YAAY,CAAC,aAAa,CAAC,EAAE,CAAC,UAAI,CAAC,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAU,EAAE,EAAE;IAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1C,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,eAAS,EAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,+BAA+B,GAAG,CAAC,IAAU,EAAE,EAAE;IACtD,IAAI,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAQF,MAAM,+BAA+B,GAAG,CACvC,IAAU,EACV,gBAAkC,EAClC,WAAmB,EACC,EAAE;IACtB,MAAM,gCAAgC,GACrC,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;IAEvD,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC;IAE9C,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,QAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElE,MAAM,iCAAiC,GACtC,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAExC,IAAI,CAAC,iCAAiC,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,gCAAgC,IAAI,UAAU,EAAE,CAAC;QACpD,OAAO,KAAK,CAAC;IACd,CAAC;IAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC1B,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED,OAAO,uBAAuB,CAAC;AAChC,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,6BAA6B,GAAG,CACrC,IAAU,EACV,gBAAkC,EAClC,WAAmB,EACK,EAAE;IAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1C,MAAM,gCAAgC,GACrC,mCAAmC,CAAC,gBAAgB,CAAC,CAAC;IAEvD,kCAAkC;IAClC,IAAI,gCAAgC,EAAE,CAAC;QACtC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAClC,CAAC;IAED,oCAAoC;IACpC,MAAM,wBAAwB,GAAG,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAEvE,IAAI,wBAAwB,EAAE,CAAC;QAC9B,OAAO,CAAC,qCAAqC,CAAC,CAAC;IAChD,CAAC;IAED,qCAAqC;IACrC,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CAAC;IAE3C,IAAI,iBAAiB,EAAE,CAAC;QACvB,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAClC,CAAC;IAED,8CAA8C;IAC9C,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,QAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAE9D,IAAI,eAAe,EAAE,CAAC;QACrB,OAAO,CAAC,0BAA0B,EAAE,uBAAuB,CAAC,CAAC;IAC9D,CAAC;IAED,kHAAkH;IAClH,OAAO,CAAC,WAAW,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAAG,KAAK,EACjC,WAAwB,EACxB,IAAU,EACV,gBAAkC,EAClC,UAAkB,EACjB,EAAE;;IACH,MAAM,YAAY,GAAG,+BAA+B,CACnD,IAAI,EACJ,gBAAgB,EAChB,UAAU,CACV,CAAC;IAEF,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,kBAAkB,EAAE,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,GAAG,GAA6B,EAAE,CAAC;IAEzC,IAAI,YAAY,KAAK,uBAAuB,EAAE,CAAC;QAC9C,mCAAmC;QACnC,GAAG,CAAC,IAAI,CACP,MAAM,WAAW,CAAC,mBAAmB,CACpC,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,cAAc,EAAE,CACrB,CACD,CAAC;IACH,CAAC;IAED,wCAAwC;IACxC,GAAG,CAAC,IAAI,CAAC,MAAM,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAEzE,6CAA6C;IAC7C,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAEnD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;IAExD,MAAM,UAAU,GAAG,WAAW,CAAC,aAAa,CAC3C,IAAI,CAAC,cAAc,EAAE,CAAC,YAAY,EAClC,WAAW,CAAC,MAAM,CAAC,SAAS,CAC5B,CAAC;IACF,MAAM,CAAA,MAAA,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,WAAW,EAAE,CAAA,CAAC;IACvD,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAErC,OAAO,KAAK,CAAC;AACd,CAAC,CAAC;AAEK,MAAM,sBAAsB,GAAG,CAAC,IAAU,EAAE,WAAmB,EAAE,EAAE;IACzE,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,cAAc,CAAC;IAE5D,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,CACnC,WAAW,GAAG,cAAc,CAAC,QAAQ,EAAE,EACvC,CAAC,CACD,CAAC;IAEF,MAAM,WAAW,GAAG,qBAAe,GAAG,mBAAmB,CAAC;IAE1D,MAAM,cAAc,GAAG,2BAAqB,GAAG,IAAI,CAAC;IAEpD,MAAM,mBAAmB,GAAG,WAAW,GAAG,cAAc,CAAC;IAEzD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;IAE5D,OAAO,eAAe,CAAC;AACxB,CAAC,CAAC;AAjBW,QAAA,sBAAsB,0BAiBjC;AAEW,QAAA,wBAAwB,GAAG;IACvC,oBAAoB;IACpB,2BAA2B;IAC3B,2BAA2B;IAC3B,6BAA6B;IAC7B,+BAA+B;IAC/B,mCAAmC;IACnC,oBAAoB;IACpB,sBAAsB,EAAtB,8BAAsB;IACtB,+BAA+B;CAC/B,CAAC","sourcesContent":["import {\n\tACCOUNT_AGE_DELETION_CUTOFF_SECONDS,\n\tBN,\n\tDriftClient,\n\tIDLE_TIME_SLOTS,\n\tSLOT_TIME_ESTIMATE_MS,\n\tUser,\n\tUserStats,\n\tUserStatsAccount,\n\tZERO,\n\tisVariant,\n\tpositionIsAvailable,\n} from '@drift-labs/sdk';\nimport { TransactionInstruction } from '@solana/web3.js';\n\ntype AccountDeletionStep =\n\t| 'askToCloseAllPositionsOrdersBorrows'\n\t| 'sendAccountDeletionIx'\n\t| 'sendBalanceWithdrawalIx'\n\t| 'sendTriggerAccountIdleIx'\n\t| 'askToWait';\n\nconst getStatsAccountDeletionWaitTime = (\n\tuserStatsAccount: UserStatsAccount\n) => {\n\tconst estimatedAgeSeconds =\n\t\tMath.round(Date.now() / 1000) -\n\t\tUserStats.getOldestActionTs(userStatsAccount);\n\n\treturn Math.max(ACCOUNT_AGE_DELETION_CUTOFF_SECONDS - estimatedAgeSeconds, 0);\n};\n\nconst getStatsAccountIsPastDeletionCutoff = (\n\tuserStatsAccount: UserStatsAccount\n) => {\n\tconst estimatedAgeSeconds =\n\t\tMath.round(Date.now() / 1000) -\n\t\tUserStats.getOldestActionTs(userStatsAccount);\n\n\treturn estimatedAgeSeconds >= ACCOUNT_AGE_DELETION_CUTOFF_SECONDS;\n};\n\nconst accountHasOpenPerpPositions = (user: User) => {\n\tconst userAccount = user.getUserAccount();\n\tfor (const perpPosition of userAccount.perpPositions) {\n\t\tif (!positionIsAvailable(perpPosition)) {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\treturn false;\n};\n\nconst accountHasOpenSpotPositions = (user: User) => {\n\tconst userAccount = user.getUserAccount();\n\tfor (const spotPosition of userAccount.spotPositions) {\n\t\tif (spotPosition.scaledBalance.gt(ZERO)) {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\treturn false;\n};\n\nconst accountHasOpenOrders = (user: User) => {\n\tconst userAccount = user.getUserAccount();\n\treturn userAccount.orders.some((order) => isVariant(order.status, 'open'));\n};\n\nconst accountHasOpenPositionsOrOrders = (user: User) => {\n\tif (accountHasOpenPerpPositions(user)) {\n\t\treturn true;\n\t}\n\n\tif (accountHasOpenSpotPositions(user)) {\n\t\treturn true;\n\t}\n\n\tif (accountHasOpenOrders(user)) {\n\t\treturn true;\n\t}\n\n\treturn false;\n};\n\ntype CanBeDeletedState =\n\t| 'no'\n\t| 'yes'\n\t| 'no-wait-for-idle'\n\t| 'yes-after-making-idle';\n\nconst getAccountCanBeDeletedInstantly = (\n\tuser: User,\n\tuserStatsAccount: UserStatsAccount,\n\tcurrentSlot: number\n): CanBeDeletedState => {\n\tconst statsAccountIsPastDeletionCutoff =\n\t\tgetStatsAccountIsPastDeletionCutoff(userStatsAccount);\n\n\tconst userIsIdle = user.getUserAccount().idle;\n\n\tconst userCanBeMarkedIdle = user.canMakeIdle(new BN(currentSlot));\n\n\tconst accountHasNoOpenPositionsOrOrders =\n\t\t!accountHasOpenPositionsOrOrders(user);\n\n\tif (!accountHasNoOpenPositionsOrOrders) {\n\t\treturn 'no';\n\t}\n\n\tif (statsAccountIsPastDeletionCutoff || userIsIdle) {\n\t\treturn 'yes';\n\t}\n\n\tif (!userCanBeMarkedIdle) {\n\t\treturn 'no-wait-for-idle';\n\t}\n\n\treturn 'yes-after-making-idle';\n};\n\n/**\n * To try improve the UX we want to abstract away the different account states and deletion compliance. This method returns the steps required to give the best UX for account deletion depending on the incoming account state. A short explanation of the logic:\n *\n * States that affect whether an account can be deleted:\n * - A user stats account that is older than 13 days => All accounts can be deleted\n * - A user account that is idle => The user account in question can be deleted\n * - A user account that can be marked idle => The user account in question can be deleted after sending a markIdle instruction\n * - A user that is not/can not be idle (yet), with no stats account older than 13 days => wait until the account is idle and then try again. If the user has open perp positions, orders or borrows, they need to be closed first as well.\n * @param userAccount\n * @param userStatsAccount\n */\nconst getAccountDeletionStepsToTake = (\n\tuser: User,\n\tuserStatsAccount: UserStatsAccount,\n\tcurrentSlot: number\n): AccountDeletionStep[] => {\n\tconst userAccount = user.getUserAccount();\n\tconst statsAccountIsPastDeletionCutoff =\n\t\tgetStatsAccountIsPastDeletionCutoff(userStatsAccount);\n\n\t// Account is past deletion cutoff\n\tif (statsAccountIsPastDeletionCutoff) {\n\t\treturn ['sendAccountDeletionIx'];\n\t}\n\n\t// Account needs to be unwound first\n\tconst hasOpenPositionsOrOrders = accountHasOpenPositionsOrOrders(user);\n\n\tif (hasOpenPositionsOrOrders) {\n\t\treturn ['askToCloseAllPositionsOrdersBorrows'];\n\t}\n\n\t// Account is idle and can be deleted\n\tconst userAccountIsIdle = userAccount.idle;\n\n\tif (userAccountIsIdle) {\n\t\treturn ['sendAccountDeletionIx'];\n\t}\n\n\t// Account can be marked idle and then deleted\n\tconst canBeMarkedIdle = user.canMakeIdle(new BN(currentSlot));\n\n\tif (canBeMarkedIdle) {\n\t\treturn ['sendTriggerAccountIdleIx', 'sendAccountDeletionIx'];\n\t}\n\n\t// Account is not idle and can not be marked idle yet, wait until it is (or can be marked) idle and then try again\n\treturn ['askToWait'];\n};\n\n/**\n * Builds the necessary transaction to delete a user account. This method will throw an error if the account cannot be deleted instantly.\n * @param driftClient\n * @param user\n * @param userStatsAccount\n * @param latestSlot\n * @returns\n */\nconst tryDeleteUserAccount = async (\n\tdriftClient: DriftClient,\n\tuser: User,\n\tuserStatsAccount: UserStatsAccount,\n\tlatestSlot: number\n) => {\n\tconst canBeDeleted = getAccountCanBeDeletedInstantly(\n\t\tuser,\n\t\tuserStatsAccount,\n\t\tlatestSlot\n\t);\n\n\tif (canBeDeleted === 'no' || canBeDeleted === 'no-wait-for-idle') {\n\t\tthrow new Error('Account cannot be deleted');\n\t}\n\n\tconst Ixs: TransactionInstruction[] = [];\n\n\tif (canBeDeleted === 'yes-after-making-idle') {\n\t\t// Create the make idle instruction\n\t\tIxs.push(\n\t\t\tawait driftClient.getUpdateUserIdleIx(\n\t\t\t\tuser.userAccountPublicKey,\n\t\t\t\tuser.getUserAccount()\n\t\t\t)\n\t\t);\n\t}\n\n\t// Create the delete account instruction\n\tIxs.push(await driftClient.getUserDeletionIx(user.userAccountPublicKey));\n\n\t// Create a transaction from the instructions\n\tconst tx = await driftClient.buildTransaction(Ixs);\n\n\tconst { txSig } = await driftClient.sendTransaction(tx);\n\n\tconst userMapKey = driftClient.getUserMapKey(\n\t\tuser.getUserAccount().subAccountId,\n\t\tdriftClient.wallet.publicKey\n\t);\n\tawait driftClient.users.get(userMapKey)?.unsubscribe();\n\tdriftClient.users.delete(userMapKey);\n\n\treturn txSig;\n};\n\nexport const getIdleWaitTimeMinutes = (user: User, currentSlot: number) => {\n\tconst lastActiveSlot = user.getUserAccount().lastActiveSlot;\n\n\tconst inactiveAccountTime = Math.max(\n\t\tcurrentSlot - lastActiveSlot.toNumber(),\n\t\t0\n\t);\n\n\tconst slotsToWait = IDLE_TIME_SLOTS - inactiveAccountTime;\n\n\tconst secondsPerSlot = SLOT_TIME_ESTIMATE_MS / 1000;\n\n\tconst timeEstimateSeconds = slotsToWait * secondsPerSlot;\n\n\tconst minutesEstimate = Math.ceil(timeEstimateSeconds / 60);\n\n\treturn minutesEstimate;\n};\n\nexport const ACCOUNT_DELETION_HELPERS = {\n\taccountHasOpenOrders,\n\taccountHasOpenPerpPositions,\n\taccountHasOpenSpotPositions,\n\tgetAccountDeletionStepsToTake,\n\tgetAccountCanBeDeletedInstantly,\n\tgetStatsAccountIsPastDeletionCutoff,\n\ttryDeleteUserAccount,\n\tgetIdleWaitTimeMinutes,\n\tgetStatsAccountDeletionWaitTime,\n};\n"]}

package/lib/actions/actionHelpers/actionHelpers.d.ts

@@ -0,0 +1,13 @@
+export declare const ACTION_HELPERS: {
+    ACCOUNT_DELETION_HELPERS: {
+        accountHasOpenOrders: (user: import("../../../../protocol/sdk/lib/node").User) => boolean;
+        accountHasOpenPerpPositions: (user: import("../../../../protocol/sdk/lib/node").User) => boolean;
+        accountHasOpenSpotPositions: (user: import("../../../../protocol/sdk/lib/node").User) => boolean;
+        getAccountDeletionStepsToTake: (user: import("../../../../protocol/sdk/lib/node").User, userStatsAccount: import("../../../../protocol/sdk/lib/node").UserStatsAccount, currentSlot: number) => ("askToCloseAllPositionsOrdersBorrows" | "sendAccountDeletionIx" | "sendBalanceWithdrawalIx" | "sendTriggerAccountIdleIx" | "askToWait")[];
+        getAccountCanBeDeletedInstantly: (user: import("../../../../protocol/sdk/lib/node").User, userStatsAccount: import("../../../../protocol/sdk/lib/node").UserStatsAccount, currentSlot: number) => "no" | "yes" | "no-wait-for-idle" | "yes-after-making-idle";
+        getStatsAccountIsPastDeletionCutoff: (userStatsAccount: import("../../../../protocol/sdk/lib/node").UserStatsAccount) => boolean;
+        tryDeleteUserAccount: (driftClient: import("../../../../protocol/sdk/lib/node").DriftClient, user: import("../../../../protocol/sdk/lib/node").User, userStatsAccount: import("../../../../protocol/sdk/lib/node").UserStatsAccount, latestSlot: number) => Promise<string>;
+        getIdleWaitTimeMinutes: (user: import("../../../../protocol/sdk/lib/node").User, currentSlot: number) => number;
+        getStatsAccountDeletionWaitTime: (userStatsAccount: import("../../../../protocol/sdk/lib/node").UserStatsAccount) => number;
+    };
+};

package/lib/actions/actionHelpers/actionHelpers.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTION_HELPERS = void 0;
+const accountDeletionHelpers_1 = require("./accountDeletionHelpers");
+exports.ACTION_HELPERS = {
+    ACCOUNT_DELETION_HELPERS: accountDeletionHelpers_1.ACCOUNT_DELETION_HELPERS,
+};
+//# sourceMappingURL=actionHelpers.js.map

package/lib/actions/actionHelpers/actionHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionHelpers.js","sourceRoot":"","sources":["../../../src/actions/actionHelpers/actionHelpers.ts"],"names":[],"mappings":";;;AAAA,qEAAoE;AAEvD,QAAA,cAAc,GAAG;IAC7B,wBAAwB,EAAxB,iDAAwB;CACxB,CAAC","sourcesContent":["import { ACCOUNT_DELETION_HELPERS } from './accountDeletionHelpers';\n\nexport const ACTION_HELPERS = {\n\tACCOUNT_DELETION_HELPERS,\n};\n"]}

package/lib/chartConstants.d.ts

@@ -0,0 +1,2 @@
+import { CandleResolution } from '@drift-labs/sdk';
+export declare const CandleResolutions: CandleResolution[];

package/lib/chartConstants.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CandleResolutions = void 0;
+exports.CandleResolutions = [
+    '1',
+    '5',
+    '15',
+    '60',
+    '240',
+    'D',
+    'W',
+    'M',
+];
+//# sourceMappingURL=chartConstants.js.map

package/lib/chartConstants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chartConstants.js","sourceRoot":"","sources":["../src/chartConstants.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAuB;IACpD,GAAG;IACH,GAAG;IACH,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,GAAG;IACH,GAAG;IACH,GAAG;CACH,CAAC","sourcesContent":["import { CandleResolution } from '@drift-labs/sdk';\n\nexport const CandleResolutions: CandleResolution[] = [\n\t'1',\n\t'5',\n\t'15',\n\t'60',\n\t'240',\n\t'D',\n\t'W',\n\t'M',\n];\n"]}

package/lib/clients/candleClient.d.ts

@@ -0,0 +1,74 @@
+import { CandleResolution } from '@drift-labs/sdk';
+import { JsonCandle, MarketId } from '../types';
+import { UIEnv } from '../types/UIEnv';
+/**
+ * # CANDLE CLIENT HIGH LEVEL EXPLANATION:
+ * The Candle Client uses the Data API (see https://data.api.drift.trade/playground) to source candles to display.
+ *
+ * There are two key parts of the client:
+ * - Fetching Candles
+ * - Subscribing to Candles
+ *
+ * ## Fetching Candles:
+ * - We can fetch candles between any timestamp range.
+ * - The maximum number of candles we can fetch in a single request is 1000 (see CANDLE_FETCH_LIMIT).
+ * - We define "recent history" to be the last 1000 candles .. basically whatever comes back from the infra when we don't use a startTs and use the maximum fetch limit.
+ * - We want to avoid using high cardinality parameters in the fetch because otherwise we will miss the cache in the infra.
+ * 	- A concrete example of this is that we don't attach a startTs parameter when we are fetching candles within recent history (past 1000 candles)
+ * - We cache the recent candles in memory so that any subsequent fetches within recent history after the first one will be served from cache.
+ * 	- e.g. moving back to a further timeframe on TradingView - the required candles could potentially be in the cache, so we don't need to refetch them.
+ *
+ * ## Subscribing to Candles:
+ * - We subscribe to a websocket endpoint for a given market and resolution.
+ * - We allow the client to support multiple concurrent subscriptions, because the TradingView comopnent will sometimes do this when switching between markets.
+ *
+ * ## Possible Improvements:
+ * - Create a more advanced cache which can store more than the most recent 1000 candles, dynamically growing as more candles are added (for now seems unnecessary, rare for someone to go back further than 1000 candles)
+ */
+type CandleFetchConfig = {
+    env: UIEnv;
+    marketId: MarketId;
+    resolution: CandleResolution;
+    fromTs: number;
+    toTs: number;
+};
+type CandleSubscriptionConfig = {
+    resolution: CandleResolution;
+    marketId: MarketId;
+    env: UIEnv;
+};
+type CandleSubscriberEvents = {
+    'candle-update': JsonCandle;
+};
+/**
+ * This class will subscribe to candles from the Drift Data API.
+ *
+ * Note: If you are using TradingView you probably want to just use the DriftTvFeed class instead.
+ */
+export declare class CandleClient {
+    private activeSubscriptions;
+    constructor();
+    subscribe: (config: CandleSubscriptionConfig, subscriptionKey: string) => Promise<void>;
+    /**
+     *
+     * @param config {
+     *
+     *   env: UIEnv;
+     *
+     *   marketId: MarketId;
+     *
+     *   resolution: CandleResolution;
+     *
+     *   fromTs: number;      // Seconds :: This should be the START (oldest) timestamp of the candles to fetch
+     *
+     *   toTs: number;        // Seconds :: This should be the END (newest) timestamp of the candles to fetch
+     *
+     * }
+     * @returns
+     */
+    fetch: (config: CandleFetchConfig) => Promise<JsonCandle[]>;
+    unsubscribe: (subscriptionKey: string) => void;
+    unsubscribeAll: () => void;
+    on(subscriptionKey: string, event: keyof CandleSubscriberEvents, listener: (candle: JsonCandle) => void): void;
+}
+export {};