@drift-labs/sdk 0.1.36-master.5 → 0.2.0-master.0

package/lib/factory/bigNum.d.ts

@@ -0,0 +1,112 @@
+/// <reference types="bn.js" />
+import { BN } from '@project-serum/anchor';
+export declare class BigNum {
+    val: BN;
+    precision: BN;
+    static delim: string;
+    static spacer: string;
+    constructor(val: BN | number | string, precisionVal?: BN | number | string);
+    add(bn: BigNum): BigNum;
+    sub(bn: BigNum): BigNum;
+    mul(bn: BigNum | BN): BigNum;
+    /**
+     * Multiplies by another big number then scales the result down by the big number's precision so that we're in the same precision space
+     * @param bn
+     * @returns
+     */
+    scalarMul(bn: BigNum | BN): BigNum;
+    div(bn: BigNum | BN): BigNum;
+    /**
+     * Shift precision up or down
+     * @param exponent
+     * @param skipAdjustingPrecision
+     * @returns
+     */
+    shift(exponent: BN | number, skipAdjustingPrecision?: boolean): BigNum;
+    /**
+     * Shift to a target precision
+     * @param targetPrecision
+     * @returns
+     */
+    shiftTo(targetPrecision: BN): BigNum;
+    /**
+     * Scale the number by a fraction
+     * @param numerator
+     * @param denominator
+     * @returns
+     */
+    scale(numerator: BN | number, denominator: BN | number): BigNum;
+    toPercentage(denominator: BigNum, precision: number): string;
+    gt(bn: BigNum | BN, ignorePrecision?: boolean): boolean;
+    lt(bn: BigNum | BN, ignorePrecision?: boolean): boolean;
+    gte(bn: BigNum | BN, ignorePrecision?: boolean): boolean;
+    lte(bn: BigNum | BN, ignorePrecision?: boolean): boolean;
+    eq(bn: BigNum | BN, ignorePrecision?: boolean): boolean;
+    eqZero(): boolean;
+    gtZero(): boolean;
+    ltZero(): boolean;
+    gteZero(): boolean;
+    lteZero(): boolean;
+    abs(): BigNum;
+    neg(): BigNum;
+    toString: (base?: number | 'hex', length?: number) => string;
+    /**
+     * Pretty print the underlying value in human-readable form. Depends on precision being correct for the output string to be correct
+     * @returns
+     */
+    print(): string;
+    prettyPrint(): string;
+    /**
+     * Print and remove unnecessary trailing zeroes
+     * @returns
+     */
+    printShort(useTradePrecision?: boolean, precisionOverride?: number): string;
+    debug(): void;
+    /**
+     * Pretty print with the specified number of decimal places
+     * @param fixedPrecision
+     * @returns
+     */
+    toFixed(fixedPrecision: number): string;
+    /**
+     * Pretty print to the specified number of significant figures
+     * @param fixedPrecision
+     * @returns
+     */
+    toPrecision(fixedPrecision: number, trailingZeroes?: boolean): string;
+    toTradePrecision(): string;
+    toNotional(): string;
+    toMillified(precision?: number): string;
+    toJSON(): {
+        val: string;
+        precision: string;
+    };
+    isNeg(): boolean;
+    isPos(): boolean;
+    /**
+     * Get the numerical value of the BigNum. This can break if the BigNum is too large.
+     * @returns
+     */
+    toNum(): number;
+    static fromJSON(json: {
+        val: string;
+        precision: string;
+    }): BigNum;
+    /**
+     * Create a BigNum instance
+     * @param val
+     * @param precision
+     * @returns
+     */
+    static from(val?: BN | number | string, precision?: BN | number | string): BigNum;
+    /**
+     * Create a BigNum instance from a printed BigNum
+     * @param val
+     * @param precisionOverride
+     * @returns
+     */
+    static fromPrint(val: string, precisionShift?: BN): BigNum;
+    static max(a: BigNum, b: BigNum): BigNum;
+    static min(a: BigNum, b: BigNum): BigNum;
+    static zero(precision?: BN | number): BigNum;
+}

package/lib/factory/bigNum.js

@@ -0,0 +1,356 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BigNum = void 0;
+const anchor_1 = require("@project-serum/anchor");
+const assert_1 = require("../assert/assert");
+const numericConstants_1 = require("./../constants/numericConstants");
+class BigNum {
+    constructor(val, precisionVal = new anchor_1.BN(0)) {
+        this.toString = (base, length) => this.val.toString(base, length);
+        this.val = new anchor_1.BN(val);
+        this.precision = new anchor_1.BN(precisionVal);
+    }
+    add(bn) {
+        (0, assert_1.assert)(bn.precision.eq(this.precision), 'Adding unequal precisions');
+        return BigNum.from(this.val.add(bn.val), this.precision);
+    }
+    sub(bn) {
+        (0, assert_1.assert)(bn.precision.eq(this.precision), 'Subtracting unequal precisions');
+        return BigNum.from(this.val.sub(bn.val), this.precision);
+    }
+    mul(bn) {
+        const mulVal = bn instanceof BigNum ? bn : BigNum.from(bn);
+        return BigNum.from(this.val.mul(mulVal.val), this.precision.add(mulVal.precision));
+    }
+    /**
+     * Multiplies by another big number then scales the result down by the big number's precision so that we're in the same precision space
+     * @param bn
+     * @returns
+     */
+    scalarMul(bn) {
+        if (bn instanceof anchor_1.BN)
+            return BigNum.from(this.val.mul(bn), this.precision);
+        return BigNum.from(this.val.mul(bn.val), this.precision.add(bn.precision)).shift(bn.precision.neg());
+    }
+    div(bn) {
+        if (bn instanceof anchor_1.BN)
+            return BigNum.from(this.val.div(bn), this.precision);
+        return BigNum.from(this.val.div(bn.val), this.precision.sub(bn.precision));
+    }
+    /**
+     * Shift precision up or down
+     * @param exponent
+     * @param skipAdjustingPrecision
+     * @returns
+     */
+    shift(exponent, skipAdjustingPrecision = false) {
+        const shiftVal = typeof exponent === 'number' ? new anchor_1.BN(exponent) : exponent;
+        return BigNum.from(shiftVal.isNeg()
+            ? this.val.div(new anchor_1.BN(10).pow(shiftVal))
+            : this.val.mul(new anchor_1.BN(10).pow(shiftVal)), skipAdjustingPrecision ? this.precision : this.precision.add(shiftVal));
+    }
+    /**
+     * Shift to a target precision
+     * @param targetPrecision
+     * @returns
+     */
+    shiftTo(targetPrecision) {
+        return this.shift(targetPrecision.sub(this.precision));
+    }
+    /**
+     * Scale the number by a fraction
+     * @param numerator
+     * @param denominator
+     * @returns
+     */
+    scale(numerator, denominator) {
+        return this.mul(BigNum.from(new anchor_1.BN(numerator))).div(new anchor_1.BN(denominator));
+    }
+    toPercentage(denominator, precision) {
+        return this.shift(precision)
+            .shift(2, true)
+            .div(denominator)
+            .toPrecision(precision);
+    }
+    gt(bn, ignorePrecision) {
+        const comparisonVal = bn instanceof BigNum ? bn : BigNum.from(bn);
+        if (!ignorePrecision && !comparisonVal.eq(numericConstants_1.ZERO)) {
+            (0, assert_1.assert)(comparisonVal.precision.eq(this.precision), 'Trying to compare numbers with different precision. Yo can opt to ignore precision using the ignorePrecision parameter');
+        }
+        return this.val.gt(comparisonVal.val);
+    }
+    lt(bn, ignorePrecision) {
+        const comparisonVal = bn instanceof BigNum ? bn : BigNum.from(bn);
+        if (!ignorePrecision && !comparisonVal.val.eq(numericConstants_1.ZERO)) {
+            (0, assert_1.assert)(comparisonVal.precision.eq(this.precision), 'Trying to compare numbers with different precision. Yo can opt to ignore precision using the ignorePrecision parameter');
+        }
+        return this.val.lt(comparisonVal.val);
+    }
+    gte(bn, ignorePrecision) {
+        const comparisonVal = bn instanceof BigNum ? bn : BigNum.from(bn);
+        if (!ignorePrecision && !comparisonVal.val.eq(numericConstants_1.ZERO)) {
+            (0, assert_1.assert)(comparisonVal.precision.eq(this.precision), 'Trying to compare numbers with different precision. Yo can opt to ignore precision using the ignorePrecision parameter');
+        }
+        return this.val.gte(comparisonVal.val);
+    }
+    lte(bn, ignorePrecision) {
+        const comparisonVal = bn instanceof BigNum ? bn : BigNum.from(bn);
+        if (!ignorePrecision && !comparisonVal.val.eq(numericConstants_1.ZERO)) {
+            (0, assert_1.assert)(comparisonVal.precision.eq(this.precision), 'Trying to compare numbers with different precision. Yo can opt to ignore precision using the ignorePrecision parameter');
+        }
+        return this.val.lte(comparisonVal.val);
+    }
+    eq(bn, ignorePrecision) {
+        const comparisonVal = bn instanceof BigNum ? bn : BigNum.from(bn);
+        if (!ignorePrecision && !comparisonVal.val.eq(numericConstants_1.ZERO)) {
+            (0, assert_1.assert)(comparisonVal.precision.eq(this.precision), 'Trying to compare numbers with different precision. Yo can opt to ignore precision using the ignorePrecision parameter');
+        }
+        return this.val.eq(comparisonVal.val);
+    }
+    eqZero() {
+        return this.val.eq(numericConstants_1.ZERO);
+    }
+    gtZero() {
+        return this.val.gt(numericConstants_1.ZERO);
+    }
+    ltZero() {
+        return this.val.lt(numericConstants_1.ZERO);
+    }
+    gteZero() {
+        return this.val.gte(numericConstants_1.ZERO);
+    }
+    lteZero() {
+        return this.val.lte(numericConstants_1.ZERO);
+    }
+    abs() {
+        return new BigNum(this.val.abs(), this.precision);
+    }
+    neg() {
+        return new BigNum(this.val.neg(), this.precision);
+    }
+    /**
+     * Pretty print the underlying value in human-readable form. Depends on precision being correct for the output string to be correct
+     * @returns
+     */
+    print() {
+        (0, assert_1.assert)(this.precision.gte(numericConstants_1.ZERO), 'Tried to print a BN with precision lower than zero');
+        const plainString = this.toString();
+        const precisionNum = this.precision.toNumber();
+        // make a string with at least the precisionNum number of zeroes
+        let printString = [
+            ...Array(this.precision.toNumber()).fill(0),
+            ...plainString.split(''),
+        ].join('');
+        // inject decimal
+        printString =
+            printString.substring(0, printString.length - precisionNum) +
+                BigNum.delim +
+                printString.substring(printString.length - precisionNum);
+        // remove leading zeroes
+        printString = printString.replace(/^0+/, '');
+        // add zero if leading delim
+        if (printString[0] === BigNum.delim)
+            printString = `0${printString}`;
+        // remove trailing delim
+        if (printString[printString.length - 1] === BigNum.delim)
+            printString = printString.slice(0, printString.length - 1);
+        return printString;
+    }
+    prettyPrint() {
+        const [leftSide, rightSide] = this.printShort().split(BigNum.delim);
+        let formattedLeftSide = leftSide;
+        const isNeg = formattedLeftSide.includes('-');
+        if (isNeg) {
+            formattedLeftSide = formattedLeftSide.replace('-', '');
+        }
+        let index = formattedLeftSide.length - 3;
+        while (index >= 1) {
+            const formattedLeftSideArray = formattedLeftSide.split('');
+            formattedLeftSideArray.splice(index, 0, BigNum.spacer);
+            formattedLeftSide = formattedLeftSideArray.join('');
+            index -= 3;
+        }
+        return `${isNeg ? '-' : ''}${formattedLeftSide}${rightSide ? `${BigNum.delim}${rightSide}` : ''}`;
+    }
+    /**
+     * Print and remove unnecessary trailing zeroes
+     * @returns
+     */
+    printShort(useTradePrecision, precisionOverride) {
+        const printVal = precisionOverride
+            ? this.toPrecision(precisionOverride)
+            : useTradePrecision
+                ? this.toTradePrecision()
+                : this.print();
+        return printVal.replace(/0+$/g, '').replace(/\.$/, '').replace(/,$/, '');
+    }
+    debug() {
+        console.log(`${this.toString()} | ${this.print()} | ${this.precision.toString()}`);
+    }
+    /**
+     * Pretty print with the specified number of decimal places
+     * @param fixedPrecision
+     * @returns
+     */
+    toFixed(fixedPrecision) {
+        const printString = this.print();
+        const [leftSide, rightSide] = printString.split(BigNum.delim);
+        const filledRightSide = [
+            ...(rightSide !== null && rightSide !== void 0 ? rightSide : '').slice(0, fixedPrecision),
+            ...Array(fixedPrecision).fill('0'),
+        ]
+            .slice(0, fixedPrecision)
+            .join('');
+        return `${leftSide}${BigNum.delim}${filledRightSide}`;
+    }
+    /**
+     * Pretty print to the specified number of significant figures
+     * @param fixedPrecision
+     * @returns
+     */
+    toPrecision(fixedPrecision, trailingZeroes = false) {
+        const printString = this.print();
+        let precisionPrintString = printString.slice(0, fixedPrecision + 1);
+        if (!precisionPrintString.includes(BigNum.delim) ||
+            precisionPrintString[precisionPrintString.length - 1] === BigNum.delim) {
+            precisionPrintString = printString.slice(0, fixedPrecision);
+        }
+        const pointsOfPrecision = precisionPrintString.replace(BigNum.delim, '').length;
+        if (pointsOfPrecision < fixedPrecision) {
+            precisionPrintString = [
+                ...precisionPrintString.split(''),
+                ...Array(fixedPrecision - pointsOfPrecision).fill('0'),
+            ].join('');
+        }
+        if (!precisionPrintString.includes(BigNum.delim)) {
+            const delimFullStringLocation = printString.indexOf(BigNum.delim);
+            let skipExponent = false;
+            if (delimFullStringLocation === -1) {
+                // no decimal, not missing any precision
+                skipExponent = true;
+            }
+            if (precisionPrintString[precisionPrintString.length - 1] === BigNum.delim) {
+                // decimal is at end of string, not missing any precision, do nothing
+                skipExponent = true;
+            }
+            if (printString.indexOf(BigNum.delim) === fixedPrecision) {
+                // decimal is at end of string, not missing any precision, do nothing
+                skipExponent = true;
+            }
+            if (!skipExponent) {
+                const exponent = delimFullStringLocation - fixedPrecision;
+                if (trailingZeroes) {
+                    precisionPrintString = `${precisionPrintString}${Array(exponent)
+                        .fill('0')
+                        .join('')}`;
+                }
+                else {
+                    precisionPrintString = `${precisionPrintString}e${exponent}`;
+                }
+            }
+        }
+        return precisionPrintString;
+    }
+    toTradePrecision() {
+        return this.toPrecision(6, true);
+    }
+    toNotional() {
+        return `${this.lt(BigNum.zero()) ? `-` : ``}$${BigNum.fromPrint(this.toFixed(2), new anchor_1.BN(2))
+            .prettyPrint()
+            .replace('-', '')}`;
+    }
+    toMillified(precision = 3) {
+        const stringVal = this.print();
+        const [leftSide] = stringVal.split(BigNum.delim);
+        if (!leftSide) {
+            return this.shift(new anchor_1.BN(precision)).toPrecision(precision, true);
+        }
+        if (leftSide.length <= 3) {
+            return this.shift(new anchor_1.BN(precision)).toPrecision(precision, true);
+        }
+        const unitTicks = ['', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y'];
+        const unitNumber = Math.floor((leftSide.length - 1) / 3);
+        const unit = unitTicks[unitNumber];
+        let leadDigits = leftSide.slice(0, precision);
+        if (leadDigits.length < precision) {
+            leadDigits = [
+                ...leadDigits.split(''),
+                ...Array(precision - leadDigits.length).fill('0'),
+            ].join('');
+        }
+        const decimalLocation = leftSide.length - 3 * unitNumber;
+        let leadString = '';
+        if (decimalLocation >= precision) {
+            leadString = `${leadDigits}`;
+        }
+        else {
+            leadString = `${leadDigits.slice(0, decimalLocation)}${BigNum.delim}${leadDigits.slice(decimalLocation)}`;
+        }
+        return `${leadString}${unit}`;
+    }
+    toJSON() {
+        return {
+            val: this.val.toString(),
+            precision: this.precision.toString(),
+        };
+    }
+    isNeg() {
+        return this.lt(numericConstants_1.ZERO, true);
+    }
+    isPos() {
+        return !this.isNeg();
+    }
+    /**
+     * Get the numerical value of the BigNum. This can break if the BigNum is too large.
+     * @returns
+     */
+    toNum() {
+        return parseFloat(this.print());
+    }
+    static fromJSON(json) {
+        return BigNum.from(new anchor_1.BN(json.val), new anchor_1.BN(json.precision));
+    }
+    /**
+     * Create a BigNum instance
+     * @param val
+     * @param precision
+     * @returns
+     */
+    static from(val = numericConstants_1.ZERO, precision) {
+        (0, assert_1.assert)(new anchor_1.BN(precision).lt(new anchor_1.BN(100)), 'Tried to create a bignum with precision higher than 10^100');
+        return new BigNum(val, precision);
+    }
+    /**
+     * Create a BigNum instance from a printed BigNum
+     * @param val
+     * @param precisionOverride
+     * @returns
+     */
+    static fromPrint(val, precisionShift) {
+        var _a;
+        // Handle empty number edge cases
+        if (!val)
+            return BigNum.from(numericConstants_1.ZERO, precisionShift);
+        if (!val.replace(BigNum.delim, ''))
+            return BigNum.from(numericConstants_1.ZERO, precisionShift);
+        const [leftSide, rightSide] = val.split(BigNum.delim);
+        const rawBn = new anchor_1.BN(`${leftSide !== null && leftSide !== void 0 ? leftSide : ''}${rightSide !== null && rightSide !== void 0 ? rightSide : ''}`);
+        const rightSideLength = (_a = rightSide === null || rightSide === void 0 ? void 0 : rightSide.length) !== null && _a !== void 0 ? _a : 0;
+        const totalShift = precisionShift
+            ? precisionShift.sub(new anchor_1.BN(rightSideLength))
+            : numericConstants_1.ZERO;
+        return BigNum.from(rawBn, precisionShift).shift(totalShift, true);
+    }
+    static max(a, b) {
+        return a.gt(b) ? a : b;
+    }
+    static min(a, b) {
+        return a.lt(b) ? a : b;
+    }
+    static zero(precision) {
+        return BigNum.from(0, precision);
+    }
+}
+exports.BigNum = BigNum;
+BigNum.delim = '.';
+BigNum.spacer = ',';

package/lib/factory/oracleClient.d.ts

@@ -1,5 +1,4 @@
 import { OracleSource } from '../types';
 import { Connection } from '@solana/web3.js';
-import { DriftEnv } from '../config';
 import { OracleClient } from '../oracles/types';
-export declare function getOracleClient(oracleSource: OracleSource, connection: Connection, env: DriftEnv): OracleClient;
+export declare function getOracleClient(oracleSource: OracleSource, connection: Connection): OracleClient;

package/lib/factory/oracleClient.js

@@ -4,12 +4,16 @@ exports.getOracleClient = void 0;
 const types_1 = require("../types");
 const pythClient_1 = require("../oracles/pythClient");
 const switchboardClient_1 = require("../oracles/switchboardClient");
-function getOracleClient(oracleSource, connection, env) {
+const quoteAssetOracleClient_1 = require("../oracles/quoteAssetOracleClient");
+function getOracleClient(oracleSource, connection) {
     if ((0, types_1.isVariant)(oracleSource, 'pyth')) {
         return new pythClient_1.PythClient(connection);
     }
     if ((0, types_1.isVariant)(oracleSource, 'switchboard')) {
-        return new switchboardClient_1.SwitchboardClient(connection, env);
+        return new switchboardClient_1.SwitchboardClient(connection);
+    }
+    if ((0, types_1.isVariant)(oracleSource, 'quoteAsset')) {
+        return new quoteAssetOracleClient_1.QuoteAssetOracleClient();
     }
     throw new Error(`Unknown oracle source ${oracleSource}`);
 }