@ultrade/shared 1.0.0

package/dist/interfaces/accountInfo.interface.d.ts

@@ -0,0 +1,15 @@
+import { KYCAuthenticationStatus, LastLookAction, MarketMakerRebateTier } from '@enums';
+import { IAccount } from '@interfaces';
+export interface IAccountInfo extends IAccount {
+    lastLook?: {
+        defaultAction: LastLookAction;
+        defaultTimeout: number;
+    };
+    loggedOnce?: boolean;
+    lastTradedAt?: Date;
+    tradesPerDay?: number;
+    marketMakerTier: MarketMakerRebateTier | 0;
+    mmTakerFee: number;
+    kycStatus?: KYCAuthenticationStatus;
+    signInCompanyId?: number;
+}

package/dist/interfaces/algostreamer/index.d.ts

@@ -0,0 +1,49 @@
+interface ICodexBalanceLog {
+    loginAddr: string;
+    loginChainID: string;
+    tokenAddr: string;
+    tokenChainID: string;
+    amount: string;
+}
+export interface ICodexDepositLog extends ICodexBalanceLog {
+    sender: string;
+    senderChainID: string;
+}
+export interface ICodexWithdrawal extends ICodexBalanceLog {
+    destAddr: string;
+    destChainID: string;
+    fee: string;
+    txnId: string;
+    msgHash: string;
+}
+export interface ICodexTransfer {
+    transferId: number;
+    transferFee: number;
+    completedAt: number;
+    txnId: string;
+    loginAddr: string;
+    loginChainID: string;
+    destAddr: string;
+    destChainID: string;
+    tokenAddr: string;
+    tokenChainID: string;
+    amount: string;
+}
+export interface StreamerVaa {
+    amount: string;
+    emitterId: number;
+    loginAddr: string;
+    loginChainID: string;
+    destAddr: string;
+    destChainID: string;
+    sender: string;
+    senderChainID: string;
+    tokenAddr: string;
+    tokenChainID: string;
+    sequence: string;
+    vaaType: 'withdraw' | 'deposit';
+    txnId: string;
+    fee: string;
+    msgHash?: string;
+}
+export {};

package/dist/interfaces/api/affiliate.interface.d.ts

@@ -0,0 +1,71 @@
+import { DBAffiliate } from '@interfaces';
+export interface SummaryStat {
+    value: number | null;
+    trend: number | null;
+}
+export interface TrendStat {
+    value: number;
+    time: number;
+}
+export interface AffiliateStats<StatType> {
+    totalRevenue: StatType;
+    linkClicks: StatType;
+    registrations: StatType;
+    firstTimeDepositors: StatType;
+    totalTradingVolume: StatType;
+    totalFees: StatType;
+}
+export interface DashboardInfo {
+    feeShare: number;
+    referralLink: string;
+    summaryStats: SummaryStats;
+    trendStats: TrendStats | null;
+}
+export interface RegularStats extends AffiliateStats<number> {
+}
+export interface SummaryStats extends AffiliateStats<SummaryStat> {
+}
+export interface TrendStats extends AffiliateStats<TrendStat[]> {
+}
+export interface WLAffiliateStats<StatType> {
+    totalRevenue: StatType;
+    conversionRate: StatType;
+    registrations: StatType;
+    totalTradingVolume: StatType;
+    qualifiedReferrers: StatType;
+    totalAffiliateRevenue: StatType;
+}
+export interface WLRegularStats {
+    totalRevenue: number;
+    registrations: number;
+    totalTradingVolume: number;
+    totalAffiliateRevenue: number;
+    firstTimeDepositors: number;
+}
+export interface WLSummaryStats extends WLAffiliateStats<SummaryStat> {
+}
+export interface WLTrendStats extends WLAffiliateStats<TrendStat[]> {
+}
+export interface WLDashboardInfo {
+    summaryStats: WLSummaryStats;
+    trendStats: WLTrendStats | null;
+}
+export interface MappedAffiliateData extends DBAffiliate {
+    totalAffiliateRevenue: number;
+    totalCompanyRevenueFromAffiliate: number;
+}
+export interface CompanyAffiliateStats {
+    address: string;
+    createdAt: Date;
+    tradingVolume: number;
+    referrals: number;
+    feeShare: number;
+}
+export interface AffiliatePerformance {
+    totalUsersReferred: SummaryStat;
+    totalRevenue: SummaryStat;
+    currentMonthReferrals: SummaryStat;
+    currentMonthRevenue: SummaryStat;
+    averageUserValue: SummaryStat;
+    conversionRate: SummaryStat;
+}

package/dist/interfaces/cache.interface.d.ts

@@ -0,0 +1,25 @@
+import { ICompany, ICompanySetting } from '@interfaces';
+export interface ICompanyCache extends Pick<ICompany, 'id' | 'domain' | 'name' | 'enabled' | 'isSuper' | 'collectionWallet' | 'collectionWalletChainId'> {
+    companyBDPartner: ICompanyBDPartnerCache;
+}
+export interface ICompanyCacheWithTakerFee extends ICompanyCache {
+    settings: [ICompanySetting];
+}
+export interface ICompanyBDPartnerCache {
+    address: string;
+    chainId: number;
+    feeShare: number;
+}
+export interface ICompanyAffiliateCache {
+    id: number;
+    address: string;
+    companyId: number;
+    chainId: number;
+    feeShare: number;
+    pointsReward: number;
+    expiresAt?: Date;
+}
+export interface IRedisCacheEntry<T> {
+    data: T;
+    lastUpdatedAt?: number;
+}

package/dist/interfaces/confirmed-txn.interface.d.ts

@@ -0,0 +1,46 @@
+export interface InnerTxnBody {
+    apan?: number;
+    apap?: Uint8Array[];
+    apsu?: Uint8Array[];
+    amt?: number;
+    fv: number;
+    lv: number;
+    rcv?: Uint8Array;
+    snd: Uint8Array;
+    type: 'appl' | 'pay';
+}
+export interface MainTxnBody {
+    apaa: Uint8Array[];
+    apat: Uint8Array[];
+    apbx: Array<{
+        n: Uint8Array[];
+    }>;
+    apfa: number[];
+    apid: number;
+    fee: number;
+    fv: number;
+    gen: string;
+    gh: Uint8Array;
+    grp: Uint8Array;
+    lv: number;
+    note: Uint8Array;
+    snd: Uint8Array;
+    type: 'appl';
+}
+export interface InnerTransaction {
+    'application-index'?: number;
+    'pool-error': string;
+    txn: {
+        txn: InnerTxnBody;
+    };
+}
+export interface ConfirmedTxn {
+    'confirmed-round': number;
+    'inner-txns': InnerTransaction[];
+    logs: Uint8Array[];
+    'pool-error': string;
+    txn: {
+        sig: Uint8Array;
+        txn: MainTxnBody;
+    };
+}

package/dist/interfaces/controller.interface.d.ts

@@ -0,0 +1,6 @@
+import { Router } from 'express';
+interface Controller {
+    path: string;
+    router: Router;
+}
+export default Controller;

package/dist/interfaces/db/baseModel.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IBaseModel {
+    id: number;
+    created_at: Date;
+    updated_at: Date;
+}

package/dist/interfaces/db/hummingbot/index.d.ts

@@ -0,0 +1,18 @@
+import { HummingbotInstanceStatus } from '@types';
+import { IUser } from '@interfaces';
+export interface IStrategy {
+    id: number;
+    name: string;
+    description: string;
+    configTemplate: string;
+}
+export interface IHummingbotInstance {
+    id: number;
+    awsId: string | null;
+    partner: IUser | number;
+    strategy: IStrategy | number;
+    configHash: string;
+    status: HummingbotInstanceStatus;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/interfaces/db/index.d.ts

@@ -0,0 +1,10 @@
+export * from './baseModel.interface';
+export * from './softDeleteModel.interface';
+export * from './market';
+export * from './white_label';
+export * from './withdrawal_wallets';
+export * from './social';
+export * from './marketing';
+export * from './relayer';
+export * from './notification_center';
+export * from './hummingbot';

package/dist/interfaces/db/market/index.d.ts

@@ -0,0 +1,313 @@
+import { FeeTier, LastLookAction, KYCAuthenticationStatus, StateType, UpgradeStatus, OrderSide, TradeStatus, TradeSubStatus, TradingKeyType, ComponentType, ComponentStatusType, PairComponentStatusType } from '@enums';
+import { IBaseModel, ICompany, IPair } from '@interfaces';
+export interface IAccount {
+    address: string;
+    chainId: number;
+    makerTier: FeeTier;
+    takerTier: FeeTier;
+    createdAt?: Date;
+    updatedAt: Date;
+    invitedByAffiliates?: IInvitedByAffiliateAccount[];
+    invitedByAffiliateId?: number;
+}
+export interface IWhitelist {
+    id: number;
+    accountAddress: string;
+    account: IAccount;
+    tkAddress: string;
+    tradingKey: ITradingKey;
+    recipientAddress: string;
+    recipient: IAccount;
+    expiredAt: Date;
+    createdAt: Date;
+    deletedAt: Date;
+    message: string;
+    signature: string;
+}
+export interface ITransfer {
+    id: number;
+    accountAddress: string;
+    account?: IAccount;
+    recipientAddress: string;
+    recipient?: IAccount;
+    status: string;
+    tokenId: number;
+    token?: ICodexAsset;
+    txnId?: string;
+    ctwId: number | null;
+    ctw?: IWhitelist;
+    amount: string;
+    expiredAt: Date;
+    createdAt: Date;
+    completedAt: Date | null;
+    hash: string;
+    message: string | null;
+    signature: string;
+}
+export interface ITradingKey {
+    address: string;
+    accountAddress: string;
+    account: IAccount;
+    createdAt: Date;
+    expiredAt?: Date;
+    deviceInfo: string;
+    type: TradingKeyType;
+    message: string;
+    signature: string;
+    deletedOn: Date;
+    orders: IOrder[];
+}
+export interface IInvitedByAffiliateAccount {
+    affiliateId: number;
+    accountAddress: string;
+    companyId: number;
+    firstDepositDate?: Date;
+}
+export interface ICodexAsset {
+    id: number;
+    address: string;
+    chainId: number;
+    unitName: string;
+    name: string;
+    decimals: number;
+    isGas: boolean;
+    deletedAt: Date;
+    coinmarketcapId: number | null;
+    img: string;
+    cmcLink: string;
+}
+export interface ICodexBalance {
+    hash: string;
+    loginAddress: string;
+    loginChainId: number;
+    tokenId: string;
+    tokenChainId: number;
+    amount: string;
+    lockedAmount: string;
+    token?: ICodexAsset;
+}
+export interface ICountry {
+    id: string;
+    name: string;
+    pairs: IPair[];
+}
+export interface IPairDelisting {
+    pairId: number;
+    companyId: number;
+    retryCount: number;
+    isDelisted: boolean;
+    scheduledDelistDate: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IPairSetting extends IBaseModel {
+    pairId: number;
+    settingId: string;
+    companyId?: number;
+    value: string;
+    enabled: boolean;
+    pair: IPair;
+    setting: IAvailablePairSetting;
+}
+export interface IAvailablePairSetting {
+    id: string;
+}
+export interface IOrder {
+    id: number;
+    pairId: number;
+    pair: IPair;
+    side: number;
+    type: number;
+    price: string;
+    excutedPrice: string;
+    amount: string;
+    filledAmount: string;
+    status: number;
+    total: string;
+    filledTotal: string;
+    userId: string;
+    chainId: number;
+    tradingKey: string;
+    expiryAt: Date | null;
+    completedAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    partnerId: number;
+    directSettle: boolean;
+    companyId: number;
+    messageHash: string | null;
+    message: string;
+    signature: string;
+    buyTrades?: ITrade[];
+    sellTrades?: ITrade[];
+}
+export interface ITrade {
+    tradeId: number;
+    pairId: number;
+    pair: IPair;
+    txnId?: string;
+    buyOrderId: number | null;
+    buyOrder?: IOrder;
+    sellOrderId: number | null;
+    sellOrder?: IOrder;
+    buyUserId: string | null;
+    sellUserId: string | null;
+    price: string;
+    amount: string;
+    total: string;
+    txStatus: TradeStatus;
+    subStatus: TradeSubStatus | null;
+    createdAtTimestamp: number;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date;
+    tradeSide: OrderSide;
+    tradeFees: ITradeFee[];
+}
+export interface ITradeFee {
+    tradeId: number;
+    address: string;
+    fee: number;
+    rebate: number;
+}
+export interface IChain {
+    whChainId: number;
+    active: boolean;
+    isEvm: boolean;
+    providerUrl: string;
+    wss: string;
+    tmc: string;
+    dispencer: string;
+    token: string;
+    whChain?: IWormholeChain;
+}
+export interface IWormholeChain {
+    id: number;
+    name: string;
+    mainnet?: string;
+    mainnetDescription?: string;
+    testnet?: string;
+    testnetDescription?: string;
+}
+export interface ICCTPAsset {
+    chainId: number;
+    address: string;
+    active: boolean;
+}
+export interface ICCTPUnifiedAsset extends ICCTPUnifiedAssetPreview {
+    cctpAssets: ICCTPAsset[];
+}
+export interface ICCTPUnifiedAssetPreview {
+    id: number;
+    address: string;
+    chainId: number;
+    symbol: string;
+}
+export interface ICCTPAssetWithUnified extends ICCTPAsset {
+    unifiedAsset: ICCTPUnifiedAssetPreview;
+}
+export interface IAsset {
+    id: number;
+    unitName: string;
+    name?: string;
+    imgUrl?: string;
+    decimals: number;
+    minDispnse?: string;
+    maxDispnse?: string;
+    creator: string;
+    total: number;
+    defaultFrozen: boolean;
+    url?: string;
+    clawback?: string;
+}
+export interface IPool {
+    id: number;
+    ammId: number;
+    asset1Id: IAsset;
+    asset2Id: IAsset;
+    fee: number;
+    poolTokenId: IAsset;
+    poolType: string;
+}
+export interface ITinymanPool {
+    id: string;
+    ammId: number;
+    asset1Id: IAsset;
+    asset2Id: IAsset;
+    fee: number;
+    poolTokenId: IAsset;
+    poolType: string;
+}
+export type BalanceActionType = "deposit" | "withdraw" | "order" | "trade" | "transfer";
+export interface ICodexBalanceHistory {
+    id: number;
+    hash: string;
+    loginAddress: string;
+    loginChainId: number;
+    tokenId: string;
+    tokenChainId: number;
+    action: BalanceActionType;
+    amount: string;
+    lockedAmount: string;
+    deltaAmount: string;
+    deltaLockedAmount: string;
+    createdAt: Date;
+}
+export interface ILastLookAccount {
+    address: string;
+    action: LastLookAction;
+    timeout: number;
+}
+export interface IKYCAuthentication {
+    address: string;
+    account: IAccount;
+    kycStatus: KYCAuthenticationStatus;
+    ondatoSetupId: string;
+    companyId: number;
+    company: ICompany;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IComponent {
+    id: ComponentType;
+    name: string;
+    instances: IComponentInstance[];
+}
+export interface IComponentInstance {
+    id: number;
+    vendor_id: number;
+    type: ComponentType;
+    component: IComponent;
+    status: ComponentStatusType;
+    last_heartbeat: Date;
+    pairComponents: IPairComponent[];
+}
+export interface IPairComponent {
+    pair_id: number;
+    pair: IPair;
+    instance_id?: number;
+    instance?: IComponentInstance;
+    status: PairComponentStatusType;
+    required_cu: number;
+    last_heartbeat: Date;
+}
+export interface IOrderBox {
+    hash: string;
+    expiryAt: number;
+    deletedAt?: Date;
+}
+export interface IUltradeState {
+    id: StateType;
+    value: string;
+}
+export interface IUpgradeHistory {
+    id: number;
+    proxyAddress: string;
+    implementationAddress: string;
+    chainId: number;
+    algoTxnId: string;
+    evmTxnId?: string;
+    status: UpgradeStatus;
+    createdAt: Date;
+}

package/dist/interfaces/db/marketing/index.d.ts

@@ -0,0 +1,48 @@
+export interface IActionTable {
+    id: number;
+    action_dict: string;
+    unique_id: string;
+}
+export interface IUserRecord {
+    id: number;
+    points: number;
+    twitter_user_id: string;
+    telegram_user_id: string;
+    discord_user_id: string;
+    reddit_user_id: string;
+    unique_id: string;
+    last_deducted_timestamp: number;
+    received_award_ids: string;
+}
+export interface ITrackInvitesModel {
+    id: number;
+    inviter_id: string;
+    invitee_id: string;
+    unique_id: string;
+}
+export interface IMessagingModel {
+    id: number;
+    unique_id: number;
+    data: string;
+    msg_type: string;
+    active: boolean;
+}
+export interface IWeeklyDeductionTable {
+    id: number;
+    length: number;
+    unique_id: string;
+    values_array: string;
+}
+export interface ITrackUserPoints {
+    id: number;
+    user_record_id: string;
+    event: string;
+    point_difference: number;
+    unique_id: string;
+}
+export interface IVipLevelTable {
+    id: number;
+    length: number;
+    unique_id: string;
+    values_array: string;
+}

package/dist/interfaces/db/notification_center/index.d.ts

@@ -0,0 +1,33 @@
+import { GlobalNotificationEnum, NotificationPriorityEnum, NotificationStatusEnum, NotificationType, ScheduledNotificationStatusEnum } from '@enums';
+import { IAccount } from '@interfaces';
+export interface INotificationModel {
+    id: number;
+    priority: NotificationPriorityEnum;
+    message: string;
+    referenceId?: number;
+    companyId: number;
+    createdAt: Date;
+}
+export interface IGlobalNotification extends INotificationModel {
+    type: GlobalNotificationEnum;
+}
+export interface IScheduledNotification extends INotificationModel {
+    type: GlobalNotificationEnum;
+    scheduledAt: Date;
+    status: ScheduledNotificationStatusEnum;
+}
+export interface IUserNotification extends INotificationModel {
+    account: IAccount;
+    address: string;
+    type: NotificationType;
+    status: NotificationStatusEnum;
+    globalNotificationId?: number;
+    globalNotification: IGlobalNotification;
+}
+export interface INotificationTemplate {
+    type: NotificationType;
+    priority: NotificationPriorityEnum;
+    text: string;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/interfaces/db/relayer/index.d.ts

@@ -0,0 +1,56 @@
+import { CCTPStatus, TransactionType } from '@enums';
+import { ICodexAsset } from '@interfaces';
+export interface IOperationStatus {
+    primaryId: number;
+    id: string;
+    hash?: string;
+    login_address: string;
+    login_chain_id: number;
+    action_type: string;
+    status: string;
+    token_id: ICodexAsset;
+    amount: string;
+    targetAddress: string;
+    timestamp?: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+    transactions?: IOperationTransactionHistory[];
+    vaaMessages?: IOperationVaaMessage[];
+    cctp?: ICctp[];
+    vaa_message?: Buffer;
+    fee?: string;
+    usdAmount?: string;
+    companyId?: number;
+    errorMessage?: any;
+}
+export interface IOperationVaaMessage {
+    vaaId: string;
+    operation: IOperationStatus;
+    vaa_message?: Buffer;
+    from_chain_id?: number;
+    to_chain_id?: number;
+    sequence?: number;
+    emitter?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface ICctp {
+    id: string;
+    destinationChainId: number;
+    messageHash: string;
+    messageBytes: string;
+    status: CCTPStatus;
+    attestationSignature?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    attestationCompletedAt?: Date;
+    operation: IOperationStatus;
+}
+export interface IOperationTransactionHistory {
+    txn_hash: string;
+    chain_id: number;
+    operation: IOperationStatus;
+    type?: TransactionType;
+    createdAt: Date;
+    updatedAt: Date;
+}