@deriverse/kit 1.0.38 → 1.0.41

package/dist/types.d.ts

@@ -1,565 +0,0 @@
-import { Address, Commitment } from "@solana/kit";
-import { BaseCrncyRecordModel, ClientCommunityAccountHeaderModel, ClientCommunityRecordModel, CommunityAccountHeaderModel, InstrAccountHeaderModel, LineQuotesModel, OrderModel } from "./structure_models";
-import { BuyMarketSeatReportModel, DepositReportModel, DrvsAirdropReportModel, EarningsReportModel, FeesDepositReportModel, FeesWithdrawReportModel, PerpChangeLeverageReportModel, PerpDepositReportModel, PerpFeesReportModel, PerpFillOrderReportModel, PerpFundingReportModel, PerpMassCancelReportModel, PerpNewOrderReportModel, PerpOrderCancelReportModel, PerpOrderRevokeReportModel, PerpPlaceMassCancelReportModel, PerpPlaceOrderReportModel, PerpSocLossReportModel, PerpWithdrawReportModel, SellMarketSeatReportModel, SpotFeesReportModel, SpotFillOrderReportModel, SpotlpTradeReportModel, SpotMassCancelReportModel, SpotNewOrderReportModel, SpotOrderCancelReportModel, SpotOrderRevokeReportModel, SpotPlaceMassCancelReportModel, SpotPlaceOrderReportModel, WithdrawReportModel } from "./logs_models";
-export declare enum InstrMask {
-    DRV = 268435456,
-    READY_TO_DRV_UPGRADE = 536870912,
-    PERP = 1073741824,
-    ORACLE = 2147483648,
-    READY_TO_PERP_UPGRADE = 16777216
-}
-export declare enum AccountType {
-    CLIENT_COMMUNITY = 35,
-    CLIENT_PRIMARY = 31,
-    COMMUNITY = 34,
-    HOLDER = 1,
-    ROOT = 2,
-    INSTR = 7,
-    SPOT_15M_CANDLES = 20,
-    SPOT_1M_CANDLES = 19,
-    SPOT_ASK_ORDERS = 17,
-    SPOT_ASKS_TREE = 15,
-    SPOT_BID_ORDERS = 16,
-    SPOT_BIDS_TREE = 14,
-    SPOT_CLIENT_INFOS = 12,
-    SPOT_CLIENT_INFOS2 = 13,
-    SPOT_DAY_CANDLES = 21,
-    SPOT_LINES = 18,
-    SPOT_MAPS = 10,
-    TOKEN = 4,
-    PERP_ASK_ORDERS = 36,
-    PERP_ASKS_TREE = 37,
-    PERP_BID_ORDERS = 38,
-    PERP_BIDS_TREE = 39,
-    PERP_CLIENT_INFOS = 41,
-    PERP_CLIENT_INFOS2 = 42,
-    PERP_CLIENT_INFOS3 = 43,
-    PERP_CLIENT_INFOS4 = 44,
-    PERP_CLIENT_INFOS5 = 45,
-    PERP_LINES = 46,
-    PERP_MAPS = 47,
-    PERP_LONG_PX_TREE = 48,
-    PERP_SHORT_PX_TREE = 49,
-    PERP_REBALANCE_TIME_TREE = 50,
-    PRIVATE_CLIENTS = 51
-}
-export declare const VERSION = 1;
-export declare const PROGRAM_ID: Address<"DRVSpZ2YUYYKgZP8XtLhAGtT1zYSCKzeHfb4DgRnrgqD">;
-export declare const MARKET_DEPTH = 20;
-export interface EngineArgs {
-    programId?: Address<any>;
-    version?: number;
-    commitment?: Commitment;
-    uiNumbers?: boolean;
-}
-/**
- * @property {number} instrId Instrument ID
- */
-export interface InstrId {
-    instrId: number;
-}
-/**
- * Contains data about orderbook line
- * @property {number} px Price
- * @property {number} qty Quantity
- */
-export interface LinePx {
-    px: number;
-    qty: number;
-}
-/**
- * Contains data about instrument
- * @property {Address} address Instrument account address
- * @property {InstrAccountHeaderModel} header Instrument account header
- * @property {LineQuotesModel[]} spotBids Spot bids
- * @property {LineQuotesModel[]} spotAsks Spot asks
- * @property {LineQuotesModel[]} perpBids Perp bids
- * @property {LineQuotesModel[]} perpAsks Perp bids
- */
-export interface Instrument {
-    address: Address;
-    header: InstrAccountHeaderModel;
-    spotBids: LineQuotesModel[];
-    spotAsks: LineQuotesModel[];
-    perpBids: LineQuotesModel[];
-    perpAsks: LineQuotesModel[];
-}
-/**
- * Contains data about Token
- * @property {Address} account Deriverse account that stores data about registered token
- * @property {Address} mint Mint token address
- * @property {Address} programAddress SPL token account in which tokens are stored
- * @property {number} id Token ID
- * @property {number} decimals Decimals
- * @property {boolean} baseCrncy Ff this token is currency - true
- * @property {boolean} pool If this token is options pool token - true
- * @property {boolean} token2022 If this token is token 2022 - true
- * @property {number} mainInstrId If If this token is options pool token refers to main instrument ID
- */
-export interface Token {
-    account: Address;
-    mint: Address;
-    programAddress: Address;
-    id: number;
-    decimals: number;
-    baseCrncy: boolean;
-    pool: boolean;
-    token2022: boolean;
-    mainInstrId?: number;
-}
-/**
- * Contains data for getClientSpotOrdersInfo function
- * @property {number} instrId Instrument ID
- * @property {number} clientId Temporary spot client ID. Use getClientData function to get this value.
- */
-export interface GetClientSpotOrdersInfoArgs {
-    instrId: number;
-    clientId: number;
-}
-/**
- * Contains data for getClientPerpOrdersInfo function
- * @property {number} instrId Instrument ID
- * @property {number} clientId Temporary perp client ID. Use getClientData function to get this value.
- */
-export interface GetClientPerpOrdersInfoArgs {
-    instrId: number;
-    clientId: number;
-}
-/**
- * Contains data for addSpotOrderInstruction
- * @property {number} instrId Instrument ID
- * @property {number} price Order price
- * @property {number} qty Order quantity
- * @property {number} ioc - Immediate Or Cancel. If true no new open order after this instruction execution.
- * @property {number} orderType 0 - Limit, 1 - Market
- * @property {number} side 0 - Bid, 1 - Ask
- */
-export interface NewSpotOrderArgs {
-    instrId: number;
-    price: number;
-    qty: number;
-    ioc?: number;
-    orderType?: number;
-    side: number;
-    edgePrice?: number;
-}
-/**
- * Contains data for spotQuotesReplaceInstruction
- * @property {number} instrId Instrument ID
- * @property {number} bidOrderIdToCancel Order ID that you want to cancel on bid side, zero value means no actions
- * @property {number} askOrderIdToCancel Order ID that you want to cancel on ask side, zero value means no actions
- * @property {number} newBidPrice New order bid price
- * @property {number} newAskPrice New order ask price
- * @property {number} newBidQty New order bid quantity, zero value means no actions
- * @property {number} newAskQty New order ask quantity, zero value means no actions
- */
-export interface SpotQuotesReplaceArgs {
-    instrId: number;
-    bidOrderIdToCancel: number;
-    newBidPrice: number;
-    newBidQty: number;
-    askOrderIdToCancel: number;
-    newAskPrice: number;
-    newAskQty: number;
-}
-/**
- * Contains data for swapInstruction
- * @property {Address} assetMint Asset Token Mint
- * @property {Address} crncyMint Crncy Token Mint
- * @property {number} amount Amount to swap
- * @property {number} limitPrice limit price
- * @property {boolean} crncyInput crncy token as input token
- */
-export interface SwapArgs {
-    assetMint: Address<any>;
-    crncyMint: Address<any>;
-    amount: number;
-    limitPrice: number;
-    crncyInput: boolean;
-}
-/**
- * Contains data for perpQuotesReplaceInstruction
- * @property {number} instrId Instrument ID
- * @property {number} bidOrderIdToCancel Order ID that you want to cancel on bid side, zero value means no actions
- * @property {number} askOrderIdToCancel Order ID that you want to cancel on ask side, zero value means no actions
- * @property {number} newBidPrice New order bid price
- * @property {number} newAskPrice New order ask price
- * @property {number} newBidQty New order bid quantity, zero value means no actions
- * @property {number} newAskQty New order ask quantity, zero value means no actions
- */
-export interface PerpQuotesReplaceArgs {
-    instrId: number;
-    bidOrderIdToCancel: number;
-    newBidPrice: number;
-    newBidQty: number;
-    askOrderIdToCancel: number;
-    newAskPrice: number;
-    newAskQty: number;
-}
-/**
- * Contains general data about client spot open orders in particular instrument
- * @property {number} bidsCount Open bid orders count
- * @property {number} asksCount Open ask orders count
- * @property {number} bidsEntry Entrypoint in bid orders account
- * @property {number} asksEntry Entrypoint in ask orders account
- * @property {number} contextSlot Context slot of response
- * @property {number} bidSlot Client open bid orders last update slot
- * @property {number} askSlot Client open ask orders last update slot
- * @property {number} tempAssetTokens Asset tokens available to withdraw from client instrument temporary account.
- * It will be automatically transfer to main account during any active transaction with the instrument.
- * @property {number} tempBaseCrncyTokens Base currency tokens available to withdraw from client instrument temporary account
- * It will be automatically transfer to main account during any active transaction with the instrument.
- */
-export interface GetClientSpotOrdersInfoResponse {
-    bidsCount: number;
-    asksCount: number;
-    bidsEntry: number;
-    asksEntry: number;
-    bidSlot: number;
-    askSlot: number;
-    contextSlot: number;
-    tempAssetTokens: number;
-    tempCrncyTokens: number;
-    inOrdersAssetTokens: number;
-    inOrdersCrncyTokens: number;
-}
-/**
- * Contains general data about client perps in particular instrument
- * @property {number} bidsCount Open bid orders count
- * @property {number} asksCount Open ask orders count
- * @property {number} bidsEntry Entrypoint in bid orders account
- * @property {number} asksEntry Entrypoint in ask orders account
- * @property {number} contextSlot Context slot of response
- * @property {number} bidSlot Client open bid orders last update slot
- * @property {number} askSlot Client open ask orders last update slot
- * @property {number} perps Margin account perps balance
- * @property {number} funds Margin account funds balance
- * @property {number} inOrdersPerps Perps in orders
- * @property {number} inOrdersFunds Funds in orders
- * @property {number} fees Fees statistics
- * @property {number} rebates Rebates statistics
- * @property {number} fundingFunds Funding rate payments statistics
- * @property {number} socLossFunds Socialized losses payments statistics
- * @property {number} result Realized PnL statistics
- * @property {number} cost Position cost
- * @property {number} mask contains some imnformation. First byte - leverage level
- */
-export interface GetClientPerpOrdersInfoResponse {
-    bidsCount: number;
-    asksCount: number;
-    bidsEntry: number;
-    asksEntry: number;
-    bidSlot: number;
-    askSlot: number;
-    contextSlot: number;
-    perps: number;
-    funds: number;
-    inOrdersPerps: number;
-    inOrdersFunds: number;
-    fees: number;
-    rebates: number;
-    socLossFunds: number;
-    fundingFunds: number;
-    lossCoverage: number;
-    result: number;
-    cost: number;
-    mask: number;
-}
-/**
- * Contains data for getClientSpotOrders function
- * @property {number} instrId instrument ID
- * @property {number} bidsCount Client spot bid orders count. Use getClientSpotOrdersInfo function to get this value.
- * @property {number} asksCount Client spot ask orders count. Use getClientSpotOrdersInfo function to get this value.
- * @property {number} bidsEntry Entrypoint in spot bid orders account. Use getClientSpotOrdersInfo function to get this value.
- * @property {number} asksEntry Entrypoint in spot ask orders account. Use getClientSpotOrdersInfo function to get this value.
- */
-export interface GetClientSpotOrdersArgs {
-    instrId: number;
-    bidsCount: number;
-    asksCount: number;
-    bidsEntry: number;
-    asksEntry: number;
-}
-/**
- * Contains data for getClientPerpOrders function
- * @property {number} instrId instrument ID
- * @property {number} bidsCount Client spot bid orders count. Use getClientPerpOrdersInfo function to get this value.
- * @property {number} asksCount Client spot ask orders count. Use getClientPerpOrdersInfo function to get this value.
- * @property {number} bidsEntry Entrypoint in spot bid orders account. Use getClientPerpOrdersInfo function to get this value.
- * @property {number} asksEntry Entrypoint in spot ask orders account. Use getClientPerpOrdersInfo function to get this value.
- */
-export interface GetClientPerpOrdersArgs {
-    instrId: number;
-    bidsCount: number;
-    asksCount: number;
-    bidsEntry: number;
-    asksEntry: number;
-}
-/**
- * @property {number} bidContextSlot Client spot bids data context slot
- * @property {number} askContextSlot Client spot asks data context slot
- * @property {OrderModel[]} bids List of client bid spot orders
- * @property {OrderModel[]} asks List of client ask spot orders
- */
-export interface GetClientSpotOrdersResponse {
-    contextSlot: number;
-    bids: OrderModel[];
-    asks: OrderModel[];
-}
-/**
- * @property {number} bidContextSlot Client perp bids data context slot
- * @property {number} askContextSlot Client perp asks data context slot
- * @property {OrderModel[]} bids List of client bid perp orders
- * @property {OrderModel[]} asks List of client ask perp orders
- */
-export interface GetClientPerpOrdersResponse {
-    contextSlot: number;
-    bids: Array<OrderModel>;
-    asks: Array<OrderModel>;
-}
-/**
- * Contains data for spotOrderCancelInstruction function
- * @property {number} instrId Instrument ID
- * @property {number} orderId Order ID to cancel
- * @property {number} side Side. 0 - bid side, 1 - ask side
- */
-export interface SpotOrderCancelArgs {
-    instrId: number;
-    orderId: number;
-    side: number;
-}
-/**
- * Contains data for perpOrderCancelInstruction function
- * @property {number} instrId Instrument ID
- * @property {number} orderId Order ID to cancel
- * @property {number} side Side. 0 - bid side, 1 - ask side
- */
-export interface PerpOrderCancelArgs {
-    instrId: number;
-    orderId: number;
-    side: number;
-}
-/**
- * Contains data for deposit function
- *  @property {number} tokenId Deriverse SPL token registered ID
- *  @property {number} amount Amount to deposit
- *  @property {number} refId  Referal Link ID for new account. Zero means no ref link
- *  @property {number} refId  Referal Wallet
- */
-export interface DepositArgs {
-    tokenId: number;
-    amount?: number;
-    refId?: number;
-    refWallet?: Address;
-    all_funds?: boolean;
-}
-/**
- * Contains data about SPL tokens on main client account
- * @property {number} tokenId Deriverse SPL token registered ID
- * @property {number} amount Amount of SPL tokens on main client account
- */
-export interface ClientTokenData {
-    tokenId: number;
-    amount: number;
-}
-/**
- * Contains data about  Deriverse internal spot LP tokens on main client account
- * @property {number} instrId Instrument ID
- * @property {number} amount Amount of Deriverse internal spot LP tokens on main client account
- */
-export interface ClientLpData {
-    instrId: number;
-    amount: number;
-}
-/**
- * Contains data about temporary instrument spot client account
- * @property {number} instrId Instrument ID
- * @property {number} clientId Temporary client ID
- * @property {number} slot Temporary instrument client last update slot
- */
-export interface ClientSpotData {
-    instrId: number;
-    clientId: number;
-    slot: number;
-}
-/**
- * Contains data about temporary instrument perp client account
- * @property {number} instrId Instrument ID
- * @property {number} clientId Temporary client ID
- * @property {number} slot Temporary instrument client last update slot
- */
-export interface ClientPerpData {
-    instrId: number;
-    clientId: number;
-    slot: number;
-}
-/**
- * Contains information about referal link
- * @property {number} id Referal ID
- * @property {number} expiration Expiration date of referal link
- * @property {number} discount Fees discount
- * @property {number} ratio Referal payments share in fees (minus rebates)
- */
-export interface RefLink {
-    id: number;
-    expiration: number;
-    discount: number;
-    ratio: number;
-}
-export interface CommunityData {
-    header: CommunityAccountHeaderModel;
-    data: Map<number, BaseCrncyRecordModel>;
-}
-export interface ClientCommunityData {
-    header: ClientCommunityAccountHeaderModel;
-    data: Map<number, ClientCommunityRecordModel>;
-}
-/**
- * Contains information about referal program
- * @property {number} address Refferal Wallet
- * @property {number} expiration Expiration date of referal program
- * @property {number} clientId Referal client ID
- * @property {number} discount Fees discount
- * @property {number} ratio Referal payments share in fees (minus rebates)
- */
-export interface ClientRefProgramData {
-    address: Address;
-    expiration: number;
-    clientId: number;
-    disount: number;
-    ratio: number;
-}
-/**
- * Contains general client data
- * @property {number} clientId Client ID
- * @property {number} points Points for Drverse tokens airdrop
- * @property {number} mask Contains some additioal data
- * @property {number} slot Last update slot
- * @property {number} spotTrades All-time active spot trades
- * @property {number} lpTrades All-time lp trades
- * @property {number} perpTrades All-time active perp trades
- * @property {ClientTokenData[]} tokens Client tokens data
- * @property {ClientLpData[]} lp Client data about Deriverse internal spot LP tokens
- * @property {ClientSpotData[]} spot Client spot trading data
- * @property {ClientPerpData[]} perp Client perp trading data
- */
-export interface GetClientDataResponse {
-    clientId: number;
-    points: number;
-    mask: number;
-    slot: number;
-    spotTrades: number;
-    lpTrades: number;
-    perpTrades: number;
-    tokens: Map<number, ClientTokenData>;
-    lp: Map<number, ClientLpData>;
-    spot: Map<number, ClientSpotData>;
-    perp: Map<number, ClientPerpData>;
-    refProgram: ClientRefProgramData;
-    refLinks: RefLink[];
-    community: ClientCommunityData;
-}
-/**
- * Contains data for withdrawSplTokenInstruction function
- * @property {number} tokenId Deriverse token registered ID
- * @property {number} amount Amount to withdraw
- * @property {instrId[]} spot List of instruments ID to withdraw from client temporary instrument accounts
- * client temporary derivative instrument accounts
- */
-export interface WithdrawArgs {
-    tokenId: number;
-    amount: number;
-    spot?: Array<InstrId>;
-}
-/**
- * Contains data for spotMassCancelInstruction
- * @property {number} instrId Instrument ID
- */
-export interface SpotMassCancelArgs {
-    instrId: number;
-}
-export interface PerpMassCancelArgs {
-    instrId: number;
-}
-export interface PerpStatisticsResetArgs {
-    instrId: number;
-}
-export interface PerpChangeLeverageArgs {
-    instrId: number;
-    leverage: number;
-}
-export interface PerpForcedCloseArgs {
-    instrId: number;
-    clientPrimaryAccount: Address;
-}
-/**
- * Contains data for getInstrId function
- * @property {number} assetTokenId Asset Deriverse token registered ID
- * @property {number} baseCrncyTokenId Base currency Deriverse token registered ID
- */
-export interface GetInstrIdArgs {
-    assetTokenId: number;
-    crncyTokenId: number;
-}
-export interface GetSpotContextArgs {
-    assetTokenId: number;
-    crncyTokenId: number;
-}
-export interface getInstrAccountByTagArgs {
-    assetTokenId: number;
-    crncyTokenId: number;
-    tag: number;
-}
-export interface updateInstrDataArgs {
-    assetTokenId: number;
-    crncyTokenId: number;
-}
-/**
- * Contains data for spotLpInstruction function
- * @property {number} instrId Instrument ID
- * @property {number} amount Amount of tokens to trade. Negative value means selling
- */
-export interface SpotLpArgs {
-    instrId: number;
-    side: number;
-    amount: number;
-    minPrice?: number;
-    maxPrice?: number;
-}
-/**
- * Contains data for distribFundsInstruction function
- * @property {number[]} instruments Instruments ID
- */
-export interface DistribDividendsArgs {
-    instruments: number[];
-}
-export interface PerpDepositArgs {
-    instrId: number;
-    amount: number;
-}
-export interface PerpBuySeatArgs {
-    instrId: number;
-    amount: number;
-    slippage?: number;
-}
-export interface PerpSellSeatArgs {
-    instrId: number;
-    slippage?: number;
-}
-export interface NewPerpOrderArgs {
-    instrId: number;
-    ioc?: number;
-    orderType?: number;
-    qty: number;
-    price: number;
-    leverage?: number;
-    side: number;
-    edgePrice?: number;
-}
-export interface NewInstrumentArgs {
-    assetMint: Address<any>;
-    crncyMint: Address<any>;
-    newProgramAccountAddress?: Address<any>;
-    initialPrice: number;
-}
-export type LogMessage = DepositReportModel | WithdrawReportModel | PerpDepositReportModel | PerpWithdrawReportModel | FeesDepositReportModel | FeesWithdrawReportModel | SpotlpTradeReportModel | EarningsReportModel | DrvsAirdropReportModel | SpotPlaceOrderReportModel | SpotFillOrderReportModel | SpotNewOrderReportModel | SpotOrderCancelReportModel | SpotOrderRevokeReportModel | SpotFeesReportModel | SpotPlaceMassCancelReportModel | SpotMassCancelReportModel | PerpPlaceOrderReportModel | PerpFillOrderReportModel | PerpNewOrderReportModel | PerpOrderCancelReportModel | PerpOrderRevokeReportModel | PerpFeesReportModel | PerpPlaceMassCancelReportModel | PerpMassCancelReportModel | PerpFundingReportModel | PerpSocLossReportModel | PerpChangeLeverageReportModel | BuyMarketSeatReportModel | SellMarketSeatReportModel;