@ultrade/ultrade-js-sdk 2.0.2 → 2.0.4

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,35 @@
+import type { Socket } from "socket.io-client";
+import { STREAMS } from "../enum/index.ts";
+export interface SocketIOFactory {
+    (url: string, options?: unknown): Socket;
+}
+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;
+}

package/dist/interface/wallet.interface.d.ts

@@ -0,0 +1,143 @@
+import { SuggestedParams } from 'algosdk';
+import { TradingKeyType, PaginatedResult, ISafeWithdrawalWallets, UpdateWithdrawalWallet, CreateWithdrawalWallet } from "../../../shared/dist/browser/interfaces";
+import { ACTION_TYPE, OperationStatusEnum, TransactionType } from '../enum/index.ts';
+export interface TxnParams {
+    suggestedParams: SuggestedParams;
+    from: string;
+    to: string;
+    amount: number;
+    assetIndex?: number;
+}
+export interface OperationTxn {
+    txn_hash: string;
+    chain_id: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+    type?: TransactionType;
+}
+export interface OperationVAA {
+    vaaId: string;
+    from_chain_id: number;
+    to_chain_id: number;
+    sequence: number;
+    emitter: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface OperationCCTP {
+    id: number;
+    destinationChainId: number;
+    messageHash: string;
+    messageBytes: string;
+    status: OperationStatusEnum;
+    attestationSignature: string;
+    createdAt: Date;
+    updatedAt: Date;
+    attestationCompletedAt: Date;
+}
+export interface ITransactionDetails {
+    primaryId: number;
+    id: string;
+    login_address: string;
+    login_chain_id: number;
+    action_type: 'withdraw' | 'deposit';
+    status: OperationStatusEnum;
+    amount: string;
+    targetAddress: string;
+    timestamp: string;
+    createdAt: Date;
+    updatedAt: Date;
+    vaa_message?: Buffer;
+    fee: string | null;
+    transactions: Array<OperationTxn>;
+    vaaMessages: Array<OperationVAA>;
+    cctp: Array<OperationCCTP>;
+}
+export interface ITransaction {
+    primaryId: number;
+    id: string;
+    action_type: ACTION_TYPE;
+    status: OperationStatusEnum;
+    amount: string;
+    targetAddress: string;
+    createdAt?: Date;
+    updatedAt: Date;
+    vaa_message?: Buffer;
+    fee: string | null;
+    token_id: {
+        id: number;
+        address: string;
+        chainId: number;
+        unitName: string;
+        name: string;
+        decimals: number;
+    };
+    transactions: Array<{
+        txnHash: string;
+        chainId: number;
+    }>;
+    vaaMessages: Array<OperationVAA>;
+}
+export interface ITradingKey {
+    address: string;
+    createdAt: Date;
+    expiredAt: Date;
+    orders: number;
+    device: string;
+    type?: TradingKeyType;
+}
+export interface ITransfer {
+    transferId: number;
+    senderAddress: string;
+    recipientAddress: string;
+    tokenId: number;
+    amount: string;
+    expiredAt: number;
+    whitelistId: number;
+    txnId: string;
+    completedAt: Date;
+    status: OperationStatusEnum;
+}
+export interface IPendingTxn {
+    id: number;
+    type: ACTION_TYPE;
+    amount: string;
+    tokenId: number;
+}
+export interface IWhiteList {
+    id?: number;
+    loginAddress: string;
+    loginChainId: number;
+    recipient: string;
+    recipientChainId: number;
+    tkAddress: string;
+    expiredDate: number;
+}
+export interface IGetWhiteList {
+    id: number;
+    recipientAddress: string;
+    tkAddress: string;
+    expiredAt: number;
+}
+import { IWithdrawData, ITransferData } from "../../../shared/dist/browser/interfaces";
+export interface IWithdrawResponse {
+    operationId: string;
+    txnId: string;
+}
+export interface IWalletForClient {
+    getTransactionDetalis(transactionId: number): Promise<ITransactionDetails>;
+    getPendingTransactions(): Promise<IPendingTxn[]>;
+    getWhitelist(): Promise<PaginatedResult<IGetWhiteList>>;
+    addWhitelist(data: IWhiteList): Promise<IGetWhiteList>;
+    deleteWhitelist(whitelistId: number): Promise<void>;
+    getWalletTransactions(type: string, page: number, limit?: number): Promise<PaginatedResult<ITransaction>>;
+    getTradingKeys(): Promise<ITradingKey>;
+    getTransfers(page: number, limit?: number): Promise<PaginatedResult<ITransfer>>;
+    getAllWithdrawalWallets(): Promise<ISafeWithdrawalWallets[]>;
+    getWithdrawalWalletByAddress(address: string): Promise<ISafeWithdrawalWallets>;
+    createWithdrawalWallet(body: CreateWithdrawalWallet): Promise<ISafeWithdrawalWallets>;
+    updateWithdrawalWallet(params: UpdateWithdrawalWallet): Promise<boolean>;
+    deleteWithdrawalWallet(address: string): Promise<boolean>;
+    withdraw(withdrawData: IWithdrawData, prettyMsg?: string): Promise<IWithdrawResponse>;
+    transfer(transferData: ITransferData): Promise<ITransfer>;
+}

package/dist/{src/localStorage.d.ts → localStorage.d.ts}

@@ -1,4 +1,4 @@
-import { WalletCredentials } from './interfaces';
+import { WalletCredentials } from './interface/index.ts';
 export declare class LocalStorageService {
     private isBrowser;
     private keys;

package/dist/{src/sockets.d.ts → sockets.d.ts}

@@ -1,4 +1,5 @@
-import { SubscribeOptions, SocketIOFactory, SocketIOClient } from './interfaces';
+import type { Socket } from 'socket.io-client';
+import { SubscribeOptions, SocketIOFactory } from './interface/index.ts';
 export declare class SocketManager {
     private onDisconnect?;
     private onConnectError?;
@@ -8,7 +9,7 @@ export declare class SocketManager {
     private socketIOFactory;
     constructor(url: string, socketIOFactory: SocketIOFactory, onDisconnect?: (socketId: string) => void, onConnectError?: (error: Error) => void);
     private initializeSocket;
-    getSocket(): SocketIOClient | null;
+    getSocket(): Socket | null;
     subscribe(subscribeOptions: SubscribeOptions, callback: Function): number;
     unsubscribe(handlerId: number): void;
     disconnect(): void;

package/dist/{src → utils}/algodService.d.ts

@@ -1,5 +1,5 @@
 import algosdk, { Transaction, SuggestedParams } from 'algosdk';
-import { AuthCredentials, OrderSide, Signer } from './interfaces';
+import { AuthCredentials, Signer, OrderSide } from '../interface/index.ts';
 export declare class AlgodService {
     private client;
     private authCredentials;
@@ -13,13 +13,9 @@ export declare class AlgodService {
     get signer(): Signer;
     set signer(value: Signer);
     signAndSend(txnGroup: Transaction[] | Transaction): Promise<any>;
-    signAndSendData(data: object | string, signMessage: (msg: string, encoding?: BufferEncoding) => Promise<string>, sendAction: (signedData: {
+    signAndSendData<TResponse>(data: object | string, signMessage: (msg: string, encoding?: BufferEncoding) => Promise<string>, sendAction: (signedData: {
         signature: string;
-    }) => Promise<{
-        signature: string;
-    }>, encoding?: BufferEncoding): Promise<{
-        signature: string;
-    }>;
+    }) => Promise<TResponse>, encoding?: BufferEncoding): Promise<TResponse>;
     getTxnParams(): Promise<SuggestedParams>;
     getCurrentAccount(): {
         addr: string;
@@ -30,6 +26,8 @@ export declare class AlgodService {
     validateCredentials(): void;
     getAppState(appId: number): Promise<any>;
     getSuperAppId(appId: number): Promise<any>;
-    getPairBalances(appId: number, address: string): Promise<any>;
+    getPairBalances(appId: number, address: string): Promise<{
+        [k: string]: any;
+    }>;
     calculateTransferAmount(appId: number, address: string, side: OrderSide, quantity: number, price: number, decimal: number): Promise<number>;
 }

package/dist/utils/algorand.util.d.ts

@@ -0,0 +1,4 @@
+export declare const unpackData: (data: Uint8Array) => {
+    [k: string]: any;
+};
+export declare const decodeString: (value: Uint8Array) => string;

package/dist/utils/client.util.d.ts

@@ -0,0 +1,6 @@
+import { AxiosRequestConfig } from "axios";
+export interface ExtendedAxiosRequestConfig<T = any> extends AxiosRequestConfig<T> {
+    withWalletCredentials?: boolean;
+    url?: string;
+}
+export declare function createExtendedConfig<T>(config: ExtendedAxiosRequestConfig<T>): ExtendedAxiosRequestConfig<T>;

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { AlgodService } from "./algodService";
+export * from "./algorand.util";
+export * from "./client.util";