@ultrade/ultrade-js-sdk 2.0.1 → 2.0.3

package/README.md

@@ -0,0 +1,117 @@
+# @ultrade/ultrade-js-sdk
+
+JavaScript/TypeScript SDK for Ultrade platform integration.
+
+**Repository:** [https://github.com/ultrade-org/ultrade-js-sdk](https://github.com/ultrade-org/ultrade-js-sdk)
+
+## Package Info
+
+- **Name:** `@ultrade/ultrade-js-sdk`
+- **Main Entry:** `./dist/index.js`
+- **Types:** `./dist/index.d.ts`
+
+## Installation
+
+Install the package using your preferred package manager:
+
+```bash
+npm install @ultrade/ultrade-js-sdk
+```
+
+```bash
+yarn add @ultrade/ultrade-js-sdk
+```
+
+```bash
+pnpm add @ultrade/ultrade-js-sdk
+```
+
+## Structure
+
+```
+src/
+├── argsAsObj/              # Method argument interfaces (RO-RO pattern)
+│   ├── affiliates.args.ts  # Affiliate method arguments
+│   ├── auth.args.ts        # Authentication arguments
+│   ├── client.args.ts      # Client configuration arguments
+│   ├── market.args.ts      # Market data arguments
+│   ├── social.args.ts      # Social features arguments
+│   ├── system.args.ts      # System method arguments
+│   ├── trading.args.ts     # Trading operation arguments
+│   ├── wallet.args.ts      # Wallet operation arguments
+│   └── index.ts            # Barrel export
+│
+├── const/                  # Constants
+│   ├── auth.const.ts       # Authentication constants
+│   ├── client.const.ts     # Client configuration constants
+│   └── index.ts
+│
+├── enum/                   # Enumerations
+│   ├── account.enum.ts     # Account-related enums
+│   ├── affiliates.enum.ts  # Affiliate enums
+│   ├── common.enum.ts      # Common enums
+│   ├── market.enum.ts      # Market enums
+│   ├── social.enum.ts      # Social enums
+│   ├── socket.enum.ts      # WebSocket stream enums
+│   └── index.ts
+│
+├── interface/              # TypeScript interfaces
+│   ├── account.interface.ts        # Account data interfaces
+│   ├── affiliates.interface.ts     # Affiliate interfaces
+│   ├── assets.interface.ts         # Asset interfaces
+│   ├── auth.interface.ts           # Auth interfaces
+│   ├── client.interface.ts         # Client interfaces
+│   ├── common.interface.ts         # Common interfaces
+│   ├── maintenance.interface.ts    # Maintenance interfaces
+│   ├── market.interface.ts         # Market interfaces
+│   ├── notification.interface.ts   # Notification interfaces
+│   ├── social.interface.ts         # Social interfaces
+│   ├── socket.interface.ts         # WebSocket interfaces
+│   ├── system.interface.ts         # System interfaces
+│   ├── trading.interface.ts        # Trading interfaces
+│   ├── wallet.interface.ts         # Wallet interfaces
+│   └── index.ts
+│
+├── utils/                  # Utility functions
+│   ├── algodService.ts     # Algorand service
+│   ├── algorand.util.ts    # Algorand utilities
+│   ├── client.util.ts      # Client utilities
+│   └── index.ts
+│
+├── client.ts               # Main SDK Client class
+├── localStorage.ts         # Local storage service
+├── sockets.ts              # WebSocket manager
+└── index.ts                # Main entry point
+```
+
+## TypeScript Path Aliases
+
+Defined in `tsconfig.alias.json`:
+
+| Alias | Path | Description |
+|-------|------|-------------|
+| `@ultrade/shared/browser/*` | `../shared/dist/browser/*` | Browser-specific shared utilities |
+| `@utils` | `./src/utils/index.ts` | Utility functions |
+| `@interface` | `./src/interface/index.ts` | TypeScript interfaces |
+| `@const` | `./src/const/index.ts` | Constants |
+| `@enum` | `./src/enum/index.ts` | Enumerations |
+
+
+
+## Build Commands
+
+**Important:** First install node_modules from monorepo root (npm_packages)
+
+- `npm run build` - Production build
+- `npm run dev` - Development build with watch mode
+- `npm run version:update` - Bump patch version
+
+## Exports
+
+The package exports:
+- `Client` class - Main SDK client
+- `SocketManager` - WebSocket connection manager
+- All constants from `@const`
+- All enums from `@enum`
+- All interfaces from `@interface`
+- All argument interfaces from `./argsAsObj`

package/dist/argsAsObj/affiliates.args.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Affiliates-related method arguments
+ */
+export interface IGetAffiliatesStatusArgs {
+    companyId: number;
+}
+export interface ICreateAffiliateArgs {
+    companyId: number;
+}
+export interface IGetAffiliateProgressArgs {
+    companyId: number;
+}
+export interface IGetAffiliateInfoArgs {
+    companyId: number;
+    range: string;
+}
+export interface ICountAffiliateDepositArgs {
+    companyId: number;
+}
+export interface ICountAffiliateClickArgs {
+    referralToken: string;
+}

package/dist/argsAsObj/auth.args.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Authentication-related method arguments
+ */
+import { ILoginData, ITradingKeyData, IWithdrawData, ITransferData } from '../../../shared/dist/browser/interfaces';
+import { Signer } from '../interface/index.ts';
+export interface ILoginArgs extends ILoginData {
+    loginMessage?: string;
+}
+export interface IAddTradingKeyArgs {
+    data: ITradingKeyData;
+}
+export interface IRevokeTradingKeyArgs {
+    data: ITradingKeyData;
+}
+export interface IWithdrawArgs {
+    withdrawData: IWithdrawData;
+    prettyMsg?: string;
+}
+export interface ITransferArgs {
+    transferData: ITransferData;
+}
+export interface ISetSignerArgs {
+    signer: Signer;
+}

package/dist/argsAsObj/client.args.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Client configuration and subscription arguments
+ */
+import { ClientOptions, AuthCredentials, SubscribeOptions, WalletCredentials } from '../interface/index.ts';
+export interface IClientConstructorArgs {
+    options: ClientOptions;
+    authCredentials?: AuthCredentials;
+}
+export interface ISubscribeArgs {
+    subscribeOptions: SubscribeOptions;
+    callback: Function;
+}
+export interface IUnsubscribeArgs {
+    handlerId: number;
+}
+export interface ISetMainWalletArgs {
+    wallet: WalletCredentials;
+}
+export interface ISetUseUltradeIdArgs {
+    isUltrade: boolean;
+}

package/dist/argsAsObj/index.d.ts

@@ -0,0 +1,8 @@
+export * from './market.args';
+export * from './wallet.args';
+export * from './system.args';
+export * from './affiliates.args';
+export * from './social.args';
+export * from './auth.args';
+export * from './trading.args';
+export * from './client.args';

package/dist/argsAsObj/market.args.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Market-related method arguments
+ */
+export interface IGetPairListArgs {
+    companyId?: number;
+}
+export interface IGetPairArgs {
+    symbol: string | number;
+}
+export interface IGetPriceArgs {
+    symbol: string;
+}
+export interface IGetDepthArgs {
+    symbol: string;
+    depth: number;
+}
+export interface IGetSymbolsArgs {
+    mask?: string;
+}
+export interface IGetLastTradesArgs {
+    symbol: string;
+}
+export interface IGetHistoryArgs {
+    symbol: string;
+    interval: string;
+    startTime?: number;
+    endTime?: number;
+    limit?: number;
+    page?: number;
+}
+export interface IGetOrdersArgs {
+    symbol?: string;
+    status?: number;
+    limit?: number;
+    endTime?: number;
+    startTime?: number;
+}
+export interface IGetOrderByIdArgs {
+    orderId: number;
+}
+export interface IGetWithdrawalFeeArgs {
+    assetAddress: string;
+    chainId: number;
+}
+export interface IGetKycInitLinkArgs {
+    embeddedAppUrl: string | null;
+}
+export interface IGetDollarValuesArgs {
+    assetIds?: number[];
+}
+export interface IGetTransactionDetailsArgs {
+    transactionId: number;
+}

package/dist/argsAsObj/social.args.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Social-related method arguments
+ */
+import { TelegramData } from '../interface/index.ts';
+export interface IAddSocialEmailArgs {
+    email: string;
+    embeddedAppUrl: string;
+}
+export interface IVerifySocialEmailArgs {
+    email: string;
+    hash: string;
+}
+export interface IGetSeasonArgs {
+    ultradeId?: number;
+}
+export interface IAddTelegramArgs {
+    data: TelegramData;
+}
+export interface IDisconnectTelegramArgs {
+    data: TelegramData;
+}
+export interface IGetDiscordConnectionUrlArgs {
+    url: string;
+}
+export interface IGetTwitterConnectionUrlArgs {
+    appUrl: string;
+    permissions?: string;
+}
+export interface IActionWithTweetArgs {
+    actions: Array<{
+        id: number;
+        text?: string;
+    }>;
+    tweetId?: string;
+}
+export interface IGetAICommentArgs {
+    styleId: number;
+    tweetId: string;
+}

package/dist/argsAsObj/system.args.d.ts

@@ -0,0 +1,7 @@
+/**
+ * System-related method arguments
+ */
+import { UpdateUserNotificationDto } from '../interface/index.ts';
+export interface IReadNotificationsArgs {
+    notifications: UpdateUserNotificationDto[];
+}

package/dist/argsAsObj/trading.args.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Trading-related method arguments
+ */
+import { CreateOrderArgs, CancelOrderArgs } from '../interface/index.ts';
+export interface ICreateOrderArgs extends CreateOrderArgs {
+}
+export interface ICancelOrderArgs extends CancelOrderArgs {
+}
+export interface ICancelMultipleOrdersArgs {
+    orderIds?: number[];
+    pairId?: number;
+}

package/dist/argsAsObj/wallet.args.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Wallet-related method arguments
+ */
+import { CreateWithdrawalWallet, UpdateWithdrawalWallet, IWhiteList } from '../../../shared/dist/browser/interfaces';
+export interface IGetWalletTransactionsArgs {
+    type: string;
+    page: number;
+    limit?: number;
+}
+export interface IGetTransfersArgs {
+    page: number;
+    limit?: number;
+}
+export interface IAddWhitelistArgs {
+    data: IWhiteList;
+}
+export interface IDeleteWhitelistArgs {
+    whitelistId: number;
+}
+export interface IGetWithdrawalWalletByAddressArgs {
+    address: string;
+}
+export interface ICreateWithdrawalWalletArgs {
+    body: CreateWithdrawalWallet;
+}
+export interface IUpdateWithdrawalWalletArgs {
+    params: UpdateWithdrawalWallet;
+}
+export interface IDeleteWithdrawalWalletArgs {
+    address: string;
+}

package/dist/client.d.ts

@@ -0,0 +1,112 @@
+import { ITradingKeyData, TradingKeyView } from '../../shared/dist/browser/interfaces';
+import { ILoginData, ITransferData, IWithdrawData } from "../../shared/dist/browser/interfaces";
+import { CreateWithdrawalWallet, UpdateWithdrawalWallet } from "../../shared/dist/browser/interfaces";
+import { ISafeWithdrawalWallets } from "../../shared/dist/browser/interfaces";
+import { PaginatedResult } from "../../shared/dist/browser/interfaces";
+import { SocketManager } from "./sockets";
+import { AuthCredentials, ClientOptions, CancelOrderArgs, CreateOrderArgs, Signer, SubscribeOptions, TelegramData, WalletCredentials, UserNotification, IPairDto, IGetDepth, SettingsInit, IGetLastTrades, CodexBalanceDto, IOrderDto, Order, Chain, MappedCCTPAssets, CCTPUnifiedAssets, IGetKycStatus, IGetKycInitLink, IGetDollarValues, ITransactionDetails, IClient, IGetPrice, IGetSymbols, IGetHistoryResponse, IWithdrawalFee, ITransaction, ITradingKey, ITransfer, IPendingTxn, IGetWhiteList, IWhiteList, ISystemVersion, ISystemMaintenance, IUnreadNotificationsCount, UpdateUserNotificationDto, IAffiliateDashboardStatus, IAffiliateProgress, DashboardInfo, ISocialAccount, ILeaderboardItem, IUnlock, IAction, IActionHistory, ISocialSettings, ISocialSeason, ITelegramConnectResponse, ICompanyTweet, IAIStyle, IAIGeneratedComment, IWithdrawResponse, IRevokeTradingKeyResponse, ICancelOrderResponse, ICancelMultipleOrdersResponse } from "./interface/index.ts";
+export declare class Client implements IClient {
+    private client;
+    private algodNode;
+    private algodIndexer;
+    private apiUrl;
+    private companyId;
+    private websocketUrl;
+    private wallet;
+    private _axios;
+    private localStorageService;
+    private isUltradeID;
+    socketManager: SocketManager;
+    constructor(options: ClientOptions, authCredentials?: AuthCredentials);
+    private axiosInterceptor;
+    get useUltradeID(): boolean;
+    set useUltradeID(isUltrade: boolean);
+    get isLogged(): boolean;
+    get mainWallet(): WalletCredentials | null;
+    set mainWallet(wallet: WalletCredentials);
+    setSigner(signer: Signer): void;
+    subscribe(subscribeOptions: SubscribeOptions, callback: Function): number;
+    unsubscribe(handlerId: number): void;
+    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>;
+    getSettings(): Promise<SettingsInit>;
+    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>;
+    getTransactionDetalis(transactionId: number): Promise<ITransactionDetails>;
+    getWalletTransactions(type: string, page: number, limit?: number): Promise<PaginatedResult<ITransaction>>;
+    getTradingKeys(): Promise<ITradingKey>;
+    getTransfers(page: number, limit?: number): Promise<PaginatedResult<ITransfer>>;
+    getPendingTransactions(): Promise<IPendingTxn[]>;
+    getWhitelist(): Promise<PaginatedResult<IGetWhiteList>>;
+    addWhitelist(data: IWhiteList): Promise<IGetWhiteList>;
+    deleteWhitelist(whitelistId: number): Promise<void>;
+    getAllWithdrawalWallets(): Promise<ISafeWithdrawalWallets[]>;
+    getWithdrawalWalletByAddress(address: string): Promise<ISafeWithdrawalWallets>;
+    createWithdrawalWallet(body: CreateWithdrawalWallet): Promise<ISafeWithdrawalWallets>;
+    updateWithdrawalWallet(params: UpdateWithdrawalWallet): Promise<boolean>;
+    deleteWithdrawalWallet(address: string): Promise<boolean>;
+    getVersion(): Promise<ISystemVersion>;
+    getMaintenance(): Promise<ISystemMaintenance>;
+    getNotifications(): Promise<UserNotification[]>;
+    getNotificationsUnreadCount(): Promise<IUnreadNotificationsCount>;
+    readNotifications(notifications: UpdateUserNotificationDto[]): Promise<UpdateUserNotificationDto[]>;
+    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>;
+    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>;
+    private getTechnologyByProvider;
+    login({ address, provider, chain, referralToken, loginMessage }: ILoginData): Promise<string>;
+    addTradingKey(data: ITradingKeyData): Promise<TradingKeyView>;
+    revokeTradingKey(data: ITradingKeyData): Promise<IRevokeTradingKeyResponse>;
+    withdraw(withdrawData: IWithdrawData, prettyMsg?: string): Promise<IWithdrawResponse>;
+    transfer(transferData: ITransferData): Promise<ITransfer>;
+    createOrder(order: CreateOrderArgs): Promise<IOrderDto>;
+    cancelOrder(order: CancelOrderArgs): Promise<ICancelOrderResponse>;
+    cancelMultipleOrders({ orderIds, pairId }: {
+        orderIds?: number[];
+        pairId?: number;
+    }): Promise<ICancelMultipleOrdersResponse>;
+    ping(): Promise<number>;
+}

package/dist/const/auth.const.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_LOGIN_MESSAGE = "By signing this message you are logging into your trading account and agreeing to all terms and conditions of the platform.";

package/dist/const/client.const.d.ts

@@ -0,0 +1,8 @@
+export interface NetworkConfig {
+    algodNode: string;
+    apiUrl: string;
+    algodIndexer: string;
+}
+export type Network = 'mainnet' | 'testnet' | 'local';
+export declare const NETWORK_CONFIGS: Record<Network, NetworkConfig>;
+export declare const tokenizedUrls: readonly ["/market/balances", "/market/order", "/market/orders", "/market/account/kyc/status", "/market/account/kyc/init", "/market/withdrawal-fee", "/market/operation-details", "/wallet/key", "/wallet/transactions", "/wallet/transfer", "/wallet/withdraw", "/wallet/whitelist", "/wallet/withdrawal-wallets"];

package/dist/const/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./auth.const";
+export * from "./client.const";

package/dist/enum/account.enum.d.ts

@@ -0,0 +1,42 @@
+export declare enum POINTS_SETTING {
+    OFF = "disable",
+    ULTRADE = "ultrade",
+    ALL = "all"
+}
+export declare enum SettingIds {
+    ENABLED = "company.enabled",
+    APP_TITLE = "company.appTitle",
+    DOMAIN = "company.domain",
+    DIRECT_SETTLE = "company.directSettlement",
+    KYC = "markets.kycTradeRequirementEnabled",
+    GEOBLOCK = "company.geoblock",
+    LOGO = "appearance.logo",
+    THEMES = "appearance.themes",
+    NEW_TAB = "appearance.newTab",
+    TARGET = "appearance.target",
+    REPORT_BUTTONS = "appearance.reportButtons",
+    CUSTOM_MENU_ITEMS = "appearance.customMenuItems",
+    APPEARANCE_CHART_TYPE = "appearance.chartType",
+    APPEARANCE_CHART_INT = "appearance.chartInt",
+    AMM = "product.amm",
+    OBDEX = "product.obdex",
+    POINTS = "product.pointSystem",
+    AFFILIATE_DASHBOARD_THRESHOLD = "product.affiliateDashboardThreshold",
+    AFFILIATE_DEFAULT_FEE_SHARE = "product.affiliateDefaultFeeShare",
+    AFFILIATE_DASHBOARD_VISIBILITY = "product.affiliateDashboardVisibility",
+    AMM_FEE = "company.ammFee",
+    FEE_SHARE = "company.feeShare",
+    MIN_FEE = "company.minFee",
+    MAKER_FEE = "company.makerFee",
+    TAKER_FEE = "company.takerFee",
+    PINNED_PAIRS = "markets.pinnedPairs",
+    TWITTER_ENABLED = "point-system.twitterEnabled",
+    TWITTER_JOB_ENABLED = "point-system.twitterJobEnabled",
+    TWITTER_HASHTAGS = "point-system.twitterHashtags",
+    TWITTER_ACCOUNT_NAME = "point-system.twitterAccountName",
+    DISCORD_ENABLED = "point-system.discordEnabled",
+    TELEGRAM_ENABLED = "point-system.telegramEnabled",
+    TELEGRAM_GROUP_NAME = "point-system.telegramGroupName",
+    TELEGRAM_BOT_NAME = "point-system.telegramBotName",
+    GUIDE_LINK = "point-system.guideLink"
+}

package/dist/enum/affiliates.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum AffDashboardVisibilitySettingEnum {
+    DISABLED = "disabled",
+    ENABLED_FOR_ALL = "enabled for all",
+    ENABLED_FOR_AFFILIATES = "enabled for affiliates"
+}

package/dist/enum/common.enum.d.ts

@@ -0,0 +1,15 @@
+export declare enum DIRECT_SETTLE {
+    YES = "Y",
+    NO = "N"
+}
+export declare enum PairSettingsIds {
+    MFT_AUDIO_LINK = "mft.audioLink",
+    MFT_TITLE = "mft.title",
+    VIEW_BASE_COIN_ICON_LINK = "view.baseCoinIconLink",
+    VIEW_BASE_COIN_MARKET_LINK = "view.baseCoinMarketLink",
+    VIEW_PRICE_COIN_ICON_LINK = "view.priceCoinIconLink",
+    VIEW_PRICE_COIN_MARKET_LINK = "view.priceCoinMarketLink",
+    MAKER_FEE = "makerFee",
+    TAKER_FEE = "takerFee",
+    MODE_PRE_SALE = "mode.preSale"
+}

package/dist/enum/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./common.enum";
+export * from "./market.enum";
+export * from "./social.enum";
+export * from "./socket.enum";
+export * from "./account.enum";
+export * from "./affiliates.enum";