@ultrade/ultrade-js-sdk 2.0.2 → 2.0.3

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,4 @@
-import { SubscribeOptions, SocketIOFactory, SocketIOClient } from './interfaces';
+import { SubscribeOptions, SocketIOFactory, SocketIOClient } from './interface/index.ts';
 export declare class SocketManager {
     private onDisconnect?;
     private onConnectError?;

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";

package/package.json

@@ -1,17 +1,22 @@
 {
   "name": "@ultrade/ultrade-js-sdk",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "This package contains the original js/ts SDK.",
   "main": "./dist/index.js",
-  "types": "./dist/src/index.d.ts",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "build": "cross-env MODE=production ts-node esbuild.config.ts",
     "dev": "ts-node esbuild.config.ts",
     "version:update": "npm version patch --no-git-tag-version"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
@@ -26,9 +31,7 @@
   "peerDependencies": {
     "algosdk": "^2.0.0",
     "axios": "^0.27.2",
-    "react-secure-storage": "^1.3.2"
-  },
-  "dependencies": {
+    "react-secure-storage": "^1.3.2",
     "@ultrade/shared": "^1.0.9"
   }
 }

package/dist/src/client.d.ts

@@ -1,143 +0,0 @@
-import { AxiosResponse } from "axios";
-import { SocketManager } from "./sockets";
-import { AuthCredentials, ClientOptions, CancelOrderArgs, CreateOrderArgs, Signer, SubscribeOptions, TelegramData, WalletCredentials, UserNotification } from "./interfaces";
-import { ITradingKeyData } from '@ultrade/shared/browser/interfaces';
-import { ILoginData, ITransferData, IWithdrawData } from "@ultrade/shared/browser/interfaces";
-import { KYCAuthenticationStatus } from "@ultrade/shared/browser/enums";
-import { CreateWithdrawalWallet, UpdateWithdrawalWallet } from "@ultrade/shared/browser/interfaces";
-import { ISafeWithdrawalWallets } from "@ultrade/shared/browser/interfaces";
-export declare class Client {
-    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<AxiosResponse<any, any>>;
-    getExchangeInfo(symbol: string | number): Promise<AxiosResponse<any, any>>;
-    getPrice(symbol: string): Promise<{
-        ask: number;
-        bid: number;
-        last: number;
-    }>;
-    getDepth(symbol: string, depth: number): Promise<any>;
-    getSymbols(mask?: string): Promise<Array<{
-        pairKey: string;
-    }>>;
-    getLastTrades(symbol: string): Promise<any>;
-    getHistory(symbol: string, interval: string, startTime?: number, endTime?: number, limit?: number, page?: number): Promise<any>;
-    getOrders(symbol?: string, status?: number, limit?: number, endTime?: number, startTime?: number): Promise<AxiosResponse<any, any>>;
-    getOrderById(orderId: number): Promise<any>;
-    getSettings(): Promise<any>;
-    getBalances(): Promise<any>;
-    getChains(): Promise<any>;
-    getCodexAssets(): Promise<any>;
-    getCCTPAssets(): Promise<any>;
-    getCCTPUnifiedAssets(): Promise<any>;
-    getWithdrawalFee(assetAddress: string, chainId: number): Promise<any>;
-    getKycStatus(): Promise<{
-        kycStatus?: KYCAuthenticationStatus;
-    }>;
-    getKycInitLink(embeddedAppUrl: string | null): Promise<{
-        url: string;
-    }>;
-    getDollarValues(assetIds?: number[]): Promise<{
-        [key: string]: number;
-    }>;
-    getTransactionDetalis(transactionId: number): Promise<any>;
-    getWalletTransactions(type: string, page: number, limit?: number): Promise<AxiosResponse<any, any>>;
-    getTradingKeys(): Promise<AxiosResponse<any, any>>;
-    getTransfers(page: number, limit?: number): Promise<AxiosResponse<any, any>>;
-    getPendingTransactions(): Promise<AxiosResponse<any, any>>;
-    getWhitelist(): Promise<AxiosResponse<any, any>>;
-    addWhitelist(data: any): Promise<{
-        signature: string;
-    }>;
-    deleteWhitelist(whitelistId: number): Promise<{
-        signature: string;
-    }>;
-    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<any>;
-    getMaintenance(): Promise<any>;
-    getNotifications(): Promise<UserNotification[]>;
-    getNotificationsUnreadCount(): Promise<{
-        count: number;
-    }>;
-    readNotifications(notifications: any[]): Promise<any>;
-    getAffiliatesStatus(companyId: number): Promise<AxiosResponse<any, any>>;
-    createAffiliate(companyId: number): Promise<AxiosResponse<any, any>>;
-    getAffiliateProgress(companyId: number): Promise<AxiosResponse<any, any>>;
-    getAffiliateInfo(companyId: number, range: string): Promise<AxiosResponse<any, any>>;
-    countAffiliateDepost(companyId: number): Promise<AxiosResponse<any, any>>;
-    countAffiliateClick(referralToken: string): Promise<AxiosResponse<any, any>>;
-    getSocialAccount(): Promise<AxiosResponse<any, any>>;
-    addSocialEmail(email: string, embeddedAppUrl: string): Promise<AxiosResponse<any, any>>;
-    verifySocialEmail(email: string, hash: string): Promise<AxiosResponse<any, any>>;
-    getLeaderboards(): Promise<AxiosResponse<any, any>>;
-    getUnlocks(): Promise<AxiosResponse<any, any>>;
-    getSocialSettings(): Promise<AxiosResponse<any, any>>;
-    getSeason(ultradeId?: number): Promise<AxiosResponse<any, any>>;
-    getPastSeasons(): Promise<AxiosResponse<any, any>>;
-    addTelegram(data: TelegramData): Promise<AxiosResponse<any, any>>;
-    disconnectTelegram(data: TelegramData): Promise<AxiosResponse<any, any>>;
-    getDiscordConnectionUrl(url: any): Promise<any>;
-    disconnectDiscord(): Promise<AxiosResponse<any, any>>;
-    getTwitterConnectionUrl(appUrl: string, permissions?: string): Promise<any>;
-    disconnectTwitter(): Promise<AxiosResponse<any, any>>;
-    getTweets(): Promise<AxiosResponse<any, any>>;
-    actionWithTweet(data: {
-        actions: [{
-            id: number;
-            text?: string;
-        }];
-        tweetId?: string;
-    }): Promise<AxiosResponse<any, any>>;
-    getActions(): Promise<AxiosResponse<any, any>>;
-    getActionHistory(): Promise<AxiosResponse<any, any>>;
-    getAIStyles(): Promise<AxiosResponse<any, any>>;
-    getAIComment(styleId: number, tweetId: string): Promise<AxiosResponse<any, any>>;
-    private getTechnologyByProvider;
-    login({ address, provider, chain, referralToken, loginMessage }: ILoginData): Promise<{
-        signature: string;
-    }>;
-    addTradingKey(data: ITradingKeyData): Promise<{
-        signature: string;
-    }>;
-    revokeTradingKey(data: ITradingKeyData): Promise<{
-        signature: string;
-    }>;
-    withdraw(withdrawData: IWithdrawData, prettyMsg?: string): Promise<{
-        signature: string;
-    }>;
-    transfer(transferData: ITransferData): Promise<{
-        signature: string;
-    }>;
-    createOrder(order: CreateOrderArgs): Promise<{
-        signature: string;
-    }>;
-    cancelOrder(order: CancelOrderArgs): Promise<any>;
-    cancelMultipleOrders({ orderIds, pairId }: {
-        orderIds?: number[];
-        pairId?: number;
-    }): Promise<any>;
-    ping(): Promise<number>;
-}

package/dist/src/index.d.ts

@@ -1,2 +0,0 @@
-export * from './client';
-export { SocketManager } from './sockets';

package/dist/src/interfaces.d.ts

@@ -1,136 +0,0 @@
-import { STREAMS } from "./enums";
-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 TelegramData {
-    auth_date: number;
-    id: number;
-    first_name: string;
-    hash: string;
-    photo_url: string;
-    username: string;
-}
-export interface AppSocketState {
-    address: string;
-    appId: number;
-    orderFilter: string;
-    pairKey: string;
-    pairId: number;
-}
-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;
-}
-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 ClientOptions {
-    network: 'mainnet' | 'testnet' | 'local';
-    apiUrl?: string;
-    algoSdkClient: any;
-    websocketUrl: string;
-    companyId?: number;
-    socketIO: SocketIOFactory;
-}
-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;
-}
-export interface SubscribeOptions {
-    symbol: string;
-    streams: STREAMS[];
-    options: WSOptions;
-}
-interface WSOptions {
-    address: string;
-    token?: string;
-    tradingKey?: string;
-    message?: string;
-    signature?: string;
-    depth?: number;
-    companyId?: number;
-    interval?: string;
-}
-export interface ServerToClientEvents {
-    reconnect: () => void;
-}
-export interface ClientToServerEvents {
-    subscribe: (options: SubscribeOptions) => void;
-    unsubscribe: (options: SubscribeOptions) => void;
-}
-export interface TxnParams {
-    suggestedParams: any;
-    from: string;
-    to: string;
-    amount: number;
-    assetIndex?: number;
-}
-export type OrderSide = 'S' | 'B';
-export type OrderType = 'L' | 'I' | 'P' | 'M';
-export interface UserNotification {
-    id: number;
-    globalNotificationId: number;
-    priority: any;
-    status: any;
-    type: any;
-    message: string;
-    createdAt: Date;
-}
-export {};

package/dist/src/utils.d.ts

@@ -1,2 +0,0 @@
-export declare const unpackData: (data: any) => any;
-export declare const decodeString: (value: Uint8Array) => string;