@dydxprotocol/v4-client-js 0.30.0

package/build/node_modules/@dydxprotocol/dydxjs/src/codegen/dydxprotocol/perpetuals/params.d.ts

@@ -0,0 +1,34 @@
+import * as _m0 from "protobufjs/minimal";
+/** Params defines the parameters for x/perpetuals module. */
+export interface Params {
+    /**
+     * Funding rate clamp factor in parts-per-million, used for clamping 8-hour
+     * funding rates according to equation: |R| <= funding_rate_clamp_factor *
+     * (initial margin - maintenance margin).
+     */
+    fundingRateClampFactorPpm: number;
+    /**
+     * Premium vote clamp factor in parts-per-million, used for clamping premium
+     * votes according to equation: |V| <= premium_vote_clamp_factor *
+     * (initial margin - maintenance margin).
+     */
+    premiumVoteClampFactorPpm: number;
+    /**
+     * Minimum number of premium votes per premium sample. If number of premium
+     * votes is smaller than this number, pad with zeros up to this number.
+     */
+    minNumVotesPerSample: number;
+}
+/** Params defines the parameters for x/perpetuals module. */
+export interface ParamsSDKType {
+    funding_rate_clamp_factor_ppm: number;
+    premium_vote_clamp_factor_ppm: number;
+    min_num_votes_per_sample: number;
+}
+export declare const Params: {
+    encode(message: Params, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Params;
+    fromJSON(object: any): Params;
+    toJSON(message: Params): unknown;
+    fromPartial(object: Partial<Params>): Params;
+};

package/build/node_modules/@dydxprotocol/dydxjs/src/codegen/dydxprotocol/perpetuals/params.js

@@ -0,0 +1,95 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Params = void 0;
+const _m0 = __importStar(require("protobufjs/minimal"));
+const helpers_1 = require("../../helpers");
+function createBaseParams() {
+    return {
+        fundingRateClampFactorPpm: 0,
+        premiumVoteClampFactorPpm: 0,
+        minNumVotesPerSample: 0
+    };
+}
+exports.Params = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.fundingRateClampFactorPpm !== 0) {
+            writer.uint32(8).uint32(message.fundingRateClampFactorPpm);
+        }
+        if (message.premiumVoteClampFactorPpm !== 0) {
+            writer.uint32(16).uint32(message.premiumVoteClampFactorPpm);
+        }
+        if (message.minNumVotesPerSample !== 0) {
+            writer.uint32(24).uint32(message.minNumVotesPerSample);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseParams();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    message.fundingRateClampFactorPpm = reader.uint32();
+                    break;
+                case 2:
+                    message.premiumVoteClampFactorPpm = reader.uint32();
+                    break;
+                case 3:
+                    message.minNumVotesPerSample = reader.uint32();
+                    break;
+                default:
+                    reader.skipType(tag & 7);
+                    break;
+            }
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            fundingRateClampFactorPpm: (0, helpers_1.isSet)(object.fundingRateClampFactorPpm) ? Number(object.fundingRateClampFactorPpm) : 0,
+            premiumVoteClampFactorPpm: (0, helpers_1.isSet)(object.premiumVoteClampFactorPpm) ? Number(object.premiumVoteClampFactorPpm) : 0,
+            minNumVotesPerSample: (0, helpers_1.isSet)(object.minNumVotesPerSample) ? Number(object.minNumVotesPerSample) : 0
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        message.fundingRateClampFactorPpm !== undefined && (obj.fundingRateClampFactorPpm = Math.round(message.fundingRateClampFactorPpm));
+        message.premiumVoteClampFactorPpm !== undefined && (obj.premiumVoteClampFactorPpm = Math.round(message.premiumVoteClampFactorPpm));
+        message.minNumVotesPerSample !== undefined && (obj.minNumVotesPerSample = Math.round(message.minNumVotesPerSample));
+        return obj;
+    },
+    fromPartial(object) {
+        var _a, _b, _c;
+        const message = createBaseParams();
+        message.fundingRateClampFactorPpm = (_a = object.fundingRateClampFactorPpm) !== null && _a !== void 0 ? _a : 0;
+        message.premiumVoteClampFactorPpm = (_b = object.premiumVoteClampFactorPpm) !== null && _b !== void 0 ? _b : 0;
+        message.minNumVotesPerSample = (_c = object.minNumVotesPerSample) !== null && _c !== void 0 ? _c : 0;
+        return message;
+    }
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGFyYW1zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vLi4vLi4vbm9kZV9tb2R1bGVzL0BkeWR4cHJvdG9jb2wvZHlkeGpzL3NyYy9jb2RlZ2VuL2R5ZHhwcm90b2NvbC9wZXJwZXR1YWxzL3BhcmFtcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHdEQUEwQztBQUMxQywyQ0FBc0M7QUFnQ3RDLFNBQVMsZ0JBQWdCO0lBQ3ZCLE9BQU87UUFDTCx5QkFBeUIsRUFBRSxDQUFDO1FBQzVCLHlCQUF5QixFQUFFLENBQUM7UUFDNUIsb0JBQW9CLEVBQUUsQ0FBQztLQUN4QixDQUFDO0FBQ0osQ0FBQztBQUVZLFFBQUEsTUFBTSxHQUFHO0lBQ3BCLE1BQU0sQ0FBQyxPQUFlLEVBQUUsU0FBcUIsR0FBRyxDQUFDLE1BQU0sQ0FBQyxNQUFNLEVBQUU7UUFDOUQsSUFBSSxPQUFPLENBQUMseUJBQXlCLEtBQUssQ0FBQyxFQUFFO1lBQzNDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyx5QkFBeUIsQ0FBQyxDQUFDO1NBQzVEO1FBRUQsSUFBSSxPQUFPLENBQUMseUJBQXlCLEtBQUssQ0FBQyxFQUFFO1lBQzNDLE1BQU0sQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyx5QkFBeUIsQ0FBQyxDQUFDO1NBQzdEO1FBRUQsSUFBSSxPQUFPLENBQUMsb0JBQW9CLEtBQUssQ0FBQyxFQUFFO1lBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO1NBQ3hEO1FBRUQsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztJQUVELE1BQU0sQ0FBQyxLQUE4QixFQUFFLE1BQWU7UUFDcEQsTUFBTSxNQUFNLEdBQUcsS0FBSyxZQUFZLEdBQUcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsSUFBSSxHQUFHLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQzNFLElBQUksR0FBRyxHQUFHLE1BQU0sS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxHQUFHLEdBQUcsTUFBTSxDQUFDO1FBQ2xFLE1BQU0sT0FBTyxHQUFHLGdCQUFnQixFQUFFLENBQUM7UUFFbkMsT0FBTyxNQUFNLENBQUMsR0FBRyxHQUFHLEdBQUcsRUFBRTtZQUN2QixNQUFNLEdBQUcsR0FBRyxNQUFNLENBQUMsTUFBTSxFQUFFLENBQUM7WUFFNUIsUUFBUSxHQUFHLEtBQUssQ0FBQyxFQUFFO2dCQUNqQixLQUFLLENBQUM7b0JBQ0osT0FBTyxDQUFDLHlCQUF5QixHQUFHLE1BQU0sQ0FBQyxNQUFNLEVBQUUsQ0FBQztvQkFDcEQsTUFBTTtnQkFFUixLQUFLLENBQUM7b0JBQ0osT0FBTyxDQUFDLHlCQUF5QixHQUFHLE1BQU0sQ0FBQyxNQUFNLEVBQUUsQ0FBQztvQkFDcEQsTUFBTTtnQkFFUixLQUFLLENBQUM7b0JBQ0osT0FBTyxDQUFDLG9CQUFvQixHQUFHLE1BQU0sQ0FBQyxNQUFNLEVBQUUsQ0FBQztvQkFDL0MsTUFBTTtnQkFFUjtvQkFDRSxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsQ0FBQztvQkFDekIsTUFBTTthQUNUO1NBQ0Y7UUFFRCxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0lBRUQsUUFBUSxDQUFDLE1BQVc7UUFDbEIsT0FBTztZQUNMLHlCQUF5QixFQUFFLElBQUEsZUFBSyxFQUFDLE1BQU0sQ0FBQyx5QkFBeUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLHlCQUF5QixDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDakgseUJBQXlCLEVBQUUsSUFBQSxlQUFLLEVBQUMsTUFBTSxDQUFDLHlCQUF5QixDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMseUJBQXlCLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNqSCxvQkFBb0IsRUFBRSxJQUFBLGVBQUssRUFBQyxNQUFNLENBQUMsb0JBQW9CLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1NBQ25HLENBQUM7SUFDSixDQUFDO0lBRUQsTUFBTSxDQUFDLE9BQWU7UUFDcEIsTUFBTSxHQUFHLEdBQVEsRUFBRSxDQUFDO1FBQ3BCLE9BQU8sQ0FBQyx5QkFBeUIsS0FBSyxTQUFTLElBQUksQ0FBQyxHQUFHLENBQUMseUJBQXlCLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMseUJBQXlCLENBQUMsQ0FBQyxDQUFDO1FBQ25JLE9BQU8sQ0FBQyx5QkFBeUIsS0FBSyxTQUFTLElBQUksQ0FBQyxHQUFHLENBQUMseUJBQXlCLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMseUJBQXlCLENBQUMsQ0FBQyxDQUFDO1FBQ25JLE9BQU8sQ0FBQyxvQkFBb0IsS0FBSyxTQUFTLElBQUksQ0FBQyxHQUFHLENBQUMsb0JBQW9CLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsb0JBQW9CLENBQUMsQ0FBQyxDQUFDO1FBQ3BILE9BQU8sR0FBRyxDQUFDO0lBQ2IsQ0FBQztJQUVELFdBQVcsQ0FBQyxNQUF1Qjs7UUFDakMsTUFBTSxPQUFPLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQztRQUNuQyxPQUFPLENBQUMseUJBQXlCLEdBQUcsTUFBQSxNQUFNLENBQUMseUJBQXlCLG1DQUFJLENBQUMsQ0FBQztRQUMxRSxPQUFPLENBQUMseUJBQXlCLEdBQUcsTUFBQSxNQUFNLENBQUMseUJBQXlCLG1DQUFJLENBQUMsQ0FBQztRQUMxRSxPQUFPLENBQUMsb0JBQW9CLEdBQUcsTUFBQSxNQUFNLENBQUMsb0JBQW9CLG1DQUFJLENBQUMsQ0FBQztRQUNoRSxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0NBRUYsQ0FBQyJ9

package/build/node_modules/@dydxprotocol/dydxjs/src/codegen/dydxprotocol/perpetuals/perpetual.d.ts

@@ -0,0 +1,178 @@
+/// <reference types="long" />
+import { Long } from "../../helpers";
+import * as _m0 from "protobufjs/minimal";
+/** Perpetual represents a perpetual on the dYdX exchange. */
+export interface Perpetual {
+    /**
+     * ==== Non-updatable fields. ====
+     * Unique, sequentially-generated.
+     */
+    id: number;
+    /** The name of the `Perpetual` (e.g. `BTC-USD`). */
+    ticker: string;
+    /**
+     * The market associated with this `Perpetual`. It
+     * acts as the oracle price for the purposes of calculating
+     * collateral, margin requirements, and funding rates.
+     */
+    marketId: number;
+    /**
+     * The exponent for converting an atomic amount (`size = 1`)
+     * to a full coin. For example, if `AtomicResolution = -8`
+     * then a `PerpetualPosition` with `size = 1e8` is equivalent to
+     * a position size of one full coin.
+     */
+    atomicResolution: number;
+    /**
+     * ==== Governance-updatable fields. ====
+     * The default funding payment if there is no price premium. In
+     * parts-per-million.
+     */
+    defaultFundingPpm: number;
+    /** The liquidity_tier that this perpetual is associated with. */
+    liquidityTier: number;
+    /**
+     * ==== Regularly-updated fields. ====
+     * The current index determined by the cumulative all-time
+     * history of the funding mechanism. Starts at zero.
+     */
+    fundingIndex: Uint8Array;
+    /**
+     * The total open-interest of the perpetual used for
+     * bookkeeping purposes. In base quantums.
+     */
+    openInterest: Long;
+}
+/** Perpetual represents a perpetual on the dYdX exchange. */
+export interface PerpetualSDKType {
+    id: number;
+    ticker: string;
+    market_id: number;
+    atomic_resolution: number;
+    default_funding_ppm: number;
+    liquidity_tier: number;
+    funding_index: Uint8Array;
+    open_interest: Long;
+}
+/** MarketPremiums stores a list of premiums for a single perpetual market. */
+export interface MarketPremiums {
+    /** perpetual_id is the Id of the perpetual market. */
+    perpetualId: number;
+    /**
+     * premiums is a list of premium values for a perpetual market. Since most
+     * premiums are zeros under "stable" market conditions, only non-zero values
+     * are stored in this list.
+     */
+    premiums: number[];
+}
+/** MarketPremiums stores a list of premiums for a single perpetual market. */
+export interface MarketPremiumsSDKType {
+    perpetual_id: number;
+    premiums: number[];
+}
+/**
+ * PremiumStore is a struct to store a perpetual premiums for all
+ * perpetual markets. It stores a list of `MarketPremiums`, each of which
+ * corresponds to a perpetual market and stores a list of non-zero premium
+ * values for that market.
+ * This struct can either be used to store `PremiumVotes` or
+ * `PremiumSamples`.
+ */
+export interface PremiumStore {
+    /**
+     * all_market_premiums a list of `MarketPremiums`, each corresponding to
+     * a perpetual market.
+     */
+    allMarketPremiums: MarketPremiums[];
+    /**
+     * number of rounds where premium values were added. This value indicates
+     * the total number of premiums (zeros and non-zeros) for each
+     * `MarketPremiums` struct. Note that in the edge case a perpetual market was
+     * added in the middle of a epoch, we don't keep a seperate count for that
+     * market. This means we treat this market as having zero premiums before it
+     * was added.
+     */
+    numPremiums: number;
+}
+/**
+ * PremiumStore is a struct to store a perpetual premiums for all
+ * perpetual markets. It stores a list of `MarketPremiums`, each of which
+ * corresponds to a perpetual market and stores a list of non-zero premium
+ * values for that market.
+ * This struct can either be used to store `PremiumVotes` or
+ * `PremiumSamples`.
+ */
+export interface PremiumStoreSDKType {
+    all_market_premiums: MarketPremiumsSDKType[];
+    num_premiums: number;
+}
+/** LiquidityTier stores margin information. */
+export interface LiquidityTier {
+    /** Unique id. */
+    id: number;
+    /** The name of the tier purely for mnemonic purposes, e.g. "Gold". */
+    name: string;
+    /**
+     * The margin fraction needed to open a position.
+     * In parts-per-million.
+     */
+    initialMarginPpm: number;
+    /**
+     * The fraction of the initial-margin that the maintenance-margin is,
+     * e.g. 50%. In parts-per-million.
+     */
+    maintenanceFractionPpm: number;
+    /**
+     * The maximum position size at which the margin requirements are
+     * not increased over the default values. Above this position size,
+     * the margin requirements increase at a rate of sqrt(size).
+     */
+    basePositionNotional: Long;
+    /**
+     * The impact notional amount (in quote quantums) is used to determine impact
+     * bid/ask prices and its recommended value is 500 USDC / initial margin
+     * fraction.
+     * - Impact bid price = average execution price for a market sell of the
+     * impact notional value.
+     * - Impact ask price = average execution price for a market buy of the
+     * impact notional value.
+     */
+    impactNotional: Long;
+}
+/** LiquidityTier stores margin information. */
+export interface LiquidityTierSDKType {
+    id: number;
+    name: string;
+    initial_margin_ppm: number;
+    maintenance_fraction_ppm: number;
+    base_position_notional: Long;
+    impact_notional: Long;
+}
+export declare const Perpetual: {
+    encode(message: Perpetual, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Perpetual;
+    fromJSON(object: any): Perpetual;
+    toJSON(message: Perpetual): unknown;
+    fromPartial(object: Partial<Perpetual>): Perpetual;
+};
+export declare const MarketPremiums: {
+    encode(message: MarketPremiums, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): MarketPremiums;
+    fromJSON(object: any): MarketPremiums;
+    toJSON(message: MarketPremiums): unknown;
+    fromPartial(object: Partial<MarketPremiums>): MarketPremiums;
+};
+export declare const PremiumStore: {
+    encode(message: PremiumStore, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PremiumStore;
+    fromJSON(object: any): PremiumStore;
+    toJSON(message: PremiumStore): unknown;
+    fromPartial(object: Partial<PremiumStore>): PremiumStore;
+};
+export declare const LiquidityTier: {
+    encode(message: LiquidityTier, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): LiquidityTier;
+    fromJSON(object: any): LiquidityTier;
+    toJSON(message: LiquidityTier): unknown;
+    fromPartial(object: Partial<LiquidityTier>): LiquidityTier;
+};