@ultrade/shared 1.0.0

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

@@ -0,0 +1,235 @@
+import { OrderSide, OrderType, TradeStatus } from "@enums";
+import { IPairSetting, PairToken, PairTokenInfo } from "@interfaces";
+export interface InsertTrade {
+    buy_order_id?: number;
+    sell_order_id?: number;
+    buy_user_id?: string;
+    sell_user_id?: string;
+    price: string;
+    amount: string;
+    total: string;
+    pairId: number;
+    status?: TradeStatus;
+    createdTimestamp?: number;
+}
+export interface IMatchingTrade {
+    pair: string;
+    amount: string;
+    price: string;
+    total: string;
+    maker: IMatchingOrder;
+    taker: IMatchingOrder | null;
+    time: number;
+}
+export interface ICancelingOrder {
+    id: number;
+    pairId: number;
+    userId: string;
+    chainId: number;
+    price: string;
+    amount: string;
+    total: string;
+    side: OrderSide;
+    type: OrderType;
+}
+export interface IMatchingOrder extends ICancelingOrder {
+    orderId: number;
+    companyId: number;
+    expiryAt: Date;
+    message: string;
+    signature: string;
+    tradingKey: string;
+}
+export interface ISettlementOrder extends IMatchingOrder {
+    collectionWallet: string;
+    collectionWalletChainId: number;
+    feeShare: number;
+    bdShare?: MatchShareWallet;
+    affiliateShare?: MatchShareWallet;
+}
+export type TradeFailReason = 'LOGIC' | 'MIN_BALANCE' | 'NETWORK' | 'TIMEOUT';
+export type TradeSettleResult = {
+    success: boolean;
+    reason?: TradeFailReason;
+};
+export interface TradeSettle {
+    trade_id: number;
+    pairId: number;
+    created_at: Date;
+    buy: ISettlementOrder | null;
+    sell: ISettlementOrder | null;
+    baseAsset?: PairToken;
+    priceAsset?: PairToken;
+    amount: string;
+    total: string;
+    price: string;
+    pair: string;
+    maker_tier?: number;
+    market_maker_tier?: number;
+    market_maker_taker_fee?: number;
+    pair_maker_fee?: number;
+    pair_taker_fee?: number;
+    taker_tier?: number;
+    superAppId?: number;
+    superCompany: MatchCompany;
+    expiredOrderBoxes?: string[];
+}
+export interface MatchArgs {
+    id: bigint;
+    amount: bigint;
+    buy: MatchOrder;
+    sell: MatchOrder;
+    baseAsset: PairToken;
+    priceAsset: PairToken;
+    fee: MatchFee;
+    superCompany: MatchCompany;
+    superAppId: number;
+}
+export interface ICollectionWallet {
+    collectionWallet?: string;
+    collectionWalletChainId?: number;
+}
+export interface MatchCompany extends ICollectionWallet {
+    collectionWallet: string;
+    collectionWalletChainId: number;
+}
+export interface MatchFee {
+    b_share: number;
+    s_share: number;
+    mfee_tier: string;
+    tfee_tier: string;
+    mmfee_tier: string;
+    mm_tfee: number;
+    p_mfee: number;
+    p_tfee: number;
+    bdMaker?: MatchShareWallet;
+    bdTaker?: MatchShareWallet;
+    afMaker?: MatchShareWallet;
+    afTaker?: MatchShareWallet;
+}
+export interface MatchShareWallet {
+    address: string;
+    chainId: number;
+    feeShare: number;
+}
+export interface MatchOrder extends ICollectionWallet {
+    id: number;
+    address: string;
+    chain: number;
+    message: string;
+    signature: string;
+    companyId: number;
+    tradingKey?: string;
+}
+export interface IPair {
+    id: number;
+    pairId: number;
+    pair_key: string;
+    base_currency: string;
+    price_currency: string;
+    base_token_id: number;
+    base_id: string;
+    base_chain_id: number;
+    price_token_id: number;
+    price_id: string;
+    price_chain_id: number;
+    price_decimal: number;
+    base_decimal: number;
+    is_active: any;
+    pair_name: string;
+    min_price_increment: string;
+    min_order_size: string;
+    min_size_increment: string;
+    created_at: string;
+    updated_at: string;
+    inuseWithPartners: number[];
+    restrictedCountries: string[];
+    pairSettings: IPairSetting[];
+    scheduled_delistings?: {
+        companyId: number;
+        scheduledDelistDate: Date;
+        disableNewOrders: boolean;
+    }[];
+}
+export interface IPairInfo extends IPair {
+    baseAsset: PairTokenInfo;
+    priceAsset: PairTokenInfo;
+}
+export interface ICompanyPair extends Omit<IPair, 'scheduled_delistings' | 'pairSettings'> {
+    pairSettings: {
+        [name: string]: string | object;
+    };
+    delisting_date?: Date;
+    new_orders_disabled?: boolean;
+}
+export interface StatData {
+    volume?: string | null;
+    total?: string | null;
+    openPriceIndex?: number | null;
+    openPrice?: string | null;
+    openPriceTs?: number | null;
+    lastPriceCreated?: number | null;
+    lastPrice?: string | null;
+    earliestPrice?: string | null;
+    earliestPriceTs?: number | null;
+    highestPrice?: string | null;
+    lowestPrice?: string | null;
+}
+export interface DepthSnapshot {
+    buy: string[][];
+    sell: string[][];
+    ts: number;
+}
+export interface DepthUpdate extends DepthSnapshot {
+    ask: {
+        price: string;
+        qty: string;
+    };
+    bid: {
+        price: string;
+        qty: string;
+    };
+    firstUpdateId: number;
+    finalUpdateId: number;
+}
+export type TradeInBook = [
+    number,
+    string,
+    string,
+    string,
+    number,
+    boolean
+];
+export interface IUserTradeEvent {
+    pairId: number;
+    pairKey: string;
+    userId: string;
+    orderId: number;
+    isBuyer: boolean;
+    isMaker: boolean;
+    tradeId: number;
+    price: string;
+    amount: string;
+    total: string;
+    timestamp: number;
+    status: 'Pending' | 'Confirmed' | 'Rejected';
+    fee?: string;
+    feeTokenId?: number;
+    feeTokenDecimal?: number;
+}
+export type UserTradeEvent = [
+    number,
+    string,
+    string,
+    number,
+    boolean,
+    boolean,
+    number,
+    string,
+    string,
+    string,
+    number,
+    string,
+    number,
+    number
+];

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

@@ -0,0 +1,26 @@
+import { TradingKeyType } from "@enums";
+export interface ITradingKeyMessageData {
+    tkAddress: string;
+    loginAddress: string;
+    loginChainId: number;
+    expiredDate?: number;
+}
+export interface ITradingKeyData extends ITradingKeyMessageData {
+    device?: string;
+    type?: TradingKeyType;
+}
+export interface ITradingKeyDto {
+    data: ITradingKeyData;
+    message: string;
+    encoding?: BufferEncoding;
+    signature: string;
+}
+export interface TradingKeyView {
+    address: string;
+    device: string;
+    type: TradingKeyType;
+    createdAt: Date;
+    expiredAt: Date;
+    orders: number;
+}
+export { TradingKeyType };

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

@@ -0,0 +1,12 @@
+export interface ITransferDto {
+    transferId: number;
+    senderAddress: string;
+    recipientAddress: string;
+    tokenId: number;
+    amount: string;
+    status: string;
+    expiredAt: Date;
+    whitelistId: number | null;
+    txnId: string | null;
+    completedAt: Date | null;
+}

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

@@ -0,0 +1,89 @@
+import { ActionTypeEnum, TradeStatus } from "@enums";
+import { IRangeParamsDto } from "./query.interface";
+export type TechnologyType = "ALGORAND" | "EVM" | "SOLANA";
+export declare enum PROVIDERS {
+    PERA = "PERA",
+    METAMASK = "METAMASK",
+    TRUST_WALLET = "TRUST_WALLET",
+    PHANTOM = "PHANTOM",
+    WALLET_CONNECT = "WALLET_CONNECT",
+    SOLANA_MOBILE = "SOLANA_MOBILE",
+    SOLFLARE = "SOLFLARE",
+    COINBASE = "COINBASE",
+    BACKPACK = "BACKPACK",
+    MOBILE = "MOBILE"
+}
+export interface DepositData {
+    loginAddress: string;
+    loginChainId: number;
+}
+export interface IWalletData {
+    address: string;
+    technology: TechnologyType;
+}
+export interface ILoginData {
+    address: string;
+    provider: PROVIDERS;
+    chain: string;
+    referralToken?: string;
+    loginMessage?: string;
+}
+export interface IDtwData {
+    loginAddress: string;
+    loginChainId: number;
+    recipient: string;
+    recipientChainId: number;
+    tkAddress: string;
+    expiredDate: number;
+}
+export interface IDtwDto extends ISignedMessage<IDtwData> {
+}
+export interface ISignedMessage<IType> {
+    data: IType;
+    encoding?: BufferEncoding;
+    message: string;
+    signature: string;
+}
+export interface ITransferData {
+    loginAddress: string;
+    loginChainId: number;
+    tokenAmount: string;
+    tokenIndex: string | number;
+    tokenChainId: number;
+    recipient: string;
+    recipientChainId: number;
+    expiredDate: number;
+    random: number;
+}
+export interface IWithdrawData extends Omit<ITransferData, "expiredDate"> {
+    fee: number;
+    isNative: boolean;
+    solanaUsdc?: string;
+}
+export interface IWithdrawDto {
+    data: IWithdrawData;
+    message: string;
+    signature: string;
+    encoding?: BufferEncoding;
+}
+export interface CollectionWalletDto {
+    data: CollectionWalletData;
+    message: string;
+    signature: string;
+}
+export interface CollectionWalletData {
+    loginAddress: string;
+    loginChainId: number;
+    companyId: number;
+}
+export interface ITradesQuery extends IRangeParamsDto {
+    address: string;
+    orderId?: number;
+    pairId?: number;
+    statuses?: TradeStatus[];
+}
+export interface ITransactionsQuery extends IRangeParamsDto {
+    tokenId?: number;
+    type?: ActionTypeEnum;
+    address: string;
+}

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

@@ -0,0 +1,14 @@
+import { WithdrawalWalletType, ISignedMessage } from "@interfaces";
+export interface WithdrawalWalletData {
+    address: string;
+    name: string;
+    type: WithdrawalWalletType;
+    description?: string;
+}
+export interface CreateWithdrawalWallet extends ISignedMessage<WithdrawalWalletData> {
+}
+export interface UpdateWithdrawalWalletData extends WithdrawalWalletData {
+    oldAddress: string;
+}
+export interface UpdateWithdrawalWallet extends ISignedMessage<UpdateWithdrawalWalletData> {
+}

package/dist/types/algo-order.type.d.ts

@@ -0,0 +1,10 @@
+import { OrderSideShort, OrderTypeShort } from "../interfaces/order.interface";
+export type AlgoOrder = {
+    orderID: number;
+    side: OrderSideShort;
+    price: string;
+    amount: string;
+    type: OrderTypeShort;
+    directSettle: any;
+    storageSlot: any;
+};

package/dist/types/amm/amm.d.ts

@@ -0,0 +1,163 @@
+export interface PoolInfo {
+    appId: number | string;
+    asset1Id: number;
+    asset1UnitName: string;
+    asset1Decimals: number;
+    asset2Id: number;
+    asset2UnitName: string;
+    asset2Decimals: number;
+    fee: number;
+    poolTokenId: number;
+    poolTokenDecimals: number;
+    poolType: string;
+}
+export interface PoolState {
+    asset1Amount: bigint;
+    asset2Amount: bigint;
+    issuedAmount?: bigint;
+    fee: number;
+    appId: number | string;
+}
+export type PoolStateRedis = Omit<PoolState, 'asset1Amount' | 'asset2Amount'> & {
+    asset1Amount: string;
+    asset2Amount: string;
+};
+export interface PoolConnector {
+    getPoolsInfo(): Promise<PoolInfo[]>;
+    getPoolState({ appId, asset1Id, asset2Id, }: {
+        appId: number | string;
+        asset1Id: number;
+        asset2Id: number;
+    }): Promise<PoolState[]>;
+    getAmmId(): number;
+}
+export declare enum PoolType {
+    STABLE = "stable",
+    CPMM = "constant_product",
+    LEND = "lending",
+    NANO = "nano",
+    MVNANO = "mvnano"
+}
+export declare enum AmmIds {
+    ultrade = 0,
+    tinyman = 1,
+    pactfi = 2,
+    humble = 3,
+    algofi = 4
+}
+export declare enum AmmChars {
+    ultrade = "U",
+    tinyman = "T",
+    pactfi = "P",
+    humble = "H",
+    algofi = "A"
+}
+export declare enum AmmForeignResources {
+    ultrade = 1,
+    tinyman = 2,
+    pactfi = 1,
+    humble = 1,
+    algofi = 2
+}
+export interface Swap {
+    splitAmt: number | bigint;
+    route: RouteWithAmount;
+}
+export interface Pool {
+    amm: number;
+    appID: number | string;
+    assetA: number;
+    assetB: number;
+    fee: number;
+}
+export interface SwapData {
+    receiveAmt: number | bigint;
+    swaps: Swap[];
+}
+export interface FindSorResult {
+    receiveAmt: number;
+    swaps: Array<{
+        splitAmt: number;
+        route: VirtualPool;
+    }>;
+}
+export interface SwapDataResponse extends SwapData {
+    txns?: Array<string>;
+    fee?: number;
+    message?: string;
+}
+export interface PoolWithAmounts extends Pool {
+    assetA_amount: bigint | number;
+    assetB_amount: bigint | number;
+    foreign_resources: number;
+}
+export interface Route {
+    assetA: number;
+    assetB: number;
+    pools: PoolWithAmounts[];
+}
+export type RoutePools = Array<string | number>[];
+export interface RouteChunk {
+    assetA: number;
+    assetB: number;
+    pools: RoutePools;
+}
+export type TxnType = 'asset_transfer' | 'swap';
+export type SwapArray = [TxnType, number, number];
+export type Txn = ([TxnType, number | bigint] | SwapArray)[];
+export interface TxnGroup {
+    routCnt: number;
+    txnData: Txn[];
+}
+export interface RouteWithAmount {
+    assetA: number;
+    assetB: number;
+    pools: PoolWithAmounts[];
+}
+export interface VirtualPool extends RouteWithAmount {
+    vAssetA: number;
+    vAssetB: number;
+    min_swap_amount: number;
+}
+export interface VirtualPoolList {
+    assetA: number;
+    assetB: number;
+    minSwapAmt: number;
+    index?: number;
+}
+export interface IndexerAsset {
+    'created-at-round': number;
+    deleted: boolean;
+    index: number;
+    params: IndexerAssetParams;
+}
+export interface IndexerAssetParams {
+    clawback?: string;
+    creator: string;
+    decimals: number;
+    'default-frozen': boolean;
+    freeze: string;
+    manager: string;
+    name: string;
+    'name-b64': string;
+    reserve: string;
+    total: number;
+    'unit-name': string;
+    'unit-name-b64': string;
+    verification?: any;
+    url?: string;
+}
+export type SupportedNetwork = 'testnet' | 'mainnet';
+export declare const CONTRACT_VERSION: {
+    readonly V1_1: "v1_1";
+    readonly V2: "v2";
+};
+export type ValueOf<T> = T[keyof T];
+export type ContractVersionValue = ValueOf<typeof CONTRACT_VERSION>;
+export declare const VALIDATOR_APP_ID: Record<ContractVersionValue, Record<SupportedNetwork, number>>;
+export interface S3Assets {
+}
+export declare enum AmmBucketKeys {
+    ASSETS = "assets.json",
+    TOP_ASSETS = "topAssets.json"
+}

package/dist/types/api/request.types.d.ts

@@ -0,0 +1,99 @@
+export type TPutPartners = {
+    id: number;
+    name: string;
+    domain: string;
+};
+export type TPutAdmins = {
+    id: number;
+    enabled: boolean;
+};
+export type TPutPair = {
+    pairId: number;
+    minOrderSize: string;
+    minSizeIncrement: string;
+    minPriceIncrement: string;
+    baseCoinIconLink: string;
+    baseCoinMarketLink: string;
+    priceCoinIconLink: string;
+    priceCoinMarketLink: string;
+    tags: Array<number>;
+    restrictedCountries: Array<string>;
+    isPairPublic: boolean;
+    audioLink?: string;
+    mftName?: string;
+};
+export type ModeType = 'OFF' | 'MTN' | 'STOP_CREATE';
+export type TPostPair = {
+    baseChainId: number;
+    baseCurrency: string;
+    baseCurrencyId: string;
+    baseDecimal: number;
+    baseName: string;
+    baseCoinIconLink?: string;
+    baseCoinMarketLink?: string;
+    isPairPublic: boolean;
+    minOrderSize: string;
+    minSizeIncrement: string;
+    minPriceIncrement: string;
+    priceChainId: number;
+    priceCurrency: string;
+    priceCurrencyId: string;
+    priceDecimal: number;
+    priceName: string;
+    priceCoinIconLink?: string;
+    priceCoinMarketLink?: string;
+    restrictedCountries?: string[];
+    tags?: number[];
+    audioLink?: string;
+    priceUsdcValue: number;
+    baseUsdcValue: number;
+    takerFee?: string;
+};
+export type TPostSuperCollectionWallet = {
+    address: string;
+    chainId: number;
+};
+export type TPostPriceCoin = {
+    address: string;
+    chainId: number;
+    decimal: number;
+    name: string;
+    unitName: string;
+    cmcLink?: string;
+};
+export type TDeletePriceCoin = {
+    address: string;
+    chainId: number;
+};
+export declare enum SmallTimeframeEnum {
+    last_7_days = "last_7_days",
+    last_30_days = "last_30_days",
+    last_90_days = "last_90_days",
+    last_year = "last_year"
+}
+export type PairSortKey = 'volume_usd' | 'fees_usd' | 'trades_count' | 'traders';
+export type UserSortKey = 'volume_usd' | 'fees_paid_usd' | 'trades_count' | 'last_active_at' | 'referred_volume_usd' | 'referred_fee_usd' | 'referrer_affiliate_id';
+export declare class PairsQueryDto {
+    timeRange: SmallTimeframeEnum;
+    sortBy?: PairSortKey;
+    order?: 'asc' | 'desc';
+    limit?: number;
+    page?: number;
+}
+export declare class UsersQueryDto {
+    timeRange: SmallTimeframeEnum;
+    sortBy?: UserSortKey;
+    order?: 'asc' | 'desc';
+    limit?: number;
+    page?: number;
+}
+export declare enum StatisticTypeQuery {
+    volume = "volume",
+    fees = "fees",
+    orders = "orders",
+    dau = "dau"
+}
+export declare class ChartQueryDto {
+    type: StatisticTypeQuery;
+    timeRange: SmallTimeframeEnum;
+}

package/dist/types/codex.types.d.ts

@@ -0,0 +1,28 @@
+export type CodexState = {
+    collectionWallet: string;
+    collectionWalletChainId: number;
+    msgProcId: number;
+    superAppId: number;
+};
+export type CompanyBox = {
+    collectionWallet: string;
+    collectionWalletChainId: number;
+    takerFee: number;
+    makerFee: number;
+};
+export type OrderBox = {
+    hash: string;
+    amount: bigint;
+    price: bigint;
+    expiredTime: bigint;
+    expiredDate: Date;
+};
+export type PairBox = {
+    minSize: bigint;
+    minPriceIncrement: bigint;
+    minSizeIncrement: bigint;
+};
+export type TokenBox = {
+    name: string;
+    decimal: number;
+};

package/dist/types/hummingbots.types.d.ts

@@ -0,0 +1,23 @@
+import { IHummingbotInstance } from '@interfaces';
+export interface HummingbotUserData {
+    password: string;
+    tradingKey: string;
+    loginAddress: string;
+    mnemonic: string;
+}
+export interface HummingbotStrategyBase {
+    strategy: string;
+    [key: string]: any;
+}
+export interface HummingbotStrategy extends HummingbotStrategyBase {
+    id: number;
+}
+export declare enum HummingbotInstanceStatus {
+    PREPARING = "provisioning",
+    STOPPING = "stopping",
+    RUNNING = "running",
+    STOPPED = "stopped",
+    FAILED = "failed"
+}
+export type CreateHummingbotInstanceDto = Omit<IHummingbotInstance, 'id' | 'createdAt' | 'updatedAt'>;
+export type CreateStrategyDto = Omit<HummingbotStrategy, 'id'>;