ccxt-ir 4.10.0 → 4.11.0

package/js/src/src/base/types.d.ts

@@ -0,0 +1,586 @@
+export declare type Int = number | undefined;
+export declare type int = number;
+export declare type Str = string | undefined;
+export declare type Strings = string[] | undefined;
+export declare type Num = number | undefined;
+export declare type Bool = boolean | undefined;
+export declare type IndexType = number | string;
+export declare type OrderSide = 'buy' | 'sell' | string | undefined;
+export declare type OrderType = 'limit' | 'market' | string;
+export declare type MarketType = 'spot' | 'margin' | 'swap' | 'future' | 'option' | 'delivery' | 'index' | 'otc';
+export declare type SubType = 'linear' | 'inverse' | undefined;
+export interface Dictionary<T> {
+    [key: string]: T;
+}
+export declare type Dict = Dictionary<any>;
+export declare type NullableDict = Dict | undefined;
+export declare type List = Array<any>;
+export declare type NullableList = List | undefined;
+/** Request parameters */
+export interface MinMax {
+    min: Num;
+    max: Num;
+}
+export interface FeeInterface {
+    currency: Str;
+    cost: Num;
+    rate?: Num;
+}
+export interface TradingFeeInterface {
+    info: any;
+    symbol: Str;
+    maker: Num;
+    taker: Num;
+    percentage: Bool;
+    tierBased: Bool;
+}
+export declare type Fee = FeeInterface | undefined;
+export interface MarketMarginModes {
+    isolated: boolean;
+    cross: boolean;
+}
+export interface MarketInterface {
+    id: Str;
+    numericId?: Num;
+    uppercaseId?: Str;
+    lowercaseId?: Str;
+    symbol: string;
+    base: string;
+    quote: string;
+    baseId: Str;
+    quoteId: Str;
+    active: Bool;
+    type: MarketType;
+    subType?: SubType;
+    spot: boolean;
+    margin: boolean;
+    swap: boolean;
+    future: boolean;
+    option: boolean;
+    contract: boolean;
+    settle: Str;
+    settleId: Str;
+    contractSize: Num;
+    linear: Bool;
+    inverse: Bool;
+    quanto?: boolean;
+    expiry: Int;
+    expiryDatetime: Str;
+    strike: Num;
+    optionType: Str;
+    taker?: Num;
+    maker?: Num;
+    percentage?: Bool;
+    tierBased?: Bool;
+    feeSide?: Str;
+    precision: {
+        amount: Num;
+        price: Num;
+        cost?: Num;
+    };
+    marginModes?: MarketMarginModes;
+    limits: {
+        amount?: MinMax;
+        cost?: MinMax;
+        leverage?: MinMax;
+        price?: MinMax;
+        market?: MinMax;
+    };
+    created: Int;
+    info: any;
+}
+export interface Trade {
+    info: any;
+    amount: Num;
+    datetime: Str;
+    id: Str;
+    order: Str;
+    price: number;
+    timestamp: Int;
+    type: Str;
+    side: 'buy' | 'sell' | Str;
+    symbol: Str;
+    takerOrMaker: 'taker' | 'maker' | Str;
+    cost: Num;
+    fee: Fee;
+}
+export interface Order {
+    id: string;
+    clientOrderId: Str;
+    datetime: string;
+    timestamp: number;
+    lastTradeTimestamp: number;
+    lastUpdateTimestamp?: number;
+    status: 'open' | 'closed' | 'canceled' | Str;
+    symbol: string;
+    type: Str;
+    timeInForce?: Str;
+    side: 'buy' | 'sell' | Str;
+    price: number;
+    average?: number;
+    amount: number;
+    filled: number;
+    remaining: number;
+    stopPrice?: number;
+    triggerPrice?: number;
+    takeProfitPrice?: number;
+    stopLossPrice?: number;
+    cost: number;
+    trades: Trade[];
+    fee: Fee;
+    reduceOnly: Bool;
+    postOnly: Bool;
+    info: any;
+}
+export interface OrderBook {
+    asks: [Num, Num][];
+    bids: [Num, Num][];
+    datetime: Str;
+    timestamp: Int;
+    nonce: Int;
+    symbol: Str;
+}
+export interface OrderBooks extends Dictionary<OrderBook> {
+}
+export interface Ticker {
+    symbol: string;
+    info: any;
+    timestamp: Int;
+    datetime: Str;
+    high: Num;
+    low: Num;
+    bid: Num;
+    bidVolume: Num;
+    ask: Num;
+    askVolume: Num;
+    vwap: Num;
+    open: Num;
+    close: Num;
+    last: Num;
+    previousClose: Num;
+    change: Num;
+    percentage: Num;
+    average: Num;
+    quoteVolume: Num;
+    baseVolume: Num;
+    indexPrice: Num;
+    markPrice: Num;
+}
+export interface Transaction {
+    info: any;
+    id: Str;
+    txid: Str;
+    timestamp: Int;
+    datetime: Str;
+    address: Str;
+    addressFrom: Str;
+    addressTo: Str;
+    tag: Str;
+    tagFrom: Str;
+    tagTo: Str;
+    type: 'deposit' | 'withdrawal' | Str;
+    amount: Num;
+    currency: Str;
+    status: 'pending' | 'ok' | Str;
+    updated: Int;
+    fee: Fee;
+    network: Str;
+    comment: Str;
+    internal: Bool;
+}
+export interface Tickers extends Dictionary<Ticker> {
+}
+export interface CurrencyInterface {
+    id: string;
+    code: string;
+    numericId?: Int;
+    precision: number;
+    type?: Str;
+    margin?: Bool;
+    name?: Str;
+    active?: Bool;
+    deposit?: Bool;
+    withdraw?: Bool;
+    fee?: Num;
+    limits: {
+        amount: {
+            min?: Num;
+            max?: Num;
+        };
+        withdraw: {
+            min?: Num;
+            max?: Num;
+        };
+    };
+    networks: {
+        string: any;
+    };
+    info: any;
+}
+export interface Balance {
+    free: Num;
+    used: Num;
+    total: Num;
+    debt?: Num;
+}
+export interface BalanceAccount {
+    free: Str;
+    used: Str;
+    total: Str;
+}
+export interface Account {
+    id: Str;
+    type: Str;
+    code: Str;
+    info: any;
+}
+export interface PartialBalances extends Dictionary<number> {
+}
+export interface Balances extends Dictionary<Balance> {
+    info: any;
+    timestamp?: any;
+    datetime?: any;
+}
+export interface DepositAddress {
+    info: any;
+    currency: string;
+    network?: string;
+    address: string;
+    tag?: Str;
+}
+export interface WithdrawalResponse {
+    info: any;
+    id: string;
+}
+export interface FundingRate {
+    symbol: string;
+    info: any;
+    timestamp?: number;
+    fundingRate?: number;
+    datetime?: string;
+    markPrice?: number;
+    indexPrice?: number;
+    interestRate?: number;
+    estimatedSettlePrice?: number;
+    fundingTimestamp?: number;
+    fundingDatetime?: string;
+    nextFundingTimestamp?: number;
+    nextFundingDatetime?: string;
+    nextFundingRate?: number;
+    previousFundingTimestamp?: number;
+    previousFundingDatetime?: string;
+    previousFundingRate?: number;
+    interval?: string;
+}
+export interface FundingRates extends Dictionary<FundingRate> {
+}
+export interface Position {
+    symbol: string;
+    id?: Str;
+    info: any;
+    timestamp?: number;
+    datetime?: string;
+    contracts?: number;
+    contractSize?: number;
+    side: Str;
+    notional?: number;
+    leverage?: number;
+    unrealizedPnl?: number;
+    realizedPnl?: number;
+    collateral?: number;
+    entryPrice?: number;
+    markPrice?: number;
+    liquidationPrice?: number;
+    marginMode?: Str;
+    hedged?: boolean;
+    maintenanceMargin?: number;
+    maintenanceMarginPercentage?: number;
+    initialMargin?: number;
+    initialMarginPercentage?: number;
+    marginRatio?: number;
+    lastUpdateTimestamp?: number;
+    lastPrice?: number;
+    stopLossPrice?: number;
+    takeProfitPrice?: number;
+    percentage?: number;
+}
+export interface BorrowInterest {
+    info: any;
+    symbol?: Str;
+    currency?: Str;
+    interest?: number;
+    interestRate?: number;
+    amountBorrowed?: number;
+    marginMode?: Str;
+    timestamp?: Int;
+    datetime?: Str;
+}
+export interface LeverageTier {
+    tier?: number;
+    symbol?: Str;
+    currency?: Str;
+    minNotional?: number;
+    maxNotional?: number;
+    maintenanceMarginRate?: number;
+    maxLeverage?: number;
+    info: any;
+}
+export interface LedgerEntry {
+    info: any;
+    id?: Str;
+    timestamp?: number;
+    datetime?: Str;
+    direction?: Str;
+    account?: Str;
+    referenceId?: Str;
+    referenceAccount?: Str;
+    type?: Str;
+    currency?: Str;
+    amount?: number;
+    before?: number;
+    after?: number;
+    status?: Str;
+    fee?: Fee;
+}
+export interface DepositWithdrawFeeNetwork {
+    fee?: number;
+    percentage?: boolean;
+}
+export interface DepositWithdrawFee {
+    info: any;
+    withdraw?: DepositWithdrawFeeNetwork;
+    deposit?: DepositWithdrawFeeNetwork;
+    networks?: Dictionary<DepositWithdrawFeeNetwork>;
+}
+export interface TransferEntry {
+    info?: any;
+    id?: Str;
+    timestamp?: number;
+    datetime?: Str;
+    currency?: Str;
+    amount?: number;
+    fromAccount?: Str;
+    toAccount?: Str;
+    status?: Str;
+}
+export interface CrossBorrowRate {
+    info: any;
+    currency?: Str;
+    rate: number;
+    period?: number;
+    timestamp?: number;
+    datetime?: Str;
+}
+export interface IsolatedBorrowRate {
+    info: any;
+    symbol: string;
+    base: string;
+    baseRate: number;
+    quote: string;
+    quoteRate: number;
+    period?: Int;
+    timestamp?: Int;
+    datetime?: Str;
+}
+export interface FundingRateHistory {
+    info: any;
+    symbol: string;
+    fundingRate: number;
+    timestamp?: number;
+    datetime?: Str;
+}
+export interface OpenInterest {
+    symbol: string;
+    openInterestAmount?: number;
+    openInterestValue?: number;
+    baseVolume?: number;
+    quoteVolume?: number;
+    timestamp?: number;
+    datetime?: Str;
+    info: any;
+}
+export interface OpenInterests extends Dictionary<OpenInterest> {
+}
+export interface Liquidation {
+    info: any;
+    symbol: string;
+    timestamp?: number;
+    datetime?: Str;
+    price: number;
+    baseValue?: number;
+    quoteValue?: number;
+    side?: OrderSide;
+}
+export interface OrderRequest {
+    symbol: string;
+    type: OrderType;
+    side: OrderSide;
+    amount?: number;
+    price?: number | undefined;
+    params?: any;
+}
+export interface CancellationRequest {
+    id: string;
+    clientOrderId?: string;
+    symbol: string;
+}
+export interface FundingHistory {
+    info: any;
+    symbol: string;
+    code: string;
+    timestamp?: number;
+    datetime?: Str;
+    id: string;
+    amount: number;
+}
+export interface MarginMode {
+    info: any;
+    symbol: string;
+    marginMode: 'isolated' | 'cross' | Str;
+}
+export interface Greeks {
+    symbol: string;
+    timestamp?: number;
+    datetime?: Str;
+    delta: number;
+    gamma: number;
+    theta: number;
+    vega: number;
+    rho: number;
+    vanna?: number;
+    volga?: number;
+    charm?: number;
+    bidSize: number;
+    askSize: number;
+    bidImpliedVolatility: number;
+    askImpliedVolatility: number;
+    markImpliedVolatility: number;
+    bidPrice: number;
+    askPrice: number;
+    markPrice: number;
+    lastPrice: number;
+    underlyingPrice: number;
+    info: any;
+}
+export interface Conversion {
+    info: any;
+    timestamp?: number;
+    datetime?: string;
+    id: string;
+    fromCurrency: string;
+    fromAmount: number;
+    toCurrency: string;
+    toAmount: number;
+    price: number;
+    fee: number;
+}
+export interface Option {
+    info: any;
+    currency: string;
+    symbol: string;
+    timestamp?: number;
+    datetime?: Str;
+    impliedVolatility: number;
+    openInterest: number;
+    bidPrice: number;
+    askPrice: number;
+    midPrice: number;
+    markPrice: number;
+    lastPrice: number;
+    underlyingPrice: number;
+    change: number;
+    percentage: number;
+    baseVolume: number;
+    quoteVolume: number;
+}
+export interface LastPrice {
+    symbol: string;
+    timestamp?: number;
+    datetime?: string;
+    price: number;
+    side?: OrderSide;
+    info: any;
+}
+export interface Leverage {
+    info: any;
+    symbol: string;
+    marginMode: 'isolated' | 'cross' | Str;
+    longLeverage: number;
+    shortLeverage: number;
+}
+export interface LongShortRatio {
+    info: any;
+    symbol: string;
+    timestamp?: number;
+    datetime?: string;
+    timeframe?: string;
+    longShortRatio: number;
+}
+export interface MarginModification {
+    'info': any;
+    'symbol': string;
+    'type': 'add' | 'reduce' | 'set' | undefined;
+    'marginMode': 'cross' | 'isolated' | undefined;
+    'amount': Num;
+    'total': Num;
+    'code': Str;
+    'status': Str;
+    'timestamp': Int;
+    'datetime': Str;
+}
+export interface Leverages extends Dictionary<Leverage> {
+}
+export interface LastPrices extends Dictionary<LastPrice> {
+}
+export interface Currencies extends Dictionary<CurrencyInterface> {
+}
+export interface TradingFees extends Dictionary<TradingFeeInterface> {
+}
+export interface MarginModes extends Dictionary<MarginMode> {
+}
+export interface OptionChain extends Dictionary<Option> {
+}
+export interface IsolatedBorrowRates extends Dictionary<IsolatedBorrowRate> {
+}
+export interface CrossBorrowRates extends Dictionary<CrossBorrowRate> {
+}
+export interface LeverageTiers extends Dictionary<LeverageTier[]> {
+}
+/** [ timestamp, open, high, low, close, volume ] */
+export declare type OHLCV = [Num, Num, Num, Num, Num, Num];
+/** [ timestamp, open, high, low, close, volume, count ] */
+export declare type OHLCVC = [Num, Num, Num, Num, Num, Num, Num];
+export declare type implicitReturnType = any;
+export declare type Market = MarketInterface | undefined;
+export declare type Currency = CurrencyInterface | undefined;
+interface BaseConstructorArgs {
+    apiKey?: string;
+    secret?: string;
+    password?: string;
+    privateKey?: string;
+    walletAddress?: string;
+    uid?: string;
+    verbose?: boolean;
+    sandbox?: boolean;
+    testnet?: boolean;
+    options?: Dict;
+    enableRateLimit?: boolean;
+    httpsProxy?: string;
+    socksProxy?: string;
+    wssProxy?: string;
+    proxy?: string;
+    rateLimit?: number;
+    commonCurrencies?: Dict;
+    userAgent?: string;
+    userAgents?: Dict;
+    timeout?: number;
+    markets?: Dict;
+    currencies?: Dict;
+    hostname?: string;
+    urls?: Dict;
+    headers?: Dict;
+}
+export declare type ConstructorArgs = Partial<BaseConstructorArgs> & {
+    [key: string]: any;
+};
+export {};

package/js/src/src/base/types.js

@@ -0,0 +1,7 @@
+// ----------------------------------------------------------------------------
+
+// PLEASE DO NOT EDIT THIS FILE, IT IS GENERATED AND WILL BE OVERWRITTEN:
+// https://github.com/ccxt/ccxt/blob/master/CONTRIBUTING.md#how-to-contribute-code
+// EDIT THE CORRESPONDENT .ts FILE INSTEAD
+
+export {};

package/js/src/src/base/ws/Cache.d.ts

@@ -0,0 +1,27 @@
+interface CustomArray extends Array<any> {
+    hashmap: object;
+}
+declare class BaseCache extends Array {
+    constructor(maxSize?: any);
+    clear(): void;
+}
+declare class ArrayCache extends BaseCache implements CustomArray {
+    hashmap: object;
+    constructor(maxSize?: any);
+    getLimit(symbol: any, limit: any): any;
+    append(item: any): void;
+}
+declare class ArrayCacheByTimestamp extends BaseCache {
+    constructor(maxSize?: any);
+    getLimit(symbol: any, limit: any): any;
+    append(item: any): void;
+}
+declare class ArrayCacheBySymbolById extends ArrayCache {
+    constructor(maxSize?: any);
+    append(item: any): void;
+}
+declare class ArrayCacheBySymbolBySide extends ArrayCache {
+    constructor();
+    append(item: any): void;
+}
+export { ArrayCache, ArrayCacheByTimestamp, ArrayCacheBySymbolById, ArrayCacheBySymbolBySide, };