Add TON mainnet/testnet

2026-03-14 06:02:36 +03:00 · 2024-10-23 15:42:47 +03:00
parent 9d17368c82
commit 8b4aae64e8
7 changed files with 370 additions and 265 deletions
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@orionprotocol/sdk",
-  "version": "0.19.92-rc121",
+  "version": "0.19.92-rc122",
  "description": "Orion Protocol SDK",
  "main": "./lib/index.cjs",
  "module": "./lib/index.js",
--- a/src/config/chains.json
+++ b/src/config/chains.json
@@ -283,5 +283,25 @@
      "WETH": "0x4200000000000000000000000000000000000006",
      "curveRegistry": ""
    }
+  },
+  "4398026970694": {
+    "chainId": "4398026970694",
+    "explorer": "https://testnet.tonscan.org/",
+    "label": "TON Testnet",
+    "shortName": "TON Testnet",
+    "code": "tonTestnet",
+    "rpc": "https://testnet-v4.tonhubapi.com",
+    "baseCurrencyName": "TON",
+    "contracts": {}
+  },
+  "4398026970693": {
+    "chainId": "4398026970693",
+    "explorer": "https://tonscan.org/",
+    "label": "TON Mainnet",
+    "shortName": "TON Mainnet",
+    "code": "ton",
+    "rpc": "https://mainnet-v4.tonhubapi.com",
+    "baseCurrencyName": "TON",
+    "contracts": {}
  }
 }
--- a/src/config/envs.json
+++ b/src/config/envs.json
@@ -219,6 +219,25 @@
            "http": "/orion-indexer/"
          }
        }
+      },
+      "4398026970693": {
+        "api": "https://app.electra.trade/lumia-mainnet",
+        "rpc": "https://mainnet-v4.tonhubapi.com",
+        "services": {
+          "aggregator": {
+            "http": "/backend",
+            "ws": "/v1"
+          },
+          "blockchain": {
+            "http": ""
+          },
+          "priceFeed": {
+            "all": "/price-feed"
+          },
+          "indexer": {
+            "http": "/orion-indexer/"
+          }
+        }
      }
    }
  },
@@ -298,6 +317,25 @@
            "http": "/orion-indexer/"
          }
        }
+      },
+      "4398026970694": {
+        "api": "https://app.electra.trade/lumia-testnet",
+        "rpc": "https://testnet-v4.tonhubapi.com",
+        "services": {
+          "aggregator": {
+            "http": "/backend",
+            "ws": "/v1"
+          },
+          "blockchain": {
+            "http": ""
+          },
+          "priceFeed": {
+            "all": "/price-feed"
+          },
+          "indexer": {
+            "http": "/orion-indexer/"
+          }
+        }
      }
    }
  },
--- a/src/constants/chains.ts
+++ b/src/constants/chains.ts
@@ -11,6 +11,7 @@ export const developmentChains = [
  SupportedChainId.OKC_TESTNET,
  SupportedChainId.EVENT_HORIZON_TESTNET,
  SupportedChainId.LUMIA_TESTNET,
+  SupportedChainId.TON_TESTNET,
 ];
 export const productionChains = [
  SupportedChainId.MAINNET,
@@ -25,4 +26,5 @@ export const productionChains = [
  SupportedChainId.AVAX,
  SupportedChainId.BASE,
  SupportedChainId.LUMIA,
+  SupportedChainId.TON,
 ];
--- a/src/constants/networkCodes.ts
+++ b/src/constants/networkCodes.ts
@@ -1 +1,17 @@
-export default ['ftm', 'bsc', 'eth', 'polygon', 'okc', 'arb', 'drip', 'opbnb', 'inevm', 'linea', 'avax', 'base', 'lumia'] as const;
+export default [
+  'ftm',
+  'bsc',
+  'eth',
+  'polygon',
+  'okc',
+  'arb',
+  'drip',
+  'opbnb',
+  'inevm',
+  'linea',
+  'avax',
+  'base',
+  'lumia',
+  'ton',
+  'tonTestnet',
+] as const;
--- a/src/constants/uppercasedNetworkCodes.ts
+++ b/src/constants/uppercasedNetworkCodes.ts
@@ -1 +1,16 @@
-export default ['FTM', 'BSC', 'ETH', 'POLYGON', 'OKC', 'ARB', 'OPBNB', 'INEVM', 'LINEA', 'AVAX', 'BASE', 'LUMIA'] as const;
+export default [
+  'FTM',
+  'BSC',
+  'ETH',
+  'POLYGON',
+  'OKC',
+  'ARB',
+  'OPBNB',
+  'INEVM',
+  'LINEA',
+  'AVAX',
+  'BASE',
+  'LUMIA',
+  'TON',
+  'TON_TESTNET',
+] as const;
--- a/src/types.ts
+++ b/src/types.ts
@@ -6,80 +6,82 @@ import type positionStatuses from './constants/positionStatuses.js';
 import type { knownEnvs } from './config/schemas/index.js';
 import type getHistory from './Orion/bridge/getHistory.js';

-export type DeepPartial<T> = T extends object ? {
-  [P in keyof T]?: DeepPartial<T[P]>;
-} : T;
+export type DeepPartial<T> = T extends object
+  ? {
+      [P in keyof T]?: DeepPartial<T[P]>;
+    }
+  : T;

 export type AssetPairUpdate = {
-  minQty: number
-  pricePrecision: number
-}
+  minQty: number;
+  pricePrecision: number;
+};
 export type SubOrder = {
-  pair: string
-  exchange: string
-  id: number
-  amount: number
-  settledAmount: number
-  price: number
-  status: typeof subOrderStatuses[number]
-  side: 'BUY' | 'SELL'
-  subOrdQty: number
-}
+  pair: string;
+  exchange: string;
+  id: number;
+  amount: number;
+  settledAmount: number;
+  price: number;
+  status: (typeof subOrderStatuses)[number];
+  side: 'BUY' | 'SELL';
+  subOrdQty: number;
+};

 export type Balance = {
-  tradable: string
-  reserved: string
-  contract: string
-  wallet: string
-  allowance: string
-}
+  tradable: string;
+  reserved: string;
+  contract: string;
+  wallet: string;
+  allowance: string;
+};

-export type PositionStatus = typeof positionStatuses[number];
+export type PositionStatus = (typeof positionStatuses)[number];

 export type Order = {
-  senderAddress: string // address
-  matcherAddress: string // address
-  baseAsset: string // address
-  quoteAsset: string // address
-  matcherFeeAsset: string // address
-  amount: number // uint64
-  price: number // uint64
-  matcherFee: number // uint64
-  nonce: number // uint64
-  expiration: number // uint64
-  buySide: 0 | 1 // uint8, 1=buy, 0=sell
-  isPersonalSign: boolean // bool
-}
+  senderAddress: string; // address
+  matcherAddress: string; // address
+  baseAsset: string; // address
+  quoteAsset: string; // address
+  matcherFeeAsset: string; // address
+  amount: number; // uint64
+  price: number; // uint64
+  matcherFee: number; // uint64
+  nonce: number; // uint64
+  expiration: number; // uint64
+  buySide: 0 | 1; // uint8, 1=buy, 0=sell
+  isPersonalSign: boolean; // bool
+};

 export type SignedOrder = {
-  id: string // hash of Order (it's not part of order structure in smart-contract)
-  signature: string // bytes
-  needWithdraw?: boolean // bool (not supported yet by smart-contract)
-} & Order
+  id: string; // hash of Order (it's not part of order structure in smart-contract)
+  signature: string; // bytes
+  needWithdraw?: boolean; // bool (not supported yet by smart-contract)
+} & Order;

 export type CancelOrderRequest = {
-  id: number | string
-  senderAddress: string
-  isPersonalSign: boolean
-}
+  id: number | string;
+  senderAddress: string;
+  isPersonalSign: boolean;
+};

 export type SignedCancelOrderRequest = {
-  id: number | string
-  senderAddress: string
-  signature: string
-} & CancelOrderRequest
+  id: number | string;
+  senderAddress: string;
+  signature: string;
+} & CancelOrderRequest;

 export type Pair = {
-  name: string
-  baseCurrency: string
-  quoteCurrency: string
-  lastPrice: string
-  openPrice: string
-  change24h: string
-  high: string
-  low: string
-  vol24h: string
-}
+  name: string;
+  baseCurrency: string;
+  quoteCurrency: string;
+  lastPrice: string;
+  openPrice: string;
+  change24h: string;
+  high: string;
+  low: string;
+  vol24h: string;
+};

 export enum SupportedChainId {
  MAINNET = '1',
@@ -107,121 +109,126 @@ export enum SupportedChainId {
  EVENT_HORIZON_TESTNET = '123420000034',
  LUMIA_TESTNET = '1952959480',

+  TON = '4398026970693',
+  TON_TESTNET = '4398026970694',
+
  // For testing and debug purpose
  // BROKEN = '0',
 }

 const balanceTypes = ['exchange', 'wallet'] as const;

-export type Source = typeof balanceTypes[number];
+export type Source = (typeof balanceTypes)[number];
 export type Asset = {
-  name: string
-  address: string
-}
+  name: string;
+  address: string;
+};
 export type BalanceRequirement = {
-  readonly reason: string
-  readonly asset: Asset
-  readonly amount: string
-  readonly sources: Source[]
-  readonly spenderAddress?: string | undefined
-}
+  readonly reason: string;
+  readonly asset: Asset;
+  readonly amount: string;
+  readonly sources: Source[];
+  readonly spenderAddress?: string | undefined;
+};

 export type AggregatedBalanceRequirement = {
-  readonly asset: Asset
-  readonly sources: Source[]
-  readonly spenderAddress?: string | undefined
-  items: Partial<Record<string, string>>
-}
+  readonly asset: Asset;
+  readonly sources: Source[];
+  readonly spenderAddress?: string | undefined;
+  items: Partial<Record<string, string>>;
+};

 export type ApproveFix = {
-  readonly type: 'byApprove'
-  readonly targetAmount: BigNumber.Value
-  readonly spenderAddress: string
-}
+  readonly type: 'byApprove';
+  readonly targetAmount: BigNumber.Value;
+  readonly spenderAddress: string;
+};

 export type DepositFix = {
-  readonly type: 'byDeposit'
-  readonly amount: BigNumber.Value
-  readonly asset: string
-}
+  readonly type: 'byDeposit';
+  readonly amount: BigNumber.Value;
+  readonly asset: string;
+};

 type Fix = ApproveFix | DepositFix;

 export type BalanceIssue = {
-  readonly asset: Asset
-  readonly message: string
-  readonly sources: Source[]
-  readonly fixes?: Fix[]
-}
+  readonly asset: Asset;
+  readonly message: string;
+  readonly sources: Source[];
+  readonly fixes?: Fix[];
+};

 // export type Exchange = typeof exchanges[number];

 export type OrderbookItem = {
-  price: string
-  amount: string
-  exchanges: string[]
+  price: string;
+  amount: string;
+  exchanges: string[];
  vob: Array<{
-    side: 'BUY' | 'SELL'
-    pairName: string
-  }>
-}
+    side: 'BUY' | 'SELL';
+    pairName: string;
+  }>;
+};

 export type SwapInfoAlternative = {
-  exchanges: string[]
-  path: string[]
-  marketAmountOut?: number | undefined
-  marketAmountIn?: number | undefined
-  marketPrice: number
-  availableAmountIn?: number | undefined
-  availableAmountOut?: number | undefined
-}
+  exchanges: string[];
+  path: string[];
+  marketAmountOut?: number | undefined;
+  marketAmountIn?: number | undefined;
+  marketPrice: number;
+  availableAmountIn?: number | undefined;
+  availableAmountOut?: number | undefined;
+};

-export type Factory = typeof factories[number]
+export type Factory = (typeof factories)[number];

 export type SingleSwap = {
-  pool: string
-  assetIn: string
-  assetOut: string
-  factory: Factory
-}
+  pool: string;
+  assetIn: string;
+  assetOut: string;
+  factory: Factory;
+};

 export type SwapInfoBase = {
-  swapRequestId: string
-  assetIn: string
-  assetOut: string
-  amountIn: number
-  amountOut: number
-  minAmountIn: number
-  minAmountOut: number
+  swapRequestId: string;
+  assetIn: string;
+  assetOut: string;
+  amountIn: number;
+  amountOut: number;
+  minAmountIn: number;
+  minAmountOut: number;

-  path: string[]
-  exchangeContractPath: SingleSwap[]
-  exchanges?: string[] | undefined
-  poolOptimal: boolean
+  path: string[];
+  exchangeContractPath: SingleSwap[];
+  exchanges?: string[] | undefined;
+  poolOptimal: boolean;

-  price?: number | undefined
-  marketPrice?: number | undefined
-  orderInfo?: {
-    pair: string
-    side: 'BUY' | 'SELL'
-    amount: number
-    safePrice: number
-  } | undefined
-  alternatives: SwapInfoAlternative[]
-  assetsNameMapping?: Partial<Record<string, string>> | undefined
-}
+  price?: number | undefined;
+  marketPrice?: number | undefined;
+  orderInfo?:
+    | {
+        pair: string;
+        side: 'BUY' | 'SELL';
+        amount: number;
+        safePrice: number;
+      }
+    | undefined;
+  alternatives: SwapInfoAlternative[];
+  assetsNameMapping?: Partial<Record<string, string>> | undefined;
+};

 export type SwapInfoByAmountIn = SwapInfoBase & {
-  kind: 'exactSpend'
-  availableAmountIn?: number | undefined
-  marketAmountOut?: number | undefined
-}
+  kind: 'exactSpend';
+  availableAmountIn?: number | undefined;
+  marketAmountOut?: number | undefined;
+};

 export type SwapInfoByAmountOut = SwapInfoBase & {
-  kind: 'exactReceive'
-  marketAmountIn?: number | undefined
-  availableAmountOut?: number | undefined
-}
+  kind: 'exactReceive';
+  marketAmountIn?: number | undefined;
+  availableAmountOut?: number | undefined;
+};

 export type SwapInfo = SwapInfoByAmountIn | SwapInfoByAmountOut;

@@ -233,107 +240,114 @@ export enum HistoryTransactionStatus {
 }

 export type BasicAuthCredentials = {
-  username: string
-  password: string
-}
+  username: string;
+  password: string;
+};

 export type VerboseUnitConfig = {
  // env?: string;
  // api: string;
-  chainId: SupportedChainId
-  nodeJsonRpc: string
+  chainId: SupportedChainId;
+  nodeJsonRpc: string;
  services: {
    blockchainService: {
-      http: string
+      http: string;
      // For example:
      // http://localhost:3001/,
      // http://10.123.34.23:3001/,
      // https://blockchain:3001/
-    }
+    };
    aggregator: {
-      http: string
-      ws: string
+      http: string;
+      ws: string;
      // For example:
      // http://localhost:3002/,
      // http://10.34.23.5:3002/,
      // https://aggregator:3002/
-    }
+    };
    priceFeed: {
-      api: string
+      api: string;
      // For example:
      // http://localhost:3003/,
      // http://10.23.5.11:3003/,
      // https://price-feed:3003/
-    }
-  }
-  basicAuth?: BasicAuthCredentials
-}
+    };
+  };
+  basicAuth?: BasicAuthCredentials;
+};

-export type KnownEnv = typeof knownEnvs[number];
+export type KnownEnv = (typeof knownEnvs)[number];

-export type Json = string | number | boolean | null | Json[] | { [key: string]: Json };
+export type Json =
+  | string
+  | number
+  | boolean
+  | null
+  | Json[]
+  | { [key: string]: Json };

 export type EnvConfig = {
-  analyticsAPI: string
-  referralAPI: string
-  networks: Partial<
-    Record<
-      SupportedChainId,
-      VerboseUnitConfig
-    >
-  >
-}
+  analyticsAPI: string;
+  referralAPI: string;
+  networks: Partial<Record<SupportedChainId, VerboseUnitConfig>>;
+};
 export type AggregatedAssets = Partial<
  Record<
    string,
    Partial<
-      Record<SupportedChainId, {
-        address: string
-      }>
+      Record<
+        SupportedChainId,
+        {
+          address: string;
+        }
+      >
    >
  >
-  >;
+>;

 export type RedeemOrder = {
-  sender: string
-  receiver: string
-  asset: string
-  amount: number
-  expiration: number
-  secretHash: string
-  signature: string
-  claimReceiver: string
-}
+  sender: string;
+  receiver: string;
+  asset: string;
+  amount: number;
+  expiration: number;
+  secretHash: string;
+  signature: string;
+  claimReceiver: string;
+};

 export interface AtomicSwapLocal {
-  secret: string
-  secretHash: string
-  walletAddress: string
-  env?: string | undefined
+  secret: string;
+  secretHash: string;
+  walletAddress: string;
+  env?: string | undefined;

-  sourceChainId?: SupportedChainId | undefined
-  targetChainId?: SupportedChainId | undefined
+  sourceChainId?: SupportedChainId | undefined;
+  targetChainId?: SupportedChainId | undefined;

-  amount?: string | undefined
-  assetName?: string | undefined
+  amount?: string | undefined;
+  assetName?: string | undefined;

-  liquidityMigrationTxHash?: string | undefined
-  lockTransactionHash?: string | undefined
-  refundTransactionHash?: string | undefined
+  liquidityMigrationTxHash?: string | undefined;
+  lockTransactionHash?: string | undefined;
+  refundTransactionHash?: string | undefined;

-  creationDate?: number | undefined
-  lockExpiration?: number | undefined
-  placingOrderError?: string | undefined
-  redeemSettlement?: {
-    type: 'own_tx'
-  } | {
-    type: 'orion_tx'
-    requestedAt?: number
-    result?: {
-      timestamp: number
-      value: 'success' | 'failed'
-    }
-  } | undefined
+  creationDate?: number | undefined;
+  lockExpiration?: number | undefined;
+  placingOrderError?: string | undefined;
+  redeemSettlement?:
+    | {
+        type: 'own_tx';
+      }
+    | {
+        type: 'orion_tx';
+        requestedAt?: number;
+        result?: {
+          timestamp: number;
+          value: 'success' | 'failed';
+        };
+      }
+    | undefined;
 }

 export enum TxStatus {
@@ -361,71 +375,72 @@ export enum TxType {
 }

 export type TxDepositOrWithdrawPayload = {
-  type: TxType.DEPOSIT | TxType.WITHDRAW
+  type: TxType.DEPOSIT | TxType.WITHDRAW;
  data: {
-    asset: string
-    amount: string
-  }
+    asset: string;
+    amount: string;
+  };
 };

 export type TxSwapThroughOrionPoolPayload = {
-  type: TxType.SWAP_THROUGH_ORION_POOL
+  type: TxType.SWAP_THROUGH_ORION_POOL;
  data: {
-    side: 'buy' | 'sell'
-    assetIn: string
-    assetOut: string
-    amount: string
-    price: string
-  }
+    side: 'buy' | 'sell';
+    assetIn: string;
+    assetOut: string;
+    amount: string;
+    price: string;
+  };
 };

 export type TxBridgePayload = {
-  type: TxType.BRIDGE_LOCK | TxType.BRIDGE_REDEEM | TxType.BRIDGE_REFUND
+  type: TxType.BRIDGE_LOCK | TxType.BRIDGE_REDEEM | TxType.BRIDGE_REFUND;
  data: {
-    secretHash: string
-  }
-}
+    secretHash: string;
+  };
+};

 export type TxLiquidityMigrationPayload = {
-  type: TxType.LIQUIDITY_MIGRATION
+  type: TxType.LIQUIDITY_MIGRATION;
  data: {
-    source: SupportedChainId
-    target: SupportedChainId
-    pair: string
-    pairAddress: string
+    source: SupportedChainId;
+    target: SupportedChainId;
+    pair: string;
+    pairAddress: string;
    assetA: {
-      amount: string
-      secretHash: string
-      secret: string
-    }
+      amount: string;
+      secretHash: string;
+      secret: string;
+    };
    assetB: {
-      amount: string
-      secretHash: string
-      secret: string
-    }
-    expiration: number
-    env?: string
-  }
-}
+      amount: string;
+      secretHash: string;
+      secret: string;
+    };
+    expiration: number;
+    env?: string;
+  };
+};

 export type TxRedeemTwoAtomicsPayload = {
-  type: TxType.REDEEM_TWO_ATOMICS
+  type: TxType.REDEEM_TWO_ATOMICS;
  data: {
-    secretHash1: string
-    secretHash2: string
-  }
-}
+    secretHash1: string;
+    secretHash2: string;
+  };
+};

 export type TransactionInfo = {
-  id?: string
-  status?: TxStatus
-  hash?: string
-  payload?: TxDepositOrWithdrawPayload
-  | TxSwapThroughOrionPoolPayload
-  | TxBridgePayload
-  | TxLiquidityMigrationPayload
-  | TxRedeemTwoAtomicsPayload
-}
+  id?: string;
+  status?: TxStatus;
+  hash?: string;
+  payload?:
+    | TxDepositOrWithdrawPayload
+    | TxSwapThroughOrionPoolPayload
+    | TxBridgePayload
+    | TxLiquidityMigrationPayload
+    | TxRedeemTwoAtomicsPayload;
+};

 type BridgeHistory = Awaited<ReturnType<typeof getHistory>>;

@@ -433,21 +448,20 @@ type BridgeHistoryItem = NonNullable<BridgeHistory[string]>;

 export type AtomicSwap = Partial<
  Omit<BridgeHistoryItem, 'creationDate' | 'expiration' | 'secret'>
-> & Partial<
-  Omit<AtomicSwapLocal, 'creationDate' | 'expiration' | 'secret'>
-> & {
-  sourceChainId: SupportedChainId
-  targetChainId: SupportedChainId
-  lockExpiration: number
-  secretHash: string
-  walletAddress: string
-  secret?: string | undefined
+> &
+  Partial<Omit<AtomicSwapLocal, 'creationDate' | 'expiration' | 'secret'>> & {
+    sourceChainId: SupportedChainId;
+    targetChainId: SupportedChainId;
+    lockExpiration: number;
+    secretHash: string;
+    walletAddress: string;
+    secret?: string | undefined;

-  creationDate?: number | undefined
-  redeemExpired?: boolean | undefined
+    creationDate?: number | undefined;
+    redeemExpired?: boolean | undefined;

-  lockTx?: TransactionInfo | undefined
-  redeemTx?: TransactionInfo | undefined
-  refundTx?: TransactionInfo | undefined
-  liquidityMigrationTx?: TransactionInfo | undefined
-}
+    lockTx?: TransactionInfo | undefined;
+    redeemTx?: TransactionInfo | undefined;
+    refundTx?: TransactionInfo | undefined;
+    liquidityMigrationTx?: TransactionInfo | undefined;
+  };