@ultrade/ultrade-js-sdk 2.0.2 → 2.0.3

package/dist/interface/affiliates.interface.d.ts

@@ -0,0 +1,42 @@
+export interface AffiliateSummaryStat {
+    value: number | null;
+    trend: number | null;
+}
+export interface AffiliateTrendStat {
+    value: number;
+    time: number;
+}
+export interface AffiliateStats<T> {
+    totalRevenue: T;
+    linkClicks: T;
+    registrations: T;
+    firstTimeDepositors: T;
+    totalTradingVolume: T;
+    totalFees: T;
+}
+export interface AffiliateSummaryStats extends AffiliateStats<AffiliateSummaryStat> {
+}
+export interface AffiliateTrendStats extends AffiliateStats<AffiliateTrendStat[]> {
+}
+export interface DashboardInfo {
+    feeShare: number;
+    referralLink: string;
+    summaryStats: AffiliateSummaryStats;
+    trendStats: AffiliateTrendStats | null;
+}
+export interface IAffiliateDashboardStatus {
+    enabled: boolean;
+    isAffiliate: boolean;
+}
+export interface IAffiliateProgress {
+    totalTradingVolumeUsd: number;
+    unlockThreshold: number;
+}
+export interface IAffiliateForClient {
+    getAffiliatesStatus(companyId: number): Promise<IAffiliateDashboardStatus>;
+    createAffiliate(companyId: number): Promise<DashboardInfo>;
+    getAffiliateProgress(companyId: number): Promise<IAffiliateProgress>;
+    getAffiliateInfo(companyId: number, range: string): Promise<DashboardInfo>;
+    countAffiliateDepost(companyId: number): Promise<void>;
+    countAffiliateClick(referralToken: string): Promise<void>;
+}

package/dist/interface/auth.interface.d.ts

@@ -0,0 +1,19 @@
+export interface Signer {
+    signAndSend: ([]: Iterable<any, void, undefined>) => any;
+    signMessage: (msg: string, encoding?: BufferEncoding) => Promise<string>;
+    signMessageByToken: (msg: string, encoding?: BufferEncoding) => Promise<string>;
+}
+export interface AuthCredentials {
+    company: string;
+    clientId?: string;
+    clientSecret?: string;
+    mnemonic?: string;
+    signer: Signer;
+}
+export interface WalletCredentials {
+    address: string;
+    chain: string;
+    provider: string;
+    token: string;
+    tradingKey?: string;
+}

package/dist/interface/client.interface.d.ts

@@ -0,0 +1,12 @@
+import { IAccountForClient, IMarketForClient, ISystemForClient, IWalletForClient, SocketIOFactory, IAffiliateForClient, ISocialForClient } from "./index.ts";
+import { Network } from "../const/index.ts";
+export interface ClientOptions {
+    network: Network;
+    apiUrl?: string;
+    algoSdkClient: any;
+    websocketUrl: string;
+    companyId?: number;
+    socketIO: SocketIOFactory;
+}
+export interface IClient extends IMarketForClient, IAccountForClient, IWalletForClient, ISystemForClient, IAffiliateForClient, ISocialForClient {
+}

package/dist/interface/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./account.interface";
+export * from "./auth.interface";
+export * from "./client.interface";
+export * from "./market.interface";
+export * from "./social.interface";
+export * from "./socket.interface";
+export * from "./trading.interface";
+export * from "./wallet.interface";
+export * from "./system.interface";
+export * from "./notification.interface";
+export * from "./affiliates.interface";

package/dist/interface/market.interface.d.ts

@@ -0,0 +1,232 @@
+import { KYCAuthenticationStatus } from "../../../shared/dist/browser/enums";
+import { BLOCKCHAINS, OrderStatus, OrderTypeEnum, OrderUpdateStaus, PairSettingsIds } from "../enum/index.ts";
+export interface IPairDto {
+    id: number;
+    base_chain_id: number;
+    base_currency: string;
+    base_decimal: number;
+    base_id: string;
+    min_order_size: string;
+    min_price_increment: string;
+    min_size_increment: string;
+    is_active: boolean;
+    pairId: number;
+    pair_key: string;
+    pair_name: string;
+    price_chain_id: number;
+    price_currency: string;
+    price_decimal: number;
+    price_id: string;
+    restrictedCountries: string[];
+    inuseWithPartners: number[];
+    pairSettings: {
+        [PairSettingsIds.MFT_AUDIO_LINK]?: string;
+        [PairSettingsIds.MFT_TITLE]?: string;
+        [PairSettingsIds.VIEW_BASE_COIN_ICON_LINK]?: string;
+        [PairSettingsIds.VIEW_BASE_COIN_MARKET_LINK]?: string;
+        [PairSettingsIds.VIEW_PRICE_COIN_ICON_LINK]?: string;
+        [PairSettingsIds.VIEW_PRICE_COIN_MARKET_LINK]?: string;
+        [PairSettingsIds.MAKER_FEE]?: string;
+        [PairSettingsIds.TAKER_FEE]?: string;
+        [PairSettingsIds.MODE_PRE_SALE]?: {
+            sellerAddress: string;
+        };
+    };
+    delisting_date?: Date;
+    new_orders_disabled?: boolean;
+    current_price?: string;
+    h?: string;
+    l?: string;
+    l_p?: string;
+    price_24?: string;
+    total_24?: string;
+    volume_24?: string;
+    change_24?: string;
+}
+export interface IGetDepth {
+    buy: string[][];
+    sell: string[][];
+    pair: string;
+    ts: number;
+    U: number;
+    u: number;
+}
+export interface IGetLastTrades {
+    tradeId: number;
+    amount: string;
+    createdAt: number;
+    price: string;
+    isBuyerMaker: boolean;
+}
+export interface CodexBalanceDto {
+    hash: string;
+    loginAddress: string;
+    loginChainId: number;
+    tokenId: number;
+    tokenAddress: string;
+    tokenChainId: number;
+    amount: string;
+    lockedAmount: string;
+}
+export type OrderSideShort = "B" | "S";
+export interface ITradeDto {
+    tradeId: number;
+    amount: string;
+    price: string;
+    createdAt: number;
+    updatedAt?: number;
+    total?: string;
+    orderId?: number;
+    orderSide?: OrderSideShort;
+    pairId?: number;
+    baseTokenId?: number;
+    baseTokenDecimal?: number;
+    quoteTokenId?: number;
+    quoteTokenDecimal?: number;
+    status?: string;
+    fee?: string;
+    isBuyer?: boolean;
+    isMaker?: boolean;
+}
+export interface IOrderDto {
+    id: number;
+    pairId: number;
+    pair: string;
+    status: OrderStatus;
+    side: 0 | 1;
+    type: OrderTypeEnum;
+    price: string;
+    amount: string;
+    filledAmount: string;
+    total: string;
+    filledTotal: string;
+    avgPrice: string;
+    userId: string;
+    createdAt: number;
+    updatedAt?: number;
+    completedAt?: number;
+    trades?: ITradeDto[];
+}
+export interface Order extends IOrderDto {
+    executed: boolean;
+    updateStatus?: OrderUpdateStaus;
+    base_currency: string;
+    base_decimal: number;
+    price_currency: string;
+    price_decimal: number;
+    min_size_increment: string;
+    min_price_increment: string;
+    price_id: number;
+}
+export interface Chain {
+    chainId: number;
+    whChainId: string;
+    tmc: string;
+    name: BLOCKCHAINS;
+}
+export interface AccountAssetType {
+    id: number;
+    index: string;
+    name: string | null;
+    decimal: number;
+    img: string;
+    amount: string;
+    lockedAmount: string;
+    unit_name: string | null;
+    chainId: number;
+    usd_value?: number;
+    isWrapped?: boolean;
+}
+export interface CCTPAssets {
+    chainId: number;
+    address: string;
+    unifiedChainId: number;
+}
+export type MappedCCTPAssets = {
+    [key: string]: CCTPAssets[];
+};
+export interface CCTPUnifiedAssets {
+    id: number;
+    chainId: number;
+    address: string;
+    symbol: string;
+}
+export interface IGetKycStatus {
+    kycStatus?: KYCAuthenticationStatus;
+}
+export interface IGetKycInitLink {
+    url: string;
+}
+export interface IGetDollarValues {
+    [key: string]: number;
+}
+export interface IWithdrawalFee {
+    fee: string;
+    dollarValue: string;
+}
+export interface IGetPrice {
+    ask: number;
+    bid: number;
+    last: number;
+}
+export interface IGetHistoryResponse {
+    t: number[];
+    o: number[];
+    c: number[];
+    l: number[];
+    h: number[];
+    v: number[];
+    q: number[];
+    s: string;
+    b: number;
+}
+interface IGetSymbolsItem {
+    pairKey: string;
+}
+export type IGetSymbols = IGetSymbolsItem[];
+import { CreateOrderArgs, CancelOrderArgs } from "./index.ts";
+export interface ICancelOrderResponse {
+    orderId: number;
+    isCancelled: boolean;
+    amount?: string;
+    filledAmount?: string;
+    filledTotal?: string;
+    averageExecutedPrice?: string;
+}
+export interface ICancelMultipleOrdersResponseItem {
+    orderId: number;
+    pairId: number;
+    isCancelled: boolean;
+    reason?: string;
+    amount?: string;
+    filledAmount?: string;
+    filledTotal?: string;
+}
+export type ICancelMultipleOrdersResponse = ICancelMultipleOrdersResponseItem[];
+export interface IMarketForClient {
+    getPairList(companyId?: number): Promise<IPairDto[]>;
+    getPair(symbol: string | number): Promise<IPairDto>;
+    getPrice(symbol: string): Promise<IGetPrice>;
+    getDepth(symbol: string, depth: number): Promise<IGetDepth>;
+    getSymbols(mask?: string): Promise<IGetSymbols>;
+    getLastTrades(symbol: string): Promise<IGetLastTrades>;
+    getHistory(symbol: string, interval: string, startTime?: number, endTime?: number, limit?: number, page?: number): Promise<IGetHistoryResponse>;
+    getOrders(symbol?: string, status?: number, limit?: number, endTime?: number, startTime?: number): Promise<IOrderDto[]>;
+    getOrderById(orderId: number): Promise<Order>;
+    getBalances(): Promise<CodexBalanceDto[]>;
+    getChains(): Promise<Chain[]>;
+    getCodexAssets(): Promise<CodexBalanceDto>;
+    getCCTPAssets(): Promise<MappedCCTPAssets>;
+    getCCTPUnifiedAssets(): Promise<CCTPUnifiedAssets[]>;
+    getWithdrawalFee(assetAddress: string, chainId: number): Promise<IWithdrawalFee>;
+    getKycStatus(): Promise<IGetKycStatus>;
+    getKycInitLink(embeddedAppUrl: string | null): Promise<IGetKycInitLink>;
+    getDollarValues(assetIds?: number[]): Promise<IGetDollarValues>;
+    createOrder(order: CreateOrderArgs): Promise<IOrderDto>;
+    cancelOrder(order: CancelOrderArgs): Promise<ICancelOrderResponse>;
+    cancelMultipleOrders(data: {
+        orderIds?: number[];
+        pairId?: number;
+    }): Promise<ICancelMultipleOrdersResponse>;
+}
+export {};

package/dist/interface/notification.interface.d.ts

@@ -0,0 +1,6 @@
+import { NotificationStatusEnum } from "../../../shared/dist/browser/enums";
+export interface UpdateUserNotificationDto {
+    id?: number;
+    globalNotificationId?: number;
+    status: NotificationStatusEnum;
+}

package/dist/interface/social.interface.d.ts

@@ -0,0 +1,145 @@
+export interface TelegramData {
+    auth_date: number;
+    id: number;
+    first_name: string;
+    hash: string;
+    photo_url: string;
+    username: string;
+}
+export interface ISocialAccount {
+    points: number;
+    address: string;
+    email?: string;
+    emailVerified: boolean;
+    twitterAccount?: {
+        userName: string;
+        twitterId: string;
+        name: string;
+        permissions: {
+            canFollowAccounts: boolean;
+            canCreateTweets: boolean;
+            canLikeTweets: boolean;
+        };
+    };
+    telegramAccount?: {
+        userName: string;
+        telegramId: string;
+    };
+    discordAccount?: {
+        userName: string;
+        discordId: string;
+        name: string;
+    };
+}
+export interface ILeaderboardItem {
+    address: string;
+    currentPoints: number;
+    tasksCompleted: number;
+    twitter?: string;
+    discord?: string;
+    telegram?: string;
+    order: number;
+}
+export interface IUnlock {
+    id: number;
+    companyId: number;
+    seasonId: number;
+    name: string;
+    description: string;
+    points: number;
+    enabled: boolean;
+}
+export interface IAction {
+    id: number;
+    companyId: number;
+    seasonId: number;
+    source: string;
+    name: string;
+    description: string;
+    points: number;
+    enabled: boolean;
+}
+export interface IActionHistory {
+    id: number;
+    address: string;
+    companyId: number;
+    actionId: number;
+    seasonId: number;
+    source: string;
+    points: number;
+    referenceId?: string;
+    createdAt: Date;
+}
+export interface ISocialSettings {
+    [key: string]: any;
+}
+export interface ISocialSeason {
+    id: number;
+    companyId: number;
+    startDate: Date;
+    endDate?: Date;
+    name: string;
+    isSelected: boolean;
+    status: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface ITelegramConnectResponse {
+    address: string;
+    telegramId: string;
+    userName: string;
+    createdAt: Date;
+}
+export interface ICompanyTweet {
+    id: string;
+    companyId: number;
+    seasonId: number;
+    type: string;
+    text: string;
+    enabled: boolean;
+    isProcessed: boolean;
+    expiresAt: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IAIStyle {
+    id: number;
+    title: string;
+    content: string;
+    enabled: boolean;
+    type: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IAIGeneratedComment {
+    comment: string | null;
+    requestsLeft: number;
+}
+export interface ISocialForClient {
+    getSocialAccount(): Promise<ISocialAccount | undefined>;
+    addSocialEmail(email: string, embeddedAppUrl: string): Promise<void>;
+    verifySocialEmail(email: string, hash: string): Promise<void>;
+    getLeaderboards(): Promise<ILeaderboardItem[]>;
+    getUnlocks(): Promise<IUnlock[]>;
+    getSocialSettings(): Promise<ISocialSettings>;
+    getSeason(ultradeId?: number): Promise<ISocialSeason>;
+    getPastSeasons(): Promise<ISocialSeason[]>;
+    addTelegram(data: TelegramData): Promise<ITelegramConnectResponse>;
+    disconnectTelegram(data: TelegramData): Promise<void>;
+    getDiscordConnectionUrl(url: string): Promise<string>;
+    disconnectDiscord(): Promise<void>;
+    getTwitterConnectionUrl(appUrl: string, permissions?: string): Promise<string>;
+    disconnectTwitter(): Promise<void>;
+    getTweets(): Promise<ICompanyTweet[]>;
+    actionWithTweet(data: {
+        actions: Array<{
+            id: number;
+            text?: string;
+        }>;
+        tweetId?: string;
+    }): Promise<void>;
+    getActions(): Promise<IAction[]>;
+    getActionHistory(): Promise<IActionHistory[]>;
+    getAIStyles(): Promise<IAIStyle[]>;
+    getAIComment(styleId: number, tweetId: string): Promise<IAIGeneratedComment>;
+}

package/dist/interface/socket.interface.d.ts

@@ -0,0 +1,47 @@
+import { STREAMS } from "../enum/index.ts";
+export interface SocketIOClient {
+    connected: boolean;
+    id: string;
+    on: (event: string, handler: (...args: unknown[]) => void) => void;
+    off: (event: string, handler?: (...args: unknown[]) => void) => void;
+    emit: (event: string, ...args: unknown[]) => void;
+    onAny: (handler: (event: string, ...args: unknown[]) => void) => void;
+    disconnect: () => void;
+    io: {
+        on: (event: string, handler: (...args: unknown[]) => void) => void;
+        off: (event: string, handler?: (...args: unknown[]) => void) => void;
+    };
+}
+export interface SocketIOFactory {
+    (url: string, options?: unknown): SocketIOClient;
+}
+export interface AppSocketState {
+    address: string;
+    appId: number;
+    orderFilter: string;
+    pairKey: string;
+    pairId: number;
+}
+interface WSOptions {
+    address: string;
+    token?: string;
+    tradingKey?: string;
+    message?: string;
+    signature?: string;
+    depth?: number;
+    companyId?: number;
+    interval?: string;
+}
+export interface SubscribeOptions {
+    symbol: string;
+    streams: STREAMS[];
+    options: WSOptions;
+}
+export interface ServerToClientEvents {
+    reconnect: () => void;
+}
+export interface ClientToServerEvents {
+    subscribe: (options: SubscribeOptions) => void;
+    unsubscribe: (options: SubscribeOptions) => void;
+}
+export {};

package/dist/interface/system.interface.d.ts

@@ -0,0 +1,20 @@
+import { MaintenanceMode } from "../../../shared/dist/browser/enums";
+import { UserNotification } from "./account.interface";
+import { UpdateUserNotificationDto } from "./notification.interface";
+export interface ISystemVersion {
+    version: string | null;
+}
+export interface ISystemMaintenance {
+    mode: MaintenanceMode;
+}
+export interface IUnreadNotificationsCount {
+    count: number;
+}
+export interface ISystemForClient {
+    getVersion(): Promise<ISystemVersion>;
+    getMaintenance(): Promise<ISystemMaintenance>;
+    getNotifications(): Promise<UserNotification[]>;
+    getNotificationsUnreadCount(): Promise<IUnreadNotificationsCount>;
+    readNotifications(notifications: UpdateUserNotificationDto[]): Promise<UpdateUserNotificationDto[]>;
+    ping(): Promise<number>;
+}

package/dist/interface/trading.interface.d.ts

@@ -0,0 +1,38 @@
+export type OrderSide = 'S' | 'B';
+export type OrderType = 'L' | 'I' | 'P' | 'M';
+export interface CancelOrderArgs {
+    orderId: number;
+    orderSide: OrderSide;
+    orderType: OrderType;
+    amount: string;
+    price: string;
+    baseTokenAddress: string;
+    baseChain: string;
+    baseCurrency: string;
+    baseDecimal: number;
+    priceTokenAddress: string;
+    priceChain: string;
+    priceCurrency: string;
+    priceDecimal: number;
+}
+export interface CreateOrderArgs {
+    pairId: number;
+    companyId: number;
+    orderSide: OrderSide;
+    orderType: OrderType;
+    amount: string;
+    price: string;
+    decimalPrice: number;
+    address: string;
+    chainId: number;
+    baseTokenAddress: string;
+    baseTokenChainId: number;
+    baseChain: string;
+    baseCurrency: string;
+    baseDecimal: number;
+    priceTokenAddress: string;
+    priceTokenChainId: number;
+    priceChain: string;
+    priceCurrency: string;
+    priceDecimal: number;
+}