@nightlylabs/dex-sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,590 @@
+import * as _aptos_labs_ts_sdk from '@aptos-labs/ts-sdk';
+import { Aptos, Account, SimpleTransaction, AccountAuthenticator } from '@aptos-labs/ts-sdk';
+import * as _thalalabs_surf_build_types_core from '@thalalabs/surf/build/types/core';
+import * as _thalalabs_surf from '@thalalabs/surf';
+import WebSocket from 'isomorphic-ws';
+
+interface StatusResponse {
+    status: string;
+}
+interface TimeResponse {
+    time: string;
+}
+interface UtilizationCurve {
+    base: string;
+    multiplier: string;
+    kink: string;
+    jump: string;
+}
+interface BorrowLending {
+    tokenAddress: string;
+    lendShares: string;
+    lendAmount: string;
+    borrowShares: string;
+    borrowAmount: string;
+    utilizationCurve: UtilizationCurve;
+    borrowEnabled: boolean;
+    lastUpdated: string;
+}
+interface GetBorrowLendingDataResponse {
+    data: Record<string, BorrowLending>;
+}
+interface GetPerpMarketsDataRequest {
+    markets: string[];
+}
+interface PerpMarketData {
+    price: string;
+    priceIndex: string;
+    change24: string;
+    high24: string;
+    low24: string;
+    baseVolume24: string;
+    quoteVolume24: string;
+    fundingRate: string;
+    openInterest24: string;
+    timestamp: string;
+}
+interface GetPerpMarketsDataResponse {
+    perpMarkets: Record<string, PerpMarketData>;
+}
+interface Content {
+    price: string;
+    size: string;
+}
+interface PerpOrderBookData {
+    timestamp: string;
+    bids: Content[];
+    asks: Content[];
+}
+interface GetPerpOrderBookDataRequest {
+    marketName: string;
+}
+interface GetPerpOrderBookDataResponse {
+    data: PerpOrderBookData;
+}
+interface MarginStep {
+    initialMarginRation: string;
+    initialAmount: string;
+    maintenanceMarginRatio: string;
+    maintenanceAmount: string;
+    maxPositionInUsd: string;
+}
+declare enum PerpetualMarketStatus {
+    Halted = "halted",
+    ReduceOnly = "reduceOnly",
+    PostOnly = "postOnly",
+    Live = "live"
+}
+interface FundingRate {
+    enabled: boolean;
+    interestRateHourly: string;
+    clampMin: string;
+    clampMax: string;
+    maxFundingRate: string;
+    minFundingRate: string;
+}
+interface PerpetualMarketConfigEntry {
+    name: string;
+    priceIndex: string;
+    marginSteps: MarginStep[];
+    liquidationPenalty: string;
+    lotSize: string;
+    tickSize: string;
+    status: PerpetualMarketStatus;
+    fundingRate: FundingRate;
+}
+interface GetPerpetualMarketsConfigResponse {
+    perpMarkets: Record<string, PerpetualMarketConfigEntry>;
+}
+interface PriceIndex {
+    name: string;
+    price: string;
+    lastUpdate: number;
+}
+interface GetPriceIndexesResponse {
+    prices: Record<string, PriceIndex>;
+}
+interface TokenConfigEntry {
+    name: string;
+    priceIndex: string;
+    collateralFactor: string;
+    borrowInitialFactor: string;
+    borrowMaintenanceFactor: string;
+    liquidationPenalty: string;
+    contractAddress: string;
+    enabled: boolean;
+}
+interface GetTokensConfigResponse {
+    tokens: Record<string, TokenConfigEntry>;
+    usdcAddress?: string;
+}
+interface GetUserDataRequest {
+    userId: string;
+}
+interface FundingCheckpoint {
+    index: string;
+    fundingPerLot: string;
+}
+interface PerpPosition {
+    size: string;
+    entryPrice: string;
+    fundingCheckpoint: FundingCheckpoint;
+}
+interface VaultInvestment {
+    sharesAmount: string;
+    sharePrice: string;
+}
+interface Fees {
+    tier: string;
+    perpTakerFee: string;
+    perpMakerFee: string;
+    spotTakerFee: string;
+    spotMakerFee: string;
+    discount: string;
+    referrerUserId?: string;
+    referrerKickback: string;
+}
+interface Referral {
+    discount: string;
+    kickback: string;
+}
+interface User {
+    userId: string;
+    alias: string;
+    autolendEnabled: boolean;
+    tokenBalances: Record<string, string>;
+    positions: Record<string, PerpPosition>;
+    perpOrders: Record<string, Order>;
+    lendingShares: Record<string, string>;
+    borrowShares: Record<string, string>;
+    apiKeys: Record<string, string>;
+    vaultInvestments: Record<string, VaultInvestment>;
+    fees: Fees;
+    referral: Referral;
+    vault?: string;
+}
+interface GetUserDataResponse {
+    userData: User;
+    perpOrdersCount: string;
+}
+interface SubmitSponsoredTransactionRequest {
+    sender: string;
+    sequenceNumber: string;
+    payload: number[];
+    maxGasAmount: string;
+    gasUnitPrice: string;
+    expirationTimestampSecs: string;
+    chainId: string;
+    authenticator: number[];
+}
+interface SubmitSponsoredTransactionResponse {
+    txHash: string;
+}
+interface ExchangeConfig {
+    tokens: Record<string, TokenConfigEntry>;
+    usdcAddress?: string;
+    perpetualsMarkets: Record<string, PerpetualMarketConfigEntry>;
+}
+declare enum OrderSide {
+    Bid = "Bid",
+    Ask = "Ask"
+}
+interface Order {
+    id: string;
+    size: string;
+    market: string;
+    price: string;
+    side: OrderSide;
+    sizeLeft: string;
+    timestamp: string;
+}
+interface OracleUpdate {
+    name: string;
+    price: string;
+}
+interface OracleUpdates {
+    updates: OracleUpdate[];
+}
+interface OrderbookUpdate {
+    market: string;
+    updates: Record<string, string>;
+}
+interface Trade {
+    id: string;
+    size: string;
+    price: string;
+    timestamp: string;
+    is_bid: boolean;
+}
+interface TradesUpdate {
+    market: string;
+    updates: Trade[];
+}
+interface BalanceChange {
+    user_id: string;
+    token_address: string;
+    amount: string;
+}
+interface Deposit {
+    user_id: string;
+    token_address: string;
+    amount: string;
+}
+interface Withdraw {
+    user_id: string;
+    token_address: string;
+    amount: string;
+}
+interface WithdrawLend {
+    user_id: string;
+    token_address: string;
+    shares_amount: string;
+    token_received: string;
+}
+interface Lend {
+    user_id: string;
+    token_address: string;
+    token_amount: string;
+    shares_received: string;
+}
+interface Borrow {
+    user_id: string;
+    token_address: string;
+    token_amount: string;
+    shares_received: string;
+}
+interface RepayBorrow {
+    user_id: string;
+    token_address: string;
+    shares_repaid: string;
+    token_repaid: string;
+    share_price: string;
+}
+interface WsFill {
+    id: string;
+    size: string;
+    price: string;
+    fee_paid: string;
+}
+interface PlacePerpLimitOrder {
+    market: string;
+    user_id: string;
+    is_bid: boolean;
+    price: string;
+    size: string;
+    post_only: boolean;
+    reduce_only: boolean;
+    order_id: string;
+    filled_size: string;
+    fills: WsFill[];
+}
+interface PlacePerpMarketOrder {
+    market: string;
+    user_id: string;
+    is_bid: boolean;
+    max_price: string;
+    size: string;
+    reduce_only: boolean;
+    order_id: string;
+    fills: WsFill[];
+}
+interface OrderFills {
+    market: string;
+    user_id: string;
+    order_id: string;
+    fills: WsFill[];
+}
+interface CanceledPerpOrders {
+    market: string;
+    user_id: string;
+    orders_ids: Array<string>;
+}
+interface ErrorResponse {
+    code: number;
+    variant: string;
+    message: string;
+}
+declare enum EndpointsV1 {
+    Ws = "/v1/ws",
+    GetConfig = "/v1/get_config",
+    GetTokensConfig = "/v1/get_tokens_config",
+    GetPerpMarketsConfig = "/v1/get_perp_markets_config",
+    GetUserData = "/v1/get_user_data",
+    GetPriceIndexes = "/v1/get_price_indexes",
+    GetPerpOrderBookData = "/v1/get_perp_orderbook_data",
+    GetPerpMarketsData = "/v1/get_perp_markets_data",
+    GetBorrowLendingData = "/v1/get_borrow_lending_data",
+    SubmitSponsoredTransactionRequest = "/v1/submit_sponsored_transaction"
+}
+declare enum AdminEndpoints {
+    Placeholder = "/admin/placeholder"
+}
+declare enum BaseEndpoints {
+    Time = "/time",
+    Status = "/app_status"
+}
+type Topic = {
+    type: "Market";
+    content: string;
+} | {
+    type: "User";
+    content: {
+        id: string;
+    };
+} | {
+    type: "Oracle";
+    content?: undefined;
+};
+type WsCommand = {
+    type: "SubscribeMarket";
+    content: {
+        id: string;
+        market: string;
+    };
+} | {
+    type: "UnsubscribeMarket";
+    content: {
+        id: string;
+        market: string;
+    };
+} | {
+    type: "SubscribeUser";
+    content: {
+        id: string;
+        user_id: string;
+    };
+} | {
+    type: "UnsubscribeUser";
+    content: {
+        id: string;
+        user_id: string;
+    };
+} | {
+    type: "SubscribeOracle";
+    content: {
+        id: string;
+    };
+} | {
+    type: "UnsubscribeOracle";
+    content: {
+        id: string;
+    };
+};
+type WsMessage = {
+    type: "Ack";
+    content: {
+        id: string;
+    };
+} | {
+    type: "Error";
+    content: {
+        id: string;
+        message: string;
+    };
+} | {
+    type: "OracleUpdates";
+    content: OracleUpdates;
+} | {
+    type: "OrderbookUpdate";
+    content: OrderbookUpdate;
+} | {
+    type: "TradesUpdate";
+    content: TradesUpdate;
+} | {
+    type: "BalanceChange";
+    content: BalanceChange;
+} | {
+    type: "Deposit";
+    content: Deposit;
+} | {
+    type: "Withdraw";
+    content: Withdraw;
+} | {
+    type: "WithdrawLend";
+    content: WithdrawLend;
+} | {
+    type: "Lend";
+    content: Lend;
+} | {
+    type: "Borrow";
+    content: Borrow;
+} | {
+    type: "RepayBorrow";
+    content: RepayBorrow;
+} | {
+    type: "PlacePerpLimitOrder";
+    content: PlacePerpLimitOrder;
+} | {
+    type: "PlacePerpMarketOrder";
+    content: PlacePerpMarketOrder;
+} | {
+    type: "CanceledPerpOrders";
+    content: CanceledPerpOrders;
+} | {
+    type: "OrderFills";
+    content: OrderFills;
+};
+declare enum OrderStatus {
+    Placed = "Placed",
+    Cancelled = "Cancelled",
+    Filled = "Filled",
+    PartiallyFilled = "PartiallyFilled",
+    Rejected = "Rejected",
+    Executed = "Executed"
+}
+declare enum OrderType {
+    Limit = "Limit",
+    Market = "Market"
+}
+declare enum TradeRole {
+    Maker = "Maker",
+    Taker = "Taker"
+}
+declare enum UserStatus {
+    Active = "Active",
+    Locked = "Locked"
+}
+
+type Address = `0x${string}`;
+declare enum Status {
+    Halted = 0,
+    ReduceOnly = 1,
+    PostOnly = 2,
+    Live = 3
+}
+declare enum Network {
+    Devnet = "Devnet"
+}
+
+declare const getRandomId: () => string;
+declare class Client {
+    _aptos: Aptos;
+    _surf: _thalalabs_surf_build_types_core.MoveTsClient<_thalalabs_surf.DefaultABITable>;
+    _apiKey: Account;
+    _ws: WebSocket;
+    _serverUrl: string;
+    _subscriptions: Map<string, (data: WsMessage) => void>;
+    timeout: number;
+    static init(connection: Aptos, apiKey?: Account, url?: string): Promise<Client>;
+    constructor(connection: Aptos, ws: WebSocket, url: string, apiKey?: Account);
+    static initWebSocket(url: string, timeout?: number): Promise<WebSocket>;
+    sendWsMessage(message: WsCommand): Promise<WsMessage>;
+    static create(connection: Aptos, apiKey?: Account, url?: string): Promise<Client>;
+    setApiKey(apiKey: Account): void;
+    createUser(params: CreateUserParams): Promise<{
+        tx: SimpleTransaction;
+        signature: AccountAuthenticator;
+        apiKey: _aptos_labs_ts_sdk.Ed25519Account;
+    }>;
+    subscribeToUserUpdates(userId: string, callback: (data: WsMessage) => void): Promise<void>;
+    unsubscribeFromUserUpdates(userId: string): Promise<void>;
+    addApiKey(params: AddApiKeyParams): Promise<_thalalabs_surf.EntryPayload>;
+    removeApiKey(params: RemoveApiKeyParams): Promise<SubmitSponsoredTransactionResponse>;
+    setAliasName(params: SetAliasNameParams): Promise<SubmitSponsoredTransactionResponse>;
+    placePerpLimitOrder(params: PlacePerpLimitOrderParams): Promise<SubmitSponsoredTransactionResponse>;
+    placePerpMarketOrder(params: PlacePerpMarketOrderParams): Promise<SubmitSponsoredTransactionResponse>;
+    cancelPerpOrders(params: CancelPerpOrdersParams): Promise<SubmitSponsoredTransactionResponse>;
+    cancelAllPerpOrders(params: CancelAllPerpOrdersParams): Promise<SubmitSponsoredTransactionResponse>;
+    setAutolend(params: SetAutolendParams): Promise<SubmitSponsoredTransactionResponse>;
+    depositToVault(params: DepositToVaultParams): Promise<SubmitSponsoredTransactionResponse>;
+    withdrawFromVault(params: WithdrawFromVaultParams): Promise<SubmitSponsoredTransactionResponse>;
+    redeemToken(params: RedeemTokenParams): Promise<SubmitSponsoredTransactionResponse>;
+    lendToken(params: LendTokenParams): Promise<SubmitSponsoredTransactionResponse>;
+    sendGetJson: (endpoint: string, message?: {
+        [key: string]: any;
+    }) => Promise<any>;
+    sendPostJson: (message: object, endpoint: string) => Promise<any>;
+    submitSponsoredTransaction: (tx: SimpleTransaction, signature: AccountAuthenticator) => Promise<SubmitSponsoredTransactionResponse>;
+    getConfig: () => Promise<ExchangeConfig>;
+    getTokensConfig: () => Promise<GetTokensConfigResponse>;
+    getPerpetualMarketsConfig: () => Promise<GetPerpetualMarketsConfigResponse>;
+    getUserData: (userId: string) => Promise<GetUserDataResponse>;
+    getPerpOrderBookData: (marketName: string) => Promise<GetPerpOrderBookDataResponse>;
+    getPerpMarketsData: (markets: string[]) => Promise<GetPerpMarketsDataResponse>;
+    getBorrowLendingData: () => Promise<GetBorrowLendingDataResponse>;
+}
+interface PlacePerpLimitOrderParams {
+    userId: string;
+    market: Uint8Array;
+    isBid: boolean;
+    price: string;
+    size: string;
+    postOnly: boolean;
+}
+interface PlacePerpMarketOrderParams {
+    userId: string;
+    market: Uint8Array;
+    isBid: boolean;
+    price: string;
+    size: string;
+}
+interface CancelAllPerpOrdersParams {
+    userId: string;
+}
+interface CancelPerpOrdersParams {
+    userId: string;
+    markets: Uint8Array[];
+    orderIds: string[][];
+}
+interface AddApiKeyParams {
+    apiKey: Address;
+    userId: string;
+    expiration: string;
+}
+interface RemoveApiKeyParams {
+    apiKey: Address;
+    userId: string;
+}
+interface CreateUserParams {
+    sender: Address;
+    name: string;
+    referralId: string;
+}
+interface SetAliasNameParams {
+    userId: string;
+    alias: string;
+}
+interface SetAutolendParams {
+    userId: string;
+    enabled: boolean;
+}
+interface DepositToVaultParams {
+    userId: string;
+    vaultId: string;
+    amount: string;
+}
+interface WithdrawFromVaultParams {
+    userId: string;
+    vaultId: string;
+    amount: string;
+    max: boolean;
+}
+interface RedeemTokenParams {
+    userId: string;
+    token: Address;
+    amount: string;
+    max: boolean;
+}
+interface LendTokenParams {
+    userId: string;
+    token: Address;
+    amount: string;
+    max: boolean;
+}
+
+declare const ExchangeProxies: {
+    [key in Network]: string[];
+};
+declare const GLOBAL_DENOMINATOR = 100000000;
+
+declare class TestFaucet extends Client {
+    constructor(connection: Aptos, ws: WebSocket, url: string, apiKey?: Account);
+    static create(connection: Aptos, apiKey?: Account, url?: string): Promise<TestFaucet>;
+    initFaucetPayload(): _thalalabs_surf.EntryPayload;
+    initFaucet(): Promise<SubmitSponsoredTransactionResponse>;
+    mintTokenPayload(receiver: Address, token: string, amount: number): _thalalabs_surf.EntryPayload;
+    mintToken(receiver: Address, token: string, amount: number): Promise<SubmitSponsoredTransactionResponse>;
+    getUSDCAddress(): Promise<`0x${string}`>;
+}
+
+export { type AddApiKeyParams, type Address, AdminEndpoints, type BalanceChange, BaseEndpoints, type Borrow, type BorrowLending, type CancelAllPerpOrdersParams, type CancelPerpOrdersParams, type CanceledPerpOrders, Client, type Content, type CreateUserParams, type Deposit, type DepositToVaultParams, EndpointsV1, type ErrorResponse, type ExchangeConfig, ExchangeProxies, type Fees, type FundingCheckpoint, type FundingRate, GLOBAL_DENOMINATOR, type GetBorrowLendingDataResponse, type GetPerpMarketsDataRequest, type GetPerpMarketsDataResponse, type GetPerpOrderBookDataRequest, type GetPerpOrderBookDataResponse, type GetPerpetualMarketsConfigResponse, type GetPriceIndexesResponse, type GetTokensConfigResponse, type GetUserDataRequest, type GetUserDataResponse, type Lend, type LendTokenParams, type MarginStep, Network, type OracleUpdate, type OracleUpdates, type Order, type OrderFills, OrderSide, OrderStatus, OrderType, type OrderbookUpdate, type PerpMarketData, type PerpOrderBookData, type PerpPosition, type PerpetualMarketConfigEntry, PerpetualMarketStatus, type PlacePerpLimitOrder, type PlacePerpLimitOrderParams, type PlacePerpMarketOrder, type PlacePerpMarketOrderParams, type PriceIndex, type RedeemTokenParams, type Referral, type RemoveApiKeyParams, type RepayBorrow, type SetAliasNameParams, type SetAutolendParams, Status, type StatusResponse, type SubmitSponsoredTransactionRequest, type SubmitSponsoredTransactionResponse, TestFaucet, type TimeResponse, type TokenConfigEntry, type Topic, type Trade, TradeRole, type TradesUpdate, type User, UserStatus, type UtilizationCurve, type VaultInvestment, type Withdraw, type WithdrawFromVaultParams, type WithdrawLend, type WsCommand, type WsFill, type WsMessage, getRandomId };